src/ap/hostapd.h

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