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