1/*
2 * Internal WPA/RSN supplicant state machine definitions
3 * Copyright (c) 2004-2017, 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
90	u8 *assoc_wpa_ie; /* Own WPA/RSN IE from (Re)AssocReq */
91	size_t assoc_wpa_ie_len;
92	u8 *ap_wpa_ie, *ap_rsn_ie;
93	size_t ap_wpa_ie_len, ap_rsn_ie_len;
94
95#ifdef CONFIG_TDLS
96	struct wpa_tdls_peer *tdls;
97	int tdls_prohibited;
98	int tdls_chan_switch_prohibited;
99	int tdls_disabled;
100
101	/* The driver supports TDLS */
102	int tdls_supported;
103
104	/*
105	 * The driver requires explicit discovery/setup/teardown frames sent
106	 * to it via tdls_mgmt.
107	 */
108	int tdls_external_setup;
109
110	/* The driver supports TDLS channel switching */
111	int tdls_chan_switch;
112#endif /* CONFIG_TDLS */
113
114#ifdef CONFIG_IEEE80211R
115	u8 xxkey[PMK_LEN]; /* PSK or the second 256 bits of MSK */
116	size_t xxkey_len;
117	u8 pmk_r0[PMK_LEN];
118	u8 pmk_r0_name[WPA_PMK_NAME_LEN];
119	u8 pmk_r1[PMK_LEN];
120	u8 pmk_r1_name[WPA_PMK_NAME_LEN];
121	u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
122	u8 r0kh_id[FT_R0KH_ID_MAX_LEN];
123	size_t r0kh_id_len;
124	u8 r1kh_id[FT_R1KH_ID_LEN];
125	int ft_completed;
126	int ft_reassoc_completed;
127	int over_the_ds_in_progress;
128	u8 target_ap[ETH_ALEN]; /* over-the-DS target AP */
129	int set_ptk_after_assoc;
130	u8 mdie_ft_capab; /* FT Capability and Policy from target AP MDIE */
131	u8 *assoc_resp_ies; /* MDIE and FTIE from (Re)Association Response */
132	size_t assoc_resp_ies_len;
133#endif /* CONFIG_IEEE80211R */
134
135#ifdef CONFIG_P2P
136	u8 p2p_ip_addr[3 * 4];
137#endif /* CONFIG_P2P */
138
139#ifdef CONFIG_TESTING_OPTIONS
140	struct wpabuf *test_assoc_ie;
141#endif /* CONFIG_TESTING_OPTIONS */
142
143#ifdef CONFIG_FILS
144	u8 fils_nonce[FILS_NONCE_LEN];
145	u8 fils_session[FILS_SESSION_LEN];
146	u8 fils_anonce[FILS_NONCE_LEN];
147	u8 fils_key_auth_ap[FILS_MAX_KEY_AUTH_LEN];
148	u8 fils_key_auth_sta[FILS_MAX_KEY_AUTH_LEN];
149	size_t fils_key_auth_len;
150	unsigned int fils_completed:1;
151	unsigned int fils_erp_pmkid_set:1;
152	unsigned int fils_cache_id_set:1;
153	u8 fils_erp_pmkid[PMKID_LEN];
154	u8 fils_cache_id[FILS_CACHE_ID_LEN];
155	struct crypto_ecdh *fils_ecdh;
156	int fils_dh_group;
157	size_t fils_dh_elem_len;
158	struct wpabuf *fils_ft_ies;
159	u8 fils_ft[FILS_FT_MAX_LEN];
160	size_t fils_ft_len;
161#endif /* CONFIG_FILS */
162
163#ifdef CONFIG_OWE
164	struct crypto_ecdh *owe_ecdh;
165	u16 owe_group;
166#endif /* CONFIG_OWE */
167};
168
169
170static inline void wpa_sm_set_state(struct wpa_sm *sm, enum wpa_states state)
171{
172	WPA_ASSERT(sm->ctx->set_state);
173	sm->ctx->set_state(sm->ctx->ctx, state);
174}
175
176static inline enum wpa_states wpa_sm_get_state(struct wpa_sm *sm)
177{
178	WPA_ASSERT(sm->ctx->get_state);
179	return sm->ctx->get_state(sm->ctx->ctx);
180}
181
182static inline void wpa_sm_deauthenticate(struct wpa_sm *sm, int reason_code)
183{
184	WPA_ASSERT(sm->ctx->deauthenticate);
185	sm->ctx->deauthenticate(sm->ctx->ctx, reason_code);
186}
187
188static inline int wpa_sm_set_key(struct wpa_sm *sm, enum wpa_alg alg,
189				 const u8 *addr, int key_idx, int set_tx,
190				 const u8 *seq, size_t seq_len,
191				 const u8 *key, size_t key_len)
192{
193	WPA_ASSERT(sm->ctx->set_key);
194	return sm->ctx->set_key(sm->ctx->ctx, alg, addr, key_idx, set_tx,
195				seq, seq_len, key, key_len);
196}
197
198static inline void * wpa_sm_get_network_ctx(struct wpa_sm *sm)
199{
200	WPA_ASSERT(sm->ctx->get_network_ctx);
201	return sm->ctx->get_network_ctx(sm->ctx->ctx);
202}
203
204static inline int wpa_sm_get_bssid(struct wpa_sm *sm, u8 *bssid)
205{
206	WPA_ASSERT(sm->ctx->get_bssid);
207	return sm->ctx->get_bssid(sm->ctx->ctx, bssid);
208}
209
210static inline int wpa_sm_ether_send(struct wpa_sm *sm, const u8 *dest,
211				    u16 proto, const u8 *buf, size_t len)
212{
213	WPA_ASSERT(sm->ctx->ether_send);
214	return sm->ctx->ether_send(sm->ctx->ctx, dest, proto, buf, len);
215}
216
217static inline int wpa_sm_get_beacon_ie(struct wpa_sm *sm)
218{
219	WPA_ASSERT(sm->ctx->get_beacon_ie);
220	return sm->ctx->get_beacon_ie(sm->ctx->ctx);
221}
222
223static inline void wpa_sm_cancel_auth_timeout(struct wpa_sm *sm)
224{
225	WPA_ASSERT(sm->ctx->cancel_auth_timeout);
226	sm->ctx->cancel_auth_timeout(sm->ctx->ctx);
227}
228
229static inline u8 * wpa_sm_alloc_eapol(struct wpa_sm *sm, u8 type,
230				      const void *data, u16 data_len,
231				      size_t *msg_len, void **data_pos)
232{
233	WPA_ASSERT(sm->ctx->alloc_eapol);
234	return sm->ctx->alloc_eapol(sm->ctx->ctx, type, data, data_len,
235				    msg_len, data_pos);
236}
237
238static inline int wpa_sm_add_pmkid(struct wpa_sm *sm, void *network_ctx,
239				   const u8 *bssid, const u8 *pmkid,
240				   const u8 *cache_id, const u8 *pmk,
241				   size_t pmk_len)
242{
243	WPA_ASSERT(sm->ctx->add_pmkid);
244	return sm->ctx->add_pmkid(sm->ctx->ctx, network_ctx, bssid, pmkid,
245				  cache_id, pmk, pmk_len);
246}
247
248static inline int wpa_sm_remove_pmkid(struct wpa_sm *sm, void *network_ctx,
249				      const u8 *bssid, const u8 *pmkid,
250				      const u8 *cache_id)
251{
252	WPA_ASSERT(sm->ctx->remove_pmkid);
253	return sm->ctx->remove_pmkid(sm->ctx->ctx, network_ctx, bssid, pmkid,
254				     cache_id);
255}
256
257static inline int wpa_sm_mlme_setprotection(struct wpa_sm *sm, const u8 *addr,
258					    int protect_type, int key_type)
259{
260	WPA_ASSERT(sm->ctx->mlme_setprotection);
261	return sm->ctx->mlme_setprotection(sm->ctx->ctx, addr, protect_type,
262					   key_type);
263}
264
265static inline int wpa_sm_update_ft_ies(struct wpa_sm *sm, const u8 *md,
266				       const u8 *ies, size_t ies_len)
267{
268	if (sm->ctx->update_ft_ies)
269		return sm->ctx->update_ft_ies(sm->ctx->ctx, md, ies, ies_len);
270	return -1;
271}
272
273static inline int wpa_sm_send_ft_action(struct wpa_sm *sm, u8 action,
274					const u8 *target_ap,
275					const u8 *ies, size_t ies_len)
276{
277	if (sm->ctx->send_ft_action)
278		return sm->ctx->send_ft_action(sm->ctx->ctx, action, target_ap,
279					       ies, ies_len);
280	return -1;
281}
282
283static inline int wpa_sm_mark_authenticated(struct wpa_sm *sm,
284					    const u8 *target_ap)
285{
286	if (sm->ctx->mark_authenticated)
287		return sm->ctx->mark_authenticated(sm->ctx->ctx, target_ap);
288	return -1;
289}
290
291static inline void wpa_sm_set_rekey_offload(struct wpa_sm *sm)
292{
293	if (!sm->ctx->set_rekey_offload)
294		return;
295	sm->ctx->set_rekey_offload(sm->ctx->ctx, sm->ptk.kek, sm->ptk.kek_len,
296				   sm->ptk.kck, sm->ptk.kck_len,
297				   sm->rx_replay_counter);
298}
299
300#ifdef CONFIG_TDLS
301static inline int wpa_sm_tdls_get_capa(struct wpa_sm *sm,
302				       int *tdls_supported,
303				       int *tdls_ext_setup,
304				       int *tdls_chan_switch)
305{
306	if (sm->ctx->tdls_get_capa)
307		return sm->ctx->tdls_get_capa(sm->ctx->ctx, tdls_supported,
308					      tdls_ext_setup, tdls_chan_switch);
309	return -1;
310}
311
312static inline int wpa_sm_send_tdls_mgmt(struct wpa_sm *sm, const u8 *dst,
313					u8 action_code, u8 dialog_token,
314					u16 status_code, u32 peer_capab,
315					int initiator, const u8 *buf,
316					size_t len)
317{
318	if (sm->ctx->send_tdls_mgmt)
319		return sm->ctx->send_tdls_mgmt(sm->ctx->ctx, dst, action_code,
320					       dialog_token, status_code,
321					       peer_capab, initiator, buf,
322					       len);
323	return -1;
324}
325
326static inline int wpa_sm_tdls_oper(struct wpa_sm *sm, int oper,
327				   const u8 *peer)
328{
329	if (sm->ctx->tdls_oper)
330		return sm->ctx->tdls_oper(sm->ctx->ctx, oper, peer);
331	return -1;
332}
333
334static inline int
335wpa_sm_tdls_peer_addset(struct wpa_sm *sm, const u8 *addr, int add,
336			u16 aid, u16 capability, const u8 *supp_rates,
337			size_t supp_rates_len,
338			const struct ieee80211_ht_capabilities *ht_capab,
339			const struct ieee80211_vht_capabilities *vht_capab,
340			u8 qosinfo, int wmm, const u8 *ext_capab,
341			size_t ext_capab_len, const u8 *supp_channels,
342			size_t supp_channels_len, const u8 *supp_oper_classes,
343			size_t supp_oper_classes_len)
344{
345	if (sm->ctx->tdls_peer_addset)
346		return sm->ctx->tdls_peer_addset(sm->ctx->ctx, addr, add,
347						 aid, capability, supp_rates,
348						 supp_rates_len, ht_capab,
349						 vht_capab, qosinfo, wmm,
350						 ext_capab, ext_capab_len,
351						 supp_channels,
352						 supp_channels_len,
353						 supp_oper_classes,
354						 supp_oper_classes_len);
355	return -1;
356}
357
358static inline int
359wpa_sm_tdls_enable_channel_switch(struct wpa_sm *sm, const u8 *addr,
360				  u8 oper_class,
361				  const struct hostapd_freq_params *freq_params)
362{
363	if (sm->ctx->tdls_enable_channel_switch)
364		return sm->ctx->tdls_enable_channel_switch(sm->ctx->ctx, addr,
365							   oper_class,
366							   freq_params);
367	return -1;
368}
369
370static inline int
371wpa_sm_tdls_disable_channel_switch(struct wpa_sm *sm, const u8 *addr)
372{
373	if (sm->ctx->tdls_disable_channel_switch)
374		return sm->ctx->tdls_disable_channel_switch(sm->ctx->ctx, addr);
375	return -1;
376}
377#endif /* CONFIG_TDLS */
378
379static inline int wpa_sm_key_mgmt_set_pmk(struct wpa_sm *sm,
380					  const u8 *pmk, size_t pmk_len)
381{
382	if (!sm->ctx->key_mgmt_set_pmk)
383		return -1;
384	return sm->ctx->key_mgmt_set_pmk(sm->ctx->ctx, pmk, pmk_len);
385}
386
387static inline void wpa_sm_fils_hlp_rx(struct wpa_sm *sm,
388				      const u8 *dst, const u8 *src,
389				      const u8 *pkt, size_t pkt_len)
390{
391	if (sm->ctx->fils_hlp_rx)
392		sm->ctx->fils_hlp_rx(sm->ctx->ctx, dst, src, pkt, pkt_len);
393}
394
395
396int wpa_eapol_key_send(struct wpa_sm *sm, struct wpa_ptk *ptk,
397		       int ver, const u8 *dest, u16 proto,
398		       u8 *msg, size_t msg_len, u8 *key_mic);
399int wpa_supplicant_send_2_of_4(struct wpa_sm *sm, const unsigned char *dst,
400			       const struct wpa_eapol_key *key,
401			       int ver, const u8 *nonce,
402			       const u8 *wpa_ie, size_t wpa_ie_len,
403			       struct wpa_ptk *ptk);
404int wpa_supplicant_send_4_of_4(struct wpa_sm *sm, const unsigned char *dst,
405			       const struct wpa_eapol_key *key,
406			       u16 ver, u16 key_info,
407			       struct wpa_ptk *ptk);
408
409int wpa_derive_ptk_ft(struct wpa_sm *sm, const unsigned char *src_addr,
410		      const struct wpa_eapol_key *key, struct wpa_ptk *ptk);
411
412void wpa_tdls_assoc(struct wpa_sm *sm);
413void wpa_tdls_disassoc(struct wpa_sm *sm);
414
415#endif /* WPA_I_H */
416