wpa_supplicant_i.h

Go to the documentation of this file.

#ifndef WPA_SUPPLICANT_I_H
#define WPA_SUPPLICANT_I_H

#include "driver.h"

struct wpa_blacklist {
        struct wpa_blacklist *next;
        u8 bssid[ETH_ALEN];
        int count;
};


struct wpa_scan_result;
struct wpa_sm;
struct wpa_supplicant;

/*
 * 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_interface;

        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;

        int wpa_debug_use_file;
};

struct wpa_global {
        struct wpa_supplicant *ifaces;
        struct wpa_params params;
        struct ctrl_iface_global_priv *ctrl_iface;
        struct ctrl_iface_dbus_priv *dbus_ctrl_iface;
};


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;
        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;

        int ssid_set:1;
        int bssid_set:1;
        int prev_bssid_set:1;
        int authenticated:1;
        int associated:1;
        int probereq_poll:1;
        int use_protection:1;
        int create_ibss:1;
        int mixed_cell:1;
        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;

        int phymode; /* current mode; WPA_MODE_IEEE80211A, .. */
        struct wpa_hw_modes *modes;
        size_t num_modes;
        unsigned int hw_modes; /* bitfield of allowed hardware modes;
                                * (1 << MODE_*) */
        int num_curr_rates;
        struct wpa_rate_data *curr_rates;
        int freq; /* The current frequency in MHz */
        int channel; /* The current IEEE 802.11 channel number */
#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 */
        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;

        /* 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 */

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

        struct wpa_scan_result *scan_results;
        int num_scan_results;

        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 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. */

        struct wpa_client_mlme mlme;
        int use_client_mlme;
};


/* wpa_supplicant.c */
void wpa_supplicant_cancel_scan(struct wpa_supplicant *wpa_s);

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 wait_for_interface);
struct wpa_blacklist * wpa_blacklist_get(struct wpa_supplicant *wpa_s,
                                         const u8 *bssid);
int wpa_blacklist_add(struct wpa_supplicant *wpa_s, const u8 *bssid);
void wpa_blacklist_clear(struct wpa_supplicant *wpa_s);
int wpa_supplicant_set_suites(struct wpa_supplicant *wpa_s,
                              struct wpa_scan_result *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_result *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_req_scan(struct wpa_supplicant *wpa_s, int sec, int usec);

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);


/* driver_ops */
static inline void * wpa_drv_init(struct wpa_supplicant *wpa_s,
                                  const char *ifname)
{
        if (wpa_s->driver->init) {
                return wpa_s->driver->init(wpa_s, ifname);
        }
        return NULL;
}

static inline void wpa_drv_deinit(struct wpa_supplicant *wpa_s)
{
        if (wpa_s->driver->deinit)
                wpa_s->driver->deinit(wpa_s->drv_priv);
}

static inline int wpa_drv_set_param(struct wpa_supplicant *wpa_s,
                                    const char *param)
{
        if (wpa_s->driver->set_param)
                return wpa_s->driver->set_param(wpa_s->drv_priv, param);
        return 0;
}

static inline int wpa_drv_set_drop_unencrypted(struct wpa_supplicant *wpa_s,
                                               int enabled)
{
        if (wpa_s->driver->set_drop_unencrypted) {
                return wpa_s->driver->set_drop_unencrypted(wpa_s->drv_priv,
                                                           enabled);
        }
        return -1;
}

static inline int wpa_drv_set_countermeasures(struct wpa_supplicant *wpa_s,
                                              int enabled)
{
        if (wpa_s->driver->set_countermeasures) {
                return wpa_s->driver->set_countermeasures(wpa_s->drv_priv,
                                                          enabled);
        }
        return -1;
}

static inline int wpa_drv_set_auth_alg(struct wpa_supplicant *wpa_s,
                                       int auth_alg)
{
        if (wpa_s->driver->set_auth_alg) {
                return wpa_s->driver->set_auth_alg(wpa_s->drv_priv,
                                                   auth_alg);
        }
        return -1;
}

static inline int wpa_drv_set_wpa(struct wpa_supplicant *wpa_s, int enabled)
{
        if (wpa_s->driver->set_wpa) {
                return wpa_s->driver->set_wpa(wpa_s->drv_priv, enabled);
        }
        return 0;
}

static inline int wpa_drv_associate(struct wpa_supplicant *wpa_s,
                                    struct wpa_driver_associate_params *params)
{
        if (wpa_s->driver->associate) {
                return wpa_s->driver->associate(wpa_s->drv_priv, params);
        }
        return -1;
}

static inline int wpa_drv_scan(struct wpa_supplicant *wpa_s, const u8 *ssid,
                               size_t ssid_len)
{
        if (wpa_s->driver->scan) {
                return wpa_s->driver->scan(wpa_s->drv_priv, ssid, ssid_len);
        }
        return -1;
}

static inline int wpa_drv_get_scan_results(struct wpa_supplicant *wpa_s,
                                           struct wpa_scan_result *results,
                                           size_t max_size)
{
        if (wpa_s->driver->get_scan_results) {
                return wpa_s->driver->get_scan_results(wpa_s->drv_priv,
                                                       results, max_size);
        }
        return -1;
}

static inline int wpa_drv_get_bssid(struct wpa_supplicant *wpa_s, u8 *bssid)
{
        if (wpa_s->driver->get_bssid) {
                return wpa_s->driver->get_bssid(wpa_s->drv_priv, bssid);
        }
        return -1;
}

static inline int wpa_drv_get_ssid(struct wpa_supplicant *wpa_s, u8 *ssid)
{
        if (wpa_s->driver->get_ssid) {
                return wpa_s->driver->get_ssid(wpa_s->drv_priv, ssid);
        }
        return -1;
}

static inline int wpa_drv_set_key(struct wpa_supplicant *wpa_s, wpa_alg alg,
                                   const u8 *addr, int key_idx, int set_tx,
                                   const u8 *seq, size_t seq_len,
                                   const u8 *key, size_t key_len)
{
        if (wpa_s->driver->set_key) {
                wpa_s->keys_cleared = 0;
                return wpa_s->driver->set_key(wpa_s->drv_priv, alg, addr,
                                              key_idx, set_tx, seq, seq_len,
                                              key, key_len);
        }
        return -1;
}

static inline int wpa_drv_deauthenticate(struct wpa_supplicant *wpa_s,
                                         const u8 *addr, int reason_code)
{
        if (wpa_s->driver->deauthenticate) {
                return wpa_s->driver->deauthenticate(wpa_s->drv_priv, addr,
                                                     reason_code);
        }
        return -1;
}

static inline int wpa_drv_disassociate(struct wpa_supplicant *wpa_s,
                                       const u8 *addr, int reason_code)
{
        if (wpa_s->driver->disassociate) {
                return wpa_s->driver->disassociate(wpa_s->drv_priv, addr,
                                                   reason_code);
        }
        return -1;
}

static inline int wpa_drv_add_pmkid(struct wpa_supplicant *wpa_s,
                                    const u8 *bssid, const u8 *pmkid)
{
        if (wpa_s->driver->add_pmkid) {
                return wpa_s->driver->add_pmkid(wpa_s->drv_priv, bssid, pmkid);
        }
        return -1;
}

static inline int wpa_drv_remove_pmkid(struct wpa_supplicant *wpa_s,
                                       const u8 *bssid, const u8 *pmkid)
{
        if (wpa_s->driver->remove_pmkid) {
                return wpa_s->driver->remove_pmkid(wpa_s->drv_priv, bssid,
                                                   pmkid);
        }
        return -1;
}

static inline int wpa_drv_flush_pmkid(struct wpa_supplicant *wpa_s)
{
        if (wpa_s->driver->flush_pmkid) {
                return wpa_s->driver->flush_pmkid(wpa_s->drv_priv);
        }
        return -1;
}

static inline int wpa_drv_get_capa(struct wpa_supplicant *wpa_s,
                                   struct wpa_driver_capa *capa)
{
        if (wpa_s->driver->get_capa) {
                return wpa_s->driver->get_capa(wpa_s->drv_priv, capa);
        }
        return -1;
}

static inline void wpa_drv_poll(struct wpa_supplicant *wpa_s)
{
        if (wpa_s->driver->poll) {
                wpa_s->driver->poll(wpa_s->drv_priv);
        }
}

static inline const char * wpa_drv_get_ifname(struct wpa_supplicant *wpa_s)
{
        if (wpa_s->driver->get_ifname) {
                return wpa_s->driver->get_ifname(wpa_s->drv_priv);
        }
        return NULL;
}

static inline const u8 * wpa_drv_get_mac_addr(struct wpa_supplicant *wpa_s)
{
        if (wpa_s->driver->get_mac_addr) {
                return wpa_s->driver->get_mac_addr(wpa_s->drv_priv);
        }
        return NULL;
}

static inline int wpa_drv_send_eapol(struct wpa_supplicant *wpa_s,
                                     const u8 *dst, u16 proto,
                                     const u8 *data, size_t data_len)
{
        if (wpa_s->driver->send_eapol)
                return wpa_s->driver->send_eapol(wpa_s->drv_priv, dst, proto,
                                                 data, data_len);
        return -1;
}

static inline int wpa_drv_set_operstate(struct wpa_supplicant *wpa_s,
                                        int state)
{
        if (wpa_s->driver->set_operstate)
                return wpa_s->driver->set_operstate(wpa_s->drv_priv, state);
        return 0;
}

static inline int wpa_drv_mlme_setprotection(struct wpa_supplicant *wpa_s,
                                             const u8 *addr, int protect_type,
                                             int key_type)
{
        if (wpa_s->driver->mlme_setprotection)
                return wpa_s->driver->mlme_setprotection(wpa_s->drv_priv, addr,
                                                         protect_type,
                                                         key_type);
        return 0;
}

static inline struct wpa_hw_modes *
wpa_drv_get_hw_feature_data(struct wpa_supplicant *wpa_s, u16 *num_modes,
                            u16 *flags)
{
        if (wpa_s->driver->get_hw_feature_data)
                return wpa_s->driver->get_hw_feature_data(wpa_s->drv_priv,
                                                          num_modes, flags);
        return NULL;
}

static inline int wpa_drv_set_channel(struct wpa_supplicant *wpa_s,
                                      wpa_hw_mode phymode, int chan,
                                      int freq)
{
        if (wpa_s->driver->set_channel)
                return wpa_s->driver->set_channel(wpa_s->drv_priv, phymode,
                                                  chan, freq);
        return -1;
}

static inline int wpa_drv_set_ssid(struct wpa_supplicant *wpa_s,
                                   const u8 *ssid, size_t ssid_len)
{
        if (wpa_s->driver->set_ssid) {
                return wpa_s->driver->set_ssid(wpa_s->drv_priv, ssid,
                                               ssid_len);
        }
        return -1;
}

static inline int wpa_drv_set_bssid(struct wpa_supplicant *wpa_s,
                                    const u8 *bssid)
{
        if (wpa_s->driver->set_bssid) {
                return wpa_s->driver->set_bssid(wpa_s->drv_priv, bssid);
        }
        return -1;
}

static inline int wpa_drv_send_mlme(struct wpa_supplicant *wpa_s,
                                    const u8 *data, size_t data_len)
{
        if (wpa_s->driver->send_mlme)
                return wpa_s->driver->send_mlme(wpa_s->drv_priv,
                                                data, data_len);
        return -1;
}

static inline int wpa_drv_mlme_add_sta(struct wpa_supplicant *wpa_s,
                                       const u8 *addr, const u8 *supp_rates,
                                       size_t supp_rates_len)
{
        if (wpa_s->driver->mlme_add_sta)
                return wpa_s->driver->mlme_add_sta(wpa_s->drv_priv, addr,
                                                   supp_rates, supp_rates_len);
        return -1;
}

static inline int wpa_drv_mlme_remove_sta(struct wpa_supplicant *wpa_s,
                                          const u8 *addr)
{
        if (wpa_s->driver->mlme_remove_sta)
                return wpa_s->driver->mlme_remove_sta(wpa_s->drv_priv, addr);
        return -1;
}

#endif /* WPA_SUPPLICANT_I_H */

---