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