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 #ifndef GSS_IOV_BUFFER_TYPE_MIC_TOKEN
81 #define GSS_IOV_BUFFER_TYPE_MIC_TOKEN 12 /* MIC token destination */
84 /* Kerberos headers */
86 #include <et/com_err.h>
91 #include <eap_peer/eap.h>
92 #include <eap_peer/eap_config.h>
93 #include <eap_peer/eap_methods.h>
94 #include <eap_common/eap_common.h>
97 #ifdef GSSEAP_ENABLE_ACCEPTOR
98 /* libradsec headers */
99 #include <radsec/radsec.h>
100 #include <radsec/request.h>
101 #include <radsec/radius.h>
104 #include "gssapi_headerfix.h"
105 #include "gsseap_err.h"
106 #include "radsec_err.h"
113 /* These name flags are informative and not actually used by anything yet */
114 #define NAME_FLAG_NAI 0x00000001
115 #define NAME_FLAG_SERVICE 0x00000002
116 #define NAME_FLAG_COMPOSITE 0x00000004
118 struct gss_eap_saml_attr_ctx;
119 struct gss_eap_attr_ctx;
121 #ifdef HAVE_HEIMDAL_VERSION
122 struct gss_name_t_desc_struct
124 struct gss_name_struct
127 GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
129 gss_OID mechanismUsed; /* this is immutable */
130 krb5_principal krbPrincipal; /* this is immutable */
131 #ifdef GSSEAP_ENABLE_ACCEPTOR
132 struct gss_eap_attr_ctx *attrCtx;
136 #define CRED_FLAG_INITIATE 0x00010000
137 #define CRED_FLAG_ACCEPT 0x00020000
138 #define CRED_FLAG_PASSWORD 0x00040000
139 #define CRED_FLAG_DEFAULT_CCACHE 0x00080000
140 #define CRED_FLAG_RESOLVED 0x00100000
141 #define CRED_FLAG_TARGET 0x00200000
142 #define CRED_FLAG_CERTIFICATE 0x00400000
143 #define CRED_FLAG_CONFIG_BLOB 0x00800000
144 #define CRED_FLAG_PUBLIC_MASK 0x0000FFFF
146 #ifdef HAVE_HEIMDAL_VERSION
147 struct gss_cred_id_t_desc_struct
149 struct gss_cred_id_struct
155 gss_name_t target; /* for initiator */
156 gss_buffer_desc password;
157 gss_OID_set mechanisms;
159 gss_buffer_desc radiusConfigFile;
160 gss_buffer_desc radiusConfigStanza;
161 gss_buffer_desc caCertificate;
162 gss_buffer_desc subjectNameConstraint;
163 gss_buffer_desc subjectAltNameConstraint;
164 gss_buffer_desc clientCertificate;
165 gss_buffer_desc privateKey;
166 gss_buffer_desc caCertificateBlob;
167 #ifdef GSSEAP_ENABLE_REAUTH
168 krb5_ccache krbCredCache;
169 gss_cred_id_t reauthCred;
173 #define CTX_FLAG_INITIATOR 0x00000001
174 #define CTX_FLAG_KRB_REAUTH 0x00000002
175 #define CTX_FLAG_CHANNEL_BINDINGS_VERIFIED 0x00000004
177 #define CTX_IS_INITIATOR(ctx) (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
179 #define CTX_IS_ESTABLISHED(ctx) ((ctx)->state == GSSEAP_STATE_ESTABLISHED)
181 /* Initiator context flags */
182 #define CTX_FLAG_EAP_SUCCESS 0x00010000
183 #define CTX_FLAG_EAP_RESTART 0x00020000
184 #define CTX_FLAG_EAP_FAIL 0x00040000
185 #define CTX_FLAG_EAP_RESP 0x00080000
186 #define CTX_FLAG_EAP_NO_RESP 0x00100000
187 #define CTX_FLAG_EAP_REQ 0x00200000
188 #define CTX_FLAG_EAP_PORT_ENABLED 0x00400000
189 #define CTX_FLAG_EAP_ALT_ACCEPT 0x00800000
190 #define CTX_FLAG_EAP_ALT_REJECT 0x01000000
191 #define CTX_FLAG_EAP_CHBIND_ACCEPT 0x02000000
192 #define CTX_FLAG_EAP_TRIGGER_START 0x04000000
193 #define CTX_FLAG_EAP_MASK 0xFFFF0000
195 #define CONFIG_BLOB_CLIENT_CERT 0
196 #define CONFIG_BLOB_PRIVATE_KEY 1
197 #define CONFIG_BLOB_CA_CERT 2
198 #define CONFIG_BLOB_MAX 3
200 struct gss_eap_initiator_ctx {
201 unsigned int idleWhile;
202 struct eap_peer_config eapPeerConfig;
204 struct wpabuf reqData;
205 struct wpabuf *chbindData;
206 unsigned int chbindReqFlags;
207 struct wpa_config_blob configBlobs[CONFIG_BLOB_MAX];
210 #ifdef GSSEAP_ENABLE_ACCEPTOR
211 struct gss_eap_acceptor_ctx {
212 struct rs_context *radContext;
213 struct rs_connection *radConn;
215 gss_buffer_desc state;
220 #ifdef HAVE_HEIMDAL_VERSION
221 struct gss_ctx_id_t_desc_struct
223 struct gss_ctx_id_struct
227 enum gss_eap_state state;
230 gss_OID mechanismUsed;
231 krb5_cksumtype checksumType;
232 krb5_enctype encryptionType;
233 krb5_keyblock rfc3961Key;
234 gss_name_t initiatorName;
235 gss_name_t acceptorName;
237 uint64_t sendSeq, recvSeq;
241 struct gss_eap_initiator_ctx initiator;
242 #define initiatorCtx ctxU.initiator
243 #ifdef GSSEAP_ENABLE_ACCEPTOR
244 struct gss_eap_acceptor_ctx acceptor;
245 #define acceptorCtx ctxU.acceptor
247 #ifdef GSSEAP_ENABLE_REAUTH
249 #define reauthCtx ctxU.reauth
252 const struct gss_eap_token_buffer_set *inputTokens;
253 const struct gss_eap_token_buffer_set *outputTokens;
257 #define TOK_FLAG_SENDER_IS_ACCEPTOR 0x01
258 #define TOK_FLAG_WRAP_CONFIDENTIAL 0x02
259 #define TOK_FLAG_ACCEPTOR_SUBKEY 0x04
261 #define KEY_USAGE_ACCEPTOR_SEAL 22
262 #define KEY_USAGE_ACCEPTOR_SIGN 23
263 #define KEY_USAGE_INITIATOR_SEAL 24
264 #define KEY_USAGE_INITIATOR_SIGN 25
266 #define KEY_USAGE_GSSEAP_CHBIND_MIC 60
267 #define KEY_USAGE_GSSEAP_ACCTOKEN_MIC 61
268 #define KEY_USAGE_GSSEAP_INITOKEN_MIC 62
270 /* accept_sec_context.c */
272 gssEapAcceptSecContext(OM_uint32 *minor,
275 gss_buffer_t input_token,
276 gss_channel_bindings_t input_chan_bindings,
277 gss_name_t *src_name,
279 gss_buffer_t output_token,
280 OM_uint32 *ret_flags,
282 gss_cred_id_t *delegated_cred_handle);
284 /* init_sec_context.c */
286 gssEapInitSecContext(OM_uint32 *minor,
289 gss_const_name_t target_name,
293 gss_channel_bindings_t input_chan_bindings,
294 gss_buffer_t input_token,
295 gss_OID *actual_mech_type,
296 gss_buffer_t output_token,
297 OM_uint32 *ret_flags,
298 OM_uint32 *time_rec);
302 gssEapWrapOrGetMIC(OM_uint32 *minor,
306 gss_iov_buffer_desc *iov,
308 enum gss_eap_token_type toktype);
311 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
314 gss_qop_t *qop_state,
315 gss_iov_buffer_desc *iov,
317 enum gss_eap_token_type toktype);
320 gssEapWrapIovLength(OM_uint32 *minor,
321 gss_const_ctx_id_t ctx,
325 gss_iov_buffer_desc *iov,
327 enum gss_eap_token_type tokType);
330 gssEapWrap(OM_uint32 *minor,
334 gss_buffer_t input_message_buffer,
336 gss_buffer_t output_message_buffer);
339 rfc4121Flags(gss_const_ctx_id_t ctx, int receiving);
341 /* display_status.c */
343 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
346 gssEapDisplayStatus(OM_uint32 *minor,
347 OM_uint32 status_value,
348 gss_buffer_t status_string);
350 #define IS_WIRE_ERROR(err) ((err) >= GSSEAP_RESERVED && \
351 (err) <= GSSEAP_RADIUS_PROT_FAILURE)
353 #ifdef GSSEAP_ENABLE_ACCEPTOR
354 #define IS_RADIUS_ERROR(err) ((err) >= ERROR_TABLE_BASE_rse && \
355 (err) <= ERROR_TABLE_BASE_rse + RSE_MAX)
357 #define IS_RADIUS_ERROR(err) (0)
360 /* exchange_meta_data.c */
361 OM_uint32 GSSAPI_CALLCONV
362 gssEapExchangeMetaData(OM_uint32 *minor,
366 const gss_name_t name,
368 gss_const_buffer_t meta_data);
370 /* export_sec_context.c */
372 gssEapExportSecContext(OM_uint32 *minor,
376 /* import_sec_context.c */
378 gssEapImportContext(OM_uint32 *minor,
382 /* inquire_sec_context_by_oid.c */
383 #define NEGOEX_INITIATOR_SALT "gss-eap-negoex-initiator"
384 #define NEGOEX_INITIATOR_SALT_LEN (sizeof(NEGOEX_INITIATOR_SALT) - 1)
386 #define NEGOEX_ACCEPTOR_SALT "gss-eap-negoex-acceptor"
387 #define NEGOEX_ACCEPTOR_SALT_LEN (sizeof(NEGOEX_ACCEPTOR_SALT) - 1)
389 /* pseudo_random.c */
391 gssEapPseudoRandom(OM_uint32 *minor,
392 gss_const_ctx_id_t ctx,
394 const gss_buffer_t prf_in,
395 gss_buffer_t prf_out);
397 /* query_mechanism_info.c */
399 gssQueryMechanismInfo(OM_uint32 *minor,
400 gss_const_OID mech_oid,
401 unsigned char auth_scheme[16]);
403 /* query_meta_data.c */
405 gssEapQueryMetaData(OM_uint32 *minor,
406 gss_const_OID mech GSSEAP_UNUSED,
408 gss_ctx_id_t *context_handle,
409 const gss_name_t name,
410 OM_uint32 req_flags GSSEAP_UNUSED,
411 gss_buffer_t meta_data);
415 gssEapInitiatorInit(OM_uint32 *minor);
418 gssEapFinalize(void);
420 /* Debugging and tracing */
423 gssEapTraceStatus(const char *function,
427 gss_buffer_desc gssErrorCodeBuf = GSS_C_EMPTY_BUFFER;
428 gss_buffer_desc gssMechBuf = GSS_C_EMPTY_BUFFER;
429 OM_uint32 tmpMajor, tmpMinor;
430 OM_uint32 messageCtx = 0;
432 tmpMajor = gss_display_status(&tmpMinor, major,
433 GSS_C_GSS_CODE, GSS_C_NO_OID,
434 &messageCtx, &gssErrorCodeBuf);
435 if (!GSS_ERROR(tmpMajor)) {
437 tmpMajor = makeStringBuffer(&tmpMinor, "no minor", &gssMechBuf);
439 tmpMajor = gssEapDisplayStatus(&tmpMinor, minor, &gssMechBuf);
442 if (!GSS_ERROR(tmpMajor))
443 wpa_printf(MSG_INFO, "%s: %.*s/%.*s",
445 (int)gssErrorCodeBuf.length, (char *)gssErrorCodeBuf.value,
446 (int)gssMechBuf.length, (char *)gssMechBuf.value);
448 wpa_printf(MSG_INFO, "%s: %u/%u",
449 function, major, minor);
451 gss_release_buffer(&tmpMinor, &gssErrorCodeBuf);
452 gss_release_buffer(&tmpMinor, &gssMechBuf);
455 /* If built as a library on Linux, don't respect environment when set*uid */
456 #ifdef HAVE_SECURE_GETENV
457 #define getenv secure_getenv
464 #endif /* _GSSAPIP_EAP_H_ */