remove debugging statement
[moonshot.git] / 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 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     const char *marshallingKey(void) const {
78         return NULL;
79     }
80     bool unmarshallAndInit(const gss_eap_attr_ctx *manager GSSEAP_UNUSED,
81                            DDF &object GSSEAP_UNUSED) {
82         return false;
83     }
84     DDF marshall(void) const {
85         return DDF(NULL);
86     }
87
88     opensaml::saml2::Assertion *initAssertion(void);
89
90     opensaml::saml2::Assertion *getAssertion(void) const {
91         return m_assertion;
92     }
93     bool authenticated(void) const {
94         return m_authenticated;
95     }
96
97     time_t getExpiryTime(void) const;
98     OM_uint32 mapException(OM_uint32 *minor, std::exception &e) const;
99
100     static bool init(void);
101     static void finalize(void);
102
103     static gss_eap_attr_provider *createAttrContext(void);
104
105 private:
106     static opensaml::saml2::Assertion *
107         parseAssertion(const gss_buffer_t buffer);
108
109     void setAssertion(const opensaml::saml2::Assertion *assertion,
110                       bool authenticated = false);
111     void setAssertion(const gss_buffer_t buffer,
112                       bool authenticated = false);
113
114     opensaml::saml2::Assertion *m_assertion;
115     bool m_authenticated;
116 };
117
118 struct gss_eap_saml_attr_provider : gss_eap_attr_provider {
119 public:
120     gss_eap_saml_attr_provider(void) {}
121     ~gss_eap_saml_attr_provider(void) {}
122
123     bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
124     bool setAttribute(int complete,
125                       const gss_buffer_t attr,
126                       const gss_buffer_t value);
127     bool deleteAttribute(const gss_buffer_t value);
128     bool getAttribute(const gss_buffer_t attr,
129                       int *authenticated,
130                       int *complete,
131                       gss_buffer_t value,
132                       gss_buffer_t display_value,
133                       int *more) const;
134     gss_any_t mapToAny(int authenticated,
135                        gss_buffer_t type_id) const;
136     void releaseAnyNameMapping(gss_buffer_t type_id,
137                                gss_any_t input) const;
138
139     const char *marshallingKey(void) const {
140         return NULL;
141     }
142     bool unmarshallAndInit(const gss_eap_attr_ctx *manager GSSEAP_UNUSED,
143                            DDF &object GSSEAP_UNUSED) {
144         return false;
145     }
146     DDF marshall(void) const {
147         return DDF(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_ */