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