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 /* FreeRADIUS headers */
96 #define operator fr_operator
98 #include <freeradius/libradius.h>
99 #include <freeradius/radius.h>
103 /* libradsec headers */
104 #include <radsec/radsec.h>
105 #include <radsec/request.h>
110 #endif /* GSSEAP_ENABLE_ACCEPTOR */
112 #include "gsseap_err.h"
113 #include "radsec_err.h"
120 /* These name flags are informative and not actually used by anything yet */
121 #define NAME_FLAG_NAI 0x00000001
122 #define NAME_FLAG_SERVICE 0x00000002
123 #define NAME_FLAG_COMPOSITE 0x00000004
125 struct gss_eap_saml_attr_ctx;
126 struct gss_eap_attr_ctx;
128 #ifdef HAVE_HEIMDAL_VERSION
129 struct gss_name_t_desc_struct
131 struct gss_name_struct
134 GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
136 gss_OID mechanismUsed; /* this is immutable */
137 krb5_principal krbPrincipal; /* this is immutable */
138 #ifdef GSSEAP_ENABLE_ACCEPTOR
139 struct gss_eap_attr_ctx *attrCtx;
143 #define CRED_FLAG_INITIATE 0x00010000
144 #define CRED_FLAG_ACCEPT 0x00020000
145 #define CRED_FLAG_PASSWORD 0x00040000
146 #define CRED_FLAG_DEFAULT_CCACHE 0x00080000
147 #define CRED_FLAG_RESOLVED 0x00100000
148 #define CRED_FLAG_PUBLIC_MASK 0x0000FFFF
150 #ifdef HAVE_HEIMDAL_VERSION
151 struct gss_cred_id_t_desc_struct
153 struct gss_cred_id_struct
159 gss_name_t target; /* for initiator */
160 gss_buffer_desc password;
161 gss_OID_set mechanisms;
163 gss_buffer_desc radiusConfigFile;
164 gss_buffer_desc radiusConfigStanza;
165 gss_buffer_desc caCertificate;
166 gss_buffer_desc subjectNameConstraint;
167 gss_buffer_desc subjectAltNameConstraint;
168 #ifdef GSSEAP_ENABLE_REAUTH
169 krb5_ccache krbCredCache;
170 gss_cred_id_t reauthCred;
174 #define CTX_FLAG_INITIATOR 0x00000001
175 #define CTX_FLAG_KRB_REAUTH 0x00000002
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_MASK 0xFFFF0000
193 struct gss_eap_initiator_ctx {
194 unsigned int idleWhile;
195 struct eap_peer_config eapPeerConfig;
197 struct wpabuf reqData;
200 #ifdef GSSEAP_ENABLE_ACCEPTOR
201 struct gss_eap_acceptor_ctx {
202 struct rs_context *radContext;
203 struct rs_connection *radConn;
205 gss_buffer_desc state;
210 #ifdef HAVE_HEIMDAL_VERSION
211 struct gss_ctx_id_t_desc_struct
213 struct gss_ctx_id_struct
217 enum gss_eap_state state;
220 gss_OID mechanismUsed;
221 krb5_cksumtype checksumType;
222 krb5_enctype encryptionType;
223 krb5_keyblock rfc3961Key;
224 gss_name_t initiatorName;
225 gss_name_t acceptorName;
227 uint64_t sendSeq, recvSeq;
231 struct gss_eap_initiator_ctx initiator;
232 #define initiatorCtx ctxU.initiator
233 #ifdef GSSEAP_ENABLE_ACCEPTOR
234 struct gss_eap_acceptor_ctx acceptor;
235 #define acceptorCtx ctxU.acceptor
237 #ifdef GSSEAP_ENABLE_REAUTH
239 #define reauthCtx ctxU.reauth
242 const struct gss_eap_token_buffer_set *inputTokens;
243 const struct gss_eap_token_buffer_set *outputTokens;
246 #define TOK_FLAG_SENDER_IS_ACCEPTOR 0x01
247 #define TOK_FLAG_WRAP_CONFIDENTIAL 0x02
248 #define TOK_FLAG_ACCEPTOR_SUBKEY 0x04
250 #define KEY_USAGE_ACCEPTOR_SEAL 22
251 #define KEY_USAGE_ACCEPTOR_SIGN 23
252 #define KEY_USAGE_INITIATOR_SEAL 24
253 #define KEY_USAGE_INITIATOR_SIGN 25
255 /* accept_sec_context.c */
257 gssEapAcceptSecContext(OM_uint32 *minor,
260 gss_buffer_t input_token,
261 gss_channel_bindings_t input_chan_bindings,
262 gss_name_t *src_name,
264 gss_buffer_t output_token,
265 OM_uint32 *ret_flags,
267 gss_cred_id_t *delegated_cred_handle);
269 /* init_sec_context.c */
271 gssEapInitSecContext(OM_uint32 *minor,
274 gss_name_t target_name,
278 gss_channel_bindings_t input_chan_bindings,
279 gss_buffer_t input_token,
280 gss_OID *actual_mech_type,
281 gss_buffer_t output_token,
282 OM_uint32 *ret_flags,
283 OM_uint32 *time_rec);
287 gssEapWrapOrGetMIC(OM_uint32 *minor,
291 gss_iov_buffer_desc *iov,
293 enum gss_eap_token_type toktype);
296 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
299 gss_qop_t *qop_state,
300 gss_iov_buffer_desc *iov,
302 enum gss_eap_token_type toktype);
305 gssEapWrapIovLength(OM_uint32 *minor,
310 gss_iov_buffer_desc *iov,
313 gssEapWrap(OM_uint32 *minor,
317 gss_buffer_t input_message_buffer,
319 gss_buffer_t output_message_buffer);
322 rfc4121Flags(gss_ctx_id_t ctx, int receiving);
324 /* display_status.c */
326 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
329 gssEapDisplayStatus(OM_uint32 *minor,
330 OM_uint32 status_value,
331 gss_buffer_t status_string);
333 #define IS_WIRE_ERROR(err) ((err) > GSSEAP_RESERVED && \
334 (err) <= GSSEAP_RADIUS_PROT_FAILURE)
336 /* upper bound of RADIUS error range must be kept in sync with radsec.h */
337 #define IS_RADIUS_ERROR(err) ((err) >= ERROR_TABLE_BASE_rse && \
338 (err) <= ERROR_TABLE_BASE_rse + 20)
340 /* export_sec_context.c */
342 gssEapExportSecContext(OM_uint32 *minor,
349 gssEapInitiatorInit(void);
352 gssEapFinalize(void);
358 #endif /* _GSSAPIP_EAP_H_ */