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