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 hapd_interfaces {
  31         int (*reload_config)(struct hostapd_iface *iface);
  32         struct hostapd_config * (*config_read_cb)(const char *config_fname);
  33         int (*ctrl_iface_init)(struct hostapd_data *hapd);
  34         void (*ctrl_iface_deinit)(struct hostapd_data *hapd);
  35         int (*for_each_interface)(struct hapd_interfaces *interfaces,
  36                                   int (*cb)(struct hostapd_iface *iface,
  37                                             void *ctx), void *ctx);
  38         int (*driver_init)(struct hostapd_iface *iface);
  39
  40         size_t count;
  41         size_t count_dynamic;
  42         int global_ctrl_sock;
  43         char *global_iface_path;
  44         char *global_iface_name;
  45         gid_t ctrl_iface_group;
  46         struct hostapd_iface **iface;
  47         struct hostapd_dynamic_iface **dynamic_iface;
  48 };
  49
  50 enum hostapd_chan_status {
  51         HOSTAPD_CHAN_VALID = 0, /* channel is ready */
  52         HOSTAPD_CHAN_INVALID = 1, /* no usable channel found */
  53         HOSTAPD_CHAN_ACS = 2, /* ACS work being performed */
  54 };
  55
  56 struct hostapd_probereq_cb {
  57         int (*cb)(void *ctx, const u8 *sa, const u8 *da, const u8 *bssid,
  58                   const u8 *ie, size_t ie_len, int ssi_signal);
  59         void *ctx;
  60 };
  61
  62 #define HOSTAPD_RATE_BASIC 0x00000001
  63
  64 struct hostapd_rate_data {
  65         int rate; /* rate in 100 kbps */
  66         int flags; /* HOSTAPD_RATE_ flags */
  67 };
  68
  69 struct hostapd_frame_info {
  70         u32 channel;
  71         u32 datarate;
  72         int ssi_signal; /* dBm */
  73 };
  74
  75 enum wps_status {
  76         WPS_STATUS_SUCCESS = 1,
  77         WPS_STATUS_FAILURE
  78 };
  79
  80 enum pbc_status {
  81         WPS_PBC_STATUS_DISABLE,
  82         WPS_PBC_STATUS_ACTIVE,
  83         WPS_PBC_STATUS_TIMEOUT,
  84         WPS_PBC_STATUS_OVERLAP
  85 };
  86
  87 struct wps_stat {
  88         enum wps_status status;
  89         enum wps_error_indication failure_reason;
  90         enum pbc_status pbc_status;
  91         u8 peer_addr[ETH_ALEN];
  92 };
  93
  94
  95 /**
  96  * struct hostapd_data - hostapd per-BSS data structure
  97  */
  98 struct hostapd_data {
  99         struct hostapd_iface *iface;
 100         struct hostapd_config *iconf;
 101         struct hostapd_bss_config *conf;
 102
 103         u8 own_addr[ETH_ALEN];
 104
 105         int num_sta; /* number of entries in sta_list */
 106         struct sta_info *sta_list; /* STA info list head */
 107 #define STA_HASH_SIZE 256
 108 #define STA_HASH(sta) (sta[5])
 109         struct sta_info *sta_hash[STA_HASH_SIZE];
 110
 111         /*
 112          * Bitfield for indicating which AIDs are allocated. Only AID values
 113          * 1-2007 are used and as such, the bit at index 0 corresponds to AID
 114          * 1.
 115          */
 116 #define AID_WORDS ((2008 + 31) / 32)
 117         u32 sta_aid[AID_WORDS];
 118
 119         const struct wpa_driver_ops *driver;
 120         void *drv_priv;
 121
 122         void (*new_assoc_sta_cb)(struct hostapd_data *hapd,
 123                                  struct sta_info *sta, int reassoc);
 124
 125         void *msg_ctx; /* ctx for wpa_msg() calls */
 126         void *msg_ctx_parent; /* parent interface ctx for wpa_msg() calls */
 127
 128         struct radius_client_data *radius;
 129         u32 acct_session_id_hi, acct_session_id_lo;
 130         struct radius_das_data *radius_das;
 131
 132         struct iapp_data *iapp;
 133
 134         struct hostapd_cached_radius_acl *acl_cache;
 135         struct hostapd_acl_query_data *acl_queries;
 136
 137         struct wpa_authenticator *wpa_auth;
 138         struct eapol_authenticator *eapol_auth;
 139
 140         struct rsn_preauth_interface *preauth_iface;
 141         time_t michael_mic_failure;
 142         int michael_mic_failures;
 143         int tkip_countermeasures;
 144
 145         int ctrl_sock;
 146         struct wpa_ctrl_dst *ctrl_dst;
 147
 148         void *ssl_ctx;
 149         void *eap_sim_db_priv;
 150         struct radius_server_data *radius_srv;
 151
 152         int parameter_set_count;
 153
 154         /* DFS specific parameters */
 155         int cac_started;
 156
 157         /* Time Advertisement */
 158         u8 time_update_counter;
 159         struct wpabuf *time_adv;
 160
 161 #ifdef CONFIG_FULL_DYNAMIC_VLAN
 162         struct full_dynamic_vlan *full_dynamic_vlan;
 163 #endif /* CONFIG_FULL_DYNAMIC_VLAN */
 164
 165         struct l2_packet_data *l2;
 166         struct wps_context *wps;
 167
 168         int beacon_set_done;
 169         struct wpabuf *wps_beacon_ie;
 170         struct wpabuf *wps_probe_resp_ie;
 171 #ifdef CONFIG_WPS
 172         unsigned int ap_pin_failures;
 173         unsigned int ap_pin_failures_consecutive;
 174         struct upnp_wps_device_sm *wps_upnp;
 175         unsigned int ap_pin_lockout_time;
 176
 177         struct wps_stat wps_stats;
 178 #endif /* CONFIG_WPS */
 179
 180         struct hostapd_probereq_cb *probereq_cb;
 181         size_t num_probereq_cb;
 182
 183         void (*public_action_cb)(void *ctx, const u8 *buf, size_t len,
 184                                  int freq);
 185         void *public_action_cb_ctx;
 186         void (*public_action_cb2)(void *ctx, const u8 *buf, size_t len,
 187                                   int freq);
 188         void *public_action_cb2_ctx;
 189
 190         int (*vendor_action_cb)(void *ctx, const u8 *buf, size_t len,
 191                                 int freq);
 192         void *vendor_action_cb_ctx;
 193
 194         void (*wps_reg_success_cb)(void *ctx, const u8 *mac_addr,
 195                                    const u8 *uuid_e);
 196         void *wps_reg_success_cb_ctx;
 197
 198         void (*wps_event_cb)(void *ctx, enum wps_event event,
 199                              union wps_event_data *data);
 200         void *wps_event_cb_ctx;
 201
 202         void (*sta_authorized_cb)(void *ctx, const u8 *mac_addr,
 203                                   int authorized, const u8 *p2p_dev_addr);
 204         void *sta_authorized_cb_ctx;
 205
 206         void (*setup_complete_cb)(void *ctx);
 207         void *setup_complete_cb_ctx;
 208
 209         void (*new_psk_cb)(void *ctx, const u8 *mac_addr,
 210                            const u8 *p2p_dev_addr, const u8 *psk,
 211                            size_t psk_len);
 212         void *new_psk_cb_ctx;
 213
 214 #ifdef CONFIG_P2P
 215         struct p2p_data *p2p;
 216         struct p2p_group *p2p_group;
 217         struct wpabuf *p2p_beacon_ie;
 218         struct wpabuf *p2p_probe_resp_ie;
 219
 220         /* Number of non-P2P association stations */
 221         int num_sta_no_p2p;
 222
 223         /* Periodic NoA (used only when no non-P2P clients in the group) */
 224         int noa_enabled;
 225         int noa_start;
 226         int noa_duration;
 227 #endif /* CONFIG_P2P */
 228 #ifdef CONFIG_INTERWORKING
 229         size_t gas_frag_limit;
 230 #endif /* CONFIG_INTERWORKING */
 231
 232 #ifdef CONFIG_SQLITE
 233         struct hostapd_eap_user tmp_eap_user;
 234 #endif /* CONFIG_SQLITE */
 235
 236 #ifdef CONFIG_SAE
 237         /** Key used for generating SAE anti-clogging tokens */
 238         u8 sae_token_key[8];
 239         os_time_t last_sae_token_key_update;
 240 #endif /* CONFIG_SAE */
 241 };
 242
 243
 244 /**
 245  * struct hostapd_iface - hostapd per-interface data structure
 246  */
 247 struct hostapd_iface {
 248         struct hapd_interfaces *interfaces;
 249         void *owner;
 250         char *config_fname;
 251         struct hostapd_config *conf;
 252         char phy[16]; /* Name of the PHY (radio) */
 253
 254         enum hostapd_iface_state {
 255                 HAPD_IFACE_UNINITIALIZED,
 256                 HAPD_IFACE_DISABLED,
 257                 HAPD_IFACE_COUNTRY_UPDATE,
 258                 HAPD_IFACE_ACS,
 259                 HAPD_IFACE_HT_SCAN,
 260                 HAPD_IFACE_DFS,
 261                 HAPD_IFACE_ENABLED
 262         } state;
 263
 264         size_t num_bss;
 265         struct hostapd_data **bss;
 266
 267         unsigned int wait_channel_update:1;
 268
 269         int num_ap; /* number of entries in ap_list */
 270         struct ap_info *ap_list; /* AP info list head */
 271         struct ap_info *ap_hash[STA_HASH_SIZE];
 272
 273         unsigned int drv_flags;
 274
 275         /*
 276          * A bitmap of supported protocols for probe response offload. See
 277          * struct wpa_driver_capa in driver.h
 278          */
 279         unsigned int probe_resp_offloads;
 280
 281         /* extended capabilities supported by the driver */
 282         const u8 *extended_capa, *extended_capa_mask;
 283         unsigned int extended_capa_len;
 284
 285         unsigned int drv_max_acl_mac_addrs;
 286
 287         struct hostapd_hw_modes *hw_features;
 288         int num_hw_features;
 289         struct hostapd_hw_modes *current_mode;
 290         /* Rates that are currently used (i.e., filtered copy of
 291          * current_mode->channels */
 292         int num_rates;
 293         struct hostapd_rate_data *current_rates;
 294         int *basic_rates;
 295         int freq;
 296
 297         u16 hw_flags;
 298
 299         /* Number of associated Non-ERP stations (i.e., stations using 802.11b
 300          * in 802.11g BSS) */
 301         int num_sta_non_erp;
 302
 303         /* Number of associated stations that do not support Short Slot Time */
 304         int num_sta_no_short_slot_time;
 305
 306         /* Number of associated stations that do not support Short Preamble */
 307         int num_sta_no_short_preamble;
 308
 309         int olbc; /* Overlapping Legacy BSS Condition */
 310
 311         /* Number of HT associated stations that do not support greenfield */
 312         int num_sta_ht_no_gf;
 313
 314         /* Number of associated non-HT stations */
 315         int num_sta_no_ht;
 316
 317         /* Number of HT associated stations 20 MHz */
 318         int num_sta_ht_20mhz;
 319
 320         /* Overlapping BSS information */
 321         int olbc_ht;
 322
 323         u16 ht_op_mode;
 324
 325         /* surveying helpers */
 326
 327         /* number of channels surveyed */
 328         unsigned int chans_surveyed;
 329
 330         /* lowest observed noise floor in dBm */
 331         s8 lowest_nf;
 332
 333 #ifdef CONFIG_ACS
 334         unsigned int acs_num_completed_scans;
 335 #endif /* CONFIG_ACS */
 336
 337         void (*scan_cb)(struct hostapd_iface *iface);
 338 };
 339
 340 /**
 341  * struct hostapd_dynamic_iface - hostapd per dynamically allocated
 342  * or added interface data structure
 343  */
 344 struct hostapd_dynamic_iface {
 345         char parent[IFNAMSIZ + 1];
 346         char iface[IFNAMSIZ + 1];
 347         unsigned int usage;
 348 };
 349
 350 /* hostapd.c */
 351 int hostapd_for_each_interface(struct hapd_interfaces *interfaces,
 352                                int (*cb)(struct hostapd_iface *iface,
 353                                          void *ctx), void *ctx);
 354 int hostapd_reload_config(struct hostapd_iface *iface);
 355 struct hostapd_data *
 356 hostapd_alloc_bss_data(struct hostapd_iface *hapd_iface,
 357                        struct hostapd_config *conf,
 358                        struct hostapd_bss_config *bss);
 359 int hostapd_setup_interface(struct hostapd_iface *iface);
 360 int hostapd_setup_interface_complete(struct hostapd_iface *iface, int err);
 361 void hostapd_interface_deinit(struct hostapd_iface *iface);
 362 void hostapd_interface_free(struct hostapd_iface *iface);
 363 struct hostapd_iface * hostapd_init(struct hapd_interfaces *interfaces,
 364                                     const char *config_file);
 365 struct hostapd_iface *
 366 hostapd_interface_init_bss(struct hapd_interfaces *interfaces, const char *phy,
 367                            const char *config_fname, int debug);
 368 void hostapd_new_assoc_sta(struct hostapd_data *hapd, struct sta_info *sta,
 369                            int reassoc);
 370 void hostapd_interface_deinit_free(struct hostapd_iface *iface);
 371 int hostapd_enable_iface(struct hostapd_iface *hapd_iface);
 372 int hostapd_reload_iface(struct hostapd_iface *hapd_iface);
 373 int hostapd_disable_iface(struct hostapd_iface *hapd_iface);
 374 int hostapd_add_iface(struct hapd_interfaces *ifaces, char *buf);
 375 int hostapd_remove_iface(struct hapd_interfaces *ifaces, char *buf);
 376 void hostapd_channel_list_updated(struct hostapd_iface *iface);
 377 void hostapd_set_state(struct hostapd_iface *iface, enum hostapd_iface_state s);
 378 const char * hostapd_state_text(enum hostapd_iface_state s);
 379
 380 /* utils.c */
 381 int hostapd_register_probereq_cb(struct hostapd_data *hapd,
 382                                  int (*cb)(void *ctx, const u8 *sa,
 383                                            const u8 *da, const u8 *bssid,
 384                                            const u8 *ie, size_t ie_len,
 385                                            int ssi_signal),
 386                                  void *ctx);
 387 void hostapd_prune_associations(struct hostapd_data *hapd, const u8 *addr);
 388
 389 /* drv_callbacks.c (TODO: move to somewhere else?) */
 390 int hostapd_notif_assoc(struct hostapd_data *hapd, const u8 *addr,
 391                         const u8 *ie, size_t ielen, int reassoc);
 392 void hostapd_notif_disassoc(struct hostapd_data *hapd, const u8 *addr);
 393 void hostapd_event_sta_low_ack(struct hostapd_data *hapd, const u8 *addr);
 394 void hostapd_event_connect_failed_reason(struct hostapd_data *hapd,
 395                                          const u8 *addr, int reason_code);
 396 int hostapd_probe_req_rx(struct hostapd_data *hapd, const u8 *sa, const u8 *da,
 397                          const u8 *bssid, const u8 *ie, size_t ie_len,
 398                          int ssi_signal);
 399 void hostapd_event_ch_switch(struct hostapd_data *hapd, int freq, int ht,
 400                              int offset);
 401
 402 const struct hostapd_eap_user *
 403 hostapd_get_eap_user(struct hostapd_data *hapd, const u8 *identity,
 404                      size_t identity_len, int phase2);
 405
 406 #endif /* HOSTAPD_H */