1 /* 2 * EAPOL supplicant state machines 3 * Copyright (c) 2004-2012, Jouni Malinen <j (at) w1.fi> 4 * 5 * This software may be distributed under the terms of the BSD license. 6 * See README for more details. 7 */ 8 9 #ifndef EAPOL_SUPP_SM_H 10 #define EAPOL_SUPP_SM_H 11 12 #include "common/defs.h" 13 14 typedef enum { Unauthorized, Authorized } PortStatus; 15 typedef enum { Auto, ForceUnauthorized, ForceAuthorized } PortControl; 16 17 /** 18 * struct eapol_config - Per network configuration for EAPOL state machines 19 */ 20 struct eapol_config { 21 /** 22 * accept_802_1x_keys - Accept IEEE 802.1X (non-WPA) EAPOL-Key frames 23 * 24 * This variable should be set to 1 when using EAPOL state machines 25 * with non-WPA security policy to generate dynamic WEP keys. When 26 * using WPA, this should be set to 0 so that WPA state machine can 27 * process the EAPOL-Key frames. 28 */ 29 int accept_802_1x_keys; 30 31 #define EAPOL_REQUIRE_KEY_UNICAST BIT(0) 32 #define EAPOL_REQUIRE_KEY_BROADCAST BIT(1) 33 /** 34 * required_keys - Which EAPOL-Key packets are required 35 * 36 * This variable determines which EAPOL-Key packets are required before 37 * marking connection authenticated. This is a bit field of 38 * EAPOL_REQUIRE_KEY_UNICAST and EAPOL_REQUIRE_KEY_BROADCAST flags. 39 */ 40 int required_keys; 41 42 /** 43 * fast_reauth - Whether fast EAP reauthentication is enabled 44 */ 45 int fast_reauth; 46 47 /** 48 * workaround - Whether EAP workarounds are enabled 49 */ 50 unsigned int workaround; 51 52 /** 53 * eap_disabled - Whether EAP is disabled 54 */ 55 int eap_disabled; 56 57 /** 58 * external_sim - Use external processing for SIM/USIM operations 59 */ 60 int external_sim; 61 62 #define EAPOL_LOCAL_WPS_IN_USE BIT(0) 63 #define EAPOL_PEER_IS_WPS20_AP BIT(1) 64 /** 65 * wps - Whether this connection is used for WPS 66 */ 67 int wps; 68 }; 69 70 struct eapol_sm; 71 struct wpa_config_blob; 72 73 enum eapol_supp_result { 74 EAPOL_SUPP_RESULT_FAILURE, 75 EAPOL_SUPP_RESULT_SUCCESS, 76 EAPOL_SUPP_RESULT_EXPECTED_FAILURE 77 }; 78 79 /** 80 * struct eapol_ctx - Global (for all networks) EAPOL state machine context 81 */ 82 struct eapol_ctx { 83 /** 84 * ctx - Pointer to arbitrary upper level context 85 */ 86 void *ctx; 87 88 /** 89 * preauth - IEEE 802.11i/RSN pre-authentication 90 * 91 * This EAPOL state machine is used for IEEE 802.11i/RSN 92 * pre-authentication 93 */ 94 int preauth; 95 96 /** 97 * cb - Function to be called when EAPOL negotiation has been completed 98 * @eapol: Pointer to EAPOL state machine data 99 * @result: Whether the authentication was completed successfully 100 * @ctx: Pointer to context data (cb_ctx) 101 * 102 * This optional callback function will be called when the EAPOL 103 * authentication has been completed. This allows the owner of the 104 * EAPOL state machine to process the key and terminate the EAPOL state 105 * machine. Currently, this is used only in RSN pre-authentication. 106 */ 107 void (*cb)(struct eapol_sm *eapol, enum eapol_supp_result result, 108 void *ctx); 109 110 /** 111 * cb_ctx - Callback context for cb() 112 */ 113 void *cb_ctx; 114 115 /** 116 * msg_ctx - Callback context for wpa_msg() calls 117 */ 118 void *msg_ctx; 119 120 /** 121 * scard_ctx - Callback context for PC/SC scard_*() function calls 122 * 123 * This context can be updated with eapol_sm_register_scard_ctx(). 124 */ 125 void *scard_ctx; 126 127 /** 128 * eapol_send_ctx - Callback context for eapol_send() calls 129 */ 130 void *eapol_send_ctx; 131 132 /** 133 * eapol_done_cb - Function to be called at successful completion 134 * @ctx: Callback context (ctx) 135 * 136 * This function is called at the successful completion of EAPOL 137 * authentication. If dynamic WEP keys are used, this is called only 138 * after all the expected keys have been received. 139 */ 140 void (*eapol_done_cb)(void *ctx); 141 142 /** 143 * eapol_send - Send EAPOL packets 144 * @ctx: Callback context (eapol_send_ctx) 145 * @type: EAPOL type (IEEE802_1X_TYPE_*) 146 * @buf: Pointer to EAPOL payload 147 * @len: Length of the EAPOL payload 148 * Returns: 0 on success, -1 on failure 149 */ 150 int (*eapol_send)(void *ctx, int type, const u8 *buf, size_t len); 151 152 /** 153 * set_wep_key - Configure WEP keys 154 * @ctx: Callback context (ctx) 155 * @unicast: Non-zero = unicast, 0 = multicast/broadcast key 156 * @keyidx: Key index (0..3) 157 * @key: WEP key 158 * @keylen: Length of the WEP key 159 * Returns: 0 on success, -1 on failure 160 */ 161 int (*set_wep_key)(void *ctx, int unicast, int keyidx, 162 const u8 *key, size_t keylen); 163 164 /** 165 * set_config_blob - Set or add a named configuration blob 166 * @ctx: Callback context (ctx) 167 * @blob: New value for the blob 168 * 169 * Adds a new configuration blob or replaces the current value of an 170 * existing blob. 171 */ 172 void (*set_config_blob)(void *ctx, struct wpa_config_blob *blob); 173 174 /** 175 * get_config_blob - Get a named configuration blob 176 * @ctx: Callback context (ctx) 177 * @name: Name of the blob 178 * Returns: Pointer to blob data or %NULL if not found 179 */ 180 const struct wpa_config_blob * (*get_config_blob)(void *ctx, 181 const char *name); 182 183 /** 184 * aborted_cached - Notify that cached PMK attempt was aborted 185 * @ctx: Callback context (ctx) 186 */ 187 void (*aborted_cached)(void *ctx); 188 189 /** 190 * opensc_engine_path - Path to the OpenSSL engine for opensc 191 * 192 * This is an OpenSSL specific configuration option for loading OpenSC 193 * engine (engine_opensc.so); if %NULL, this engine is not loaded. 194 */ 195 const char *opensc_engine_path; 196 197 /** 198 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11 199 * 200 * This is an OpenSSL specific configuration option for loading PKCS#11 201 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded. 202 */ 203 const char *pkcs11_engine_path; 204 205 /** 206 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module 207 * 208 * This is an OpenSSL specific configuration option for configuring 209 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this 210 * module is not loaded. 211 */ 212 const char *pkcs11_module_path; 213 214 /** 215 * openssl_ciphers - OpenSSL cipher string 216 * 217 * This is an OpenSSL specific configuration option for configuring the 218 * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the 219 * default. 220 */ 221 const char *openssl_ciphers; 222 223 /** 224 * wps - WPS context data 225 * 226 * This is only used by EAP-WSC and can be left %NULL if not available. 227 */ 228 struct wps_context *wps; 229 230 /** 231 * eap_param_needed - Notify that EAP parameter is needed 232 * @ctx: Callback context (ctx) 233 * @field: Field indicator (e.g., WPA_CTRL_REQ_EAP_IDENTITY) 234 * @txt: User readable text describing the required parameter 235 */ 236 void (*eap_param_needed)(void *ctx, enum wpa_ctrl_req_type field, 237 const char *txt); 238 239 /** 240 * port_cb - Set port authorized/unauthorized callback (optional) 241 * @ctx: Callback context (ctx) 242 * @authorized: Whether the supplicant port is now in authorized state 243 */ 244 void (*port_cb)(void *ctx, int authorized); 245 246 /** 247 * cert_cb - Notification of a peer certificate 248 * @ctx: Callback context (ctx) 249 * @depth: Depth in certificate chain (0 = server) 250 * @subject: Subject of the peer certificate 251 * @altsubject: Select fields from AltSubject of the peer certificate 252 * @num_altsubject: Number of altsubject values 253 * @cert_hash: SHA-256 hash of the certificate 254 * @cert: Peer certificate 255 */ 256 void (*cert_cb)(void *ctx, int depth, const char *subject, 257 const char *altsubject[], int num_altsubject, 258 const char *cert_hash, const struct wpabuf *cert); 259 260 /** 261 * cert_in_cb - Include server certificates in callback 262 */ 263 int cert_in_cb; 264 265 /** 266 * status_cb - Notification of a change in EAP status 267 * @ctx: Callback context (ctx) 268 * @status: Step in the process of EAP authentication 269 * @parameter: Step-specific parameter, e.g., EAP method name 270 */ 271 void (*status_cb)(void *ctx, const char *status, 272 const char *parameter); 273 274 /** 275 * eap_error_cb - Notification of EAP method error 276 * @ctx: Callback context (ctx) 277 * @error_code: EAP method error code 278 */ 279 void (*eap_error_cb)(void *ctx, int error_code); 280 281 #ifdef CONFIG_EAP_PROXY 282 /** 283 * eap_proxy_cb - Callback signifying any updates from eap_proxy 284 * @ctx: eapol_ctx from eap_peer_sm_init() call 285 */ 286 void (*eap_proxy_cb)(void *ctx); 287 288 /** 289 * eap_proxy_notify_sim_status - Notification of SIM status change 290 * @ctx: eapol_ctx from eap_peer_sm_init() call 291 * @status: One of enum value from sim_state 292 */ 293 void (*eap_proxy_notify_sim_status)(void *ctx, 294 enum eap_proxy_sim_state sim_state); 295 #endif /* CONFIG_EAP_PROXY */ 296 297 /** 298 * set_anon_id - Set or add anonymous identity 299 * @ctx: eapol_ctx from eap_peer_sm_init() call 300 * @id: Anonymous identity (e.g., EAP-SIM pseudonym) 301 * @len: Length of anonymous identity in octets 302 */ 303 void (*set_anon_id)(void *ctx, const u8 *id, size_t len); 304 }; 305 306 307 struct eap_peer_config; 308 struct ext_password_data; 309 310 #ifdef IEEE8021X_EAPOL 311 struct eapol_sm *eapol_sm_init(struct eapol_ctx *ctx); 312 void eapol_sm_deinit(struct eapol_sm *sm); 313 void eapol_sm_step(struct eapol_sm *sm); 314 int eapol_sm_get_status(struct eapol_sm *sm, char *buf, size_t buflen, 315 int verbose); 316 int eapol_sm_get_mib(struct eapol_sm *sm, char *buf, size_t buflen); 317 void eapol_sm_configure(struct eapol_sm *sm, int heldPeriod, int authPeriod, 318 int startPeriod, int maxStart); 319 int eapol_sm_rx_eapol(struct eapol_sm *sm, const u8 *src, const u8 *buf, 320 size_t len); 321 void eapol_sm_notify_tx_eapol_key(struct eapol_sm *sm); 322 void eapol_sm_notify_portEnabled(struct eapol_sm *sm, Boolean enabled); 323 void eapol_sm_notify_portValid(struct eapol_sm *sm, Boolean valid); 324 void eapol_sm_notify_eap_success(struct eapol_sm *sm, Boolean success); 325 void eapol_sm_notify_eap_fail(struct eapol_sm *sm, Boolean fail); 326 void eapol_sm_notify_config(struct eapol_sm *sm, 327 struct eap_peer_config *config, 328 const struct eapol_config *conf); 329 int eapol_sm_get_key(struct eapol_sm *sm, u8 *key, size_t len); 330 const u8 * eapol_sm_get_session_id(struct eapol_sm *sm, size_t *len); 331 void eapol_sm_notify_logoff(struct eapol_sm *sm, Boolean logoff); 332 void eapol_sm_notify_cached(struct eapol_sm *sm); 333 void eapol_sm_notify_pmkid_attempt(struct eapol_sm *sm); 334 void eapol_sm_register_scard_ctx(struct eapol_sm *sm, void *ctx); 335 void eapol_sm_notify_portControl(struct eapol_sm *sm, PortControl portControl); 336 void eapol_sm_notify_ctrl_attached(struct eapol_sm *sm); 337 void eapol_sm_notify_ctrl_response(struct eapol_sm *sm); 338 void eapol_sm_request_reauth(struct eapol_sm *sm); 339 void eapol_sm_notify_lower_layer_success(struct eapol_sm *sm, int in_eapol_sm); 340 void eapol_sm_invalidate_cached_session(struct eapol_sm *sm); 341 const char * eapol_sm_get_method_name(struct eapol_sm *sm); 342 void eapol_sm_set_ext_pw_ctx(struct eapol_sm *sm, 343 struct ext_password_data *ext); 344 int eapol_sm_failed(struct eapol_sm *sm); 345 void eapol_sm_erp_flush(struct eapol_sm *sm); 346 struct wpabuf * eapol_sm_build_erp_reauth_start(struct eapol_sm *sm); 347 void eapol_sm_process_erp_finish(struct eapol_sm *sm, const u8 *buf, 348 size_t len); 349 int eapol_sm_get_eap_proxy_imsi(void *ctx, int sim_num, char *imsi, 350 size_t *len); 351 int eapol_sm_update_erp_next_seq_num(struct eapol_sm *sm, u16 next_seq_num); 352 int eapol_sm_get_erp_info(struct eapol_sm *sm, struct eap_peer_config *config, 353 const u8 **username, size_t *username_len, 354 const u8 **realm, size_t *realm_len, 355 u16 *erp_next_seq_num, const u8 **rrk, 356 size_t *rrk_len); 357 358 #else /* IEEE8021X_EAPOL */ 359 static inline struct eapol_sm *eapol_sm_init(struct eapol_ctx *ctx) 360 { 361 free(ctx); 362 return (struct eapol_sm *) 1; 363 } 364 static inline void eapol_sm_deinit(struct eapol_sm *sm) 365 { 366 } 367 static inline void eapol_sm_step(struct eapol_sm *sm) 368 { 369 } 370 static inline int eapol_sm_get_status(struct eapol_sm *sm, char *buf, 371 size_t buflen, int verbose) 372 { 373 return 0; 374 } 375 static inline int eapol_sm_get_mib(struct eapol_sm *sm, char *buf, 376 size_t buflen) 377 { 378 return 0; 379 } 380 static inline void eapol_sm_configure(struct eapol_sm *sm, int heldPeriod, 381 int authPeriod, int startPeriod, 382 int maxStart) 383 { 384 } 385 static inline int eapol_sm_rx_eapol(struct eapol_sm *sm, const u8 *src, 386 const u8 *buf, size_t len) 387 { 388 return 0; 389 } 390 static inline void eapol_sm_notify_tx_eapol_key(struct eapol_sm *sm) 391 { 392 } 393 static inline void eapol_sm_notify_portEnabled(struct eapol_sm *sm, 394 Boolean enabled) 395 { 396 } 397 static inline void eapol_sm_notify_portValid(struct eapol_sm *sm, 398 Boolean valid) 399 { 400 } 401 static inline void eapol_sm_notify_eap_success(struct eapol_sm *sm, 402 Boolean success) 403 { 404 } 405 static inline void eapol_sm_notify_eap_fail(struct eapol_sm *sm, Boolean fail) 406 { 407 } 408 static inline void eapol_sm_notify_config(struct eapol_sm *sm, 409 struct eap_peer_config *config, 410 struct eapol_config *conf) 411 { 412 } 413 static inline int eapol_sm_get_key(struct eapol_sm *sm, u8 *key, size_t len) 414 { 415 return -1; 416 } 417 static inline const u8 * 418 eapol_sm_get_session_id(struct eapol_sm *sm, size_t *len) 419 { 420 return NULL; 421 } 422 static inline void eapol_sm_notify_logoff(struct eapol_sm *sm, Boolean logoff) 423 { 424 } 425 static inline void eapol_sm_notify_cached(struct eapol_sm *sm) 426 { 427 } 428 static inline void eapol_sm_notify_pmkid_attempt(struct eapol_sm *sm) 429 { 430 } 431 #define eapol_sm_register_scard_ctx(sm, ctx) do { } while (0) 432 static inline void eapol_sm_notify_portControl(struct eapol_sm *sm, 433 PortControl portControl) 434 { 435 } 436 static inline void eapol_sm_notify_ctrl_attached(struct eapol_sm *sm) 437 { 438 } 439 static inline void eapol_sm_notify_ctrl_response(struct eapol_sm *sm) 440 { 441 } 442 static inline void eapol_sm_request_reauth(struct eapol_sm *sm) 443 { 444 } 445 static inline void eapol_sm_notify_lower_layer_success(struct eapol_sm *sm, 446 int in_eapol_sm) 447 { 448 } 449 static inline void eapol_sm_invalidate_cached_session(struct eapol_sm *sm) 450 { 451 } 452 static inline const char * eapol_sm_get_method_name(struct eapol_sm *sm) 453 { 454 return NULL; 455 } 456 static inline void eapol_sm_set_ext_pw_ctx(struct eapol_sm *sm, 457 struct ext_password_data *ext) 458 { 459 } 460 static inline int eapol_sm_failed(struct eapol_sm *sm) 461 { 462 return 0; 463 } 464 static inline void eapol_sm_erp_flush(struct eapol_sm *sm) 465 { 466 } 467 static inline struct wpabuf * 468 eapol_sm_build_erp_reauth_start(struct eapol_sm *sm) 469 { 470 return NULL; 471 } 472 static inline void eapol_sm_process_erp_finish(struct eapol_sm *sm, 473 const u8 *buf, size_t len) 474 { 475 } 476 static inline int eapol_sm_update_erp_next_seq_num(struct eapol_sm *sm, 477 u16 next_seq_num) 478 { 479 return -1; 480 } 481 static inline int 482 eapol_sm_get_erp_info(struct eapol_sm *sm, struct eap_peer_config *config, 483 const u8 **username, size_t *username_len, 484 const u8 **realm, size_t *realm_len, 485 u16 *erp_next_seq_num, const u8 **rrk, size_t *rrk_len) 486 { 487 return -1; 488 } 489 #endif /* IEEE8021X_EAPOL */ 490 491 #endif /* EAPOL_SUPP_SM_H */ 492
