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