Home | History | Annotate | Line # | Download | only in wpa_supplicant
      1 /*
      2  * BSS table
      3  * Copyright (c) 2009-2019, Jouni Malinen <j (at) 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 BSS_H
     10 #define BSS_H
     11 
     12 struct wpa_scan_res;
     13 
     14 #define WPA_BSS_QUAL_INVALID		BIT(0)
     15 #define WPA_BSS_NOISE_INVALID		BIT(1)
     16 #define WPA_BSS_LEVEL_INVALID		BIT(2)
     17 #define WPA_BSS_LEVEL_DBM		BIT(3)
     18 #define WPA_BSS_AUTHENTICATED		BIT(4)
     19 #define WPA_BSS_ASSOCIATED		BIT(5)
     20 #define WPA_BSS_ANQP_FETCH_TRIED	BIT(6)
     21 #define WPA_BSS_OWE_TRANSITION		BIT(7)
     22 
     23 #define WPA_BSS_FREQ_CHANGED_FLAG	BIT(0)
     24 #define WPA_BSS_SIGNAL_CHANGED_FLAG	BIT(1)
     25 #define WPA_BSS_PRIVACY_CHANGED_FLAG	BIT(2)
     26 #define WPA_BSS_MODE_CHANGED_FLAG	BIT(3)
     27 #define WPA_BSS_WPAIE_CHANGED_FLAG	BIT(4)
     28 #define WPA_BSS_RSNIE_CHANGED_FLAG	BIT(5)
     29 #define WPA_BSS_WPS_CHANGED_FLAG	BIT(6)
     30 #define WPA_BSS_RATES_CHANGED_FLAG	BIT(7)
     31 #define WPA_BSS_IES_CHANGED_FLAG	BIT(8)
     32 
     33 struct wpa_bss_anqp_elem {
     34 	struct dl_list list;
     35 	u16 infoid;
     36 	bool protected_response; /* received in a protected GAS response */
     37 	struct wpabuf *payload;
     38 };
     39 
     40 /**
     41  * struct wpa_bss_anqp - ANQP data for a BSS entry (struct wpa_bss)
     42  */
     43 struct wpa_bss_anqp {
     44 	/** Number of BSS entries referring to this ANQP data instance */
     45 	unsigned int users;
     46 #ifdef CONFIG_INTERWORKING
     47 	struct wpabuf *capability_list;
     48 	struct wpabuf *venue_name;
     49 	struct wpabuf *network_auth_type;
     50 	struct wpabuf *roaming_consortium;
     51 	struct wpabuf *ip_addr_type_availability;
     52 	struct wpabuf *nai_realm;
     53 	struct wpabuf *anqp_3gpp;
     54 	struct wpabuf *domain_name;
     55 	struct wpabuf *fils_realm_info;
     56 	struct dl_list anqp_elems; /* list of struct wpa_bss_anqp_elem */
     57 #endif /* CONFIG_INTERWORKING */
     58 #ifdef CONFIG_HS20
     59 	struct wpabuf *hs20_capability_list;
     60 	struct wpabuf *hs20_operator_friendly_name;
     61 	struct wpabuf *hs20_wan_metrics;
     62 	struct wpabuf *hs20_connection_capability;
     63 	struct wpabuf *hs20_operating_class;
     64 	struct wpabuf *hs20_osu_providers_list;
     65 	struct wpabuf *hs20_operator_icon_metadata;
     66 	struct wpabuf *hs20_osu_providers_nai_list;
     67 #endif /* CONFIG_HS20 */
     68 };
     69 
     70 /**
     71  * struct wpa_bss - BSS table
     72  *
     73  * This structure is used to store information about neighboring BSSes in
     74  * generic format. It is mainly updated based on scan results from the driver.
     75  */
     76 struct wpa_bss {
     77 	/** List entry for struct wpa_supplicant::bss */
     78 	struct dl_list list;
     79 	/** List entry for struct wpa_supplicant::bss_id */
     80 	struct dl_list list_id;
     81 	/** Unique identifier for this BSS entry */
     82 	unsigned int id;
     83 	/** Number of counts without seeing this BSS */
     84 	unsigned int scan_miss_count;
     85 	/** Index of the last scan update */
     86 	unsigned int last_update_idx;
     87 	/** Information flags about the BSS/IBSS (WPA_BSS_*) */
     88 	unsigned int flags;
     89 	/** BSSID */
     90 	u8 bssid[ETH_ALEN];
     91 	/** HESSID */
     92 	u8 hessid[ETH_ALEN];
     93 	/** SSID */
     94 	u8 ssid[SSID_MAX_LEN];
     95 	/** Length of SSID */
     96 	size_t ssid_len;
     97 	/** Frequency of the channel in MHz (e.g., 2412 = channel 1) */
     98 	int freq;
     99 	/** The max channel width supported by both the AP and the STA */
    100 	enum chan_width max_cw;
    101 	/** Beacon interval in TUs (host byte order) */
    102 	u16 beacon_int;
    103 	/** Capability information field in host byte order */
    104 	u16 caps;
    105 	/** Signal quality */
    106 	int qual;
    107 	/** Noise level */
    108 	int noise;
    109 	/** Signal level */
    110 	int level;
    111 	/** Timestamp of last Beacon/Probe Response frame */
    112 	u64 tsf;
    113 	/** Whether the Beacon frame data is known to be newer */
    114 	bool beacon_newer;
    115 	/** Time of the last update (i.e., Beacon or Probe Response RX) */
    116 	struct os_reltime last_update;
    117 	/** Estimated throughput in kbps */
    118 	unsigned int est_throughput;
    119 	/** Signal-to-noise ratio in dB */
    120 	int snr;
    121 	/** ANQP data */
    122 	struct wpa_bss_anqp *anqp;
    123 	/** Length of the following IE field in octets (from Probe Response) */
    124 	size_t ie_len;
    125 	/** Length of the following Beacon IE field in octets */
    126 	size_t beacon_ie_len;
    127 	/** MLD address of the AP */
    128 	u8 mld_addr[ETH_ALEN];
    129 	/** Link ID of this affiliated AP of the AP MLD */
    130 	u8 mld_link_id;
    131 
    132 	/** An array of MLD links */
    133 	u16 valid_links;
    134 	struct mld_link {
    135 		u8 bssid[ETH_ALEN];
    136 		int freq;
    137 
    138 		/* Whether the link is valid but currently disabled */
    139 		bool disabled;
    140 	} mld_links[MAX_NUM_MLD_LINKS];
    141 
    142 	/* followed by ie_len octets of IEs */
    143 	/* followed by beacon_ie_len octets of IEs */
    144 	u8 ies[];
    145 };
    146 
    147 static inline const u8 * wpa_bss_ie_ptr(const struct wpa_bss *bss)
    148 {
    149 	return bss->ies;
    150 }
    151 
    152 void notify_bss_changes(struct wpa_supplicant *wpa_s, u32 changes,
    153 			const struct wpa_bss *bss);
    154 void wpa_bss_update_start(struct wpa_supplicant *wpa_s);
    155 void wpa_bss_update_scan_res(struct wpa_supplicant *wpa_s,
    156 			     struct wpa_scan_res *res,
    157 			     struct os_reltime *fetch_time);
    158 void wpa_bss_remove(struct wpa_supplicant *wpa_s, struct wpa_bss *bss,
    159 		    const char *reason);
    160 void wpa_bss_update_end(struct wpa_supplicant *wpa_s, struct scan_info *info,
    161 			int new_scan);
    162 int wpa_bss_init(struct wpa_supplicant *wpa_s);
    163 void wpa_bss_deinit(struct wpa_supplicant *wpa_s);
    164 void wpa_bss_flush(struct wpa_supplicant *wpa_s);
    165 void wpa_bss_flush_by_age(struct wpa_supplicant *wpa_s, int age);
    166 struct wpa_bss * wpa_bss_get(struct wpa_supplicant *wpa_s, const u8 *bssid,
    167 			     const u8 *ssid, size_t ssid_len);
    168 struct wpa_bss * wpa_bss_get_bssid(struct wpa_supplicant *wpa_s,
    169 				   const u8 *bssid);
    170 struct wpa_bss * wpa_bss_get_bssid_latest(struct wpa_supplicant *wpa_s,
    171 					  const u8 *bssid);
    172 struct wpa_bss * wpa_bss_get_p2p_dev_addr(struct wpa_supplicant *wpa_s,
    173 					  const u8 *dev_addr);
    174 struct wpa_bss * wpa_bss_get_id(struct wpa_supplicant *wpa_s, unsigned int id);
    175 struct wpa_bss * wpa_bss_get_id_range(struct wpa_supplicant *wpa_s,
    176 				      unsigned int idf, unsigned int idl);
    177 const u8 * wpa_bss_get_ie(const struct wpa_bss *bss, u8 ie);
    178 const u8 * wpa_bss_get_ie_beacon(const struct wpa_bss *bss, u8 ie);
    179 const u8 * wpa_bss_get_ie_ext(const struct wpa_bss *bss, u8 ext);
    180 const u8 * wpa_bss_get_vendor_ie(const struct wpa_bss *bss, u32 vendor_type);
    181 const u8 * wpa_bss_get_vendor_ie_beacon(const struct wpa_bss *bss,
    182 					u32 vendor_type);
    183 struct wpabuf * wpa_bss_get_vendor_ie_multi(const struct wpa_bss *bss,
    184 					    u32 vendor_type);
    185 struct wpabuf * wpa_bss_get_vendor_ie_multi_beacon(const struct wpa_bss *bss,
    186 						   u32 vendor_type);
    187 int wpa_bss_get_max_rate(const struct wpa_bss *bss);
    188 int wpa_bss_get_bit_rates(const struct wpa_bss *bss, u8 **rates);
    189 struct wpa_bss_anqp * wpa_bss_anqp_alloc(void);
    190 int wpa_bss_anqp_unshare_alloc(struct wpa_bss *bss);
    191 const u8 * wpa_bss_get_fils_cache_id(const struct wpa_bss *bss);
    192 int wpa_bss_ext_capab(const struct wpa_bss *bss, unsigned int capab);
    193 
    194 static inline int bss_is_dmg(const struct wpa_bss *bss)
    195 {
    196 	return bss->freq > 45000;
    197 }
    198 
    199 /**
    200  * Test whether a BSS is a PBSS.
    201  * This checks whether a BSS is a DMG-band PBSS. PBSS is used for P2P DMG
    202  * network.
    203  */
    204 static inline int bss_is_pbss(struct wpa_bss *bss)
    205 {
    206 	return bss_is_dmg(bss) &&
    207 		(bss->caps & IEEE80211_CAP_DMG_MASK) == IEEE80211_CAP_DMG_PBSS;
    208 }
    209 
    210 static inline void wpa_bss_update_level(struct wpa_bss *bss, int new_level)
    211 {
    212 	if (bss != NULL && new_level > -WPA_INVALID_NOISE && new_level < 0)
    213 		bss->level = new_level;
    214 }
    215 
    216 void calculate_update_time(const struct os_reltime *fetch_time,
    217 			   unsigned int age_ms,
    218 			   struct os_reltime *update_time);
    219 
    220 int wpa_bss_parse_basic_ml_element(struct wpa_supplicant *wpa_s,
    221 				   struct wpa_bss *bss,
    222 				   u8 *ap_mld_addr,
    223 				   u16 *missing_links,
    224 				   struct wpa_ssid *ssid,
    225 				   u8 *ap_mld_id);
    226 u16 wpa_bss_parse_reconf_ml_element(struct wpa_supplicant *wpa_s,
    227 				    struct wpa_bss *bss);
    228 
    229 #endif /* BSS_H */
    230