util_saml: correctly account for gss lengths
[mech_eap.orig] / util_shib.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  * Local attribute provider.
35  */
36
37 #ifndef _UTIL_SHIB_H_
38 #define _UTIL_SHIB_H_ 1
39
40 #ifdef __cplusplus
41
42 #include <vector>
43
44 namespace shibsp {
45     class Attribute;
46 };
47
48 namespace shibresolver {
49     class ShibbolethResolver;
50 };
51
52 struct gss_eap_shib_attr_provider : gss_eap_attr_provider {
53 public:
54     gss_eap_shib_attr_provider(void);
55     ~gss_eap_shib_attr_provider(void);
56
57     bool initFromExistingContext(const gss_eap_attr_ctx *source,
58                                  const gss_eap_attr_provider *ctx);
59     bool initFromGssContext(const gss_eap_attr_ctx *source,
60                             const gss_cred_id_t cred,
61                             const gss_ctx_id_t ctx);
62
63     bool setAttribute(int complete,
64                       const gss_buffer_t attr,
65                       const gss_buffer_t value);
66     bool deleteAttribute(const gss_buffer_t value);
67     bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
68     bool getAttribute(const gss_buffer_t attr,
69                       int *authenticated,
70                       int *complete,
71                       gss_buffer_t value,
72                       gss_buffer_t display_value,
73                       int *more) const;
74     gss_any_t mapToAny(int authenticated,
75                        gss_buffer_t type_id) const;
76     void releaseAnyNameMapping(gss_buffer_t type_id,
77                                gss_any_t input) const;
78
79     void exportToBuffer(gss_buffer_t buffer) const;
80     bool initFromBuffer(const gss_eap_attr_ctx *ctx,
81                         const gss_buffer_t buffer);
82
83     static bool init(void);
84     static void finalize(void);
85
86     OM_uint32 mapException(OM_uint32 *minor, std::exception &e) const;
87
88     static gss_eap_attr_provider *createAttrContext(void);
89
90 private:
91     static shibsp::Attribute *
92         duplicateAttribute(const shibsp::Attribute *src);
93     static std::vector <shibsp::Attribute *>
94         duplicateAttributes(const std::vector <shibsp::Attribute *>src);
95
96     ssize_t getAttributeIndex(const gss_buffer_t attr) const;
97     const shibsp::Attribute *getAttribute(const gss_buffer_t attr) const;
98
99     std::vector<shibsp::Attribute *> getAttributes(void) const {
100         return m_attributes;
101     }
102
103     bool authenticated(void) const { return m_authenticated; }
104
105     friend bool
106     addRadiusAttribute(const gss_eap_attr_provider *source,
107                        const gss_buffer_t attribute,
108                        void *data);
109
110     std::vector<shibsp::Attribute *> m_attributes;
111     int m_authenticated;
112 };
113
114
115 extern "C" {
116 #endif
117
118 OM_uint32 gssEapLocalAttrProviderInit(OM_uint32 *minor);
119 OM_uint32 gssEapLocalAttrProviderFinalize(OM_uint32 *minor);
120
121 #ifdef __cplusplus
122 }
123 #endif
124
125 #endif /* _UTIL_SHIB_H_ */