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