File: util_attr.h

package info (click to toggle)
moonshot-gss-eap 0.9.2-3+deb8u1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 4,456 kB
  • ctags: 5,386
  • sloc: ansic: 33,657; sh: 16,977; cpp: 3,582; makefile: 363
file content (386 lines) | stat: -rw-r--r-- 11,951 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
/*
 * Copyright (c) 2011, JANET(UK)
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of JANET(UK) nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

/*
 * Attribute provider interface.
 */

#ifndef _UTIL_ATTR_H_
#define _UTIL_ATTR_H_ 1

#ifdef __cplusplus
#include <string>
#include <new>

using namespace gss_eap_util;

struct gss_eap_attr_provider;
struct gss_eap_attr_ctx;

typedef bool
(*gss_eap_attr_enumeration_cb)(const gss_eap_attr_ctx *ctx,
                               const gss_eap_attr_provider *source,
                               const gss_buffer_t attribute,
                               void *data);

#define ATTR_TYPE_RADIUS            0U                  /* RADIUS AVPs */
#ifdef HAVE_OPENSAML
#define ATTR_TYPE_SAML_ASSERTION    1U                  /* SAML assertion */
#define ATTR_TYPE_SAML              2U                  /* SAML attributes */
#endif
#define ATTR_TYPE_LOCAL             3U                  /* Local attributes */
#define ATTR_TYPE_MIN               ATTR_TYPE_RADIUS
#define ATTR_TYPE_MAX               ATTR_TYPE_LOCAL

#define ATTR_FLAG_DISABLE_LOCAL     0x00000001

/*
 * Attribute provider: this represents a source of attributes derived
 * from the security context.
 */
struct gss_eap_attr_provider
{
public:
    gss_eap_attr_provider(void) {}
    virtual ~gss_eap_attr_provider(void) {}

    bool initWithManager(const gss_eap_attr_ctx *manager)
    {
        m_manager = manager;
        return true;
    }

    virtual bool initWithExistingContext(const gss_eap_attr_ctx *manager,
                                         const gss_eap_attr_provider *ctx GSSEAP_UNUSED)
    {
        return initWithManager(manager);
    }

    virtual bool initWithGssContext(const gss_eap_attr_ctx *manager,
                                    const gss_cred_id_t cred GSSEAP_UNUSED,
                                    const gss_ctx_id_t ctx GSSEAP_UNUSED)
    {
        return initWithManager(manager);
    }

    virtual bool getAttributeTypes(gss_eap_attr_enumeration_cb GSSEAP_UNUSED,
                                   void *data GSSEAP_UNUSED) const
    {
        return false;
    }

    virtual bool setAttribute(int complete GSSEAP_UNUSED,
                              const gss_buffer_t attr GSSEAP_UNUSED,
                              const gss_buffer_t value GSSEAP_UNUSED)
    {
        return false;
    }

    virtual bool deleteAttribute(const gss_buffer_t value GSSEAP_UNUSED)
    {
        return false;
    }

    virtual bool getAttribute(const gss_buffer_t attr GSSEAP_UNUSED,
                              int *authenticated GSSEAP_UNUSED,
                              int *complete GSSEAP_UNUSED,
                              gss_buffer_t value GSSEAP_UNUSED,
                              gss_buffer_t display_value GSSEAP_UNUSED,
                              int *more GSSEAP_UNUSED) const
    {
        return false;
    }

    virtual gss_any_t mapToAny(int authenticated GSSEAP_UNUSED,
                               gss_buffer_t type_id GSSEAP_UNUSED) const
    {
        return NULL;
    }

    virtual void releaseAnyNameMapping(gss_buffer_t type_id GSSEAP_UNUSED,
                                       gss_any_t input GSSEAP_UNUSED) const
    {
    }

    /* prefix to be prepended to attributes emitted by gss_get_name_attribute */
    virtual const char *prefix(void) const
    {
        return NULL;
    }

    /* optional key for storing JSON dictionary */
    virtual const char *name(void) const
    {
        return NULL;
    }

    virtual bool initWithJsonObject(const gss_eap_attr_ctx *manager,
                                    JSONObject &object GSSEAP_UNUSED)
    {
        return initWithManager(manager);
    }


    virtual JSONObject jsonRepresentation(void) const
    {
        return JSONObject::null();
    }

    virtual time_t getExpiryTime(void) const { return 0; }

    virtual OM_uint32 mapException(OM_uint32 *minor GSSEAP_UNUSED,
                                   std::exception &e GSSEAP_UNUSED) const
    {
        return GSS_S_CONTINUE_NEEDED;
    }

    static bool init(void) { return true; }
    static void finalize(void) {}

    static gss_eap_attr_provider *createAttrContext(void) { return NULL; }

protected:
    const gss_eap_attr_ctx *m_manager;

private:
    /* make non-copyable */
    gss_eap_attr_provider(const gss_eap_attr_provider&);
    gss_eap_attr_provider& operator=(const gss_eap_attr_provider&);
};

typedef gss_eap_attr_provider *(*gss_eap_attr_create_provider)(void);

/*
 * Attribute context: this manages a set of providers for a given
 * security context.
 */
struct gss_eap_attr_ctx
{
public:
    gss_eap_attr_ctx(void);
    ~gss_eap_attr_ctx(void);

    bool initWithExistingContext(const gss_eap_attr_ctx *manager);
    bool initWithGssContext(const gss_cred_id_t cred,
                            const gss_ctx_id_t ctx);

    bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
    bool getAttributeTypes(gss_buffer_set_t *attrs);

    bool setAttribute(int complete,
                      const gss_buffer_t attr,
                      const gss_buffer_t value);
    bool deleteAttribute(const gss_buffer_t value);
    bool getAttribute(const gss_buffer_t attr,
                      int *authenticated,
                      int *complete,
                      gss_buffer_t value,
                      gss_buffer_t display_value,
                      int *more) const;
    gss_any_t mapToAny(int authenticated,
                       gss_buffer_t type_id) const;
    void releaseAnyNameMapping(gss_buffer_t type_id,
                               gss_any_t input) const;

    void exportToBuffer(gss_buffer_t buffer) const;
    bool initWithBuffer(const gss_buffer_t buffer);

    static std::string
    composeAttributeName(const gss_buffer_t prefix,
                         const gss_buffer_t suffix);
    static void
    decomposeAttributeName(const gss_buffer_t attribute,
                           gss_buffer_t prefix,
                           gss_buffer_t suffix);
    static void
    composeAttributeName(const gss_buffer_t prefix,
                         const gss_buffer_t suffix,
                         gss_buffer_t attribute);

    std::string
    composeAttributeName(unsigned int type,
                         const gss_buffer_t suffix);
    void
    decomposeAttributeName(const gss_buffer_t attribute,
                           unsigned int *type,
                           gss_buffer_t suffix) const;
    void
    composeAttributeName(unsigned int type,
                         const gss_buffer_t suffix,
                         gss_buffer_t attribute) const;

    gss_eap_attr_provider *getProvider(unsigned int type) const;

    static void
    registerProvider(unsigned int type,
                     gss_eap_attr_create_provider factory);
    static void
    unregisterProvider(unsigned int type);

    time_t getExpiryTime(void) const;
    OM_uint32 mapException(OM_uint32 *minor, std::exception &e) const;

private:
    bool providerEnabled(unsigned int type) const;
    void releaseProvider(unsigned int type);

    unsigned int attributePrefixToType(const gss_buffer_t prefix) const;
    gss_buffer_desc attributeTypeToPrefix(unsigned int type) const;

    bool initWithJsonObject(JSONObject &object);
    JSONObject jsonRepresentation(void) const;

    gss_eap_attr_provider *getPrimaryProvider(void) const;

    /* make non-copyable */
    gss_eap_attr_ctx(const gss_eap_attr_ctx&);
    gss_eap_attr_ctx& operator=(const gss_eap_attr_ctx&);

    uint32_t m_flags;
    gss_eap_attr_provider *m_providers[ATTR_TYPE_MAX + 1];
};

#endif /* __cplusplus */

#include "util_radius.h"
#include "util_saml.h"
#include "util_shib.h"

#ifdef __cplusplus

static inline void
duplicateBuffer(gss_buffer_desc &src, gss_buffer_t dst)
{
    OM_uint32 minor;

    if (GSS_ERROR(duplicateBuffer(&minor, &src, dst)))
        throw std::bad_alloc();
}

static inline void
duplicateBuffer(std::string &str, gss_buffer_t buffer)
{
    gss_buffer_desc tmp;

    tmp.length = str.length();
    tmp.value = (char *)str.c_str();

    duplicateBuffer(tmp, buffer);
}

#else
struct gss_eap_attr_ctx;
#endif

#ifdef __cplusplus
extern "C" {
#endif

/*
 * C wrappers for attribute context functions. These match their
 * GSS naming extension equivalents. The caller is required to
 * obtain the name mutex.
 */

OM_uint32
gssEapCreateAttrContext(OM_uint32 *minor,
                        gss_cred_id_t acceptorCred,
                        gss_ctx_id_t acceptorCtx,
                        struct gss_eap_attr_ctx **pAttrCtx,
                        time_t *pExpiryTime);

OM_uint32
gssEapInquireName(OM_uint32 *minor,
                  gss_name_t name,
                  int *name_is_MN,
                  gss_OID *MN_mech,
                  gss_buffer_set_t *attrs);

OM_uint32
gssEapGetNameAttribute(OM_uint32 *minor,
                       gss_name_t name,
                       gss_buffer_t attr,
                       int *authenticated,
                       int *complete,
                       gss_buffer_t value,
                       gss_buffer_t display_value,
                       int *more);

OM_uint32
gssEapDeleteNameAttribute(OM_uint32 *minor,
                          gss_name_t name,
                          gss_buffer_t attr);

OM_uint32
gssEapSetNameAttribute(OM_uint32 *minor,
                       gss_name_t name,
                       int complete,
                       gss_buffer_t attr,
                       gss_buffer_t value);

OM_uint32
gssEapExportAttrContext(OM_uint32 *minor,
                        gss_name_t name,
                        gss_buffer_t buffer);

OM_uint32
gssEapImportAttrContext(OM_uint32 *minor,
                        gss_buffer_t buffer,
                        gss_name_t name);

OM_uint32
gssEapDuplicateAttrContext(OM_uint32 *minor,
                           gss_name_t in,
                           gss_name_t out);

OM_uint32
gssEapMapNameToAny(OM_uint32 *minor,
                   gss_name_t name,
                   int authenticated,
                   gss_buffer_t type_id,
                   gss_any_t *output);

OM_uint32
gssEapReleaseAnyNameMapping(OM_uint32 *minor,
                            gss_name_t name,
                            gss_buffer_t type_id,
                            gss_any_t *input);

OM_uint32
gssEapReleaseAttrContext(OM_uint32 *minor,
                         gss_name_t name);

#ifdef __cplusplus
}
#endif

#endif /* _UTIL_ATTR_H_ */