mech_eap/util_saml.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  * SAML attribute provider.
  35  */
  36
  37 #ifndef _UTIL_SAML_H_
  38 #define _UTIL_SAML_H_ 1
  39
  40 #ifdef __cplusplus
  41
  42 namespace opensaml {
  43     namespace saml2 {
  44         class Attribute;
  45         class Assertion;
  46         class NameID;
  47     };
  48 };
  49
  50 struct gss_eap_saml_assertion_provider : gss_eap_attr_provider {
  51 public:
  52     gss_eap_saml_assertion_provider(void);
  53     ~gss_eap_saml_assertion_provider(void);
  54
  55     bool initWithExistingContext(const gss_eap_attr_ctx *source,
  56                                  const gss_eap_attr_provider *ctx);
  57     bool initWithGssContext(const gss_eap_attr_ctx *source,
  58                             const gss_cred_id_t cred,
  59                             const gss_ctx_id_t ctx);
  60
  61     bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
  62     bool setAttribute(int complete,
  63                       const gss_buffer_t attr,
  64                       const gss_buffer_t value);
  65     bool deleteAttribute(const gss_buffer_t value);
  66     bool getAttribute(const gss_buffer_t attr,
  67                       int *authenticated,
  68                       int *complete,
  69                       gss_buffer_t value,
  70                       gss_buffer_t display_value,
  71                       int *more) const;
  72     gss_any_t mapToAny(int authenticated,
  73                        gss_buffer_t type_id) const;
  74     void releaseAnyNameMapping(gss_buffer_t type_id,
  75                                gss_any_t input) const;
  76
  77     const char *prefix(void) const;
  78     const char *name(void) const { return NULL; }
  79     bool initWithJsonObject(const gss_eap_attr_ctx *manager GSSEAP_UNUSED,
  80                            JSONObject &object GSSEAP_UNUSED) {
  81         return false;
  82     }
  83     JSONObject jsonRepresentation(void) const {
  84         return JSONObject::null();
  85     }
  86
  87     opensaml::saml2::Assertion *initAssertion(void);
  88
  89     opensaml::saml2::Assertion *getAssertion(void) const {
  90         return m_assertion;
  91     }
  92     bool authenticated(void) const {
  93         return m_authenticated;
  94     }
  95
  96     time_t getExpiryTime(void) const;
  97     OM_uint32 mapException(OM_uint32 *minor, std::exception &e) const;
  98
  99     static bool init(void);
 100     static void finalize(void);
 101
 102     static gss_eap_attr_provider *createAttrContext(void);
 103
 104 private:
 105     static opensaml::saml2::Assertion *
 106         parseAssertion(const gss_buffer_t buffer);
 107
 108     void setAssertion(const opensaml::saml2::Assertion *assertion,
 109                       bool authenticated = false);
 110     void setAssertion(const gss_buffer_t buffer,
 111                       bool authenticated = false);
 112
 113     opensaml::saml2::Assertion *m_assertion;
 114     bool m_authenticated;
 115 };
 116
 117 struct gss_eap_saml_attr_provider : gss_eap_attr_provider {
 118 public:
 119     gss_eap_saml_attr_provider(void) {}
 120     ~gss_eap_saml_attr_provider(void) {}
 121
 122     bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
 123     bool setAttribute(int complete,
 124                       const gss_buffer_t attr,
 125                       const gss_buffer_t value);
 126     bool deleteAttribute(const gss_buffer_t value);
 127     bool getAttribute(const gss_buffer_t attr,
 128                       int *authenticated,
 129                       int *complete,
 130                       gss_buffer_t value,
 131                       gss_buffer_t display_value,
 132                       int *more) const;
 133     gss_any_t mapToAny(int authenticated,
 134                        gss_buffer_t type_id) const;
 135     void releaseAnyNameMapping(gss_buffer_t type_id,
 136                                gss_any_t input) const;
 137
 138     const char *prefix(void) const;
 139     const char *name(void) const {
 140         return NULL;
 141     }
 142     bool initWithJsonObject(const gss_eap_attr_ctx *manager GSSEAP_UNUSED,
 143                             JSONObject &object GSSEAP_UNUSED) {
 144         return false;
 145     }
 146     JSONObject jsonRepresentation(void) const {
 147         return JSONObject::null();
 148     }
 149
 150     bool getAttribute(const gss_buffer_t attr,
 151                       int *authenticated,
 152                       int *complete,
 153                       const opensaml::saml2::Attribute **pAttribute) const;
 154     bool getAssertion(int *authenticated,
 155                       opensaml::saml2::Assertion **pAssertion,
 156                       bool createIfAbsent = false) const;
 157
 158     static bool init(void);
 159     static void finalize(void);
 160
 161     static gss_eap_attr_provider *createAttrContext(void);
 162
 163 private:
 164 };
 165
 166 extern "C" {
 167 #endif
 168
 169 OM_uint32 gssEapSamlAttrProvidersInit(OM_uint32 *minor);
 170 OM_uint32 gssEapSamlAttrProvidersFinalize(OM_uint32 *minor);
 171
 172 #ifdef __cplusplus
 173 }
 174 #endif
 175
 176 #endif /* _UTIL_SAML_H_ */