initial libradsec port
[mech_eap.orig] / 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 #ifdef __cplusplus
37
38 namespace opensaml {
39     namespace saml2 {
40         class Attribute;
41         class Assertion;
42         class NameID;
43     };
44 };
45
46 struct gss_eap_saml_assertion_provider : gss_eap_attr_provider {
47 public:
48     gss_eap_saml_assertion_provider(void);
49     ~gss_eap_saml_assertion_provider(void);
50
51     bool initFromExistingContext(const gss_eap_attr_ctx *source,
52                                  const gss_eap_attr_provider *ctx);
53     bool initFromGssContext(const gss_eap_attr_ctx *source,
54                             const gss_cred_id_t cred,
55                             const gss_ctx_id_t ctx);
56
57     bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
58     void setAttribute(int complete,
59                       const gss_buffer_t attr,
60                       const gss_buffer_t value);
61     void deleteAttribute(const gss_buffer_t value);
62     bool getAttribute(const gss_buffer_t attr,
63                       int *authenticated,
64                       int *complete,
65                       gss_buffer_t value,
66                       gss_buffer_t display_value,
67                       int *more) const;
68     gss_any_t mapToAny(int authenticated,
69                        gss_buffer_t type_id) const;
70     void releaseAnyNameMapping(gss_buffer_t type_id,
71                                gss_any_t input) const;
72
73     void exportToBuffer(gss_buffer_t buffer) const;
74     bool initFromBuffer(const gss_eap_attr_ctx *ctx,
75                         const gss_buffer_t buffer);
76
77     const opensaml::saml2::Assertion *getAssertion(void) const {
78         return m_assertion;
79     }
80     bool authenticated(void) const {
81         return m_authenticated;
82     }
83
84     time_t getExpiryTime(void) const;
85
86     static bool init(void);
87     static void finalize(void);
88
89     static gss_eap_attr_provider *createAttrContext(void);
90
91 private:
92     static opensaml::saml2::Assertion *
93         parseAssertion(const gss_buffer_t buffer);
94
95     void setAssertion(const opensaml::saml2::Assertion *assertion,
96                       bool authenticated = false);
97     void setAssertion(const gss_buffer_t buffer,
98                       bool authenticated = false);
99
100     opensaml::saml2::Assertion *m_assertion;
101     bool m_authenticated;
102 };
103
104 struct gss_eap_saml_attr_provider : gss_eap_attr_provider {
105 public:
106     gss_eap_saml_attr_provider(void) {}
107     ~gss_eap_saml_attr_provider(void) {}
108
109     bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
110     void setAttribute(int complete,
111                       const gss_buffer_t attr,
112                       const gss_buffer_t value);
113     void deleteAttribute(const gss_buffer_t value);
114     bool getAttribute(const gss_buffer_t attr,
115                       int *authenticated,
116                       int *complete,
117                       gss_buffer_t value,
118                       gss_buffer_t display_value,
119                       int *more) const;
120     gss_any_t mapToAny(int authenticated,
121                        gss_buffer_t type_id) const;
122     void releaseAnyNameMapping(gss_buffer_t type_id,
123                                gss_any_t input) const;
124
125     void exportToBuffer(gss_buffer_t buffer) const;
126     bool initFromBuffer(const gss_eap_attr_ctx *ctx,
127                         const gss_buffer_t buffer);
128
129     bool getAttribute(const gss_buffer_t attr,
130                       int *authenticated,
131                       int *complete,
132                       const opensaml::saml2::Attribute **pAttribute) const;
133     bool getAssertion(int *authenticated,
134                       const opensaml::saml2::Assertion **pAssertion) const;
135
136     static bool init(void);
137     static void finalize(void);
138
139     static gss_eap_attr_provider *createAttrContext(void);
140
141 private:
142 };
143
144 extern "C" {
145 #endif
146
147 OM_uint32 gssEapSamlAttrProvidersInit(OM_uint32 *minor);
148 OM_uint32 gssEapSamlAttrProvidersFinalize(OM_uint32 *minor);
149
150 #ifdef __cplusplus
151 }
152 #endif
153
154 #endif /* _UTIL_SAML_H_ */