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