hostapd.h revision 818ea489ef32dcdc7c098d8a336d6e1dd8996112 
1/*
2 * hostapd / Initialization and configuration
3 * Copyright (c) 2002-2013, 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#include "drivers/driver.h"
15
16struct wpa_ctrl_dst;
17struct radius_server_data;
18struct upnp_wps_device_sm;
19struct hostapd_data;
20struct sta_info;
21struct ieee80211_ht_capabilities;
22struct full_dynamic_vlan;
23enum wps_event;
24union wps_event_data;
25
26struct hostapd_iface;
27
28struct hapd_interfaces {
29	int (*reload_config)(struct hostapd_iface *iface);
30	struct hostapd_config * (*config_read_cb)(const char *config_fname);
31	int (*ctrl_iface_init)(struct hostapd_data *hapd);
32	void (*ctrl_iface_deinit)(struct hostapd_data *hapd);
33	int (*for_each_interface)(struct hapd_interfaces *interfaces,
34				  int (*cb)(struct hostapd_iface *iface,
35					    void *ctx), void *ctx);
36	int (*driver_init)(struct hostapd_iface *iface);
37
38	size_t count;
39	int global_ctrl_sock;
40	char *global_iface_path;
41	char *global_iface_name;
42#ifndef CONFIG_NATIVE_WINDOWS
43	gid_t ctrl_iface_group;
44#endif /* CONFIG_NATIVE_WINDOWS */
45	struct hostapd_iface **iface;
46
47	size_t terminate_on_error;
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	unsigned int started:1;
104
105	u8 own_addr[ETH_ALEN];
106
107	int num_sta; /* number of entries in sta_list */
108	struct sta_info *sta_list; /* STA info list head */
109#define STA_HASH_SIZE 256
110#define STA_HASH(sta) (sta[5])
111	struct sta_info *sta_hash[STA_HASH_SIZE];
112
113	/*
114	 * Bitfield for indicating which AIDs are allocated. Only AID values
115	 * 1-2007 are used and as such, the bit at index 0 corresponds to AID
116	 * 1.
117	 */
118#define AID_WORDS ((2008 + 31) / 32)
119	u32 sta_aid[AID_WORDS];
120
121	const struct wpa_driver_ops *driver;
122	void *drv_priv;
123
124	void (*new_assoc_sta_cb)(struct hostapd_data *hapd,
125				 struct sta_info *sta, int reassoc);
126
127	void *msg_ctx; /* ctx for wpa_msg() calls */
128	void *msg_ctx_parent; /* parent interface ctx for wpa_msg() calls */
129
130	struct radius_client_data *radius;
131	u32 acct_session_id_hi, acct_session_id_lo;
132	struct radius_das_data *radius_das;
133
134	struct iapp_data *iapp;
135
136	struct hostapd_cached_radius_acl *acl_cache;
137	struct hostapd_acl_query_data *acl_queries;
138
139	struct wpa_authenticator *wpa_auth;
140	struct eapol_authenticator *eapol_auth;
141
142	struct rsn_preauth_interface *preauth_iface;
143	struct os_reltime michael_mic_failure;
144	int michael_mic_failures;
145	int tkip_countermeasures;
146
147	int ctrl_sock;
148	struct wpa_ctrl_dst *ctrl_dst;
149
150	void *ssl_ctx;
151	void *eap_sim_db_priv;
152	struct radius_server_data *radius_srv;
153
154	int parameter_set_count;
155
156	/* Time Advertisement */
157	u8 time_update_counter;
158	struct wpabuf *time_adv;
159
160#ifdef CONFIG_FULL_DYNAMIC_VLAN
161	struct full_dynamic_vlan *full_dynamic_vlan;
162#endif /* CONFIG_FULL_DYNAMIC_VLAN */
163
164	struct l2_packet_data *l2;
165	struct wps_context *wps;
166
167	int beacon_set_done;
168	struct wpabuf *wps_beacon_ie;
169	struct wpabuf *wps_probe_resp_ie;
170#ifdef CONFIG_WPS
171	unsigned int ap_pin_failures;
172	unsigned int ap_pin_failures_consecutive;
173	struct upnp_wps_device_sm *wps_upnp;
174	unsigned int ap_pin_lockout_time;
175
176	struct wps_stat wps_stats;
177#endif /* CONFIG_WPS */
178
179	struct hostapd_probereq_cb *probereq_cb;
180	size_t num_probereq_cb;
181
182	void (*public_action_cb)(void *ctx, const u8 *buf, size_t len,
183				 int freq);
184	void *public_action_cb_ctx;
185	void (*public_action_cb2)(void *ctx, const u8 *buf, size_t len,
186				  int freq);
187	void *public_action_cb2_ctx;
188
189	int (*vendor_action_cb)(void *ctx, const u8 *buf, size_t len,
190				int freq);
191	void *vendor_action_cb_ctx;
192
193	void (*wps_reg_success_cb)(void *ctx, const u8 *mac_addr,
194				   const u8 *uuid_e);
195	void *wps_reg_success_cb_ctx;
196
197	void (*wps_event_cb)(void *ctx, enum wps_event event,
198			     union wps_event_data *data);
199	void *wps_event_cb_ctx;
200
201	void (*sta_authorized_cb)(void *ctx, const u8 *mac_addr,
202				  int authorized, const u8 *p2p_dev_addr);
203	void *sta_authorized_cb_ctx;
204
205	void (*setup_complete_cb)(void *ctx);
206	void *setup_complete_cb_ctx;
207
208	void (*new_psk_cb)(void *ctx, const u8 *mac_addr,
209			   const u8 *p2p_dev_addr, const u8 *psk,
210			   size_t psk_len);
211	void *new_psk_cb_ctx;
212
213#ifdef CONFIG_P2P
214	struct p2p_data *p2p;
215	struct p2p_group *p2p_group;
216	struct wpabuf *p2p_beacon_ie;
217	struct wpabuf *p2p_probe_resp_ie;
218
219	/* Number of non-P2P association stations */
220	int num_sta_no_p2p;
221
222	/* Periodic NoA (used only when no non-P2P clients in the group) */
223	int noa_enabled;
224	int noa_start;
225	int noa_duration;
226#endif /* CONFIG_P2P */
227#ifdef CONFIG_INTERWORKING
228	size_t gas_frag_limit;
229#endif /* CONFIG_INTERWORKING */
230
231#ifdef CONFIG_SQLITE
232	struct hostapd_eap_user tmp_eap_user;
233#endif /* CONFIG_SQLITE */
234
235#ifdef CONFIG_SAE
236	/** Key used for generating SAE anti-clogging tokens */
237	u8 sae_token_key[8];
238	struct os_reltime last_sae_token_key_update;
239#endif /* CONFIG_SAE */
240
241#ifdef CONFIG_TESTING_OPTIONS
242	int ext_mgmt_frame_handling;
243#endif /* CONFIG_TESTING_OPTIONS */
244};
245
246
247/**
248 * struct hostapd_iface - hostapd per-interface data structure
249 */
250struct hostapd_iface {
251	struct hapd_interfaces *interfaces;
252	void *owner;
253	char *config_fname;
254	struct hostapd_config *conf;
255	char phy[16]; /* Name of the PHY (radio) */
256
257	enum hostapd_iface_state {
258		HAPD_IFACE_UNINITIALIZED,
259		HAPD_IFACE_DISABLED,
260		HAPD_IFACE_COUNTRY_UPDATE,
261		HAPD_IFACE_ACS,
262		HAPD_IFACE_HT_SCAN,
263		HAPD_IFACE_DFS,
264		HAPD_IFACE_ENABLED
265	} state;
266
267	size_t num_bss;
268	struct hostapd_data **bss;
269
270	unsigned int wait_channel_update:1;
271	unsigned int cac_started:1;
272
273	/*
274	 * When set, indicates that the driver will handle the AP
275	 * teardown: delete global keys, station keys, and stations.
276	 */
277	unsigned int driver_ap_teardown:1;
278
279	int num_ap; /* number of entries in ap_list */
280	struct ap_info *ap_list; /* AP info list head */
281	struct ap_info *ap_hash[STA_HASH_SIZE];
282
283	unsigned int drv_flags;
284
285	/*
286	 * A bitmap of supported protocols for probe response offload. See
287	 * struct wpa_driver_capa in driver.h
288	 */
289	unsigned int probe_resp_offloads;
290
291	/* extended capabilities supported by the driver */
292	const u8 *extended_capa, *extended_capa_mask;
293	unsigned int extended_capa_len;
294
295	unsigned int drv_max_acl_mac_addrs;
296
297	struct hostapd_hw_modes *hw_features;
298	int num_hw_features;
299	struct hostapd_hw_modes *current_mode;
300	/* Rates that are currently used (i.e., filtered copy of
301	 * current_mode->channels */
302	int num_rates;
303	struct hostapd_rate_data *current_rates;
304	int *basic_rates;
305	int freq;
306
307	u16 hw_flags;
308
309	/* Number of associated Non-ERP stations (i.e., stations using 802.11b
310	 * in 802.11g BSS) */
311	int num_sta_non_erp;
312
313	/* Number of associated stations that do not support Short Slot Time */
314	int num_sta_no_short_slot_time;
315
316	/* Number of associated stations that do not support Short Preamble */
317	int num_sta_no_short_preamble;
318
319	int olbc; /* Overlapping Legacy BSS Condition */
320
321	/* Number of HT associated stations that do not support greenfield */
322	int num_sta_ht_no_gf;
323
324	/* Number of associated non-HT stations */
325	int num_sta_no_ht;
326
327	/* Number of HT associated stations 20 MHz */
328	int num_sta_ht_20mhz;
329
330	/* Overlapping BSS information */
331	int olbc_ht;
332
333	u16 ht_op_mode;
334
335	/* surveying helpers */
336
337	/* number of channels surveyed */
338	unsigned int chans_surveyed;
339
340	/* lowest observed noise floor in dBm */
341	s8 lowest_nf;
342
343	/* channel switch parameters */
344	struct hostapd_freq_params cs_freq_params;
345	u8 cs_count;
346	int cs_block_tx;
347	unsigned int cs_c_off_beacon;
348	unsigned int cs_c_off_proberesp;
349	int csa_in_progress;
350
351#ifdef CONFIG_ACS
352	unsigned int acs_num_completed_scans;
353#endif /* CONFIG_ACS */
354
355	void (*scan_cb)(struct hostapd_iface *iface);
356};
357
358/* hostapd.c */
359int hostapd_for_each_interface(struct hapd_interfaces *interfaces,
360			       int (*cb)(struct hostapd_iface *iface,
361					 void *ctx), void *ctx);
362int hostapd_reload_config(struct hostapd_iface *iface);
363struct hostapd_data *
364hostapd_alloc_bss_data(struct hostapd_iface *hapd_iface,
365		       struct hostapd_config *conf,
366		       struct hostapd_bss_config *bss);
367int hostapd_setup_interface(struct hostapd_iface *iface);
368int hostapd_setup_interface_complete(struct hostapd_iface *iface, int err);
369void hostapd_interface_deinit(struct hostapd_iface *iface);
370void hostapd_interface_free(struct hostapd_iface *iface);
371struct hostapd_iface * hostapd_init(struct hapd_interfaces *interfaces,
372				    const char *config_file);
373struct hostapd_iface *
374hostapd_interface_init_bss(struct hapd_interfaces *interfaces, const char *phy,
375			   const char *config_fname, int debug);
376void hostapd_new_assoc_sta(struct hostapd_data *hapd, struct sta_info *sta,
377			   int reassoc);
378void hostapd_interface_deinit_free(struct hostapd_iface *iface);
379int hostapd_enable_iface(struct hostapd_iface *hapd_iface);
380int hostapd_reload_iface(struct hostapd_iface *hapd_iface);
381int hostapd_disable_iface(struct hostapd_iface *hapd_iface);
382int hostapd_add_iface(struct hapd_interfaces *ifaces, char *buf);
383int hostapd_remove_iface(struct hapd_interfaces *ifaces, char *buf);
384void hostapd_channel_list_updated(struct hostapd_iface *iface, int initiator);
385void hostapd_set_state(struct hostapd_iface *iface, enum hostapd_iface_state s);
386const char * hostapd_state_text(enum hostapd_iface_state s);
387int hostapd_switch_channel(struct hostapd_data *hapd,
388			   struct csa_settings *settings);
389void hostapd_cleanup_cs_params(struct hostapd_data *hapd);
390
391/* utils.c */
392int hostapd_register_probereq_cb(struct hostapd_data *hapd,
393				 int (*cb)(void *ctx, const u8 *sa,
394					   const u8 *da, const u8 *bssid,
395					   const u8 *ie, size_t ie_len,
396					   int ssi_signal),
397				 void *ctx);
398void hostapd_prune_associations(struct hostapd_data *hapd, const u8 *addr);
399
400/* drv_callbacks.c (TODO: move to somewhere else?) */
401int hostapd_notif_assoc(struct hostapd_data *hapd, const u8 *addr,
402			const u8 *ie, size_t ielen, int reassoc);
403void hostapd_notif_disassoc(struct hostapd_data *hapd, const u8 *addr);
404void hostapd_event_sta_low_ack(struct hostapd_data *hapd, const u8 *addr);
405void hostapd_event_connect_failed_reason(struct hostapd_data *hapd,
406					 const u8 *addr, int reason_code);
407int hostapd_probe_req_rx(struct hostapd_data *hapd, const u8 *sa, const u8 *da,
408			 const u8 *bssid, const u8 *ie, size_t ie_len,
409			 int ssi_signal);
410void hostapd_event_ch_switch(struct hostapd_data *hapd, int freq, int ht,
411			     int offset, int width, int cf1, int cf2);
412
413const struct hostapd_eap_user *
414hostapd_get_eap_user(struct hostapd_data *hapd, const u8 *identity,
415		     size_t identity_len, int phase2);
416
417#endif /* HOSTAPD_H */
418