]> git.ipfire.org Git - thirdparty/hostap.git/blame - src/rsn_supp/wpa.h
wpa_supplicant configuration for Beacon protection
[thirdparty/hostap.git] / src / rsn_supp / wpa.h
CommitLineData
6fc6879b
JM
1/*
2 * wpa_supplicant - WPA definitions
98cd3d1c 3 * Copyright (c) 2003-2015, Jouni Malinen <j@w1.fi>
6fc6879b 4 *
0f3d578e
JM
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
6fc6879b
JM
7 */
8
9#ifndef WPA_H
10#define WPA_H
11
90973fb2
JM
12#include "common/defs.h"
13#include "common/eapol_common.h"
14#include "common/wpa_common.h"
ff4178d5 15#include "common/ieee802_11_defs.h"
6fc6879b 16
6fc6879b
JM
17struct wpa_sm;
18struct eapol_sm;
19struct wpa_config_blob;
6b90deae 20struct hostapd_freq_params;
4b62b52e 21struct wpa_channel_info;
6fc6879b
JM
22
23struct wpa_sm_ctx {
24 void *ctx; /* pointer to arbitrary upper level context */
0f057fb2 25 void *msg_ctx; /* upper level context for wpa_msg() calls */
6fc6879b 26
71934751
JM
27 void (*set_state)(void *ctx, enum wpa_states state);
28 enum wpa_states (*get_state)(void *ctx);
4be17ffb 29 void (*deauthenticate)(void * ctx, u16 reason_code);
71934751 30 int (*set_key)(void *ctx, enum wpa_alg alg,
6fc6879b
JM
31 const u8 *addr, int key_idx, int set_tx,
32 const u8 *seq, size_t seq_len,
a919a260 33 const u8 *key, size_t key_len, enum key_flag key_flag);
6fc6879b
JM
34 void * (*get_network_ctx)(void *ctx);
35 int (*get_bssid)(void *ctx, u8 *bssid);
36 int (*ether_send)(void *ctx, const u8 *dest, u16 proto, const u8 *buf,
37 size_t len);
38 int (*get_beacon_ie)(void *ctx);
39 void (*cancel_auth_timeout)(void *ctx);
40 u8 * (*alloc_eapol)(void *ctx, u8 type, const void *data, u16 data_len,
41 size_t *msg_len, void **data_pos);
c5793127 42 int (*add_pmkid)(void *ctx, void *network_ctx, const u8 *bssid,
42e69bda
VK
43 const u8 *pmkid, const u8 *fils_cache_id,
44 const u8 *pmk, size_t pmk_len);
c5793127 45 int (*remove_pmkid)(void *ctx, void *network_ctx, const u8 *bssid,
42e69bda 46 const u8 *pmkid, const u8 *fils_cache_id);
6fc6879b
JM
47 void (*set_config_blob)(void *ctx, struct wpa_config_blob *blob);
48 const struct wpa_config_blob * (*get_config_blob)(void *ctx,
49 const char *name);
50 int (*mlme_setprotection)(void *ctx, const u8 *addr,
51 int protection_type, int key_type);
52 int (*update_ft_ies)(void *ctx, const u8 *md, const u8 *ies,
53 size_t ies_len);
54 int (*send_ft_action)(void *ctx, u8 action, const u8 *target_ap,
55 const u8 *ies, size_t ies_len);
2a7e7f4e 56 int (*mark_authenticated)(void *ctx, const u8 *target_ap);
281ff0aa 57#ifdef CONFIG_TDLS
c58ab8f2 58 int (*tdls_get_capa)(void *ctx, int *tdls_supported,
4daa5729 59 int *tdls_ext_setup, int *tdls_chan_switch);
281ff0aa
GP
60 int (*send_tdls_mgmt)(void *ctx, const u8 *dst,
61 u8 action_code, u8 dialog_token,
96ecea5e 62 u16 status_code, u32 peer_capab,
984dadc2 63 int initiator, const u8 *buf, size_t len);
281ff0aa 64 int (*tdls_oper)(void *ctx, int oper, const u8 *peer);
78533699 65 int (*tdls_peer_addset)(void *ctx, const u8 *addr, int add, u16 aid,
45b722f1 66 u16 capability, const u8 *supp_rates,
ff4178d5
SD
67 size_t supp_rates_len,
68 const struct ieee80211_ht_capabilities *ht_capab,
f8361e3d 69 const struct ieee80211_vht_capabilities *vht_capab,
08d7665c 70 u8 qosinfo, int wmm, const u8 *ext_capab,
3ed97271
SD
71 size_t ext_capab_len, const u8 *supp_channels,
72 size_t supp_channels_len,
73 const u8 *supp_oper_classes,
74 size_t supp_oper_classes_len);
6b90deae
AN
75 int (*tdls_enable_channel_switch)(
76 void *ctx, const u8 *addr, u8 oper_class,
77 const struct hostapd_freq_params *params);
78 int (*tdls_disable_channel_switch)(void *ctx, const u8 *addr);
281ff0aa 79#endif /* CONFIG_TDLS */
98cd3d1c
JM
80 void (*set_rekey_offload)(void *ctx, const u8 *kek, size_t kek_len,
81 const u8 *kck, size_t kck_len,
b14a210c 82 const u8 *replay_ctr);
b41f2684 83 int (*key_mgmt_set_pmk)(void *ctx, const u8 *pmk, size_t pmk_len);
124ddfa1
JM
84 void (*fils_hlp_rx)(void *ctx, const u8 *dst, const u8 *src,
85 const u8 *pkt, size_t pkt_len);
4b62b52e 86 int (*channel_info)(void *ctx, struct wpa_channel_info *ci);
6fc6879b
JM
87};
88
89
90enum wpa_sm_conf_params {
91 RSNA_PMK_LIFETIME /* dot11RSNAConfigPMKLifetime */,
92 RSNA_PMK_REAUTH_THRESHOLD /* dot11RSNAConfigPMKReauthThreshold */,
93 RSNA_SA_TIMEOUT /* dot11RSNAConfigSATimeout */,
94 WPA_PARAM_PROTO,
95 WPA_PARAM_PAIRWISE,
96 WPA_PARAM_GROUP,
97 WPA_PARAM_KEY_MGMT,
98 WPA_PARAM_MGMT_GROUP,
e820cf95 99 WPA_PARAM_RSN_ENABLED,
55c12f5d 100 WPA_PARAM_MFP,
6d6c8877
JM
101 WPA_PARAM_OCV,
102 WPA_PARAM_SAE_PWE,
6fc6879b
JM
103};
104
105struct rsn_supp_config {
106 void *network_ctx;
6fc6879b
JM
107 int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
108 int proactive_key_caching;
109 int eap_workaround;
110 void *eap_conf_ctx;
111 const u8 *ssid;
112 size_t ssid_len;
581a8cde 113 int wpa_ptk_rekey;
25ef8529 114 int p2p;
73ed03f3 115 int wpa_rsc_relaxation;
8b138d28 116 int owe_ptk_workaround;
869af307 117 const u8 *fils_cache_id;
ecbf59e6 118 int beacon_prot;
6fc6879b
JM
119};
120
121#ifndef CONFIG_NO_WPA
122
123struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx);
124void wpa_sm_deinit(struct wpa_sm *sm);
125void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid);
126void wpa_sm_notify_disassoc(struct wpa_sm *sm);
bc26ac50 127void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len,
70c93963 128 const u8 *pmkid, const u8 *bssid);
6fc6879b
JM
129void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm);
130void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth);
131void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx);
132void wpa_sm_set_config(struct wpa_sm *sm, struct rsn_supp_config *config);
133void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr);
134void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
135 const char *bridge_ifname);
136void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol);
137int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
138int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm, u8 *wpa_ie,
139 size_t *wpa_ie_len);
6d6c8877
JM
140int wpa_sm_set_assoc_rsnxe_default(struct wpa_sm *sm, u8 *rsnxe,
141 size_t *rsnxe_len);
142int wpa_sm_set_assoc_rsnxe(struct wpa_sm *sm, const u8 *ie, size_t len);
6fc6879b
JM
143int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
144int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
146889e3 145int wpa_sm_set_ap_rsnxe(struct wpa_sm *sm, const u8 *ie, size_t len);
6fc6879b
JM
146int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen);
147
148int wpa_sm_set_param(struct wpa_sm *sm, enum wpa_sm_conf_params param,
149 unsigned int value);
6fc6879b
JM
150
151int wpa_sm_get_status(struct wpa_sm *sm, char *buf, size_t buflen,
152 int verbose);
ae8535b6 153int wpa_sm_pmf_enabled(struct wpa_sm *sm);
17c2559c 154int wpa_sm_ocv_enabled(struct wpa_sm *sm);
6fc6879b
JM
155
156void wpa_sm_key_request(struct wpa_sm *sm, int error, int pairwise);
157
158int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
159 struct wpa_ie_data *data);
160
161void wpa_sm_aborted_cached(struct wpa_sm *sm);
162int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
163 const u8 *buf, size_t len);
164int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm, struct wpa_ie_data *data);
540264a7 165int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf, size_t len);
3459381d
JM
166struct rsn_pmksa_cache_entry * wpa_sm_pmksa_cache_head(struct wpa_sm *sm);
167struct rsn_pmksa_cache_entry *
168wpa_sm_pmksa_cache_add_entry(struct wpa_sm *sm,
169 struct rsn_pmksa_cache_entry * entry);
f705f41b
VK
170void wpa_sm_pmksa_cache_add(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len,
171 const u8 *pmkid, const u8 *bssid,
172 const u8 *fils_cache_id);
567da5bb
JM
173int wpa_sm_pmksa_exists(struct wpa_sm *sm, const u8 *bssid,
174 const void *network_ctx);
32d5295f 175void wpa_sm_drop_sa(struct wpa_sm *sm);
0d7b4409 176int wpa_sm_has_ptk(struct wpa_sm *sm);
a79ed068 177int wpa_sm_has_ptk_installed(struct wpa_sm *sm);
6fc6879b 178
b14a210c
JB
179void wpa_sm_update_replay_ctr(struct wpa_sm *sm, const u8 *replay_ctr);
180
d8a790b9
JM
181void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm, void *network_ctx);
182
25ef8529
JM
183int wpa_sm_get_p2p_ip_addr(struct wpa_sm *sm, u8 *buf);
184
b41f2684 185void wpa_sm_set_rx_replay_ctr(struct wpa_sm *sm, const u8 *rx_replay_counter);
98cd3d1c
JM
186void wpa_sm_set_ptk_kck_kek(struct wpa_sm *sm,
187 const u8 *ptk_kck, size_t ptk_kck_len,
188 const u8 *ptk_kek, size_t ptk_kek_len);
881a92e8 189int wpa_fils_is_completed(struct wpa_sm *sm);
b41f2684 190
6fc6879b
JM
191#else /* CONFIG_NO_WPA */
192
193static inline struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx)
194{
195 return (struct wpa_sm *) 1;
196}
197
198static inline void wpa_sm_deinit(struct wpa_sm *sm)
199{
200}
201
202static inline void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid)
203{
204}
205
206static inline void wpa_sm_notify_disassoc(struct wpa_sm *sm)
207{
208}
209
210static inline void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk,
70c93963
MH
211 size_t pmk_len, const u8 *pmkid,
212 const u8 *bssid)
6fc6879b
JM
213{
214}
215
216static inline void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm)
217{
218}
219
220static inline void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth)
221{
222}
223
224static inline void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx)
225{
226}
227
228static inline void wpa_sm_set_config(struct wpa_sm *sm,
229 struct rsn_supp_config *config)
230{
231}
232
233static inline void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr)
234{
235}
236
237static inline void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
238 const char *bridge_ifname)
239{
240}
241
242static inline void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol)
243{
244}
245
246static inline int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie,
247 size_t len)
248{
249 return -1;
250}
251
252static inline int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm,
253 u8 *wpa_ie,
254 size_t *wpa_ie_len)
255{
256 return -1;
257}
258
259static inline int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie,
260 size_t len)
261{
262 return -1;
263}
264
265static inline int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie,
266 size_t len)
267{
268 return -1;
269}
270
146889e3
JM
271static inline int wpa_sm_set_ap_rsnxe(struct wpa_sm *sm, const u8 *ie,
272 size_t len)
273{
274 return -1;
275}
276
6fc6879b
JM
277static inline int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen)
278{
279 return 0;
280}
281
282static inline int wpa_sm_set_param(struct wpa_sm *sm,
283 enum wpa_sm_conf_params param,
284 unsigned int value)
285{
286 return -1;
287}
288
6fc6879b
JM
289static inline int wpa_sm_get_status(struct wpa_sm *sm, char *buf,
290 size_t buflen, int verbose)
291{
292 return 0;
293}
294
84ae1d44
JM
295static inline int wpa_sm_pmf_enabled(struct wpa_sm *sm)
296{
297 return 0;
298}
299
17c2559c
MV
300static inline int wpa_sm_ocv_enabled(struct wpa_sm *sm)
301{
302 return 0;
303}
304
6fc6879b
JM
305static inline void wpa_sm_key_request(struct wpa_sm *sm, int error,
306 int pairwise)
307{
308}
309
310static inline int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
311 struct wpa_ie_data *data)
312{
313 return -1;
314}
315
316static inline void wpa_sm_aborted_cached(struct wpa_sm *sm)
317{
318}
319
320static inline int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
321 const u8 *buf, size_t len)
322{
323 return -1;
324}
325
326static inline int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm,
327 struct wpa_ie_data *data)
328{
329 return -1;
330}
331
540264a7
JM
332static inline int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf,
333 size_t len)
334{
335 return -1;
336}
337
32d5295f
JM
338static inline void wpa_sm_drop_sa(struct wpa_sm *sm)
339{
340}
341
e6ecca77
JM
342static inline int wpa_sm_has_ptk(struct wpa_sm *sm)
343{
344 return 0;
345}
346
b14a210c
JB
347static inline void wpa_sm_update_replay_ctr(struct wpa_sm *sm,
348 const u8 *replay_ctr)
349{
350}
351
d8a790b9
JM
352static inline void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm,
353 void *network_ctx)
354{
355}
356
b41f2684
CL
357static inline void wpa_sm_set_rx_replay_ctr(struct wpa_sm *sm,
358 const u8 *rx_replay_counter)
359{
360}
361
362static inline void wpa_sm_set_ptk_kck_kek(struct wpa_sm *sm, const u8 *ptk_kck,
9e68742e
JM
363 size_t ptk_kck_len,
364 const u8 *ptk_kek, size_t ptk_kek_len)
b41f2684
CL
365{
366}
367
881a92e8
EG
368static inline int wpa_fils_is_completed(struct wpa_sm *sm)
369{
370 return 0;
371}
372
6fc6879b
JM
373#endif /* CONFIG_NO_WPA */
374
6fc6879b
JM
375#ifdef CONFIG_IEEE80211R
376
e7846b68 377int wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len);
76b7981d 378int wpa_ft_prepare_auth_request(struct wpa_sm *sm, const u8 *mdie);
3dc3afe2
AM
379int wpa_ft_add_mdie(struct wpa_sm *sm, u8 *ies, size_t ies_len,
380 const u8 *mdie);
381const u8 * wpa_sm_get_ft_md(struct wpa_sm *sm);
6fc6879b 382int wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
babfbf15
JM
383 int ft_action, const u8 *target_ap,
384 const u8 *ric_ies, size_t ric_ies_len);
6fc6879b 385int wpa_ft_is_completed(struct wpa_sm *sm);
02db75b6 386void wpa_reset_ft_completed(struct wpa_sm *sm);
6fc6879b 387int wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies,
658d1662 388 size_t ies_len, const u8 *src_addr);
76b7981d
JM
389int wpa_ft_start_over_ds(struct wpa_sm *sm, const u8 *target_ap,
390 const u8 *mdie);
6fc6879b
JM
391
392#else /* CONFIG_IEEE80211R */
393
394static inline int
087f0254 395wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len)
6fc6879b
JM
396{
397 return 0;
398}
399
76b7981d
JM
400static inline int wpa_ft_prepare_auth_request(struct wpa_sm *sm,
401 const u8 *mdie)
6fc6879b
JM
402{
403 return 0;
404}
405
3dc3afe2
AM
406static inline int wpa_ft_add_mdie(struct wpa_sm *sm, u8 *ies, size_t ies_len,
407 const u8 *mdie)
408{
409 return 0;
410}
411
6fc6879b
JM
412static inline int
413wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
414 int ft_action, const u8 *target_ap)
415{
416 return 0;
417}
418
419static inline int wpa_ft_is_completed(struct wpa_sm *sm)
420{
421 return 0;
422}
423
02db75b6
DG
424static inline void wpa_reset_ft_completed(struct wpa_sm *sm)
425{
426}
427
6fc6879b 428static inline int
658d1662
JM
429wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
430 const u8 *src_addr)
6fc6879b
JM
431{
432 return -1;
433}
434
435#endif /* CONFIG_IEEE80211R */
436
281ff0aa
GP
437
438/* tdls.c */
52c9e6f3
JM
439void wpa_tdls_ap_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
440void wpa_tdls_assoc_resp_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
281ff0aa 441int wpa_tdls_start(struct wpa_sm *sm, const u8 *addr);
3887878e 442void wpa_tdls_remove(struct wpa_sm *sm, const u8 *addr);
7de27409 443int wpa_tdls_teardown_link(struct wpa_sm *sm, const u8 *addr, u16 reason_code);
7a1486cd 444int wpa_tdls_send_discovery_request(struct wpa_sm *sm, const u8 *addr);
281ff0aa 445int wpa_tdls_init(struct wpa_sm *sm);
7b44ff2c 446void wpa_tdls_teardown_peers(struct wpa_sm *sm);
281ff0aa 447void wpa_tdls_deinit(struct wpa_sm *sm);
b8f64582 448void wpa_tdls_enable(struct wpa_sm *sm, int enabled);
947f900f 449void wpa_tdls_disable_unreachable_link(struct wpa_sm *sm, const u8 *addr);
cea97a04 450const char * wpa_tdls_get_link_status(struct wpa_sm *sm, const u8 *addr);
2d565a61 451int wpa_tdls_is_external_setup(struct wpa_sm *sm);
6b90deae
AN
452int wpa_tdls_enable_chan_switch(struct wpa_sm *sm, const u8 *addr,
453 u8 oper_class,
454 struct hostapd_freq_params *freq_params);
455int wpa_tdls_disable_chan_switch(struct wpa_sm *sm, const u8 *addr);
6013bbe0
JM
456#ifdef CONFIG_TDLS_TESTING
457extern unsigned int tdls_testing;
458#endif /* CONFIG_TDLS_TESTING */
459
281ff0aa 460
75cad1a0 461int wpa_wnmsleep_install_key(struct wpa_sm *sm, u8 subelem_id, u8 *buf);
651c6a84 462void wpa_sm_set_test_assoc_ie(struct wpa_sm *sm, struct wpabuf *buf);
bb06748f 463const u8 * wpa_sm_get_anonce(struct wpa_sm *sm);
3dc3afe2 464unsigned int wpa_sm_get_key_mgmt(struct wpa_sm *sm);
75cad1a0 465
af3e362f 466struct wpabuf * fils_build_auth(struct wpa_sm *sm, int dh_group, const u8 *md);
ba9774bd
JM
467int fils_process_auth(struct wpa_sm *sm, const u8 *bssid, const u8 *data,
468 size_t len);
86cd6928
JM
469struct wpabuf * fils_build_assoc_req(struct wpa_sm *sm, const u8 **kek,
470 size_t *kek_len, const u8 **snonce,
5732b770
JM
471 const u8 **anonce,
472 const struct wpabuf **hlp,
473 unsigned int num_hlp);
706df429 474int fils_process_assoc_resp(struct wpa_sm *sm, const u8 *resp, size_t len);
f00b9b88 475
ec9f4837 476struct wpabuf * owe_build_assoc_req(struct wpa_sm *sm, u16 group);
5a78c361
JM
477int owe_process_assoc_resp(struct wpa_sm *sm, const u8 *bssid,
478 const u8 *resp_ies, size_t resp_ies_len);
0a614799 479
5538fc93 480void wpa_sm_set_reset_fils_completed(struct wpa_sm *sm, int set);
bbe7969d 481void wpa_sm_set_fils_cache_id(struct wpa_sm *sm, const u8 *fils_cache_id);
10ec6a5f 482void wpa_sm_set_dpp_z(struct wpa_sm *sm, const struct wpabuf *z);
5538fc93 483
6fc6879b 484#endif /* WPA_H */