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