src/ap/hostapd.h

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