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_source : gss_eap_attr_source {
  45 public:
  46     gss_eap_saml_assertion_source(void) {}
  47     ~gss_eap_saml_assertion_source(void);
  48
  49     bool initFromExistingContext(const gss_eap_attr_ctx *source,
  50                                  const gss_eap_attr_source *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     void setAssertion(const opensaml::saml2::Assertion *assertion);
  76
  77     const opensaml::saml2::Assertion *getAssertion(void) const {
  78         return m_assertion;
  79     }
  80
  81     static bool init();
  82     static void finalize();
  83
  84     static gss_eap_attr_source *createAttrContext(void);
  85
  86 private:
  87     static opensaml::saml2::Assertion *
  88         parseAssertion(const gss_buffer_t buffer);
  89
  90     opensaml::saml2::Assertion *m_assertion;
  91 };
  92
  93 struct gss_eap_saml_attr_source : gss_eap_attr_source {
  94 public:
  95     gss_eap_saml_attr_source(void) {}
  96     ~gss_eap_saml_attr_source(void);
  97
  98     bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
  99     void setAttribute(int complete,
 100                       const gss_buffer_t attr,
 101                       const gss_buffer_t value);
 102     void deleteAttribute(const gss_buffer_t value);
 103     bool getAttribute(const gss_buffer_t attr,
 104                       int *authenticated,
 105                       int *complete,
 106                       gss_buffer_t value,
 107                       gss_buffer_t display_value,
 108                       int *more) const;
 109     gss_any_t mapToAny(int authenticated,
 110                        gss_buffer_t type_id) const;
 111     void releaseAnyNameMapping(gss_buffer_t type_id,
 112                                gss_any_t input) const;
 113
 114     void exportToBuffer(gss_buffer_t buffer) const;
 115     bool initFromBuffer(const gss_eap_attr_ctx *ctx,
 116                         const gss_buffer_t buffer);
 117
 118     const opensaml::saml2::Attribute *
 119         getAttribute(const gss_buffer_t attr) const;
 120
 121     const opensaml::saml2::Assertion *getAssertion(void) const;
 122
 123     static bool init();
 124     static void finalize();
 125
 126     static gss_eap_attr_source *createAttrContext(void);
 127
 128 private:
 129 };
 130
 131 #endif /* _UTIL_SAML_H_ */