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 typedef std::pair <unsigned int, unsigned int> gss_eap_attrid;
  43
  44 struct gss_eap_radius_attr_provider : gss_eap_attr_provider {
  45 public:
  46     gss_eap_radius_attr_provider(void);
  47     ~gss_eap_radius_attr_provider(void);
  48
  49     bool initWithExistingContext(const gss_eap_attr_ctx *source,
  50                                  const gss_eap_attr_provider *ctx);
  51     bool initWithGssContext(const gss_eap_attr_ctx *source,
  52                             const gss_cred_id_t cred,
  53                             const gss_ctx_id_t ctx);
  54
  55     bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
  56     bool setAttribute(int complete,
  57                       const gss_buffer_t attr,
  58                       const gss_buffer_t value);
  59     bool deleteAttribute(const gss_buffer_t attr);
  60     bool getAttribute(const gss_buffer_t attr,
  61                       int *authenticated,
  62                       int *complete,
  63                       gss_buffer_t value,
  64                       gss_buffer_t display_value,
  65                       int *more) const;
  66     gss_any_t mapToAny(int authenticated,
  67                        gss_buffer_t type_id) const;
  68     void releaseAnyNameMapping(gss_buffer_t type_id,
  69                                gss_any_t input) const;
  70
  71     const char *prefix(void) const;
  72     const char *name(void) const;
  73     bool initWithJsonObject(const gss_eap_attr_ctx *manager,
  74                            JSONObject &obj);
  75     JSONObject jsonRepresentation(void) const;
  76
  77     bool getAttribute(const gss_eap_attrid &attrid,
  78                       int *authenticated,
  79                       int *complete,
  80                       gss_buffer_t value,
  81                       gss_buffer_t display_value,
  82                       int *more) const;
  83     bool setAttribute(int complete,
  84                       const gss_eap_attrid &attrid,
  85                       const gss_buffer_t value);
  86     bool deleteAttribute(const gss_eap_attrid &attrid);
  87
  88     bool getFragmentedAttribute(const gss_eap_attrid &attrid,
  89                                 int *authenticated,
  90                                 int *complete,
  91                                 gss_buffer_t value) const;
  92
  93     bool authenticated(void) const { return m_authenticated; }
  94
  95     time_t getExpiryTime(void) const;
  96
  97     static bool init(void);
  98     static void finalize(void);
  99
 100     static gss_eap_attr_provider *createAttrContext(void);
 101
 102 private:
 103     rs_const_avp *getAvps(void) const {
 104         return m_vps;
 105     }
 106
 107     rs_avp *m_vps;
 108     bool m_authenticated;
 109 };
 110
 111 /* For now */
 112 extern "C" {
 113 #endif
 114
 115 OM_uint32
 116 gssEapRadiusAddAvp(OM_uint32 *minor,
 117                    struct rs_packet *pkt,
 118                    unsigned int type,
 119                    unsigned int vendor,
 120                    const gss_buffer_t buffer);
 121
 122 OM_uint32
 123 gssEapRadiusGetAvp(OM_uint32 *minor,
 124                    struct rs_packet *pkt,
 125                    unsigned int type,
 126                    unsigned int vendor,
 127                    gss_buffer_t buffer,
 128                    int concat);
 129
 130 OM_uint32
 131 gssEapRadiusGetRawAvp(OM_uint32 *minor,
 132                       rs_const_avp *vps,
 133                       unsigned int type,
 134                       unsigned int vendor,
 135                       rs_const_avp **vp);
 136 OM_uint32
 137 gssEapRadiusFreeAvps(OM_uint32 *minor,
 138                      rs_avp **vps);
 139
 140 OM_uint32 gssEapRadiusAttrProviderInit(OM_uint32 *minor);
 141 OM_uint32 gssEapRadiusAttrProviderFinalize(OM_uint32 *minor);
 142
 143 OM_uint32
 144 gssEapRadiusMapError(OM_uint32 *minor,
 145                      struct rs_error *err);
 146
 147 OM_uint32
 148 gssEapCreateRadiusContext(OM_uint32 *minor,
 149                           gss_cred_id_t cred,
 150                           struct rs_context **pRadContext);
 151
 152 /* This really needs to be a function call on Windows */
 153 #define RS_CONFIG_FILE      SYSCONFDIR "/radsec.conf"
 154
 155 #ifdef __cplusplus
 156 }
 157 #endif
 158
 159 #endif /* _UTIL_RADIUS_H_ */