1 /*
2  * hostapd - IEEE 802.11i-2004 / WPA Authenticator
3  * Copyright (c) 2004-2022, 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_H
10 #define WPA_AUTH_H
11 
12 #include "common/defs.h"
13 #include "common/eapol_common.h"
14 #include "common/wpa_common.h"
15 #include "common/ieee802_11_defs.h"
16 
17 struct vlan_description;
18 struct mld_info;
19 
20 #define MAX_OWN_IE_OVERRIDE 257
21 
22 #ifdef _MSC_VER
23 #pragma pack(push, 1)
24 #endif /* _MSC_VER */
25 
26 /* IEEE Std 802.11r-2008, 11A.10.3 - Remote request/response frame definition
27  */
28 struct ft_rrb_frame {
29 	u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
30 	u8 packet_type; /* FT_PACKET_REQUEST/FT_PACKET_RESPONSE */
31 	le16 action_length; /* little endian length of action_frame */
32 	u8 ap_address[ETH_ALEN];
33 	/*
34 	 * Followed by action_length bytes of FT Action frame (from Category
35 	 * field to the end of Action Frame body.
36 	 */
37 } STRUCT_PACKED;
38 
39 #define RSN_REMOTE_FRAME_TYPE_FT_RRB 1
40 
41 #define FT_PACKET_REQUEST 0
42 #define FT_PACKET_RESPONSE 1
43 
44 /* Vendor-specific types for R0KH-R1KH protocol; not defined in 802.11r. These
45  * use OUI Extended EtherType as the encapsulating format. */
46 #define FT_PACKET_R0KH_R1KH_PULL 0x01
47 #define FT_PACKET_R0KH_R1KH_RESP 0x02
48 #define FT_PACKET_R0KH_R1KH_PUSH 0x03
49 #define FT_PACKET_R0KH_R1KH_SEQ_REQ 0x04
50 #define FT_PACKET_R0KH_R1KH_SEQ_RESP 0x05
51 
52 /* packet layout
53  *  IEEE 802 extended OUI ethertype frame header
54  *  u16 authlen (little endian)
55  *  multiple of struct ft_rrb_tlv (authenticated only, length = authlen)
56  *  multiple of struct ft_rrb_tlv (AES-SIV encrypted, AES-SIV needs an extra
57  *                                 blocksize length)
58  *
59  * AES-SIV AAD;
60  *  source MAC address (6)
61  *  authenticated-only TLVs (authlen)
62  *  subtype (1; FT_PACKET_*)
63  */
64 
65 #define FT_RRB_NONCE_LEN 16
66 
67 #define FT_RRB_LAST_EMPTY     0 /* placeholder or padding */
68 
69 #define FT_RRB_SEQ            1 /* struct ft_rrb_seq */
70 #define FT_RRB_NONCE          2 /* size FT_RRB_NONCE_LEN */
71 #define FT_RRB_TIMESTAMP      3 /* le32 unix seconds */
72 
73 #define FT_RRB_R0KH_ID        4 /* FT_R0KH_ID_MAX_LEN */
74 #define FT_RRB_R1KH_ID        5 /* FT_R1KH_ID_LEN */
75 #define FT_RRB_S1KH_ID        6 /* ETH_ALEN */
76 
77 #define FT_RRB_PMK_R0_NAME    7 /* WPA_PMK_NAME_LEN */
78 #define FT_RRB_PMK_R0         8 /* PMK_LEN */
79 #define FT_RRB_PMK_R1_NAME    9 /* WPA_PMK_NAME_LEN */
80 #define FT_RRB_PMK_R1        10 /* PMK_LEN */
81 
82 #define FT_RRB_PAIRWISE      11 /* le16 */
83 #define FT_RRB_EXPIRES_IN    12 /* le16 seconds */
84 
85 #define FT_RRB_VLAN_UNTAGGED 13 /* le16 */
86 #define FT_RRB_VLAN_TAGGED   14 /* n times le16 */
87 
88 #define FT_RRB_IDENTITY      15
89 #define FT_RRB_RADIUS_CUI    16
90 #define FT_RRB_SESSION_TIMEOUT  17 /* le32 seconds */
91 
92 struct ft_rrb_tlv {
93 	le16 type;
94 	le16 len;
95 	/* followed by data of length len */
96 } STRUCT_PACKED;
97 
98 struct ft_rrb_seq {
99 	le32 dom;
100 	le32 seq;
101 	le32 ts;
102 } STRUCT_PACKED;
103 
104 /* session TLVs:
105  *   required: PMK_R1, PMK_R1_NAME, PAIRWISE
106  *   optional: VLAN_UNTAGGED, VLAN_TAGGED, EXPIRES_IN, IDENTITY, RADIUS_CUI,
107  *		 SESSION_TIMEOUT
108  *
109  * pull frame TLVs:
110  *   auth:
111  *     required: SEQ, NONCE, R0KH_ID, R1KH_ID
112  *   encrypted:
113  *     required: PMK_R0_NAME, S1KH_ID
114  *
115  * response frame TLVs:
116  *   auth:
117  *     required: SEQ, NONCE, R0KH_ID, R1KH_ID
118  *   encrypted:
119  *     required: S1KH_ID
120  *     optional: session TLVs
121  *
122  * push frame TLVs:
123  *   auth:
124  *     required: SEQ, R0KH_ID, R1KH_ID
125  *   encrypted:
126  *     required: S1KH_ID, PMK_R0_NAME, session TLVs
127  *
128  * sequence number request frame TLVs:
129  *   auth:
130  *     required: R0KH_ID, R1KH_ID, NONCE
131  *
132  * sequence number response frame TLVs:
133  *   auth:
134  *     required: SEQ, NONCE, R0KH_ID, R1KH_ID
135  */
136 
137 #ifdef _MSC_VER
138 #pragma pack(pop)
139 #endif /* _MSC_VER */
140 
141 
142 /* per STA state machine data */
143 
144 struct wpa_authenticator;
145 struct wpa_state_machine;
146 struct rsn_pmksa_cache_entry;
147 struct eapol_state_machine;
148 struct ft_remote_seq;
149 struct wpa_channel_info;
150 
151 
152 struct ft_remote_r0kh {
153 	struct ft_remote_r0kh *next;
154 	u8 addr[ETH_ALEN];
155 	u8 id[FT_R0KH_ID_MAX_LEN];
156 	size_t id_len;
157 	u8 key[32];
158 	struct ft_remote_seq *seq;
159 };
160 
161 
162 struct ft_remote_r1kh {
163 	struct ft_remote_r1kh *next;
164 	u8 addr[ETH_ALEN];
165 	u8 id[FT_R1KH_ID_LEN];
166 	u8 key[32];
167 	struct ft_remote_seq *seq;
168 };
169 
170 
171 struct wpa_auth_config {
172 	void *msg_ctx;
173 	int wpa;
174 	int extended_key_id;
175 	int wpa_key_mgmt;
176 	int rsn_override_key_mgmt;
177 	int rsn_override_key_mgmt_2;
178 	int wpa_pairwise;
179 	int wpa_group;
180 	int wpa_group_rekey;
181 	int wpa_strict_rekey;
182 	int wpa_gmk_rekey;
183 	int wpa_ptk_rekey;
184 	int wpa_deny_ptk0_rekey;
185 	u32 wpa_group_update_count;
186 	u32 wpa_pairwise_update_count;
187 	int wpa_disable_eapol_key_retries;
188 	int rsn_pairwise;
189 	int rsn_override_pairwise;
190 	int rsn_override_pairwise_2;
191 	int rsn_preauth;
192 	int eapol_version;
193 	int wmm_enabled;
194 	int wmm_uapsd;
195 	int disable_pmksa_caching;
196 	int okc;
197 	int tx_status;
198 	enum mfp_options ieee80211w;
199 	enum mfp_options rsn_override_mfp;
200 	enum mfp_options rsn_override_mfp_2;
201 	int beacon_prot;
202 	int group_mgmt_cipher;
203 	int sae_require_mfp;
204 #ifdef CONFIG_OCV
205 	int ocv; /* Operating Channel Validation */
206 #endif /* CONFIG_OCV */
207 	u8 ssid[SSID_MAX_LEN];
208 	size_t ssid_len;
209 #ifdef CONFIG_IEEE80211R_AP
210 	u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
211 	u8 r0_key_holder[FT_R0KH_ID_MAX_LEN];
212 	size_t r0_key_holder_len;
213 	u8 r1_key_holder[FT_R1KH_ID_LEN];
214 	u32 r0_key_lifetime; /* PMK-R0 lifetime seconds */
215 	int rkh_pos_timeout;
216 	int rkh_neg_timeout;
217 	int rkh_pull_timeout; /* ms */
218 	int rkh_pull_retries;
219 	int r1_max_key_lifetime;
220 	u32 reassociation_deadline;
221 	struct ft_remote_r0kh **r0kh_list;
222 	struct ft_remote_r1kh **r1kh_list;
223 	int pmk_r1_push;
224 	int ft_over_ds;
225 	int ft_psk_generate_local;
226 #endif /* CONFIG_IEEE80211R_AP */
227 	int disable_gtk;
228 	int ap_mlme;
229 #ifdef CONFIG_TESTING_OPTIONS
230 	double corrupt_gtk_rekey_mic_probability;
231 	u8 own_ie_override[MAX_OWN_IE_OVERRIDE];
232 	size_t own_ie_override_len;
233 	bool rsne_override_set;
234 	u8 rsne_override[MAX_OWN_IE_OVERRIDE];
235 	size_t rsne_override_len;
236 	bool rsnoe_override_set;
237 	u8 rsnoe_override[MAX_OWN_IE_OVERRIDE];
238 	size_t rsnoe_override_len;
239 	bool rsno2e_override_set;
240 	u8 rsno2e_override[MAX_OWN_IE_OVERRIDE];
241 	size_t rsno2e_override_len;
242 	bool rsnxe_override_set;
243 	u8 rsnxe_override[MAX_OWN_IE_OVERRIDE];
244 	size_t rsnxe_override_len;
245 	bool rsnxoe_override_set;
246 	u8 rsnxoe_override[MAX_OWN_IE_OVERRIDE];
247 	size_t rsnxoe_override_len;
248 	u8 rsne_override_eapol[MAX_OWN_IE_OVERRIDE];
249 	size_t rsne_override_eapol_len;
250 	u8 rsnxe_override_eapol[MAX_OWN_IE_OVERRIDE];
251 	size_t rsnxe_override_eapol_len;
252 	u8 rsne_override_ft[MAX_OWN_IE_OVERRIDE];
253 	size_t rsne_override_ft_len;
254 	u8 rsnxe_override_ft[MAX_OWN_IE_OVERRIDE];
255 	size_t rsnxe_override_ft_len;
256 	u8 gtk_rsc_override[WPA_KEY_RSC_LEN];
257 	u8 igtk_rsc_override[WPA_KEY_RSC_LEN];
258 	unsigned int rsne_override_eapol_set:1;
259 	unsigned int rsnxe_override_eapol_set:1;
260 	unsigned int rsne_override_ft_set:1;
261 	unsigned int rsnxe_override_ft_set:1;
262 	unsigned int gtk_rsc_override_set:1;
263 	unsigned int igtk_rsc_override_set:1;
264 	int ft_rsnxe_used;
265 	bool delay_eapol_tx;
266 	struct wpabuf *eapol_m1_elements;
267 	struct wpabuf *eapol_m3_elements;
268 	bool eapol_m3_no_encrypt;
269 	bool eapol_key_reserved_random;
270 #endif /* CONFIG_TESTING_OPTIONS */
271 	unsigned int oci_freq_override_eapol_m3;
272 	unsigned int oci_freq_override_eapol_g1;
273 	unsigned int oci_freq_override_ft_assoc;
274 	unsigned int oci_freq_override_fils_assoc;
275 #ifdef CONFIG_P2P
276 	u8 ip_addr_go[4];
277 	u8 ip_addr_mask[4];
278 	u8 ip_addr_start[4];
279 	u8 ip_addr_end[4];
280 #endif /* CONFIG_P2P */
281 #ifdef CONFIG_FILS
282 	unsigned int fils_cache_id_set:1;
283 	u8 fils_cache_id[FILS_CACHE_ID_LEN];
284 #endif /* CONFIG_FILS */
285 	enum sae_pwe sae_pwe;
286 	bool sae_pk;
287 
288 	unsigned int secure_ltf:1;
289 	unsigned int secure_rtt:1;
290 	unsigned int prot_range_neg:1;
291 
292 	int owe_ptk_workaround;
293 	u8 transition_disable;
294 #ifdef CONFIG_DPP2
295 	int dpp_pfs;
296 #endif /* CONFIG_DPP2 */
297 
298 	/*
299 	 * If set Key Derivation Key should be derived as part of PMK to
300 	 * PTK derivation regardless of advertised capabilities.
301 	 */
302 	bool force_kdk_derivation;
303 
304 	bool radius_psk;
305 
306 	bool no_disconnect_on_group_keyerror;
307 
308 	/* Pointer to Multi-BSSID transmitted BSS authenticator instance.
309 	 * Set only in nontransmitted BSSs, i.e., is NULL for transmitted BSS
310 	 * and in BSSs that are not part of a Multi-BSSID set. */
311 	struct wpa_authenticator *tx_bss_auth;
312 
313 #ifdef CONFIG_IEEE80211BE
314 	const u8 *mld_addr;
315 	int link_id;
316 	struct wpa_authenticator *first_link_auth;
317 #endif /* CONFIG_IEEE80211BE */
318 
319 	bool ssid_protection;
320 
321 	int rsn_override_omit_rsnxe;
322 
323 	bool spp_amsdu;
324 };
325 
326 typedef enum {
327 	LOGGER_DEBUG, LOGGER_INFO, LOGGER_WARNING
328 } logger_level;
329 
330 typedef enum {
331 	WPA_EAPOL_portEnabled, WPA_EAPOL_portValid, WPA_EAPOL_authorized,
332 	WPA_EAPOL_portControl_Auto, WPA_EAPOL_keyRun, WPA_EAPOL_keyAvailable,
333 	WPA_EAPOL_keyDone, WPA_EAPOL_inc_EapolFramesTx
334 } wpa_eapol_variable;
335 
336 struct wpa_auth_ml_key_info {
337 	unsigned int n_mld_links;
338 	bool mgmt_frame_prot;
339 	bool beacon_prot;
340 
341 	struct wpa_auth_ml_link_key_info {
342 		u8 link_id;
343 
344 		u8 gtkidx;
345 		u8 gtk_len;
346 		u8 pn[6];
347 		const u8 *gtk;
348 
349 		u8 igtkidx;
350 		u8 igtk_len;
351 		const u8 *igtk;
352 		u8 ipn[6];
353 
354 		u8 bigtkidx;
355 		const u8 *bigtk;
356 		u8 bipn[6];
357 	} links[MAX_NUM_MLD_LINKS];
358 };
359 
360 struct wpa_auth_callbacks {
361 	void (*logger)(void *ctx, const u8 *addr, logger_level level,
362 		       const char *txt);
363 	void (*disconnect)(void *ctx, const u8 *addr, u16 reason);
364 	int (*mic_failure_report)(void *ctx, const u8 *addr);
365 	void (*psk_failure_report)(void *ctx, const u8 *addr);
366 	void (*set_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var,
367 			  int value);
368 	int (*get_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var);
369 	const u8 * (*get_psk)(void *ctx, const u8 *addr, const u8 *p2p_dev_addr,
370 			      const u8 *prev_psk, size_t *psk_len,
371 			      int *vlan_id);
372 	int (*get_msk)(void *ctx, const u8 *addr, u8 *msk, size_t *len);
373 	int (*set_key)(void *ctx, int vlan_id, enum wpa_alg alg,
374 		       const u8 *addr, int idx, u8 *key, size_t key_len,
375 		       enum key_flag key_flag);
376 	int (*get_seqnum)(void *ctx, const u8 *addr, int idx, u8 *seq);
377 	int (*send_eapol)(void *ctx, const u8 *addr, const u8 *data,
378 			  size_t data_len, int encrypt);
379 	int (*get_sta_count)(void *ctx);
380 	int (*for_each_sta)(void *ctx, int (*cb)(struct wpa_state_machine *sm,
381 						 void *ctx), void *cb_ctx);
382 	int (*for_each_auth)(void *ctx, int (*cb)(struct wpa_authenticator *a,
383 						  void *ctx), void *cb_ctx);
384 	int (*send_ether)(void *ctx, const u8 *dst, u16 proto, const u8 *data,
385 			  size_t data_len);
386 	int (*send_oui)(void *ctx, const u8 *dst, u8 oui_suffix, const u8 *data,
387 			size_t data_len);
388 	int (*channel_info)(void *ctx, struct wpa_channel_info *ci);
389 	int (*update_vlan)(void *ctx, const u8 *addr, int vlan_id);
390 	int (*get_sta_tx_params)(void *ctx, const u8 *addr,
391 				 int ap_max_chanwidth, int ap_seg1_idx,
392 				 int *bandwidth, int *seg1_idx);
393 	void (*store_ptksa)(void *ctx, const u8 *addr, int cipher,
394 			    u32 life_time, const struct wpa_ptk *ptk);
395 	void (*clear_ptksa)(void *ctx, const u8 *addr, int cipher);
396 	void (*request_radius_psk)(void *ctx, const u8 *addr, int key_mgmt,
397 				   const u8 *anonce,
398 				   const u8 *eapol, size_t eapol_len);
399 #ifdef CONFIG_IEEE80211R_AP
400 	struct wpa_state_machine * (*add_sta)(void *ctx, const u8 *sta_addr);
401 	int (*add_sta_ft)(void *ctx, const u8 *sta_addr);
402 	int (*set_vlan)(void *ctx, const u8 *sta_addr,
403 			struct vlan_description *vlan);
404 	int (*get_vlan)(void *ctx, const u8 *sta_addr,
405 			struct vlan_description *vlan);
406 	int (*set_identity)(void *ctx, const u8 *sta_addr,
407 			    const u8 *identity, size_t identity_len);
408 	size_t (*get_identity)(void *ctx, const u8 *sta_addr, const u8 **buf);
409 	int (*set_radius_cui)(void *ctx, const u8 *sta_addr,
410 			      const u8 *radius_cui, size_t radius_cui_len);
411 	size_t (*get_radius_cui)(void *ctx, const u8 *sta_addr, const u8 **buf);
412 	void (*set_session_timeout)(void *ctx, const u8 *sta_addr,
413 				    int session_timeout);
414 	int (*get_session_timeout)(void *ctx, const u8 *sta_addr);
415 
416 	int (*send_ft_action)(void *ctx, const u8 *dst,
417 			      const u8 *data, size_t data_len);
418 	int (*add_tspec)(void *ctx, const u8 *sta_addr, u8 *tspec_ie,
419 			 size_t tspec_ielen);
420 #endif /* CONFIG_IEEE80211R_AP */
421 #ifdef CONFIG_MESH
422 	int (*start_ampe)(void *ctx, const u8 *sta_addr);
423 #endif /* CONFIG_MESH */
424 #ifdef CONFIG_PASN
425 	int (*set_ltf_keyseed)(void *ctx, const u8 *addr, const u8 *ltf_keyseed,
426 			       size_t ltf_keyseed_len);
427 #endif /* CONFIG_PASN */
428 #ifdef CONFIG_IEEE80211BE
429 	int (*get_ml_key_info)(void *ctx, struct wpa_auth_ml_key_info *info,
430 			       bool rekey);
431 	struct wpa_authenticator * (*next_primary_auth)(void *ctx);
432 #endif /* CONFIG_IEEE80211BE */
433 	int (*get_drv_flags)(void *ctx, u64 *drv_flags, u64 *drv_flags2);
434 };
435 
436 struct wpa_authenticator * wpa_init(const u8 *addr,
437 				    struct wpa_auth_config *conf,
438 				    const struct wpa_auth_callbacks *cb,
439 				    void *cb_ctx);
440 int wpa_init_keys(struct wpa_authenticator *wpa_auth);
441 void wpa_deinit(struct wpa_authenticator *wpa_auth);
442 int wpa_reconfig(struct wpa_authenticator *wpa_auth,
443 		 struct wpa_auth_config *conf);
444 
445 enum wpa_validate_result {
446 	WPA_IE_OK, WPA_INVALID_IE, WPA_INVALID_GROUP, WPA_INVALID_PAIRWISE,
447 	WPA_INVALID_AKMP, WPA_NOT_ENABLED, WPA_ALLOC_FAIL,
448 	WPA_MGMT_FRAME_PROTECTION_VIOLATION, WPA_INVALID_MGMT_GROUP_CIPHER,
449 	WPA_INVALID_MDIE, WPA_INVALID_PROTO, WPA_INVALID_PMKID,
450 	WPA_DENIED_OTHER_REASON
451 };
452 
453 enum wpa_validate_result
454 wpa_validate_wpa_ie(struct wpa_authenticator *wpa_auth,
455 		    struct wpa_state_machine *sm, int freq,
456 		    const u8 *wpa_ie, size_t wpa_ie_len,
457 		    const u8 *rsnxe, size_t rsnxe_len,
458 		    const u8 *mdie, size_t mdie_len,
459 		    const u8 *owe_dh, size_t owe_dh_len,
460 		    struct wpa_state_machine *assoc_sm,
461 		    bool is_ml);
462 int wpa_validate_osen(struct wpa_authenticator *wpa_auth,
463 		      struct wpa_state_machine *sm,
464 		      const u8 *osen_ie, size_t osen_ie_len);
465 int wpa_auth_uses_mfp(struct wpa_state_machine *sm);
466 int wpa_auth_uses_spp_amsdu(struct wpa_state_machine *sm);
467 void wpa_auth_set_ocv(struct wpa_state_machine *sm, int ocv);
468 int wpa_auth_uses_ocv(struct wpa_state_machine *sm);
469 struct wpa_state_machine *
470 wpa_auth_sta_init(struct wpa_authenticator *wpa_auth, const u8 *addr,
471 		  const u8 *p2p_dev_addr);
472 int wpa_auth_sta_associated(struct wpa_authenticator *wpa_auth,
473 			    struct wpa_state_machine *sm);
474 void wpa_auth_sta_no_wpa(struct wpa_state_machine *sm);
475 void wpa_auth_sta_deinit(struct wpa_state_machine *sm);
476 void wpa_receive(struct wpa_authenticator *wpa_auth,
477 		 struct wpa_state_machine *sm,
478 		 u8 *data, size_t data_len);
479 enum wpa_event {
480 	WPA_AUTH, WPA_ASSOC, WPA_DISASSOC, WPA_DEAUTH, WPA_REAUTH,
481 	WPA_REAUTH_EAPOL, WPA_ASSOC_FT, WPA_ASSOC_FILS, WPA_DRV_STA_REMOVED
482 };
483 void wpa_remove_ptk(struct wpa_state_machine *sm);
484 int wpa_auth_sm_event(struct wpa_state_machine *sm, enum wpa_event event);
485 void wpa_auth_sm_notify(struct wpa_state_machine *sm);
486 void wpa_gtk_rekey(struct wpa_authenticator *wpa_auth);
487 int wpa_get_mib(struct wpa_authenticator *wpa_auth, char *buf, size_t buflen);
488 int wpa_get_mib_sta(struct wpa_state_machine *sm, char *buf, size_t buflen);
489 void wpa_auth_countermeasures_start(struct wpa_authenticator *wpa_auth);
490 int wpa_auth_pairwise_set(struct wpa_state_machine *sm);
491 int wpa_auth_get_pairwise(struct wpa_state_machine *sm);
492 const u8 * wpa_auth_get_pmk(struct wpa_state_machine *sm, int *len);
493 const u8 * wpa_auth_get_dpp_pkhash(struct wpa_state_machine *sm);
494 int wpa_auth_sta_key_mgmt(struct wpa_state_machine *sm);
495 int wpa_auth_sta_wpa_version(struct wpa_state_machine *sm);
496 int wpa_auth_sta_ft_tk_already_set(struct wpa_state_machine *sm);
497 int wpa_auth_sta_fils_tk_already_set(struct wpa_state_machine *sm);
498 int wpa_auth_sta_clear_pmksa(struct wpa_state_machine *sm,
499 			     struct rsn_pmksa_cache_entry *entry);
500 struct rsn_pmksa_cache_entry *
501 wpa_auth_sta_get_pmksa(struct wpa_state_machine *sm);
502 void wpa_auth_sta_local_mic_failure_report(struct wpa_state_machine *sm);
503 const u8 * wpa_auth_get_wpa_ie(struct wpa_authenticator *wpa_auth,
504 			       size_t *len);
505 int wpa_auth_pmksa_add(struct wpa_state_machine *sm, const u8 *pmk,
506 		       unsigned int pmk_len,
507 		       int session_timeout, struct eapol_state_machine *eapol);
508 int wpa_auth_pmksa_add_preauth(struct wpa_authenticator *wpa_auth,
509 			       const u8 *pmk, size_t len, const u8 *sta_addr,
510 			       int session_timeout,
511 			       struct eapol_state_machine *eapol);
512 int wpa_auth_pmksa_add_sae(struct wpa_authenticator *wpa_auth, const u8 *addr,
513 			   const u8 *pmk, size_t pmk_len, const u8 *pmkid,
514 			   int akmp, bool is_ml);
515 void wpa_auth_add_sae_pmkid(struct wpa_state_machine *sm, const u8 *pmkid);
516 int wpa_auth_pmksa_add2(struct wpa_authenticator *wpa_auth, const u8 *addr,
517 			const u8 *pmk, size_t pmk_len, const u8 *pmkid,
518 			int session_timeout, int akmp, const u8 *dpp_pkhash,
519 			bool is_ml);
520 void wpa_auth_pmksa_remove(struct wpa_authenticator *wpa_auth,
521 			   const u8 *sta_addr);
522 int wpa_auth_pmksa_list(struct wpa_authenticator *wpa_auth, char *buf,
523 			size_t len);
524 void wpa_auth_pmksa_flush(struct wpa_authenticator *wpa_auth);
525 int wpa_auth_pmksa_list_mesh(struct wpa_authenticator *wpa_auth, const u8 *addr,
526 			     char *buf, size_t len);
527 struct rsn_pmksa_cache_entry *
528 wpa_auth_pmksa_create_entry(const u8 *aa, const u8 *spa, const u8 *pmk,
529 			    size_t pmk_len, int akmp,
530 			    const u8 *pmkid, int expiration);
531 int wpa_auth_pmksa_add_entry(struct wpa_authenticator *wpa_auth,
532 			     struct rsn_pmksa_cache_entry *entry);
533 struct rsn_pmksa_cache *
534 wpa_auth_get_pmksa_cache(struct wpa_authenticator *wpa_auth);
535 struct rsn_pmksa_cache_entry *
536 wpa_auth_pmksa_get(struct wpa_authenticator *wpa_auth, const u8 *sta_addr,
537 		   const u8 *pmkid);
538 int wpa_auth_pmksa_get_pmk(struct wpa_authenticator *wpa_auth,
539 			   const u8 *sta_addr, const u8 **pmk, size_t *pmk_len,
540 			   const u8 **pmkid);
541 struct rsn_pmksa_cache_entry *
542 wpa_auth_pmksa_get_fils_cache_id(struct wpa_authenticator *wpa_auth,
543 				 const u8 *sta_addr, const u8 *pmkid);
544 void wpa_auth_pmksa_set_to_sm(struct rsn_pmksa_cache_entry *pmksa,
545 			      struct wpa_state_machine *sm,
546 			      struct wpa_authenticator *wpa_auth,
547 			      u8 *pmkid, u8 *pmk, size_t *pmk_len);
548 int wpa_auth_sta_set_vlan(struct wpa_state_machine *sm, int vlan_id);
549 void wpa_auth_eapol_key_tx_status(struct wpa_authenticator *wpa_auth,
550 				  struct wpa_state_machine *sm, int ack);
551 
552 #ifdef CONFIG_IEEE80211R_AP
553 u8 * wpa_sm_write_assoc_resp_ies(struct wpa_state_machine *sm, u8 *pos,
554 				 size_t max_len, int auth_alg,
555 				 const u8 *req_ies, size_t req_ies_len,
556 				 int omit_rsnxe);
557 void wpa_ft_process_auth(struct wpa_state_machine *sm,
558 			 u16 auth_transaction, const u8 *ies, size_t ies_len,
559 			 void (*cb)(void *ctx, const u8 *dst,
560 				    u16 auth_transaction, u16 resp,
561 				    const u8 *ies, size_t ies_len),
562 			 void *ctx);
563 int wpa_ft_validate_reassoc(struct wpa_state_machine *sm, const u8 *ies,
564 			    size_t ies_len);
565 int wpa_ft_action_rx(struct wpa_state_machine *sm, const u8 *data, size_t len);
566 int wpa_ft_rrb_rx(struct wpa_authenticator *wpa_auth, const u8 *src_addr,
567 		  const u8 *data, size_t data_len);
568 void wpa_ft_rrb_oui_rx(struct wpa_authenticator *wpa_auth, const u8 *src_addr,
569 		       const u8 *dst_addr, u8 oui_suffix, const u8 *data,
570 		       size_t data_len);
571 void wpa_ft_push_pmk_r1(struct wpa_authenticator *wpa_auth, const u8 *addr);
572 void wpa_ft_deinit(struct wpa_authenticator *wpa_auth);
573 void wpa_ft_sta_deinit(struct wpa_state_machine *sm);
574 int wpa_ft_fetch_pmk_r1(struct wpa_authenticator *wpa_auth,
575 			const u8 *spa, const u8 *pmk_r1_name,
576 			u8 *pmk_r1, size_t *pmk_r1_len, int *pairwise,
577 			struct vlan_description *vlan,
578 			const u8 **identity, size_t *identity_len,
579 			const u8 **radius_cui, size_t *radius_cui_len,
580 			int *session_timeout);
581 
582 #endif /* CONFIG_IEEE80211R_AP */
583 
584 void wpa_wnmsleep_rekey_gtk(struct wpa_state_machine *sm);
585 void wpa_set_wnmsleep(struct wpa_state_machine *sm, int flag);
586 int wpa_wnmsleep_gtk_subelem(struct wpa_state_machine *sm, u8 *pos);
587 int wpa_wnmsleep_igtk_subelem(struct wpa_state_machine *sm, u8 *pos);
588 int wpa_wnmsleep_bigtk_subelem(struct wpa_state_machine *sm, u8 *pos);
589 
590 int wpa_auth_uses_sae(struct wpa_state_machine *sm);
591 int wpa_auth_uses_ft_sae(struct wpa_state_machine *sm);
592 
593 int wpa_auth_get_ip_addr(struct wpa_state_machine *sm, u8 *addr);
594 
595 struct radius_das_attrs;
596 int wpa_auth_radius_das_disconnect_pmksa(struct wpa_authenticator *wpa_auth,
597 					 struct radius_das_attrs *attr);
598 void wpa_auth_reconfig_group_keys(struct wpa_authenticator *wpa_auth);
599 
600 int wpa_auth_ensure_group(struct wpa_authenticator *wpa_auth, int vlan_id);
601 int wpa_auth_release_group(struct wpa_authenticator *wpa_auth, int vlan_id);
602 int fils_auth_pmk_to_ptk(struct wpa_state_machine *sm, const u8 *pmk,
603 			 size_t pmk_len, const u8 *snonce, const u8 *anonce,
604 			 const u8 *dhss, size_t dhss_len,
605 			 struct wpabuf *g_sta, struct wpabuf *g_ap);
606 int fils_decrypt_assoc(struct wpa_state_machine *sm, const u8 *fils_session,
607 		       const struct ieee80211_mgmt *mgmt, size_t frame_len,
608 		       u8 *pos, size_t left);
609 int fils_encrypt_assoc(struct wpa_state_machine *sm, u8 *buf,
610 		       size_t current_len, size_t max_len,
611 		       const struct wpabuf *hlp);
612 int fils_set_tk(struct wpa_state_machine *sm);
613 u8 * hostapd_eid_assoc_fils_session(struct wpa_state_machine *sm, u8 *eid,
614 				    const u8 *fils_session,
615 				    struct wpabuf *fils_hlp_resp);
616 const u8 *  wpa_fils_validate_fils_session(struct wpa_state_machine *sm,
617 					   const u8 *ies, size_t ies_len,
618 					   const u8 *fils_session);
619 int wpa_fils_validate_key_confirm(struct wpa_state_machine *sm, const u8 *ies,
620 				  size_t ies_len);
621 
622 int get_sta_tx_parameters(struct wpa_state_machine *sm, int ap_max_chanwidth,
623 			  int ap_seg1_idx, int *bandwidth, int *seg1_idx);
624 
625 int wpa_auth_write_fte(struct wpa_authenticator *wpa_auth,
626 		       struct wpa_state_machine *sm,
627 		       u8 *buf, size_t len);
628 void wpa_auth_get_fils_aead_params(struct wpa_state_machine *sm,
629 				   u8 *fils_anonce, u8 *fils_snonce,
630 				   u8 *fils_kek, size_t *fils_kek_len);
631 void wpa_auth_add_fils_pmk_pmkid(struct wpa_state_machine *sm, const u8 *pmk,
632 				 size_t pmk_len, const u8 *pmkid);
633 u8 * wpa_auth_write_assoc_resp_owe(struct wpa_state_machine *sm,
634 				   u8 *pos, size_t max_len,
635 				   const u8 *req_ies, size_t req_ies_len);
636 u8 * wpa_auth_write_assoc_resp_fils(struct wpa_state_machine *sm,
637 				    u8 *pos, size_t max_len,
638 				    const u8 *req_ies, size_t req_ies_len);
639 bool wpa_auth_write_fd_rsn_info(struct wpa_authenticator *wpa_auth,
640 				u8 *fd_rsn_info);
641 void wpa_auth_set_auth_alg(struct wpa_state_machine *sm, u16 auth_alg);
642 void wpa_auth_set_rsn_selection(struct wpa_state_machine *sm, const u8 *ie,
643 				size_t len);
644 void wpa_auth_set_dpp_z(struct wpa_state_machine *sm, const struct wpabuf *z);
645 void wpa_auth_set_ssid_protection(struct wpa_state_machine *sm, bool val);
646 void wpa_auth_set_transition_disable(struct wpa_authenticator *wpa_auth,
647 				     u8 val);
648 
649 int wpa_auth_resend_m1(struct wpa_state_machine *sm, int change_anonce,
650 		       void (*cb)(void *ctx1, void *ctx2),
651 		       void *ctx1, void *ctx2);
652 int wpa_auth_resend_m3(struct wpa_state_machine *sm,
653 		       void (*cb)(void *ctx1, void *ctx2),
654 		       void *ctx1, void *ctx2);
655 int wpa_auth_resend_group_m1(struct wpa_state_machine *sm,
656 			     void (*cb)(void *ctx1, void *ctx2),
657 			     void *ctx1, void *ctx2);
658 int wpa_auth_rekey_ptk(struct wpa_authenticator *wpa_auth,
659 		       struct wpa_state_machine *sm);
660 int wpa_auth_rekey_gtk(struct wpa_authenticator *wpa_auth);
661 int hostapd_wpa_auth_send_eapol(void *ctx, const u8 *addr,
662 				const u8 *data, size_t data_len,
663 				int encrypt);
664 void wpa_auth_set_ptk_rekey_timer(struct wpa_state_machine *sm);
665 void wpa_auth_set_ft_rsnxe_used(struct wpa_authenticator *wpa_auth, int val);
666 
667 enum wpa_auth_ocv_override_frame {
668 	WPA_AUTH_OCV_OVERRIDE_EAPOL_M3,
669 	WPA_AUTH_OCV_OVERRIDE_EAPOL_G1,
670 	WPA_AUTH_OCV_OVERRIDE_FT_ASSOC,
671 	WPA_AUTH_OCV_OVERRIDE_FILS_ASSOC,
672 };
673 void wpa_auth_set_ocv_override_freq(struct wpa_authenticator *wpa_auth,
674 				    enum wpa_auth_ocv_override_frame frame,
675 				    unsigned int freq);
676 
677 void wpa_auth_sta_radius_psk_resp(struct wpa_state_machine *sm, bool success);
678 
679 void wpa_auth_set_ml_info(struct wpa_state_machine *sm,
680 			  u8 mld_assoc_link_id, struct mld_info *info);
681 void wpa_auth_ml_get_key_info(struct wpa_authenticator *a,
682 			      struct wpa_auth_ml_link_key_info *info,
683 			      bool mgmt_frame_prot, bool beacon_prot,
684 			      bool rekey);
685 
686 void wpa_release_link_auth_ref(struct wpa_state_machine *sm,
687 			       int release_link_id);
688 
689 #define for_each_sm_auth(sm, link_id) \
690 	for (link_id = 0; link_id < MAX_NUM_MLD_LINKS; link_id++)	\
691 		if (sm->mld_links[link_id].valid &&			\
692 		    sm->mld_links[link_id].wpa_auth &&			\
693 		    sm->wpa_auth != sm->mld_links[link_id].wpa_auth)
694 
wpa_auth_pmf_enabled(struct wpa_auth_config * conf)695 static inline bool wpa_auth_pmf_enabled(struct wpa_auth_config *conf)
696 {
697 	return conf->ieee80211w != NO_MGMT_FRAME_PROTECTION ||
698 		conf->rsn_override_mfp != NO_MGMT_FRAME_PROTECTION ||
699 		conf->rsn_override_mfp_2 != NO_MGMT_FRAME_PROTECTION;
700 }
701 
702 bool wpa_auth_sm_known_sta_identification(struct wpa_state_machine *sm,
703 					  const u8 *timestamp,
704 					  const u8 *mic, size_t mic_len);
705 
706 #endif /* WPA_AUTH_H */
707