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 /* libradsec headers */
94 #include <radsec/radsec.h>
95 #include <radsec/request.h>
96 #include <radsec/radius.h>
99 #include "gsseap_err.h"
100 #include "radsec_err.h"
107 /* These name flags are informative and not actually used by anything yet */
108 #define NAME_FLAG_NAI 0x00000001
109 #define NAME_FLAG_SERVICE 0x00000002
110 #define NAME_FLAG_COMPOSITE 0x00000004
112 struct gss_eap_saml_attr_ctx;
113 struct gss_eap_attr_ctx;
115 #ifdef HAVE_HEIMDAL_VERSION
116 struct gss_name_t_desc_struct
118 struct gss_name_struct
121 GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
123 gss_OID mechanismUsed; /* this is immutable */
124 krb5_principal krbPrincipal; /* this is immutable */
125 #ifdef GSSEAP_ENABLE_ACCEPTOR
126 struct gss_eap_attr_ctx *attrCtx;
130 #define CRED_FLAG_INITIATE 0x00010000
131 #define CRED_FLAG_ACCEPT 0x00020000
132 #define CRED_FLAG_PASSWORD 0x00040000
133 #define CRED_FLAG_DEFAULT_CCACHE 0x00080000
134 #define CRED_FLAG_RESOLVED 0x00100000
135 #define CRED_FLAG_TARGET 0x00200000
136 #define CRED_FLAG_CERTIFICATE 0x00400000
137 #define CRED_FLAG_CONFIG_BLOB 0x00800000
138 #define CRED_FLAG_PUBLIC_MASK 0x0000FFFF
140 #ifdef HAVE_HEIMDAL_VERSION
141 struct gss_cred_id_t_desc_struct
143 struct gss_cred_id_struct
149 gss_name_t target; /* for initiator */
150 gss_buffer_desc password;
151 gss_OID_set mechanisms;
153 gss_buffer_desc radiusConfigFile;
154 gss_buffer_desc radiusConfigStanza;
155 gss_buffer_desc caCertificate;
156 gss_buffer_desc subjectNameConstraint;
157 gss_buffer_desc subjectAltNameConstraint;
158 gss_buffer_desc clientCertificate;
159 gss_buffer_desc privateKey;
160 gss_buffer_desc caCertificateBlob;
161 #ifdef GSSEAP_ENABLE_REAUTH
162 krb5_ccache krbCredCache;
163 gss_cred_id_t reauthCred;
167 #define CTX_FLAG_INITIATOR 0x00000001
168 #define CTX_FLAG_KRB_REAUTH 0x00000002
169 #define CTX_FLAG_CHANNEL_BINDINGS_VERIFIED 0x00000004
171 #define CTX_IS_INITIATOR(ctx) (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
173 #define CTX_IS_ESTABLISHED(ctx) ((ctx)->state == GSSEAP_STATE_ESTABLISHED)
175 /* Initiator context flags */
176 #define CTX_FLAG_EAP_SUCCESS 0x00010000
177 #define CTX_FLAG_EAP_RESTART 0x00020000
178 #define CTX_FLAG_EAP_FAIL 0x00040000
179 #define CTX_FLAG_EAP_RESP 0x00080000
180 #define CTX_FLAG_EAP_NO_RESP 0x00100000
181 #define CTX_FLAG_EAP_REQ 0x00200000
182 #define CTX_FLAG_EAP_PORT_ENABLED 0x00400000
183 #define CTX_FLAG_EAP_ALT_ACCEPT 0x00800000
184 #define CTX_FLAG_EAP_ALT_REJECT 0x01000000
185 #define CTX_FLAG_EAP_CHBIND_ACCEPT 0x02000000
186 #define CTX_FLAG_EAP_TRIGGER_START 0x04000000
187 #define CTX_FLAG_EAP_MASK 0xFFFF0000
189 #define CONFIG_BLOB_CLIENT_CERT 0
190 #define CONFIG_BLOB_PRIVATE_KEY 1
191 #define CONFIG_BLOB_CA_CERT 2
192 #define CONFIG_BLOB_MAX 3
194 struct gss_eap_initiator_ctx {
195 unsigned int idleWhile;
196 struct eap_peer_config eapPeerConfig;
198 struct wpabuf reqData;
199 struct wpabuf *chbindData;
200 unsigned int chbindReqFlags;
201 struct wpa_config_blob configBlobs[CONFIG_BLOB_MAX];
204 #ifdef GSSEAP_ENABLE_ACCEPTOR
205 struct gss_eap_acceptor_ctx {
206 struct rs_context *radContext;
207 struct rs_connection *radConn;
209 gss_buffer_desc state;
214 #ifdef HAVE_HEIMDAL_VERSION
215 struct gss_ctx_id_t_desc_struct
217 struct gss_ctx_id_struct
221 enum gss_eap_state state;
224 gss_OID mechanismUsed;
225 krb5_cksumtype checksumType;
226 krb5_enctype encryptionType;
227 krb5_keyblock rfc3961Key;
228 gss_name_t initiatorName;
229 gss_name_t acceptorName;
231 uint64_t sendSeq, recvSeq;
235 struct gss_eap_initiator_ctx initiator;
236 #define initiatorCtx ctxU.initiator
237 #ifdef GSSEAP_ENABLE_ACCEPTOR
238 struct gss_eap_acceptor_ctx acceptor;
239 #define acceptorCtx ctxU.acceptor
241 #ifdef GSSEAP_ENABLE_REAUTH
243 #define reauthCtx ctxU.reauth
246 const struct gss_eap_token_buffer_set *inputTokens;
247 const struct gss_eap_token_buffer_set *outputTokens;
250 #define TOK_FLAG_SENDER_IS_ACCEPTOR 0x01
251 #define TOK_FLAG_WRAP_CONFIDENTIAL 0x02
252 #define TOK_FLAG_ACCEPTOR_SUBKEY 0x04
254 #define KEY_USAGE_ACCEPTOR_SEAL 22
255 #define KEY_USAGE_ACCEPTOR_SIGN 23
256 #define KEY_USAGE_INITIATOR_SEAL 24
257 #define KEY_USAGE_INITIATOR_SIGN 25
259 #define KEY_USAGE_GSSEAP_CHBIND_MIC 60
260 #define KEY_USAGE_GSSEAP_ACCTOKEN_MIC 61
261 #define KEY_USAGE_GSSEAP_INITOKEN_MIC 62
263 /* accept_sec_context.c */
265 gssEapAcceptSecContext(OM_uint32 *minor,
268 gss_buffer_t input_token,
269 gss_channel_bindings_t input_chan_bindings,
270 gss_name_t *src_name,
272 gss_buffer_t output_token,
273 OM_uint32 *ret_flags,
275 gss_cred_id_t *delegated_cred_handle);
277 /* init_sec_context.c */
279 gssEapInitSecContext(OM_uint32 *minor,
282 gss_name_t target_name,
286 gss_channel_bindings_t input_chan_bindings,
287 gss_buffer_t input_token,
288 gss_OID *actual_mech_type,
289 gss_buffer_t output_token,
290 OM_uint32 *ret_flags,
291 OM_uint32 *time_rec);
295 gssEapWrapOrGetMIC(OM_uint32 *minor,
299 gss_iov_buffer_desc *iov,
301 enum gss_eap_token_type toktype);
304 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
307 gss_qop_t *qop_state,
308 gss_iov_buffer_desc *iov,
310 enum gss_eap_token_type toktype);
313 gssEapWrapIovLength(OM_uint32 *minor,
318 gss_iov_buffer_desc *iov,
321 gssEapWrap(OM_uint32 *minor,
325 gss_buffer_t input_message_buffer,
327 gss_buffer_t output_message_buffer);
330 rfc4121Flags(gss_ctx_id_t ctx, int receiving);
332 /* display_status.c */
334 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
337 gssEapDisplayStatus(OM_uint32 *minor,
338 OM_uint32 status_value,
339 gss_buffer_t status_string);
341 #define IS_WIRE_ERROR(err) ((err) >= GSSEAP_RESERVED && \
342 (err) <= GSSEAP_RADIUS_PROT_FAILURE)
344 #ifdef GSSEAP_ENABLE_ACCEPTOR
345 #define IS_RADIUS_ERROR(err) ((err) >= ERROR_TABLE_BASE_rse && \
346 (err) <= ERROR_TABLE_BASE_rse + RSE_MAX)
348 #define IS_RADIUS_ERROR(err) (0)
351 /* exchange_meta_data.c */
352 OM_uint32 GSSAPI_CALLCONV
353 gssEapExchangeMetaData(OM_uint32 *minor,
357 const gss_name_t name,
359 gss_const_buffer_t meta_data);
361 /* export_sec_context.c */
363 gssEapExportSecContext(OM_uint32 *minor,
367 /* import_sec_context.c */
369 gssEapImportContext(OM_uint32 *minor,
373 /* inquire_sec_context_by_oid.c */
374 #define NEGOEX_INITIATOR_SALT "gss-eap-negoex-initiator"
375 #define NEGOEX_INITIATOR_SALT_LEN (sizeof(NEGOEX_INITIATOR_SALT) - 1)
377 #define NEGOEX_ACCEPTOR_SALT "gss-eap-negoex-acceptor"
378 #define NEGOEX_ACCEPTOR_SALT_LEN (sizeof(NEGOEX_ACCEPTOR_SALT) - 1)
380 /* pseudo_random.c */
382 gssEapPseudoRandom(OM_uint32 *minor,
385 const gss_buffer_t prf_in,
386 gss_buffer_t prf_out);
388 /* query_mechanism_info.c */
390 gssQueryMechanismInfo(OM_uint32 *minor,
391 gss_const_OID mech_oid,
392 unsigned char auth_scheme[16]);
394 /* query_meta_data.c */
396 gssEapQueryMetaData(OM_uint32 *minor,
397 gss_const_OID mech GSSEAP_UNUSED,
399 gss_ctx_id_t *context_handle,
400 const gss_name_t name,
401 OM_uint32 req_flags GSSEAP_UNUSED,
402 gss_buffer_t meta_data);
406 gssEapInitiatorInit(OM_uint32 *minor);
409 gssEapFinalize(void);
411 /* Debugging and tracing*/
412 #define gssEapTrace(_fmt, ...) wpa_printf(MSG_INFO, _fmt, __VA_ARGS__);
415 gssEapTraceStatus(const char *function,
416 OM_uint32 major, OM_uint32 minor)
418 gss_buffer_desc gss_code_buf, mech_buf;
419 OM_uint32 tmpmaj, tmpmin, ctx = 0;
420 gss_code_buf.value = NULL;
421 mech_buf.value = NULL;
422 tmpmaj = gss_display_status(&tmpmin, major,
423 GSS_C_GSS_CODE, GSS_C_NO_OID, &ctx,
425 if (!GSS_ERROR(tmpmaj)) {
427 tmpmaj = makeStringBuffer(&tmpmin, "no minor", &mech_buf);
428 else tmpmaj = gssEapDisplayStatus(&tmpmin, minor, &mech_buf);
430 if (!GSS_ERROR(tmpmaj))
431 wpa_printf(MSG_INFO, "%s: %.*s/%.*s",
432 function, (int) gss_code_buf.length, (char *) gss_code_buf.value,
433 (int) mech_buf.length, (char *) mech_buf.value);
434 else wpa_printf(MSG_INFO, "%s: %u/%u",
435 function, major, minor);
436 tmpmaj = gss_release_buffer(&tmpmin, &gss_code_buf);
437 tmpmaj = gss_release_buffer(&tmpmin, &mech_buf);
441 /*If built as a library on Linux, don't respect environment when set*uid*/
442 #ifdef HAVE_SECURE_GETENV
443 #define getenv secure_getenv
450 #endif /* _GSSAPIP_EAP_H_ */