mech_eap/util_attr.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  * Attribute provider interface.
  35  */
  36
  37 #ifndef _UTIL_ATTR_H_
  38 #define _UTIL_ATTR_H_ 1
  39
  40 #ifdef __cplusplus
  41 #include <string>
  42 #include <new>
  43
  44 #include <shibsp/remoting/ddf.h>
  45
  46 using namespace shibsp;
  47
  48 struct gss_eap_attr_provider;
  49 struct gss_eap_attr_ctx;
  50
  51 typedef bool
  52 (*gss_eap_attr_enumeration_cb)(const gss_eap_attr_provider *source,
  53                                const gss_buffer_t attribute,
  54                                void *data);
  55
  56 #define ATTR_TYPE_RADIUS            0U                  /* RADIUS AVPs */
  57 #define ATTR_TYPE_SAML_ASSERTION    1U                  /* SAML assertion */
  58 #define ATTR_TYPE_SAML              2U                  /* SAML attributes */
  59 #define ATTR_TYPE_LOCAL             3U                  /* Local attributes */
  60 #define ATTR_TYPE_MIN               ATTR_TYPE_RADIUS
  61 #define ATTR_TYPE_MAX               ATTR_TYPE_LOCAL
  62
  63 #define ATTR_FLAG_DISABLE_LOCAL     0x00000001
  64
  65 /*
  66  * Attribute provider: this represents a source of attributes derived
  67  * from the security context.
  68  */
  69 struct gss_eap_attr_provider
  70 {
  71 public:
  72     gss_eap_attr_provider(void) {}
  73     virtual ~gss_eap_attr_provider(void) {}
  74
  75     bool initWithManager(const gss_eap_attr_ctx *manager)
  76     {
  77         m_manager = manager;
  78         return true;
  79     }
  80
  81     virtual bool initFromExistingContext(const gss_eap_attr_ctx *manager,
  82                                          const gss_eap_attr_provider *ctx GSSEAP_UNUSED)
  83     {
  84         return initWithManager(manager);
  85     }
  86
  87     virtual bool initFromGssContext(const gss_eap_attr_ctx *manager,
  88                                     const gss_cred_id_t cred GSSEAP_UNUSED,
  89                                     const gss_ctx_id_t ctx GSSEAP_UNUSED)
  90     {
  91         return initWithManager(manager);
  92     }
  93
  94     virtual bool getAttributeTypes(gss_eap_attr_enumeration_cb GSSEAP_UNUSED,
  95                                    void *data GSSEAP_UNUSED) const
  96     {
  97         return false;
  98     }
  99
 100     virtual bool setAttribute(int complete GSSEAP_UNUSED,
 101                               const gss_buffer_t attr GSSEAP_UNUSED,
 102                               const gss_buffer_t value GSSEAP_UNUSED)
 103     {
 104         return false;
 105     }
 106
 107     virtual bool deleteAttribute(const gss_buffer_t value GSSEAP_UNUSED)
 108     {
 109         return false;
 110     }
 111
 112     virtual bool getAttribute(const gss_buffer_t attr GSSEAP_UNUSED,
 113                               int *authenticated GSSEAP_UNUSED,
 114                               int *complete GSSEAP_UNUSED,
 115                               gss_buffer_t value GSSEAP_UNUSED,
 116                               gss_buffer_t display_value GSSEAP_UNUSED,
 117                               int *more GSSEAP_UNUSED) const
 118     {
 119         return false;
 120     }
 121
 122     virtual gss_any_t mapToAny(int authenticated GSSEAP_UNUSED,
 123                                gss_buffer_t type_id GSSEAP_UNUSED) const
 124     {
 125         return NULL;
 126     }
 127     virtual void releaseAnyNameMapping(gss_buffer_t type_id GSSEAP_UNUSED,
 128                                        gss_any_t input GSSEAP_UNUSED) const
 129     {
 130     }
 131
 132     virtual bool unmarshallAndInit(const gss_eap_attr_ctx *manager,
 133                                    DDF &object GSSEAP_UNUSED)
 134     {
 135         return initWithManager(manager);
 136     }
 137
 138     virtual DDF marshall(void) const
 139     {
 140         return DDF(NULL);
 141     }
 142
 143     virtual time_t getExpiryTime(void) const { return 0; }
 144
 145     virtual OM_uint32 mapException(OM_uint32 *minor GSSEAP_UNUSED,
 146                                    std::exception &e GSSEAP_UNUSED) const
 147     {
 148         return GSS_S_CONTINUE_NEEDED;
 149     }
 150
 151     static bool init(void) { return true; }
 152     static void finalize(void) {}
 153
 154     static gss_eap_attr_provider *createAttrContext(void) { return NULL; }
 155
 156 protected:
 157     const gss_eap_attr_ctx *m_manager;
 158
 159 private:
 160     /* make non-copyable */
 161     gss_eap_attr_provider(const gss_eap_attr_provider&);
 162     gss_eap_attr_provider& operator=(const gss_eap_attr_provider&);
 163 };
 164
 165 typedef gss_eap_attr_provider *(*gss_eap_attr_create_provider)(void);
 166
 167 /*
 168  * Attribute context: this manages a set of providers for a given
 169  * security context.
 170  */
 171 struct gss_eap_attr_ctx
 172 {
 173 public:
 174     gss_eap_attr_ctx(void);
 175     ~gss_eap_attr_ctx(void);
 176
 177     bool initFromExistingContext(const gss_eap_attr_ctx *manager);
 178     bool initFromGssContext(const gss_cred_id_t cred,
 179                             const gss_ctx_id_t ctx);
 180
 181     bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
 182     bool getAttributeTypes(gss_buffer_set_t *attrs);
 183
 184     bool setAttribute(int complete,
 185                       const gss_buffer_t attr,
 186                       const gss_buffer_t value);
 187     bool deleteAttribute(const gss_buffer_t value);
 188     bool getAttribute(const gss_buffer_t attr,
 189                       int *authenticated,
 190                       int *complete,
 191                       gss_buffer_t value,
 192                       gss_buffer_t display_value,
 193                       int *more) const;
 194     gss_any_t mapToAny(int authenticated,
 195                        gss_buffer_t type_id) const;
 196     void releaseAnyNameMapping(gss_buffer_t type_id,
 197                                gss_any_t input) const;
 198
 199     void exportToBuffer(gss_buffer_t buffer) const;
 200     bool initFromBuffer(const gss_buffer_t buffer);
 201
 202     static unsigned int
 203     attributePrefixToType(const gss_buffer_t prefix);
 204
 205     static const gss_buffer_t
 206     attributeTypeToPrefix(unsigned int type);
 207
 208     static void
 209     decomposeAttributeName(const gss_buffer_t attribute,
 210                            gss_buffer_t prefix,
 211                            gss_buffer_t suffix);
 212     static void
 213     composeAttributeName(const gss_buffer_t prefix,
 214                          const gss_buffer_t suffix,
 215                          gss_buffer_t attribute);
 216     static void
 217     decomposeAttributeName(const gss_buffer_t attribute,
 218                            unsigned int *type,
 219                            gss_buffer_t suffix);
 220     static void
 221     composeAttributeName(unsigned int type,
 222                          const gss_buffer_t suffix,
 223                          gss_buffer_t attribute);
 224
 225     static std::string
 226     composeAttributeName(const gss_buffer_t prefix,
 227                          const gss_buffer_t suffix);
 228     static std::string
 229     composeAttributeName(unsigned int type,
 230                          const gss_buffer_t suffix);
 231
 232     gss_eap_attr_provider *getProvider(unsigned int type) const;
 233     gss_eap_attr_provider *getProvider(const gss_buffer_t prefix) const;
 234
 235     static void
 236     registerProvider(unsigned int type,
 237                      const char *prefix,
 238                      gss_eap_attr_create_provider factory);
 239     static void
 240     unregisterProvider(unsigned int type);
 241
 242     time_t getExpiryTime(void) const;
 243     OM_uint32 mapException(OM_uint32 *minor, std::exception &e) const;
 244
 245 private:
 246     bool providerEnabled(unsigned int type) const;
 247     void releaseProvider(unsigned int type);
 248
 249     bool unmarshallAndInit(DDF &object);
 250     DDF marshall(void) const;
 251
 252     gss_eap_attr_provider *getPrimaryProvider(void) const;
 253
 254     /* make non-copyable */
 255     gss_eap_attr_ctx(const gss_eap_attr_ctx&);
 256     gss_eap_attr_ctx& operator=(const gss_eap_attr_ctx&);
 257
 258     uint32_t m_flags;
 259     gss_eap_attr_provider *m_providers[ATTR_TYPE_MAX + 1];
 260 };
 261
 262 #endif /* __cplusplus */
 263
 264 #include "util_radius.h"
 265 #include "util_saml.h"
 266 #include "util_shib.h"
 267
 268 #ifdef __cplusplus
 269
 270 static inline void
 271 duplicateBuffer(gss_buffer_desc &src, gss_buffer_t dst)
 272 {
 273     OM_uint32 minor;
 274
 275     if (GSS_ERROR(duplicateBuffer(&minor, &src, dst)))
 276         throw new std::bad_alloc();
 277 }
 278
 279 static inline void
 280 duplicateBuffer(std::string &str, gss_buffer_t buffer)
 281 {
 282     gss_buffer_desc tmp;
 283
 284     tmp.length = str.length();
 285     tmp.value = (char *)str.c_str();
 286
 287     duplicateBuffer(tmp, buffer);
 288 }
 289
 290 #else
 291 struct gss_eap_attr_ctx;
 292 #endif
 293
 294 #ifdef __cplusplus
 295 extern "C" {
 296 #endif
 297
 298 /*
 299  * C wrappers for attribute context functions. These match their
 300  * GSS naming extension equivalents. The caller is required to
 301  * obtain the name mutex.
 302  */
 303
 304 OM_uint32
 305 gssEapCreateAttrContext(OM_uint32 *minor,
 306                         gss_cred_id_t acceptorCred,
 307                         gss_ctx_id_t acceptorCtx,
 308                         struct gss_eap_attr_ctx **pAttrCtx,
 309                         time_t *pExpiryTime);
 310
 311 OM_uint32
 312 gssEapInquireName(OM_uint32 *minor,
 313                   gss_name_t name,
 314                   int *name_is_MN,
 315                   gss_OID *MN_mech,
 316                   gss_buffer_set_t *attrs);
 317
 318 OM_uint32
 319 gssEapGetNameAttribute(OM_uint32 *minor,
 320                        gss_name_t name,
 321                        gss_buffer_t attr,
 322                        int *authenticated,
 323                        int *complete,
 324                        gss_buffer_t value,
 325                        gss_buffer_t display_value,
 326                        int *more);
 327
 328 OM_uint32
 329 gssEapDeleteNameAttribute(OM_uint32 *minor,
 330                           gss_name_t name,
 331                           gss_buffer_t attr);
 332
 333 OM_uint32
 334 gssEapSetNameAttribute(OM_uint32 *minor,
 335                        gss_name_t name,
 336                        int complete,
 337                        gss_buffer_t attr,
 338                        gss_buffer_t value);
 339
 340 OM_uint32
 341 gssEapExportAttrContext(OM_uint32 *minor,
 342                         gss_name_t name,
 343                         gss_buffer_t buffer);
 344
 345 OM_uint32
 346 gssEapImportAttrContext(OM_uint32 *minor,
 347                         gss_buffer_t buffer,
 348                         gss_name_t name);
 349
 350 OM_uint32
 351 gssEapDuplicateAttrContext(OM_uint32 *minor,
 352                            gss_name_t in,
 353                            gss_name_t out);
 354
 355 OM_uint32
 356 gssEapMapNameToAny(OM_uint32 *minor,
 357                    gss_name_t name,
 358                    int authenticated,
 359                    gss_buffer_t type_id,
 360                    gss_any_t *output);
 361
 362 OM_uint32
 363 gssEapReleaseAnyNameMapping(OM_uint32 *minor,
 364                             gss_name_t name,
 365                             gss_buffer_t type_id,
 366                             gss_any_t *input);
 367
 368 OM_uint32
 369 gssEapReleaseAttrContext(OM_uint32 *minor,
 370                          gss_name_t name);
 371
 372 OM_uint32
 373 gssEapAttrProvidersFinalize(OM_uint32 *minor);
 374
 375 #ifdef __cplusplus
 376 }
 377 #endif
 378
 379 #endif /* _UTIL_ATTR_H_ */