cleanup
[cyrus-sasl.git] / mech_eap / util_shib.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_SHIB_H_
34 #define _UTIL_SHIB_H_ 1
35
36 #include <vector>
37
38 namespace shibsp {
39     class Attribute;
40 };
41
42 struct gss_eap_shib_attr_provider : gss_eap_attr_provider {
43 public:
44     gss_eap_shib_attr_provider(const gss_eap_attr_ctx *ctx);
45     gss_eap_shib_attr_provider(const gss_eap_attr_ctx *ctx,
46                                gss_cred_id_t acceptorCred,
47                                gss_ctx_id_t acceptorCtx);
48     ~gss_eap_shib_attr_provider(void);
49
50     void setAttribute(int complete,
51                       const gss_buffer_t attr,
52                       const gss_buffer_t value);
53     void deleteAttribute(const gss_buffer_t value);
54     bool getAttributeTypes(gss_eap_attr_enumeration_cb, void *data) const;
55     bool getAttribute(const gss_buffer_t attr,
56                       int *authenticated,
57                       int *complete,
58                       gss_buffer_t value,
59                       gss_buffer_t display_value,
60                       int *more) const;
61     gss_any_t mapToAny(int authenticated,
62                        gss_buffer_t type_id) const;
63     void releaseAnyNameMapping(gss_buffer_t type_id,
64                                gss_any_t input) const;
65
66     void marshall(gss_buffer_t buffer) const;
67     bool unmarshall(const gss_eap_attr_ctx *ctx,
68                     const gss_buffer_t buffer);
69
70
71     static bool init();
72     static void finalize();
73
74     static gss_eap_attr_provider *
75     createAttrContext(const gss_eap_attr_ctx *ctx,
76                       gss_cred_id_t acceptorCred,
77                            gss_ctx_id_t acceptorCtx);
78 private:
79     int getAttributeIndex(const gss_buffer_t attr) const;
80     const shibsp::Attribute *getAttribute(const gss_buffer_t attr) const;
81
82     const std::vector<shibsp::Attribute *> getAttributes(void) const {
83         return m_attributes;
84     }
85
86     std::vector<shibsp::Attribute *> m_attributes;
87 };
88
89 #endif /* _UTIL_SHIB_H_ */