mech_eap/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 #ifndef _UTIL_SAML_H_
  34 #define _UTIL_SAML_H_ 1
  35
  36 namespace opensaml {
  37     namespace saml2 {
  38         class Attribute;
  39         class Assertion;
  40         class NameID;
  41     };
  42 };
  43
  44 struct gss_eap_saml_assertion_provider : gss_eap_attr_provider {
  45 public:
  46     gss_eap_saml_assertion_provider(void);
  47     ~gss_eap_saml_assertion_provider(void);
  48
  49     bool initFromExistingContext(const gss_eap_attr_ctx *source,
  50                                  const gss_eap_attr_provider *ctx);
  51     bool initFromGssContext(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     void setAttribute(int complete,
  57                       const gss_buffer_t attr,
  58                       const gss_buffer_t value);
  59     void deleteAttribute(const gss_buffer_t value);
  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     void exportToBuffer(gss_buffer_t buffer) const;
  72     bool initFromBuffer(const gss_eap_attr_ctx *ctx,
  73                         const gss_buffer_t buffer);
  74
  75     const opensaml::saml2::Assertion *getAssertion(void) const {
  76         return m_assertion;
  77     }
  78     bool authenticated(void) const {
  79         return m_authenticated;
  80     }
  81
  82     time_t getExpiryTime(void) const;
  83
  84     static bool init();
  85     static void finalize();
  86
  87     static gss_eap_attr_provider *createAttrContext(void);
  88
  89 private:
  90     static opensaml::saml2::Assertion *
  91         parseAssertion(const gss_buffer_t buffer);
  92
  93     void setAssertion(const opensaml::saml2::Assertion *assertion,
  94                       bool authenticated = false);
  95     void setAssertion(const gss_buffer_t buffer,
  96                       bool authenticated = false);
  97
  98     opensaml::saml2::Assertion *m_assertion;
  99     bool m_authenticated;
 100 };
 101
 102 struct gss_eap_saml_attr_provider : gss_eap_attr_provider {
 103 public:
 104     gss_eap_saml_attr_provider(void) {}
 105     ~gss_eap_saml_attr_provider(void) {}
 106
 107     bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
 108     void setAttribute(int complete,
 109                       const gss_buffer_t attr,
 110                       const gss_buffer_t value);
 111     void deleteAttribute(const gss_buffer_t value);
 112     bool getAttribute(const gss_buffer_t attr,
 113                       int *authenticated,
 114                       int *complete,
 115                       gss_buffer_t value,
 116                       gss_buffer_t display_value,
 117                       int *more) const;
 118     gss_any_t mapToAny(int authenticated,
 119                        gss_buffer_t type_id) const;
 120     void releaseAnyNameMapping(gss_buffer_t type_id,
 121                                gss_any_t input) const;
 122
 123     void exportToBuffer(gss_buffer_t buffer) const;
 124     bool initFromBuffer(const gss_eap_attr_ctx *ctx,
 125                         const gss_buffer_t buffer);
 126
 127     bool getAttribute(const gss_buffer_t attr,
 128                       int *authenticated,
 129                       int *complete,
 130                       const opensaml::saml2::Attribute **pAttribute) const;
 131     bool getAssertion(int *authenticated,
 132                       const opensaml::saml2::Assertion **pAssertion) const;
 133
 134     static bool init();
 135     static void finalize();
 136
 137     static gss_eap_attr_provider *createAttrContext(void);
 138
 139 private:
 140 };
 141
 142 #endif /* _UTIL_SAML_H_ */