1/*
2 * wpa_supplicant - WPA definitions
3 * Copyright (c) 2003-2015, 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_H
10#define WPA_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
17struct wpa_sm;
18struct eapol_sm;
19struct wpa_config_blob;
20struct hostapd_freq_params;
21
22struct wpa_sm_ctx {
23	void *ctx; /* pointer to arbitrary upper level context */
24	void *msg_ctx; /* upper level context for wpa_msg() calls */
25
26	void (*set_state)(void *ctx, enum wpa_states state);
27	enum wpa_states (*get_state)(void *ctx);
28	void (*deauthenticate)(void * ctx, int reason_code);
29	int (*set_key)(void *ctx, enum wpa_alg alg,
30		       const u8 *addr, int key_idx, int set_tx,
31		       const u8 *seq, size_t seq_len,
32		       const u8 *key, size_t key_len);
33	void * (*get_network_ctx)(void *ctx);
34	int (*get_bssid)(void *ctx, u8 *bssid);
35	int (*ether_send)(void *ctx, const u8 *dest, u16 proto, const u8 *buf,
36			  size_t len);
37	int (*get_beacon_ie)(void *ctx);
38	void (*cancel_auth_timeout)(void *ctx);
39	u8 * (*alloc_eapol)(void *ctx, u8 type, const void *data, u16 data_len,
40			    size_t *msg_len, void **data_pos);
41	int (*add_pmkid)(void *ctx, void *network_ctx, const u8 *bssid,
42			 const u8 *pmkid);
43	int (*remove_pmkid)(void *ctx, void *network_ctx, const u8 *bssid,
44			    const u8 *pmkid);
45	void (*set_config_blob)(void *ctx, struct wpa_config_blob *blob);
46	const struct wpa_config_blob * (*get_config_blob)(void *ctx,
47							  const char *name);
48	int (*mlme_setprotection)(void *ctx, const u8 *addr,
49				  int protection_type, int key_type);
50	int (*update_ft_ies)(void *ctx, const u8 *md, const u8 *ies,
51			     size_t ies_len);
52	int (*send_ft_action)(void *ctx, u8 action, const u8 *target_ap,
53			      const u8 *ies, size_t ies_len);
54	int (*mark_authenticated)(void *ctx, const u8 *target_ap);
55#ifdef CONFIG_TDLS
56	int (*tdls_get_capa)(void *ctx, int *tdls_supported,
57			     int *tdls_ext_setup, int *tdls_chan_switch);
58	int (*send_tdls_mgmt)(void *ctx, const u8 *dst,
59			      u8 action_code, u8 dialog_token,
60			      u16 status_code, u32 peer_capab,
61			      int initiator, const u8 *buf, size_t len);
62	int (*tdls_oper)(void *ctx, int oper, const u8 *peer);
63	int (*tdls_peer_addset)(void *ctx, const u8 *addr, int add, u16 aid,
64				u16 capability, const u8 *supp_rates,
65				size_t supp_rates_len,
66				const struct ieee80211_ht_capabilities *ht_capab,
67				const struct ieee80211_vht_capabilities *vht_capab,
68				u8 qosinfo, int wmm, const u8 *ext_capab,
69				size_t ext_capab_len, const u8 *supp_channels,
70				size_t supp_channels_len,
71				const u8 *supp_oper_classes,
72				size_t supp_oper_classes_len);
73	int (*tdls_enable_channel_switch)(
74		void *ctx, const u8 *addr, u8 oper_class,
75		const struct hostapd_freq_params *params);
76	int (*tdls_disable_channel_switch)(void *ctx, const u8 *addr);
77#endif /* CONFIG_TDLS */
78	void (*set_rekey_offload)(void *ctx, const u8 *kek, size_t kek_len,
79				  const u8 *kck, size_t kck_len,
80				  const u8 *replay_ctr);
81	int (*key_mgmt_set_pmk)(void *ctx, const u8 *pmk, size_t pmk_len);
82	void (*fils_hlp_rx)(void *ctx, const u8 *dst, const u8 *src,
83			    const u8 *pkt, size_t pkt_len);
84};
85
86
87enum wpa_sm_conf_params {
88	RSNA_PMK_LIFETIME /* dot11RSNAConfigPMKLifetime */,
89	RSNA_PMK_REAUTH_THRESHOLD /* dot11RSNAConfigPMKReauthThreshold */,
90	RSNA_SA_TIMEOUT /* dot11RSNAConfigSATimeout */,
91	WPA_PARAM_PROTO,
92	WPA_PARAM_PAIRWISE,
93	WPA_PARAM_GROUP,
94	WPA_PARAM_KEY_MGMT,
95	WPA_PARAM_MGMT_GROUP,
96	WPA_PARAM_RSN_ENABLED,
97	WPA_PARAM_MFP
98};
99
100struct rsn_supp_config {
101	void *network_ctx;
102	int peerkey_enabled;
103	int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
104	int proactive_key_caching;
105	int eap_workaround;
106	void *eap_conf_ctx;
107	const u8 *ssid;
108	size_t ssid_len;
109	int wpa_ptk_rekey;
110	int p2p;
111	int wpa_rsc_relaxation;
112};
113
114#ifndef CONFIG_NO_WPA
115
116struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx);
117void wpa_sm_deinit(struct wpa_sm *sm);
118void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid);
119void wpa_sm_notify_disassoc(struct wpa_sm *sm);
120void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len,
121		    const u8 *pmkid, const u8 *bssid);
122void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm);
123void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth);
124void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx);
125void wpa_sm_set_config(struct wpa_sm *sm, struct rsn_supp_config *config);
126void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr);
127void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
128		       const char *bridge_ifname);
129void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol);
130int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
131int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm, u8 *wpa_ie,
132				    size_t *wpa_ie_len);
133int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
134int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
135int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen);
136
137int wpa_sm_set_param(struct wpa_sm *sm, enum wpa_sm_conf_params param,
138		     unsigned int value);
139
140int wpa_sm_get_status(struct wpa_sm *sm, char *buf, size_t buflen,
141		      int verbose);
142int wpa_sm_pmf_enabled(struct wpa_sm *sm);
143
144void wpa_sm_key_request(struct wpa_sm *sm, int error, int pairwise);
145
146int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
147		     struct wpa_ie_data *data);
148
149void wpa_sm_aborted_cached(struct wpa_sm *sm);
150int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
151		    const u8 *buf, size_t len);
152int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm, struct wpa_ie_data *data);
153int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf, size_t len);
154struct rsn_pmksa_cache_entry * wpa_sm_pmksa_cache_head(struct wpa_sm *sm);
155struct rsn_pmksa_cache_entry *
156wpa_sm_pmksa_cache_add_entry(struct wpa_sm *sm,
157			     struct rsn_pmksa_cache_entry * entry);
158void wpa_sm_drop_sa(struct wpa_sm *sm);
159int wpa_sm_has_ptk(struct wpa_sm *sm);
160
161void wpa_sm_update_replay_ctr(struct wpa_sm *sm, const u8 *replay_ctr);
162
163void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm, void *network_ctx);
164
165int wpa_sm_get_p2p_ip_addr(struct wpa_sm *sm, u8 *buf);
166
167void wpa_sm_set_rx_replay_ctr(struct wpa_sm *sm, const u8 *rx_replay_counter);
168void wpa_sm_set_ptk_kck_kek(struct wpa_sm *sm,
169			    const u8 *ptk_kck, size_t ptk_kck_len,
170			    const u8 *ptk_kek, size_t ptk_kek_len);
171
172#else /* CONFIG_NO_WPA */
173
174static inline struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx)
175{
176	return (struct wpa_sm *) 1;
177}
178
179static inline void wpa_sm_deinit(struct wpa_sm *sm)
180{
181}
182
183static inline void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid)
184{
185}
186
187static inline void wpa_sm_notify_disassoc(struct wpa_sm *sm)
188{
189}
190
191static inline void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk,
192				  size_t pmk_len, const u8 *pmkid,
193				  const u8 *bssid)
194{
195}
196
197static inline void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm)
198{
199}
200
201static inline void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth)
202{
203}
204
205static inline void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx)
206{
207}
208
209static inline void wpa_sm_set_config(struct wpa_sm *sm,
210				     struct rsn_supp_config *config)
211{
212}
213
214static inline void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr)
215{
216}
217
218static inline void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
219				     const char *bridge_ifname)
220{
221}
222
223static inline void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol)
224{
225}
226
227static inline int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie,
228					  size_t len)
229{
230	return -1;
231}
232
233static inline int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm,
234						  u8 *wpa_ie,
235						  size_t *wpa_ie_len)
236{
237	return -1;
238}
239
240static inline int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie,
241				       size_t len)
242{
243	return -1;
244}
245
246static inline int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie,
247				       size_t len)
248{
249	return -1;
250}
251
252static inline int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen)
253{
254	return 0;
255}
256
257static inline int wpa_sm_set_param(struct wpa_sm *sm,
258				   enum wpa_sm_conf_params param,
259				   unsigned int value)
260{
261	return -1;
262}
263
264static inline int wpa_sm_get_status(struct wpa_sm *sm, char *buf,
265				    size_t buflen, int verbose)
266{
267	return 0;
268}
269
270static inline int wpa_sm_pmf_enabled(struct wpa_sm *sm)
271{
272	return 0;
273}
274
275static inline void wpa_sm_key_request(struct wpa_sm *sm, int error,
276				      int pairwise)
277{
278}
279
280static inline int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
281				   struct wpa_ie_data *data)
282{
283	return -1;
284}
285
286static inline void wpa_sm_aborted_cached(struct wpa_sm *sm)
287{
288}
289
290static inline int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
291				  const u8 *buf, size_t len)
292{
293	return -1;
294}
295
296static inline int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm,
297					  struct wpa_ie_data *data)
298{
299	return -1;
300}
301
302static inline int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf,
303					  size_t len)
304{
305	return -1;
306}
307
308static inline void wpa_sm_drop_sa(struct wpa_sm *sm)
309{
310}
311
312static inline int wpa_sm_has_ptk(struct wpa_sm *sm)
313{
314	return 0;
315}
316
317static inline void wpa_sm_update_replay_ctr(struct wpa_sm *sm,
318					    const u8 *replay_ctr)
319{
320}
321
322static inline void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm,
323					    void *network_ctx)
324{
325}
326
327static inline void wpa_sm_set_rx_replay_ctr(struct wpa_sm *sm,
328					    const u8 *rx_replay_counter)
329{
330}
331
332static inline void wpa_sm_set_ptk_kck_kek(struct wpa_sm *sm, const u8 *ptk_kck,
333					  size_t ptk_kck_len,
334					  const u8 *ptk_kek, size_t ptk_kek_len)
335{
336}
337
338#endif /* CONFIG_NO_WPA */
339
340#ifdef CONFIG_PEERKEY
341int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer);
342int wpa_sm_rx_eapol_peerkey(struct wpa_sm *sm, const u8 *src_addr,
343			    const u8 *buf, size_t len);
344#else /* CONFIG_PEERKEY */
345static inline int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer)
346{
347	return -1;
348}
349
350static inline int wpa_sm_rx_eapol_peerkey(struct wpa_sm *sm, const u8 *src_addr,
351					  const u8 *buf, size_t len)
352{
353	return 0;
354}
355#endif /* CONFIG_PEERKEY */
356
357#ifdef CONFIG_IEEE80211R
358
359int wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len);
360int wpa_ft_prepare_auth_request(struct wpa_sm *sm, const u8 *mdie);
361int wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
362			    int ft_action, const u8 *target_ap,
363			    const u8 *ric_ies, size_t ric_ies_len);
364int wpa_ft_is_completed(struct wpa_sm *sm);
365void wpa_reset_ft_completed(struct wpa_sm *sm);
366int wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies,
367				 size_t ies_len, const u8 *src_addr);
368int wpa_ft_start_over_ds(struct wpa_sm *sm, const u8 *target_ap,
369			 const u8 *mdie);
370
371#else /* CONFIG_IEEE80211R */
372
373static inline int
374wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len)
375{
376	return 0;
377}
378
379static inline int wpa_ft_prepare_auth_request(struct wpa_sm *sm,
380					      const u8 *mdie)
381{
382	return 0;
383}
384
385static inline int
386wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
387			int ft_action, const u8 *target_ap)
388{
389	return 0;
390}
391
392static inline int wpa_ft_is_completed(struct wpa_sm *sm)
393{
394	return 0;
395}
396
397static inline void wpa_reset_ft_completed(struct wpa_sm *sm)
398{
399}
400
401static inline int
402wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
403			     const u8 *src_addr)
404{
405	return -1;
406}
407
408#endif /* CONFIG_IEEE80211R */
409
410
411/* tdls.c */
412void wpa_tdls_ap_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
413void wpa_tdls_assoc_resp_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
414int wpa_tdls_start(struct wpa_sm *sm, const u8 *addr);
415void wpa_tdls_remove(struct wpa_sm *sm, const u8 *addr);
416int wpa_tdls_teardown_link(struct wpa_sm *sm, const u8 *addr, u16 reason_code);
417int wpa_tdls_send_discovery_request(struct wpa_sm *sm, const u8 *addr);
418int wpa_tdls_init(struct wpa_sm *sm);
419void wpa_tdls_teardown_peers(struct wpa_sm *sm);
420void wpa_tdls_deinit(struct wpa_sm *sm);
421void wpa_tdls_enable(struct wpa_sm *sm, int enabled);
422void wpa_tdls_disable_unreachable_link(struct wpa_sm *sm, const u8 *addr);
423const char * wpa_tdls_get_link_status(struct wpa_sm *sm, const u8 *addr);
424int wpa_tdls_is_external_setup(struct wpa_sm *sm);
425int wpa_tdls_enable_chan_switch(struct wpa_sm *sm, const u8 *addr,
426				u8 oper_class,
427				struct hostapd_freq_params *freq_params);
428int wpa_tdls_disable_chan_switch(struct wpa_sm *sm, const u8 *addr);
429#ifdef CONFIG_TDLS_TESTING
430extern unsigned int tdls_testing;
431#endif /* CONFIG_TDLS_TESTING */
432
433
434int wpa_wnmsleep_install_key(struct wpa_sm *sm, u8 subelem_id, u8 *buf);
435void wpa_sm_set_test_assoc_ie(struct wpa_sm *sm, struct wpabuf *buf);
436
437struct wpabuf * fils_build_auth(struct wpa_sm *sm);
438int fils_process_auth(struct wpa_sm *sm, const u8 *data, size_t len);
439struct wpabuf * fils_build_assoc_req(struct wpa_sm *sm, const u8 **kek,
440				     size_t *kek_len, const u8 **snonce,
441				     const u8 **anonce,
442				     const struct wpabuf **hlp,
443				     unsigned int num_hlp);
444int fils_process_assoc_resp(struct wpa_sm *sm, const u8 *resp, size_t len);
445int wpa_fils_is_completed(struct wpa_sm *sm);
446
447#endif /* WPA_H */
448