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 #include <gssapi/gssapi.h>
61 #include <gssapi/gssapi_krb5.h>
62 #ifdef HAVE_HEIMDAL_VERSION
63 typedef struct gss_any *gss_any_t;
65 #include <gssapi/gssapi_ext.h>
67 #include "gssapi_eap.h"
69 #ifndef HAVE_GSS_INQUIRE_ATTRS_FOR_MECH
70 typedef const gss_OID_desc *gss_const_OID;
73 /* Kerberos headers */
79 #include <eap_peer/eap.h>
80 #include <eap_peer/eap_config.h>
81 #include <eap_peer/eap_methods.h>
82 #include <eap_common/eap_common.h>
85 /* FreeRADIUS headers */
86 #ifdef GSSEAP_ENABLE_ACCEPTOR
89 #define operator fr_operator
91 #include <freeradius/libradius.h>
92 #include <freeradius/radius.h>
93 #include <radsec/radsec.h>
94 #include <radsec/request.h>
99 #endif /* GSSEAP_ENABLE_ACCEPTOR */
101 #include "gsseap_err.h"
102 #include "radsec_err.h"
109 /* These name flags are informative and not actually used by anything yet */
110 #define NAME_FLAG_NAI 0x00000001
111 #define NAME_FLAG_SERVICE 0x00000002
112 #define NAME_FLAG_COMPOSITE 0x00000004
114 struct gss_eap_saml_attr_ctx;
115 struct gss_eap_attr_ctx;
117 #ifdef HAVE_HEIMDAL_VERSION
118 struct gss_name_t_desc_struct
120 struct gss_name_struct
123 GSSEAP_MUTEX mutex; /* mutex protects attrCtx */
125 gss_OID mechanismUsed; /* this is immutable */
126 krb5_principal krbPrincipal; /* this is immutable */
127 #ifdef GSSEAP_ENABLE_ACCEPTOR
128 struct gss_eap_attr_ctx *attrCtx;
132 #define CRED_FLAG_INITIATE 0x00010000
133 #define CRED_FLAG_ACCEPT 0x00020000
134 #define CRED_FLAG_PASSWORD 0x00040000
135 #define CRED_FLAG_DEFAULT_CCACHE 0x00080000
136 #define CRED_FLAG_RESOLVED 0x00100000
137 #define CRED_FLAG_PUBLIC_MASK 0x0000FFFF
139 #ifdef HAVE_HEIMDAL_VERSION
140 struct gss_cred_id_t_desc_struct
142 struct gss_cred_id_struct
148 gss_name_t target; /* for initiator */
149 gss_buffer_desc password;
150 gss_OID_set mechanisms;
152 gss_buffer_desc radiusConfigFile;
153 gss_buffer_desc radiusConfigStanza;
154 gss_buffer_desc caCertificate;
155 gss_buffer_desc subjectNameConstraint;
156 gss_buffer_desc subjectAltNameConstraint;
157 #ifdef GSSEAP_ENABLE_REAUTH
158 krb5_ccache krbCredCache;
159 gss_cred_id_t reauthCred;
163 #define CTX_FLAG_INITIATOR 0x00000001
164 #define CTX_FLAG_KRB_REAUTH 0x00000002
166 #define CTX_IS_INITIATOR(ctx) (((ctx)->flags & CTX_FLAG_INITIATOR) != 0)
168 #define CTX_IS_ESTABLISHED(ctx) ((ctx)->state == GSSEAP_STATE_ESTABLISHED)
170 /* Initiator context flags */
171 #define CTX_FLAG_EAP_SUCCESS 0x00010000
172 #define CTX_FLAG_EAP_RESTART 0x00020000
173 #define CTX_FLAG_EAP_FAIL 0x00040000
174 #define CTX_FLAG_EAP_RESP 0x00080000
175 #define CTX_FLAG_EAP_NO_RESP 0x00100000
176 #define CTX_FLAG_EAP_REQ 0x00200000
177 #define CTX_FLAG_EAP_PORT_ENABLED 0x00400000
178 #define CTX_FLAG_EAP_ALT_ACCEPT 0x00800000
179 #define CTX_FLAG_EAP_ALT_REJECT 0x01000000
180 #define CTX_FLAG_EAP_MASK 0xFFFF0000
182 struct gss_eap_initiator_ctx {
183 unsigned int idleWhile;
184 struct eap_peer_config eapPeerConfig;
186 struct wpabuf reqData;
189 #ifdef GSSEAP_ENABLE_ACCEPTOR
190 struct gss_eap_acceptor_ctx {
191 struct rs_context *radContext;
192 struct rs_connection *radConn;
194 gss_buffer_desc state;
199 #ifdef HAVE_HEIMDAL_VERSION
200 struct gss_ctx_id_t_desc_struct
202 struct gss_ctx_id_struct
206 enum gss_eap_state state;
209 gss_OID mechanismUsed;
210 krb5_cksumtype checksumType;
211 krb5_enctype encryptionType;
212 krb5_keyblock rfc3961Key;
213 gss_name_t initiatorName;
214 gss_name_t acceptorName;
216 uint64_t sendSeq, recvSeq;
220 struct gss_eap_initiator_ctx initiator;
221 #define initiatorCtx ctxU.initiator
222 #ifdef GSSEAP_ENABLE_ACCEPTOR
223 struct gss_eap_acceptor_ctx acceptor;
224 #define acceptorCtx ctxU.acceptor
226 #ifdef GSSEAP_ENABLE_REAUTH
228 #define reauthCtx ctxU.reauth
231 const struct gss_eap_token_buffer_set *inputTokens;
232 const struct gss_eap_token_buffer_set *outputTokens;
235 #define TOK_FLAG_SENDER_IS_ACCEPTOR 0x01
236 #define TOK_FLAG_WRAP_CONFIDENTIAL 0x02
237 #define TOK_FLAG_ACCEPTOR_SUBKEY 0x04
239 #define KEY_USAGE_ACCEPTOR_SEAL 22
240 #define KEY_USAGE_ACCEPTOR_SIGN 23
241 #define KEY_USAGE_INITIATOR_SEAL 24
242 #define KEY_USAGE_INITIATOR_SIGN 25
244 /* accept_sec_context.c */
246 gssEapAcceptSecContext(OM_uint32 *minor,
249 gss_buffer_t input_token,
250 gss_channel_bindings_t input_chan_bindings,
251 gss_name_t *src_name,
253 gss_buffer_t output_token,
254 OM_uint32 *ret_flags,
256 gss_cred_id_t *delegated_cred_handle);
258 /* init_sec_context.c */
260 gssEapInitSecContext(OM_uint32 *minor,
263 gss_name_t target_name,
267 gss_channel_bindings_t input_chan_bindings,
268 gss_buffer_t input_token,
269 gss_OID *actual_mech_type,
270 gss_buffer_t output_token,
271 OM_uint32 *ret_flags,
272 OM_uint32 *time_rec);
276 gssEapWrapOrGetMIC(OM_uint32 *minor,
280 gss_iov_buffer_desc *iov,
282 enum gss_eap_token_type toktype);
285 gssEapUnwrapOrVerifyMIC(OM_uint32 *minor_status,
288 gss_qop_t *qop_state,
289 gss_iov_buffer_desc *iov,
291 enum gss_eap_token_type toktype);
294 gssEapWrapIovLength(OM_uint32 *minor,
299 gss_iov_buffer_desc *iov,
302 gssEapWrap(OM_uint32 *minor,
306 gss_buffer_t input_message_buffer,
308 gss_buffer_t output_message_buffer);
311 rfc4121Flags(gss_ctx_id_t ctx, int receiving);
313 /* display_status.c */
315 gssEapSaveStatusInfo(OM_uint32 minor, const char *format, ...);
317 #define IS_WIRE_ERROR(err) ((err) > GSSEAP_RESERVED && \
318 (err) <= GSSEAP_RADIUS_PROT_FAILURE)
320 /* upper bound of RADIUS error range must be kept in sync with radsec.h */
321 #define IS_RADIUS_ERROR(err) ((err) >= ERROR_TABLE_BASE_rse && \
322 (err) <= ERROR_TABLE_BASE_rse + 20)
324 /* export_sec_context.c */
326 gssEapExportSecContext(OM_uint32 *minor,
335 #endif /* _GSSAPIP_EAP_H_ */