wpa.h revision 21de214b4ba4271ca20843f3b8fba9f1501b2a89
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, u32 peer_capab,
58			      const u8 *buf, size_t len);
59	int (*tdls_oper)(void *ctx, int oper, const u8 *peer);
60	int (*tdls_peer_addset)(void *ctx, const u8 *addr, int add, u16 aid,
61				u16 capability, const u8 *supp_rates,
62				size_t supp_rates_len,
63				const struct ieee80211_ht_capabilities *ht_capab,
64				const struct ieee80211_vht_capabilities *vht_capab,
65				u8 qosinfo, const u8 *ext_capab,
66				size_t ext_capab_len, const u8 *supp_channels,
67				size_t supp_channels_len,
68				const u8 *supp_oper_classes,
69				size_t supp_oper_classes_len);
70#endif /* CONFIG_TDLS */
71	void (*set_rekey_offload)(void *ctx, const u8 *kek, const u8 *kck,
72				  const u8 *replay_ctr);
73};
74
75
76enum wpa_sm_conf_params {
77	RSNA_PMK_LIFETIME /* dot11RSNAConfigPMKLifetime */,
78	RSNA_PMK_REAUTH_THRESHOLD /* dot11RSNAConfigPMKReauthThreshold */,
79	RSNA_SA_TIMEOUT /* dot11RSNAConfigSATimeout */,
80	WPA_PARAM_PROTO,
81	WPA_PARAM_PAIRWISE,
82	WPA_PARAM_GROUP,
83	WPA_PARAM_KEY_MGMT,
84	WPA_PARAM_MGMT_GROUP,
85	WPA_PARAM_RSN_ENABLED,
86	WPA_PARAM_MFP
87};
88
89struct rsn_supp_config {
90	void *network_ctx;
91	int peerkey_enabled;
92	int allowed_pairwise_cipher; /* bitfield of WPA_CIPHER_* */
93	int proactive_key_caching;
94	int eap_workaround;
95	void *eap_conf_ctx;
96	const u8 *ssid;
97	size_t ssid_len;
98	int wpa_ptk_rekey;
99	int p2p;
100};
101
102#ifndef CONFIG_NO_WPA
103
104struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx);
105void wpa_sm_deinit(struct wpa_sm *sm);
106void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid);
107void wpa_sm_notify_disassoc(struct wpa_sm *sm);
108void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len);
109void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm);
110void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth);
111void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx);
112void wpa_sm_set_config(struct wpa_sm *sm, struct rsn_supp_config *config);
113void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr);
114void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
115		       const char *bridge_ifname);
116void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol);
117int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
118int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm, u8 *wpa_ie,
119				    size_t *wpa_ie_len);
120int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
121int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie, size_t len);
122int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen);
123
124int wpa_sm_set_param(struct wpa_sm *sm, enum wpa_sm_conf_params param,
125		     unsigned int value);
126
127int wpa_sm_get_status(struct wpa_sm *sm, char *buf, size_t buflen,
128		      int verbose);
129int wpa_sm_pmf_enabled(struct wpa_sm *sm);
130
131void wpa_sm_key_request(struct wpa_sm *sm, int error, int pairwise);
132
133int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
134		     struct wpa_ie_data *data);
135
136void wpa_sm_aborted_cached(struct wpa_sm *sm);
137int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
138		    const u8 *buf, size_t len);
139int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm, struct wpa_ie_data *data);
140int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf, size_t len);
141void wpa_sm_drop_sa(struct wpa_sm *sm);
142int wpa_sm_has_ptk(struct wpa_sm *sm);
143
144void wpa_sm_update_replay_ctr(struct wpa_sm *sm, const u8 *replay_ctr);
145
146void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm, void *network_ctx);
147
148int wpa_sm_get_p2p_ip_addr(struct wpa_sm *sm, u8 *buf);
149
150#else /* CONFIG_NO_WPA */
151
152static inline struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx)
153{
154	return (struct wpa_sm *) 1;
155}
156
157static inline void wpa_sm_deinit(struct wpa_sm *sm)
158{
159}
160
161static inline void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid)
162{
163}
164
165static inline void wpa_sm_notify_disassoc(struct wpa_sm *sm)
166{
167}
168
169static inline void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk,
170				  size_t pmk_len)
171{
172}
173
174static inline void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm)
175{
176}
177
178static inline void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth)
179{
180}
181
182static inline void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx)
183{
184}
185
186static inline void wpa_sm_set_config(struct wpa_sm *sm,
187				     struct rsn_supp_config *config)
188{
189}
190
191static inline void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr)
192{
193}
194
195static inline void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
196				     const char *bridge_ifname)
197{
198}
199
200static inline void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol)
201{
202}
203
204static inline int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie,
205					  size_t len)
206{
207	return -1;
208}
209
210static inline int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm,
211						  u8 *wpa_ie,
212						  size_t *wpa_ie_len)
213{
214	return -1;
215}
216
217static inline int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie,
218				       size_t len)
219{
220	return -1;
221}
222
223static inline int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie,
224				       size_t len)
225{
226	return -1;
227}
228
229static inline int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen)
230{
231	return 0;
232}
233
234static inline int wpa_sm_set_param(struct wpa_sm *sm,
235				   enum wpa_sm_conf_params param,
236				   unsigned int value)
237{
238	return -1;
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 int wpa_sm_pmf_enabled(struct wpa_sm *sm)
248{
249	return 0;
250}
251
252static inline void wpa_sm_key_request(struct wpa_sm *sm, int error,
253				      int pairwise)
254{
255}
256
257static inline int wpa_parse_wpa_ie(const u8 *wpa_ie, size_t wpa_ie_len,
258				   struct wpa_ie_data *data)
259{
260	return -1;
261}
262
263static inline void wpa_sm_aborted_cached(struct wpa_sm *sm)
264{
265}
266
267static inline int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
268				  const u8 *buf, size_t len)
269{
270	return -1;
271}
272
273static inline int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm,
274					  struct wpa_ie_data *data)
275{
276	return -1;
277}
278
279static inline int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf,
280					  size_t len)
281{
282	return -1;
283}
284
285static inline void wpa_sm_drop_sa(struct wpa_sm *sm)
286{
287}
288
289static inline int wpa_sm_has_ptk(struct wpa_sm *sm)
290{
291	return 0;
292}
293
294static inline void wpa_sm_update_replay_ctr(struct wpa_sm *sm,
295					    const u8 *replay_ctr)
296{
297}
298
299static inline void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm,
300					    void *network_ctx)
301{
302}
303
304#endif /* CONFIG_NO_WPA */
305
306#ifdef CONFIG_PEERKEY
307int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer);
308int wpa_sm_rx_eapol_peerkey(struct wpa_sm *sm, const u8 *src_addr,
309			    const u8 *buf, size_t len);
310#else /* CONFIG_PEERKEY */
311static inline int wpa_sm_stkstart(struct wpa_sm *sm, const u8 *peer)
312{
313	return -1;
314}
315
316static inline int wpa_sm_rx_eapol_peerkey(struct wpa_sm *sm, const u8 *src_addr,
317					  const u8 *buf, size_t len)
318{
319	return 0;
320}
321#endif /* CONFIG_PEERKEY */
322
323#ifdef CONFIG_IEEE80211R
324
325int wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len);
326int wpa_ft_prepare_auth_request(struct wpa_sm *sm, const u8 *mdie);
327int wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
328			    int ft_action, const u8 *target_ap,
329			    const u8 *ric_ies, size_t ric_ies_len);
330int wpa_ft_is_completed(struct wpa_sm *sm);
331void wpa_reset_ft_completed(struct wpa_sm *sm);
332int wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies,
333				 size_t ies_len, const u8 *src_addr);
334int wpa_ft_start_over_ds(struct wpa_sm *sm, const u8 *target_ap,
335			 const u8 *mdie);
336
337#else /* CONFIG_IEEE80211R */
338
339static inline int
340wpa_sm_set_ft_params(struct wpa_sm *sm, const u8 *ies, size_t ies_len)
341{
342	return 0;
343}
344
345static inline int wpa_ft_prepare_auth_request(struct wpa_sm *sm,
346					      const u8 *mdie)
347{
348	return 0;
349}
350
351static inline int
352wpa_ft_process_response(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
353			int ft_action, const u8 *target_ap)
354{
355	return 0;
356}
357
358static inline int wpa_ft_is_completed(struct wpa_sm *sm)
359{
360	return 0;
361}
362
363static inline void wpa_reset_ft_completed(struct wpa_sm *sm)
364{
365}
366
367static inline int
368wpa_ft_validate_reassoc_resp(struct wpa_sm *sm, const u8 *ies, size_t ies_len,
369			     const u8 *src_addr)
370{
371	return -1;
372}
373
374#endif /* CONFIG_IEEE80211R */
375
376
377/* tdls.c */
378void wpa_tdls_ap_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
379void wpa_tdls_assoc_resp_ies(struct wpa_sm *sm, const u8 *ies, size_t len);
380int wpa_tdls_start(struct wpa_sm *sm, const u8 *addr);
381void wpa_tdls_remove(struct wpa_sm *sm, const u8 *addr);
382int wpa_tdls_send_teardown(struct wpa_sm *sm, const u8 *addr, u16 reason_code);
383int wpa_tdls_teardown_link(struct wpa_sm *sm, const u8 *addr, u16 reason_code);
384int wpa_tdls_send_discovery_request(struct wpa_sm *sm, const u8 *addr);
385int wpa_tdls_init(struct wpa_sm *sm);
386void wpa_tdls_teardown_peers(struct wpa_sm *sm);
387void wpa_tdls_deinit(struct wpa_sm *sm);
388void wpa_tdls_enable(struct wpa_sm *sm, int enabled);
389void wpa_tdls_disable_link(struct wpa_sm *sm, const u8 *addr);
390const char * wpa_tdls_get_link_status(struct wpa_sm *sm, const u8 *addr);
391int wpa_tdls_is_external_setup(struct wpa_sm *sm);
392
393int wpa_wnmsleep_install_key(struct wpa_sm *sm, u8 subelem_id, u8 *buf);
394
395#endif /* WPA_H */
396