wpa_i.h revision 324698
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
14struct wpa_peerkey;
15struct wpa_tdls_peer;
16struct wpa_eapol_key;
17
18/**
19 * struct wpa_sm - Internal WPA state machine data
20 */
21struct wpa_sm {
22	u8 pmk[PMK_LEN];
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
70	u8 own_addr[ETH_ALEN];
71	const char *ifname;
72	const char *bridge_ifname;
73	u8 bssid[ETH_ALEN];
74
75	unsigned int dot11RSNAConfigPMKLifetime;
76	unsigned int dot11RSNAConfigPMKReauthThreshold;
77	unsigned int dot11RSNAConfigSATimeout;
78
79	unsigned int dot11RSNA4WayHandshakeFailures;
80
81	/* Selected configuration (based on Beacon/ProbeResp WPA IE) */
82	unsigned int proto;
83	unsigned int pairwise_cipher;
84	unsigned int group_cipher;
85	unsigned int key_mgmt;
86	unsigned int mgmt_group_cipher;
87
88	int rsn_enabled; /* Whether RSN is enabled in configuration */
89	int mfp; /* 0 = disabled, 1 = optional, 2 = mandatory */
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_PEERKEY
97	struct wpa_peerkey *peerkey;
98#endif /* CONFIG_PEERKEY */
99#ifdef CONFIG_TDLS
100	struct wpa_tdls_peer *tdls;
101	int tdls_prohibited;
102	int tdls_chan_switch_prohibited;
103	int tdls_disabled;
104
105	/* The driver supports TDLS */
106	int tdls_supported;
107
108	/*
109	 * The driver requires explicit discovery/setup/teardown frames sent
110	 * to it via tdls_mgmt.
111	 */
112	int tdls_external_setup;
113
114	/* The driver supports TDLS channel switching */
115	int tdls_chan_switch;
116#endif /* CONFIG_TDLS */
117
118#ifdef CONFIG_IEEE80211R
119	u8 xxkey[PMK_LEN]; /* PSK or the second 256 bits of MSK */
120	size_t xxkey_len;
121	u8 pmk_r0[PMK_LEN];
122	u8 pmk_r0_name[WPA_PMK_NAME_LEN];
123	u8 pmk_r1[PMK_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	int ft_completed;
130	int ft_reassoc_completed;
131	int over_the_ds_in_progress;
132	u8 target_ap[ETH_ALEN]; /* over-the-DS target AP */
133	int set_ptk_after_assoc;
134	u8 mdie_ft_capab; /* FT Capability and Policy from target AP MDIE */
135	u8 *assoc_resp_ies; /* MDIE and FTIE from (Re)Association Response */
136	size_t assoc_resp_ies_len;
137#endif /* CONFIG_IEEE80211R */
138
139#ifdef CONFIG_P2P
140	u8 p2p_ip_addr[3 * 4];
141#endif /* CONFIG_P2P */
142};
143
144
145static inline void wpa_sm_set_state(struct wpa_sm *sm, enum wpa_states state)
146{
147	WPA_ASSERT(sm->ctx->set_state);
148	sm->ctx->set_state(sm->ctx->ctx, state);
149}
150
151static inline enum wpa_states wpa_sm_get_state(struct wpa_sm *sm)
152{
153	WPA_ASSERT(sm->ctx->get_state);
154	return sm->ctx->get_state(sm->ctx->ctx);
155}
156
157static inline void wpa_sm_deauthenticate(struct wpa_sm *sm, int reason_code)
158{
159	WPA_ASSERT(sm->ctx->deauthenticate);
160	sm->ctx->deauthenticate(sm->ctx->ctx, reason_code);
161}
162
163static inline int wpa_sm_set_key(struct wpa_sm *sm, enum wpa_alg alg,
164				 const u8 *addr, int key_idx, int set_tx,
165				 const u8 *seq, size_t seq_len,
166				 const u8 *key, size_t key_len)
167{
168	WPA_ASSERT(sm->ctx->set_key);
169	return sm->ctx->set_key(sm->ctx->ctx, alg, addr, key_idx, set_tx,
170				seq, seq_len, key, key_len);
171}
172
173static inline void * wpa_sm_get_network_ctx(struct wpa_sm *sm)
174{
175	WPA_ASSERT(sm->ctx->get_network_ctx);
176	return sm->ctx->get_network_ctx(sm->ctx->ctx);
177}
178
179static inline int wpa_sm_get_bssid(struct wpa_sm *sm, u8 *bssid)
180{
181	WPA_ASSERT(sm->ctx->get_bssid);
182	return sm->ctx->get_bssid(sm->ctx->ctx, bssid);
183}
184
185static inline int wpa_sm_ether_send(struct wpa_sm *sm, const u8 *dest,
186				    u16 proto, const u8 *buf, size_t len)
187{
188	WPA_ASSERT(sm->ctx->ether_send);
189	return sm->ctx->ether_send(sm->ctx->ctx, dest, proto, buf, len);
190}
191
192static inline int wpa_sm_get_beacon_ie(struct wpa_sm *sm)
193{
194	WPA_ASSERT(sm->ctx->get_beacon_ie);
195	return sm->ctx->get_beacon_ie(sm->ctx->ctx);
196}
197
198static inline void wpa_sm_cancel_auth_timeout(struct wpa_sm *sm)
199{
200	WPA_ASSERT(sm->ctx->cancel_auth_timeout);
201	sm->ctx->cancel_auth_timeout(sm->ctx->ctx);
202}
203
204static inline u8 * wpa_sm_alloc_eapol(struct wpa_sm *sm, u8 type,
205				      const void *data, u16 data_len,
206				      size_t *msg_len, void **data_pos)
207{
208	WPA_ASSERT(sm->ctx->alloc_eapol);
209	return sm->ctx->alloc_eapol(sm->ctx->ctx, type, data, data_len,
210				    msg_len, data_pos);
211}
212
213static inline int wpa_sm_add_pmkid(struct wpa_sm *sm, const u8 *bssid,
214				   const u8 *pmkid)
215{
216	WPA_ASSERT(sm->ctx->add_pmkid);
217	return sm->ctx->add_pmkid(sm->ctx->ctx, bssid, pmkid);
218}
219
220static inline int wpa_sm_remove_pmkid(struct wpa_sm *sm, const u8 *bssid,
221				      const u8 *pmkid)
222{
223	WPA_ASSERT(sm->ctx->remove_pmkid);
224	return sm->ctx->remove_pmkid(sm->ctx->ctx, bssid, pmkid);
225}
226
227static inline int wpa_sm_mlme_setprotection(struct wpa_sm *sm, const u8 *addr,
228					    int protect_type, int key_type)
229{
230	WPA_ASSERT(sm->ctx->mlme_setprotection);
231	return sm->ctx->mlme_setprotection(sm->ctx->ctx, addr, protect_type,
232					   key_type);
233}
234
235static inline int wpa_sm_update_ft_ies(struct wpa_sm *sm, const u8 *md,
236				       const u8 *ies, size_t ies_len)
237{
238	if (sm->ctx->update_ft_ies)
239		return sm->ctx->update_ft_ies(sm->ctx->ctx, md, ies, ies_len);
240	return -1;
241}
242
243static inline int wpa_sm_send_ft_action(struct wpa_sm *sm, u8 action,
244					const u8 *target_ap,
245					const u8 *ies, size_t ies_len)
246{
247	if (sm->ctx->send_ft_action)
248		return sm->ctx->send_ft_action(sm->ctx->ctx, action, target_ap,
249					       ies, ies_len);
250	return -1;
251}
252
253static inline int wpa_sm_mark_authenticated(struct wpa_sm *sm,
254					    const u8 *target_ap)
255{
256	if (sm->ctx->mark_authenticated)
257		return sm->ctx->mark_authenticated(sm->ctx->ctx, target_ap);
258	return -1;
259}
260
261static inline void wpa_sm_set_rekey_offload(struct wpa_sm *sm)
262{
263	if (!sm->ctx->set_rekey_offload)
264		return;
265	sm->ctx->set_rekey_offload(sm->ctx->ctx, sm->ptk.kek, sm->ptk.kek_len,
266				   sm->ptk.kck, sm->ptk.kck_len,
267				   sm->rx_replay_counter);
268}
269
270#ifdef CONFIG_TDLS
271static inline int wpa_sm_tdls_get_capa(struct wpa_sm *sm,
272				       int *tdls_supported,
273				       int *tdls_ext_setup,
274				       int *tdls_chan_switch)
275{
276	if (sm->ctx->tdls_get_capa)
277		return sm->ctx->tdls_get_capa(sm->ctx->ctx, tdls_supported,
278					      tdls_ext_setup, tdls_chan_switch);
279	return -1;
280}
281
282static inline int wpa_sm_send_tdls_mgmt(struct wpa_sm *sm, const u8 *dst,
283					u8 action_code, u8 dialog_token,
284					u16 status_code, u32 peer_capab,
285					int initiator, const u8 *buf,
286					size_t len)
287{
288	if (sm->ctx->send_tdls_mgmt)
289		return sm->ctx->send_tdls_mgmt(sm->ctx->ctx, dst, action_code,
290					       dialog_token, status_code,
291					       peer_capab, initiator, buf,
292					       len);
293	return -1;
294}
295
296static inline int wpa_sm_tdls_oper(struct wpa_sm *sm, int oper,
297				   const u8 *peer)
298{
299	if (sm->ctx->tdls_oper)
300		return sm->ctx->tdls_oper(sm->ctx->ctx, oper, peer);
301	return -1;
302}
303
304static inline int
305wpa_sm_tdls_peer_addset(struct wpa_sm *sm, const u8 *addr, int add,
306			u16 aid, u16 capability, const u8 *supp_rates,
307			size_t supp_rates_len,
308			const struct ieee80211_ht_capabilities *ht_capab,
309			const struct ieee80211_vht_capabilities *vht_capab,
310			u8 qosinfo, int wmm, const u8 *ext_capab,
311			size_t ext_capab_len, const u8 *supp_channels,
312			size_t supp_channels_len, const u8 *supp_oper_classes,
313			size_t supp_oper_classes_len)
314{
315	if (sm->ctx->tdls_peer_addset)
316		return sm->ctx->tdls_peer_addset(sm->ctx->ctx, addr, add,
317						 aid, capability, supp_rates,
318						 supp_rates_len, ht_capab,
319						 vht_capab, qosinfo, wmm,
320						 ext_capab, ext_capab_len,
321						 supp_channels,
322						 supp_channels_len,
323						 supp_oper_classes,
324						 supp_oper_classes_len);
325	return -1;
326}
327
328static inline int
329wpa_sm_tdls_enable_channel_switch(struct wpa_sm *sm, const u8 *addr,
330				  u8 oper_class,
331				  const struct hostapd_freq_params *freq_params)
332{
333	if (sm->ctx->tdls_enable_channel_switch)
334		return sm->ctx->tdls_enable_channel_switch(sm->ctx->ctx, addr,
335							   oper_class,
336							   freq_params);
337	return -1;
338}
339
340static inline int
341wpa_sm_tdls_disable_channel_switch(struct wpa_sm *sm, const u8 *addr)
342{
343	if (sm->ctx->tdls_disable_channel_switch)
344		return sm->ctx->tdls_disable_channel_switch(sm->ctx->ctx, addr);
345	return -1;
346}
347#endif /* CONFIG_TDLS */
348
349static inline int wpa_sm_key_mgmt_set_pmk(struct wpa_sm *sm,
350					  const u8 *pmk, size_t pmk_len)
351{
352	if (!sm->proactive_key_caching)
353		return 0;
354	if (!sm->ctx->key_mgmt_set_pmk)
355		return -1;
356	return sm->ctx->key_mgmt_set_pmk(sm->ctx->ctx, pmk, pmk_len);
357}
358
359void wpa_eapol_key_send(struct wpa_sm *sm, const u8 *kck, size_t kck_len,
360			int ver, const u8 *dest, u16 proto,
361			u8 *msg, size_t msg_len, u8 *key_mic);
362int wpa_supplicant_send_2_of_4(struct wpa_sm *sm, const unsigned char *dst,
363			       const struct wpa_eapol_key *key,
364			       int ver, const u8 *nonce,
365			       const u8 *wpa_ie, size_t wpa_ie_len,
366			       struct wpa_ptk *ptk);
367int wpa_supplicant_send_4_of_4(struct wpa_sm *sm, const unsigned char *dst,
368			       const struct wpa_eapol_key *key,
369			       u16 ver, u16 key_info,
370			       struct wpa_ptk *ptk);
371
372int wpa_derive_ptk_ft(struct wpa_sm *sm, const unsigned char *src_addr,
373		      const struct wpa_eapol_key *key, struct wpa_ptk *ptk);
374
375void wpa_tdls_assoc(struct wpa_sm *sm);
376void wpa_tdls_disassoc(struct wpa_sm *sm);
377
378#endif /* WPA_I_H */
379