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