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 /* FreeRADIUS headers */
93 #ifdef GSSEAP_ENABLE_ACCEPTOR
96 #define operator fr_operator
98 #include <freeradius/libradius.h>
99 #include <freeradius/radius.h>
100 #include <radsec/radsec.h>
101 #include <radsec/request.h>
106 #endif /* GSSEAP_ENABLE_ACCEPTOR */
108 #include "gsseap_err.h"
109 #include "radsec_err.h"
116 /* These name flags are informative and not actually used by anything yet */
117 #define NAME_FLAG_NAI 0x00000001
118 #define NAME_FLAG_SERVICE 0x00000002
119 #define NAME_FLAG_COMPOSITE 0x00000004
121 struct gss_eap_saml_attr_ctx;
122 struct gss_eap_attr_ctx;
124 #ifdef HAVE_HEIMDAL_VERSION
125 struct gss_name_t_desc_struct
127 struct gss_name_struct
130 GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
132 gss_OID mechanismUsed; /* this is immutable */
133 krb5_principal krbPrincipal; /* this is immutable */
134 #ifdef GSSEAP_ENABLE_ACCEPTOR
135 struct gss_eap_attr_ctx *attrCtx;
139 #define CRED_FLAG_INITIATE 0x00010000
140 #define CRED_FLAG_ACCEPT 0x00020000
141 #define CRED_FLAG_PASSWORD 0x00040000
142 #define CRED_FLAG_DEFAULT_CCACHE 0x00080000
143 #define CRED_FLAG_RESOLVED 0x00100000
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 #ifdef GSSEAP_ENABLE_REAUTH
165 krb5_ccache krbCredCache;
166 gss_cred_id_t reauthCred;
170 #define CTX_FLAG_INITIATOR 0x00000001
171 #define CTX_FLAG_KRB_REAUTH 0x00000002
173 #define CTX_IS_INITIATOR(ctx) (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
175 #define CTX_IS_ESTABLISHED(ctx) ((ctx)->state == GSSEAP_STATE_ESTABLISHED)
177 /* Initiator context flags */
178 #define CTX_FLAG_EAP_SUCCESS 0x00010000
179 #define CTX_FLAG_EAP_RESTART 0x00020000
180 #define CTX_FLAG_EAP_FAIL 0x00040000
181 #define CTX_FLAG_EAP_RESP 0x00080000
182 #define CTX_FLAG_EAP_NO_RESP 0x00100000
183 #define CTX_FLAG_EAP_REQ 0x00200000
184 #define CTX_FLAG_EAP_PORT_ENABLED 0x00400000
185 #define CTX_FLAG_EAP_ALT_ACCEPT 0x00800000
186 #define CTX_FLAG_EAP_ALT_REJECT 0x01000000
187 #define CTX_FLAG_EAP_MASK 0xFFFF0000
189 struct gss_eap_initiator_ctx {
190 unsigned int idleWhile;
191 struct eap_peer_config eapPeerConfig;
193 struct wpabuf reqData;
196 #ifdef GSSEAP_ENABLE_ACCEPTOR
197 struct gss_eap_acceptor_ctx {
198 struct rs_context *radContext;
199 struct rs_connection *radConn;
201 gss_buffer_desc state;
206 #ifdef HAVE_HEIMDAL_VERSION
207 struct gss_ctx_id_t_desc_struct
209 struct gss_ctx_id_struct
213 enum gss_eap_state state;
216 gss_OID mechanismUsed;
217 krb5_cksumtype checksumType;
218 krb5_enctype encryptionType;
219 krb5_keyblock rfc3961Key;
220 gss_name_t initiatorName;
221 gss_name_t acceptorName;
223 uint64_t sendSeq, recvSeq;
227 struct gss_eap_initiator_ctx initiator;
228 #define initiatorCtx ctxU.initiator
229 #ifdef GSSEAP_ENABLE_ACCEPTOR
230 struct gss_eap_acceptor_ctx acceptor;
231 #define acceptorCtx ctxU.acceptor
233 #ifdef GSSEAP_ENABLE_REAUTH
235 #define reauthCtx ctxU.reauth
238 const struct gss_eap_token_buffer_set *inputTokens;
239 const struct gss_eap_token_buffer_set *outputTokens;
242 #define TOK_FLAG_SENDER_IS_ACCEPTOR 0x01
243 #define TOK_FLAG_WRAP_CONFIDENTIAL 0x02
244 #define TOK_FLAG_ACCEPTOR_SUBKEY 0x04
246 #define KEY_USAGE_ACCEPTOR_SEAL 22
247 #define KEY_USAGE_ACCEPTOR_SIGN 23
248 #define KEY_USAGE_INITIATOR_SEAL 24
249 #define KEY_USAGE_INITIATOR_SIGN 25
251 /* accept_sec_context.c */
253 gssEapAcceptSecContext(OM_uint32 *minor,
256 gss_buffer_t input_token,
257 gss_channel_bindings_t input_chan_bindings,
258 gss_name_t *src_name,
260 gss_buffer_t output_token,
261 OM_uint32 *ret_flags,
263 gss_cred_id_t *delegated_cred_handle);
265 /* init_sec_context.c */
267 gssEapInitSecContext(OM_uint32 *minor,
270 gss_name_t target_name,
274 gss_channel_bindings_t input_chan_bindings,
275 gss_buffer_t input_token,
276 gss_OID *actual_mech_type,
277 gss_buffer_t output_token,
278 OM_uint32 *ret_flags,
279 OM_uint32 *time_rec);
283 gssEapWrapOrGetMIC(OM_uint32 *minor,
287 gss_iov_buffer_desc *iov,
289 enum gss_eap_token_type toktype);
292 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
295 gss_qop_t *qop_state,
296 gss_iov_buffer_desc *iov,
298 enum gss_eap_token_type toktype);
301 gssEapWrapIovLength(OM_uint32 *minor,
306 gss_iov_buffer_desc *iov,
309 gssEapWrap(OM_uint32 *minor,
313 gss_buffer_t input_message_buffer,
315 gss_buffer_t output_message_buffer);
318 rfc4121Flags(gss_ctx_id_t ctx, int receiving);
320 /* display_status.c */
322 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
324 #define IS_WIRE_ERROR(err) ((err) > GSSEAP_RESERVED && \
325 (err) <= GSSEAP_RADIUS_PROT_FAILURE)
327 /* upper bound of RADIUS error range must be kept in sync with radsec.h */
328 #define IS_RADIUS_ERROR(err) ((err) >= ERROR_TABLE_BASE_rse && \
329 (err) <= ERROR_TABLE_BASE_rse + 20)
331 /* export_sec_context.c */
333 gssEapExportSecContext(OM_uint32 *minor,
342 #endif /* _GSSAPIP_EAP_H_ */