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