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() */
55 #ifdef HAVE_SYS_PARAM_H
56 #include <sys/param.h>
60 #ifndef MAXHOSTNAMELEN
61 # include <WinSock2.h>
62 # define MAXHOSTNAMELEN NI_MAXHOST
67 #include <gssapi/gssapi.h>
68 #include <gssapi/gssapi_krb5.h>
69 #ifdef HAVE_HEIMDAL_VERSION
70 typedef struct gss_any *gss_any_t;
72 #include <gssapi/gssapi_ext.h>
74 #include "gssapi_eap.h"
76 #ifndef HAVE_GSS_INQUIRE_ATTRS_FOR_MECH
77 typedef const gss_OID_desc *gss_const_OID;
80 /* Kerberos headers */
86 #include <eap_peer/eap.h>
87 #include <eap_peer/eap_config.h>
88 #include <eap_peer/eap_methods.h>
89 #include <eap_common/eap_common.h>
92 #ifdef GSSEAP_ENABLE_ACCEPTOR
93 /* FreeRADIUS headers */
97 #define operator fr_operator
100 #include <freeradius/libradius.h>
101 #include <freeradius/radius.h>
105 /* libradsec headers */
106 #include <radsec/radsec.h>
107 #include <radsec/request.h>
114 #endif /* GSSEAP_ENABLE_ACCEPTOR */
116 #include "gsseap_err.h"
117 #include "radsec_err.h"
124 /* These name flags are informative and not actually used by anything yet */
125 #define NAME_FLAG_NAI 0x00000001
126 #define NAME_FLAG_SERVICE 0x00000002
127 #define NAME_FLAG_COMPOSITE 0x00000004
129 struct gss_eap_saml_attr_ctx;
130 struct gss_eap_attr_ctx;
132 #ifdef HAVE_HEIMDAL_VERSION
133 struct gss_name_t_desc_struct
135 struct gss_name_struct
138 GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
140 gss_OID mechanismUsed; /* this is immutable */
141 krb5_principal krbPrincipal; /* this is immutable */
142 #ifdef GSSEAP_ENABLE_ACCEPTOR
143 struct gss_eap_attr_ctx *attrCtx;
147 #define CRED_FLAG_INITIATE 0x00010000
148 #define CRED_FLAG_ACCEPT 0x00020000
149 #define CRED_FLAG_PASSWORD 0x00040000
150 #define CRED_FLAG_DEFAULT_CCACHE 0x00080000
151 #define CRED_FLAG_RESOLVED 0x00100000
152 #define CRED_FLAG_TARGET 0x00200000
153 #define CRED_FLAG_PUBLIC_MASK 0x0000FFFF
155 #ifdef HAVE_HEIMDAL_VERSION
156 struct gss_cred_id_t_desc_struct
158 struct gss_cred_id_struct
164 gss_name_t target; /* for initiator */
165 gss_buffer_desc password;
166 gss_OID_set mechanisms;
168 gss_buffer_desc radiusConfigFile;
169 gss_buffer_desc radiusConfigStanza;
170 gss_buffer_desc caCertificate;
171 gss_buffer_desc subjectNameConstraint;
172 gss_buffer_desc subjectAltNameConstraint;
173 #ifdef GSSEAP_ENABLE_REAUTH
174 krb5_ccache krbCredCache;
175 gss_cred_id_t reauthCred;
179 #define CTX_FLAG_INITIATOR 0x00000001
180 #define CTX_FLAG_KRB_REAUTH 0x00000002
182 #define CTX_IS_INITIATOR(ctx) (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
184 #define CTX_IS_ESTABLISHED(ctx) ((ctx)->state == GSSEAP_STATE_ESTABLISHED)
186 /* Initiator context flags */
187 #define CTX_FLAG_EAP_SUCCESS 0x00010000
188 #define CTX_FLAG_EAP_RESTART 0x00020000
189 #define CTX_FLAG_EAP_FAIL 0x00040000
190 #define CTX_FLAG_EAP_RESP 0x00080000
191 #define CTX_FLAG_EAP_NO_RESP 0x00100000
192 #define CTX_FLAG_EAP_REQ 0x00200000
193 #define CTX_FLAG_EAP_PORT_ENABLED 0x00400000
194 #define CTX_FLAG_EAP_ALT_ACCEPT 0x00800000
195 #define CTX_FLAG_EAP_ALT_REJECT 0x01000000
196 #define CTX_FLAG_EAP_MASK 0xFFFF0000
198 struct gss_eap_initiator_ctx {
199 unsigned int idleWhile;
200 struct eap_peer_config eapPeerConfig;
202 struct wpabuf reqData;
205 #ifdef GSSEAP_ENABLE_ACCEPTOR
206 struct gss_eap_acceptor_ctx {
207 struct rs_context *radContext;
208 struct rs_connection *radConn;
210 gss_buffer_desc state;
215 #ifdef HAVE_HEIMDAL_VERSION
216 struct gss_ctx_id_t_desc_struct
218 struct gss_ctx_id_struct
222 enum gss_eap_state state;
225 gss_OID mechanismUsed;
226 krb5_cksumtype checksumType;
227 krb5_enctype encryptionType;
228 krb5_keyblock rfc3961Key;
229 gss_name_t initiatorName;
230 gss_name_t acceptorName;
232 uint64_t sendSeq, recvSeq;
236 struct gss_eap_initiator_ctx initiator;
237 #define initiatorCtx ctxU.initiator
238 #ifdef GSSEAP_ENABLE_ACCEPTOR
239 struct gss_eap_acceptor_ctx acceptor;
240 #define acceptorCtx ctxU.acceptor
242 #ifdef GSSEAP_ENABLE_REAUTH
244 #define reauthCtx ctxU.reauth
247 const struct gss_eap_token_buffer_set *inputTokens;
248 const struct gss_eap_token_buffer_set *outputTokens;
251 #define TOK_FLAG_SENDER_IS_ACCEPTOR 0x01
252 #define TOK_FLAG_WRAP_CONFIDENTIAL 0x02
253 #define TOK_FLAG_ACCEPTOR_SUBKEY 0x04
255 #define KEY_USAGE_ACCEPTOR_SEAL 22
256 #define KEY_USAGE_ACCEPTOR_SIGN 23
257 #define KEY_USAGE_INITIATOR_SEAL 24
258 #define KEY_USAGE_INITIATOR_SIGN 25
260 /* accept_sec_context.c */
262 gssEapAcceptSecContext(OM_uint32 *minor,
265 gss_buffer_t input_token,
266 gss_channel_bindings_t input_chan_bindings,
267 gss_name_t *src_name,
269 gss_buffer_t output_token,
270 OM_uint32 *ret_flags,
272 gss_cred_id_t *delegated_cred_handle);
274 /* init_sec_context.c */
276 gssEapInitSecContext(OM_uint32 *minor,
279 gss_name_t target_name,
283 gss_channel_bindings_t input_chan_bindings,
284 gss_buffer_t input_token,
285 gss_OID *actual_mech_type,
286 gss_buffer_t output_token,
287 OM_uint32 *ret_flags,
288 OM_uint32 *time_rec);
292 gssEapWrapOrGetMIC(OM_uint32 *minor,
296 gss_iov_buffer_desc *iov,
298 enum gss_eap_token_type toktype);
301 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
304 gss_qop_t *qop_state,
305 gss_iov_buffer_desc *iov,
307 enum gss_eap_token_type toktype);
310 gssEapWrapIovLength(OM_uint32 *minor,
315 gss_iov_buffer_desc *iov,
318 gssEapWrap(OM_uint32 *minor,
322 gss_buffer_t input_message_buffer,
324 gss_buffer_t output_message_buffer);
327 rfc4121Flags(gss_ctx_id_t ctx, int receiving);
329 /* display_status.c */
331 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
334 gssEapDisplayStatus(OM_uint32 *minor,
335 OM_uint32 status_value,
336 gss_buffer_t status_string);
338 #define IS_WIRE_ERROR(err) ((err) > GSSEAP_RESERVED && \
339 (err) <= GSSEAP_RADIUS_PROT_FAILURE)
341 /* upper bound of RADIUS error range must be kept in sync with radsec.h */
342 #define IS_RADIUS_ERROR(err) ((err) >= ERROR_TABLE_BASE_rse && \
343 (err) <= ERROR_TABLE_BASE_rse + 20)
345 /* export_sec_context.c */
347 gssEapExportSecContext(OM_uint32 *minor,
351 /* import_sec_context.c */
353 gssEapImportContext(OM_uint32 *minor,
357 /* pseudo_random.c */
359 gssEapPseudoRandom(OM_uint32 *minor,
362 const gss_buffer_t prf_in,
363 ssize_t desired_output_len,
364 gss_buffer_t prf_out);
368 gssEapInitiatorInit(OM_uint32 *minor);
371 gssEapFinalize(void);
377 #endif /* _GSSAPIP_EAP_H_ */