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