blob: 3b32fe390b9fec8e29ad3ab83a6078c33d9e8b15 [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;
18
Dmitry Shmidtd80a4012015-11-05 16:35:40 -080019#define MAX_OWN_IE_OVERRIDE 256
20
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070021#ifdef _MSC_VER
22#pragma pack(push, 1)
23#endif /* _MSC_VER */
24
25/* IEEE Std 802.11r-2008, 11A.10.3 - Remote request/response frame definition
26 */
27struct ft_rrb_frame {
28 u8 frame_type; /* RSN_REMOTE_FRAME_TYPE_FT_RRB */
29 u8 packet_type; /* FT_PACKET_REQUEST/FT_PACKET_RESPONSE */
30 le16 action_length; /* little endian length of action_frame */
31 u8 ap_address[ETH_ALEN];
32 /*
33 * Followed by action_length bytes of FT Action frame (from Category
34 * field to the end of Action Frame body.
35 */
36} STRUCT_PACKED;
37
38#define RSN_REMOTE_FRAME_TYPE_FT_RRB 1
39
40#define FT_PACKET_REQUEST 0
41#define FT_PACKET_RESPONSE 1
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070042
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070043/* Vendor-specific types for R0KH-R1KH protocol; not defined in 802.11r. These
44 * use OUI Extended EtherType as the encapsulating format. */
45#define FT_PACKET_R0KH_R1KH_PULL 0x01
46#define FT_PACKET_R0KH_R1KH_RESP 0x02
47#define FT_PACKET_R0KH_R1KH_PUSH 0x03
48#define FT_PACKET_R0KH_R1KH_SEQ_REQ 0x04
49#define FT_PACKET_R0KH_R1KH_SEQ_RESP 0x05
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070050
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070051/* packet layout
52 * IEEE 802 extended OUI ethertype frame header
53 * u16 authlen (little endian)
54 * multiple of struct ft_rrb_tlv (authenticated only, length = authlen)
55 * multiple of struct ft_rrb_tlv (AES-SIV encrypted, AES-SIV needs an extra
56 * blocksize length)
57 *
58 * AES-SIV AAD;
59 * source MAC address (6)
60 * authenticated-only TLVs (authlen)
61 * subtype (1; FT_PACKET_*)
62 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070063
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070064#define FT_RRB_NONCE_LEN 16
65
66#define FT_RRB_LAST_EMPTY 0 /* placeholder or padding */
67
68#define FT_RRB_SEQ 1 /* struct ft_rrb_seq */
69#define FT_RRB_NONCE 2 /* size FT_RRB_NONCE_LEN */
70#define FT_RRB_TIMESTAMP 3 /* le32 unix seconds */
71
72#define FT_RRB_R0KH_ID 4 /* FT_R0KH_ID_MAX_LEN */
73#define FT_RRB_R1KH_ID 5 /* FT_R1KH_ID_LEN */
74#define FT_RRB_S1KH_ID 6 /* ETH_ALEN */
75
76#define FT_RRB_PMK_R0_NAME 7 /* WPA_PMK_NAME_LEN */
77#define FT_RRB_PMK_R0 8 /* PMK_LEN */
78#define FT_RRB_PMK_R1_NAME 9 /* WPA_PMK_NAME_LEN */
79#define FT_RRB_PMK_R1 10 /* PMK_LEN */
80
81#define FT_RRB_PAIRWISE 11 /* le16 */
Roshan Pius3a1667e2018-07-03 15:17:14 -070082#define FT_RRB_EXPIRES_IN 12 /* le16 seconds */
83
84#define FT_RRB_VLAN_UNTAGGED 13 /* le16 */
85#define FT_RRB_VLAN_TAGGED 14 /* n times le16 */
86
87#define FT_RRB_IDENTITY 15
88#define FT_RRB_RADIUS_CUI 16
89#define FT_RRB_SESSION_TIMEOUT 17 /* le32 seconds */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070090
91struct ft_rrb_tlv {
92 le16 type;
93 le16 len;
94 /* followed by data of length len */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070095} STRUCT_PACKED;
96
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070097struct ft_rrb_seq {
98 le32 dom;
99 le32 seq;
100 le32 ts;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700101} STRUCT_PACKED;
102
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700103/* session TLVs:
104 * required: PMK_R1, PMK_R1_NAME, PAIRWISE
Roshan Pius3a1667e2018-07-03 15:17:14 -0700105 * optional: VLAN_UNTAGGED, VLAN_TAGGED, EXPIRES_IN, IDENTITY, RADIUS_CUI,
106 * SESSION_TIMEOUT
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700107 *
108 * pull frame TLVs:
109 * auth:
110 * required: SEQ, NONCE, R0KH_ID, R1KH_ID
111 * encrypted:
112 * required: PMK_R0_NAME, S1KH_ID
113 *
114 * response frame TLVs:
115 * auth:
116 * required: SEQ, NONCE, R0KH_ID, R1KH_ID
117 * encrypted:
118 * required: S1KH_ID
119 * optional: session TLVs
120 *
121 * push frame TLVs:
122 * auth:
123 * required: SEQ, R0KH_ID, R1KH_ID
124 * encrypted:
125 * required: S1KH_ID, PMK_R0_NAME, session TLVs
126 *
127 * sequence number request frame TLVs:
128 * auth:
129 * required: R0KH_ID, R1KH_ID, NONCE
130 *
131 * sequence number response frame TLVs:
132 * auth:
133 * required: SEQ, NONCE, R0KH_ID, R1KH_ID
134 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700135
136#ifdef _MSC_VER
137#pragma pack(pop)
138#endif /* _MSC_VER */
139
140
141/* per STA state machine data */
142
143struct wpa_authenticator;
144struct wpa_state_machine;
145struct rsn_pmksa_cache_entry;
146struct eapol_state_machine;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700147struct ft_remote_seq;
Hai Shalom74f70d42019-02-11 14:42:39 -0800148struct wpa_channel_info;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700149
150
151struct ft_remote_r0kh {
152 struct ft_remote_r0kh *next;
153 u8 addr[ETH_ALEN];
154 u8 id[FT_R0KH_ID_MAX_LEN];
155 size_t id_len;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700156 u8 key[32];
157 struct ft_remote_seq *seq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700158};
159
160
161struct ft_remote_r1kh {
162 struct ft_remote_r1kh *next;
163 u8 addr[ETH_ALEN];
164 u8 id[FT_R1KH_ID_LEN];
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700165 u8 key[32];
166 struct ft_remote_seq *seq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700167};
168
169
170struct wpa_auth_config {
Hai Shalom899fcc72020-10-19 14:38:18 -0700171 void *msg_ctx;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700172 int wpa;
Hai Shalomfdcde762020-04-02 11:19:20 -0700173 int extended_key_id;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700174 int wpa_key_mgmt;
175 int wpa_pairwise;
176 int wpa_group;
177 int wpa_group_rekey;
178 int wpa_strict_rekey;
179 int wpa_gmk_rekey;
180 int wpa_ptk_rekey;
Hai Shalomfdcde762020-04-02 11:19:20 -0700181 int wpa_deny_ptk0_rekey;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800182 u32 wpa_group_update_count;
183 u32 wpa_pairwise_update_count;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700184 int wpa_disable_eapol_key_retries;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700185 int rsn_pairwise;
186 int rsn_preauth;
187 int eapol_version;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700188 int wmm_enabled;
189 int wmm_uapsd;
Dmitry Shmidtc55524a2011-07-07 11:18:38 -0700190 int disable_pmksa_caching;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700191 int okc;
192 int tx_status;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700193 enum mfp_options ieee80211w;
Hai Shalomfdcde762020-04-02 11:19:20 -0700194 int beacon_prot;
Dmitry Shmidtb36ed7c2014-03-17 10:57:26 -0700195 int group_mgmt_cipher;
Roshan Pius3a1667e2018-07-03 15:17:14 -0700196 int sae_require_mfp;
Hai Shalom74f70d42019-02-11 14:42:39 -0800197#ifdef CONFIG_OCV
198 int ocv; /* Operating Channel Validation */
199#endif /* CONFIG_OCV */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800200#ifdef CONFIG_IEEE80211R_AP
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -0700201 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700202 size_t ssid_len;
203 u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
204 u8 r0_key_holder[FT_R0KH_ID_MAX_LEN];
205 size_t r0_key_holder_len;
206 u8 r1_key_holder[FT_R1KH_ID_LEN];
Roshan Pius3a1667e2018-07-03 15:17:14 -0700207 u32 r0_key_lifetime; /* PMK-R0 lifetime seconds */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700208 int rkh_pos_timeout;
209 int rkh_neg_timeout;
210 int rkh_pull_timeout; /* ms */
211 int rkh_pull_retries;
Roshan Pius3a1667e2018-07-03 15:17:14 -0700212 int r1_max_key_lifetime;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700213 u32 reassociation_deadline;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700214 struct ft_remote_r0kh **r0kh_list;
215 struct ft_remote_r1kh **r1kh_list;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700216 int pmk_r1_push;
217 int ft_over_ds;
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800218 int ft_psk_generate_local;
219#endif /* CONFIG_IEEE80211R_AP */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700220 int disable_gtk;
221 int ap_mlme;
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700222#ifdef CONFIG_TESTING_OPTIONS
223 double corrupt_gtk_rekey_mic_probability;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800224 u8 own_ie_override[MAX_OWN_IE_OVERRIDE];
225 size_t own_ie_override_len;
Hai Shalomfdcde762020-04-02 11:19:20 -0700226 u8 rsne_override_eapol[MAX_OWN_IE_OVERRIDE];
227 size_t rsne_override_eapol_len;
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -0800228 u8 rsnxe_override_eapol[MAX_OWN_IE_OVERRIDE];
229 size_t rsnxe_override_eapol_len;
Hai Shalomfdcde762020-04-02 11:19:20 -0700230 u8 rsne_override_ft[MAX_OWN_IE_OVERRIDE];
231 size_t rsne_override_ft_len;
232 u8 rsnxe_override_ft[MAX_OWN_IE_OVERRIDE];
233 size_t rsnxe_override_ft_len;
234 u8 gtk_rsc_override[WPA_KEY_RSC_LEN];
235 u8 igtk_rsc_override[WPA_KEY_RSC_LEN];
236 unsigned int rsne_override_eapol_set:1;
237 unsigned int rsnxe_override_eapol_set:1;
238 unsigned int rsne_override_ft_set:1;
239 unsigned int rsnxe_override_ft_set:1;
240 unsigned int gtk_rsc_override_set:1;
241 unsigned int igtk_rsc_override_set:1;
Hai Shalomb755a2a2020-04-23 21:49:02 -0700242 int ft_rsnxe_used;
Kai Shie75b0652020-11-24 20:31:29 -0800243 unsigned int skip_send_eapol:1;
244 unsigned int enable_eapol_large_timeout:1;
Sunil Ravi38ad1ed2023-01-17 23:58:31 +0000245 bool delay_eapol_tx;
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700246#endif /* CONFIG_TESTING_OPTIONS */
Hai Shalom899fcc72020-10-19 14:38:18 -0700247 unsigned int oci_freq_override_eapol_m3;
248 unsigned int oci_freq_override_eapol_g1;
249 unsigned int oci_freq_override_ft_assoc;
250 unsigned int oci_freq_override_fils_assoc;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800251#ifdef CONFIG_P2P
252 u8 ip_addr_go[4];
253 u8 ip_addr_mask[4];
254 u8 ip_addr_start[4];
255 u8 ip_addr_end[4];
256#endif /* CONFIG_P2P */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700257#ifdef CONFIG_FILS
258 unsigned int fils_cache_id_set:1;
259 u8 fils_cache_id[FILS_CACHE_ID_LEN];
260#endif /* CONFIG_FILS */
Sunil Ravi38ad1ed2023-01-17 23:58:31 +0000261 enum sae_pwe sae_pwe;
Hai Shalom899fcc72020-10-19 14:38:18 -0700262 bool sae_pk;
Hai Shalom60840252021-02-19 19:02:11 -0800263
264 unsigned int secure_ltf:1;
265 unsigned int secure_rtt:1;
266 unsigned int prot_range_neg:1;
267
Hai Shalomfdcde762020-04-02 11:19:20 -0700268 int owe_ptk_workaround;
269 u8 transition_disable;
270#ifdef CONFIG_DPP2
271 int dpp_pfs;
272#endif /* CONFIG_DPP2 */
Hai Shalom60840252021-02-19 19:02:11 -0800273
274 /*
275 * If set Key Derivation Key should be derived as part of PMK to
276 * PTK derivation regardless of advertised capabilities.
277 */
278 bool force_kdk_derivation;
Sunil Ravia04bd252022-05-02 22:54:18 -0700279
280 bool radius_psk;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700281};
282
283typedef enum {
284 LOGGER_DEBUG, LOGGER_INFO, LOGGER_WARNING
285} logger_level;
286
287typedef enum {
288 WPA_EAPOL_portEnabled, WPA_EAPOL_portValid, WPA_EAPOL_authorized,
289 WPA_EAPOL_portControl_Auto, WPA_EAPOL_keyRun, WPA_EAPOL_keyAvailable,
290 WPA_EAPOL_keyDone, WPA_EAPOL_inc_EapolFramesTx
291} wpa_eapol_variable;
292
293struct wpa_auth_callbacks {
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700294 void (*logger)(void *ctx, const u8 *addr, logger_level level,
295 const char *txt);
296 void (*disconnect)(void *ctx, const u8 *addr, u16 reason);
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800297 int (*mic_failure_report)(void *ctx, const u8 *addr);
Dmitry Shmidtdda10c22015-03-24 16:05:01 -0700298 void (*psk_failure_report)(void *ctx, const u8 *addr);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700299 void (*set_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var,
300 int value);
301 int (*get_eapol)(void *ctx, const u8 *addr, wpa_eapol_variable var);
Dmitry Shmidt391c59f2013-09-03 12:16:28 -0700302 const u8 * (*get_psk)(void *ctx, const u8 *addr, const u8 *p2p_dev_addr,
Hai Shalom021b0b52019-04-10 11:17:58 -0700303 const u8 *prev_psk, size_t *psk_len,
304 int *vlan_id);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700305 int (*get_msk)(void *ctx, const u8 *addr, u8 *msk, size_t *len);
306 int (*set_key)(void *ctx, int vlan_id, enum wpa_alg alg,
Hai Shalomfdcde762020-04-02 11:19:20 -0700307 const u8 *addr, int idx, u8 *key, size_t key_len,
308 enum key_flag key_flag);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700309 int (*get_seqnum)(void *ctx, const u8 *addr, int idx, u8 *seq);
310 int (*send_eapol)(void *ctx, const u8 *addr, const u8 *data,
311 size_t data_len, int encrypt);
312 int (*for_each_sta)(void *ctx, int (*cb)(struct wpa_state_machine *sm,
313 void *ctx), void *cb_ctx);
314 int (*for_each_auth)(void *ctx, int (*cb)(struct wpa_authenticator *a,
315 void *ctx), void *cb_ctx);
316 int (*send_ether)(void *ctx, const u8 *dst, u16 proto, const u8 *data,
317 size_t data_len);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700318 int (*send_oui)(void *ctx, const u8 *dst, u8 oui_suffix, const u8 *data,
319 size_t data_len);
Hai Shalom74f70d42019-02-11 14:42:39 -0800320 int (*channel_info)(void *ctx, struct wpa_channel_info *ci);
Hai Shalom021b0b52019-04-10 11:17:58 -0700321 int (*update_vlan)(void *ctx, const u8 *addr, int vlan_id);
Hai Shalom74f70d42019-02-11 14:42:39 -0800322 int (*get_sta_tx_params)(void *ctx, const u8 *addr,
323 int ap_max_chanwidth, int ap_seg1_idx,
324 int *bandwidth, int *seg1_idx);
Hai Shalom60840252021-02-19 19:02:11 -0800325 void (*store_ptksa)(void *ctx, const u8 *addr, int cipher,
326 u32 life_time, const struct wpa_ptk *ptk);
327 void (*clear_ptksa)(void *ctx, const u8 *addr, int cipher);
Sunil Ravia04bd252022-05-02 22:54:18 -0700328 void (*request_radius_psk)(void *ctx, const u8 *addr, int key_mgmt,
329 const u8 *anonce,
330 const u8 *eapol, size_t eapol_len);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800331#ifdef CONFIG_IEEE80211R_AP
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700332 struct wpa_state_machine * (*add_sta)(void *ctx, const u8 *sta_addr);
Hai Shalomb755a2a2020-04-23 21:49:02 -0700333 int (*add_sta_ft)(void *ctx, const u8 *sta_addr);
Roshan Pius3a1667e2018-07-03 15:17:14 -0700334 int (*set_vlan)(void *ctx, const u8 *sta_addr,
335 struct vlan_description *vlan);
336 int (*get_vlan)(void *ctx, const u8 *sta_addr,
337 struct vlan_description *vlan);
338 int (*set_identity)(void *ctx, const u8 *sta_addr,
339 const u8 *identity, size_t identity_len);
340 size_t (*get_identity)(void *ctx, const u8 *sta_addr, const u8 **buf);
341 int (*set_radius_cui)(void *ctx, const u8 *sta_addr,
342 const u8 *radius_cui, size_t radius_cui_len);
343 size_t (*get_radius_cui)(void *ctx, const u8 *sta_addr, const u8 **buf);
344 void (*set_session_timeout)(void *ctx, const u8 *sta_addr,
345 int session_timeout);
346 int (*get_session_timeout)(void *ctx, const u8 *sta_addr);
347
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700348 int (*send_ft_action)(void *ctx, const u8 *dst,
349 const u8 *data, size_t data_len);
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700350 int (*add_tspec)(void *ctx, const u8 *sta_addr, u8 *tspec_ie,
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800351 size_t tspec_ielen);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800352#endif /* CONFIG_IEEE80211R_AP */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800353#ifdef CONFIG_MESH
354 int (*start_ampe)(void *ctx, const u8 *sta_addr);
355#endif /* CONFIG_MESH */
Sunil Ravi89eba102022-09-13 21:04:37 -0700356#ifdef CONFIG_PASN
357 int (*set_ltf_keyseed)(void *ctx, const u8 *addr, const u8 *ltf_keyseed,
358 size_t ltf_keyseed_len);
359#endif /* CONFIG_PASN */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700360};
361
362struct wpa_authenticator * wpa_init(const u8 *addr,
363 struct wpa_auth_config *conf,
Paul Stewart092955c2017-02-06 09:13:09 -0800364 const struct wpa_auth_callbacks *cb,
365 void *cb_ctx);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800366int wpa_init_keys(struct wpa_authenticator *wpa_auth);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700367void wpa_deinit(struct wpa_authenticator *wpa_auth);
368int wpa_reconfig(struct wpa_authenticator *wpa_auth,
369 struct wpa_auth_config *conf);
370
Hai Shalomfdcde762020-04-02 11:19:20 -0700371enum wpa_validate_result {
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700372 WPA_IE_OK, WPA_INVALID_IE, WPA_INVALID_GROUP, WPA_INVALID_PAIRWISE,
373 WPA_INVALID_AKMP, WPA_NOT_ENABLED, WPA_ALLOC_FAIL,
374 WPA_MGMT_FRAME_PROTECTION_VIOLATION, WPA_INVALID_MGMT_GROUP_CIPHER,
Hai Shalomfdcde762020-04-02 11:19:20 -0700375 WPA_INVALID_MDIE, WPA_INVALID_PROTO, WPA_INVALID_PMKID,
376 WPA_DENIED_OTHER_REASON
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700377};
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800378
Hai Shalomfdcde762020-04-02 11:19:20 -0700379enum wpa_validate_result
380wpa_validate_wpa_ie(struct wpa_authenticator *wpa_auth,
381 struct wpa_state_machine *sm, int freq,
382 const u8 *wpa_ie, size_t wpa_ie_len,
383 const u8 *rsnxe, size_t rsnxe_len,
384 const u8 *mdie, size_t mdie_len,
385 const u8 *owe_dh, size_t owe_dh_len);
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800386int wpa_validate_osen(struct wpa_authenticator *wpa_auth,
387 struct wpa_state_machine *sm,
388 const u8 *osen_ie, size_t osen_ie_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700389int wpa_auth_uses_mfp(struct wpa_state_machine *sm);
Hai Shalom74f70d42019-02-11 14:42:39 -0800390void wpa_auth_set_ocv(struct wpa_state_machine *sm, int ocv);
391int wpa_auth_uses_ocv(struct wpa_state_machine *sm);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700392struct wpa_state_machine *
Dmitry Shmidt391c59f2013-09-03 12:16:28 -0700393wpa_auth_sta_init(struct wpa_authenticator *wpa_auth, const u8 *addr,
394 const u8 *p2p_dev_addr);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700395int wpa_auth_sta_associated(struct wpa_authenticator *wpa_auth,
396 struct wpa_state_machine *sm);
397void wpa_auth_sta_no_wpa(struct wpa_state_machine *sm);
398void wpa_auth_sta_deinit(struct wpa_state_machine *sm);
399void wpa_receive(struct wpa_authenticator *wpa_auth,
400 struct wpa_state_machine *sm,
401 u8 *data, size_t data_len);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800402enum wpa_event {
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700403 WPA_AUTH, WPA_ASSOC, WPA_DISASSOC, WPA_DEAUTH, WPA_REAUTH,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700404 WPA_REAUTH_EAPOL, WPA_ASSOC_FT, WPA_ASSOC_FILS, WPA_DRV_STA_REMOVED
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800405};
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700406void wpa_remove_ptk(struct wpa_state_machine *sm);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800407int wpa_auth_sm_event(struct wpa_state_machine *sm, enum wpa_event event);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700408void wpa_auth_sm_notify(struct wpa_state_machine *sm);
409void wpa_gtk_rekey(struct wpa_authenticator *wpa_auth);
410int wpa_get_mib(struct wpa_authenticator *wpa_auth, char *buf, size_t buflen);
411int wpa_get_mib_sta(struct wpa_state_machine *sm, char *buf, size_t buflen);
412void wpa_auth_countermeasures_start(struct wpa_authenticator *wpa_auth);
413int wpa_auth_pairwise_set(struct wpa_state_machine *sm);
414int wpa_auth_get_pairwise(struct wpa_state_machine *sm);
Hai Shalom74f70d42019-02-11 14:42:39 -0800415const u8 * wpa_auth_get_pmk(struct wpa_state_machine *sm, int *len);
Sunil Ravi38ad1ed2023-01-17 23:58:31 +0000416const u8 * wpa_auth_get_dpp_pkhash(struct wpa_state_machine *sm);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700417int wpa_auth_sta_key_mgmt(struct wpa_state_machine *sm);
418int wpa_auth_sta_wpa_version(struct wpa_state_machine *sm);
Mathy Vanhoeff6e1f662017-07-14 15:15:35 +0200419int wpa_auth_sta_ft_tk_already_set(struct wpa_state_machine *sm);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700420int wpa_auth_sta_fils_tk_already_set(struct wpa_state_machine *sm);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700421int wpa_auth_sta_clear_pmksa(struct wpa_state_machine *sm,
422 struct rsn_pmksa_cache_entry *entry);
423struct rsn_pmksa_cache_entry *
424wpa_auth_sta_get_pmksa(struct wpa_state_machine *sm);
425void wpa_auth_sta_local_mic_failure_report(struct wpa_state_machine *sm);
426const u8 * wpa_auth_get_wpa_ie(struct wpa_authenticator *wpa_auth,
427 size_t *len);
428int wpa_auth_pmksa_add(struct wpa_state_machine *sm, const u8 *pmk,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800429 unsigned int pmk_len,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700430 int session_timeout, struct eapol_state_machine *eapol);
431int wpa_auth_pmksa_add_preauth(struct wpa_authenticator *wpa_auth,
432 const u8 *pmk, size_t len, const u8 *sta_addr,
433 int session_timeout,
434 struct eapol_state_machine *eapol);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800435int wpa_auth_pmksa_add_sae(struct wpa_authenticator *wpa_auth, const u8 *addr,
Sunil Ravi89eba102022-09-13 21:04:37 -0700436 const u8 *pmk, size_t pmk_len, const u8 *pmkid,
437 int akmp);
Roshan Pius3a1667e2018-07-03 15:17:14 -0700438void wpa_auth_add_sae_pmkid(struct wpa_state_machine *sm, const u8 *pmkid);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700439int wpa_auth_pmksa_add2(struct wpa_authenticator *wpa_auth, const u8 *addr,
440 const u8 *pmk, size_t pmk_len, const u8 *pmkid,
441 int session_timeout, int akmp);
Sunil Ravi38ad1ed2023-01-17 23:58:31 +0000442int wpa_auth_pmksa_add3(struct wpa_authenticator *wpa_auth, const u8 *addr,
443 const u8 *pmk, size_t pmk_len, const u8 *pmkid,
444 int session_timeout, int akmp, const u8 *dpp_pkhash);
Dmitry Shmidtf7e0a992013-05-23 11:03:10 -0700445void wpa_auth_pmksa_remove(struct wpa_authenticator *wpa_auth,
446 const u8 *sta_addr);
Dmitry Shmidte4663042016-04-04 10:07:49 -0700447int wpa_auth_pmksa_list(struct wpa_authenticator *wpa_auth, char *buf,
448 size_t len);
449void wpa_auth_pmksa_flush(struct wpa_authenticator *wpa_auth);
Paul Stewart092955c2017-02-06 09:13:09 -0800450int wpa_auth_pmksa_list_mesh(struct wpa_authenticator *wpa_auth, const u8 *addr,
451 char *buf, size_t len);
452struct rsn_pmksa_cache_entry *
453wpa_auth_pmksa_create_entry(const u8 *aa, const u8 *spa, const u8 *pmk,
Sunil Ravi89eba102022-09-13 21:04:37 -0700454 size_t pmk_len, int akmp,
Paul Stewart092955c2017-02-06 09:13:09 -0800455 const u8 *pmkid, int expiration);
456int wpa_auth_pmksa_add_entry(struct wpa_authenticator *wpa_auth,
457 struct rsn_pmksa_cache_entry *entry);
Sunil Ravi38ad1ed2023-01-17 23:58:31 +0000458struct rsn_pmksa_cache *
459wpa_auth_get_pmksa_cache(struct wpa_authenticator *wpa_auth);
Dmitry Shmidte4663042016-04-04 10:07:49 -0700460struct rsn_pmksa_cache_entry *
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800461wpa_auth_pmksa_get(struct wpa_authenticator *wpa_auth, const u8 *sta_addr,
462 const u8 *pmkid);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700463struct rsn_pmksa_cache_entry *
464wpa_auth_pmksa_get_fils_cache_id(struct wpa_authenticator *wpa_auth,
465 const u8 *sta_addr, const u8 *pmkid);
Dmitry Shmidte4663042016-04-04 10:07:49 -0700466void wpa_auth_pmksa_set_to_sm(struct rsn_pmksa_cache_entry *pmksa,
467 struct wpa_state_machine *sm,
468 struct wpa_authenticator *wpa_auth,
469 u8 *pmkid, u8 *pmk);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700470int wpa_auth_sta_set_vlan(struct wpa_state_machine *sm, int vlan_id);
471void wpa_auth_eapol_key_tx_status(struct wpa_authenticator *wpa_auth,
472 struct wpa_state_machine *sm, int ack);
473
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800474#ifdef CONFIG_IEEE80211R_AP
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700475u8 * wpa_sm_write_assoc_resp_ies(struct wpa_state_machine *sm, u8 *pos,
476 size_t max_len, int auth_alg,
Hai Shalomfdcde762020-04-02 11:19:20 -0700477 const u8 *req_ies, size_t req_ies_len,
478 int omit_rsnxe);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700479void wpa_ft_process_auth(struct wpa_state_machine *sm, const u8 *bssid,
480 u16 auth_transaction, const u8 *ies, size_t ies_len,
481 void (*cb)(void *ctx, const u8 *dst, const u8 *bssid,
482 u16 auth_transaction, u16 resp,
483 const u8 *ies, size_t ies_len),
484 void *ctx);
Hai Shalomb755a2a2020-04-23 21:49:02 -0700485int wpa_ft_validate_reassoc(struct wpa_state_machine *sm, const u8 *ies,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700486 size_t ies_len);
487int wpa_ft_action_rx(struct wpa_state_machine *sm, const u8 *data, size_t len);
488int wpa_ft_rrb_rx(struct wpa_authenticator *wpa_auth, const u8 *src_addr,
489 const u8 *data, size_t data_len);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700490void wpa_ft_rrb_oui_rx(struct wpa_authenticator *wpa_auth, const u8 *src_addr,
491 const u8 *dst_addr, u8 oui_suffix, const u8 *data,
492 size_t data_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700493void wpa_ft_push_pmk_r1(struct wpa_authenticator *wpa_auth, const u8 *addr);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700494void wpa_ft_deinit(struct wpa_authenticator *wpa_auth);
495void wpa_ft_sta_deinit(struct wpa_state_machine *sm);
Hai Shalom60840252021-02-19 19:02:11 -0800496int wpa_ft_fetch_pmk_r1(struct wpa_authenticator *wpa_auth,
497 const u8 *spa, const u8 *pmk_r1_name,
498 u8 *pmk_r1, size_t *pmk_r1_len, int *pairwise,
499 struct vlan_description *vlan,
500 const u8 **identity, size_t *identity_len,
501 const u8 **radius_cui, size_t *radius_cui_len,
502 int *session_timeout);
503
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800504#endif /* CONFIG_IEEE80211R_AP */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700505
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700506void wpa_wnmsleep_rekey_gtk(struct wpa_state_machine *sm);
507void wpa_set_wnmsleep(struct wpa_state_machine *sm, int flag);
508int wpa_wnmsleep_gtk_subelem(struct wpa_state_machine *sm, u8 *pos);
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700509int wpa_wnmsleep_igtk_subelem(struct wpa_state_machine *sm, u8 *pos);
Hai Shalomfdcde762020-04-02 11:19:20 -0700510int wpa_wnmsleep_bigtk_subelem(struct wpa_state_machine *sm, u8 *pos);
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700511
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800512int wpa_auth_uses_sae(struct wpa_state_machine *sm);
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800513int wpa_auth_uses_ft_sae(struct wpa_state_machine *sm);
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800514
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800515int wpa_auth_get_ip_addr(struct wpa_state_machine *sm, u8 *addr);
516
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800517struct radius_das_attrs;
518int wpa_auth_radius_das_disconnect_pmksa(struct wpa_authenticator *wpa_auth,
519 struct radius_das_attrs *attr);
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800520void wpa_auth_reconfig_group_keys(struct wpa_authenticator *wpa_auth);
Dmitry Shmidt2f74e362015-01-21 13:19:05 -0800521
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800522int wpa_auth_ensure_group(struct wpa_authenticator *wpa_auth, int vlan_id);
523int wpa_auth_release_group(struct wpa_authenticator *wpa_auth, int vlan_id);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800524int fils_auth_pmk_to_ptk(struct wpa_state_machine *sm, const u8 *pmk,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700525 size_t pmk_len, const u8 *snonce, const u8 *anonce,
526 const u8 *dhss, size_t dhss_len,
527 struct wpabuf *g_sta, struct wpabuf *g_ap);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800528int fils_decrypt_assoc(struct wpa_state_machine *sm, const u8 *fils_session,
529 const struct ieee80211_mgmt *mgmt, size_t frame_len,
530 u8 *pos, size_t left);
531int fils_encrypt_assoc(struct wpa_state_machine *sm, u8 *buf,
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800532 size_t current_len, size_t max_len,
533 const struct wpabuf *hlp);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800534int fils_set_tk(struct wpa_state_machine *sm);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700535u8 * hostapd_eid_assoc_fils_session(struct wpa_state_machine *sm, u8 *eid,
536 const u8 *fils_session,
537 struct wpabuf *fils_hlp_resp);
538const u8 * wpa_fils_validate_fils_session(struct wpa_state_machine *sm,
539 const u8 *ies, size_t ies_len,
540 const u8 *fils_session);
541int wpa_fils_validate_key_confirm(struct wpa_state_machine *sm, const u8 *ies,
542 size_t ies_len);
543
Hai Shalom74f70d42019-02-11 14:42:39 -0800544int get_sta_tx_parameters(struct wpa_state_machine *sm, int ap_max_chanwidth,
545 int ap_seg1_idx, int *bandwidth, int *seg1_idx);
546
Sunil Ravi38ad1ed2023-01-17 23:58:31 +0000547int wpa_auth_write_fte(struct wpa_authenticator *wpa_auth,
548 struct wpa_state_machine *sm,
Roshan Pius3a1667e2018-07-03 15:17:14 -0700549 u8 *buf, size_t len);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700550void wpa_auth_get_fils_aead_params(struct wpa_state_machine *sm,
551 u8 *fils_anonce, u8 *fils_snonce,
552 u8 *fils_kek, size_t *fils_kek_len);
Hai Shalom81f62d82019-07-22 12:10:00 -0700553void wpa_auth_add_fils_pmk_pmkid(struct wpa_state_machine *sm, const u8 *pmk,
554 size_t pmk_len, const u8 *pmkid);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700555u8 * wpa_auth_write_assoc_resp_owe(struct wpa_state_machine *sm,
556 u8 *pos, size_t max_len,
557 const u8 *req_ies, size_t req_ies_len);
Hai Shalom81f62d82019-07-22 12:10:00 -0700558u8 * wpa_auth_write_assoc_resp_fils(struct wpa_state_machine *sm,
559 u8 *pos, size_t max_len,
560 const u8 *req_ies, size_t req_ies_len);
Hai Shalom60840252021-02-19 19:02:11 -0800561bool wpa_auth_write_fd_rsn_info(struct wpa_authenticator *wpa_auth,
562 u8 *fd_rsn_info);
Hai Shalom021b0b52019-04-10 11:17:58 -0700563void wpa_auth_set_auth_alg(struct wpa_state_machine *sm, u16 auth_alg);
564void wpa_auth_set_dpp_z(struct wpa_state_machine *sm, const struct wpabuf *z);
Hai Shalom899fcc72020-10-19 14:38:18 -0700565void wpa_auth_set_transition_disable(struct wpa_authenticator *wpa_auth,
566 u8 val);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700567
568int wpa_auth_resend_m1(struct wpa_state_machine *sm, int change_anonce,
569 void (*cb)(void *ctx1, void *ctx2),
570 void *ctx1, void *ctx2);
571int wpa_auth_resend_m3(struct wpa_state_machine *sm,
572 void (*cb)(void *ctx1, void *ctx2),
573 void *ctx1, void *ctx2);
574int wpa_auth_resend_group_m1(struct wpa_state_machine *sm,
575 void (*cb)(void *ctx1, void *ctx2),
576 void *ctx1, void *ctx2);
Hai Shaloma20dcd72022-02-04 13:43:00 -0800577int wpa_auth_rekey_ptk(struct wpa_authenticator *wpa_auth,
578 struct wpa_state_machine *sm);
Roshan Pius3a1667e2018-07-03 15:17:14 -0700579int wpa_auth_rekey_gtk(struct wpa_authenticator *wpa_auth);
Hai Shaloma20dcd72022-02-04 13:43:00 -0800580int hostapd_wpa_auth_send_eapol(void *ctx, const u8 *addr,
581 const u8 *data, size_t data_len,
582 int encrypt);
Hai Shalom81f62d82019-07-22 12:10:00 -0700583void wpa_auth_set_ptk_rekey_timer(struct wpa_state_machine *sm);
Hai Shalomb755a2a2020-04-23 21:49:02 -0700584void wpa_auth_set_ft_rsnxe_used(struct wpa_authenticator *wpa_auth, int val);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800585
Hai Shalom899fcc72020-10-19 14:38:18 -0700586enum wpa_auth_ocv_override_frame {
587 WPA_AUTH_OCV_OVERRIDE_EAPOL_M3,
588 WPA_AUTH_OCV_OVERRIDE_EAPOL_G1,
589 WPA_AUTH_OCV_OVERRIDE_FT_ASSOC,
590 WPA_AUTH_OCV_OVERRIDE_FILS_ASSOC,
591};
592void wpa_auth_set_ocv_override_freq(struct wpa_authenticator *wpa_auth,
593 enum wpa_auth_ocv_override_frame frame,
594 unsigned int freq);
Kai Shie75b0652020-11-24 20:31:29 -0800595void wpa_auth_set_skip_send_eapol(struct wpa_authenticator *wpa_auth,
596 u8 val);
597void wpa_auth_set_enable_eapol_large_timeout(struct wpa_authenticator *wpa_auth,
598 u8 val);
Hai Shalom899fcc72020-10-19 14:38:18 -0700599
Sunil Ravia04bd252022-05-02 22:54:18 -0700600void wpa_auth_sta_radius_psk_resp(struct wpa_state_machine *sm, bool success);
601
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700602#endif /* WPA_AUTH_H */