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