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