util_saml.h

   1 /*
   2  * Copyright (c) 2010, 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 initFromExistingContext(const gss_eap_attr_ctx *source,
  56                                  const gss_eap_attr_provider *ctx);
  57     bool initFromGssContext(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     void exportToBuffer(gss_buffer_t buffer) const;
  78     bool initFromBuffer(const gss_eap_attr_ctx *ctx,
  79                         const gss_buffer_t buffer);
  80
  81     opensaml::saml2::Assertion *initAssertion(void);
  82
  83     opensaml::saml2::Assertion *getAssertion(void) const {
  84         return m_assertion;
  85     }
  86     bool authenticated(void) const {
  87         return m_authenticated;
  88     }
  89
  90     time_t getExpiryTime(void) const;
  91
  92     static bool init(void);
  93     static void finalize(void);
  94
  95     static gss_eap_attr_provider *createAttrContext(void);
  96
  97 private:
  98     static opensaml::saml2::Assertion *
  99         parseAssertion(const gss_buffer_t buffer);
 100
 101     void setAssertion(const opensaml::saml2::Assertion *assertion,
 102                       bool authenticated = false);
 103     void setAssertion(const gss_buffer_t buffer,
 104                       bool authenticated = false);
 105
 106     opensaml::saml2::Assertion *m_assertion;
 107     bool m_authenticated;
 108 };
 109
 110 struct gss_eap_saml_attr_provider : gss_eap_attr_provider {
 111 public:
 112     gss_eap_saml_attr_provider(void) {}
 113     ~gss_eap_saml_attr_provider(void) {}
 114
 115     bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
 116     bool setAttribute(int complete,
 117                       const gss_buffer_t attr,
 118                       const gss_buffer_t value);
 119     bool deleteAttribute(const gss_buffer_t value);
 120     bool getAttribute(const gss_buffer_t attr,
 121                       int *authenticated,
 122                       int *complete,
 123                       gss_buffer_t value,
 124                       gss_buffer_t display_value,
 125                       int *more) const;
 126     gss_any_t mapToAny(int authenticated,
 127                        gss_buffer_t type_id) const;
 128     void releaseAnyNameMapping(gss_buffer_t type_id,
 129                                gss_any_t input) const;
 130
 131     void exportToBuffer(gss_buffer_t buffer) const;
 132     bool initFromBuffer(const gss_eap_attr_ctx *ctx,
 133                         const gss_buffer_t buffer);
 134
 135     bool getAttribute(const gss_buffer_t attr,
 136                       int *authenticated,
 137                       int *complete,
 138                       const opensaml::saml2::Attribute **pAttribute) const;
 139     bool getAssertion(int *authenticated,
 140                       opensaml::saml2::Assertion **pAssertion,
 141                       bool createIfAbsent = false) const;
 142
 143     static bool init(void);
 144     static void finalize(void);
 145
 146     static gss_eap_attr_provider *createAttrContext(void);
 147
 148 private:
 149 };
 150
 151 extern "C" {
 152 #endif
 153
 154 OM_uint32 gssEapSamlAttrProvidersInit(OM_uint32 *minor);
 155 OM_uint32 gssEapSamlAttrProvidersFinalize(OM_uint32 *minor);
 156
 157 #ifdef __cplusplus
 158 }
 159 #endif
 160
 161 #endif /* _UTIL_SAML_H_ */