xref: /freebsd/contrib/wpa/src/rsn_supp/wpa_i.h (revision 3468ddce672350a6d974b4f0fdf3f4a56eaab0a0)
1 /*
2  * Internal WPA/RSN supplicant state machine definitions
3  * Copyright (c) 2004-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_I_H
10 #define WPA_I_H
11 
12 #include "utils/list.h"
13 
14 struct wpa_peerkey;
15 struct wpa_tdls_peer;
16 struct wpa_eapol_key;
17 
18 /**
19  * struct wpa_sm - Internal WPA state machine data
20  */
21 struct wpa_sm {
22 	u8 pmk[PMK_LEN_MAX];
23 	size_t pmk_len;
24 	struct wpa_ptk ptk, tptk;
25 	int ptk_set, tptk_set;
26 	unsigned int msg_3_of_4_ok:1;
27 	unsigned int tk_to_set:1;
28 	u8 snonce[WPA_NONCE_LEN];
29 	u8 anonce[WPA_NONCE_LEN]; /* ANonce from the last 1/4 msg */
30 	int renew_snonce;
31 	u8 rx_replay_counter[WPA_REPLAY_COUNTER_LEN];
32 	int rx_replay_counter_set;
33 	u8 request_counter[WPA_REPLAY_COUNTER_LEN];
34 	struct wpa_gtk gtk;
35 	struct wpa_gtk gtk_wnm_sleep;
36 #ifdef CONFIG_IEEE80211W
37 	struct wpa_igtk igtk;
38 	struct wpa_igtk igtk_wnm_sleep;
39 #endif /* CONFIG_IEEE80211W */
40 
41 	struct eapol_sm *eapol; /* EAPOL state machine from upper level code */
42 
43 	struct rsn_pmksa_cache *pmksa; /* PMKSA cache */
44 	struct rsn_pmksa_cache_entry *cur_pmksa; /* current PMKSA entry */
45 	struct dl_list pmksa_candidates;
46 
47 	struct l2_packet_data *l2_preauth;
48 	struct l2_packet_data *l2_preauth_br;
49 	struct l2_packet_data *l2_tdls;
50 	u8 preauth_bssid[ETH_ALEN]; /* current RSN pre-auth peer or
51 				     * 00:00:00:00:00:00 if no pre-auth is
52 				     * in progress */
53 	struct eapol_sm *preauth_eapol;
54 
55 	struct wpa_sm_ctx *ctx;
56 
57 	void *scard_ctx; /* context for smartcard callbacks */
58 	int fast_reauth; /* whether EAP fast re-authentication is enabled */
59 
60 	void *network_ctx;
61 	int peerkey_enabled;
62 	int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
63 	int proactive_key_caching;
64 	int eap_workaround;
65 	void *eap_conf_ctx;
66 	u8 ssid[32];
67 	size_t ssid_len;
68 	int wpa_ptk_rekey;
69 	int p2p;
70 	int wpa_rsc_relaxation;
71 
72 	u8 own_addr[ETH_ALEN];
73 	const char *ifname;
74 	const char *bridge_ifname;
75 	u8 bssid[ETH_ALEN];
76 
77 	unsigned int dot11RSNAConfigPMKLifetime;
78 	unsigned int dot11RSNAConfigPMKReauthThreshold;
79 	unsigned int dot11RSNAConfigSATimeout;
80 
81 	unsigned int dot11RSNA4WayHandshakeFailures;
82 
83 	/* Selected configuration (based on Beacon/ProbeResp WPA IE) */
84 	unsigned int proto;
85 	unsigned int pairwise_cipher;
86 	unsigned int group_cipher;
87 	unsigned int key_mgmt;
88 	unsigned int mgmt_group_cipher;
89 
90 	int rsn_enabled; /* Whether RSN is enabled in configuration */
91 	int mfp; /* 0 = disabled, 1 = optional, 2 = mandatory */
92 
93 	u8 *assoc_wpa_ie; /* Own WPA/RSN IE from (Re)AssocReq */
94 	size_t assoc_wpa_ie_len;
95 	u8 *ap_wpa_ie, *ap_rsn_ie;
96 	size_t ap_wpa_ie_len, ap_rsn_ie_len;
97 
98 #ifdef CONFIG_PEERKEY
99 	struct wpa_peerkey *peerkey;
100 #endif /* CONFIG_PEERKEY */
101 #ifdef CONFIG_TDLS
102 	struct wpa_tdls_peer *tdls;
103 	int tdls_prohibited;
104 	int tdls_chan_switch_prohibited;
105 	int tdls_disabled;
106 
107 	/* The driver supports TDLS */
108 	int tdls_supported;
109 
110 	/*
111 	 * The driver requires explicit discovery/setup/teardown frames sent
112 	 * to it via tdls_mgmt.
113 	 */
114 	int tdls_external_setup;
115 
116 	/* The driver supports TDLS channel switching */
117 	int tdls_chan_switch;
118 #endif /* CONFIG_TDLS */
119 
120 #ifdef CONFIG_IEEE80211R
121 	u8 xxkey[PMK_LEN]; /* PSK or the second 256 bits of MSK */
122 	size_t xxkey_len;
123 	u8 pmk_r0[PMK_LEN];
124 	u8 pmk_r0_name[WPA_PMK_NAME_LEN];
125 	u8 pmk_r1[PMK_LEN];
126 	u8 pmk_r1_name[WPA_PMK_NAME_LEN];
127 	u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
128 	u8 r0kh_id[FT_R0KH_ID_MAX_LEN];
129 	size_t r0kh_id_len;
130 	u8 r1kh_id[FT_R1KH_ID_LEN];
131 	int ft_completed;
132 	int ft_reassoc_completed;
133 	int over_the_ds_in_progress;
134 	u8 target_ap[ETH_ALEN]; /* over-the-DS target AP */
135 	int set_ptk_after_assoc;
136 	u8 mdie_ft_capab; /* FT Capability and Policy from target AP MDIE */
137 	u8 *assoc_resp_ies; /* MDIE and FTIE from (Re)Association Response */
138 	size_t assoc_resp_ies_len;
139 #endif /* CONFIG_IEEE80211R */
140 
141 #ifdef CONFIG_P2P
142 	u8 p2p_ip_addr[3 * 4];
143 #endif /* CONFIG_P2P */
144 
145 #ifdef CONFIG_TESTING_OPTIONS
146 	struct wpabuf *test_assoc_ie;
147 #endif /* CONFIG_TESTING_OPTIONS */
148 };
149 
150 
151 static inline void wpa_sm_set_state(struct wpa_sm *sm, enum wpa_states state)
152 {
153 	WPA_ASSERT(sm->ctx->set_state);
154 	sm->ctx->set_state(sm->ctx->ctx, state);
155 }
156 
157 static inline enum wpa_states wpa_sm_get_state(struct wpa_sm *sm)
158 {
159 	WPA_ASSERT(sm->ctx->get_state);
160 	return sm->ctx->get_state(sm->ctx->ctx);
161 }
162 
163 static inline void wpa_sm_deauthenticate(struct wpa_sm *sm, int reason_code)
164 {
165 	WPA_ASSERT(sm->ctx->deauthenticate);
166 	sm->ctx->deauthenticate(sm->ctx->ctx, reason_code);
167 }
168 
169 static inline int wpa_sm_set_key(struct wpa_sm *sm, enum wpa_alg alg,
170 				 const u8 *addr, int key_idx, int set_tx,
171 				 const u8 *seq, size_t seq_len,
172 				 const u8 *key, size_t key_len)
173 {
174 	WPA_ASSERT(sm->ctx->set_key);
175 	return sm->ctx->set_key(sm->ctx->ctx, alg, addr, key_idx, set_tx,
176 				seq, seq_len, key, key_len);
177 }
178 
179 static inline void * wpa_sm_get_network_ctx(struct wpa_sm *sm)
180 {
181 	WPA_ASSERT(sm->ctx->get_network_ctx);
182 	return sm->ctx->get_network_ctx(sm->ctx->ctx);
183 }
184 
185 static inline int wpa_sm_get_bssid(struct wpa_sm *sm, u8 *bssid)
186 {
187 	WPA_ASSERT(sm->ctx->get_bssid);
188 	return sm->ctx->get_bssid(sm->ctx->ctx, bssid);
189 }
190 
191 static inline int wpa_sm_ether_send(struct wpa_sm *sm, const u8 *dest,
192 				    u16 proto, const u8 *buf, size_t len)
193 {
194 	WPA_ASSERT(sm->ctx->ether_send);
195 	return sm->ctx->ether_send(sm->ctx->ctx, dest, proto, buf, len);
196 }
197 
198 static inline int wpa_sm_get_beacon_ie(struct wpa_sm *sm)
199 {
200 	WPA_ASSERT(sm->ctx->get_beacon_ie);
201 	return sm->ctx->get_beacon_ie(sm->ctx->ctx);
202 }
203 
204 static inline void wpa_sm_cancel_auth_timeout(struct wpa_sm *sm)
205 {
206 	WPA_ASSERT(sm->ctx->cancel_auth_timeout);
207 	sm->ctx->cancel_auth_timeout(sm->ctx->ctx);
208 }
209 
210 static inline u8 * wpa_sm_alloc_eapol(struct wpa_sm *sm, u8 type,
211 				      const void *data, u16 data_len,
212 				      size_t *msg_len, void **data_pos)
213 {
214 	WPA_ASSERT(sm->ctx->alloc_eapol);
215 	return sm->ctx->alloc_eapol(sm->ctx->ctx, type, data, data_len,
216 				    msg_len, data_pos);
217 }
218 
219 static inline int wpa_sm_add_pmkid(struct wpa_sm *sm, const u8 *bssid,
220 				   const u8 *pmkid)
221 {
222 	WPA_ASSERT(sm->ctx->add_pmkid);
223 	return sm->ctx->add_pmkid(sm->ctx->ctx, bssid, pmkid);
224 }
225 
226 static inline int wpa_sm_remove_pmkid(struct wpa_sm *sm, const u8 *bssid,
227 				      const u8 *pmkid)
228 {
229 	WPA_ASSERT(sm->ctx->remove_pmkid);
230 	return sm->ctx->remove_pmkid(sm->ctx->ctx, bssid, pmkid);
231 }
232 
233 static inline int wpa_sm_mlme_setprotection(struct wpa_sm *sm, const u8 *addr,
234 					    int protect_type, int key_type)
235 {
236 	WPA_ASSERT(sm->ctx->mlme_setprotection);
237 	return sm->ctx->mlme_setprotection(sm->ctx->ctx, addr, protect_type,
238 					   key_type);
239 }
240 
241 static inline int wpa_sm_update_ft_ies(struct wpa_sm *sm, const u8 *md,
242 				       const u8 *ies, size_t ies_len)
243 {
244 	if (sm->ctx->update_ft_ies)
245 		return sm->ctx->update_ft_ies(sm->ctx->ctx, md, ies, ies_len);
246 	return -1;
247 }
248 
249 static inline int wpa_sm_send_ft_action(struct wpa_sm *sm, u8 action,
250 					const u8 *target_ap,
251 					const u8 *ies, size_t ies_len)
252 {
253 	if (sm->ctx->send_ft_action)
254 		return sm->ctx->send_ft_action(sm->ctx->ctx, action, target_ap,
255 					       ies, ies_len);
256 	return -1;
257 }
258 
259 static inline int wpa_sm_mark_authenticated(struct wpa_sm *sm,
260 					    const u8 *target_ap)
261 {
262 	if (sm->ctx->mark_authenticated)
263 		return sm->ctx->mark_authenticated(sm->ctx->ctx, target_ap);
264 	return -1;
265 }
266 
267 static inline void wpa_sm_set_rekey_offload(struct wpa_sm *sm)
268 {
269 	if (!sm->ctx->set_rekey_offload)
270 		return;
271 	sm->ctx->set_rekey_offload(sm->ctx->ctx, sm->ptk.kek, sm->ptk.kek_len,
272 				   sm->ptk.kck, sm->ptk.kck_len,
273 				   sm->rx_replay_counter);
274 }
275 
276 #ifdef CONFIG_TDLS
277 static inline int wpa_sm_tdls_get_capa(struct wpa_sm *sm,
278 				       int *tdls_supported,
279 				       int *tdls_ext_setup,
280 				       int *tdls_chan_switch)
281 {
282 	if (sm->ctx->tdls_get_capa)
283 		return sm->ctx->tdls_get_capa(sm->ctx->ctx, tdls_supported,
284 					      tdls_ext_setup, tdls_chan_switch);
285 	return -1;
286 }
287 
288 static inline int wpa_sm_send_tdls_mgmt(struct wpa_sm *sm, const u8 *dst,
289 					u8 action_code, u8 dialog_token,
290 					u16 status_code, u32 peer_capab,
291 					int initiator, const u8 *buf,
292 					size_t len)
293 {
294 	if (sm->ctx->send_tdls_mgmt)
295 		return sm->ctx->send_tdls_mgmt(sm->ctx->ctx, dst, action_code,
296 					       dialog_token, status_code,
297 					       peer_capab, initiator, buf,
298 					       len);
299 	return -1;
300 }
301 
302 static inline int wpa_sm_tdls_oper(struct wpa_sm *sm, int oper,
303 				   const u8 *peer)
304 {
305 	if (sm->ctx->tdls_oper)
306 		return sm->ctx->tdls_oper(sm->ctx->ctx, oper, peer);
307 	return -1;
308 }
309 
310 static inline int
311 wpa_sm_tdls_peer_addset(struct wpa_sm *sm, const u8 *addr, int add,
312 			u16 aid, u16 capability, const u8 *supp_rates,
313 			size_t supp_rates_len,
314 			const struct ieee80211_ht_capabilities *ht_capab,
315 			const struct ieee80211_vht_capabilities *vht_capab,
316 			u8 qosinfo, int wmm, const u8 *ext_capab,
317 			size_t ext_capab_len, const u8 *supp_channels,
318 			size_t supp_channels_len, const u8 *supp_oper_classes,
319 			size_t supp_oper_classes_len)
320 {
321 	if (sm->ctx->tdls_peer_addset)
322 		return sm->ctx->tdls_peer_addset(sm->ctx->ctx, addr, add,
323 						 aid, capability, supp_rates,
324 						 supp_rates_len, ht_capab,
325 						 vht_capab, qosinfo, wmm,
326 						 ext_capab, ext_capab_len,
327 						 supp_channels,
328 						 supp_channels_len,
329 						 supp_oper_classes,
330 						 supp_oper_classes_len);
331 	return -1;
332 }
333 
334 static inline int
335 wpa_sm_tdls_enable_channel_switch(struct wpa_sm *sm, const u8 *addr,
336 				  u8 oper_class,
337 				  const struct hostapd_freq_params *freq_params)
338 {
339 	if (sm->ctx->tdls_enable_channel_switch)
340 		return sm->ctx->tdls_enable_channel_switch(sm->ctx->ctx, addr,
341 							   oper_class,
342 							   freq_params);
343 	return -1;
344 }
345 
346 static inline int
347 wpa_sm_tdls_disable_channel_switch(struct wpa_sm *sm, const u8 *addr)
348 {
349 	if (sm->ctx->tdls_disable_channel_switch)
350 		return sm->ctx->tdls_disable_channel_switch(sm->ctx->ctx, addr);
351 	return -1;
352 }
353 #endif /* CONFIG_TDLS */
354 
355 static inline int wpa_sm_key_mgmt_set_pmk(struct wpa_sm *sm,
356 					  const u8 *pmk, size_t pmk_len)
357 {
358 	if (!sm->ctx->key_mgmt_set_pmk)
359 		return -1;
360 	return sm->ctx->key_mgmt_set_pmk(sm->ctx->ctx, pmk, pmk_len);
361 }
362 
363 int wpa_eapol_key_send(struct wpa_sm *sm, const u8 *kck, size_t kck_len,
364 		       int ver, const u8 *dest, u16 proto,
365 		       u8 *msg, size_t msg_len, u8 *key_mic);
366 int wpa_supplicant_send_2_of_4(struct wpa_sm *sm, const unsigned char *dst,
367 			       const struct wpa_eapol_key *key,
368 			       int ver, const u8 *nonce,
369 			       const u8 *wpa_ie, size_t wpa_ie_len,
370 			       struct wpa_ptk *ptk);
371 int wpa_supplicant_send_4_of_4(struct wpa_sm *sm, const unsigned char *dst,
372 			       const struct wpa_eapol_key *key,
373 			       u16 ver, u16 key_info,
374 			       struct wpa_ptk *ptk);
375 
376 int wpa_derive_ptk_ft(struct wpa_sm *sm, const unsigned char *src_addr,
377 		      const struct wpa_eapol_key *key, struct wpa_ptk *ptk);
378 
379 void wpa_tdls_assoc(struct wpa_sm *sm);
380 void wpa_tdls_disassoc(struct wpa_sm *sm);
381 
382 #endif /* WPA_I_H */
383