2 * Copyright (c) 2011, 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 * Attribute provider interface.
38 #define _UTIL_ATTR_H_ 1
44 using namespace gss_eap_util;
46 struct gss_eap_attr_provider;
47 struct gss_eap_attr_ctx;
50 (*gss_eap_attr_enumeration_cb)(const gss_eap_attr_ctx *ctx,
51 const gss_eap_attr_provider *source,
52 const gss_buffer_t attribute,
55 #define ATTR_TYPE_RADIUS 0U /* RADIUS AVPs */
56 #define ATTR_TYPE_SAML_ASSERTION 1U /* SAML assertion */
57 #define ATTR_TYPE_SAML 2U /* SAML attributes */
58 #define ATTR_TYPE_LOCAL 3U /* Local attributes */
59 #define ATTR_TYPE_MIN ATTR_TYPE_RADIUS
60 #define ATTR_TYPE_MAX ATTR_TYPE_LOCAL
63 * Attribute provider: this represents a source of attributes derived
64 * from the security context.
66 struct gss_eap_attr_provider
69 gss_eap_attr_provider(void) {}
70 virtual ~gss_eap_attr_provider(void) {}
72 bool initWithManager(const gss_eap_attr_ctx *manager)
78 virtual bool initFromExistingContext(const gss_eap_attr_ctx *manager,
79 const gss_eap_attr_provider *ctx GSSEAP_UNUSED)
81 return initWithManager(manager);
84 virtual bool initFromGssContext(const gss_eap_attr_ctx *manager,
85 const gss_cred_id_t cred GSSEAP_UNUSED,
86 const gss_ctx_id_t ctx GSSEAP_UNUSED)
88 return initWithManager(manager);
91 virtual bool getAttributeTypes(gss_eap_attr_enumeration_cb GSSEAP_UNUSED,
92 void *data GSSEAP_UNUSED) const
97 virtual bool setAttribute(int complete GSSEAP_UNUSED,
98 const gss_buffer_t attr GSSEAP_UNUSED,
99 const gss_buffer_t value GSSEAP_UNUSED)
104 virtual bool deleteAttribute(const gss_buffer_t value GSSEAP_UNUSED)
109 virtual bool getAttribute(const gss_buffer_t attr GSSEAP_UNUSED,
110 int *authenticated GSSEAP_UNUSED,
111 int *complete GSSEAP_UNUSED,
112 gss_buffer_t value GSSEAP_UNUSED,
113 gss_buffer_t display_value GSSEAP_UNUSED,
114 int *more GSSEAP_UNUSED) const
119 virtual gss_any_t mapToAny(int authenticated GSSEAP_UNUSED,
120 gss_buffer_t type_id GSSEAP_UNUSED) const
125 virtual void releaseAnyNameMapping(gss_buffer_t type_id GSSEAP_UNUSED,
126 gss_any_t input GSSEAP_UNUSED) const
130 /* prefix to be prepended to attributes emitted by gss_get_name_attribute */
131 virtual const char *prefix(void) const
136 /* optional key for storing JSON dictionary */
137 virtual const char *name(void) const
142 virtual bool initWithJsonObject(const gss_eap_attr_ctx *manager,
143 JSONObject &object GSSEAP_UNUSED)
145 return initWithManager(manager);
149 virtual JSONObject jsonRepresentation(void) const
151 return JSONObject::null();
154 virtual time_t getExpiryTime(void) const { return 0; }
156 virtual OM_uint32 mapException(OM_uint32 *minor GSSEAP_UNUSED,
157 std::exception &e GSSEAP_UNUSED) const
159 return GSS_S_CONTINUE_NEEDED;
162 static bool init(void) { return true; }
163 static void finalize(void) {}
165 static gss_eap_attr_provider *createAttrContext(void) { return NULL; }
168 const gss_eap_attr_ctx *m_manager;
171 /* make non-copyable */
172 gss_eap_attr_provider(const gss_eap_attr_provider&);
173 gss_eap_attr_provider& operator=(const gss_eap_attr_provider&);
176 typedef gss_eap_attr_provider *(*gss_eap_attr_create_provider)(void);
179 * Attribute context: this manages a set of providers for a given
182 struct gss_eap_attr_ctx
185 gss_eap_attr_ctx(void);
186 ~gss_eap_attr_ctx(void);
188 bool initFromExistingContext(const gss_eap_attr_ctx *manager);
189 bool initFromGssContext(const gss_cred_id_t cred,
190 const gss_ctx_id_t ctx);
192 bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
193 bool getAttributeTypes(gss_buffer_set_t *attrs);
195 bool setAttribute(int complete,
196 const gss_buffer_t attr,
197 const gss_buffer_t value);
198 bool deleteAttribute(const gss_buffer_t value);
199 bool getAttribute(const gss_buffer_t attr,
203 gss_buffer_t display_value,
205 gss_any_t mapToAny(int authenticated,
206 gss_buffer_t type_id) const;
207 void releaseAnyNameMapping(gss_buffer_t type_id,
208 gss_any_t input) const;
210 void exportToBuffer(gss_buffer_t buffer,
211 uint32_t flags) const;
212 bool initFromBuffer(const gss_buffer_t buffer);
215 composeAttributeName(const gss_buffer_t prefix,
216 const gss_buffer_t suffix);
218 decomposeAttributeName(const gss_buffer_t attribute,
220 gss_buffer_t suffix);
222 composeAttributeName(const gss_buffer_t prefix,
223 const gss_buffer_t suffix,
224 gss_buffer_t attribute);
227 composeAttributeName(unsigned int type,
228 const gss_buffer_t suffix);
230 decomposeAttributeName(const gss_buffer_t attribute,
232 gss_buffer_t suffix) const;
234 composeAttributeName(unsigned int type,
235 const gss_buffer_t suffix,
236 gss_buffer_t attribute) const;
238 gss_eap_attr_provider *getProvider(unsigned int type) const;
241 registerProvider(unsigned int type,
242 gss_eap_attr_create_provider factory);
244 unregisterProvider(unsigned int type);
246 time_t getExpiryTime(void) const;
247 OM_uint32 mapException(OM_uint32 *minor, std::exception &e) const;
250 bool providerEnabled(unsigned int type) const;
251 void releaseProvider(unsigned int type);
253 unsigned int attributePrefixToType(const gss_buffer_t prefix) const;
254 gss_buffer_desc attributeTypeToPrefix(unsigned int type) const;
256 bool initWithJsonObject(JSONObject &object);
257 JSONObject jsonRepresentation(uint32_t flags = 0) const;
259 gss_eap_attr_provider *getPrimaryProvider(void) const;
261 /* make non-copyable */
262 gss_eap_attr_ctx(const gss_eap_attr_ctx&);
263 gss_eap_attr_ctx& operator=(const gss_eap_attr_ctx&);
266 gss_eap_attr_provider *m_providers[ATTR_TYPE_MAX + 1];
269 #endif /* __cplusplus */
271 #include "util_radius.h"
272 #include "util_saml.h"
273 #include "util_shib.h"
278 duplicateBuffer(gss_buffer_desc &src, gss_buffer_t dst)
282 if (GSS_ERROR(duplicateBuffer(&minor, &src, dst)))
283 throw new std::bad_alloc();
287 duplicateBuffer(std::string &str, gss_buffer_t buffer)
291 tmp.length = str.length();
292 tmp.value = (char *)str.c_str();
294 duplicateBuffer(tmp, buffer);
298 struct gss_eap_attr_ctx;
305 #define ATTR_FLAG_DISABLE_LOCAL 0x00000001
308 * C wrappers for attribute context functions. These match their
309 * GSS naming extension equivalents. The caller is required to
310 * obtain the name mutex.
314 gssEapCreateAttrContext(OM_uint32 *minor,
315 gss_cred_id_t acceptorCred,
316 gss_ctx_id_t acceptorCtx,
317 struct gss_eap_attr_ctx **pAttrCtx,
318 time_t *pExpiryTime);
321 gssEapInquireName(OM_uint32 *minor,
325 gss_buffer_set_t *attrs);
328 gssEapGetNameAttribute(OM_uint32 *minor,
334 gss_buffer_t display_value,
338 gssEapDeleteNameAttribute(OM_uint32 *minor,
343 gssEapSetNameAttribute(OM_uint32 *minor,
350 gssEapExportAttrContext(OM_uint32 *minor,
356 gssEapImportAttrContext(OM_uint32 *minor,
361 gssEapDuplicateAttrContext(OM_uint32 *minor,
366 gssEapMapNameToAny(OM_uint32 *minor,
369 gss_buffer_t type_id,
373 gssEapReleaseAnyNameMapping(OM_uint32 *minor,
375 gss_buffer_t type_id,
379 gssEapReleaseAttrContext(OM_uint32 *minor,
383 gssEapAttrProvidersFinalize(OM_uint32 *minor);
389 #endif /* _UTIL_ATTR_H_ */