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