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