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
17struct wpa_ctrl_dst;
18struct radius_server_data;
19struct upnp_wps_device_sm;
20struct hostapd_data;
21struct sta_info;
22struct ieee80211_ht_capabilities;
23struct full_dynamic_vlan;
24enum wps_event;
25union wps_event_data;
26#ifdef CONFIG_MESH
27struct mesh_conf;
28#endif /* CONFIG_MESH */
29
30struct hostapd_iface;
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	int global_ctrl_sock;
44	struct dl_list 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
58enum 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
64struct 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
72struct hostapd_rate_data {
73	int rate; /* rate in 100 kbps */
74	int flags; /* HOSTAPD_RATE_ flags */
75};
76
77struct hostapd_frame_info {
78	u32 channel;
79	u32 datarate;
80	int ssi_signal; /* dBm */
81};
82
83enum wps_status {
84	WPS_STATUS_SUCCESS = 1,
85	WPS_STATUS_FAILURE
86};
87
88enum pbc_status {
89	WPS_PBC_STATUS_DISABLE,
90	WPS_PBC_STATUS_ACTIVE,
91	WPS_PBC_STATUS_TIMEOUT,
92	WPS_PBC_STATUS_OVERLAP
93};
94
95struct 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 */
106struct 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	u64 acct_session_id;
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 dl_list 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	unsigned int cs_c_off_ecsa_beacon;
232	unsigned int cs_c_off_ecsa_proberesp;
233
234	/* BSS Load */
235	unsigned int bss_load_update_timeout;
236
237#ifdef CONFIG_P2P
238	struct p2p_data *p2p;
239	struct p2p_group *p2p_group;
240	struct wpabuf *p2p_beacon_ie;
241	struct wpabuf *p2p_probe_resp_ie;
242
243	/* Number of non-P2P association stations */
244	int num_sta_no_p2p;
245
246	/* Periodic NoA (used only when no non-P2P clients in the group) */
247	int noa_enabled;
248	int noa_start;
249	int noa_duration;
250#endif /* CONFIG_P2P */
251#ifdef CONFIG_INTERWORKING
252	size_t gas_frag_limit;
253#endif /* CONFIG_INTERWORKING */
254#ifdef CONFIG_PROXYARP
255	struct l2_packet_data *sock_dhcp;
256	struct l2_packet_data *sock_ndisc;
257#endif /* CONFIG_PROXYARP */
258#ifdef CONFIG_MESH
259	int num_plinks;
260	int max_plinks;
261	void (*mesh_sta_free_cb)(struct hostapd_data *hapd,
262				 struct sta_info *sta);
263	struct wpabuf *mesh_pending_auth;
264	struct os_reltime mesh_pending_auth_time;
265	u8 mesh_required_peer[ETH_ALEN];
266#endif /* CONFIG_MESH */
267
268#ifdef CONFIG_SQLITE
269	struct hostapd_eap_user tmp_eap_user;
270#endif /* CONFIG_SQLITE */
271
272#ifdef CONFIG_SAE
273	/** Key used for generating SAE anti-clogging tokens */
274	u8 sae_token_key[8];
275	struct os_reltime last_sae_token_key_update;
276	int dot11RSNASAERetransPeriod; /* msec */
277#endif /* CONFIG_SAE */
278
279#ifdef CONFIG_TESTING_OPTIONS
280	unsigned int ext_mgmt_frame_handling:1;
281	unsigned int ext_eapol_frame_io:1;
282
283	struct l2_packet_data *l2_test;
284#endif /* CONFIG_TESTING_OPTIONS */
285
286#ifdef CONFIG_MBO
287	unsigned int mbo_assoc_disallow;
288#endif /* CONFIG_MBO */
289};
290
291
292struct hostapd_sta_info {
293	struct dl_list list;
294	u8 addr[ETH_ALEN];
295	struct os_reltime last_seen;
296};
297
298/**
299 * struct hostapd_iface - hostapd per-interface data structure
300 */
301struct hostapd_iface {
302	struct hapd_interfaces *interfaces;
303	void *owner;
304	char *config_fname;
305	struct hostapd_config *conf;
306	char phy[16]; /* Name of the PHY (radio) */
307
308	enum hostapd_iface_state {
309		HAPD_IFACE_UNINITIALIZED,
310		HAPD_IFACE_DISABLED,
311		HAPD_IFACE_COUNTRY_UPDATE,
312		HAPD_IFACE_ACS,
313		HAPD_IFACE_HT_SCAN,
314		HAPD_IFACE_DFS,
315		HAPD_IFACE_ENABLED
316	} state;
317
318#ifdef CONFIG_MESH
319	struct mesh_conf *mconf;
320#endif /* CONFIG_MESH */
321
322	size_t num_bss;
323	struct hostapd_data **bss;
324
325	unsigned int wait_channel_update:1;
326	unsigned int cac_started:1;
327#ifdef CONFIG_FST
328	struct fst_iface *fst;
329	const struct wpabuf *fst_ies;
330#endif /* CONFIG_FST */
331
332	/*
333	 * When set, indicates that the driver will handle the AP
334	 * teardown: delete global keys, station keys, and stations.
335	 */
336	unsigned int driver_ap_teardown:1;
337
338	/*
339	 * When set, indicates that this interface is part of list of
340	 * interfaces that need to be started together (synchronously).
341	 */
342	unsigned int need_to_start_in_sync:1;
343
344	/* Ready to start but waiting for other interfaces to become ready. */
345	unsigned int ready_to_start_in_sync:1;
346
347	int num_ap; /* number of entries in ap_list */
348	struct ap_info *ap_list; /* AP info list head */
349	struct ap_info *ap_hash[STA_HASH_SIZE];
350
351	u64 drv_flags;
352
353	/* SMPS modes supported by the driver (WPA_DRIVER_SMPS_MODE_*) */
354	unsigned int smps_modes;
355
356	/*
357	 * A bitmap of supported protocols for probe response offload. See
358	 * struct wpa_driver_capa in driver.h
359	 */
360	unsigned int probe_resp_offloads;
361
362	/* extended capabilities supported by the driver */
363	const u8 *extended_capa, *extended_capa_mask;
364	unsigned int extended_capa_len;
365
366	unsigned int drv_max_acl_mac_addrs;
367
368	struct hostapd_hw_modes *hw_features;
369	int num_hw_features;
370	struct hostapd_hw_modes *current_mode;
371	/* Rates that are currently used (i.e., filtered copy of
372	 * current_mode->channels */
373	int num_rates;
374	struct hostapd_rate_data *current_rates;
375	int *basic_rates;
376	int freq;
377
378	u16 hw_flags;
379
380	/* Number of associated Non-ERP stations (i.e., stations using 802.11b
381	 * in 802.11g BSS) */
382	int num_sta_non_erp;
383
384	/* Number of associated stations that do not support Short Slot Time */
385	int num_sta_no_short_slot_time;
386
387	/* Number of associated stations that do not support Short Preamble */
388	int num_sta_no_short_preamble;
389
390	int olbc; /* Overlapping Legacy BSS Condition */
391
392	/* Number of HT associated stations that do not support greenfield */
393	int num_sta_ht_no_gf;
394
395	/* Number of associated non-HT stations */
396	int num_sta_no_ht;
397
398	/* Number of HT associated stations 20 MHz */
399	int num_sta_ht_20mhz;
400
401	/* Number of HT40 intolerant stations */
402	int num_sta_ht40_intolerant;
403
404	/* Overlapping BSS information */
405	int olbc_ht;
406
407	u16 ht_op_mode;
408
409	/* surveying helpers */
410
411	/* number of channels surveyed */
412	unsigned int chans_surveyed;
413
414	/* lowest observed noise floor in dBm */
415	s8 lowest_nf;
416
417	/* channel utilization calculation */
418	u64 last_channel_time;
419	u64 last_channel_time_busy;
420	u8 channel_utilization;
421
422	/* eCSA IE will be added only if operating class is specified */
423	u8 cs_oper_class;
424
425	unsigned int dfs_cac_ms;
426	struct os_reltime dfs_cac_start;
427
428	/* Latched with the actual secondary channel information and will be
429	 * used while juggling between HT20 and HT40 modes. */
430	int secondary_ch;
431
432#ifdef CONFIG_ACS
433	unsigned int acs_num_completed_scans;
434#endif /* CONFIG_ACS */
435
436	void (*scan_cb)(struct hostapd_iface *iface);
437	int num_ht40_scan_tries;
438
439	struct dl_list sta_seen; /* struct hostapd_sta_info */
440	unsigned int num_sta_seen;
441};
442
443/* hostapd.c */
444int hostapd_for_each_interface(struct hapd_interfaces *interfaces,
445			       int (*cb)(struct hostapd_iface *iface,
446					 void *ctx), void *ctx);
447int hostapd_reload_config(struct hostapd_iface *iface);
448struct hostapd_data *
449hostapd_alloc_bss_data(struct hostapd_iface *hapd_iface,
450		       struct hostapd_config *conf,
451		       struct hostapd_bss_config *bss);
452int hostapd_setup_interface(struct hostapd_iface *iface);
453int hostapd_setup_interface_complete(struct hostapd_iface *iface, int err);
454void hostapd_interface_deinit(struct hostapd_iface *iface);
455void hostapd_interface_free(struct hostapd_iface *iface);
456struct hostapd_iface * hostapd_init(struct hapd_interfaces *interfaces,
457				    const char *config_file);
458struct hostapd_iface *
459hostapd_interface_init_bss(struct hapd_interfaces *interfaces, const char *phy,
460			   const char *config_fname, int debug);
461void hostapd_new_assoc_sta(struct hostapd_data *hapd, struct sta_info *sta,
462			   int reassoc);
463void hostapd_interface_deinit_free(struct hostapd_iface *iface);
464int hostapd_enable_iface(struct hostapd_iface *hapd_iface);
465int hostapd_reload_iface(struct hostapd_iface *hapd_iface);
466int hostapd_disable_iface(struct hostapd_iface *hapd_iface);
467int hostapd_add_iface(struct hapd_interfaces *ifaces, char *buf);
468int hostapd_remove_iface(struct hapd_interfaces *ifaces, char *buf);
469void hostapd_channel_list_updated(struct hostapd_iface *iface, int initiator);
470void hostapd_set_state(struct hostapd_iface *iface, enum hostapd_iface_state s);
471const char * hostapd_state_text(enum hostapd_iface_state s);
472int hostapd_csa_in_progress(struct hostapd_iface *iface);
473int hostapd_switch_channel(struct hostapd_data *hapd,
474			   struct csa_settings *settings);
475void
476hostapd_switch_channel_fallback(struct hostapd_iface *iface,
477				const struct hostapd_freq_params *freq_params);
478void hostapd_cleanup_cs_params(struct hostapd_data *hapd);
479void hostapd_periodic_iface(struct hostapd_iface *iface);
480
481/* utils.c */
482int hostapd_register_probereq_cb(struct hostapd_data *hapd,
483				 int (*cb)(void *ctx, const u8 *sa,
484					   const u8 *da, const u8 *bssid,
485					   const u8 *ie, size_t ie_len,
486					   int ssi_signal),
487				 void *ctx);
488void hostapd_prune_associations(struct hostapd_data *hapd, const u8 *addr);
489
490/* drv_callbacks.c (TODO: move to somewhere else?) */
491int hostapd_notif_assoc(struct hostapd_data *hapd, const u8 *addr,
492			const u8 *ie, size_t ielen, int reassoc);
493void hostapd_notif_disassoc(struct hostapd_data *hapd, const u8 *addr);
494void hostapd_event_sta_low_ack(struct hostapd_data *hapd, const u8 *addr);
495void hostapd_event_connect_failed_reason(struct hostapd_data *hapd,
496					 const u8 *addr, int reason_code);
497int hostapd_probe_req_rx(struct hostapd_data *hapd, const u8 *sa, const u8 *da,
498			 const u8 *bssid, const u8 *ie, size_t ie_len,
499			 int ssi_signal);
500void hostapd_event_ch_switch(struct hostapd_data *hapd, int freq, int ht,
501			     int offset, int width, int cf1, int cf2);
502struct survey_results;
503void hostapd_event_get_survey(struct hostapd_iface *iface,
504			      struct survey_results *survey_results);
505void hostapd_acs_channel_selected(struct hostapd_data *hapd,
506				  struct acs_selected_channels *acs_res);
507
508const struct hostapd_eap_user *
509hostapd_get_eap_user(struct hostapd_data *hapd, const u8 *identity,
510		     size_t identity_len, int phase2);
511
512struct hostapd_data * hostapd_get_iface(struct hapd_interfaces *interfaces,
513					const char *ifname);
514
515#ifdef CONFIG_FST
516void fst_hostapd_fill_iface_obj(struct hostapd_data *hapd,
517				struct fst_wpa_obj *iface_obj);
518#endif /* CONFIG_FST */
519
520#endif /* HOSTAPD_H */
521