wpa.h revision 33e38bfa7159cef089d6ee0d904778e184c72c47
1/*
2 * wpa_supplicant - WPA definitions
3 * Copyright (c) 2003-2007, 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_H
10#define WPA_H
11
12#include "common/defs.h"
13#include "common/eapol_common.h"
14#include "common/wpa_common.h"
15#include "common/ieee802_11_defs.h"
16
17struct wpa_sm;
18struct eapol_sm;
19struct wpa_config_blob;
20
21struct wpa_sm_ctx {
22	void *ctx; /* pointer to arbitrary upper level context */
23	void *msg_ctx; /* upper level context for wpa_msg() calls */
24
25	void (*set_state)(void *ctx, enum wpa_states state);
26	enum wpa_states (*get_state)(void *ctx);
27	void (*deauthenticate)(void * ctx, int reason_code);
28	int (*set_key)(void *ctx, enum wpa_alg alg,
29		       const u8 *addr, int key_idx, int set_tx,
30		       const u8 *seq, size_t seq_len,
31		       const u8 *key, size_t key_len);
32	void * (*get_network_ctx)(void *ctx);
33	int (*get_bssid)(void *ctx, u8 *bssid);
34	int (*ether_send)(void *ctx, const u8 *dest, u16 proto, const u8 *buf,
35			  size_t len);
36	int (*get_beacon_ie)(void *ctx);
37	void (*cancel_auth_timeout)(void *ctx);
38	u8 * (*alloc_eapol)(void *ctx, u8 type, const void *data, u16 data_len,
39			    size_t *msg_len, void **data_pos);
40	int (*add_pmkid)(void *ctx, const u8 *bssid, const u8 *pmkid);
41	int (*remove_pmkid)(void *ctx, const u8 *bssid, const u8 *pmkid);
42	void (*set_config_blob)(void *ctx, struct wpa_config_blob *blob);
43	const struct wpa_config_blob * (*get_config_blob)(void *ctx,
44							  const char *name);
45	int (*mlme_setprotection)(void *ctx, const u8 *addr,
46				  int protection_type, int key_type);
47	int (*update_ft_ies)(void *ctx, const u8 *md, const u8 *ies,
48			     size_t ies_len);
49	int (*send_ft_action)(void *ctx, u8 action, const u8 *target_ap,
50			      const u8 *ies, size_t ies_len);
51	int (*mark_authenticated)(void *ctx, const u8 *target_ap);
52#ifdef CONFIG_TDLS
53	int (*tdls_get_capa)(void *ctx, int *tdls_supported,
54			     int *tdls_ext_setup);
55	int (*send_tdls_mgmt)(void *ctx, const u8 *dst,
56			      u8 action_code, u8 dialog_token,
57			      u16 status_code, const u8 *buf, size_t len);
58	int (*tdls_oper)(void *ctx, int oper, const u8 *peer);
59	int (*tdls_peer_addset)(void *ctx, const u8 *addr, int add,
60				u16 capability, const u8 *supp_rates,
61				size_t supp_rates_len,
62				const struct ieee80211_ht_capabilities *ht_capab,
63				const struct ieee80211_vht_capabilities *vht_capab,
64				u8 qosinfo, const u8 *ext_capab,
65				size_t ext_capab_len);
66#endif /* CONFIG_TDLS */
67	void (*set_rekey_offload)(void *ctx, const u8 *kek, const u8 *kck,
68				  const u8 *replay_ctr);
69};
70
71
72enum wpa_sm_conf_params {
73	RSNA_PMK_LIFETIME /* dot11RSNAConfigPMKLifetime */,
74	RSNA_PMK_REAUTH_THRESHOLD /* dot11RSNAConfigPMKReauthThreshold */,
75	RSNA_SA_TIMEOUT /* dot11RSNAConfigSATimeout */,
76	WPA_PARAM_PROTO,
77	WPA_PARAM_PAIRWISE,
78	WPA_PARAM_GROUP,
79	WPA_PARAM_KEY_MGMT,
80	WPA_PARAM_MGMT_GROUP,
81	WPA_PARAM_RSN_ENABLED,
82	WPA_PARAM_MFP
83};
84
85struct rsn_supp_config {
86	void *network_ctx;
87	int peerkey_enabled;
88	int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
89	int proactive_key_caching;
90	int eap_workaround;
91	void *eap_conf_ctx;
92	const u8 *ssid;
93	size_t ssid_len;
94	int wpa_ptk_rekey;
95};
96
97#ifndef CONFIG_NO_WPA
98
99struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx);
100void wpa_sm_deinit(struct wpa_sm *sm);
101void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid);
102void wpa_sm_notify_disassoc(struct wpa_sm *sm);
103void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len);
104void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm);
105void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth);
106void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx);
107void wpa_sm_set_config(struct wpa_sm *sm, struct rsn_supp_config *config);
108void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr);
109void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
110		       const char *bridge_ifname);
111void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol);
112int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
113int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm, u8 *wpa_ie,
114				    size_t *wpa_ie_len);
115int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
116int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
117int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen);
118
119int wpa_sm_set_param(struct wpa_sm *sm, enum wpa_sm_conf_params param,
120		     unsigned int value);
121unsigned int wpa_sm_get_param(struct wpa_sm *sm,
122			      enum wpa_sm_conf_params param);
123
124int wpa_sm_get_status(struct wpa_sm *sm, char *buf, size_t buflen,
125		      int verbose);
126
127void wpa_sm_key_request(struct wpa_sm *sm, int error, int pairwise);
128
129int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
130		     struct wpa_ie_data *data);
131
132void wpa_sm_aborted_cached(struct wpa_sm *sm);
133int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
134		    const u8 *buf, size_t len);
135int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm, struct wpa_ie_data *data);
136int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf, size_t len);
137void wpa_sm_drop_sa(struct wpa_sm *sm);
138int wpa_sm_has_ptk(struct wpa_sm *sm);
139
140void wpa_sm_update_replay_ctr(struct wpa_sm *sm, const u8 *replay_ctr);
141
142void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm, void *network_ctx);
143
144#else /* CONFIG_NO_WPA */
145
146static inline struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx)
147{
148	return (struct wpa_sm *) 1;
149}
150
151static inline void wpa_sm_deinit(struct wpa_sm *sm)
152{
153}
154
155static inline void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid)
156{
157}
158
159static inline void wpa_sm_notify_disassoc(struct wpa_sm *sm)
160{
161}
162
163static inline void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk,
164				  size_t pmk_len)
165{
166}
167
168static inline void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm)
169{
170}
171
172static inline void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth)
173{
174}
175
176static inline void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx)
177{
178}
179
180static inline void wpa_sm_set_config(struct wpa_sm *sm,
181				     struct rsn_supp_config *config)
182{
183}
184
185static inline void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr)
186{
187}
188
189static inline void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
190				     const char *bridge_ifname)
191{
192}
193
194static inline void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol)
195{
196}
197
198static inline int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie,
199					  size_t len)
200{
201	return -1;
202}
203
204static inline int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm,
205						  u8 *wpa_ie,
206						  size_t *wpa_ie_len)
207{
208	return -1;
209}
210
211static inline int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie,
212				       size_t len)
213{
214	return -1;
215}
216
217static inline int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie,
218				       size_t len)
219{
220	return -1;
221}
222
223static inline int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen)
224{
225	return 0;
226}
227
228static inline int wpa_sm_set_param(struct wpa_sm *sm,
229				   enum wpa_sm_conf_params param,
230				   unsigned int value)
231{
232	return -1;
233}
234
235static inline unsigned int wpa_sm_get_param(struct wpa_sm *sm,
236					    enum wpa_sm_conf_params param)
237{
238	return 0;
239}
240
241static inline int wpa_sm_get_status(struct wpa_sm *sm, char *buf,
242				    size_t buflen, int verbose)
243{
244	return 0;
245}
246
247static inline void wpa_sm_key_request(struct wpa_sm *sm, int error,
248				      int pairwise)
249{
250}
251
252static inline int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
253				   struct wpa_ie_data *data)
254{
255	return -1;
256}
257
258static inline void wpa_sm_aborted_cached(struct wpa_sm *sm)
259{
260}
261
262static inline int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
263				  const u8 *buf, size_t len)
264{
265	return -1;
266}
267
268static inline int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm,
269					  struct wpa_ie_data *data)
270{
271	return -1;
272}
273
274static inline int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf,
275					  size_t len)
276{
277	return -1;
278}
279
280static inline void wpa_sm_drop_sa(struct wpa_sm *sm)
281{
282}
283
284static inline int wpa_sm_has_ptk(struct wpa_sm *sm)
285{
286	return 0;
287}
288
289static inline void wpa_sm_update_replay_ctr(struct wpa_sm *sm,
290					    const u8 *replay_ctr)
291{
292}
293
294static inline void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm,
295					    void *network_ctx)
296{
297}
298
299#endif /* CONFIG_NO_WPA */
300
301#ifdef CONFIG_PEERKEY
302int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer);
303#else /* CONFIG_PEERKEY */
304static inline int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer)
305{
306	return -1;
307}
308#endif /* CONFIG_PEERKEY */
309
310#ifdef CONFIG_IEEE80211R
311
312int wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len);
313int wpa_ft_prepare_auth_request(struct wpa_sm *sm, const u8 *mdie);
314int wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
315			    int ft_action, const u8 *target_ap,
316			    const u8 *ric_ies, size_t ric_ies_len);
317int wpa_ft_is_completed(struct wpa_sm *sm);
318int wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies,
319				 size_t ies_len, const u8 *src_addr);
320int wpa_ft_start_over_ds(struct wpa_sm *sm, const u8 *target_ap,
321			 const u8 *mdie);
322
323#else /* CONFIG_IEEE80211R */
324
325static inline int
326wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len)
327{
328	return 0;
329}
330
331static inline int wpa_ft_prepare_auth_request(struct wpa_sm *sm,
332					      const u8 *mdie)
333{
334	return 0;
335}
336
337static inline int
338wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
339			int ft_action, const u8 *target_ap)
340{
341	return 0;
342}
343
344static inline int wpa_ft_is_completed(struct wpa_sm *sm)
345{
346	return 0;
347}
348
349static inline int
350wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
351			     const u8 *src_addr)
352{
353	return -1;
354}
355
356#endif /* CONFIG_IEEE80211R */
357
358
359/* tdls.c */
360void wpa_tdls_ap_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
361void wpa_tdls_assoc_resp_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
362int wpa_tdls_start(struct wpa_sm *sm, const u8 *addr);
363void wpa_tdls_remove(struct wpa_sm *sm, const u8 *addr);
364int wpa_tdls_send_teardown(struct wpa_sm *sm, const u8 *addr, u16 reason_code);
365int wpa_tdls_teardown_link(struct wpa_sm *sm, const u8 *addr, u16 reason_code);
366int wpa_tdls_send_discovery_request(struct wpa_sm *sm, const u8 *addr);
367int wpa_tdls_init(struct wpa_sm *sm);
368void wpa_tdls_teardown_peers(struct wpa_sm *sm);
369void wpa_tdls_deinit(struct wpa_sm *sm);
370void wpa_tdls_enable(struct wpa_sm *sm, int enabled);
371void wpa_tdls_disable_link(struct wpa_sm *sm, const u8 *addr);
372int wpa_tdls_is_external_setup(struct wpa_sm *sm);
373
374int wpa_wnmsleep_install_key(struct wpa_sm *sm, u8 subelem_id, u8 *buf);
375
376#endif /* WPA_H */
377