moonshot/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 initWithExistingContext(const gss_eap_attr_ctx *source,
  48                                  const gss_eap_attr_provider *ctx);
  49     bool initWithGssContext(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 *prefix(void) const;
  70     const char *name(void) const;
  71     bool initWithJsonObject(const gss_eap_attr_ctx *manager,
  72                            JSONObject &obj);
  73     JSONObject jsonRepresentation(void) const;
  74
  75     bool getAttribute(uint32_t attribute,
  76                       int *authenticated,
  77                       int *complete,
  78                       gss_buffer_t value,
  79                       gss_buffer_t display_value,
  80                       int *more) const;
  81     bool getAttribute(uint16_t attribute,
  82                       uint16_t vendor,
  83                       int *authenticated,
  84                       int *complete,
  85                       gss_buffer_t value,
  86                       gss_buffer_t display_value,
  87                       int *more) const;
  88     bool setAttribute(int complete,
  89                       uint32_t attribute,
  90                       const gss_buffer_t value);
  91     bool deleteAttribute(uint32_t attribute);
  92
  93     bool getFragmentedAttribute(uint16_t attribute,
  94                                 uint16_t vendor,
  95                                 int *authenticated,
  96                                 int *complete,
  97                                 gss_buffer_t value) const;
  98
  99     bool authenticated(void) const { return m_authenticated; }
 100
 101     time_t getExpiryTime(void) const;
 102
 103     static bool init(void);
 104     static void finalize(void);
 105
 106     static gss_eap_attr_provider *createAttrContext(void);
 107
 108 private:
 109     const VALUE_PAIR *getAvps(void) const {
 110         return m_vps;
 111     }
 112
 113     VALUE_PAIR *m_vps;
 114     bool m_authenticated;
 115 };
 116
 117 /* For now */
 118 extern "C" {
 119 #endif
 120
 121 OM_uint32
 122 gssEapRadiusAddAvp(OM_uint32 *minor,
 123                    VALUE_PAIR **vp,
 124                    uint16_t type,
 125                    uint16_t vendor,
 126                    const gss_buffer_t buffer);
 127
 128 OM_uint32
 129 gssEapRadiusGetAvp(OM_uint32 *minor,
 130                    VALUE_PAIR *vps,
 131                    uint16_t type,
 132                    uint16_t vendor,
 133                    gss_buffer_t buffer,
 134                    int concat);
 135
 136 OM_uint32
 137 gssEapRadiusGetRawAvp(OM_uint32 *minor,
 138                       VALUE_PAIR *vps,
 139                       uint16_t type,
 140                       uint16_t vendor,
 141                       VALUE_PAIR **vp);
 142 OM_uint32
 143 gssEapRadiusFreeAvps(OM_uint32 *minor,
 144                      VALUE_PAIR **vps);
 145
 146 OM_uint32 gssEapRadiusAttrProviderInit(OM_uint32 *minor);
 147 OM_uint32 gssEapRadiusAttrProviderFinalize(OM_uint32 *minor);
 148
 149 OM_uint32
 150 gssEapRadiusMapError(OM_uint32 *minor,
 151                      struct rs_error *err);
 152
 153 #define RS_CONFIG_FILE      SYSCONFDIR "/radsec.conf"
 154
 155 #define VENDORPEC_MS                        311 /* RFC 2548 */
 156
 157 #define PW_MS_MPPE_SEND_KEY                 16
 158 #define PW_MS_MPPE_RECV_KEY                 17
 159
 160 #define VENDORPEC_UKERNA                    25622
 161
 162 #define PW_GSS_ACCEPTOR_SERVICE_NAME        128
 163 #define PW_GSS_ACCEPTOR_HOST_NAME           129
 164 #define PW_GSS_ACCEPTOR_SERVICE_SPECIFIC    130
 165 #define PW_GSS_ACCEPTOR_REALM_NAME          131
 166 #define PW_SAML_AAA_ASSERTION               132
 167
 168 #define IS_RADIUS_ERROR(code)               ((code) >= ERROR_TABLE_BASE_rse && \
 169                                              (code) <= ERROR_TABLE_BASE_rse + RSE_TIMEOUT_IO)
 170
 171 #ifdef __cplusplus
 172 }
 173 #endif
 174
 175 #endif /* _UTIL_RADIUS_H_ */