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
33 #ifndef _GSSAPIP_EAP_H_
34 #define _GSSAPIP_EAP_H_ 1
38 #ifdef HAVE_HEIMDAL_VERSION
39 #define KRB5_DEPRECATED /* so we can use krb5_free_unparsed_name() */
48 #include <sys/param.h>
51 #include <gssapi/gssapi.h>
52 #include <gssapi/gssapi_krb5.h>
53 #ifndef HAVE_HEIMDAL_VERSION
54 #include <gssapi/gssapi_ext.h>
56 #include "gssapi_eap.h"
58 /* Kerberos headers */
63 #include <eap_peer/eap.h>
64 #include <eap_peer/eap_config.h>
65 #include <eap_peer/eap_methods.h>
66 #include <eap_common/eap_common.h>
69 /* FreeRADIUS headers */
72 #define operator fr_operator
74 #include <freeradius/libradius.h>
75 #include <freeradius/radius.h>
76 #include <radsec/radsec.h>
77 #include <radsec/request.h>
83 #include "gsseap_err.h"
84 #include "radsec_err.h"
91 /* These name flags are informative and not actually used by anything yet */
92 #define NAME_FLAG_NAI 0x00000001
93 #define NAME_FLAG_SERVICE 0x00000002
94 #define NAME_FLAG_COMPOSITE 0x00000004
96 struct gss_eap_saml_attr_ctx;
97 struct gss_eap_attr_ctx;
99 #ifdef HAVE_HEIMDAL_VERSION
100 struct gss_name_t_desc_struct
102 struct gss_name_struct
105 GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
107 krb5_principal krbPrincipal; /* this is immutable */
108 struct gss_eap_attr_ctx *attrCtx;
111 #define CRED_FLAG_INITIATE 0x00010000
112 #define CRED_FLAG_ACCEPT 0x00020000
113 #define CRED_FLAG_DEFAULT_IDENTITY 0x00040000
114 #define CRED_FLAG_PASSWORD 0x00080000
115 #define CRED_FLAG_DEFAULT_CCACHE 0x00100000
116 #define CRED_FLAG_PUBLIC_MASK 0x0000FFFF
118 #ifdef HAVE_HEIMDAL_VERSION
119 struct gss_cred_id_t_desc_struct
121 struct gss_cred_id_struct
127 gss_buffer_desc password;
128 gss_OID_set mechanisms;
130 char *radiusConfigFile;
131 char *radiusConfigStanza;
132 #ifdef GSSEAP_ENABLE_REAUTH
133 krb5_ccache krbCredCache;
134 gss_cred_id_t krbCred;
138 #define CTX_FLAG_INITIATOR 0x00000001
139 #define CTX_FLAG_KRB_REAUTH 0x00000002
141 #define CTX_IS_INITIATOR(ctx) (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
144 GSSEAP_STATE_INITIAL = 0x01, /* initial state */
145 GSSEAP_STATE_AUTHENTICATE = 0x02, /* exchange EAP messages */
146 GSSEAP_STATE_INITIATOR_EXTS = 0x04, /* initiator extensions */
147 GSSEAP_STATE_ACCEPTOR_EXTS = 0x08, /* acceptor extensions */
148 GSSEAP_STATE_REAUTHENTICATE = 0x10, /* GSS reauthentication messages */
149 GSSEAP_STATE_ESTABLISHED = 0x20, /* context established */
150 GSSEAP_STATE_ALL = 0x3F
153 #define GSSEAP_STATE_NEXT(s) ((s) << 1)
155 /* state machine entry */
157 OM_uint32 inputTokenType;
158 OM_uint32 outputTokenType;
159 enum gss_eap_state validStates;
161 OM_uint32 (*processToken)(OM_uint32 *,
168 gss_channel_bindings_t,
174 #define SM_FLAG_TRANSITION 0x00000001 /* transition to next state */
175 #define SM_FLAG_FORCE_SEND_TOKEN 0x00000002 /* send token even if empty */
176 #define SM_FLAG_STOP_EVAL 0x00000004 /* no more handlers for this state */
178 #define SM_ITOK_FLAG_CRITICAL 0x00000001 /* sent tokens marked critical */
179 #define SM_ITOK_FLAG_REQUIRED 0x00000002 /* received tokens must be present */
181 #define CTX_IS_ESTABLISHED(ctx) ((ctx)->state == GSSEAP_STATE_ESTABLISHED)
183 /* Initiator context flags */
184 #define CTX_FLAG_EAP_SUCCESS 0x00010000
185 #define CTX_FLAG_EAP_RESTART 0x00020000
186 #define CTX_FLAG_EAP_FAIL 0x00040000
187 #define CTX_FLAG_EAP_RESP 0x00080000
188 #define CTX_FLAG_EAP_NO_RESP 0x00100000
189 #define CTX_FLAG_EAP_REQ 0x00200000
190 #define CTX_FLAG_EAP_PORT_ENABLED 0x00400000
191 #define CTX_FLAG_EAP_ALT_ACCEPT 0x00800000
192 #define CTX_FLAG_EAP_ALT_REJECT 0x01000000
193 #define CTX_FLAG_EAP_MASK 0xFFFF0000
195 struct gss_eap_initiator_ctx {
196 unsigned int idleWhile;
198 struct eap_peer_config eapPeerConfig;
200 struct wpabuf reqData;
204 struct gss_eap_acceptor_ctx {
205 struct rs_context *radContext;
206 struct rs_connection *radConn;
208 gss_buffer_desc state;
212 #ifdef HAVE_HEIMDAL_VERSION
213 struct gss_ctx_id_t_desc_struct
215 struct gss_ctx_id_struct
219 enum gss_eap_state state;
222 gss_OID mechanismUsed;
223 krb5_cksumtype checksumType;
224 krb5_enctype encryptionType;
225 krb5_keyblock rfc3961Key;
226 gss_name_t initiatorName;
227 gss_name_t acceptorName;
229 uint64_t sendSeq, recvSeq;
231 gss_cred_id_t defaultCred;
233 struct gss_eap_initiator_ctx initiator;
234 #define initiatorCtx ctxU.initiator
235 struct gss_eap_acceptor_ctx acceptor;
236 #define acceptorCtx ctxU.acceptor
237 #ifdef GSSEAP_ENABLE_REAUTH
238 gss_ctx_id_t kerberos;
239 #define kerberosCtx ctxU.kerberos
244 #define TOK_FLAG_SENDER_IS_ACCEPTOR 0x01
245 #define TOK_FLAG_WRAP_CONFIDENTIAL 0x02
246 #define TOK_FLAG_ACCEPTOR_SUBKEY 0x04
248 #define KEY_USAGE_ACCEPTOR_SEAL 22
249 #define KEY_USAGE_ACCEPTOR_SIGN 23
250 #define KEY_USAGE_INITIATOR_SEAL 24
251 #define KEY_USAGE_INITIATOR_SIGN 25
255 gssEapWrapOrGetMIC(OM_uint32 *minor,
259 gss_iov_buffer_desc *iov,
261 enum gss_eap_token_type toktype);
264 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
267 gss_qop_t *qop_state,
268 gss_iov_buffer_desc *iov,
270 enum gss_eap_token_type toktype);
273 gssEapWrapIovLength(OM_uint32 *minor,
278 gss_iov_buffer_desc *iov,
281 gssEapWrap(OM_uint32 *minor,
285 gss_buffer_t input_message_buffer,
287 gss_buffer_t output_message_buffer);
290 rfc4121Flags(gss_ctx_id_t ctx, int receiving);
292 /* display_status.c */
294 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
296 #define IS_WIRE_ERROR(err) ((err) > GSSEAP_RESERVED && \
297 (err) <= GSSEAP_RADIUS_PROT_FAILURE)
303 #endif /* _GSSAPIP_EAP_H_ */