18d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/* 28d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAP peer state machine functions (RFC 4137) 34530cfd4d14a77c58e35393b91e40f8dd9d62697Dmitry Shmidt * Copyright (c) 2004-2012, Jouni Malinen <j@w1.fi> 48d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 5c5ec7f57ead87efa365800228aa0b09a12d9e6c4Dmitry Shmidt * This software may be distributed under the terms of the BSD license. 6c5ec7f57ead87efa365800228aa0b09a12d9e6c4Dmitry Shmidt * See README for more details. 78d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 88d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 98d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#ifndef EAP_H 108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#define EAP_H 118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#include "common/defs.h" 138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#include "eap_common/eap_defs.h" 148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#include "eap_peer/eap_methods.h" 158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct eap_sm; 178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct wpa_config_blob; 188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct wpabuf; 198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct eap_method_type { 218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int vendor; 228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt u32 method; 238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#ifdef IEEE8021X_EAPOL 268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * enum eapol_bool_var - EAPOL boolean state variables for EAP state machine 298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * These variables are used in the interface between EAP peer state machine and 318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * lower layer. These are defined in RFC 4137, Sect. 4.1. Lower layer code is 328d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * expected to maintain these variables and register a callback functions for 338d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAP state machine to get and set the variables. 348d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtenum eapol_bool_var { 368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 378d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAPOL_eapSuccess - EAP SUCCESS state reached 388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAP state machine reads and writes this value. 408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt EAPOL_eapSuccess, 428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAPOL_eapRestart - Lower layer request to restart authentication 458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 468d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Set to TRUE in lower layer, FALSE in EAP state machine. 478d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 488d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt EAPOL_eapRestart, 498d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 508d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 518d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAPOL_eapFail - EAP FAILURE state reached 528d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 538d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAP state machine writes this value. 548d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 558d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt EAPOL_eapFail, 568d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 578d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 588d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAPOL_eapResp - Response to send 598d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 608d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Set to TRUE in EAP state machine, FALSE in lower layer. 618d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 628d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt EAPOL_eapResp, 638d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 648d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 658d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAPOL_eapNoResp - Request has been process; no response to send 668d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 678d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Set to TRUE in EAP state machine, FALSE in lower layer. 688d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 698d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt EAPOL_eapNoResp, 708d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 718d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 728d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAPOL_eapReq - EAP request available from lower layer 738d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 748d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Set to TRUE in lower layer, FALSE in EAP state machine. 758d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 768d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt EAPOL_eapReq, 778d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 788d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 798d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAPOL_portEnabled - Lower layer is ready for communication 808d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 818d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAP state machines reads this value. 828d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 838d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt EAPOL_portEnabled, 848d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 858d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 868d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAPOL_altAccept - Alternate indication of success (RFC3748) 878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 888d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAP state machines reads this value. 898d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 908d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt EAPOL_altAccept, 918d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 928d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 938d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAPOL_altReject - Alternate indication of failure (RFC3748) 948d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 958d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAP state machines reads this value. 968d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 976c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt EAPOL_altReject, 986c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt 996c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt /** 1006c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt * EAPOL_eapTriggerStart - EAP-based trigger to send EAPOL-Start 1016c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt * 1026c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt * EAP state machine writes this value. 1036c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt */ 1046c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt EAPOL_eapTriggerStart 1058d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 1068d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1078d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 1088d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * enum eapol_int_var - EAPOL integer state variables for EAP state machine 1098d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * These variables are used in the interface between EAP peer state machine and 1118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * lower layer. These are defined in RFC 4137, Sect. 4.1. Lower layer code is 1128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * expected to maintain these variables and register a callback functions for 1138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAP state machine to get and set the variables. 1148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtenum eapol_int_var { 1168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 1178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAPOL_idleWhile - Outside time for EAP peer timeout 1188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This integer variable is used to provide an outside timer that the 1208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * external (to EAP state machine) code must decrement by one every 1218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * second until the value reaches zero. This is used in the same way as 1228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * EAPOL state machine timers. EAP state machine reads and writes this 1238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * value. 1248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1258d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt EAPOL_idleWhile 1268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 1278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 1298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * struct eapol_callbacks - Callback functions from EAP to lower layer 1308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This structure defines the callback functions that EAP state machine 1328d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * requires from the lower layer (usually EAPOL state machine) for updating 1338d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * state variables and requesting information. eapol_ctx from 1348d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * eap_peer_sm_init() call will be used as the ctx parameter for these 1358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * callback functions. 1368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1378d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct eapol_callbacks { 1388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 1398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * get_config - Get pointer to the current network configuration 1408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctx: eapol_ctx from eap_peer_sm_init() call 1418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct eap_peer_config * (*get_config)(void *ctx); 1438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 1458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * get_bool - Get a boolean EAPOL state variable 1468d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @variable: EAPOL boolean variable to get 1478d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Value of the EAPOL variable 1488d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1498d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt Boolean (*get_bool)(void *ctx, enum eapol_bool_var variable); 1508d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1518d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 1528d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * set_bool - Set a boolean EAPOL state variable 1538d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctx: eapol_ctx from eap_peer_sm_init() call 1548d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @variable: EAPOL boolean variable to set 1558d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @value: Value for the EAPOL variable 1568d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1578d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt void (*set_bool)(void *ctx, enum eapol_bool_var variable, 1588d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt Boolean value); 1598d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1608d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 1618d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * get_int - Get an integer EAPOL state variable 1628d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctx: eapol_ctx from eap_peer_sm_init() call 1638d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @variable: EAPOL integer variable to get 1648d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Value of the EAPOL variable 1658d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1668d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt unsigned int (*get_int)(void *ctx, enum eapol_int_var variable); 1678d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1688d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 1698d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * set_int - Set an integer EAPOL state variable 1708d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctx: eapol_ctx from eap_peer_sm_init() call 1718d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @variable: EAPOL integer variable to set 1728d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @value: Value for the EAPOL variable 1738d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1748d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt void (*set_int)(void *ctx, enum eapol_int_var variable, 1758d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt unsigned int value); 1768d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1778d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 1788d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * get_eapReqData - Get EAP-Request data 1798d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctx: eapol_ctx from eap_peer_sm_init() call 1808d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @len: Pointer to variable that will be set to eapReqDataLen 1818d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Reference to eapReqData (EAP state machine will not free 1828d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * this) or %NULL if eapReqData not available. 1838d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1848d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct wpabuf * (*get_eapReqData)(void *ctx); 1858d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1868d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 1878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * set_config_blob - Set named configuration blob 1888d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctx: eapol_ctx from eap_peer_sm_init() call 1898d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @blob: New value for the blob 1908d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 1918d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Adds a new configuration blob or replaces the current value of an 1928d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * existing blob. 1938d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 1948d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt void (*set_config_blob)(void *ctx, struct wpa_config_blob *blob); 1958d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 1968d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 1978d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * get_config_blob - Get a named configuration blob 1988d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctx: eapol_ctx from eap_peer_sm_init() call 1998d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @name: Name of the blob 2008d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Returns: Pointer to blob data or %NULL if not found 2018d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2028d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const struct wpa_config_blob * (*get_config_blob)(void *ctx, 2038d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *name); 2048d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2058d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 2068d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * notify_pending - Notify that a pending request can be retried 2078d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctx: eapol_ctx from eap_peer_sm_init() call 2088d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 2098d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * An EAP method can perform a pending operation (e.g., to get a 2108d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * response from an external process). Once the response is available, 2118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * this callback function can be used to request EAPOL state machine to 2128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * retry delivering the previously received (and still unanswered) EAP 2138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * request to EAP state machine. 2148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt void (*notify_pending)(void *ctx); 2168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 2188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * eap_param_needed - Notify that EAP parameter is needed 2198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @ctx: eapol_ctx from eap_peer_sm_init() call 2201f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt * @field: Field indicator (e.g., WPA_CTRL_REQ_EAP_IDENTITY) 2218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * @txt: User readable text describing the required parameter 2228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2231f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt void (*eap_param_needed)(void *ctx, enum wpa_ctrl_req_type field, 2248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *txt); 225c55524ad84d13014e8019491c2b17e5dcf13545aDmitry Shmidt 226c55524ad84d13014e8019491c2b17e5dcf13545aDmitry Shmidt /** 227c55524ad84d13014e8019491c2b17e5dcf13545aDmitry Shmidt * notify_cert - Notification of a peer certificate 228c55524ad84d13014e8019491c2b17e5dcf13545aDmitry Shmidt * @ctx: eapol_ctx from eap_peer_sm_init() call 229c55524ad84d13014e8019491c2b17e5dcf13545aDmitry Shmidt * @depth: Depth in certificate chain (0 = server) 230c55524ad84d13014e8019491c2b17e5dcf13545aDmitry Shmidt * @subject: Subject of the peer certificate 2312f74e36e84064ffa32f82f3decf36b653c7e4fadDmitry Shmidt * @altsubject: Select fields from AltSubject of the peer certificate 2322f74e36e84064ffa32f82f3decf36b653c7e4fadDmitry Shmidt * @num_altsubject: Number of altsubject values 233c55524ad84d13014e8019491c2b17e5dcf13545aDmitry Shmidt * @cert_hash: SHA-256 hash of the certificate 234c55524ad84d13014e8019491c2b17e5dcf13545aDmitry Shmidt * @cert: Peer certificate 235c55524ad84d13014e8019491c2b17e5dcf13545aDmitry Shmidt */ 236c55524ad84d13014e8019491c2b17e5dcf13545aDmitry Shmidt void (*notify_cert)(void *ctx, int depth, const char *subject, 2372f74e36e84064ffa32f82f3decf36b653c7e4fadDmitry Shmidt const char *altsubject[], int num_altsubject, 238c55524ad84d13014e8019491c2b17e5dcf13545aDmitry Shmidt const char *cert_hash, const struct wpabuf *cert); 23904949598a23f501be6eec21697465fd46a28840aDmitry Shmidt 24004949598a23f501be6eec21697465fd46a28840aDmitry Shmidt /** 24104949598a23f501be6eec21697465fd46a28840aDmitry Shmidt * notify_status - Notification of the current EAP state 24204949598a23f501be6eec21697465fd46a28840aDmitry Shmidt * @ctx: eapol_ctx from eap_peer_sm_init() call 24304949598a23f501be6eec21697465fd46a28840aDmitry Shmidt * @status: Step in the process of EAP authentication 24404949598a23f501be6eec21697465fd46a28840aDmitry Shmidt * @parameter: Step-specific parameter, e.g., EAP method name 24504949598a23f501be6eec21697465fd46a28840aDmitry Shmidt */ 24604949598a23f501be6eec21697465fd46a28840aDmitry Shmidt void (*notify_status)(void *ctx, const char *status, 24704949598a23f501be6eec21697465fd46a28840aDmitry Shmidt const char *parameter); 2484530cfd4d14a77c58e35393b91e40f8dd9d62697Dmitry Shmidt 249203eadb9eda41a1dde4a583edb4684319e3f399eDmitry Shmidt#ifdef CONFIG_EAP_PROXY 250203eadb9eda41a1dde4a583edb4684319e3f399eDmitry Shmidt /** 251203eadb9eda41a1dde4a583edb4684319e3f399eDmitry Shmidt * eap_proxy_cb - Callback signifying any updates from eap_proxy 252203eadb9eda41a1dde4a583edb4684319e3f399eDmitry Shmidt * @ctx: eapol_ctx from eap_peer_sm_init() call 253203eadb9eda41a1dde4a583edb4684319e3f399eDmitry Shmidt */ 254203eadb9eda41a1dde4a583edb4684319e3f399eDmitry Shmidt void (*eap_proxy_cb)(void *ctx); 255203eadb9eda41a1dde4a583edb4684319e3f399eDmitry Shmidt#endif /* CONFIG_EAP_PROXY */ 256203eadb9eda41a1dde4a583edb4684319e3f399eDmitry Shmidt 2574530cfd4d14a77c58e35393b91e40f8dd9d62697Dmitry Shmidt /** 2584530cfd4d14a77c58e35393b91e40f8dd9d62697Dmitry Shmidt * set_anon_id - Set or add anonymous identity 2594530cfd4d14a77c58e35393b91e40f8dd9d62697Dmitry Shmidt * @ctx: eapol_ctx from eap_peer_sm_init() call 2604530cfd4d14a77c58e35393b91e40f8dd9d62697Dmitry Shmidt * @id: Anonymous identity (e.g., EAP-SIM pseudonym) or %NULL to clear 2614530cfd4d14a77c58e35393b91e40f8dd9d62697Dmitry Shmidt * @len: Length of anonymous identity in octets 2624530cfd4d14a77c58e35393b91e40f8dd9d62697Dmitry Shmidt */ 2634530cfd4d14a77c58e35393b91e40f8dd9d62697Dmitry Shmidt void (*set_anon_id)(void *ctx, const u8 *id, size_t len); 2648d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 2658d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 2668d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt/** 2678d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * struct eap_config - Configuration for EAP state machine 2688d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2698d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct eap_config { 2708d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 2718d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * opensc_engine_path - OpenSC engine for OpenSSL engine support 2728d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 2738d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Usually, path to engine_opensc.so. 2748d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2758d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *opensc_engine_path; 2768d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 2778d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * pkcs11_engine_path - PKCS#11 engine for OpenSSL engine support 2788d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 2798d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Usually, path to engine_pkcs11.so. 2808d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2818d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *pkcs11_engine_path; 2828d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 2838d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * pkcs11_module_path - OpenSC PKCS#11 module for OpenSSL engine 2848d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 2858d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * Usually, path to opensc-pkcs11.so. 2868d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 2878d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt const char *pkcs11_module_path; 2888d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt /** 2896c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt * openssl_ciphers - OpenSSL cipher string 2906c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt * 2916c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt * This is an OpenSSL specific configuration option for configuring the 2926c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the 2936c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt * default. 2946c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt */ 2956c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt const char *openssl_ciphers; 2966c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidt /** 2978d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * wps - WPS context data 2988d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * 2998d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt * This is only used by EAP-WSC and can be left %NULL if not available. 3008d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt */ 3018d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt struct wps_context *wps; 3021f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt 3031f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt /** 3041f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt * cert_in_cb - Include server certificates in callback 3051f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt */ 3061f69aa52ea2e0a73ac502565df8c666ee49cab6aDmitry Shmidt int cert_in_cb; 3078d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt}; 3088d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 3098d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct eap_sm * eap_peer_sm_init(void *eapol_ctx, 3101d755d025b206e22b06aeb322e25a79f98ca7777Dmitry Shmidt const struct eapol_callbacks *eapol_cb, 3118d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt void *msg_ctx, struct eap_config *conf); 3128d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_peer_sm_deinit(struct eap_sm *sm); 3138d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint eap_peer_sm_step(struct eap_sm *sm); 3148d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_sm_abort(struct eap_sm *sm); 3158d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint eap_sm_get_status(struct eap_sm *sm, char *buf, size_t buflen, 3168d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt int verbose); 3178d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtconst char * eap_sm_get_method_name(struct eap_sm *sm); 3188d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct wpabuf * eap_sm_buildIdentity(struct eap_sm *sm, int id, int encrypted); 3198d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_sm_request_identity(struct eap_sm *sm); 3208d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_sm_request_password(struct eap_sm *sm); 3218d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_sm_request_new_password(struct eap_sm *sm); 3228d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_sm_request_pin(struct eap_sm *sm); 3238d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_sm_request_otp(struct eap_sm *sm, const char *msg, size_t msg_len); 3248d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_sm_request_passphrase(struct eap_sm *sm); 325051af73b8f8014eff33330aead0f36944b3403e6Dmitry Shmidtvoid eap_sm_request_sim(struct eap_sm *sm, const char *req); 3268d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_sm_notify_ctrl_attached(struct eap_sm *sm); 3278d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtu32 eap_get_phase2_type(const char *name, int *vendor); 3288d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct eap_method_type * eap_get_phase2_types(struct eap_peer_config *config, 3298d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt size_t *count); 3308d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_set_fast_reauth(struct eap_sm *sm, int enabled); 3318d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_set_workaround(struct eap_sm *sm, unsigned int workaround); 3328d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_set_force_disabled(struct eap_sm *sm, int disabled); 333051af73b8f8014eff33330aead0f36944b3403e6Dmitry Shmidtvoid eap_set_external_sim(struct eap_sm *sm, int external_sim); 3348d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint eap_key_available(struct eap_sm *sm); 3358d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_notify_success(struct eap_sm *sm); 3368d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_notify_lower_layer_success(struct eap_sm *sm); 337f86232838cf712377867cb42417c1613ab5dc425Dmitry Shmidtconst u8 * eap_get_eapSessionId(struct eap_sm *sm, size_t *len); 3388d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtconst u8 * eap_get_eapKeyData(struct eap_sm *sm, size_t *len); 3398d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtstruct wpabuf * eap_get_eapRespData(struct eap_sm *sm); 3408d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_register_scard_ctx(struct eap_sm *sm, void *ctx); 3418d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtvoid eap_invalidate_cached_session(struct eap_sm *sm); 3428d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 3438d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint eap_is_wps_pbc_enrollee(struct eap_peer_config *conf); 3448d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidtint eap_is_wps_pin_enrollee(struct eap_peer_config *conf); 3458d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 34661d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidtstruct ext_password_data; 34761d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidtvoid eap_sm_set_ext_pw_ctx(struct eap_sm *sm, struct ext_password_data *ext); 3484530cfd4d14a77c58e35393b91e40f8dd9d62697Dmitry Shmidtvoid eap_set_anon_id(struct eap_sm *sm, const u8 *id, size_t len); 349344abd362cfe2d03ed956666527352826b67bde5Dmitry Shmidtint eap_peer_was_failure_expected(struct eap_sm *sm); 3506c0da2bb83f6915d8260912362692d1a742e057bDmitry Shmidtvoid eap_peer_erp_free_keys(struct eap_sm *sm); 35161d9df3e62aaa0e87ad05452fcb95142159a17b6Dmitry Shmidt 3528d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#endif /* IEEE8021X_EAPOL */ 3538d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt 3548d520ff1dc2da35cdca849e982051b86468016d8Dmitry Shmidt#endif /* EAP_H */ 355