1214501Srpaulo/* 2214501Srpaulo * IEEE 802.1X-2004 Authenticator - EAPOL state machine (internal definitions) 3214501Srpaulo * Copyright (c) 2002-2009, Jouni Malinen <j@w1.fi> 4214501Srpaulo * 5252726Srpaulo * This software may be distributed under the terms of the BSD license. 6252726Srpaulo * See README for more details. 7214501Srpaulo */ 8214501Srpaulo 9214501Srpaulo#ifndef EAPOL_AUTH_SM_I_H 10214501Srpaulo#define EAPOL_AUTH_SM_I_H 11214501Srpaulo 12214501Srpaulo#include "common/defs.h" 13214501Srpaulo#include "radius/radius.h" 14214501Srpaulo 15214501Srpaulo/* IEEE Std 802.1X-2004, Ch. 8.2 */ 16214501Srpaulo 17214501Srpaulotypedef enum { ForceUnauthorized = 1, ForceAuthorized = 3, Auto = 2 } 18214501Srpaulo PortTypes; 19214501Srpaulotypedef enum { Unauthorized = 2, Authorized = 1 } PortState; 20214501Srpaulotypedef enum { Both = 0, In = 1 } ControlledDirection; 21214501Srpaulotypedef unsigned int Counter; 22214501Srpaulo 23214501Srpaulo 24214501Srpaulo/** 25214501Srpaulo * struct eapol_authenticator - Global EAPOL authenticator data 26214501Srpaulo */ 27214501Srpaulostruct eapol_authenticator { 28214501Srpaulo struct eapol_auth_config conf; 29214501Srpaulo struct eapol_auth_cb cb; 30214501Srpaulo 31214501Srpaulo u8 *default_wep_key; 32214501Srpaulo u8 default_wep_key_idx; 33214501Srpaulo}; 34214501Srpaulo 35214501Srpaulo 36214501Srpaulo/** 37214501Srpaulo * struct eapol_state_machine - Per-Supplicant Authenticator state machines 38214501Srpaulo */ 39214501Srpaulostruct eapol_state_machine { 40214501Srpaulo /* timers */ 41214501Srpaulo int aWhile; 42214501Srpaulo int quietWhile; 43214501Srpaulo int reAuthWhen; 44214501Srpaulo 45214501Srpaulo /* global variables */ 46214501Srpaulo Boolean authAbort; 47214501Srpaulo Boolean authFail; 48214501Srpaulo PortState authPortStatus; 49214501Srpaulo Boolean authStart; 50214501Srpaulo Boolean authTimeout; 51214501Srpaulo Boolean authSuccess; 52214501Srpaulo Boolean eapolEap; 53214501Srpaulo Boolean initialize; 54214501Srpaulo Boolean keyDone; 55214501Srpaulo Boolean keyRun; 56214501Srpaulo Boolean keyTxEnabled; 57214501Srpaulo PortTypes portControl; 58214501Srpaulo Boolean portValid; 59214501Srpaulo Boolean reAuthenticate; 60214501Srpaulo 61214501Srpaulo /* Port Timers state machine */ 62214501Srpaulo /* 'Boolean tick' implicitly handled as registered timeout */ 63214501Srpaulo 64214501Srpaulo /* Authenticator PAE state machine */ 65214501Srpaulo enum { AUTH_PAE_INITIALIZE, AUTH_PAE_DISCONNECTED, AUTH_PAE_CONNECTING, 66214501Srpaulo AUTH_PAE_AUTHENTICATING, AUTH_PAE_AUTHENTICATED, 67214501Srpaulo AUTH_PAE_ABORTING, AUTH_PAE_HELD, AUTH_PAE_FORCE_AUTH, 68214501Srpaulo AUTH_PAE_FORCE_UNAUTH, AUTH_PAE_RESTART } auth_pae_state; 69214501Srpaulo /* variables */ 70214501Srpaulo Boolean eapolLogoff; 71214501Srpaulo Boolean eapolStart; 72214501Srpaulo PortTypes portMode; 73214501Srpaulo unsigned int reAuthCount; 74214501Srpaulo /* constants */ 75214501Srpaulo unsigned int quietPeriod; /* default 60; 0..65535 */ 76214501Srpaulo#define AUTH_PAE_DEFAULT_quietPeriod 60 77214501Srpaulo unsigned int reAuthMax; /* default 2 */ 78214501Srpaulo#define AUTH_PAE_DEFAULT_reAuthMax 2 79214501Srpaulo /* counters */ 80214501Srpaulo Counter authEntersConnecting; 81214501Srpaulo Counter authEapLogoffsWhileConnecting; 82214501Srpaulo Counter authEntersAuthenticating; 83214501Srpaulo Counter authAuthSuccessesWhileAuthenticating; 84214501Srpaulo Counter authAuthTimeoutsWhileAuthenticating; 85214501Srpaulo Counter authAuthFailWhileAuthenticating; 86214501Srpaulo Counter authAuthEapStartsWhileAuthenticating; 87214501Srpaulo Counter authAuthEapLogoffWhileAuthenticating; 88214501Srpaulo Counter authAuthReauthsWhileAuthenticated; 89214501Srpaulo Counter authAuthEapStartsWhileAuthenticated; 90214501Srpaulo Counter authAuthEapLogoffWhileAuthenticated; 91214501Srpaulo 92214501Srpaulo /* Backend Authentication state machine */ 93214501Srpaulo enum { BE_AUTH_REQUEST, BE_AUTH_RESPONSE, BE_AUTH_SUCCESS, 94214501Srpaulo BE_AUTH_FAIL, BE_AUTH_TIMEOUT, BE_AUTH_IDLE, BE_AUTH_INITIALIZE, 95214501Srpaulo BE_AUTH_IGNORE 96214501Srpaulo } be_auth_state; 97214501Srpaulo /* constants */ 98214501Srpaulo unsigned int serverTimeout; /* default 30; 1..X */ 99214501Srpaulo#define BE_AUTH_DEFAULT_serverTimeout 30 100214501Srpaulo /* counters */ 101214501Srpaulo Counter backendResponses; 102214501Srpaulo Counter backendAccessChallenges; 103214501Srpaulo Counter backendOtherRequestsToSupplicant; 104214501Srpaulo Counter backendAuthSuccesses; 105214501Srpaulo Counter backendAuthFails; 106214501Srpaulo 107214501Srpaulo /* Reauthentication Timer state machine */ 108214501Srpaulo enum { REAUTH_TIMER_INITIALIZE, REAUTH_TIMER_REAUTHENTICATE 109214501Srpaulo } reauth_timer_state; 110214501Srpaulo /* constants */ 111214501Srpaulo unsigned int reAuthPeriod; /* default 3600 s */ 112214501Srpaulo Boolean reAuthEnabled; 113214501Srpaulo 114214501Srpaulo /* Authenticator Key Transmit state machine */ 115214501Srpaulo enum { AUTH_KEY_TX_NO_KEY_TRANSMIT, AUTH_KEY_TX_KEY_TRANSMIT 116214501Srpaulo } auth_key_tx_state; 117214501Srpaulo 118214501Srpaulo /* Key Receive state machine */ 119214501Srpaulo enum { KEY_RX_NO_KEY_RECEIVE, KEY_RX_KEY_RECEIVE } key_rx_state; 120214501Srpaulo /* variables */ 121214501Srpaulo Boolean rxKey; 122214501Srpaulo 123214501Srpaulo /* Controlled Directions state machine */ 124214501Srpaulo enum { CTRL_DIR_FORCE_BOTH, CTRL_DIR_IN_OR_BOTH } ctrl_dir_state; 125214501Srpaulo /* variables */ 126214501Srpaulo ControlledDirection adminControlledDirections; 127214501Srpaulo ControlledDirection operControlledDirections; 128214501Srpaulo Boolean operEdge; 129214501Srpaulo 130214501Srpaulo /* Authenticator Statistics Table */ 131214501Srpaulo Counter dot1xAuthEapolFramesRx; 132214501Srpaulo Counter dot1xAuthEapolFramesTx; 133214501Srpaulo Counter dot1xAuthEapolStartFramesRx; 134214501Srpaulo Counter dot1xAuthEapolLogoffFramesRx; 135214501Srpaulo Counter dot1xAuthEapolRespIdFramesRx; 136214501Srpaulo Counter dot1xAuthEapolRespFramesRx; 137214501Srpaulo Counter dot1xAuthEapolReqIdFramesTx; 138214501Srpaulo Counter dot1xAuthEapolReqFramesTx; 139214501Srpaulo Counter dot1xAuthInvalidEapolFramesRx; 140214501Srpaulo Counter dot1xAuthEapLengthErrorFramesRx; 141214501Srpaulo Counter dot1xAuthLastEapolFrameVersion; 142214501Srpaulo 143214501Srpaulo /* Other variables - not defined in IEEE 802.1X */ 144214501Srpaulo u8 addr[ETH_ALEN]; /* Supplicant address */ 145214501Srpaulo int flags; /* EAPOL_SM_* */ 146214501Srpaulo 147214501Srpaulo /* EAPOL/AAA <-> EAP full authenticator interface */ 148214501Srpaulo struct eap_eapol_interface *eap_if; 149214501Srpaulo 150214501Srpaulo int radius_identifier; 151214501Srpaulo /* TODO: check when the last messages can be released */ 152214501Srpaulo struct radius_msg *last_recv_radius; 153214501Srpaulo u8 last_eap_id; /* last used EAP Identifier */ 154214501Srpaulo u8 *identity; 155214501Srpaulo size_t identity_len; 156214501Srpaulo u8 eap_type_authsrv; /* EAP type of the last EAP packet from 157214501Srpaulo * Authentication server */ 158214501Srpaulo u8 eap_type_supp; /* EAP type of the last EAP packet from Supplicant */ 159214501Srpaulo struct radius_class_data radius_class; 160252726Srpaulo struct wpabuf *radius_cui; /* Chargeable-User-Identity */ 161214501Srpaulo 162214501Srpaulo struct eap_sm *eap; 163214501Srpaulo 164214501Srpaulo Boolean initializing; /* in process of initializing state machines */ 165214501Srpaulo Boolean changed; 166214501Srpaulo 167214501Srpaulo struct eapol_authenticator *eapol; 168214501Srpaulo 169214501Srpaulo void *sta; /* station context pointer to use in callbacks */ 170281806Srpaulo 171281806Srpaulo int remediation; 172281806Srpaulo 173337817Scy u64 acct_multi_session_id; 174214501Srpaulo}; 175214501Srpaulo 176214501Srpaulo#endif /* EAPOL_AUTH_SM_I_H */ 177