add a testing path for setting initiator credentials
[mech_eap.orig] / gssapiP_eap.h
1 /*
2  * Copyright (c) 2011, 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 _GSSAPIP_EAP_H_
34 #define _GSSAPIP_EAP_H_ 1
35
36 #include "config.h"
37
38 #ifdef HAVE_HEIMDAL_VERSION
39 #define KRB5_DEPRECATED         /* so we can use krb5_free_unparsed_name() */
40 #endif
41
42 #include <assert.h>
43 #include <string.h>
44 #include <errno.h>
45 #include <unistd.h>
46 #include <stdlib.h>
47 #include <stdarg.h>
48 #include <time.h>
49 #include <sys/param.h>
50
51 /* GSS headers */
52 #include <gssapi/gssapi.h>
53 #include <gssapi/gssapi_krb5.h>
54 #ifndef HAVE_HEIMDAL_VERSION
55 #include <gssapi/gssapi_ext.h>
56 #endif
57 #include "gssapi_eap.h"
58
59 /* Kerberos headers */
60 #include <krb5.h>
61
62 /* EAP headers */
63 #include <common.h>
64 #include <eap_peer/eap.h>
65 #include <eap_peer/eap_config.h>
66 #include <eap_peer/eap_methods.h>
67 #include <eap_common/eap_common.h>
68 #include <wpabuf.h>
69
70 /* FreeRADIUS headers */
71 #ifdef __cplusplus
72 extern "C" {
73 #define operator fr_operator
74 #endif
75 #include <freeradius/libradius.h>
76 #include <freeradius/radius.h>
77 #include <radsec/radsec.h>
78 #include <radsec/request.h>
79 #ifdef __cplusplus
80 #undef operator
81 }
82 #endif
83
84 #include "gsseap_err.h"
85 #include "radsec_err.h"
86 #include "util.h"
87
88 #ifdef __cplusplus
89 extern "C" {
90 #endif
91
92 /* These name flags are informative and not actually used by anything yet */
93 #define NAME_FLAG_NAI                       0x00000001
94 #define NAME_FLAG_SERVICE                   0x00000002
95 #define NAME_FLAG_COMPOSITE                 0x00000004
96
97 struct gss_eap_saml_attr_ctx;
98 struct gss_eap_attr_ctx;
99
100 #ifdef HAVE_HEIMDAL_VERSION
101 struct gss_name_t_desc_struct
102 #else
103 struct gss_name_struct
104 #endif
105 {
106     GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
107     OM_uint32 flags;
108     krb5_principal krbPrincipal; /* this is immutable */
109     struct gss_eap_attr_ctx *attrCtx;
110 };
111
112 #define CRED_FLAG_INITIATE                  0x00010000
113 #define CRED_FLAG_ACCEPT                    0x00020000
114 #define CRED_FLAG_DEFAULT_IDENTITY          0x00040000
115 #define CRED_FLAG_PASSWORD                  0x00080000
116 #define CRED_FLAG_DEFAULT_CCACHE            0x00100000
117 #define CRED_FLAG_PUBLIC_MASK               0x0000FFFF
118
119 #ifdef HAVE_HEIMDAL_VERSION
120 struct gss_cred_id_t_desc_struct
121 #else
122 struct gss_cred_id_struct
123 #endif
124 {
125     GSSEAP_MUTEX mutex;
126     OM_uint32 flags;
127     gss_name_t name;
128     gss_buffer_desc password;
129     gss_OID_set mechanisms;
130     time_t expiryTime;
131     char *radiusConfigFile;
132     char *radiusConfigStanza;
133 #ifdef GSSEAP_ENABLE_REAUTH
134     krb5_ccache krbCredCache;
135     gss_cred_id_t krbCred;
136 #endif
137 };
138
139 #define CTX_FLAG_INITIATOR                  0x00000001
140 #define CTX_FLAG_KRB_REAUTH                 0x00000002
141
142 #define CTX_IS_INITIATOR(ctx)               (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
143
144 #define CTX_IS_ESTABLISHED(ctx)             ((ctx)->state == GSSEAP_STATE_ESTABLISHED)
145
146 /* Initiator context flags */
147 #define CTX_FLAG_EAP_SUCCESS                0x00010000
148 #define CTX_FLAG_EAP_RESTART                0x00020000
149 #define CTX_FLAG_EAP_FAIL                   0x00040000
150 #define CTX_FLAG_EAP_RESP                   0x00080000
151 #define CTX_FLAG_EAP_NO_RESP                0x00100000
152 #define CTX_FLAG_EAP_REQ                    0x00200000
153 #define CTX_FLAG_EAP_PORT_ENABLED           0x00400000
154 #define CTX_FLAG_EAP_ALT_ACCEPT             0x00800000
155 #define CTX_FLAG_EAP_ALT_REJECT             0x01000000
156 #define CTX_FLAG_EAP_MASK                   0xFFFF0000
157
158 struct gss_eap_initiator_ctx {
159     unsigned int idleWhile;
160 #ifndef __cplusplus
161     struct eap_peer_config eapPeerConfig;
162     struct eap_sm *eap;
163     struct wpabuf reqData;
164 #endif
165 };
166
167 struct gss_eap_acceptor_ctx {
168     struct rs_context *radContext;
169     struct rs_connection *radConn;
170     char *radServer;
171     gss_buffer_desc state;
172     VALUE_PAIR *vps;
173 };
174
175 #ifdef HAVE_HEIMDAL_VERSION
176 struct gss_ctx_id_t_desc_struct
177 #else
178 struct gss_ctx_id_struct
179 #endif
180 {
181     GSSEAP_MUTEX mutex;
182     enum gss_eap_state state;
183     OM_uint32 flags;
184     OM_uint32 gssFlags;
185     gss_OID mechanismUsed;
186     krb5_cksumtype checksumType;
187     krb5_enctype encryptionType;
188     krb5_keyblock rfc3961Key;
189     gss_name_t initiatorName;
190     gss_name_t acceptorName;
191     time_t expiryTime;
192     uint64_t sendSeq, recvSeq;
193     void *seqState;
194     gss_cred_id_t defaultCred;
195     union {
196         struct gss_eap_initiator_ctx initiator;
197         #define initiatorCtx         ctxU.initiator
198         struct gss_eap_acceptor_ctx  acceptor;
199         #define acceptorCtx          ctxU.acceptor
200 #ifdef GSSEAP_ENABLE_REAUTH
201         gss_ctx_id_t                 kerberos;
202         #define kerberosCtx          ctxU.kerberos
203 #endif
204     } ctxU;
205 };
206
207 #define TOK_FLAG_SENDER_IS_ACCEPTOR         0x01
208 #define TOK_FLAG_WRAP_CONFIDENTIAL          0x02
209 #define TOK_FLAG_ACCEPTOR_SUBKEY            0x04
210
211 #define KEY_USAGE_ACCEPTOR_SEAL             22
212 #define KEY_USAGE_ACCEPTOR_SIGN             23
213 #define KEY_USAGE_INITIATOR_SEAL            24
214 #define KEY_USAGE_INITIATOR_SIGN            25
215
216 /* wrap_iov.c */
217 OM_uint32
218 gssEapWrapOrGetMIC(OM_uint32 *minor,
219                    gss_ctx_id_t ctx,
220                    int conf_req_flag,
221                    int *conf_state,
222                    gss_iov_buffer_desc *iov,
223                    int iov_count,
224                    enum gss_eap_token_type toktype);
225
226 OM_uint32
227 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
228                         gss_ctx_id_t ctx,
229                         int *conf_state,
230                         gss_qop_t *qop_state,
231                         gss_iov_buffer_desc *iov,
232                         int iov_count,
233                         enum gss_eap_token_type toktype);
234
235 OM_uint32
236 gssEapWrapIovLength(OM_uint32 *minor,
237                     gss_ctx_id_t ctx,
238                     int conf_req_flag,
239                     gss_qop_t qop_req,
240                     int *conf_state,
241                     gss_iov_buffer_desc *iov,
242                     int iov_count);
243 OM_uint32
244 gssEapWrap(OM_uint32 *minor,
245            gss_ctx_id_t ctx,
246            int conf_req_flag,
247            gss_qop_t qop_req,
248            gss_buffer_t input_message_buffer,
249            int *conf_state,
250            gss_buffer_t output_message_buffer);
251
252 unsigned char
253 rfc4121Flags(gss_ctx_id_t ctx, int receiving);
254
255 /* display_status.c */
256 void
257 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
258
259 #define IS_WIRE_ERROR(err)              ((err) > GSSEAP_RESERVED && \
260                                          (err) <= GSSEAP_RADIUS_PROT_FAILURE)
261
262 #ifdef __cplusplus
263 }
264 #endif
265
266 #endif /* _GSSAPIP_EAP_H_ */