2 * Copyright (c) 2010, JANET(UK)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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.
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.
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
34 #define _UTIL_ATTR_H_ 1
36 #define ATTR_TYPE_RADIUS 0U
37 #define ATTR_TYPE_SAML_ASSERTION 1U
38 #define ATTR_TYPE_SAML 2U
39 #define ATTR_TYPE_LOCAL 3U
40 #define ATTR_TYPE_MIN ATTR_TYPE_RADIUS
41 #define ATTR_TYPE_MAX ATTR_TYPE_LOCAL
46 struct gss_eap_attr_provider;
47 struct gss_eap_attr_ctx;
50 (*gss_eap_attr_enumeration_cb)(const gss_eap_attr_provider *source,
51 const gss_buffer_t attribute,
55 * Attribute provider: this represents a source of attributes derived
56 * from the security context.
58 struct gss_eap_attr_provider
61 gss_eap_attr_provider(void) {}
62 virtual ~gss_eap_attr_provider(void) {}
64 bool initWithManager(const gss_eap_attr_ctx *manager)
70 virtual bool initFromExistingContext(const gss_eap_attr_ctx *manager,
71 const gss_eap_attr_provider *ctx)
73 return initWithManager(manager);
76 virtual bool initFromGssContext(const gss_eap_attr_ctx *manager,
77 const gss_cred_id_t cred,
78 const gss_ctx_id_t ctx)
80 return initWithManager(manager);
83 virtual bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const
88 virtual void setAttribute(int complete,
89 const gss_buffer_t attr,
90 const gss_buffer_t value) {}
91 virtual void deleteAttribute(const gss_buffer_t value) {}
92 virtual bool getAttribute(const gss_buffer_t attr,
96 gss_buffer_t display_value,
97 int *more) const { return false; }
99 virtual gss_any_t mapToAny(int authenticated,
100 gss_buffer_t type_id) const { return NULL; }
101 virtual void releaseAnyNameMapping(gss_buffer_t type_id,
102 gss_any_t input) const {}
104 virtual void exportToBuffer(gss_buffer_t buffer) const {}
105 virtual bool initFromBuffer(const gss_eap_attr_ctx *manager,
106 const gss_buffer_t buffer)
108 return initWithManager(manager);
111 virtual time_t getExpiryTime(void) const { return 0; }
113 static bool init() { return true; }
114 static void finalize() {}
116 static gss_eap_attr_provider *createAttrContext(void) { return NULL; }
119 const gss_eap_attr_ctx *m_manager;
122 /* make non-copyable */
123 gss_eap_attr_provider(const gss_eap_attr_provider&);
124 gss_eap_attr_provider& operator=(const gss_eap_attr_provider&);
127 typedef gss_eap_attr_provider *(*gss_eap_attr_create_provider)(void);
130 * Attribute context: this manages a set of providers for a given
133 struct gss_eap_attr_ctx
136 gss_eap_attr_ctx(void);
137 ~gss_eap_attr_ctx(void);
139 bool initFromExistingContext(const gss_eap_attr_ctx *manager);
140 bool initFromGssContext(const gss_cred_id_t cred,
141 const gss_ctx_id_t ctx);
143 bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
144 bool getAttributeTypes(gss_buffer_set_t *attrs);
146 void setAttribute(int complete,
147 const gss_buffer_t attr,
148 const gss_buffer_t value);
149 void deleteAttribute(const gss_buffer_t value);
150 bool getAttribute(const gss_buffer_t attr,
154 gss_buffer_t display_value,
156 gss_any_t mapToAny(int authenticated,
157 gss_buffer_t type_id) const;
158 void releaseAnyNameMapping(gss_buffer_t type_id,
159 gss_any_t input) const;
161 void exportToBuffer(gss_buffer_t buffer) const;
162 bool initFromBuffer(const gss_buffer_t buffer);
165 attributePrefixToType(const gss_buffer_t prefix);
167 static const gss_buffer_t
168 attributeTypeToPrefix(unsigned int type);
171 decomposeAttributeName(const gss_buffer_t attribute,
173 gss_buffer_t suffix);
175 composeAttributeName(const gss_buffer_t prefix,
176 const gss_buffer_t suffix,
177 gss_buffer_t attribute);
179 decomposeAttributeName(const gss_buffer_t attribute,
181 gss_buffer_t suffix);
183 composeAttributeName(unsigned int type,
184 const gss_buffer_t suffix,
185 gss_buffer_t attribute);
188 composeAttributeName(const gss_buffer_t prefix,
189 const gss_buffer_t suffix);
191 composeAttributeName(unsigned int type,
192 const gss_buffer_t suffix);
194 gss_eap_attr_provider *getProvider(unsigned int type) const;
195 gss_eap_attr_provider *getProvider(const gss_buffer_t prefix) const;
198 registerProvider(unsigned int type,
200 gss_eap_attr_create_provider factory);
202 unregisterProvider(unsigned int type);
204 time_t getExpiryTime(void) const;
207 gss_eap_attr_provider *getPrimaryProvider(void) const;
209 /* make non-copyable */
210 gss_eap_attr_ctx(const gss_eap_attr_ctx&);
211 gss_eap_attr_ctx& operator=(const gss_eap_attr_ctx&);
213 gss_eap_attr_provider *m_providers[ATTR_TYPE_MAX + 1];
216 #endif /* __cplusplus */
218 #include "util_radius.h"
219 #include "util_saml.h"
220 #include "util_shib.h"
228 duplicateBuffer(gss_buffer_desc &src, gss_buffer_t dst)
232 if (GSS_ERROR(duplicateBuffer(&minor, &src, dst)))
233 throw new std::bad_alloc();
237 duplicateBuffer(std::string &str, gss_buffer_t buffer)
241 tmp.length = str.length();
242 tmp.value = (char *)str.c_str();
244 duplicateBuffer(tmp, buffer);
248 struct gss_eap_attr_ctx;
256 * C wrappers for attribute context functions. These match their
257 * GSS naming extension equivalents. The caller is required to
258 * obtain the name mutex.
261 struct gss_eap_attr_ctx *
262 gssEapCreateAttrContext(gss_cred_id_t acceptorCred,
263 gss_ctx_id_t acceptorCtx);
266 gssEapInquireName(OM_uint32 *minor,
270 gss_buffer_set_t *attrs);
273 gssEapGetNameAttribute(OM_uint32 *minor,
279 gss_buffer_t display_value,
283 gssEapDeleteNameAttribute(OM_uint32 *minor,
288 gssEapSetNameAttribute(OM_uint32 *minor,
295 gssEapExportAttrContext(OM_uint32 *minor,
297 gss_buffer_t buffer);
300 gssEapImportAttrContext(OM_uint32 *minor,
305 gssEapDuplicateAttrContext(OM_uint32 *minor,
310 gssEapMapNameToAny(OM_uint32 *minor,
313 gss_buffer_t type_id,
317 gssEapReleaseAnyNameMapping(OM_uint32 *minor,
319 gss_buffer_t type_id,
323 gssEapReleaseAttrContext(OM_uint32 *minor,
327 gssEapAttrProvidersInit(OM_uint32 *minor);
330 gssEapAttrProvidersFinalize(OM_uint32 *minor);
336 #endif /* _UTIL_ATTR_H_ */