mech_eap/util_radius.h

   1 /*
   2  * Copyright (c) 2011, JANET(UK)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  *
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * 3. Neither the name of JANET(UK) nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  */
  32
  33 /*
  34  * RADIUS attribute provider.
  35  */
  36
  37 #ifndef _UTIL_RADIUS_H_
  38 #define _UTIL_RADIUS_H_ 1
  39
  40 #ifdef __cplusplus
  41
  42 struct gss_eap_radius_attr_provider : gss_eap_attr_provider {
  43 public:
  44     gss_eap_radius_attr_provider(void);
  45     ~gss_eap_radius_attr_provider(void);
  46
  47     bool initFromExistingContext(const gss_eap_attr_ctx *source,
  48                                  const gss_eap_attr_provider *ctx);
  49     bool initFromGssContext(const gss_eap_attr_ctx *source,
  50                             const gss_cred_id_t cred,
  51                             const gss_ctx_id_t ctx);
  52
  53     bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
  54     bool setAttribute(int complete,
  55                       const gss_buffer_t attr,
  56                       const gss_buffer_t value);
  57     bool deleteAttribute(const gss_buffer_t attr);
  58     bool getAttribute(const gss_buffer_t attr,
  59                       int *authenticated,
  60                       int *complete,
  61                       gss_buffer_t value,
  62                       gss_buffer_t display_value,
  63                       int *more) const;
  64     gss_any_t mapToAny(int authenticated,
  65                        gss_buffer_t type_id) const;
  66     void releaseAnyNameMapping(gss_buffer_t type_id,
  67                                gss_any_t input) const;
  68
  69     const char *marshallingKey(void) const;
  70     bool unmarshallAndInit(const gss_eap_attr_ctx *manager,
  71                            DDF &object GSSEAP_UNUSED);
  72     DDF marshall(void) const;
  73
  74     bool getAttribute(uint32_t attribute,
  75                       int *authenticated,
  76                       int *complete,
  77                       gss_buffer_t value,
  78                       gss_buffer_t display_value,
  79                       int *more) const;
  80     bool getAttribute(uint16_t attribute,
  81                       uint16_t vendor,
  82                       int *authenticated,
  83                       int *complete,
  84                       gss_buffer_t value,
  85                       gss_buffer_t display_value,
  86                       int *more) const;
  87     bool setAttribute(int complete,
  88                       uint32_t attribute,
  89                       const gss_buffer_t value);
  90     bool deleteAttribute(uint32_t attribute);
  91
  92     bool getFragmentedAttribute(uint16_t attribute,
  93                                 uint16_t vendor,
  94                                 int *authenticated,
  95                                 int *complete,
  96                                 gss_buffer_t value) const;
  97
  98     bool authenticated(void) const { return m_authenticated; }
  99
 100     time_t getExpiryTime(void) const;
 101
 102     static bool init(void);
 103     static void finalize(void);
 104
 105     static gss_eap_attr_provider *createAttrContext(void);
 106
 107 private:
 108     const VALUE_PAIR *getAvps(void) const {
 109         return m_vps;
 110     }
 111
 112     VALUE_PAIR *m_vps;
 113     bool m_authenticated;
 114 };
 115
 116 /* For now */
 117 extern "C" {
 118 #endif
 119
 120 OM_uint32
 121 gssEapRadiusAddAvp(OM_uint32 *minor,
 122                    VALUE_PAIR **vp,
 123                    uint16_t type,
 124                    uint16_t vendor,
 125                    const gss_buffer_t buffer);
 126
 127 OM_uint32
 128 gssEapRadiusGetAvp(OM_uint32 *minor,
 129                    VALUE_PAIR *vps,
 130                    uint16_t type,
 131                    uint16_t vendor,
 132                    gss_buffer_t buffer,
 133                    int concat);
 134
 135 OM_uint32
 136 gssEapRadiusGetRawAvp(OM_uint32 *minor,
 137                       VALUE_PAIR *vps,
 138                       uint16_t type,
 139                       uint16_t vendor,
 140                       VALUE_PAIR **vp);
 141 OM_uint32
 142 gssEapRadiusFreeAvps(OM_uint32 *minor,
 143                      VALUE_PAIR **vps);
 144
 145 OM_uint32 gssEapRadiusAttrProviderInit(OM_uint32 *minor);
 146 OM_uint32 gssEapRadiusAttrProviderFinalize(OM_uint32 *minor);
 147
 148 OM_uint32
 149 gssEapRadiusMapError(OM_uint32 *minor,
 150                      struct rs_error *err);
 151
 152 #define RS_CONFIG_FILE      SYSCONFDIR "/radsec.conf"
 153
 154 #define VENDORPEC_MS                        311 /* RFC 2548 */
 155
 156 #define PW_MS_MPPE_SEND_KEY                 16
 157 #define PW_MS_MPPE_RECV_KEY                 17
 158
 159 #define VENDORPEC_UKERNA                    25622
 160
 161 #define PW_GSS_ACCEPTOR_SERVICE_NAME        128
 162 #define PW_GSS_ACCEPTOR_HOST_NAME           129
 163 #define PW_GSS_ACCEPTOR_SERVICE_SPECIFIC    130
 164 #define PW_GSS_ACCEPTOR_REALM_NAME          131
 165 #define PW_SAML_AAA_ASSERTION               132
 166
 167 #define IS_RADIUS_ERROR(code)               ((code) >= ERROR_TABLE_BASE_rse && \
 168                                              (code) <= ERROR_TABLE_BASE_rse + RSE_TIMEOUT_IO)
 169
 170 #ifdef __cplusplus
 171 }
 172 #endif
 173
 174 #endif /* _UTIL_RADIUS_H_ */