More work on SAML code
[mech_eap.git] / util_saml.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_SAML_H_
34 #define _UTIL_SAML_H_ 1
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 struct gss_eap_saml_attr_ctx;
41
42 OM_uint32
43 samlDuplicateAttrContext(OM_uint32 *minor,
44                          gss_name_t in,
45                          gss_name_t out);
46
47 OM_uint32
48 samlCreateAttrContext(OM_uint32 *minor,
49                       gss_cred_id_t acceptorCred,
50                       gss_name_t initiatorName,
51                       time_t *pExpiryTime);
52
53 OM_uint32
54 samlReleaseAttrContext(OM_uint32 *minor,
55                        gss_name_t name);
56
57 OM_uint32
58 samlGetAttributeTypes(OM_uint32 *minor,
59                       gss_name_t name,
60                       enum gss_eap_attribute_type type,
61                       gss_eap_add_attr_cb cb,
62                       void *data);
63
64 OM_uint32
65 samlGetAttribute(OM_uint32 *minor,
66                  enum gss_eap_attribute_type type,
67                  gss_name_t name,
68                  gss_buffer_t attr,
69                  int *authenticated,
70                  int *complete,
71                  gss_buffer_t value,
72                  gss_buffer_t display_value,
73                  int *more);
74
75 OM_uint32
76 samlSetAttribute(OM_uint32 *minor,
77                  gss_name_t name,
78                  int complete,
79                  gss_buffer_t attr,
80                  gss_buffer_t value);
81
82 OM_uint32
83 samlDeleteAttribute(OM_uint32 *minor,
84                     gss_name_t name,
85                     gss_buffer_t attr);
86
87 OM_uint32
88 samlExportAttrContext(OM_uint32 *minor,
89                       gss_name_t name,
90                       gss_buffer_t buffer);
91
92 OM_uint32
93 samlImportAttrContext(OM_uint32 *minor,
94                       gss_buffer_t buffer,
95                       gss_name_t name);
96
97 OM_uint32
98 samlGetAssertion(OM_uint32 *minor,
99                  gss_name_t name,
100                  gss_buffer_t assertion);
101  
102
103 OM_uint32
104 samlMapNameToAny(OM_uint32 *minor,
105                  gss_name_t name,
106                  int authenticated,
107                  gss_buffer_t type_id,
108                  gss_any_t *output);
109
110 OM_uint32
111 samlReleaseAnyNameMapping(OM_uint32 *minor,
112                           gss_name_t name,
113                           gss_buffer_t type_id,
114                           gss_any_t *input);
115
116 OM_uint32
117 samlInit(OM_uint32 *minor);
118
119 OM_uint32
120 samlFinalize(OM_uint32 *minor);
121
122
123 #ifdef __cplusplus
124 }
125 #endif
126
127 #endif /* _UTIL_SAML_H_ */