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 */
90 #include <eap_peer/eap.h>
91 #include <eap_peer/eap_config.h>
92 #include <eap_peer/eap_methods.h>
93 #include <eap_common/eap_common.h>
96 #ifdef GSSEAP_ENABLE_ACCEPTOR
97 /* libradsec headers */
98 #include <radsec/radsec.h>
99 #include <radsec/request.h>
100 #include <radsec/radius.h>
103 #include "gsseap_err.h"
104 #include "radsec_err.h"
111 /* These name flags are informative and not actually used by anything yet */
112 #define NAME_FLAG_NAI 0x00000001
113 #define NAME_FLAG_SERVICE 0x00000002
114 #define NAME_FLAG_COMPOSITE 0x00000004
116 struct gss_eap_saml_attr_ctx;
117 struct gss_eap_attr_ctx;
119 #ifdef HAVE_HEIMDAL_VERSION
120 struct gss_name_t_desc_struct
122 struct gss_name_struct
125 GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
127 gss_OID mechanismUsed; /* this is immutable */
128 krb5_principal krbPrincipal; /* this is immutable */
129 #ifdef GSSEAP_ENABLE_ACCEPTOR
130 struct gss_eap_attr_ctx *attrCtx;
134 #define CRED_FLAG_INITIATE 0x00010000
135 #define CRED_FLAG_ACCEPT 0x00020000
136 #define CRED_FLAG_PASSWORD 0x00040000
137 #define CRED_FLAG_DEFAULT_CCACHE 0x00080000
138 #define CRED_FLAG_RESOLVED 0x00100000
139 #define CRED_FLAG_TARGET 0x00200000
140 #define CRED_FLAG_CERTIFICATE 0x00400000
141 #define CRED_FLAG_CONFIG_BLOB 0x00800000
142 #define CRED_FLAG_PUBLIC_MASK 0x0000FFFF
144 #ifdef HAVE_HEIMDAL_VERSION
145 struct gss_cred_id_t_desc_struct
147 struct gss_cred_id_struct
153 gss_name_t target; /* for initiator */
154 gss_buffer_desc password;
155 gss_OID_set mechanisms;
157 gss_buffer_desc radiusConfigFile;
158 gss_buffer_desc radiusConfigStanza;
159 gss_buffer_desc caCertificate;
160 gss_buffer_desc subjectNameConstraint;
161 gss_buffer_desc subjectAltNameConstraint;
162 gss_buffer_desc clientCertificate;
163 gss_buffer_desc privateKey;
164 gss_buffer_desc caCertificateBlob;
165 #ifdef GSSEAP_ENABLE_REAUTH
166 krb5_ccache krbCredCache;
167 gss_cred_id_t reauthCred;
171 #define CTX_FLAG_INITIATOR 0x00000001
172 #define CTX_FLAG_KRB_REAUTH 0x00000002
173 #define CTX_FLAG_CHANNEL_BINDINGS_VERIFIED 0x00000004
175 #define CTX_IS_INITIATOR(ctx) (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
177 #define CTX_IS_ESTABLISHED(ctx) ((ctx)->state == GSSEAP_STATE_ESTABLISHED)
179 /* Initiator context flags */
180 #define CTX_FLAG_EAP_SUCCESS 0x00010000
181 #define CTX_FLAG_EAP_RESTART 0x00020000
182 #define CTX_FLAG_EAP_FAIL 0x00040000
183 #define CTX_FLAG_EAP_RESP 0x00080000
184 #define CTX_FLAG_EAP_NO_RESP 0x00100000
185 #define CTX_FLAG_EAP_REQ 0x00200000
186 #define CTX_FLAG_EAP_PORT_ENABLED 0x00400000
187 #define CTX_FLAG_EAP_ALT_ACCEPT 0x00800000
188 #define CTX_FLAG_EAP_ALT_REJECT 0x01000000
189 #define CTX_FLAG_EAP_CHBIND_ACCEPT 0x02000000
190 #define CTX_FLAG_EAP_MASK 0xFFFF0000
192 #define CONFIG_BLOB_CLIENT_CERT 0
193 #define CONFIG_BLOB_PRIVATE_KEY 1
194 #define CONFIG_BLOB_CA_CERT 2
195 #define CONFIG_BLOB_MAX 3
197 struct gss_eap_initiator_ctx {
198 unsigned int idleWhile;
199 struct eap_peer_config eapPeerConfig;
201 struct wpabuf reqData;
202 struct wpabuf *chbindData;
203 unsigned int chbindReqFlags;
204 struct wpa_config_blob configBlobs[CONFIG_BLOB_MAX];
207 #ifdef GSSEAP_ENABLE_ACCEPTOR
208 struct gss_eap_acceptor_ctx {
209 struct rs_context *radContext;
210 struct rs_connection *radConn;
212 gss_buffer_desc state;
217 #ifdef HAVE_HEIMDAL_VERSION
218 struct gss_ctx_id_t_desc_struct
220 struct gss_ctx_id_struct
224 enum gss_eap_state state;
227 gss_OID mechanismUsed;
228 krb5_cksumtype checksumType;
229 krb5_enctype encryptionType;
230 krb5_keyblock rfc3961Key;
231 gss_name_t initiatorName;
232 gss_name_t acceptorName;
234 uint64_t sendSeq, recvSeq;
238 struct gss_eap_initiator_ctx initiator;
239 #define initiatorCtx ctxU.initiator
240 #ifdef GSSEAP_ENABLE_ACCEPTOR
241 struct gss_eap_acceptor_ctx acceptor;
242 #define acceptorCtx ctxU.acceptor
244 #ifdef GSSEAP_ENABLE_REAUTH
246 #define reauthCtx ctxU.reauth
249 const struct gss_eap_token_buffer_set *inputTokens;
250 const struct gss_eap_token_buffer_set *outputTokens;
253 #define TOK_FLAG_SENDER_IS_ACCEPTOR 0x01
254 #define TOK_FLAG_WRAP_CONFIDENTIAL 0x02
255 #define TOK_FLAG_ACCEPTOR_SUBKEY 0x04
257 #define KEY_USAGE_ACCEPTOR_SEAL 22
258 #define KEY_USAGE_ACCEPTOR_SIGN 23
259 #define KEY_USAGE_INITIATOR_SEAL 24
260 #define KEY_USAGE_INITIATOR_SIGN 25
262 #define KEY_USAGE_GSSEAP_CHBIND_MIC 60
263 #define KEY_USAGE_GSSEAP_ACCTOKEN_MIC 61
264 #define KEY_USAGE_GSSEAP_INITOKEN_MIC 62
266 /* accept_sec_context.c */
268 gssEapAcceptSecContext(OM_uint32 *minor,
271 gss_buffer_t input_token,
272 gss_channel_bindings_t input_chan_bindings,
273 gss_name_t *src_name,
275 gss_buffer_t output_token,
276 OM_uint32 *ret_flags,
278 gss_cred_id_t *delegated_cred_handle);
280 /* init_sec_context.c */
282 gssEapInitSecContext(OM_uint32 *minor,
285 gss_name_t target_name,
289 gss_channel_bindings_t input_chan_bindings,
290 gss_buffer_t input_token,
291 gss_OID *actual_mech_type,
292 gss_buffer_t output_token,
293 OM_uint32 *ret_flags,
294 OM_uint32 *time_rec);
298 gssEapWrapOrGetMIC(OM_uint32 *minor,
302 gss_iov_buffer_desc *iov,
304 enum gss_eap_token_type toktype);
307 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
310 gss_qop_t *qop_state,
311 gss_iov_buffer_desc *iov,
313 enum gss_eap_token_type toktype);
316 gssEapWrapIovLength(OM_uint32 *minor,
321 gss_iov_buffer_desc *iov,
323 enum gss_eap_token_type tokType);
326 gssEapWrap(OM_uint32 *minor,
330 gss_buffer_t input_message_buffer,
332 gss_buffer_t output_message_buffer);
335 rfc4121Flags(gss_ctx_id_t ctx, int receiving);
337 /* display_status.c */
339 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
342 gssEapDisplayStatus(OM_uint32 *minor,
343 OM_uint32 status_value,
344 gss_buffer_t status_string);
346 #define IS_WIRE_ERROR(err) ((err) >= GSSEAP_RESERVED && \
347 (err) <= GSSEAP_RADIUS_PROT_FAILURE)
349 #ifdef GSSEAP_ENABLE_ACCEPTOR
350 #define IS_RADIUS_ERROR(err) ((err) >= ERROR_TABLE_BASE_rse && \
351 (err) <= ERROR_TABLE_BASE_rse + RSE_MAX)
353 #define IS_RADIUS_ERROR(err) (0)
356 /* exchange_meta_data.c */
357 OM_uint32 GSSAPI_CALLCONV
358 gssEapExchangeMetaData(OM_uint32 *minor,
362 const gss_name_t name,
364 gss_const_buffer_t meta_data);
366 /* export_sec_context.c */
368 gssEapExportSecContext(OM_uint32 *minor,
372 /* import_sec_context.c */
374 gssEapImportContext(OM_uint32 *minor,
378 /* inquire_sec_context_by_oid.c */
379 #define NEGOEX_INITIATOR_SALT "gss-eap-negoex-initiator"
380 #define NEGOEX_INITIATOR_SALT_LEN (sizeof(NEGOEX_INITIATOR_SALT) - 1)
382 #define NEGOEX_ACCEPTOR_SALT "gss-eap-negoex-acceptor"
383 #define NEGOEX_ACCEPTOR_SALT_LEN (sizeof(NEGOEX_ACCEPTOR_SALT) - 1)
385 /* pseudo_random.c */
387 gssEapPseudoRandom(OM_uint32 *minor,
390 const gss_buffer_t prf_in,
391 gss_buffer_t prf_out);
393 /* query_mechanism_info.c */
395 gssQueryMechanismInfo(OM_uint32 *minor,
396 gss_const_OID mech_oid,
397 unsigned char auth_scheme[16]);
399 /* query_meta_data.c */
401 gssEapQueryMetaData(OM_uint32 *minor,
402 gss_const_OID mech GSSEAP_UNUSED,
404 gss_ctx_id_t *context_handle,
405 const gss_name_t name,
406 OM_uint32 req_flags GSSEAP_UNUSED,
407 gss_buffer_t meta_data);
411 gssEapInitiatorInit(OM_uint32 *minor);
414 gssEapFinalize(void);
416 /* Debugging and tracing*/
417 #define gssEapTrace(_fmt, ...) wpa_printf(MSG_INFO, _fmt, __VA_ARGS__);
420 gssEapTraceStatus(const char *function,
421 OM_uint32 major, OM_uint32 minor)
423 gss_buffer_desc gss_code_buf, mech_buf;
424 OM_uint32 tmpmaj, tmpmin, ctx = 0;
425 gss_code_buf.value = NULL;
426 mech_buf.value = NULL;
427 tmpmaj = gss_display_status(&tmpmin, major,
428 GSS_C_GSS_CODE, GSS_C_NO_OID, &ctx,
430 if (!GSS_ERROR(tmpmaj)) {
432 tmpmaj = makeStringBuffer(&tmpmin, "no minor", &mech_buf);
433 else tmpmaj = gssEapDisplayStatus(&tmpmin, minor, &mech_buf);
435 if (!GSS_ERROR(tmpmaj))
436 wpa_printf(MSG_INFO, "%s: %.*s/%.*s",
437 function, (int) gss_code_buf.length, (char *) gss_code_buf.value,
438 (int) mech_buf.length, (char *) mech_buf.value);
439 else wpa_printf(MSG_INFO, "%s: %u/%u",
440 function, major, minor);
441 tmpmaj = gss_release_buffer(&tmpmin, &gss_code_buf);
442 tmpmaj = gss_release_buffer(&tmpmin, &mech_buf);
446 /*If built as a library on Linux, don't respect environment when set*uid*/
447 #ifdef HAVE_SECURE_GETENV
448 #define getenv secure_getenv
455 #endif /* _GSSAPIP_EAP_H_ */