wpa_supplicant_i.h

Go to the documentation of this file.

#ifndef WPA_SUPPLICANT_I_H
#define WPA_SUPPLICANT_I_H

#include "common/defs.h"

extern const char *wpa_supplicant_version;
extern const char *wpa_supplicant_license;
#ifndef CONFIG_NO_STDOUT_DEBUG
extern const char *wpa_supplicant_full_license1;
extern const char *wpa_supplicant_full_license2;
extern const char *wpa_supplicant_full_license3;
extern const char *wpa_supplicant_full_license4;
extern const char *wpa_supplicant_full_license5;
#endif /* CONFIG_NO_STDOUT_DEBUG */

struct wpa_scan_result;
struct wpa_scan_res;
struct wpa_sm;
struct wpa_supplicant;
struct ibss_rsn;

/*
 * Forward declarations of private structures used within the ctrl_iface
 * backends. Other parts of wpa_supplicant do not have access to data stored in
 * these structures.
 */
struct ctrl_iface_priv;
struct ctrl_iface_global_priv;
struct ctrl_iface_dbus_priv;

struct wpa_interface {
        const char *confname;

        const char *ctrl_interface;

        const char *driver;

        const char *driver_param;

        const char *ifname;

        const char *bridge_ifname;
};

struct wpa_params {
        int daemonize;

        int wait_for_monitor;

        char *pid_file;

        int wpa_debug_level;

        int wpa_debug_show_keys;

        int wpa_debug_timestamp;

        char *ctrl_interface;

        int dbus_ctrl_interface;

        const char *wpa_debug_file_path;

        int wpa_debug_syslog;

        char *override_driver;

        char *override_ctrl_interface;
};

struct wpa_global {
        struct wpa_supplicant *ifaces;
        struct wpa_params params;
        struct ctrl_iface_global_priv *ctrl_iface;
        /* old DBus API data */
        struct ctrl_iface_dbus_priv *dbus_ctrl_iface;
        /* new DBus API data */
        struct ctrl_iface_dbus_new_priv *dbus_new_ctrl_iface;
        void **drv_priv;
        size_t drv_count;
};


struct wpa_client_mlme {
#ifdef CONFIG_CLIENT_MLME
        enum {
                IEEE80211_DISABLED, IEEE80211_AUTHENTICATE,
                IEEE80211_ASSOCIATE, IEEE80211_ASSOCIATED,
                IEEE80211_IBSS_SEARCH, IEEE80211_IBSS_JOINED
        } state;
        u8 prev_bssid[ETH_ALEN];
        u8 ssid[32];
        size_t ssid_len;
        u16 aid;
        u16 ap_capab, capab;
        u8 *extra_ie; /* to be added to the end of AssocReq */
        size_t extra_ie_len;
        u8 *extra_probe_ie; /* to be added to the end of ProbeReq */
        size_t extra_probe_ie_len;
        wpa_key_mgmt key_mgmt;

        /* The last AssocReq/Resp IEs */
        u8 *assocreq_ies, *assocresp_ies;
        size_t assocreq_ies_len, assocresp_ies_len;

        int auth_tries, assoc_tries;

        unsigned int ssid_set:1;
        unsigned int bssid_set:1;
        unsigned int prev_bssid_set:1;
        unsigned int authenticated:1;
        unsigned int associated:1;
        unsigned int probereq_poll:1;
        unsigned int use_protection:1;
        unsigned int create_ibss:1;
        unsigned int mixed_cell:1;
        unsigned int wmm_enabled:1;

        struct os_time last_probe;

#define IEEE80211_AUTH_ALG_OPEN BIT(0)
#define IEEE80211_AUTH_ALG_SHARED_KEY BIT(1)
#define IEEE80211_AUTH_ALG_LEAP BIT(2)
        unsigned int auth_algs; /* bitfield of allowed auth algs */
        int auth_alg; /* currently used IEEE 802.11 authentication algorithm */
        int auth_transaction;

        struct os_time ibss_join_req;
        u8 *probe_resp; /* ProbeResp template for IBSS */
        size_t probe_resp_len;
        u32 supp_rates_bits;

        int wmm_last_param_set;

        int sta_scanning;
        int scan_hw_mode_idx;
        int scan_channel_idx;
        enum { SCAN_SET_CHANNEL, SCAN_SEND_PROBE } scan_state;
        struct os_time last_scan_completed;
        int scan_oper_channel;
        int scan_oper_freq;
        int scan_oper_phymode;
        u8 scan_ssid[32];
        size_t scan_ssid_len;
        int scan_skip_11b;

        struct ieee80211_sta_bss *sta_bss_list;
#define STA_HASH_SIZE 256
#define STA_HASH(sta) (sta[5])
        struct ieee80211_sta_bss *sta_bss_hash[STA_HASH_SIZE];

        int cts_protect_erp_frames;

        hostapd_hw_mode phymode; /* current mode */
        struct hostapd_hw_modes *modes;
        size_t num_modes;
        unsigned int hw_modes; /* bitfield of allowed hardware modes;
                                * (1 << HOSTAPD_MODE_*) */
        int num_curr_rates;
        struct hostapd_rate_data *curr_rates;
        int freq; /* The current frequency in MHz */
        int channel; /* The current IEEE 802.11 channel number */

#ifdef CONFIG_IEEE80211R
        u8 current_md[6];
        u8 *ft_ies;
        size_t ft_ies_len;
#endif /* CONFIG_IEEE80211R */

#else /* CONFIG_CLIENT_MLME */
        int dummy; /* to keep MSVC happy */
#endif /* CONFIG_CLIENT_MLME */
};

struct wpa_supplicant {
        struct wpa_global *global;
        struct wpa_supplicant *next;
        struct l2_packet_data *l2;
        struct l2_packet_data *l2_br;
        unsigned char own_addr[ETH_ALEN];
        char ifname[100];
#ifdef CONFIG_CTRL_IFACE_DBUS
        char *dbus_path;
#endif /* CONFIG_CTRL_IFACE_DBUS */
#ifdef CONFIG_CTRL_IFACE_DBUS_NEW
        char *dbus_new_path;
#endif /* CONFIG_CTRL_IFACE_DBUS_NEW */
        char bridge_ifname[16];

        char *confname;
        struct wpa_config *conf;
        int countermeasures;
        os_time_t last_michael_mic_error;
        u8 bssid[ETH_ALEN];
        u8 pending_bssid[ETH_ALEN]; /* If wpa_state == WPA_ASSOCIATING, this
                                     * field contains the targer BSSID. */
        int reassociate; /* reassociation requested */
        int disconnected; /* all connections disabled; i.e., do no reassociate
                           * before this has been cleared */
        struct wpa_ssid *current_ssid;
        int ap_ies_from_associnfo;

        /* Selected configuration (based on Beacon/ProbeResp WPA IE) */
        int pairwise_cipher;
        int group_cipher;
        int key_mgmt;
        int mgmt_group_cipher;

        void *drv_priv; /* private data used by driver_ops */
        void *global_drv_priv;

        struct wpa_ssid *prev_scan_ssid; /* previously scanned SSID;
                                          * NULL = not yet initialized (start
                                          * with wildcard SSID)
                                          * WILDCARD_SSID_SCAN = wildcard
                                          * SSID was used in the previous scan
                                          */
#define WILDCARD_SSID_SCAN ((struct wpa_ssid *) 1)

        struct wpa_scan_results *scan_res;

        struct wpa_driver_ops *driver;
        int interface_removed; /* whether the network interface has been
                                * removed */
        struct wpa_sm *wpa;
        struct eapol_sm *eapol;

        struct ctrl_iface_priv *ctrl_iface;

        wpa_states wpa_state;
        int scanning;
        int new_connection;
        int reassociated_connection;

        int eapol_received; /* number of EAPOL packets received after the
                             * previous association event */

        struct scard_data *scard;

        unsigned char last_eapol_src[ETH_ALEN];

        int keys_cleared;

        struct wpa_blacklist *blacklist;

        int scan_req; /* manual scan request; this forces a scan even if there
                       * are no enabled networks in the configuration */
        int scan_res_tried; /* whether ap_scan=1 mode has tried to fetch scan
                             * results without a new scan request; this is used
                             * to speed up the first association if the driver
                             * has already available scan results. */
        int scan_runs; /* number of scan runs since WPS was started */

        struct wpa_client_mlme mlme;
        unsigned int drv_flags;
        int max_scan_ssids;

        int pending_mic_error_report;
        int pending_mic_error_pairwise;
        int mic_errors_seen; /* Michael MIC errors with the current PTK */

        struct wps_context *wps;
        int wps_success; /* WPS success event received */
        struct wps_er *wps_er;
        int blacklist_cleared;

        struct wpabuf *pending_eapol_rx;
        struct os_time pending_eapol_rx_time;
        u8 pending_eapol_rx_src[ETH_ALEN];

        struct ibss_rsn *ibss_rsn;

#ifdef CONFIG_SME
        struct {
                u8 ssid[32];
                size_t ssid_len;
                int freq;
                u8 assoc_req_ie[80];
                size_t assoc_req_ie_len;
                int mfp;
                int ft_used;
                u8 mobility_domain[2];
                u8 *ft_ies;
                size_t ft_ies_len;
                u8 prev_bssid[ETH_ALEN];
                int prev_bssid_set;
        } sme;
#endif /* CONFIG_SME */

#ifdef CONFIG_AP
        struct hostapd_iface *ap_iface;
#endif /* CONFIG_AP */

        struct wpa_ssid *bgscan_ssid;
        const struct bgscan_ops *bgscan;
        void *bgscan_priv;
};


/* wpa_supplicant.c */
int wpa_set_wep_keys(struct wpa_supplicant *wpa_s, struct wpa_ssid *ssid);

int wpa_supplicant_reload_configuration(struct wpa_supplicant *wpa_s);

const char * wpa_supplicant_state_txt(int state);
int wpa_supplicant_driver_init(struct wpa_supplicant *wpa_s);
int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
                              struct wpa_scan_res *bss,
                              struct wpa_ssid *ssid,
                              u8 *wpa_ie, size_t *wpa_ie_len);
void wpa_supplicant_associate(struct wpa_supplicant *wpa_s,
                              struct wpa_scan_res *bss,
                              struct wpa_ssid *ssid);
void wpa_supplicant_set_non_wpa_policy(struct wpa_supplicant *wpa_s,
                                       struct wpa_ssid *ssid);
void wpa_supplicant_initiate_eapol(struct wpa_supplicant *wpa_s);
int wpa_supplicant_get_scan_results(struct wpa_supplicant *wpa_s);
void wpa_clear_keys(struct wpa_supplicant *wpa_s, const u8 *addr);
void wpa_supplicant_req_auth_timeout(struct wpa_supplicant *wpa_s,
                                     int sec, int usec);
void wpa_supplicant_set_state(struct wpa_supplicant *wpa_s, wpa_states state);
struct wpa_ssid * wpa_supplicant_get_ssid(struct wpa_supplicant *wpa_s);
void wpa_supplicant_cancel_auth_timeout(struct wpa_supplicant *wpa_s);
void wpa_supplicant_deauthenticate(struct wpa_supplicant *wpa_s,
                                   int reason_code);
void wpa_supplicant_disassociate(struct wpa_supplicant *wpa_s,
                                 int reason_code);

void wpa_supplicant_enable_network(struct wpa_supplicant *wpa_s,
                                   struct wpa_ssid *ssid);
void wpa_supplicant_disable_network(struct wpa_supplicant *wpa_s,
                                    struct wpa_ssid *ssid);
void wpa_supplicant_select_network(struct wpa_supplicant *wpa_s,
                                   struct wpa_ssid *ssid);
int wpa_supplicant_set_ap_scan(struct wpa_supplicant *wpa_s,
                               int ap_scan);
int wpa_supplicant_set_debug_params(struct wpa_global *global,
                                    int debug_level, int debug_timestamp,
                                    int debug_show_keys);

void wpa_show_license(void);

struct wpa_supplicant * wpa_supplicant_add_iface(struct wpa_global *global,
                                                 struct wpa_interface *iface);
int wpa_supplicant_remove_iface(struct wpa_global *global,
                                struct wpa_supplicant *wpa_s);
struct wpa_supplicant * wpa_supplicant_get_iface(struct wpa_global *global,
                                                 const char *ifname);
struct wpa_global * wpa_supplicant_init(struct wpa_params *params);
int wpa_supplicant_run(struct wpa_global *global);
void wpa_supplicant_deinit(struct wpa_global *global);

int wpa_supplicant_scard_init(struct wpa_supplicant *wpa_s,
                              struct wpa_ssid *ssid);

/* scan.c */
int wpa_supplicant_enabled_networks(struct wpa_config *conf);
void wpa_supplicant_req_scan(struct wpa_supplicant *wpa_s, int sec, int usec);
void wpa_supplicant_cancel_scan(struct wpa_supplicant *wpa_s);
void wpa_supplicant_notify_scanning(struct wpa_supplicant *wpa_s,
                                    int scanning);
struct wpa_driver_scan_params;
int wpa_supplicant_trigger_scan(struct wpa_supplicant *wpa_s,
                                struct wpa_driver_scan_params *params);

/* events.c */
void wpa_supplicant_mark_disassoc(struct wpa_supplicant *wpa_s);

#endif /* WPA_SUPPLICANT_I_H */