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