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