2 * hostapd / IEEE 802.1X-2004 Authenticator - EAPOL state machine
3 * Copyright (c) 2002-2007, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
20 /* IEEE Std 802.1X-2004, Ch. 8.2 */
22 typedef enum { ForceUnauthorized = 1, ForceAuthorized = 3, Auto = 2 }
24 typedef enum { Unauthorized = 2, Authorized = 1 } PortState;
25 typedef enum { Both = 0, In = 1 } ControlledDirection;
26 typedef unsigned int Counter;
30 struct radius_attr_data {
35 struct radius_class_data {
36 struct radius_attr_data *attr;
41 struct eapol_auth_config {
42 int eap_reauth_period;
44 int individual_wep_key_len;
47 void *eap_sim_db_priv;
48 char *eap_req_id_text; /* a copy of this will be allocated */
49 size_t eap_req_id_text_len;
50 u8 *pac_opaque_encr_key;
52 size_t eap_fast_a_id_len;
53 char *eap_fast_a_id_info;
56 int pac_key_refresh_time;
57 int eap_sim_aka_result_ind;
61 * Pointer to hostapd data. This is a temporary workaround for
62 * transition phase and will be removed once IEEE 802.1X/EAPOL code is
63 * separated more cleanly from rest of hostapd.
65 struct hostapd_data *hapd;
71 EAPOL_LOGGER_DEBUG, EAPOL_LOGGER_INFO, EAPOL_LOGGER_WARNING
74 struct eapol_auth_cb {
75 void (*eapol_send)(void *ctx, void *sta_ctx, u8 type, const u8 *data,
77 void (*aaa_send)(void *ctx, void *sta_ctx, const u8 *data,
79 void (*finished)(void *ctx, void *sta_ctx, int success, int preauth);
80 int (*get_eap_user)(void *ctx, const u8 *identity, size_t identity_len,
81 int phase2, struct eap_user *user);
82 int (*sta_entry_alive)(void *ctx, const u8 *addr);
83 void (*logger)(void *ctx, const u8 *addr, eapol_logger_level level,
85 void (*set_port_authorized)(void *ctx, void *sta_ctx, int authorized);
86 void (*abort_auth)(void *ctx, void *sta_ctx);
87 void (*tx_key)(void *ctx, void *sta_ctx);
91 * struct eapol_authenticator - Global EAPOL authenticator data
93 struct eapol_authenticator {
94 struct eapol_auth_config conf;
95 struct eapol_auth_cb cb;
100 * struct eapol_state_machine - Per-Supplicant Authenticator state machines
102 struct eapol_state_machine {
108 /* global variables */
111 PortState authPortStatus;
119 Boolean keyTxEnabled;
120 PortTypes portControl;
122 Boolean reAuthenticate;
124 /* Port Timers state machine */
125 /* 'Boolean tick' implicitly handled as registered timeout */
127 /* Authenticator PAE state machine */
128 enum { AUTH_PAE_INITIALIZE, AUTH_PAE_DISCONNECTED, AUTH_PAE_CONNECTING,
129 AUTH_PAE_AUTHENTICATING, AUTH_PAE_AUTHENTICATED,
130 AUTH_PAE_ABORTING, AUTH_PAE_HELD, AUTH_PAE_FORCE_AUTH,
131 AUTH_PAE_FORCE_UNAUTH, AUTH_PAE_RESTART } auth_pae_state;
136 unsigned int reAuthCount;
138 unsigned int quietPeriod; /* default 60; 0..65535 */
139 #define AUTH_PAE_DEFAULT_quietPeriod 60
140 unsigned int reAuthMax; /* default 2 */
141 #define AUTH_PAE_DEFAULT_reAuthMax 2
143 Counter authEntersConnecting;
144 Counter authEapLogoffsWhileConnecting;
145 Counter authEntersAuthenticating;
146 Counter authAuthSuccessesWhileAuthenticating;
147 Counter authAuthTimeoutsWhileAuthenticating;
148 Counter authAuthFailWhileAuthenticating;
149 Counter authAuthEapStartsWhileAuthenticating;
150 Counter authAuthEapLogoffWhileAuthenticating;
151 Counter authAuthReauthsWhileAuthenticated;
152 Counter authAuthEapStartsWhileAuthenticated;
153 Counter authAuthEapLogoffWhileAuthenticated;
155 /* Backend Authentication state machine */
156 enum { BE_AUTH_REQUEST, BE_AUTH_RESPONSE, BE_AUTH_SUCCESS,
157 BE_AUTH_FAIL, BE_AUTH_TIMEOUT, BE_AUTH_IDLE, BE_AUTH_INITIALIZE,
161 unsigned int serverTimeout; /* default 30; 1..X */
162 #define BE_AUTH_DEFAULT_serverTimeout 30
164 Counter backendResponses;
165 Counter backendAccessChallenges;
166 Counter backendOtherRequestsToSupplicant;
167 Counter backendAuthSuccesses;
168 Counter backendAuthFails;
170 /* Reauthentication Timer state machine */
171 enum { REAUTH_TIMER_INITIALIZE, REAUTH_TIMER_REAUTHENTICATE
172 } reauth_timer_state;
174 unsigned int reAuthPeriod; /* default 3600 s */
175 Boolean reAuthEnabled;
177 /* Authenticator Key Transmit state machine */
178 enum { AUTH_KEY_TX_NO_KEY_TRANSMIT, AUTH_KEY_TX_KEY_TRANSMIT
181 /* Key Receive state machine */
182 enum { KEY_RX_NO_KEY_RECEIVE, KEY_RX_KEY_RECEIVE } key_rx_state;
186 /* Controlled Directions state machine */
187 enum { CTRL_DIR_FORCE_BOTH, CTRL_DIR_IN_OR_BOTH } ctrl_dir_state;
189 ControlledDirection adminControlledDirections;
190 ControlledDirection operControlledDirections;
193 /* Authenticator Statistics Table */
194 Counter dot1xAuthEapolFramesRx;
195 Counter dot1xAuthEapolFramesTx;
196 Counter dot1xAuthEapolStartFramesRx;
197 Counter dot1xAuthEapolLogoffFramesRx;
198 Counter dot1xAuthEapolRespIdFramesRx;
199 Counter dot1xAuthEapolRespFramesRx;
200 Counter dot1xAuthEapolReqIdFramesTx;
201 Counter dot1xAuthEapolReqFramesTx;
202 Counter dot1xAuthInvalidEapolFramesRx;
203 Counter dot1xAuthEapLengthErrorFramesRx;
204 Counter dot1xAuthLastEapolFrameVersion;
206 /* Other variables - not defined in IEEE 802.1X */
207 u8 addr[ETH_ALEN]; /* Supplicant address */
208 #define EAPOL_SM_PREAUTH BIT(0)
209 #define EAPOL_SM_WAIT_START BIT(1)
210 int flags; /* EAPOL_SM_* */
212 /* EAPOL/AAA <-> EAP full authenticator interface */
213 struct eap_eapol_interface *eap_if;
215 int radius_identifier;
216 /* TODO: check when the last messages can be released */
217 struct radius_msg *last_recv_radius;
218 u8 last_eap_id; /* last used EAP Identifier */
221 u8 eap_type_authsrv; /* EAP type of the last EAP packet from
222 * Authentication server */
223 u8 eap_type_supp; /* EAP type of the last EAP packet from Supplicant */
224 struct radius_class_data radius_class;
226 /* Keys for encrypting and signing EAPOL-Key frames */
228 size_t eapol_key_sign_len;
230 size_t eapol_key_crypt_len;
234 Boolean initializing; /* in process of initializing state machines */
237 struct eapol_authenticator *eapol;
239 /* Somewhat nasty pointers to global hostapd and STA data to avoid
240 * passing these to every function */
241 struct hostapd_data *hapd;
242 struct sta_info *sta;
246 struct eapol_authenticator * eapol_auth_init(struct eapol_auth_config *conf,
247 struct eapol_auth_cb *cb);
248 void eapol_auth_deinit(struct eapol_authenticator *eapol);
249 struct eapol_state_machine *
250 eapol_auth_alloc(struct eapol_authenticator *eapol, const u8 *addr,
251 int preauth, struct sta_info *sta);
252 void eapol_auth_free(struct eapol_state_machine *sm);
253 void eapol_auth_step(struct eapol_state_machine *sm);
254 void eapol_auth_initialize(struct eapol_state_machine *sm);
255 void eapol_auth_dump_state(FILE *f, const char *prefix,
256 struct eapol_state_machine *sm);
257 int eapol_auth_eap_pending_cb(struct eapol_state_machine *sm, void *ctx);
259 #endif /* EAPOL_SM_H */