blob: 57fda8ae18214d87b743796c2543f1e5eb1280be [file] [log] [blame]
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001/*
2 * hostapd - IEEE 802.11i-2004 / WPA Authenticator
Sunil Ravia04bd252022-05-02 22:54:18 -07003 * Copyright (c) 2004-2022, Jouni Malinen <j@w1.fi>
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004 *
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07007 */
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"
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -070015#include "common/ieee802_11_defs.h"
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070016
Roshan Pius3a1667e2018-07-03 15:17:14 -070017struct vlan_description;
Sunil Ravi2a14cf12023-11-21 00:54:38 +000018struct mld_info;
Roshan Pius3a1667e2018-07-03 15:17:14 -070019
Dmitry Shmidtd80a4012015-11-05 16:35:40 -080020#define MAX_OWN_IE_OVERRIDE 256
21
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070022#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 */
28struct 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
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070043
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070044/* 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
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070051
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070052/* 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 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070064
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070065#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 */
Roshan Pius3a1667e2018-07-03 15:17:14 -070083#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 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070091
92struct ft_rrb_tlv {
93 le16 type;
94 le16 len;
95 /* followed by data of length len */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070096} STRUCT_PACKED;
97
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070098struct ft_rrb_seq {
99 le32 dom;
100 le32 seq;
101 le32 ts;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700102} STRUCT_PACKED;
103
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700104/* session TLVs:
105 * required: PMK_R1, PMK_R1_NAME, PAIRWISE
Roshan Pius3a1667e2018-07-03 15:17:14 -0700106 * optional: VLAN_UNTAGGED, VLAN_TAGGED, EXPIRES_IN, IDENTITY, RADIUS_CUI,
107 * SESSION_TIMEOUT
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700108 *
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 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700136
137#ifdef _MSC_VER
138#pragma pack(pop)
139#endif /* _MSC_VER */
140
141
142/* per STA state machine data */
143
144struct wpa_authenticator;
145struct wpa_state_machine;
146struct rsn_pmksa_cache_entry;
147struct eapol_state_machine;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700148struct ft_remote_seq;
Hai Shalom74f70d42019-02-11 14:42:39 -0800149struct wpa_channel_info;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700150
151
152struct 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;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700157 u8 key[32];
158 struct ft_remote_seq *seq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700159};
160
161
162struct ft_remote_r1kh {
163 struct ft_remote_r1kh *next;
164 u8 addr[ETH_ALEN];
165 u8 id[FT_R1KH_ID_LEN];
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700166 u8 key[32];
167 struct ft_remote_seq *seq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700168};
169
170
171struct wpa_auth_config {
Hai Shalom899fcc72020-10-19 14:38:18 -0700172 void *msg_ctx;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700173 int wpa;
Hai Shalomfdcde762020-04-02 11:19:20 -0700174 int extended_key_id;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700175 int wpa_key_mgmt;
176 int wpa_pairwise;
177 int wpa_group;
178 int wpa_group_rekey;
179 int wpa_strict_rekey;
180 int wpa_gmk_rekey;
181 int wpa_ptk_rekey;
Hai Shalomfdcde762020-04-02 11:19:20 -0700182 int wpa_deny_ptk0_rekey;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800183 u32 wpa_group_update_count;
184 u32 wpa_pairwise_update_count;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700185 int wpa_disable_eapol_key_retries;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700186 int rsn_pairwise;
187 int rsn_preauth;
188 int eapol_version;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700189 int wmm_enabled;
190 int wmm_uapsd;
Dmitry Shmidtc55524a2011-07-07 11:18:38 -0700191 int disable_pmksa_caching;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700192 int okc;
193 int tx_status;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700194 enum mfp_options ieee80211w;
Hai Shalomfdcde762020-04-02 11:19:20 -0700195 int beacon_prot;
Dmitry Shmidtb36ed7c2014-03-17 10:57:26 -0700196 int group_mgmt_cipher;
Roshan Pius3a1667e2018-07-03 15:17:14 -0700197 int sae_require_mfp;
Hai Shalom74f70d42019-02-11 14:42:39 -0800198#ifdef CONFIG_OCV
199 int ocv; /* Operating Channel Validation */
200#endif /* CONFIG_OCV */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800201#ifdef CONFIG_IEEE80211R_AP
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -0700202 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700203 size_t ssid_len;
204 u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
205 u8 r0_key_holder[FT_R0KH_ID_MAX_LEN];
206 size_t r0_key_holder_len;
207 u8 r1_key_holder[FT_R1KH_ID_LEN];
Roshan Pius3a1667e2018-07-03 15:17:14 -0700208 u32 r0_key_lifetime; /* PMK-R0 lifetime seconds */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700209 int rkh_pos_timeout;
210 int rkh_neg_timeout;
211 int rkh_pull_timeout; /* ms */
212 int rkh_pull_retries;
Roshan Pius3a1667e2018-07-03 15:17:14 -0700213 int r1_max_key_lifetime;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700214 u32 reassociation_deadline;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700215 struct ft_remote_r0kh **r0kh_list;
216 struct ft_remote_r1kh **r1kh_list;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700217 int pmk_r1_push;
218 int ft_over_ds;
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800219 int ft_psk_generate_local;
220#endif /* CONFIG_IEEE80211R_AP */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700221 int disable_gtk;
222 int ap_mlme;
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700223#ifdef CONFIG_TESTING_OPTIONS
224 double corrupt_gtk_rekey_mic_probability;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800225 u8 own_ie_override[MAX_OWN_IE_OVERRIDE];
226 size_t own_ie_override_len;
Hai Shalomfdcde762020-04-02 11:19:20 -0700227 u8 rsne_override_eapol[MAX_OWN_IE_OVERRIDE];
228 size_t rsne_override_eapol_len;
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -0800229 u8 rsnxe_override_eapol[MAX_OWN_IE_OVERRIDE];
230 size_t rsnxe_override_eapol_len;
Hai Shalomfdcde762020-04-02 11:19:20 -0700231 u8 rsne_override_ft[MAX_OWN_IE_OVERRIDE];
232 size_t rsne_override_ft_len;
233 u8 rsnxe_override_ft[MAX_OWN_IE_OVERRIDE];
234 size_t rsnxe_override_ft_len;
235 u8 gtk_rsc_override[WPA_KEY_RSC_LEN];
236 u8 igtk_rsc_override[WPA_KEY_RSC_LEN];
237 unsigned int rsne_override_eapol_set:1;
238 unsigned int rsnxe_override_eapol_set:1;
239 unsigned int rsne_override_ft_set:1;
240 unsigned int rsnxe_override_ft_set:1;
241 unsigned int gtk_rsc_override_set:1;
242 unsigned int igtk_rsc_override_set:1;
Hai Shalomb755a2a2020-04-23 21:49:02 -0700243 int ft_rsnxe_used;
Kai Shie75b0652020-11-24 20:31:29 -0800244 unsigned int skip_send_eapol:1;
245 unsigned int enable_eapol_large_timeout:1;
Sunil Ravi38ad1ed2023-01-17 23:58:31 +0000246 bool delay_eapol_tx;
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700247#endif /* CONFIG_TESTING_OPTIONS */
Hai Shalom899fcc72020-10-19 14:38:18 -0700248 unsigned int oci_freq_override_eapol_m3;
249 unsigned int oci_freq_override_eapol_g1;
250 unsigned int oci_freq_override_ft_assoc;
251 unsigned int oci_freq_override_fils_assoc;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800252#ifdef CONFIG_P2P
253 u8 ip_addr_go[4];
254 u8 ip_addr_mask[4];
255 u8 ip_addr_start[4];
256 u8 ip_addr_end[4];
257#endif /* CONFIG_P2P */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700258#ifdef CONFIG_FILS
259 unsigned int fils_cache_id_set:1;
260 u8 fils_cache_id[FILS_CACHE_ID_LEN];
261#endif /* CONFIG_FILS */
Sunil Ravi38ad1ed2023-01-17 23:58:31 +0000262 enum sae_pwe sae_pwe;
Hai Shalom899fcc72020-10-19 14:38:18 -0700263 bool sae_pk;
Hai Shalom60840252021-02-19 19:02:11 -0800264
265 unsigned int secure_ltf:1;
266 unsigned int secure_rtt:1;
267 unsigned int prot_range_neg:1;
268
Hai Shalomfdcde762020-04-02 11:19:20 -0700269 int owe_ptk_workaround;
270 u8 transition_disable;
271#ifdef CONFIG_DPP2
272 int dpp_pfs;
273#endif /* CONFIG_DPP2 */
Hai Shalom60840252021-02-19 19:02:11 -0800274
275 /*
276 * If set Key Derivation Key should be derived as part of PMK to
277 * PTK derivation regardless of advertised capabilities.
278 */
279 bool force_kdk_derivation;
Sunil Ravia04bd252022-05-02 22:54:18 -0700280
281 bool radius_psk;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700282};
283
284typedef enum {
285 LOGGER_DEBUG, LOGGER_INFO, LOGGER_WARNING
286} logger_level;
287
288typedef enum {
289 WPA_EAPOL_portEnabled, WPA_EAPOL_portValid, WPA_EAPOL_authorized,
290 WPA_EAPOL_portControl_Auto, WPA_EAPOL_keyRun, WPA_EAPOL_keyAvailable,
291 WPA_EAPOL_keyDone, WPA_EAPOL_inc_EapolFramesTx
292} wpa_eapol_variable;
293
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000294struct wpa_auth_ml_rsn_info {
295 unsigned int n_mld_links;
296
297 struct wpa_auth_ml_link_rsn_info {
298 unsigned int link_id;
299 const u8 *rsn_ies;
300 size_t rsn_ies_len;
301 } links[MAX_NUM_MLD_LINKS];
302};
303
304struct wpa_auth_ml_key_info {
305 unsigned int n_mld_links;
306 bool mgmt_frame_prot;
307 bool beacon_prot;
308
309 struct wpa_auth_ml_link_key_info {
310 u8 link_id;
311
312 u8 gtkidx;
313 u8 gtk_len;
314 u8 pn[6];
315 const u8 *gtk;
316
317 u8 igtkidx;
318 u8 igtk_len;
319 const u8 *igtk;
320 u8 ipn[6];
321
322 u8 bigtkidx;
323 const u8 *bigtk;
324 u8 bipn[6];
325 } links[MAX_NUM_MLD_LINKS];
326};
327
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700328struct wpa_auth_callbacks {
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700329 void (*logger)(void *ctx, const u8 *addr, logger_level level,
330 const char *txt);
331 void (*disconnect)(void *ctx, const u8 *addr, u16 reason);
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800332 int (*mic_failure_report)(void *ctx, const u8 *addr);
Dmitry Shmidtdda10c22015-03-24 16:05:01 -0700333 void (*psk_failure_report)(void *ctx, const u8 *addr);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700334 void (*set_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var,
335 int value);
336 int (*get_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var);
Dmitry Shmidt391c59f2013-09-03 12:16:28 -0700337 const u8 * (*get_psk)(void *ctx, const u8 *addr, const u8 *p2p_dev_addr,
Hai Shalom021b0b52019-04-10 11:17:58 -0700338 const u8 *prev_psk, size_t *psk_len,
339 int *vlan_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700340 int (*get_msk)(void *ctx, const u8 *addr, u8 *msk, size_t *len);
341 int (*set_key)(void *ctx, int vlan_id, enum wpa_alg alg,
Hai Shalomfdcde762020-04-02 11:19:20 -0700342 const u8 *addr, int idx, u8 *key, size_t key_len,
343 enum key_flag key_flag);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700344 int (*get_seqnum)(void *ctx, const u8 *addr, int idx, u8 *seq);
345 int (*send_eapol)(void *ctx, const u8 *addr, const u8 *data,
346 size_t data_len, int encrypt);
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000347 int (*get_sta_count)(void *ctx);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700348 int (*for_each_sta)(void *ctx, int (*cb)(struct wpa_state_machine *sm,
349 void *ctx), void *cb_ctx);
350 int (*for_each_auth)(void *ctx, int (*cb)(struct wpa_authenticator *a,
351 void *ctx), void *cb_ctx);
352 int (*send_ether)(void *ctx, const u8 *dst, u16 proto, const u8 *data,
353 size_t data_len);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700354 int (*send_oui)(void *ctx, const u8 *dst, u8 oui_suffix, const u8 *data,
355 size_t data_len);
Hai Shalom74f70d42019-02-11 14:42:39 -0800356 int (*channel_info)(void *ctx, struct wpa_channel_info *ci);
Hai Shalom021b0b52019-04-10 11:17:58 -0700357 int (*update_vlan)(void *ctx, const u8 *addr, int vlan_id);
Hai Shalom74f70d42019-02-11 14:42:39 -0800358 int (*get_sta_tx_params)(void *ctx, const u8 *addr,
359 int ap_max_chanwidth, int ap_seg1_idx,
360 int *bandwidth, int *seg1_idx);
Hai Shalom60840252021-02-19 19:02:11 -0800361 void (*store_ptksa)(void *ctx, const u8 *addr, int cipher,
362 u32 life_time, const struct wpa_ptk *ptk);
363 void (*clear_ptksa)(void *ctx, const u8 *addr, int cipher);
Sunil Ravia04bd252022-05-02 22:54:18 -0700364 void (*request_radius_psk)(void *ctx, const u8 *addr, int key_mgmt,
365 const u8 *anonce,
366 const u8 *eapol, size_t eapol_len);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800367#ifdef CONFIG_IEEE80211R_AP
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700368 struct wpa_state_machine * (*add_sta)(void *ctx, const u8 *sta_addr);
Hai Shalomb755a2a2020-04-23 21:49:02 -0700369 int (*add_sta_ft)(void *ctx, const u8 *sta_addr);
Roshan Pius3a1667e2018-07-03 15:17:14 -0700370 int (*set_vlan)(void *ctx, const u8 *sta_addr,
371 struct vlan_description *vlan);
372 int (*get_vlan)(void *ctx, const u8 *sta_addr,
373 struct vlan_description *vlan);
374 int (*set_identity)(void *ctx, const u8 *sta_addr,
375 const u8 *identity, size_t identity_len);
376 size_t (*get_identity)(void *ctx, const u8 *sta_addr, const u8 **buf);
377 int (*set_radius_cui)(void *ctx, const u8 *sta_addr,
378 const u8 *radius_cui, size_t radius_cui_len);
379 size_t (*get_radius_cui)(void *ctx, const u8 *sta_addr, const u8 **buf);
380 void (*set_session_timeout)(void *ctx, const u8 *sta_addr,
381 int session_timeout);
382 int (*get_session_timeout)(void *ctx, const u8 *sta_addr);
383
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700384 int (*send_ft_action)(void *ctx, const u8 *dst,
385 const u8 *data, size_t data_len);
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700386 int (*add_tspec)(void *ctx, const u8 *sta_addr, u8 *tspec_ie,
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800387 size_t tspec_ielen);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800388#endif /* CONFIG_IEEE80211R_AP */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800389#ifdef CONFIG_MESH
390 int (*start_ampe)(void *ctx, const u8 *sta_addr);
391#endif /* CONFIG_MESH */
Sunil Ravi89eba102022-09-13 21:04:37 -0700392#ifdef CONFIG_PASN
393 int (*set_ltf_keyseed)(void *ctx, const u8 *addr, const u8 *ltf_keyseed,
394 size_t ltf_keyseed_len);
395#endif /* CONFIG_PASN */
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000396#ifdef CONFIG_IEEE80211BE
397 int (*get_ml_rsn_info)(void *ctx, struct wpa_auth_ml_rsn_info *info);
398 int (*get_ml_key_info)(void *ctx, struct wpa_auth_ml_key_info *info);
399#endif /* CONFIG_IEEE80211BE */
400 int (*get_drv_flags)(void *ctx, u64 *drv_flags, u64 *drv_flags2);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700401};
402
403struct wpa_authenticator * wpa_init(const u8 *addr,
404 struct wpa_auth_config *conf,
Paul Stewart092955c2017-02-06 09:13:09 -0800405 const struct wpa_auth_callbacks *cb,
406 void *cb_ctx);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800407int wpa_init_keys(struct wpa_authenticator *wpa_auth);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700408void wpa_deinit(struct wpa_authenticator *wpa_auth);
409int wpa_reconfig(struct wpa_authenticator *wpa_auth,
410 struct wpa_auth_config *conf);
411
Hai Shalomfdcde762020-04-02 11:19:20 -0700412enum wpa_validate_result {
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700413 WPA_IE_OK, WPA_INVALID_IE, WPA_INVALID_GROUP, WPA_INVALID_PAIRWISE,
414 WPA_INVALID_AKMP, WPA_NOT_ENABLED, WPA_ALLOC_FAIL,
415 WPA_MGMT_FRAME_PROTECTION_VIOLATION, WPA_INVALID_MGMT_GROUP_CIPHER,
Hai Shalomfdcde762020-04-02 11:19:20 -0700416 WPA_INVALID_MDIE, WPA_INVALID_PROTO, WPA_INVALID_PMKID,
417 WPA_DENIED_OTHER_REASON
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700418};
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800419
Hai Shalomfdcde762020-04-02 11:19:20 -0700420enum wpa_validate_result
421wpa_validate_wpa_ie(struct wpa_authenticator *wpa_auth,
422 struct wpa_state_machine *sm, int freq,
423 const u8 *wpa_ie, size_t wpa_ie_len,
424 const u8 *rsnxe, size_t rsnxe_len,
425 const u8 *mdie, size_t mdie_len,
426 const u8 *owe_dh, size_t owe_dh_len);
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800427int wpa_validate_osen(struct wpa_authenticator *wpa_auth,
428 struct wpa_state_machine *sm,
429 const u8 *osen_ie, size_t osen_ie_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700430int wpa_auth_uses_mfp(struct wpa_state_machine *sm);
Hai Shalom74f70d42019-02-11 14:42:39 -0800431void wpa_auth_set_ocv(struct wpa_state_machine *sm, int ocv);
432int wpa_auth_uses_ocv(struct wpa_state_machine *sm);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700433struct wpa_state_machine *
Dmitry Shmidt391c59f2013-09-03 12:16:28 -0700434wpa_auth_sta_init(struct wpa_authenticator *wpa_auth, const u8 *addr,
435 const u8 *p2p_dev_addr);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700436int wpa_auth_sta_associated(struct wpa_authenticator *wpa_auth,
437 struct wpa_state_machine *sm);
438void wpa_auth_sta_no_wpa(struct wpa_state_machine *sm);
439void wpa_auth_sta_deinit(struct wpa_state_machine *sm);
440void wpa_receive(struct wpa_authenticator *wpa_auth,
441 struct wpa_state_machine *sm,
442 u8 *data, size_t data_len);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800443enum wpa_event {
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700444 WPA_AUTH, WPA_ASSOC, WPA_DISASSOC, WPA_DEAUTH, WPA_REAUTH,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700445 WPA_REAUTH_EAPOL, WPA_ASSOC_FT, WPA_ASSOC_FILS, WPA_DRV_STA_REMOVED
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800446};
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700447void wpa_remove_ptk(struct wpa_state_machine *sm);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800448int wpa_auth_sm_event(struct wpa_state_machine *sm, enum wpa_event event);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700449void wpa_auth_sm_notify(struct wpa_state_machine *sm);
450void wpa_gtk_rekey(struct wpa_authenticator *wpa_auth);
451int wpa_get_mib(struct wpa_authenticator *wpa_auth, char *buf, size_t buflen);
452int wpa_get_mib_sta(struct wpa_state_machine *sm, char *buf, size_t buflen);
453void wpa_auth_countermeasures_start(struct wpa_authenticator *wpa_auth);
454int wpa_auth_pairwise_set(struct wpa_state_machine *sm);
455int wpa_auth_get_pairwise(struct wpa_state_machine *sm);
Hai Shalom74f70d42019-02-11 14:42:39 -0800456const u8 * wpa_auth_get_pmk(struct wpa_state_machine *sm, int *len);
Sunil Ravi38ad1ed2023-01-17 23:58:31 +0000457const u8 * wpa_auth_get_dpp_pkhash(struct wpa_state_machine *sm);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700458int wpa_auth_sta_key_mgmt(struct wpa_state_machine *sm);
459int wpa_auth_sta_wpa_version(struct wpa_state_machine *sm);
Mathy Vanhoeff6e1f662017-07-14 15:15:35 +0200460int wpa_auth_sta_ft_tk_already_set(struct wpa_state_machine *sm);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700461int wpa_auth_sta_fils_tk_already_set(struct wpa_state_machine *sm);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700462int wpa_auth_sta_clear_pmksa(struct wpa_state_machine *sm,
463 struct rsn_pmksa_cache_entry *entry);
464struct rsn_pmksa_cache_entry *
465wpa_auth_sta_get_pmksa(struct wpa_state_machine *sm);
466void wpa_auth_sta_local_mic_failure_report(struct wpa_state_machine *sm);
467const u8 * wpa_auth_get_wpa_ie(struct wpa_authenticator *wpa_auth,
468 size_t *len);
469int wpa_auth_pmksa_add(struct wpa_state_machine *sm, const u8 *pmk,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800470 unsigned int pmk_len,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700471 int session_timeout, struct eapol_state_machine *eapol);
472int wpa_auth_pmksa_add_preauth(struct wpa_authenticator *wpa_auth,
473 const u8 *pmk, size_t len, const u8 *sta_addr,
474 int session_timeout,
475 struct eapol_state_machine *eapol);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800476int wpa_auth_pmksa_add_sae(struct wpa_authenticator *wpa_auth, const u8 *addr,
Sunil Ravi89eba102022-09-13 21:04:37 -0700477 const u8 *pmk, size_t pmk_len, const u8 *pmkid,
478 int akmp);
Roshan Pius3a1667e2018-07-03 15:17:14 -0700479void wpa_auth_add_sae_pmkid(struct wpa_state_machine *sm, const u8 *pmkid);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700480int wpa_auth_pmksa_add2(struct wpa_authenticator *wpa_auth, const u8 *addr,
481 const u8 *pmk, size_t pmk_len, const u8 *pmkid,
Sunil Ravieb83e2a2024-06-28 17:34:56 +0000482 int session_timeout, int akmp);
483int wpa_auth_pmksa_add3(struct wpa_authenticator *wpa_auth, const u8 *addr,
484 const u8 *pmk, size_t pmk_len, const u8 *pmkid,
Sunil Ravi38ad1ed2023-01-17 23:58:31 +0000485 int session_timeout, int akmp, const u8 *dpp_pkhash);
Dmitry Shmidtf7e0a992013-05-23 11:03:10 -0700486void wpa_auth_pmksa_remove(struct wpa_authenticator *wpa_auth,
487 const u8 *sta_addr);
Dmitry Shmidte4663042016-04-04 10:07:49 -0700488int wpa_auth_pmksa_list(struct wpa_authenticator *wpa_auth, char *buf,
489 size_t len);
490void wpa_auth_pmksa_flush(struct wpa_authenticator *wpa_auth);
Paul Stewart092955c2017-02-06 09:13:09 -0800491int wpa_auth_pmksa_list_mesh(struct wpa_authenticator *wpa_auth, const u8 *addr,
492 char *buf, size_t len);
493struct rsn_pmksa_cache_entry *
494wpa_auth_pmksa_create_entry(const u8 *aa, const u8 *spa, const u8 *pmk,
Sunil Ravi89eba102022-09-13 21:04:37 -0700495 size_t pmk_len, int akmp,
Paul Stewart092955c2017-02-06 09:13:09 -0800496 const u8 *pmkid, int expiration);
497int wpa_auth_pmksa_add_entry(struct wpa_authenticator *wpa_auth,
498 struct rsn_pmksa_cache_entry *entry);
Sunil Ravi38ad1ed2023-01-17 23:58:31 +0000499struct rsn_pmksa_cache *
500wpa_auth_get_pmksa_cache(struct wpa_authenticator *wpa_auth);
Dmitry Shmidte4663042016-04-04 10:07:49 -0700501struct rsn_pmksa_cache_entry *
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800502wpa_auth_pmksa_get(struct wpa_authenticator *wpa_auth, const u8 *sta_addr,
503 const u8 *pmkid);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700504struct rsn_pmksa_cache_entry *
505wpa_auth_pmksa_get_fils_cache_id(struct wpa_authenticator *wpa_auth,
506 const u8 *sta_addr, const u8 *pmkid);
Dmitry Shmidte4663042016-04-04 10:07:49 -0700507void wpa_auth_pmksa_set_to_sm(struct rsn_pmksa_cache_entry *pmksa,
508 struct wpa_state_machine *sm,
509 struct wpa_authenticator *wpa_auth,
Sunil Ravieb83e2a2024-06-28 17:34:56 +0000510 u8 *pmkid, u8 *pmk);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700511int wpa_auth_sta_set_vlan(struct wpa_state_machine *sm, int vlan_id);
512void wpa_auth_eapol_key_tx_status(struct wpa_authenticator *wpa_auth,
513 struct wpa_state_machine *sm, int ack);
514
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800515#ifdef CONFIG_IEEE80211R_AP
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700516u8 * wpa_sm_write_assoc_resp_ies(struct wpa_state_machine *sm, u8 *pos,
517 size_t max_len, int auth_alg,
Hai Shalomfdcde762020-04-02 11:19:20 -0700518 const u8 *req_ies, size_t req_ies_len,
519 int omit_rsnxe);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700520void wpa_ft_process_auth(struct wpa_state_machine *sm, const u8 *bssid,
521 u16 auth_transaction, const u8 *ies, size_t ies_len,
522 void (*cb)(void *ctx, const u8 *dst, const u8 *bssid,
523 u16 auth_transaction, u16 resp,
524 const u8 *ies, size_t ies_len),
525 void *ctx);
Hai Shalomb755a2a2020-04-23 21:49:02 -0700526int wpa_ft_validate_reassoc(struct wpa_state_machine *sm, const u8 *ies,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700527 size_t ies_len);
528int wpa_ft_action_rx(struct wpa_state_machine *sm, const u8 *data, size_t len);
529int wpa_ft_rrb_rx(struct wpa_authenticator *wpa_auth, const u8 *src_addr,
530 const u8 *data, size_t data_len);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700531void wpa_ft_rrb_oui_rx(struct wpa_authenticator *wpa_auth, const u8 *src_addr,
532 const u8 *dst_addr, u8 oui_suffix, const u8 *data,
533 size_t data_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700534void wpa_ft_push_pmk_r1(struct wpa_authenticator *wpa_auth, const u8 *addr);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700535void wpa_ft_deinit(struct wpa_authenticator *wpa_auth);
536void wpa_ft_sta_deinit(struct wpa_state_machine *sm);
Hai Shalom60840252021-02-19 19:02:11 -0800537int wpa_ft_fetch_pmk_r1(struct wpa_authenticator *wpa_auth,
538 const u8 *spa, const u8 *pmk_r1_name,
539 u8 *pmk_r1, size_t *pmk_r1_len, int *pairwise,
540 struct vlan_description *vlan,
541 const u8 **identity, size_t *identity_len,
542 const u8 **radius_cui, size_t *radius_cui_len,
543 int *session_timeout);
544
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800545#endif /* CONFIG_IEEE80211R_AP */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700546
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700547void wpa_wnmsleep_rekey_gtk(struct wpa_state_machine *sm);
548void wpa_set_wnmsleep(struct wpa_state_machine *sm, int flag);
549int wpa_wnmsleep_gtk_subelem(struct wpa_state_machine *sm, u8 *pos);
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700550int wpa_wnmsleep_igtk_subelem(struct wpa_state_machine *sm, u8 *pos);
Hai Shalomfdcde762020-04-02 11:19:20 -0700551int wpa_wnmsleep_bigtk_subelem(struct wpa_state_machine *sm, u8 *pos);
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700552
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800553int wpa_auth_uses_sae(struct wpa_state_machine *sm);
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800554int wpa_auth_uses_ft_sae(struct wpa_state_machine *sm);
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800555
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800556int wpa_auth_get_ip_addr(struct wpa_state_machine *sm, u8 *addr);
557
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800558struct radius_das_attrs;
559int wpa_auth_radius_das_disconnect_pmksa(struct wpa_authenticator *wpa_auth,
560 struct radius_das_attrs *attr);
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800561void wpa_auth_reconfig_group_keys(struct wpa_authenticator *wpa_auth);
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800562
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800563int wpa_auth_ensure_group(struct wpa_authenticator *wpa_auth, int vlan_id);
564int wpa_auth_release_group(struct wpa_authenticator *wpa_auth, int vlan_id);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800565int fils_auth_pmk_to_ptk(struct wpa_state_machine *sm, const u8 *pmk,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700566 size_t pmk_len, const u8 *snonce, const u8 *anonce,
567 const u8 *dhss, size_t dhss_len,
568 struct wpabuf *g_sta, struct wpabuf *g_ap);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800569int fils_decrypt_assoc(struct wpa_state_machine *sm, const u8 *fils_session,
570 const struct ieee80211_mgmt *mgmt, size_t frame_len,
571 u8 *pos, size_t left);
572int fils_encrypt_assoc(struct wpa_state_machine *sm, u8 *buf,
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800573 size_t current_len, size_t max_len,
574 const struct wpabuf *hlp);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800575int fils_set_tk(struct wpa_state_machine *sm);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700576u8 * hostapd_eid_assoc_fils_session(struct wpa_state_machine *sm, u8 *eid,
577 const u8 *fils_session,
578 struct wpabuf *fils_hlp_resp);
579const u8 * wpa_fils_validate_fils_session(struct wpa_state_machine *sm,
580 const u8 *ies, size_t ies_len,
581 const u8 *fils_session);
582int wpa_fils_validate_key_confirm(struct wpa_state_machine *sm, const u8 *ies,
583 size_t ies_len);
584
Hai Shalom74f70d42019-02-11 14:42:39 -0800585int get_sta_tx_parameters(struct wpa_state_machine *sm, int ap_max_chanwidth,
586 int ap_seg1_idx, int *bandwidth, int *seg1_idx);
587
Sunil Ravi38ad1ed2023-01-17 23:58:31 +0000588int wpa_auth_write_fte(struct wpa_authenticator *wpa_auth,
589 struct wpa_state_machine *sm,
Roshan Pius3a1667e2018-07-03 15:17:14 -0700590 u8 *buf, size_t len);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700591void wpa_auth_get_fils_aead_params(struct wpa_state_machine *sm,
592 u8 *fils_anonce, u8 *fils_snonce,
593 u8 *fils_kek, size_t *fils_kek_len);
Hai Shalom81f62d82019-07-22 12:10:00 -0700594void wpa_auth_add_fils_pmk_pmkid(struct wpa_state_machine *sm, const u8 *pmk,
595 size_t pmk_len, const u8 *pmkid);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700596u8 * wpa_auth_write_assoc_resp_owe(struct wpa_state_machine *sm,
597 u8 *pos, size_t max_len,
598 const u8 *req_ies, size_t req_ies_len);
Hai Shalom81f62d82019-07-22 12:10:00 -0700599u8 * wpa_auth_write_assoc_resp_fils(struct wpa_state_machine *sm,
600 u8 *pos, size_t max_len,
601 const u8 *req_ies, size_t req_ies_len);
Hai Shalom60840252021-02-19 19:02:11 -0800602bool wpa_auth_write_fd_rsn_info(struct wpa_authenticator *wpa_auth,
603 u8 *fd_rsn_info);
Hai Shalom021b0b52019-04-10 11:17:58 -0700604void wpa_auth_set_auth_alg(struct wpa_state_machine *sm, u16 auth_alg);
605void wpa_auth_set_dpp_z(struct wpa_state_machine *sm, const struct wpabuf *z);
Hai Shalom899fcc72020-10-19 14:38:18 -0700606void wpa_auth_set_transition_disable(struct wpa_authenticator *wpa_auth,
607 u8 val);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700608
609int wpa_auth_resend_m1(struct wpa_state_machine *sm, int change_anonce,
610 void (*cb)(void *ctx1, void *ctx2),
611 void *ctx1, void *ctx2);
612int wpa_auth_resend_m3(struct wpa_state_machine *sm,
613 void (*cb)(void *ctx1, void *ctx2),
614 void *ctx1, void *ctx2);
615int wpa_auth_resend_group_m1(struct wpa_state_machine *sm,
616 void (*cb)(void *ctx1, void *ctx2),
617 void *ctx1, void *ctx2);
Hai Shaloma20dcd72022-02-04 13:43:00 -0800618int wpa_auth_rekey_ptk(struct wpa_authenticator *wpa_auth,
619 struct wpa_state_machine *sm);
Roshan Pius3a1667e2018-07-03 15:17:14 -0700620int wpa_auth_rekey_gtk(struct wpa_authenticator *wpa_auth);
Hai Shaloma20dcd72022-02-04 13:43:00 -0800621int hostapd_wpa_auth_send_eapol(void *ctx, const u8 *addr,
622 const u8 *data, size_t data_len,
623 int encrypt);
Hai Shalom81f62d82019-07-22 12:10:00 -0700624void wpa_auth_set_ptk_rekey_timer(struct wpa_state_machine *sm);
Hai Shalomb755a2a2020-04-23 21:49:02 -0700625void wpa_auth_set_ft_rsnxe_used(struct wpa_authenticator *wpa_auth, int val);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800626
Hai Shalom899fcc72020-10-19 14:38:18 -0700627enum wpa_auth_ocv_override_frame {
628 WPA_AUTH_OCV_OVERRIDE_EAPOL_M3,
629 WPA_AUTH_OCV_OVERRIDE_EAPOL_G1,
630 WPA_AUTH_OCV_OVERRIDE_FT_ASSOC,
631 WPA_AUTH_OCV_OVERRIDE_FILS_ASSOC,
632};
633void wpa_auth_set_ocv_override_freq(struct wpa_authenticator *wpa_auth,
634 enum wpa_auth_ocv_override_frame frame,
635 unsigned int freq);
Kai Shie75b0652020-11-24 20:31:29 -0800636void wpa_auth_set_skip_send_eapol(struct wpa_authenticator *wpa_auth,
637 u8 val);
638void wpa_auth_set_enable_eapol_large_timeout(struct wpa_authenticator *wpa_auth,
639 u8 val);
Hai Shalom899fcc72020-10-19 14:38:18 -0700640
Sunil Ravia04bd252022-05-02 22:54:18 -0700641void wpa_auth_sta_radius_psk_resp(struct wpa_state_machine *sm, bool success);
642
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000643void wpa_auth_set_ml_info(struct wpa_state_machine *sm, const u8 *mld_addr,
644 u8 mld_assoc_link_id, struct mld_info *info);
645void wpa_auth_ml_get_rsn_info(struct wpa_authenticator *a,
646 struct wpa_auth_ml_link_rsn_info *info);
647void wpa_auth_ml_get_key_info(struct wpa_authenticator *a,
648 struct wpa_auth_ml_link_key_info *info,
649 bool mgmt_frame_prot, bool beacon_prot);
650
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700651#endif /* WPA_AUTH_H */