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