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 */
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 "gsseap_err.h"
105 #include "radsec_err.h"
112 /* These name flags are informative and not actually used by anything yet */
113 #define NAME_FLAG_NAI 0x00000001
114 #define NAME_FLAG_SERVICE 0x00000002
115 #define NAME_FLAG_COMPOSITE 0x00000004
117 struct gss_eap_saml_attr_ctx;
118 struct gss_eap_attr_ctx;
120 #ifdef HAVE_HEIMDAL_VERSION
121 struct gss_name_t_desc_struct
123 struct gss_name_struct
126 GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
128 gss_OID mechanismUsed; /* this is immutable */
129 krb5_principal krbPrincipal; /* this is immutable */
130 #ifdef GSSEAP_ENABLE_ACCEPTOR
131 struct gss_eap_attr_ctx *attrCtx;
135 #define CRED_FLAG_INITIATE 0x00010000
136 #define CRED_FLAG_ACCEPT 0x00020000
137 #define CRED_FLAG_PASSWORD 0x00040000
138 #define CRED_FLAG_DEFAULT_CCACHE 0x00080000
139 #define CRED_FLAG_RESOLVED 0x00100000
140 #define CRED_FLAG_TARGET 0x00200000
141 #define CRED_FLAG_CERTIFICATE 0x00400000
142 #define CRED_FLAG_CONFIG_BLOB 0x00800000
143 #define CRED_FLAG_PUBLIC_MASK 0x0000FFFF
145 #ifdef HAVE_HEIMDAL_VERSION
146 struct gss_cred_id_t_desc_struct
148 struct gss_cred_id_struct
154 gss_name_t target; /* for initiator */
155 gss_buffer_desc password;
156 gss_OID_set mechanisms;
158 gss_buffer_desc radiusConfigFile;
159 gss_buffer_desc radiusConfigStanza;
160 gss_buffer_desc caCertificate;
161 gss_buffer_desc subjectNameConstraint;
162 gss_buffer_desc subjectAltNameConstraint;
163 gss_buffer_desc clientCertificate;
164 gss_buffer_desc privateKey;
165 gss_buffer_desc caCertificateBlob;
166 #ifdef GSSEAP_ENABLE_REAUTH
167 krb5_ccache krbCredCache;
168 gss_cred_id_t reauthCred;
172 #define CTX_FLAG_INITIATOR 0x00000001
173 #define CTX_FLAG_KRB_REAUTH 0x00000002
174 #define CTX_FLAG_CHANNEL_BINDINGS_VERIFIED 0x00000004
176 #define CTX_IS_INITIATOR(ctx) (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
178 #define CTX_IS_ESTABLISHED(ctx) ((ctx)->state == GSSEAP_STATE_ESTABLISHED)
180 /* Initiator context flags */
181 #define CTX_FLAG_EAP_SUCCESS 0x00010000
182 #define CTX_FLAG_EAP_RESTART 0x00020000
183 #define CTX_FLAG_EAP_FAIL 0x00040000
184 #define CTX_FLAG_EAP_RESP 0x00080000
185 #define CTX_FLAG_EAP_NO_RESP 0x00100000
186 #define CTX_FLAG_EAP_REQ 0x00200000
187 #define CTX_FLAG_EAP_PORT_ENABLED 0x00400000
188 #define CTX_FLAG_EAP_ALT_ACCEPT 0x00800000
189 #define CTX_FLAG_EAP_ALT_REJECT 0x01000000
190 #define CTX_FLAG_EAP_CHBIND_ACCEPT 0x02000000
191 #define CTX_FLAG_EAP_TRIGGER_START 0x04000000
192 #define CTX_FLAG_EAP_MASK 0xFFFF0000
194 #define CONFIG_BLOB_CLIENT_CERT 0
195 #define CONFIG_BLOB_PRIVATE_KEY 1
196 #define CONFIG_BLOB_CA_CERT 2
197 #define CONFIG_BLOB_MAX 3
199 struct gss_eap_initiator_ctx {
200 unsigned int idleWhile;
201 struct eap_peer_config eapPeerConfig;
203 struct wpabuf reqData;
204 struct wpabuf *chbindData;
205 unsigned int chbindReqFlags;
206 struct wpa_config_blob configBlobs[CONFIG_BLOB_MAX];
209 #ifdef GSSEAP_ENABLE_ACCEPTOR
210 struct gss_eap_acceptor_ctx {
211 struct rs_context *radContext;
212 struct rs_connection *radConn;
214 gss_buffer_desc state;
219 #ifdef HAVE_HEIMDAL_VERSION
220 struct gss_ctx_id_t_desc_struct
222 struct gss_ctx_id_struct
226 enum gss_eap_state state;
229 gss_OID mechanismUsed;
230 krb5_cksumtype checksumType;
231 krb5_enctype encryptionType;
232 krb5_keyblock rfc3961Key;
233 gss_name_t initiatorName;
234 gss_name_t acceptorName;
236 uint64_t sendSeq, recvSeq;
240 struct gss_eap_initiator_ctx initiator;
241 #define initiatorCtx ctxU.initiator
242 #ifdef GSSEAP_ENABLE_ACCEPTOR
243 struct gss_eap_acceptor_ctx acceptor;
244 #define acceptorCtx ctxU.acceptor
246 #ifdef GSSEAP_ENABLE_REAUTH
248 #define reauthCtx ctxU.reauth
251 const struct gss_eap_token_buffer_set *inputTokens;
252 const struct gss_eap_token_buffer_set *outputTokens;
255 #define TOK_FLAG_SENDER_IS_ACCEPTOR 0x01
256 #define TOK_FLAG_WRAP_CONFIDENTIAL 0x02
257 #define TOK_FLAG_ACCEPTOR_SUBKEY 0x04
259 #define KEY_USAGE_ACCEPTOR_SEAL 22
260 #define KEY_USAGE_ACCEPTOR_SIGN 23
261 #define KEY_USAGE_INITIATOR_SEAL 24
262 #define KEY_USAGE_INITIATOR_SIGN 25
264 #define KEY_USAGE_GSSEAP_CHBIND_MIC 60
265 #define KEY_USAGE_GSSEAP_ACCTOKEN_MIC 61
266 #define KEY_USAGE_GSSEAP_INITOKEN_MIC 62
268 /* accept_sec_context.c */
270 gssEapAcceptSecContext(OM_uint32 *minor,
273 gss_buffer_t input_token,
274 gss_channel_bindings_t input_chan_bindings,
275 gss_name_t *src_name,
277 gss_buffer_t output_token,
278 OM_uint32 *ret_flags,
280 gss_cred_id_t *delegated_cred_handle);
282 /* init_sec_context.c */
284 gssEapInitSecContext(OM_uint32 *minor,
287 gss_const_name_t target_name,
291 gss_channel_bindings_t input_chan_bindings,
292 gss_buffer_t input_token,
293 gss_OID *actual_mech_type,
294 gss_buffer_t output_token,
295 OM_uint32 *ret_flags,
296 OM_uint32 *time_rec);
300 gssEapWrapOrGetMIC(OM_uint32 *minor,
304 gss_iov_buffer_desc *iov,
306 enum gss_eap_token_type toktype);
309 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
312 gss_qop_t *qop_state,
313 gss_iov_buffer_desc *iov,
315 enum gss_eap_token_type toktype);
318 gssEapWrapIovLength(OM_uint32 *minor,
319 gss_const_ctx_id_t ctx,
323 gss_iov_buffer_desc *iov,
325 enum gss_eap_token_type tokType);
328 gssEapWrap(OM_uint32 *minor,
332 gss_buffer_t input_message_buffer,
334 gss_buffer_t output_message_buffer);
337 rfc4121Flags(gss_const_ctx_id_t ctx, int receiving);
339 /* display_status.c */
341 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
344 gssEapDisplayStatus(OM_uint32 *minor,
345 OM_uint32 status_value,
346 gss_buffer_t status_string);
348 #define IS_WIRE_ERROR(err) ((err) >= GSSEAP_RESERVED && \
349 (err) <= GSSEAP_RADIUS_PROT_FAILURE)
351 #ifdef GSSEAP_ENABLE_ACCEPTOR
352 #define IS_RADIUS_ERROR(err) ((err) >= ERROR_TABLE_BASE_rse && \
353 (err) <= ERROR_TABLE_BASE_rse + RSE_MAX)
355 #define IS_RADIUS_ERROR(err) (0)
358 /* exchange_meta_data.c */
359 OM_uint32 GSSAPI_CALLCONV
360 gssEapExchangeMetaData(OM_uint32 *minor,
364 const gss_name_t name,
366 gss_const_buffer_t meta_data);
368 /* export_sec_context.c */
370 gssEapExportSecContext(OM_uint32 *minor,
374 /* import_sec_context.c */
376 gssEapImportContext(OM_uint32 *minor,
380 /* inquire_sec_context_by_oid.c */
381 #define NEGOEX_INITIATOR_SALT "gss-eap-negoex-initiator"
382 #define NEGOEX_INITIATOR_SALT_LEN (sizeof(NEGOEX_INITIATOR_SALT) - 1)
384 #define NEGOEX_ACCEPTOR_SALT "gss-eap-negoex-acceptor"
385 #define NEGOEX_ACCEPTOR_SALT_LEN (sizeof(NEGOEX_ACCEPTOR_SALT) - 1)
387 /* pseudo_random.c */
389 gssEapPseudoRandom(OM_uint32 *minor,
390 gss_const_ctx_id_t ctx,
392 const gss_buffer_t prf_in,
393 gss_buffer_t prf_out);
395 /* query_mechanism_info.c */
397 gssQueryMechanismInfo(OM_uint32 *minor,
398 gss_const_OID mech_oid,
399 unsigned char auth_scheme[16]);
401 /* query_meta_data.c */
403 gssEapQueryMetaData(OM_uint32 *minor,
404 gss_const_OID mech GSSEAP_UNUSED,
406 gss_ctx_id_t *context_handle,
407 const gss_name_t name,
408 OM_uint32 req_flags GSSEAP_UNUSED,
409 gss_buffer_t meta_data);
413 gssEapInitiatorInit(OM_uint32 *minor);
416 gssEapFinalize(void);
418 /* Debugging and tracing */
421 gssEapTraceStatus(const char *function,
425 gss_buffer_desc gssErrorCodeBuf = GSS_C_EMPTY_BUFFER;
426 gss_buffer_desc gssMechBuf = GSS_C_EMPTY_BUFFER;
427 OM_uint32 tmpMajor, tmpMinor;
428 OM_uint32 messageCtx = 0;
430 tmpMajor = gss_display_status(&tmpMinor, major,
431 GSS_C_GSS_CODE, GSS_C_NO_OID,
432 &messageCtx, &gssErrorCodeBuf);
433 if (!GSS_ERROR(tmpMajor)) {
435 tmpMajor = makeStringBuffer(&tmpMinor, "no minor", &gssMechBuf);
437 tmpMajor = gssEapDisplayStatus(&tmpMinor, minor, &gssMechBuf);
440 if (!GSS_ERROR(tmpMajor))
441 wpa_printf(MSG_INFO, "%s: %.*s/%.*s",
443 (int)gssErrorCodeBuf.length, (char *)gssErrorCodeBuf.value,
444 (int)gssMechBuf.length, (char *)gssMechBuf.value);
446 wpa_printf(MSG_INFO, "%s: %u/%u",
447 function, major, minor);
449 gss_release_buffer(&tmpMinor, &gssErrorCodeBuf);
450 gss_release_buffer(&tmpMinor, &gssMechBuf);
453 /* If built as a library on Linux, don't respect environment when set*uid */
454 #ifdef HAVE_SECURE_GETENV
455 #define getenv secure_getenv
462 #endif /* _GSSAPIP_EAP_H_ */