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