blob: b5591a01f7a5c3ca919b6d193e41b27322df2318 [file] [log] [blame]
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001/*
2 * EAP peer state machine functions (RFC 4137)
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -07003 * Copyright (c) 2004-2012, Jouni Malinen <j@w1.fi>
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004 *
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07007 */
8
9#ifndef EAP_H
10#define EAP_H
11
12#include "common/defs.h"
13#include "eap_common/eap_defs.h"
14#include "eap_peer/eap_methods.h"
15
16struct eap_sm;
17struct wpa_config_blob;
18struct wpabuf;
19
20struct eap_method_type {
21 int vendor;
22 u32 method;
23};
24
25#ifdef IEEE8021X_EAPOL
26
27/**
28 * enum eapol_bool_var - EAPOL boolean state variables for EAP state machine
29 *
30 * These variables are used in the interface between EAP peer state machine and
31 * lower layer. These are defined in RFC 4137, Sect. 4.1. Lower layer code is
32 * expected to maintain these variables and register a callback functions for
33 * EAP state machine to get and set the variables.
34 */
35enum eapol_bool_var {
36 /**
37 * EAPOL_eapSuccess - EAP SUCCESS state reached
38 *
39 * EAP state machine reads and writes this value.
40 */
41 EAPOL_eapSuccess,
42
43 /**
44 * EAPOL_eapRestart - Lower layer request to restart authentication
45 *
46 * Set to TRUE in lower layer, FALSE in EAP state machine.
47 */
48 EAPOL_eapRestart,
49
50 /**
51 * EAPOL_eapFail - EAP FAILURE state reached
52 *
53 * EAP state machine writes this value.
54 */
55 EAPOL_eapFail,
56
57 /**
58 * EAPOL_eapResp - Response to send
59 *
60 * Set to TRUE in EAP state machine, FALSE in lower layer.
61 */
62 EAPOL_eapResp,
63
64 /**
65 * EAPOL_eapNoResp - Request has been process; no response to send
66 *
67 * Set to TRUE in EAP state machine, FALSE in lower layer.
68 */
69 EAPOL_eapNoResp,
70
71 /**
72 * EAPOL_eapReq - EAP request available from lower layer
73 *
74 * Set to TRUE in lower layer, FALSE in EAP state machine.
75 */
76 EAPOL_eapReq,
77
78 /**
79 * EAPOL_portEnabled - Lower layer is ready for communication
80 *
81 * EAP state machines reads this value.
82 */
83 EAPOL_portEnabled,
84
85 /**
86 * EAPOL_altAccept - Alternate indication of success (RFC3748)
87 *
88 * EAP state machines reads this value.
89 */
90 EAPOL_altAccept,
91
92 /**
93 * EAPOL_altReject - Alternate indication of failure (RFC3748)
94 *
95 * EAP state machines reads this value.
96 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080097 EAPOL_altReject,
98
99 /**
100 * EAPOL_eapTriggerStart - EAP-based trigger to send EAPOL-Start
101 *
102 * EAP state machine writes this value.
103 */
104 EAPOL_eapTriggerStart
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700105};
106
107/**
108 * enum eapol_int_var - EAPOL integer state variables for EAP state machine
109 *
110 * These variables are used in the interface between EAP peer state machine and
111 * lower layer. These are defined in RFC 4137, Sect. 4.1. Lower layer code is
112 * expected to maintain these variables and register a callback functions for
113 * EAP state machine to get and set the variables.
114 */
115enum eapol_int_var {
116 /**
117 * EAPOL_idleWhile - Outside time for EAP peer timeout
118 *
119 * This integer variable is used to provide an outside timer that the
120 * external (to EAP state machine) code must decrement by one every
121 * second until the value reaches zero. This is used in the same way as
122 * EAPOL state machine timers. EAP state machine reads and writes this
123 * value.
124 */
125 EAPOL_idleWhile
126};
127
128/**
129 * struct eapol_callbacks - Callback functions from EAP to lower layer
130 *
131 * This structure defines the callback functions that EAP state machine
132 * requires from the lower layer (usually EAPOL state machine) for updating
133 * state variables and requesting information. eapol_ctx from
134 * eap_peer_sm_init() call will be used as the ctx parameter for these
135 * callback functions.
136 */
137struct eapol_callbacks {
138 /**
139 * get_config - Get pointer to the current network configuration
140 * @ctx: eapol_ctx from eap_peer_sm_init() call
141 */
142 struct eap_peer_config * (*get_config)(void *ctx);
143
144 /**
145 * get_bool - Get a boolean EAPOL state variable
146 * @variable: EAPOL boolean variable to get
147 * Returns: Value of the EAPOL variable
148 */
149 Boolean (*get_bool)(void *ctx, enum eapol_bool_var variable);
150
151 /**
152 * set_bool - Set a boolean EAPOL state variable
153 * @ctx: eapol_ctx from eap_peer_sm_init() call
154 * @variable: EAPOL boolean variable to set
155 * @value: Value for the EAPOL variable
156 */
157 void (*set_bool)(void *ctx, enum eapol_bool_var variable,
158 Boolean value);
159
160 /**
161 * get_int - Get an integer EAPOL state variable
162 * @ctx: eapol_ctx from eap_peer_sm_init() call
163 * @variable: EAPOL integer variable to get
164 * Returns: Value of the EAPOL variable
165 */
166 unsigned int (*get_int)(void *ctx, enum eapol_int_var variable);
167
168 /**
169 * set_int - Set an integer EAPOL state variable
170 * @ctx: eapol_ctx from eap_peer_sm_init() call
171 * @variable: EAPOL integer variable to set
172 * @value: Value for the EAPOL variable
173 */
174 void (*set_int)(void *ctx, enum eapol_int_var variable,
175 unsigned int value);
176
177 /**
178 * get_eapReqData - Get EAP-Request data
179 * @ctx: eapol_ctx from eap_peer_sm_init() call
180 * @len: Pointer to variable that will be set to eapReqDataLen
181 * Returns: Reference to eapReqData (EAP state machine will not free
182 * this) or %NULL if eapReqData not available.
183 */
184 struct wpabuf * (*get_eapReqData)(void *ctx);
185
186 /**
187 * set_config_blob - Set named configuration blob
188 * @ctx: eapol_ctx from eap_peer_sm_init() call
189 * @blob: New value for the blob
190 *
191 * Adds a new configuration blob or replaces the current value of an
192 * existing blob.
193 */
194 void (*set_config_blob)(void *ctx, struct wpa_config_blob *blob);
195
196 /**
197 * get_config_blob - Get a named configuration blob
198 * @ctx: eapol_ctx from eap_peer_sm_init() call
199 * @name: Name of the blob
200 * Returns: Pointer to blob data or %NULL if not found
201 */
202 const struct wpa_config_blob * (*get_config_blob)(void *ctx,
203 const char *name);
204
205 /**
206 * notify_pending - Notify that a pending request can be retried
207 * @ctx: eapol_ctx from eap_peer_sm_init() call
208 *
209 * An EAP method can perform a pending operation (e.g., to get a
210 * response from an external process). Once the response is available,
211 * this callback function can be used to request EAPOL state machine to
212 * retry delivering the previously received (and still unanswered) EAP
213 * request to EAP state machine.
214 */
215 void (*notify_pending)(void *ctx);
216
217 /**
218 * eap_param_needed - Notify that EAP parameter is needed
219 * @ctx: eapol_ctx from eap_peer_sm_init() call
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800220 * @field: Field indicator (e.g., WPA_CTRL_REQ_EAP_IDENTITY)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700221 * @txt: User readable text describing the required parameter
222 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800223 void (*eap_param_needed)(void *ctx, enum wpa_ctrl_req_type field,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700224 const char *txt);
Dmitry Shmidtc55524a2011-07-07 11:18:38 -0700225
226 /**
227 * notify_cert - Notification of a peer certificate
228 * @ctx: eapol_ctx from eap_peer_sm_init() call
229 * @depth: Depth in certificate chain (0 = server)
230 * @subject: Subject of the peer certificate
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800231 * @altsubject: Select fields from AltSubject of the peer certificate
232 * @num_altsubject: Number of altsubject values
Dmitry Shmidtc55524a2011-07-07 11:18:38 -0700233 * @cert_hash: SHA-256 hash of the certificate
234 * @cert: Peer certificate
235 */
236 void (*notify_cert)(void *ctx, int depth, const char *subject,
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800237 const char *altsubject[], int num_altsubject,
Dmitry Shmidtc55524a2011-07-07 11:18:38 -0700238 const char *cert_hash, const struct wpabuf *cert);
Dmitry Shmidt04949592012-07-19 12:16:46 -0700239
240 /**
241 * notify_status - Notification of the current EAP state
242 * @ctx: eapol_ctx from eap_peer_sm_init() call
243 * @status: Step in the process of EAP authentication
244 * @parameter: Step-specific parameter, e.g., EAP method name
245 */
246 void (*notify_status)(void *ctx, const char *status,
247 const char *parameter);
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700248
Dmitry Shmidt203eadb2015-03-05 14:16:04 -0800249#ifdef CONFIG_EAP_PROXY
250 /**
251 * eap_proxy_cb - Callback signifying any updates from eap_proxy
252 * @ctx: eapol_ctx from eap_peer_sm_init() call
253 */
254 void (*eap_proxy_cb)(void *ctx);
Dmitry Shmidt29333592017-01-09 12:27:11 -0800255
256 /**
257 * eap_proxy_notify_sim_status - Notification of SIM status change
258 * @ctx: eapol_ctx from eap_peer_sm_init() call
259 * @sim_state: One of enum value from sim_state
260 */
261 void (*eap_proxy_notify_sim_status)(void *ctx,
262 enum eap_proxy_sim_state sim_state);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700263
264 /**
265 * get_imsi - Get the IMSI value from eap_proxy
266 * @ctx: eapol_ctx from eap_peer_sm_init() call
267 * @sim_num: SIM/USIM number to get the IMSI value for
268 * @imsi: Buffer for IMSI value
269 * @len: Buffer for returning IMSI length in octets
270 * Returns: MNC length (2 or 3) or -1 on error
271 */
272 int (*get_imsi)(void *ctx, int sim_num, char *imsi, size_t *len);
Dmitry Shmidt203eadb2015-03-05 14:16:04 -0800273#endif /* CONFIG_EAP_PROXY */
274
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700275 /**
276 * set_anon_id - Set or add anonymous identity
277 * @ctx: eapol_ctx from eap_peer_sm_init() call
278 * @id: Anonymous identity (e.g., EAP-SIM pseudonym) or %NULL to clear
279 * @len: Length of anonymous identity in octets
280 */
281 void (*set_anon_id)(void *ctx, const u8 *id, size_t len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700282};
283
284/**
285 * struct eap_config - Configuration for EAP state machine
286 */
287struct eap_config {
288 /**
289 * opensc_engine_path - OpenSC engine for OpenSSL engine support
290 *
291 * Usually, path to engine_opensc.so.
292 */
293 const char *opensc_engine_path;
294 /**
295 * pkcs11_engine_path - PKCS#11 engine for OpenSSL engine support
296 *
297 * Usually, path to engine_pkcs11.so.
298 */
299 const char *pkcs11_engine_path;
300 /**
301 * pkcs11_module_path - OpenSC PKCS#11 module for OpenSSL engine
302 *
303 * Usually, path to opensc-pkcs11.so.
304 */
305 const char *pkcs11_module_path;
306 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800307 * openssl_ciphers - OpenSSL cipher string
308 *
309 * This is an OpenSSL specific configuration option for configuring the
310 * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the
311 * default.
312 */
313 const char *openssl_ciphers;
314 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700315 * wps - WPS context data
316 *
317 * This is only used by EAP-WSC and can be left %NULL if not available.
318 */
319 struct wps_context *wps;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800320
321 /**
322 * cert_in_cb - Include server certificates in callback
323 */
324 int cert_in_cb;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700325};
326
327struct eap_sm * eap_peer_sm_init(void *eapol_ctx,
Dmitry Shmidt1d755d02015-04-28 10:34:29 -0700328 const struct eapol_callbacks *eapol_cb,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700329 void *msg_ctx, struct eap_config *conf);
330void eap_peer_sm_deinit(struct eap_sm *sm);
331int eap_peer_sm_step(struct eap_sm *sm);
332void eap_sm_abort(struct eap_sm *sm);
333int eap_sm_get_status(struct eap_sm *sm, char *buf, size_t buflen,
334 int verbose);
335const char * eap_sm_get_method_name(struct eap_sm *sm);
336struct wpabuf * eap_sm_buildIdentity(struct eap_sm *sm, int id, int encrypted);
337void eap_sm_request_identity(struct eap_sm *sm);
338void eap_sm_request_password(struct eap_sm *sm);
339void eap_sm_request_new_password(struct eap_sm *sm);
340void eap_sm_request_pin(struct eap_sm *sm);
341void eap_sm_request_otp(struct eap_sm *sm, const char *msg, size_t msg_len);
342void eap_sm_request_passphrase(struct eap_sm *sm);
Dmitry Shmidt051af732013-10-22 13:52:46 -0700343void eap_sm_request_sim(struct eap_sm *sm, const char *req);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700344void eap_sm_notify_ctrl_attached(struct eap_sm *sm);
345u32 eap_get_phase2_type(const char *name, int *vendor);
346struct eap_method_type * eap_get_phase2_types(struct eap_peer_config *config,
347 size_t *count);
348void eap_set_fast_reauth(struct eap_sm *sm, int enabled);
349void eap_set_workaround(struct eap_sm *sm, unsigned int workaround);
350void eap_set_force_disabled(struct eap_sm *sm, int disabled);
Dmitry Shmidt051af732013-10-22 13:52:46 -0700351void eap_set_external_sim(struct eap_sm *sm, int external_sim);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700352int eap_key_available(struct eap_sm *sm);
353void eap_notify_success(struct eap_sm *sm);
354void eap_notify_lower_layer_success(struct eap_sm *sm);
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800355const u8 * eap_get_eapSessionId(struct eap_sm *sm, size_t *len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700356const u8 * eap_get_eapKeyData(struct eap_sm *sm, size_t *len);
357struct wpabuf * eap_get_eapRespData(struct eap_sm *sm);
358void eap_register_scard_ctx(struct eap_sm *sm, void *ctx);
359void eap_invalidate_cached_session(struct eap_sm *sm);
360
361int eap_is_wps_pbc_enrollee(struct eap_peer_config *conf);
362int eap_is_wps_pin_enrollee(struct eap_peer_config *conf);
363
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700364struct ext_password_data;
365void eap_sm_set_ext_pw_ctx(struct eap_sm *sm, struct ext_password_data *ext);
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700366void eap_set_anon_id(struct eap_sm *sm, const u8 *id, size_t len);
Dmitry Shmidt344abd32014-01-14 13:17:00 -0800367int eap_peer_was_failure_expected(struct eap_sm *sm);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800368void eap_peer_erp_free_keys(struct eap_sm *sm);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800369struct wpabuf * eap_peer_build_erp_reauth_start(struct eap_sm *sm, u8 eap_id);
370void eap_peer_finish(struct eap_sm *sm, const struct eap_hdr *hdr, size_t len);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700371int eap_peer_get_erp_info(struct eap_sm *sm, struct eap_peer_config *config,
372 const u8 **username, size_t *username_len,
373 const u8 **realm, size_t *realm_len, u16 *erp_seq_num,
374 const u8 **rrk, size_t *rrk_len);
375int eap_peer_update_erp_next_seq_num(struct eap_sm *sm, u16 seq_num);
376void eap_peer_erp_init(struct eap_sm *sm, u8 *ext_session_id,
377 size_t ext_session_id_len, u8 *ext_emsk,
378 size_t ext_emsk_len);
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700379
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700380#endif /* IEEE8021X_EAPOL */
381
382#endif /* EAP_H */