Debian Codegraph @

src/ap/wpa_auth_i.h

raw
1 /*
2 * hostapd - IEEE 802.11i-2004 / WPA Authenticator: Internal definitions
3 * Copyright (c) 2004-2015, Jouni Malinen <[email protected]>
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 rx_eapol_key_secure:1;
90 unsigned int update_snonce:1;
91 unsigned int alt_snonce_valid:1;
92 #ifdef CONFIG_IEEE80211R_AP
93 unsigned int ft_completed:1;
94 unsigned int pmk_r1_name_valid:1;
95 #endif /* CONFIG_IEEE80211R_AP */
96 unsigned int is_wnmsleep:1;
97 unsigned int pmkid_set:1;
98
99 #ifdef CONFIG_OCV
100 int ocv_enabled;
101 #endif /* CONFIG_OCV */
102
103 u8 req_replay_counter[WPA_REPLAY_COUNTER_LEN];
104 int req_replay_counter_used;
105
106 u8 *wpa_ie;
107 size_t wpa_ie_len;
108 u8 *rsnxe;
109 size_t rsnxe_len;
110
111 enum {
112 WPA_VERSION_NO_WPA = 0 /* WPA not used */,
113 WPA_VERSION_WPA = 1 /* WPA / IEEE 802.11i/D3.0 */,
114 WPA_VERSION_WPA2 = 2 /* WPA2 / IEEE 802.11i */
115 } wpa;
116 int pairwise; /* Pairwise cipher suite, WPA_CIPHER_* */
117 int wpa_key_mgmt; /* the selected WPA_KEY_MGMT_* */
118 struct rsn_pmksa_cache_entry *pmksa;
119
120 u32 dot11RSNAStatsTKIPLocalMICFailures;
121 u32 dot11RSNAStatsTKIPRemoteMICFailures;
122
123 #ifdef CONFIG_IEEE80211R_AP
124 u8 xxkey[PMK_LEN_MAX]; /* PSK or the second 256 bits of MSK, or the
125 * first 384 bits of MSK */
126 size_t xxkey_len;
127 u8 pmk_r1[PMK_LEN_MAX];
128 unsigned int pmk_r1_len;
129 u8 pmk_r1_name[WPA_PMK_NAME_LEN]; /* PMKR1Name derived from FT Auth
130 * Request */
131 u8 r0kh_id[FT_R0KH_ID_MAX_LEN]; /* R0KH-ID from FT Auth Request */
132 size_t r0kh_id_len;
133 u8 sup_pmk_r1_name[WPA_PMK_NAME_LEN]; /* PMKR1Name from EAPOL-Key
134 * message 2/4 */
135 u8 *assoc_resp_ftie;
136
137 void (*ft_pending_cb)(void *ctx, const u8 *dst, const u8 *bssid,
138 u16 auth_transaction, u16 status,
139 const u8 *ies, size_t ies_len);
140 void *ft_pending_cb_ctx;
141 struct wpabuf *ft_pending_req_ies;
142 u8 ft_pending_pull_nonce[FT_RRB_NONCE_LEN];
143 u8 ft_pending_auth_transaction;
144 u8 ft_pending_current_ap[ETH_ALEN];
145 int ft_pending_pull_left_retries;
146 #endif /* CONFIG_IEEE80211R_AP */
147
148 int pending_1_of_4_timeout;
149
150 #ifdef CONFIG_P2P
151 u8 ip_addr[4];
152 #endif /* CONFIG_P2P */
153
154 #ifdef CONFIG_FILS
155 u8 fils_key_auth_sta[FILS_MAX_KEY_AUTH_LEN];
156 u8 fils_key_auth_ap[FILS_MAX_KEY_AUTH_LEN];
157 size_t fils_key_auth_len;
158 unsigned int fils_completed:1;
159 #endif /* CONFIG_FILS */
160
161 #ifdef CONFIG_DPP2
162 struct wpabuf *dpp_z;
163 #endif /* CONFIG_DPP2 */
164
165 #ifdef CONFIG_TESTING_OPTIONS
166 void (*eapol_status_cb)(void *ctx1, void *ctx2);
167 void *eapol_status_cb_ctx1;
168 void *eapol_status_cb_ctx2;
169 #endif /* CONFIG_TESTING_OPTIONS */
170 };
171
172
173 /* per group key state machine data */
174 struct wpa_group {
175 struct wpa_group *next;
176 int vlan_id;
177
178 bool GInit;
179 int GKeyDoneStations;
180 bool GTKReKey;
181 int GTK_len;
182 int GN, GM;
183 bool GTKAuthenticator;
184 u8 Counter[WPA_NONCE_LEN];
185
186 enum {
187 WPA_GROUP_GTK_INIT = 0,
188 WPA_GROUP_SETKEYS, WPA_GROUP_SETKEYSDONE,
189 WPA_GROUP_FATAL_FAILURE
190 } wpa_group_state;
191
192 u8 GMK[WPA_GMK_LEN];
193 u8 GTK[2][WPA_GTK_MAX_LEN];
194 u8 GNonce[WPA_NONCE_LEN];
195 bool changed;
196 bool first_sta_seen;
197 bool reject_4way_hs_for_entropy;
198 u8 IGTK[2][WPA_IGTK_MAX_LEN];
199 u8 BIGTK[2][WPA_IGTK_MAX_LEN];
200 int GN_igtk, GM_igtk;
201 int GN_bigtk, GM_bigtk;
202 /* Number of references except those in struct wpa_group->next */
203 unsigned int references;
204 unsigned int num_setup_iface;
205 };
206
207
208 struct wpa_ft_pmk_cache;
209
210 /* per authenticator data */
211 struct wpa_authenticator {
212 struct wpa_group *group;
213
214 unsigned int dot11RSNAStatsTKIPRemoteMICFailures;
215 u32 dot11RSNAAuthenticationSuiteSelected;
216 u32 dot11RSNAPairwiseCipherSelected;
217 u32 dot11RSNAGroupCipherSelected;
218 u8 dot11RSNAPMKIDUsed[PMKID_LEN];
219 u32 dot11RSNAAuthenticationSuiteRequested; /* FIX: update */
220 u32 dot11RSNAPairwiseCipherRequested; /* FIX: update */
221 u32 dot11RSNAGroupCipherRequested; /* FIX: update */
222 unsigned int dot11RSNATKIPCounterMeasuresInvoked;
223 unsigned int dot11RSNA4WayHandshakeFailures;
224
225 struct wpa_auth_config conf;
226 const struct wpa_auth_callbacks *cb;
227 void *cb_ctx;
228
229 u8 *wpa_ie;
230 size_t wpa_ie_len;
231
232 u8 addr[ETH_ALEN];
233
234 struct rsn_pmksa_cache *pmksa;
235 struct wpa_ft_pmk_cache *ft_pmk_cache;
236
237 #ifdef CONFIG_P2P
238 struct bitfield *ip_pool;
239 #endif /* CONFIG_P2P */
240 };
241
242
243 #ifdef CONFIG_IEEE80211R_AP
244
245 #define FT_REMOTE_SEQ_BACKLOG 16
246 struct ft_remote_seq_rx {
247 u32 dom;
248 struct os_reltime time_offset; /* local time - offset = remote time */
249
250 /* accepted sequence numbers: (offset ... offset + 0x40000000]
251 * (except those in last)
252 * dropped sequence numbers: (offset - 0x40000000 ... offset]
253 * all others trigger SEQ_REQ message (except first message)
254 */
255 u32 last[FT_REMOTE_SEQ_BACKLOG];
256 unsigned int num_last;
257 u32 offsetidx;
258
259 struct dl_list queue; /* send nonces + rrb msgs awaiting seq resp */
260 };
261
262 struct ft_remote_seq_tx {
263 u32 dom; /* non zero if initialized */
264 u32 seq;
265 };
266
267 struct ft_remote_seq {
268 struct ft_remote_seq_rx rx;
269 struct ft_remote_seq_tx tx;
270 };
271
272 #endif /* CONFIG_IEEE80211R_AP */
273
274
275 int wpa_write_rsn_ie(struct wpa_auth_config *conf, u8 *buf, size_t len,
276 const u8 *pmkid);
277 int wpa_write_rsnxe(struct wpa_auth_config *conf, u8 *buf, size_t len);
278 void wpa_auth_logger(struct wpa_authenticator *wpa_auth, const u8 *addr,
279 logger_level level, const char *txt);
280 void wpa_auth_vlogger(struct wpa_authenticator *wpa_auth, const u8 *addr,
281 logger_level level, const char *fmt, ...)
282 PRINTF_FORMAT(4, 5);
283 void __wpa_send_eapol(struct wpa_authenticator *wpa_auth,
284 struct wpa_state_machine *sm, int key_info,
285 const u8 *key_rsc, const u8 *nonce,
286 const u8 *kde, size_t kde_len,
287 int keyidx, int encr, int force_version);
288 int wpa_auth_for_each_sta(struct wpa_authenticator *wpa_auth,
289 int (*cb)(struct wpa_state_machine *sm, void *ctx),
290 void *cb_ctx);
291 int wpa_auth_for_each_auth(struct wpa_authenticator *wpa_auth,
292 int (*cb)(struct wpa_authenticator *a, void *ctx),
293 void *cb_ctx);
294
295 #ifdef CONFIG_IEEE80211R_AP
296 int wpa_write_mdie(struct wpa_auth_config *conf, u8 *buf, size_t len);
297 int wpa_write_ftie(struct wpa_auth_config *conf, int use_sha384,
298 const u8 *r0kh_id, size_t r0kh_id_len,
299 const u8 *anonce, const u8 *snonce,
300 u8 *buf, size_t len, const u8 *subelem,
301 size_t subelem_len, int rsnxe_used);
302 int wpa_auth_derive_ptk_ft(struct wpa_state_machine *sm, struct wpa_ptk *ptk);
303 struct wpa_ft_pmk_cache * wpa_ft_pmk_cache_init(void);
304 void wpa_ft_pmk_cache_deinit(struct wpa_ft_pmk_cache *cache);
305 void wpa_ft_install_ptk(struct wpa_state_machine *sm, int retry);
306 int wpa_ft_store_pmk_fils(struct wpa_state_machine *sm, const u8 *pmk_r0,
307 const u8 *pmk_r0_name);
308 #endif /* CONFIG_IEEE80211R_AP */
309
310 #endif /* WPA_AUTH_I_H */