1 /* 2 * hostapd - IEEE 802.11i-2004 / WPA Authenticator: Internal definitions 3 * Copyright (c) 2004-2015, Jouni Malinen <j@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 WPA_AUTH_I_H 10 #define WPA_AUTH_I_H 11 12 #include "utils/list.h" 13 14 /* max(dot11RSNAConfigGroupUpdateCount,dot11RSNAConfigPairwiseUpdateCount) */ 15 #define RSNA_MAX_EAPOL_RETRIES 4 16 17 struct wpa_group; 18 19 struct wpa_state_machine { 20 struct wpa_authenticator *wpa_auth; 21 struct wpa_group *group; 22 23 u8 addr[ETH_ALEN]; 24 u8 p2p_dev_addr[ETH_ALEN]; 25 u16 auth_alg; 26 27 enum { 28 WPA_PTK_INITIALIZE, WPA_PTK_DISCONNECT, WPA_PTK_DISCONNECTED, 29 WPA_PTK_AUTHENTICATION, WPA_PTK_AUTHENTICATION2, 30 WPA_PTK_INITPMK, WPA_PTK_INITPSK, WPA_PTK_PTKSTART, 31 WPA_PTK_PTKCALCNEGOTIATING, WPA_PTK_PTKCALCNEGOTIATING2, 32 WPA_PTK_PTKINITNEGOTIATING, WPA_PTK_PTKINITDONE 33 } wpa_ptk_state; 34 35 enum { 36 WPA_PTK_GROUP_IDLE = 0, 37 WPA_PTK_GROUP_REKEYNEGOTIATING, 38 WPA_PTK_GROUP_REKEYESTABLISHED, 39 WPA_PTK_GROUP_KEYERROR 40 } wpa_ptk_group_state; 41 42 bool Init; 43 bool DeauthenticationRequest; 44 bool AuthenticationRequest; 45 bool ReAuthenticationRequest; 46 bool Disconnect; 47 u16 disconnect_reason; /* specific reason code to use with Disconnect */ 48 u32 TimeoutCtr; 49 u32 GTimeoutCtr; 50 bool TimeoutEvt; 51 bool EAPOLKeyReceived; 52 bool EAPOLKeyPairwise; 53 bool EAPOLKeyRequest; 54 bool MICVerified; 55 bool GUpdateStationKeys; 56 u8 ANonce[WPA_NONCE_LEN]; 57 u8 SNonce[WPA_NONCE_LEN]; 58 u8 alt_SNonce[WPA_NONCE_LEN]; 59 u8 alt_replay_counter[WPA_REPLAY_COUNTER_LEN]; 60 u8 PMK[PMK_LEN_MAX]; 61 unsigned int pmk_len; 62 u8 pmkid[PMKID_LEN]; /* valid if pmkid_set == 1 */ 63 struct wpa_ptk PTK; 64 u8 keyidx_active; 65 bool use_ext_key_id; 66 bool PTK_valid; 67 bool pairwise_set; 68 bool tk_already_set; 69 int keycount; 70 bool Pair; 71 struct wpa_key_replay_counter { 72 u8 counter[WPA_REPLAY_COUNTER_LEN]; 73 bool valid; 74 } key_replay[RSNA_MAX_EAPOL_RETRIES], 75 prev_key_replay[RSNA_MAX_EAPOL_RETRIES]; 76 bool PInitAKeys; /* WPA only, not in IEEE 802.11i */ 77 bool PTKRequest; /* not in IEEE 802.11i state machine */ 78 bool has_GTK; 79 bool PtkGroupInit; /* init request for PTK Group state machine */ 80 81 u8 *last_rx_eapol_key; /* starting from IEEE 802.1X header */ 82 size_t last_rx_eapol_key_len; 83 84 unsigned int changed:1; 85 unsigned int in_step_loop:1; 86 unsigned int pending_deinit:1; 87 unsigned int started:1; 88 unsigned int mgmt_frame_prot:1; 89 unsigned int mfpr:1; 90 unsigned int rx_eapol_key_secure:1; 91 unsigned int update_snonce:1; 92 unsigned int alt_snonce_valid:1; 93 unsigned int waiting_radius_psk:1; 94 #ifdef CONFIG_IEEE80211R_AP 95 unsigned int ft_completed:1; 96 unsigned int pmk_r1_name_valid:1; 97 #endif /* CONFIG_IEEE80211R_AP */ 98 unsigned int is_wnmsleep:1; 99 unsigned int pmkid_set:1; 100 unsigned int spp_amsdu:1; 101 102 unsigned int ptkstart_without_success; 103 104 #ifdef CONFIG_OCV 105 int ocv_enabled; 106 #endif /* CONFIG_OCV */ 107 108 u8 req_replay_counter[WPA_REPLAY_COUNTER_LEN]; 109 int req_replay_counter_used; 110 111 u8 *wpa_ie; 112 size_t wpa_ie_len; 113 u8 *rsnxe; 114 size_t rsnxe_len; 115 u8 *rsn_selection; 116 size_t rsn_selection_len; 117 118 enum { 119 WPA_VERSION_NO_WPA = 0 /* WPA not used */, 120 WPA_VERSION_WPA = 1 /* WPA / IEEE 802.11i/D3.0 */, 121 WPA_VERSION_WPA2 = 2 /* WPA2 / IEEE 802.11i */ 122 } wpa; 123 int pairwise; /* Pairwise cipher suite, WPA_CIPHER_* */ 124 int wpa_key_mgmt; /* the selected WPA_KEY_MGMT_* */ 125 struct rsn_pmksa_cache_entry *pmksa; 126 127 u32 dot11RSNAStatsTKIPLocalMICFailures; 128 u32 dot11RSNAStatsTKIPRemoteMICFailures; 129 130 bool rsn_override; 131 bool rsn_override_2; 132 133 #ifdef CONFIG_IEEE80211R_AP 134 u8 xxkey[PMK_LEN_MAX]; /* PSK or the second 256 bits of MSK, or the 135 * first 384 bits of MSK */ 136 size_t xxkey_len; 137 u8 pmk_r1[PMK_LEN_MAX]; 138 unsigned int pmk_r1_len; 139 u8 pmk_r1_name[WPA_PMK_NAME_LEN]; /* PMKR1Name derived from FT Auth 140 * Request */ 141 u8 r0kh_id[FT_R0KH_ID_MAX_LEN]; /* R0KH-ID from FT Auth Request */ 142 size_t r0kh_id_len; 143 u8 *assoc_resp_ftie; 144 145 void (*ft_pending_cb)(void *ctx, const u8 *dst, 146 u16 auth_transaction, u16 status, 147 const u8 *ies, size_t ies_len); 148 void *ft_pending_cb_ctx; 149 struct wpabuf *ft_pending_req_ies; 150 u8 ft_pending_pull_nonce[FT_RRB_NONCE_LEN]; 151 u8 ft_pending_auth_transaction; 152 u8 ft_pending_current_ap[ETH_ALEN]; 153 int ft_pending_pull_left_retries; 154 #endif /* CONFIG_IEEE80211R_AP */ 155 156 int pending_1_of_4_timeout; 157 158 #ifdef CONFIG_P2P 159 u8 ip_addr[4]; 160 unsigned int ip_addr_bit; 161 #endif /* CONFIG_P2P */ 162 163 #ifdef CONFIG_FILS 164 u8 fils_key_auth_sta[FILS_MAX_KEY_AUTH_LEN]; 165 u8 fils_key_auth_ap[FILS_MAX_KEY_AUTH_LEN]; 166 size_t fils_key_auth_len; 167 unsigned int fils_completed:1; 168 #endif /* CONFIG_FILS */ 169 170 #ifdef CONFIG_DPP2 171 struct wpabuf *dpp_z; 172 #endif /* CONFIG_DPP2 */ 173 174 #ifdef CONFIG_TESTING_OPTIONS 175 void (*eapol_status_cb)(void *ctx1, void *ctx2); 176 void *eapol_status_cb_ctx1; 177 void *eapol_status_cb_ctx2; 178 #endif /* CONFIG_TESTING_OPTIONS */ 179 180 #ifdef CONFIG_IEEE80211BE 181 u8 peer_mld_addr[ETH_ALEN]; 182 s8 mld_assoc_link_id; 183 u8 n_mld_affiliated_links; 184 185 struct mld_link { 186 bool valid; 187 u8 peer_addr[ETH_ALEN]; 188 189 struct wpa_authenticator *wpa_auth; 190 } mld_links[MAX_NUM_MLD_LINKS]; 191 #endif /* CONFIG_IEEE80211BE */ 192 193 bool ssid_protection; 194 }; 195 196 197 /* per group key state machine data */ 198 struct wpa_group { 199 struct wpa_group *next; 200 int vlan_id; 201 202 bool GInit; 203 int GKeyDoneStations; 204 bool GTKReKey; 205 int GTK_len; 206 int GN, GM; 207 bool GTKAuthenticator; 208 u8 Counter[WPA_NONCE_LEN]; 209 210 enum { 211 WPA_GROUP_GTK_INIT = 0, 212 WPA_GROUP_SETKEYS, WPA_GROUP_SETKEYSDONE, 213 WPA_GROUP_FATAL_FAILURE 214 } wpa_group_state; 215 216 u8 GMK[WPA_GMK_LEN]; 217 u8 GTK[2][WPA_GTK_MAX_LEN]; 218 u8 GNonce[WPA_NONCE_LEN]; 219 bool changed; 220 bool first_sta_seen; 221 bool reject_4way_hs_for_entropy; 222 u8 IGTK[2][WPA_IGTK_MAX_LEN]; 223 u8 BIGTK[2][WPA_IGTK_MAX_LEN]; 224 int GN_igtk, GM_igtk; 225 int GN_bigtk, GM_bigtk; 226 bool bigtk_set; 227 bool bigtk_configured; 228 /* Number of references except those in struct wpa_group->next */ 229 unsigned int references; 230 unsigned int num_setup_iface; 231 }; 232 233 234 struct wpa_ft_pmk_cache; 235 236 /* per authenticator data */ 237 struct wpa_authenticator { 238 struct wpa_group *group; 239 240 unsigned int dot11RSNAStatsTKIPRemoteMICFailures; 241 u32 dot11RSNAAuthenticationSuiteSelected; 242 u32 dot11RSNAPairwiseCipherSelected; 243 u32 dot11RSNAGroupCipherSelected; 244 u8 dot11RSNAPMKIDUsed[PMKID_LEN]; 245 u32 dot11RSNAAuthenticationSuiteRequested; /* FIX: update */ 246 u32 dot11RSNAPairwiseCipherRequested; /* FIX: update */ 247 u32 dot11RSNAGroupCipherRequested; /* FIX: update */ 248 unsigned int dot11RSNATKIPCounterMeasuresInvoked; 249 unsigned int dot11RSNA4WayHandshakeFailures; 250 251 struct wpa_auth_config conf; 252 const struct wpa_auth_callbacks *cb; 253 void *cb_ctx; 254 255 u8 *wpa_ie; 256 size_t wpa_ie_len; 257 258 u8 addr[ETH_ALEN]; 259 260 struct rsn_pmksa_cache *pmksa; 261 struct wpa_ft_pmk_cache *ft_pmk_cache; 262 263 bool non_tx_beacon_prot; 264 265 #ifdef CONFIG_P2P 266 struct bitfield *ip_pool; 267 #endif /* CONFIG_P2P */ 268 269 #ifdef CONFIG_IEEE80211BE 270 /* MLD-level PMKSA cache for non-AP MLD entries only. */ 271 struct rsn_pmksa_cache *ml_pmksa; 272 bool is_ml; 273 u8 mld_addr[ETH_ALEN]; 274 u8 link_id; 275 bool primary_auth; 276 #endif /* CONFIG_IEEE80211BE */ 277 }; 278 279 280 #ifdef CONFIG_IEEE80211R_AP 281 282 #define FT_REMOTE_SEQ_BACKLOG 16 283 struct ft_remote_seq_rx { 284 u32 dom; 285 struct os_reltime time_offset; /* local time - offset = remote time */ 286 287 /* accepted sequence numbers: (offset ... offset + 0x40000000] 288 * (except those in last) 289 * dropped sequence numbers: (offset - 0x40000000 ... offset] 290 * all others trigger SEQ_REQ message (except first message) 291 */ 292 u32 last[FT_REMOTE_SEQ_BACKLOG]; 293 unsigned int num_last; 294 u32 offsetidx; 295 296 struct dl_list queue; /* send nonces + rrb msgs awaiting seq resp */ 297 }; 298 299 struct ft_remote_seq_tx { 300 u32 dom; /* non zero if initialized */ 301 u32 seq; 302 }; 303 304 struct ft_remote_seq { 305 struct ft_remote_seq_rx rx; 306 struct ft_remote_seq_tx tx; 307 }; 308 309 #endif /* CONFIG_IEEE80211R_AP */ 310 311 312 int wpa_write_rsn_ie(struct wpa_auth_config *conf, u8 *buf, size_t len, 313 const u8 *pmkid); 314 int wpa_write_rsnxe(struct wpa_auth_config *conf, u8 *buf, size_t len); 315 void wpa_auth_logger(struct wpa_authenticator *wpa_auth, const u8 *addr, 316 logger_level level, const char *txt); 317 void wpa_auth_vlogger(struct wpa_authenticator *wpa_auth, const u8 *addr, 318 logger_level level, const char *fmt, ...) 319 PRINTF_FORMAT(4, 5); 320 void __wpa_send_eapol(struct wpa_authenticator *wpa_auth, 321 struct wpa_state_machine *sm, int key_info, 322 const u8 *key_rsc, const u8 *nonce, 323 const u8 *kde, size_t kde_len, 324 int keyidx, int encr, int force_version); 325 int wpa_auth_for_each_sta(struct wpa_authenticator *wpa_auth, 326 int (*cb)(struct wpa_state_machine *sm, void *ctx), 327 void *cb_ctx); 328 int wpa_auth_for_each_auth(struct wpa_authenticator *wpa_auth, 329 int (*cb)(struct wpa_authenticator *a, void *ctx), 330 void *cb_ctx); 331 void wpa_auth_store_ptksa(struct wpa_authenticator *wpa_auth, 332 const u8 *addr, int cipher, 333 u32 life_time, const struct wpa_ptk *ptk); 334 335 #ifdef CONFIG_IEEE80211R_AP 336 int wpa_write_mdie(struct wpa_auth_config *conf, u8 *buf, size_t len); 337 int wpa_write_ftie(struct wpa_auth_config *conf, int key_mgmt, size_t key_len, 338 const u8 *r0kh_id, size_t r0kh_id_len, 339 const u8 *anonce, const u8 *snonce, 340 u8 *buf, size_t len, const u8 *subelem, 341 size_t subelem_len, int rsnxe_used); 342 int wpa_auth_derive_ptk_ft(struct wpa_state_machine *sm, struct wpa_ptk *ptk, 343 u8 *pmk_r0, u8 *pmk_r1, u8 *pmk_r0_name, 344 size_t *key_len, size_t kdk_len); 345 void wpa_auth_ft_store_keys(struct wpa_state_machine *sm, const u8 *pmk_r0, 346 const u8 *pmk_r1, const u8 *pmk_r0_name, 347 size_t key_len); 348 struct wpa_ft_pmk_cache * wpa_ft_pmk_cache_init(void); 349 void wpa_ft_pmk_cache_deinit(struct wpa_ft_pmk_cache *cache); 350 void wpa_ft_install_ptk(struct wpa_state_machine *sm, int retry); 351 int wpa_ft_store_pmk_fils(struct wpa_state_machine *sm, const u8 *pmk_r0, 352 const u8 *pmk_r0_name); 353 #endif /* CONFIG_IEEE80211R_AP */ 354 355 #endif /* WPA_AUTH_I_H */ 356