src/ap/hostapd.h

   1 /*
   2  * hostapd / Initialization and configuration
   3  * Copyright (c) 2002-2013, 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 "ap_config.h"
  14
  15 struct wpa_driver_ops;
  16 struct wpa_ctrl_dst;
  17 struct radius_server_data;
  18 struct upnp_wps_device_sm;
  19 struct hostapd_data;
  20 struct sta_info;
  21 struct hostap_sta_driver_data;
  22 struct ieee80211_ht_capabilities;
  23 struct full_dynamic_vlan;
  24 enum wps_event;
  25 union wps_event_data;
  26
  27 struct hostapd_iface;
  28 struct hostapd_dynamic_iface;
  29
  30 struct csa_settings;
  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         size_t count_dynamic;
  44         int global_ctrl_sock;
  45         char *global_iface_path;
  46         char *global_iface_name;
  47         gid_t ctrl_iface_group;
  48         struct hostapd_iface **iface;
  49         struct hostapd_dynamic_iface **dynamic_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         time_t 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
 158         int parameter_set_count;
 159
 160         /* Time Advertisement */
 161         u8 time_update_counter;
 162         struct wpabuf *time_adv;
 163
 164 #ifdef CONFIG_FULL_DYNAMIC_VLAN
 165         struct full_dynamic_vlan *full_dynamic_vlan;
 166 #endif /* CONFIG_FULL_DYNAMIC_VLAN */
 167
 168         struct l2_packet_data *l2;
 169         struct wps_context *wps;
 170
 171         int beacon_set_done;
 172         struct wpabuf *wps_beacon_ie;
 173         struct wpabuf *wps_probe_resp_ie;
 174 #ifdef CONFIG_WPS
 175         unsigned int ap_pin_failures;
 176         unsigned int ap_pin_failures_consecutive;
 177         struct upnp_wps_device_sm *wps_upnp;
 178         unsigned int ap_pin_lockout_time;
 179
 180         struct wps_stat wps_stats;
 181 #endif /* CONFIG_WPS */
 182
 183         struct hostapd_probereq_cb *probereq_cb;
 184         size_t num_probereq_cb;
 185
 186         void (*public_action_cb)(void *ctx, const u8 *buf, size_t len,
 187                                  int freq);
 188         void *public_action_cb_ctx;
 189         void (*public_action_cb2)(void *ctx, const u8 *buf, size_t len,
 190                                   int freq);
 191         void *public_action_cb2_ctx;
 192
 193         int (*vendor_action_cb)(void *ctx, const u8 *buf, size_t len,
 194                                 int freq);
 195         void *vendor_action_cb_ctx;
 196
 197         void (*wps_reg_success_cb)(void *ctx, const u8 *mac_addr,
 198                                    const u8 *uuid_e);
 199         void *wps_reg_success_cb_ctx;
 200
 201         void (*wps_event_cb)(void *ctx, enum wps_event event,
 202                              union wps_event_data *data);
 203         void *wps_event_cb_ctx;
 204
 205         void (*sta_authorized_cb)(void *ctx, const u8 *mac_addr,
 206                                   int authorized, const u8 *p2p_dev_addr);
 207         void *sta_authorized_cb_ctx;
 208
 209         void (*setup_complete_cb)(void *ctx);
 210         void *setup_complete_cb_ctx;
 211
 212         void (*new_psk_cb)(void *ctx, const u8 *mac_addr,
 213                            const u8 *p2p_dev_addr, const u8 *psk,
 214                            size_t psk_len);
 215         void *new_psk_cb_ctx;
 216
 217 #ifdef CONFIG_P2P
 218         struct p2p_data *p2p;
 219         struct p2p_group *p2p_group;
 220         struct wpabuf *p2p_beacon_ie;
 221         struct wpabuf *p2p_probe_resp_ie;
 222
 223         /* Number of non-P2P association stations */
 224         int num_sta_no_p2p;
 225
 226         /* Periodic NoA (used only when no non-P2P clients in the group) */
 227         int noa_enabled;
 228         int noa_start;
 229         int noa_duration;
 230 #endif /* CONFIG_P2P */
 231 #ifdef CONFIG_INTERWORKING
 232         size_t gas_frag_limit;
 233 #endif /* CONFIG_INTERWORKING */
 234
 235 #ifdef CONFIG_SQLITE
 236         struct hostapd_eap_user tmp_eap_user;
 237 #endif /* CONFIG_SQLITE */
 238
 239 #ifdef CONFIG_SAE
 240         /** Key used for generating SAE anti-clogging tokens */
 241         u8 sae_token_key[8];
 242         os_time_t last_sae_token_key_update;
 243 #endif /* CONFIG_SAE */
 244 };
 245
 246
 247 /**
 248  * struct hostapd_iface - hostapd per-interface data structure
 249  */
 250 struct hostapd_iface {
 251         struct hapd_interfaces *interfaces;
 252         void *owner;
 253         char *config_fname;
 254         struct hostapd_config *conf;
 255         char phy[16]; /* Name of the PHY (radio) */
 256
 257         enum hostapd_iface_state {
 258                 HAPD_IFACE_UNINITIALIZED,
 259                 HAPD_IFACE_DISABLED,
 260                 HAPD_IFACE_COUNTRY_UPDATE,
 261                 HAPD_IFACE_ACS,
 262                 HAPD_IFACE_HT_SCAN,
 263                 HAPD_IFACE_DFS,
 264                 HAPD_IFACE_ENABLED
 265         } state;
 266
 267         size_t num_bss;
 268         struct hostapd_data **bss;
 269
 270         unsigned int wait_channel_update:1;
 271         unsigned int cac_started:1;
 272
 273         int num_ap; /* number of entries in ap_list */
 274         struct ap_info *ap_list; /* AP info list head */
 275         struct ap_info *ap_hash[STA_HASH_SIZE];
 276
 277         unsigned int drv_flags;
 278
 279         /*
 280          * A bitmap of supported protocols for probe response offload. See
 281          * struct wpa_driver_capa in driver.h
 282          */
 283         unsigned int probe_resp_offloads;
 284
 285         /* extended capabilities supported by the driver */
 286         const u8 *extended_capa, *extended_capa_mask;
 287         unsigned int extended_capa_len;
 288
 289         unsigned int drv_max_acl_mac_addrs;
 290
 291         struct hostapd_hw_modes *hw_features;
 292         int num_hw_features;
 293         struct hostapd_hw_modes *current_mode;
 294         /* Rates that are currently used (i.e., filtered copy of
 295          * current_mode->channels */
 296         int num_rates;
 297         struct hostapd_rate_data *current_rates;
 298         int *basic_rates;
 299         int freq;
 300
 301         u16 hw_flags;
 302
 303         /* Number of associated Non-ERP stations (i.e., stations using 802.11b
 304          * in 802.11g BSS) */
 305         int num_sta_non_erp;
 306
 307         /* Number of associated stations that do not support Short Slot Time */
 308         int num_sta_no_short_slot_time;
 309
 310         /* Number of associated stations that do not support Short Preamble */
 311         int num_sta_no_short_preamble;
 312
 313         int olbc; /* Overlapping Legacy BSS Condition */
 314
 315         /* Number of HT associated stations that do not support greenfield */
 316         int num_sta_ht_no_gf;
 317
 318         /* Number of associated non-HT stations */
 319         int num_sta_no_ht;
 320
 321         /* Number of HT associated stations 20 MHz */
 322         int num_sta_ht_20mhz;
 323
 324         /* Overlapping BSS information */
 325         int olbc_ht;
 326
 327         u16 ht_op_mode;
 328
 329         /* surveying helpers */
 330
 331         /* number of channels surveyed */
 332         unsigned int chans_surveyed;
 333
 334         /* lowest observed noise floor in dBm */
 335         s8 lowest_nf;
 336
 337         /* channel switch parameters */
 338         int cs_freq;
 339         u8 cs_count;
 340         int cs_block_tx;
 341         unsigned int cs_c_off_beacon;
 342         unsigned int cs_c_off_proberesp;
 343         int csa_in_progress;
 344
 345 #ifdef CONFIG_ACS
 346         unsigned int acs_num_completed_scans;
 347 #endif /* CONFIG_ACS */
 348
 349         void (*scan_cb)(struct hostapd_iface *iface);
 350 };
 351
 352 /**
 353  * struct hostapd_dynamic_iface - hostapd per dynamically allocated
 354  * or added interface data structure
 355  */
 356 struct hostapd_dynamic_iface {
 357         char parent[IFNAMSIZ + 1];
 358         char iface[IFNAMSIZ + 1];
 359         unsigned int usage;
 360 };
 361
 362 /* hostapd.c */
 363 int hostapd_for_each_interface(struct hapd_interfaces *interfaces,
 364                                int (*cb)(struct hostapd_iface *iface,
 365                                          void *ctx), void *ctx);
 366 int hostapd_reload_config(struct hostapd_iface *iface);
 367 struct hostapd_data *
 368 hostapd_alloc_bss_data(struct hostapd_iface *hapd_iface,
 369                        struct hostapd_config *conf,
 370                        struct hostapd_bss_config *bss);
 371 int hostapd_setup_interface(struct hostapd_iface *iface);
 372 int hostapd_setup_interface_complete(struct hostapd_iface *iface, int err);
 373 void hostapd_interface_deinit(struct hostapd_iface *iface);
 374 void hostapd_interface_free(struct hostapd_iface *iface);
 375 struct hostapd_iface * hostapd_init(struct hapd_interfaces *interfaces,
 376                                     const char *config_file);
 377 struct hostapd_iface *
 378 hostapd_interface_init_bss(struct hapd_interfaces *interfaces, const char *phy,
 379                            const char *config_fname, int debug);
 380 void hostapd_new_assoc_sta(struct hostapd_data *hapd, struct sta_info *sta,
 381                            int reassoc);
 382 void hostapd_interface_deinit_free(struct hostapd_iface *iface);
 383 int hostapd_enable_iface(struct hostapd_iface *hapd_iface);
 384 int hostapd_reload_iface(struct hostapd_iface *hapd_iface);
 385 int hostapd_disable_iface(struct hostapd_iface *hapd_iface);
 386 int hostapd_add_iface(struct hapd_interfaces *ifaces, char *buf);
 387 int hostapd_remove_iface(struct hapd_interfaces *ifaces, char *buf);
 388 void hostapd_channel_list_updated(struct hostapd_iface *iface, int initiator);
 389 void hostapd_set_state(struct hostapd_iface *iface, enum hostapd_iface_state s);
 390 const char * hostapd_state_text(enum hostapd_iface_state s);
 391 int hostapd_switch_channel(struct hostapd_data *hapd,
 392                            struct csa_settings *settings);
 393 void hostapd_cleanup_cs_params(struct hostapd_data *hapd);
 394
 395 /* utils.c */
 396 int hostapd_register_probereq_cb(struct hostapd_data *hapd,
 397                                  int (*cb)(void *ctx, const u8 *sa,
 398                                            const u8 *da, const u8 *bssid,
 399                                            const u8 *ie, size_t ie_len,
 400                                            int ssi_signal),
 401                                  void *ctx);
 402 void hostapd_prune_associations(struct hostapd_data *hapd, const u8 *addr);
 403
 404 /* drv_callbacks.c (TODO: move to somewhere else?) */
 405 int hostapd_notif_assoc(struct hostapd_data *hapd, const u8 *addr,
 406                         const u8 *ie, size_t ielen, int reassoc);
 407 void hostapd_notif_disassoc(struct hostapd_data *hapd, const u8 *addr);
 408 void hostapd_event_sta_low_ack(struct hostapd_data *hapd, const u8 *addr);
 409 void hostapd_event_connect_failed_reason(struct hostapd_data *hapd,
 410                                          const u8 *addr, int reason_code);
 411 int hostapd_probe_req_rx(struct hostapd_data *hapd, const u8 *sa, const u8 *da,
 412                          const u8 *bssid, const u8 *ie, size_t ie_len,
 413                          int ssi_signal);
 414 void hostapd_event_ch_switch(struct hostapd_data *hapd, int freq, int ht,
 415                              int offset);
 416
 417 const struct hostapd_eap_user *
 418 hostapd_get_eap_user(struct hostapd_data *hapd, const u8 *identity,
 419                      size_t identity_len, int phase2);
 420
 421 #endif /* HOSTAPD_H */