hostapd.h revision 68d0e3ed07847339aedfac8e02f50db68c702e52 
1/*
2 * hostapd / Initialization and configuration
3 * Copyright (c) 2002-2009, 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 HOSTAPD_H
10#define HOSTAPD_H
11
12#include "common/defs.h"
13#include "ap_config.h"
14
15struct wpa_driver_ops;
16struct wpa_ctrl_dst;
17struct radius_server_data;
18struct upnp_wps_device_sm;
19struct hostapd_data;
20struct sta_info;
21struct hostap_sta_driver_data;
22struct ieee80211_ht_capabilities;
23struct full_dynamic_vlan;
24enum wps_event;
25union wps_event_data;
26
27struct hostapd_iface;
28struct hostapd_dynamic_iface;
29
30struct hapd_interfaces {
31	int (*reload_config)(struct hostapd_iface *iface);
32	struct hostapd_config * (*config_read_cb)(const char *config_fname);
33	int (*ctrl_iface_init)(struct hostapd_data *hapd);
34	void (*ctrl_iface_deinit)(struct hostapd_data *hapd);
35	int (*for_each_interface)(struct hapd_interfaces *interfaces,
36				  int (*cb)(struct hostapd_iface *iface,
37					    void *ctx), void *ctx);
38	int (*driver_init)(struct hostapd_iface *iface);
39
40	size_t count;
41	size_t count_dynamic;
42	int global_ctrl_sock;
43	char *global_iface_path;
44	char *global_iface_name;
45	gid_t ctrl_iface_group;
46	struct hostapd_iface **iface;
47	struct hostapd_dynamic_iface **dynamic_iface;
48};
49
50enum hostapd_chan_status {
51	HOSTAPD_CHAN_VALID = 0, /* channel is ready */
52	HOSTAPD_CHAN_INVALID = 1, /* no usable channel found */
53	HOSTAPD_CHAN_ACS = 2, /* ACS work being performed */
54};
55
56struct hostapd_probereq_cb {
57	int (*cb)(void *ctx, const u8 *sa, const u8 *da, const u8 *bssid,
58		  const u8 *ie, size_t ie_len, int ssi_signal);
59	void *ctx;
60};
61
62#define HOSTAPD_RATE_BASIC 0x00000001
63
64struct hostapd_rate_data {
65	int rate; /* rate in 100 kbps */
66	int flags; /* HOSTAPD_RATE_ flags */
67};
68
69struct hostapd_frame_info {
70	u32 channel;
71	u32 datarate;
72	int ssi_signal; /* dBm */
73};
74
75enum wps_status {
76	WPS_STATUS_SUCCESS = 1,
77	WPS_STATUS_FAILURE
78};
79
80enum pbc_status {
81	WPS_PBC_STATUS_DISABLE,
82	WPS_PBC_STATUS_ACTIVE,
83	WPS_PBC_STATUS_TIMEOUT,
84	WPS_PBC_STATUS_OVERLAP
85};
86
87struct wps_stat {
88	enum wps_status status;
89	enum wps_error_indication failure_reason;
90	enum pbc_status pbc_status;
91	u8 peer_addr[ETH_ALEN];
92};
93
94
95/**
96 * struct hostapd_data - hostapd per-BSS data structure
97 */
98struct hostapd_data {
99	struct hostapd_iface *iface;
100	struct hostapd_config *iconf;
101	struct hostapd_bss_config *conf;
102	int interface_added; /* virtual interface added for this BSS */
103
104	u8 own_addr[ETH_ALEN];
105
106	int num_sta; /* number of entries in sta_list */
107	struct sta_info *sta_list; /* STA info list head */
108#define STA_HASH_SIZE 256
109#define STA_HASH(sta) (sta[5])
110	struct sta_info *sta_hash[STA_HASH_SIZE];
111
112	/*
113	 * Bitfield for indicating which AIDs are allocated. Only AID values
114	 * 1-2007 are used and as such, the bit at index 0 corresponds to AID
115	 * 1.
116	 */
117#define AID_WORDS ((2008 + 31) / 32)
118	u32 sta_aid[AID_WORDS];
119
120	const struct wpa_driver_ops *driver;
121	void *drv_priv;
122
123	void (*new_assoc_sta_cb)(struct hostapd_data *hapd,
124				 struct sta_info *sta, int reassoc);
125
126	void *msg_ctx; /* ctx for wpa_msg() calls */
127	void *msg_ctx_parent; /* parent interface ctx for wpa_msg() calls */
128
129	struct radius_client_data *radius;
130	u32 acct_session_id_hi, acct_session_id_lo;
131	struct radius_das_data *radius_das;
132
133	struct iapp_data *iapp;
134
135	struct hostapd_cached_radius_acl *acl_cache;
136	struct hostapd_acl_query_data *acl_queries;
137
138	struct wpa_authenticator *wpa_auth;
139	struct eapol_authenticator *eapol_auth;
140
141	struct rsn_preauth_interface *preauth_iface;
142	time_t michael_mic_failure;
143	int michael_mic_failures;
144	int tkip_countermeasures;
145
146	int ctrl_sock;
147	struct wpa_ctrl_dst *ctrl_dst;
148
149	void *ssl_ctx;
150	void *eap_sim_db_priv;
151	struct radius_server_data *radius_srv;
152
153	int parameter_set_count;
154
155	/* DFS specific parameters */
156	int cac_started;
157
158	/* Time Advertisement */
159	u8 time_update_counter;
160	struct wpabuf *time_adv;
161
162#ifdef CONFIG_FULL_DYNAMIC_VLAN
163	struct full_dynamic_vlan *full_dynamic_vlan;
164#endif /* CONFIG_FULL_DYNAMIC_VLAN */
165
166	struct l2_packet_data *l2;
167	struct wps_context *wps;
168
169	int beacon_set_done;
170	struct wpabuf *wps_beacon_ie;
171	struct wpabuf *wps_probe_resp_ie;
172#ifdef CONFIG_WPS
173	unsigned int ap_pin_failures;
174	unsigned int ap_pin_failures_consecutive;
175	struct upnp_wps_device_sm *wps_upnp;
176	unsigned int ap_pin_lockout_time;
177
178	struct wps_stat wps_stats;
179#endif /* CONFIG_WPS */
180
181	struct hostapd_probereq_cb *probereq_cb;
182	size_t num_probereq_cb;
183
184	void (*public_action_cb)(void *ctx, const u8 *buf, size_t len,
185				 int freq);
186	void *public_action_cb_ctx;
187	void (*public_action_cb2)(void *ctx, const u8 *buf, size_t len,
188				  int freq);
189	void *public_action_cb2_ctx;
190
191	int (*vendor_action_cb)(void *ctx, const u8 *buf, size_t len,
192				int freq);
193	void *vendor_action_cb_ctx;
194
195	void (*wps_reg_success_cb)(void *ctx, const u8 *mac_addr,
196				   const u8 *uuid_e);
197	void *wps_reg_success_cb_ctx;
198
199	void (*wps_event_cb)(void *ctx, enum wps_event event,
200			     union wps_event_data *data);
201	void *wps_event_cb_ctx;
202
203	void (*sta_authorized_cb)(void *ctx, const u8 *mac_addr,
204				  int authorized, const u8 *p2p_dev_addr);
205	void *sta_authorized_cb_ctx;
206
207	void (*setup_complete_cb)(void *ctx);
208	void *setup_complete_cb_ctx;
209
210	void (*new_psk_cb)(void *ctx, const u8 *mac_addr,
211			   const u8 *p2p_dev_addr, const u8 *psk,
212			   size_t psk_len);
213	void *new_psk_cb_ctx;
214
215#ifdef CONFIG_P2P
216	struct p2p_data *p2p;
217	struct p2p_group *p2p_group;
218	struct wpabuf *p2p_beacon_ie;
219	struct wpabuf *p2p_probe_resp_ie;
220
221	/* Number of non-P2P association stations */
222	int num_sta_no_p2p;
223
224	/* Periodic NoA (used only when no non-P2P clients in the group) */
225	int noa_enabled;
226	int noa_start;
227	int noa_duration;
228#endif /* CONFIG_P2P */
229#ifdef CONFIG_INTERWORKING
230	size_t gas_frag_limit;
231#endif /* CONFIG_INTERWORKING */
232
233#ifdef CONFIG_SQLITE
234	struct hostapd_eap_user tmp_eap_user;
235#endif /* CONFIG_SQLITE */
236
237#ifdef CONFIG_SAE
238	/** Key used for generating SAE anti-clogging tokens */
239	u8 sae_token_key[8];
240	os_time_t last_sae_token_key_update;
241#endif /* CONFIG_SAE */
242};
243
244
245/**
246 * struct hostapd_iface - hostapd per-interface data structure
247 */
248struct hostapd_iface {
249	struct hapd_interfaces *interfaces;
250	void *owner;
251	char *config_fname;
252	struct hostapd_config *conf;
253
254	size_t num_bss;
255	struct hostapd_data **bss;
256
257	int num_ap; /* number of entries in ap_list */
258	struct ap_info *ap_list; /* AP info list head */
259	struct ap_info *ap_hash[STA_HASH_SIZE];
260
261	unsigned int drv_flags;
262
263	/*
264	 * A bitmap of supported protocols for probe response offload. See
265	 * struct wpa_driver_capa in driver.h
266	 */
267	unsigned int probe_resp_offloads;
268
269	/* extended capabilities supported by the driver */
270	const u8 *extended_capa, *extended_capa_mask;
271	unsigned int extended_capa_len;
272
273	unsigned int drv_max_acl_mac_addrs;
274
275	struct hostapd_hw_modes *hw_features;
276	int num_hw_features;
277	struct hostapd_hw_modes *current_mode;
278	/* Rates that are currently used (i.e., filtered copy of
279	 * current_mode->channels */
280	int num_rates;
281	struct hostapd_rate_data *current_rates;
282	int *basic_rates;
283	int freq;
284
285	u16 hw_flags;
286
287	/* Number of associated Non-ERP stations (i.e., stations using 802.11b
288	 * in 802.11g BSS) */
289	int num_sta_non_erp;
290
291	/* Number of associated stations that do not support Short Slot Time */
292	int num_sta_no_short_slot_time;
293
294	/* Number of associated stations that do not support Short Preamble */
295	int num_sta_no_short_preamble;
296
297	int olbc; /* Overlapping Legacy BSS Condition */
298
299	/* Number of HT associated stations that do not support greenfield */
300	int num_sta_ht_no_gf;
301
302	/* Number of associated non-HT stations */
303	int num_sta_no_ht;
304
305	/* Number of HT associated stations 20 MHz */
306	int num_sta_ht_20mhz;
307
308	/* Overlapping BSS information */
309	int olbc_ht;
310
311	u16 ht_op_mode;
312
313	/* surveying helpers */
314
315	/* number of channels surveyed */
316	unsigned int chans_surveyed;
317
318	/* lowest observed noise floor in dBm */
319	s8 lowest_nf;
320
321#ifdef CONFIG_ACS
322	unsigned int acs_num_completed_scans;
323#endif /* CONFIG_ACS */
324
325	void (*scan_cb)(struct hostapd_iface *iface);
326};
327
328/**
329 * struct hostapd_dynamic_iface - hostapd per dynamically allocated
330 * or added interface data structure
331 */
332struct hostapd_dynamic_iface {
333	char parent[IFNAMSIZ + 1];
334	char iface[IFNAMSIZ + 1];
335	unsigned int usage;
336};
337
338/* hostapd.c */
339int hostapd_for_each_interface(struct hapd_interfaces *interfaces,
340			       int (*cb)(struct hostapd_iface *iface,
341					 void *ctx), void *ctx);
342int hostapd_reload_config(struct hostapd_iface *iface);
343struct hostapd_data *
344hostapd_alloc_bss_data(struct hostapd_iface *hapd_iface,
345		       struct hostapd_config *conf,
346		       struct hostapd_bss_config *bss);
347int hostapd_setup_interface(struct hostapd_iface *iface);
348int hostapd_setup_interface_complete(struct hostapd_iface *iface, int err);
349void hostapd_interface_deinit(struct hostapd_iface *iface);
350void hostapd_interface_free(struct hostapd_iface *iface);
351void hostapd_new_assoc_sta(struct hostapd_data *hapd, struct sta_info *sta,
352			   int reassoc);
353void hostapd_interface_deinit_free(struct hostapd_iface *iface);
354int hostapd_enable_iface(struct hostapd_iface *hapd_iface);
355int hostapd_reload_iface(struct hostapd_iface *hapd_iface);
356int hostapd_disable_iface(struct hostapd_iface *hapd_iface);
357int hostapd_add_iface(struct hapd_interfaces *ifaces, char *buf);
358int hostapd_remove_iface(struct hapd_interfaces *ifaces, char *buf);
359
360/* utils.c */
361int hostapd_register_probereq_cb(struct hostapd_data *hapd,
362				 int (*cb)(void *ctx, const u8 *sa,
363					   const u8 *da, const u8 *bssid,
364					   const u8 *ie, size_t ie_len,
365					   int ssi_signal),
366				 void *ctx);
367void hostapd_prune_associations(struct hostapd_data *hapd, const u8 *addr);
368
369/* drv_callbacks.c (TODO: move to somewhere else?) */
370int hostapd_notif_assoc(struct hostapd_data *hapd, const u8 *addr,
371			const u8 *ie, size_t ielen, int reassoc);
372void hostapd_notif_disassoc(struct hostapd_data *hapd, const u8 *addr);
373void hostapd_event_sta_low_ack(struct hostapd_data *hapd, const u8 *addr);
374void hostapd_event_connect_failed_reason(struct hostapd_data *hapd,
375					 const u8 *addr, int reason_code);
376int hostapd_probe_req_rx(struct hostapd_data *hapd, const u8 *sa, const u8 *da,
377			 const u8 *bssid, const u8 *ie, size_t ie_len,
378			 int ssi_signal);
379void hostapd_event_ch_switch(struct hostapd_data *hapd, int freq, int ht,
380			     int offset);
381
382const struct hostapd_eap_user *
383hostapd_get_eap_user(struct hostapd_data *hapd, const u8 *identity,
384		     size_t identity_len, int phase2);
385
386#endif /* HOSTAPD_H */
387