mesh: Use mesh id instead of SSID in BSS table
[mech_eap.git] / wpa_supplicant / bss.c
1 /*
2  * BSS table
3  * Copyright (c) 2009-2012, 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 #include "utils/includes.h"
10
11 #include "utils/common.h"
12 #include "utils/eloop.h"
13 #include "common/ieee802_11_defs.h"
14 #include "drivers/driver.h"
15 #include "wpa_supplicant_i.h"
16 #include "config.h"
17 #include "notify.h"
18 #include "scan.h"
19 #include "bss.h"
20
21
22 /**
23  * WPA_BSS_EXPIRATION_PERIOD - Period of expiration run in seconds
24  */
25 #define WPA_BSS_EXPIRATION_PERIOD 10
26
27 #define WPA_BSS_FREQ_CHANGED_FLAG       BIT(0)
28 #define WPA_BSS_SIGNAL_CHANGED_FLAG     BIT(1)
29 #define WPA_BSS_PRIVACY_CHANGED_FLAG    BIT(2)
30 #define WPA_BSS_MODE_CHANGED_FLAG       BIT(3)
31 #define WPA_BSS_WPAIE_CHANGED_FLAG      BIT(4)
32 #define WPA_BSS_RSNIE_CHANGED_FLAG      BIT(5)
33 #define WPA_BSS_WPS_CHANGED_FLAG        BIT(6)
34 #define WPA_BSS_RATES_CHANGED_FLAG      BIT(7)
35 #define WPA_BSS_IES_CHANGED_FLAG        BIT(8)
36
37
38 static void wpa_bss_set_hessid(struct wpa_bss *bss)
39 {
40 #ifdef CONFIG_INTERWORKING
41         const u8 *ie = wpa_bss_get_ie(bss, WLAN_EID_INTERWORKING);
42         if (ie == NULL || (ie[1] != 7 && ie[1] != 9)) {
43                 os_memset(bss->hessid, 0, ETH_ALEN);
44                 return;
45         }
46         if (ie[1] == 7)
47                 os_memcpy(bss->hessid, ie + 3, ETH_ALEN);
48         else
49                 os_memcpy(bss->hessid, ie + 5, ETH_ALEN);
50 #endif /* CONFIG_INTERWORKING */
51 }
52
53
54 /**
55  * wpa_bss_anqp_alloc - Allocate ANQP data structure for a BSS entry
56  * Returns: Allocated ANQP data structure or %NULL on failure
57  *
58  * The allocated ANQP data structure has its users count set to 1. It may be
59  * shared by multiple BSS entries and each shared entry is freed with
60  * wpa_bss_anqp_free().
61  */
62 struct wpa_bss_anqp * wpa_bss_anqp_alloc(void)
63 {
64         struct wpa_bss_anqp *anqp;
65         anqp = os_zalloc(sizeof(*anqp));
66         if (anqp == NULL)
67                 return NULL;
68         anqp->users = 1;
69         return anqp;
70 }
71
72
73 /**
74  * wpa_bss_anqp_clone - Clone an ANQP data structure
75  * @anqp: ANQP data structure from wpa_bss_anqp_alloc()
76  * Returns: Cloned ANQP data structure or %NULL on failure
77  */
78 static struct wpa_bss_anqp * wpa_bss_anqp_clone(struct wpa_bss_anqp *anqp)
79 {
80         struct wpa_bss_anqp *n;
81
82         n = os_zalloc(sizeof(*n));
83         if (n == NULL)
84                 return NULL;
85
86 #define ANQP_DUP(f) if (anqp->f) n->f = wpabuf_dup(anqp->f)
87 #ifdef CONFIG_INTERWORKING
88         ANQP_DUP(venue_name);
89         ANQP_DUP(network_auth_type);
90         ANQP_DUP(roaming_consortium);
91         ANQP_DUP(ip_addr_type_availability);
92         ANQP_DUP(nai_realm);
93         ANQP_DUP(anqp_3gpp);
94         ANQP_DUP(domain_name);
95 #endif /* CONFIG_INTERWORKING */
96 #ifdef CONFIG_HS20
97         ANQP_DUP(hs20_operator_friendly_name);
98         ANQP_DUP(hs20_wan_metrics);
99         ANQP_DUP(hs20_connection_capability);
100         ANQP_DUP(hs20_operating_class);
101         ANQP_DUP(hs20_osu_providers_list);
102 #endif /* CONFIG_HS20 */
103 #undef ANQP_DUP
104
105         return n;
106 }
107
108
109 /**
110  * wpa_bss_anqp_unshare_alloc - Unshare ANQP data (if shared) in a BSS entry
111  * @bss: BSS entry
112  * Returns: 0 on success, -1 on failure
113  *
114  * This function ensures the specific BSS entry has an ANQP data structure that
115  * is not shared with any other BSS entry.
116  */
117 int wpa_bss_anqp_unshare_alloc(struct wpa_bss *bss)
118 {
119         struct wpa_bss_anqp *anqp;
120
121         if (bss->anqp && bss->anqp->users > 1) {
122                 /* allocated, but shared - clone an unshared copy */
123                 anqp = wpa_bss_anqp_clone(bss->anqp);
124                 if (anqp == NULL)
125                         return -1;
126                 anqp->users = 1;
127                 bss->anqp->users--;
128                 bss->anqp = anqp;
129                 return 0;
130         }
131
132         if (bss->anqp)
133                 return 0; /* already allocated and not shared */
134
135         /* not allocated - allocate a new storage area */
136         bss->anqp = wpa_bss_anqp_alloc();
137         return bss->anqp ? 0 : -1;
138 }
139
140
141 /**
142  * wpa_bss_anqp_free - Free an ANQP data structure
143  * @anqp: ANQP data structure from wpa_bss_anqp_alloc() or wpa_bss_anqp_clone()
144  */
145 static void wpa_bss_anqp_free(struct wpa_bss_anqp *anqp)
146 {
147         if (anqp == NULL)
148                 return;
149
150         anqp->users--;
151         if (anqp->users > 0) {
152                 /* Another BSS entry holds a pointer to this ANQP info */
153                 return;
154         }
155
156 #ifdef CONFIG_INTERWORKING
157         wpabuf_free(anqp->venue_name);
158         wpabuf_free(anqp->network_auth_type);
159         wpabuf_free(anqp->roaming_consortium);
160         wpabuf_free(anqp->ip_addr_type_availability);
161         wpabuf_free(anqp->nai_realm);
162         wpabuf_free(anqp->anqp_3gpp);
163         wpabuf_free(anqp->domain_name);
164 #endif /* CONFIG_INTERWORKING */
165 #ifdef CONFIG_HS20
166         wpabuf_free(anqp->hs20_operator_friendly_name);
167         wpabuf_free(anqp->hs20_wan_metrics);
168         wpabuf_free(anqp->hs20_connection_capability);
169         wpabuf_free(anqp->hs20_operating_class);
170         wpabuf_free(anqp->hs20_osu_providers_list);
171 #endif /* CONFIG_HS20 */
172
173         os_free(anqp);
174 }
175
176
177 static void wpa_bss_remove(struct wpa_supplicant *wpa_s, struct wpa_bss *bss,
178                            const char *reason)
179 {
180         if (wpa_s->last_scan_res) {
181                 unsigned int i;
182                 for (i = 0; i < wpa_s->last_scan_res_used; i++) {
183                         if (wpa_s->last_scan_res[i] == bss) {
184                                 os_memmove(&wpa_s->last_scan_res[i],
185                                            &wpa_s->last_scan_res[i + 1],
186                                            (wpa_s->last_scan_res_used - i - 1)
187                                            * sizeof(struct wpa_bss *));
188                                 wpa_s->last_scan_res_used--;
189                                 break;
190                         }
191                 }
192         }
193         dl_list_del(&bss->list);
194         dl_list_del(&bss->list_id);
195         wpa_s->num_bss--;
196         wpa_dbg(wpa_s, MSG_DEBUG, "BSS: Remove id %u BSSID " MACSTR
197                 " SSID '%s' due to %s", bss->id, MAC2STR(bss->bssid),
198                 wpa_ssid_txt(bss->ssid, bss->ssid_len), reason);
199         wpas_notify_bss_removed(wpa_s, bss->bssid, bss->id);
200         wpa_bss_anqp_free(bss->anqp);
201         os_free(bss);
202 }
203
204
205 /**
206  * wpa_bss_get - Fetch a BSS table entry based on BSSID and SSID
207  * @wpa_s: Pointer to wpa_supplicant data
208  * @bssid: BSSID
209  * @ssid: SSID
210  * @ssid_len: Length of @ssid
211  * Returns: Pointer to the BSS entry or %NULL if not found
212  */
213 struct wpa_bss * wpa_bss_get(struct wpa_supplicant *wpa_s, const u8 *bssid,
214                              const u8 *ssid, size_t ssid_len)
215 {
216         struct wpa_bss *bss;
217         if (!wpa_supplicant_filter_bssid_match(wpa_s, bssid))
218                 return NULL;
219         dl_list_for_each(bss, &wpa_s->bss, struct wpa_bss, list) {
220                 if (os_memcmp(bss->bssid, bssid, ETH_ALEN) == 0 &&
221                     bss->ssid_len == ssid_len &&
222                     os_memcmp(bss->ssid, ssid, ssid_len) == 0)
223                         return bss;
224         }
225         return NULL;
226 }
227
228
229 static void calculate_update_time(const struct os_reltime *fetch_time,
230                                   unsigned int age_ms,
231                                   struct os_reltime *update_time)
232 {
233         os_time_t usec;
234
235         update_time->sec = fetch_time->sec;
236         update_time->usec = fetch_time->usec;
237         update_time->sec -= age_ms / 1000;
238         usec = (age_ms % 1000) * 1000;
239         if (update_time->usec < usec) {
240                 update_time->sec--;
241                 update_time->usec += 1000000;
242         }
243         update_time->usec -= usec;
244 }
245
246
247 static void wpa_bss_copy_res(struct wpa_bss *dst, struct wpa_scan_res *src,
248                              struct os_reltime *fetch_time)
249 {
250         dst->flags = src->flags;
251         os_memcpy(dst->bssid, src->bssid, ETH_ALEN);
252         dst->freq = src->freq;
253         dst->beacon_int = src->beacon_int;
254         dst->caps = src->caps;
255         dst->qual = src->qual;
256         dst->noise = src->noise;
257         dst->level = src->level;
258         dst->tsf = src->tsf;
259
260         calculate_update_time(fetch_time, src->age, &dst->last_update);
261 }
262
263
264 static int wpa_bss_known(struct wpa_supplicant *wpa_s, struct wpa_bss *bss)
265 {
266         struct wpa_ssid *ssid;
267
268         for (ssid = wpa_s->conf->ssid; ssid; ssid = ssid->next) {
269                 if (ssid->ssid == NULL || ssid->ssid_len == 0)
270                         continue;
271                 if (ssid->ssid_len == bss->ssid_len &&
272                     os_memcmp(ssid->ssid, bss->ssid, ssid->ssid_len) == 0)
273                         return 1;
274         }
275
276         return 0;
277 }
278
279
280 static int wpa_bss_in_use(struct wpa_supplicant *wpa_s, struct wpa_bss *bss)
281 {
282         return bss == wpa_s->current_bss ||
283                 os_memcmp(bss->bssid, wpa_s->bssid, ETH_ALEN) == 0 ||
284                 os_memcmp(bss->bssid, wpa_s->pending_bssid, ETH_ALEN) == 0;
285 }
286
287
288 static int wpa_bss_remove_oldest_unknown(struct wpa_supplicant *wpa_s)
289 {
290         struct wpa_bss *bss;
291
292         dl_list_for_each(bss, &wpa_s->bss, struct wpa_bss, list) {
293                 if (!wpa_bss_known(wpa_s, bss)) {
294                         wpa_bss_remove(wpa_s, bss, __func__);
295                         return 0;
296                 }
297         }
298
299         return -1;
300 }
301
302
303 static int wpa_bss_remove_oldest(struct wpa_supplicant *wpa_s)
304 {
305         struct wpa_bss *bss;
306
307         /*
308          * Remove the oldest entry that does not match with any configured
309          * network.
310          */
311         if (wpa_bss_remove_oldest_unknown(wpa_s) == 0)
312                 return 0;
313
314         /*
315          * Remove the oldest entry that isn't currently in use.
316          */
317         dl_list_for_each(bss, &wpa_s->bss, struct wpa_bss, list) {
318                 if (!wpa_bss_in_use(wpa_s, bss)) {
319                         wpa_bss_remove(wpa_s, bss, __func__);
320                         return 0;
321                 }
322         }
323
324         return -1;
325 }
326
327
328 static struct wpa_bss * wpa_bss_add(struct wpa_supplicant *wpa_s,
329                                     const u8 *ssid, size_t ssid_len,
330                                     struct wpa_scan_res *res,
331                                     struct os_reltime *fetch_time)
332 {
333         struct wpa_bss *bss;
334
335         bss = os_zalloc(sizeof(*bss) + res->ie_len + res->beacon_ie_len);
336         if (bss == NULL)
337                 return NULL;
338         bss->id = wpa_s->bss_next_id++;
339         bss->last_update_idx = wpa_s->bss_update_idx;
340         wpa_bss_copy_res(bss, res, fetch_time);
341         os_memcpy(bss->ssid, ssid, ssid_len);
342         bss->ssid_len = ssid_len;
343         bss->ie_len = res->ie_len;
344         bss->beacon_ie_len = res->beacon_ie_len;
345         os_memcpy(bss + 1, res + 1, res->ie_len + res->beacon_ie_len);
346         wpa_bss_set_hessid(bss);
347
348         if (wpa_s->num_bss + 1 > wpa_s->conf->bss_max_count &&
349             wpa_bss_remove_oldest(wpa_s) != 0) {
350                 wpa_printf(MSG_ERROR, "Increasing the MAX BSS count to %d "
351                            "because all BSSes are in use. We should normally "
352                            "not get here!", (int) wpa_s->num_bss + 1);
353                 wpa_s->conf->bss_max_count = wpa_s->num_bss + 1;
354         }
355
356         dl_list_add_tail(&wpa_s->bss, &bss->list);
357         dl_list_add_tail(&wpa_s->bss_id, &bss->list_id);
358         wpa_s->num_bss++;
359         wpa_dbg(wpa_s, MSG_DEBUG, "BSS: Add new id %u BSSID " MACSTR
360                 " SSID '%s'",
361                 bss->id, MAC2STR(bss->bssid), wpa_ssid_txt(ssid, ssid_len));
362         wpas_notify_bss_added(wpa_s, bss->bssid, bss->id);
363         return bss;
364 }
365
366
367 static int are_ies_equal(const struct wpa_bss *old,
368                          const struct wpa_scan_res *new, u32 ie)
369 {
370         const u8 *old_ie, *new_ie;
371         struct wpabuf *old_ie_buff = NULL;
372         struct wpabuf *new_ie_buff = NULL;
373         int new_ie_len, old_ie_len, ret, is_multi;
374
375         switch (ie) {
376         case WPA_IE_VENDOR_TYPE:
377                 old_ie = wpa_bss_get_vendor_ie(old, ie);
378                 new_ie = wpa_scan_get_vendor_ie(new, ie);
379                 is_multi = 0;
380                 break;
381         case WPS_IE_VENDOR_TYPE:
382                 old_ie_buff = wpa_bss_get_vendor_ie_multi(old, ie);
383                 new_ie_buff = wpa_scan_get_vendor_ie_multi(new, ie);
384                 is_multi = 1;
385                 break;
386         case WLAN_EID_RSN:
387         case WLAN_EID_SUPP_RATES:
388         case WLAN_EID_EXT_SUPP_RATES:
389                 old_ie = wpa_bss_get_ie(old, ie);
390                 new_ie = wpa_scan_get_ie(new, ie);
391                 is_multi = 0;
392                 break;
393         default:
394                 wpa_printf(MSG_DEBUG, "bss: %s: cannot compare IEs", __func__);
395                 return 0;
396         }
397
398         if (is_multi) {
399                 /* in case of multiple IEs stored in buffer */
400                 old_ie = old_ie_buff ? wpabuf_head_u8(old_ie_buff) : NULL;
401                 new_ie = new_ie_buff ? wpabuf_head_u8(new_ie_buff) : NULL;
402                 old_ie_len = old_ie_buff ? wpabuf_len(old_ie_buff) : 0;
403                 new_ie_len = new_ie_buff ? wpabuf_len(new_ie_buff) : 0;
404         } else {
405                 /* in case of single IE */
406                 old_ie_len = old_ie ? old_ie[1] + 2 : 0;
407                 new_ie_len = new_ie ? new_ie[1] + 2 : 0;
408         }
409
410         if (!old_ie || !new_ie)
411                 ret = !old_ie && !new_ie;
412         else
413                 ret = (old_ie_len == new_ie_len &&
414                        os_memcmp(old_ie, new_ie, old_ie_len) == 0);
415
416         wpabuf_free(old_ie_buff);
417         wpabuf_free(new_ie_buff);
418
419         return ret;
420 }
421
422
423 static u32 wpa_bss_compare_res(const struct wpa_bss *old,
424                                const struct wpa_scan_res *new)
425 {
426         u32 changes = 0;
427         int caps_diff = old->caps ^ new->caps;
428
429         if (old->freq != new->freq)
430                 changes |= WPA_BSS_FREQ_CHANGED_FLAG;
431
432         if (old->level != new->level)
433                 changes |= WPA_BSS_SIGNAL_CHANGED_FLAG;
434
435         if (caps_diff & IEEE80211_CAP_PRIVACY)
436                 changes |= WPA_BSS_PRIVACY_CHANGED_FLAG;
437
438         if (caps_diff & IEEE80211_CAP_IBSS)
439                 changes |= WPA_BSS_MODE_CHANGED_FLAG;
440
441         if (old->ie_len == new->ie_len &&
442             os_memcmp(old + 1, new + 1, old->ie_len) == 0)
443                 return changes;
444         changes |= WPA_BSS_IES_CHANGED_FLAG;
445
446         if (!are_ies_equal(old, new, WPA_IE_VENDOR_TYPE))
447                 changes |= WPA_BSS_WPAIE_CHANGED_FLAG;
448
449         if (!are_ies_equal(old, new, WLAN_EID_RSN))
450                 changes |= WPA_BSS_RSNIE_CHANGED_FLAG;
451
452         if (!are_ies_equal(old, new, WPS_IE_VENDOR_TYPE))
453                 changes |= WPA_BSS_WPS_CHANGED_FLAG;
454
455         if (!are_ies_equal(old, new, WLAN_EID_SUPP_RATES) ||
456             !are_ies_equal(old, new, WLAN_EID_EXT_SUPP_RATES))
457                 changes |= WPA_BSS_RATES_CHANGED_FLAG;
458
459         return changes;
460 }
461
462
463 static void notify_bss_changes(struct wpa_supplicant *wpa_s, u32 changes,
464                                const struct wpa_bss *bss)
465 {
466         if (changes & WPA_BSS_FREQ_CHANGED_FLAG)
467                 wpas_notify_bss_freq_changed(wpa_s, bss->id);
468
469         if (changes & WPA_BSS_SIGNAL_CHANGED_FLAG)
470                 wpas_notify_bss_signal_changed(wpa_s, bss->id);
471
472         if (changes & WPA_BSS_PRIVACY_CHANGED_FLAG)
473                 wpas_notify_bss_privacy_changed(wpa_s, bss->id);
474
475         if (changes & WPA_BSS_MODE_CHANGED_FLAG)
476                 wpas_notify_bss_mode_changed(wpa_s, bss->id);
477
478         if (changes & WPA_BSS_WPAIE_CHANGED_FLAG)
479                 wpas_notify_bss_wpaie_changed(wpa_s, bss->id);
480
481         if (changes & WPA_BSS_RSNIE_CHANGED_FLAG)
482                 wpas_notify_bss_rsnie_changed(wpa_s, bss->id);
483
484         if (changes & WPA_BSS_WPS_CHANGED_FLAG)
485                 wpas_notify_bss_wps_changed(wpa_s, bss->id);
486
487         if (changes & WPA_BSS_IES_CHANGED_FLAG)
488                 wpas_notify_bss_ies_changed(wpa_s, bss->id);
489
490         if (changes & WPA_BSS_RATES_CHANGED_FLAG)
491                 wpas_notify_bss_rates_changed(wpa_s, bss->id);
492
493         wpas_notify_bss_seen(wpa_s, bss->id);
494 }
495
496
497 static struct wpa_bss *
498 wpa_bss_update(struct wpa_supplicant *wpa_s, struct wpa_bss *bss,
499                struct wpa_scan_res *res, struct os_reltime *fetch_time)
500 {
501         u32 changes;
502
503         changes = wpa_bss_compare_res(bss, res);
504         bss->scan_miss_count = 0;
505         bss->last_update_idx = wpa_s->bss_update_idx;
506         wpa_bss_copy_res(bss, res, fetch_time);
507         /* Move the entry to the end of the list */
508         dl_list_del(&bss->list);
509 #ifdef CONFIG_P2P
510         if (wpa_bss_get_vendor_ie(bss, P2P_IE_VENDOR_TYPE) &&
511             !wpa_scan_get_vendor_ie(res, P2P_IE_VENDOR_TYPE)) {
512                 /*
513                  * This can happen when non-P2P station interface runs a scan
514                  * without P2P IE in the Probe Request frame. P2P GO would reply
515                  * to that with a Probe Response that does not include P2P IE.
516                  * Do not update the IEs in this BSS entry to avoid such loss of
517                  * information that may be needed for P2P operations to
518                  * determine group information.
519                  */
520                 wpa_dbg(wpa_s, MSG_DEBUG, "BSS: Do not update scan IEs for "
521                         MACSTR " since that would remove P2P IE information",
522                         MAC2STR(bss->bssid));
523         } else
524 #endif /* CONFIG_P2P */
525         if (bss->ie_len + bss->beacon_ie_len >=
526             res->ie_len + res->beacon_ie_len) {
527                 os_memcpy(bss + 1, res + 1, res->ie_len + res->beacon_ie_len);
528                 bss->ie_len = res->ie_len;
529                 bss->beacon_ie_len = res->beacon_ie_len;
530         } else {
531                 struct wpa_bss *nbss;
532                 struct dl_list *prev = bss->list_id.prev;
533                 dl_list_del(&bss->list_id);
534                 nbss = os_realloc(bss, sizeof(*bss) + res->ie_len +
535                                   res->beacon_ie_len);
536                 if (nbss) {
537                         unsigned int i;
538                         for (i = 0; i < wpa_s->last_scan_res_used; i++) {
539                                 if (wpa_s->last_scan_res[i] == bss) {
540                                         wpa_s->last_scan_res[i] = nbss;
541                                         break;
542                                 }
543                         }
544                         if (wpa_s->current_bss == bss)
545                                 wpa_s->current_bss = nbss;
546                         bss = nbss;
547                         os_memcpy(bss + 1, res + 1,
548                                   res->ie_len + res->beacon_ie_len);
549                         bss->ie_len = res->ie_len;
550                         bss->beacon_ie_len = res->beacon_ie_len;
551                 }
552                 dl_list_add(prev, &bss->list_id);
553         }
554         if (changes & WPA_BSS_IES_CHANGED_FLAG)
555                 wpa_bss_set_hessid(bss);
556         dl_list_add_tail(&wpa_s->bss, &bss->list);
557
558         notify_bss_changes(wpa_s, changes, bss);
559
560         return bss;
561 }
562
563
564 /**
565  * wpa_bss_update_start - Start a BSS table update from scan results
566  * @wpa_s: Pointer to wpa_supplicant data
567  *
568  * This function is called at the start of each BSS table update round for new
569  * scan results. The actual scan result entries are indicated with calls to
570  * wpa_bss_update_scan_res() and the update round is finished with a call to
571  * wpa_bss_update_end().
572  */
573 void wpa_bss_update_start(struct wpa_supplicant *wpa_s)
574 {
575         wpa_s->bss_update_idx++;
576         wpa_dbg(wpa_s, MSG_DEBUG, "BSS: Start scan result update %u",
577                 wpa_s->bss_update_idx);
578         wpa_s->last_scan_res_used = 0;
579 }
580
581
582 /**
583  * wpa_bss_update_scan_res - Update a BSS table entry based on a scan result
584  * @wpa_s: Pointer to wpa_supplicant data
585  * @res: Scan result
586  * @fetch_time: Time when the result was fetched from the driver
587  *
588  * This function updates a BSS table entry (or adds one) based on a scan result.
589  * This is called separately for each scan result between the calls to
590  * wpa_bss_update_start() and wpa_bss_update_end().
591  */
592 void wpa_bss_update_scan_res(struct wpa_supplicant *wpa_s,
593                              struct wpa_scan_res *res,
594                              struct os_reltime *fetch_time)
595 {
596         const u8 *ssid, *p2p, *mesh;
597         struct wpa_bss *bss;
598
599         if (wpa_s->conf->ignore_old_scan_res) {
600                 struct os_reltime update;
601                 calculate_update_time(fetch_time, res->age, &update);
602                 if (os_reltime_before(&update, &wpa_s->scan_trigger_time)) {
603                         struct os_reltime age;
604                         os_reltime_sub(&wpa_s->scan_trigger_time, &update,
605                                        &age);
606                         wpa_dbg(wpa_s, MSG_DEBUG, "BSS: Ignore driver BSS "
607                                 "table entry that is %u.%06u seconds older "
608                                 "than our scan trigger",
609                                 (unsigned int) age.sec,
610                                 (unsigned int) age.usec);
611                         return;
612                 }
613         }
614
615         ssid = wpa_scan_get_ie(res, WLAN_EID_SSID);
616         if (ssid == NULL) {
617                 wpa_dbg(wpa_s, MSG_DEBUG, "BSS: No SSID IE included for "
618                         MACSTR, MAC2STR(res->bssid));
619                 return;
620         }
621         if (ssid[1] > 32) {
622                 wpa_dbg(wpa_s, MSG_DEBUG, "BSS: Too long SSID IE included for "
623                         MACSTR, MAC2STR(res->bssid));
624                 return;
625         }
626
627         p2p = wpa_scan_get_vendor_ie(res, P2P_IE_VENDOR_TYPE);
628 #ifdef CONFIG_P2P
629         if (p2p == NULL &&
630             wpa_s->p2p_group_interface != NOT_P2P_GROUP_INTERFACE) {
631                 /*
632                  * If it's a P2P specific interface, then don't update
633                  * the scan result without a P2P IE.
634                  */
635                 wpa_printf(MSG_DEBUG, "BSS: No P2P IE - skipping BSS " MACSTR
636                            " update for P2P interface", MAC2STR(res->bssid));
637                 return;
638         }
639 #endif /* CONFIG_P2P */
640         if (p2p && ssid[1] == P2P_WILDCARD_SSID_LEN &&
641             os_memcmp(ssid + 2, P2P_WILDCARD_SSID, P2P_WILDCARD_SSID_LEN) == 0)
642                 return; /* Skip P2P listen discovery results here */
643
644         /* TODO: add option for ignoring BSSes we are not interested in
645          * (to save memory) */
646
647         mesh = wpa_scan_get_ie(res, WLAN_EID_MESH_ID);
648         if (mesh && mesh[1] <= 32)
649                 ssid = mesh;
650
651         bss = wpa_bss_get(wpa_s, res->bssid, ssid + 2, ssid[1]);
652         if (bss == NULL)
653                 bss = wpa_bss_add(wpa_s, ssid + 2, ssid[1], res, fetch_time);
654         else {
655                 bss = wpa_bss_update(wpa_s, bss, res, fetch_time);
656                 if (wpa_s->last_scan_res) {
657                         unsigned int i;
658                         for (i = 0; i < wpa_s->last_scan_res_used; i++) {
659                                 if (bss == wpa_s->last_scan_res[i]) {
660                                         /* Already in the list */
661                                         return;
662                                 }
663                         }
664                 }
665         }
666
667         if (bss == NULL)
668                 return;
669         if (wpa_s->last_scan_res_used >= wpa_s->last_scan_res_size) {
670                 struct wpa_bss **n;
671                 unsigned int siz;
672                 if (wpa_s->last_scan_res_size == 0)
673                         siz = 32;
674                 else
675                         siz = wpa_s->last_scan_res_size * 2;
676                 n = os_realloc_array(wpa_s->last_scan_res, siz,
677                                      sizeof(struct wpa_bss *));
678                 if (n == NULL)
679                         return;
680                 wpa_s->last_scan_res = n;
681                 wpa_s->last_scan_res_size = siz;
682         }
683
684         if (wpa_s->last_scan_res)
685                 wpa_s->last_scan_res[wpa_s->last_scan_res_used++] = bss;
686 }
687
688
689 static int wpa_bss_included_in_scan(const struct wpa_bss *bss,
690                                     const struct scan_info *info)
691 {
692         int found;
693         size_t i;
694
695         if (info == NULL)
696                 return 1;
697
698         if (info->num_freqs) {
699                 found = 0;
700                 for (i = 0; i < info->num_freqs; i++) {
701                         if (bss->freq == info->freqs[i]) {
702                                 found = 1;
703                                 break;
704                         }
705                 }
706                 if (!found)
707                         return 0;
708         }
709
710         if (info->num_ssids) {
711                 found = 0;
712                 for (i = 0; i < info->num_ssids; i++) {
713                         const struct wpa_driver_scan_ssid *s = &info->ssids[i];
714                         if ((s->ssid == NULL || s->ssid_len == 0) ||
715                             (s->ssid_len == bss->ssid_len &&
716                              os_memcmp(s->ssid, bss->ssid, bss->ssid_len) ==
717                              0)) {
718                                 found = 1;
719                                 break;
720                         }
721                 }
722                 if (!found)
723                         return 0;
724         }
725
726         return 1;
727 }
728
729
730 /**
731  * wpa_bss_update_end - End a BSS table update from scan results
732  * @wpa_s: Pointer to wpa_supplicant data
733  * @info: Information about scan parameters
734  * @new_scan: Whether this update round was based on a new scan
735  *
736  * This function is called at the end of each BSS table update round for new
737  * scan results. The start of the update was indicated with a call to
738  * wpa_bss_update_start().
739  */
740 void wpa_bss_update_end(struct wpa_supplicant *wpa_s, struct scan_info *info,
741                         int new_scan)
742 {
743         struct wpa_bss *bss, *n;
744
745         os_get_reltime(&wpa_s->last_scan);
746         if (!new_scan)
747                 return; /* do not expire entries without new scan */
748
749         dl_list_for_each_safe(bss, n, &wpa_s->bss, struct wpa_bss, list) {
750                 if (wpa_bss_in_use(wpa_s, bss))
751                         continue;
752                 if (!wpa_bss_included_in_scan(bss, info))
753                         continue; /* expire only BSSes that were scanned */
754                 if (bss->last_update_idx < wpa_s->bss_update_idx)
755                         bss->scan_miss_count++;
756                 if (bss->scan_miss_count >=
757                     wpa_s->conf->bss_expiration_scan_count) {
758                         wpa_bss_remove(wpa_s, bss, "no match in scan");
759                 }
760         }
761
762         wpa_printf(MSG_DEBUG, "BSS: last_scan_res_used=%u/%u",
763                    wpa_s->last_scan_res_used, wpa_s->last_scan_res_size);
764 }
765
766
767 /**
768  * wpa_bss_flush_by_age - Flush old BSS entries
769  * @wpa_s: Pointer to wpa_supplicant data
770  * @age: Maximum entry age in seconds
771  *
772  * Remove BSS entries that have not been updated during the last @age seconds.
773  */
774 void wpa_bss_flush_by_age(struct wpa_supplicant *wpa_s, int age)
775 {
776         struct wpa_bss *bss, *n;
777         struct os_reltime t;
778
779         if (dl_list_empty(&wpa_s->bss))
780                 return;
781
782         os_get_reltime(&t);
783         t.sec -= age;
784
785         dl_list_for_each_safe(bss, n, &wpa_s->bss, struct wpa_bss, list) {
786                 if (wpa_bss_in_use(wpa_s, bss))
787                         continue;
788
789                 if (os_reltime_before(&bss->last_update, &t)) {
790                         wpa_bss_remove(wpa_s, bss, __func__);
791                 } else
792                         break;
793         }
794 }
795
796
797 static void wpa_bss_timeout(void *eloop_ctx, void *timeout_ctx)
798 {
799         struct wpa_supplicant *wpa_s = eloop_ctx;
800
801         wpa_bss_flush_by_age(wpa_s, wpa_s->conf->bss_expiration_age);
802         eloop_register_timeout(WPA_BSS_EXPIRATION_PERIOD, 0,
803                                wpa_bss_timeout, wpa_s, NULL);
804 }
805
806
807 /**
808  * wpa_bss_init - Initialize BSS table
809  * @wpa_s: Pointer to wpa_supplicant data
810  * Returns: 0 on success, -1 on failure
811  *
812  * This prepares BSS table lists and timer for periodic updates. The BSS table
813  * is deinitialized with wpa_bss_deinit() once not needed anymore.
814  */
815 int wpa_bss_init(struct wpa_supplicant *wpa_s)
816 {
817         dl_list_init(&wpa_s->bss);
818         dl_list_init(&wpa_s->bss_id);
819         eloop_register_timeout(WPA_BSS_EXPIRATION_PERIOD, 0,
820                                wpa_bss_timeout, wpa_s, NULL);
821         return 0;
822 }
823
824
825 /**
826  * wpa_bss_flush - Flush all unused BSS entries
827  * @wpa_s: Pointer to wpa_supplicant data
828  */
829 void wpa_bss_flush(struct wpa_supplicant *wpa_s)
830 {
831         struct wpa_bss *bss, *n;
832
833         wpa_s->clear_driver_scan_cache = 1;
834
835         if (wpa_s->bss.next == NULL)
836                 return; /* BSS table not yet initialized */
837
838         dl_list_for_each_safe(bss, n, &wpa_s->bss, struct wpa_bss, list) {
839                 if (wpa_bss_in_use(wpa_s, bss))
840                         continue;
841                 wpa_bss_remove(wpa_s, bss, __func__);
842         }
843 }
844
845
846 /**
847  * wpa_bss_deinit - Deinitialize BSS table
848  * @wpa_s: Pointer to wpa_supplicant data
849  */
850 void wpa_bss_deinit(struct wpa_supplicant *wpa_s)
851 {
852         eloop_cancel_timeout(wpa_bss_timeout, wpa_s, NULL);
853         wpa_bss_flush(wpa_s);
854 }
855
856
857 /**
858  * wpa_bss_get_bssid - Fetch a BSS table entry based on BSSID
859  * @wpa_s: Pointer to wpa_supplicant data
860  * @bssid: BSSID
861  * Returns: Pointer to the BSS entry or %NULL if not found
862  */
863 struct wpa_bss * wpa_bss_get_bssid(struct wpa_supplicant *wpa_s,
864                                    const u8 *bssid)
865 {
866         struct wpa_bss *bss;
867         if (!wpa_supplicant_filter_bssid_match(wpa_s, bssid))
868                 return NULL;
869         dl_list_for_each_reverse(bss, &wpa_s->bss, struct wpa_bss, list) {
870                 if (os_memcmp(bss->bssid, bssid, ETH_ALEN) == 0)
871                         return bss;
872         }
873         return NULL;
874 }
875
876
877 /**
878  * wpa_bss_get_bssid_latest - Fetch the latest BSS table entry based on BSSID
879  * @wpa_s: Pointer to wpa_supplicant data
880  * @bssid: BSSID
881  * Returns: Pointer to the BSS entry or %NULL if not found
882  *
883  * This function is like wpa_bss_get_bssid(), but full BSS table is iterated to
884  * find the entry that has the most recent update. This can help in finding the
885  * correct entry in cases where the SSID of the AP may have changed recently
886  * (e.g., in WPS reconfiguration cases).
887  */
888 struct wpa_bss * wpa_bss_get_bssid_latest(struct wpa_supplicant *wpa_s,
889                                           const u8 *bssid)
890 {
891         struct wpa_bss *bss, *found = NULL;
892         if (!wpa_supplicant_filter_bssid_match(wpa_s, bssid))
893                 return NULL;
894         dl_list_for_each_reverse(bss, &wpa_s->bss, struct wpa_bss, list) {
895                 if (os_memcmp(bss->bssid, bssid, ETH_ALEN) != 0)
896                         continue;
897                 if (found == NULL ||
898                     os_reltime_before(&found->last_update, &bss->last_update))
899                         found = bss;
900         }
901         return found;
902 }
903
904
905 #ifdef CONFIG_P2P
906 /**
907  * wpa_bss_get_p2p_dev_addr - Fetch a BSS table entry based on P2P Device Addr
908  * @wpa_s: Pointer to wpa_supplicant data
909  * @dev_addr: P2P Device Address of the GO
910  * Returns: Pointer to the BSS entry or %NULL if not found
911  */
912 struct wpa_bss * wpa_bss_get_p2p_dev_addr(struct wpa_supplicant *wpa_s,
913                                           const u8 *dev_addr)
914 {
915         struct wpa_bss *bss;
916         dl_list_for_each_reverse(bss, &wpa_s->bss, struct wpa_bss, list) {
917                 u8 addr[ETH_ALEN];
918                 if (p2p_parse_dev_addr((const u8 *) (bss + 1), bss->ie_len,
919                                        addr) == 0 &&
920                     os_memcmp(addr, dev_addr, ETH_ALEN) == 0)
921                         return bss;
922         }
923         return NULL;
924 }
925 #endif /* CONFIG_P2P */
926
927
928 /**
929  * wpa_bss_get_id - Fetch a BSS table entry based on identifier
930  * @wpa_s: Pointer to wpa_supplicant data
931  * @id: Unique identifier (struct wpa_bss::id) assigned for the entry
932  * Returns: Pointer to the BSS entry or %NULL if not found
933  */
934 struct wpa_bss * wpa_bss_get_id(struct wpa_supplicant *wpa_s, unsigned int id)
935 {
936         struct wpa_bss *bss;
937         dl_list_for_each(bss, &wpa_s->bss, struct wpa_bss, list) {
938                 if (bss->id == id)
939                         return bss;
940         }
941         return NULL;
942 }
943
944
945 /**
946  * wpa_bss_get_id_range - Fetch a BSS table entry based on identifier range
947  * @wpa_s: Pointer to wpa_supplicant data
948  * @idf: Smallest allowed identifier assigned for the entry
949  * @idf: Largest allowed identifier assigned for the entry
950  * Returns: Pointer to the BSS entry or %NULL if not found
951  *
952  * This function is similar to wpa_bss_get_id() but allows a BSS entry with the
953  * smallest id value to be fetched within the specified range without the
954  * caller having to know the exact id.
955  */
956 struct wpa_bss * wpa_bss_get_id_range(struct wpa_supplicant *wpa_s,
957                                       unsigned int idf, unsigned int idl)
958 {
959         struct wpa_bss *bss;
960         dl_list_for_each(bss, &wpa_s->bss_id, struct wpa_bss, list_id) {
961                 if (bss->id >= idf && bss->id <= idl)
962                         return bss;
963         }
964         return NULL;
965 }
966
967
968 /**
969  * wpa_bss_get_ie - Fetch a specified information element from a BSS entry
970  * @bss: BSS table entry
971  * @ie: Information element identitifier (WLAN_EID_*)
972  * Returns: Pointer to the information element (id field) or %NULL if not found
973  *
974  * This function returns the first matching information element in the BSS
975  * entry.
976  */
977 const u8 * wpa_bss_get_ie(const struct wpa_bss *bss, u8 ie)
978 {
979         const u8 *end, *pos;
980
981         pos = (const u8 *) (bss + 1);
982         end = pos + bss->ie_len;
983
984         while (pos + 1 < end) {
985                 if (pos + 2 + pos[1] > end)
986                         break;
987                 if (pos[0] == ie)
988                         return pos;
989                 pos += 2 + pos[1];
990         }
991
992         return NULL;
993 }
994
995
996 /**
997  * wpa_bss_get_vendor_ie - Fetch a vendor information element from a BSS entry
998  * @bss: BSS table entry
999  * @vendor_type: Vendor type (four octets starting the IE payload)
1000  * Returns: Pointer to the information element (id field) or %NULL if not found
1001  *
1002  * This function returns the first matching information element in the BSS
1003  * entry.
1004  */
1005 const u8 * wpa_bss_get_vendor_ie(const struct wpa_bss *bss, u32 vendor_type)
1006 {
1007         const u8 *end, *pos;
1008
1009         pos = (const u8 *) (bss + 1);
1010         end = pos + bss->ie_len;
1011
1012         while (pos + 1 < end) {
1013                 if (pos + 2 + pos[1] > end)
1014                         break;
1015                 if (pos[0] == WLAN_EID_VENDOR_SPECIFIC && pos[1] >= 4 &&
1016                     vendor_type == WPA_GET_BE32(&pos[2]))
1017                         return pos;
1018                 pos += 2 + pos[1];
1019         }
1020
1021         return NULL;
1022 }
1023
1024
1025 /**
1026  * wpa_bss_get_vendor_ie_beacon - Fetch a vendor information from a BSS entry
1027  * @bss: BSS table entry
1028  * @vendor_type: Vendor type (four octets starting the IE payload)
1029  * Returns: Pointer to the information element (id field) or %NULL if not found
1030  *
1031  * This function returns the first matching information element in the BSS
1032  * entry.
1033  *
1034  * This function is like wpa_bss_get_vendor_ie(), but uses IE buffer only
1035  * from Beacon frames instead of either Beacon or Probe Response frames.
1036  */
1037 const u8 * wpa_bss_get_vendor_ie_beacon(const struct wpa_bss *bss,
1038                                         u32 vendor_type)
1039 {
1040         const u8 *end, *pos;
1041
1042         if (bss->beacon_ie_len == 0)
1043                 return NULL;
1044
1045         pos = (const u8 *) (bss + 1);
1046         pos += bss->ie_len;
1047         end = pos + bss->beacon_ie_len;
1048
1049         while (pos + 1 < end) {
1050                 if (pos + 2 + pos[1] > end)
1051                         break;
1052                 if (pos[0] == WLAN_EID_VENDOR_SPECIFIC && pos[1] >= 4 &&
1053                     vendor_type == WPA_GET_BE32(&pos[2]))
1054                         return pos;
1055                 pos += 2 + pos[1];
1056         }
1057
1058         return NULL;
1059 }
1060
1061
1062 /**
1063  * wpa_bss_get_vendor_ie_multi - Fetch vendor IE data from a BSS entry
1064  * @bss: BSS table entry
1065  * @vendor_type: Vendor type (four octets starting the IE payload)
1066  * Returns: Pointer to the information element payload or %NULL if not found
1067  *
1068  * This function returns concatenated payload of possibly fragmented vendor
1069  * specific information elements in the BSS entry. The caller is responsible for
1070  * freeing the returned buffer.
1071  */
1072 struct wpabuf * wpa_bss_get_vendor_ie_multi(const struct wpa_bss *bss,
1073                                             u32 vendor_type)
1074 {
1075         struct wpabuf *buf;
1076         const u8 *end, *pos;
1077
1078         buf = wpabuf_alloc(bss->ie_len);
1079         if (buf == NULL)
1080                 return NULL;
1081
1082         pos = (const u8 *) (bss + 1);
1083         end = pos + bss->ie_len;
1084
1085         while (pos + 1 < end) {
1086                 if (pos + 2 + pos[1] > end)
1087                         break;
1088                 if (pos[0] == WLAN_EID_VENDOR_SPECIFIC && pos[1] >= 4 &&
1089                     vendor_type == WPA_GET_BE32(&pos[2]))
1090                         wpabuf_put_data(buf, pos + 2 + 4, pos[1] - 4);
1091                 pos += 2 + pos[1];
1092         }
1093
1094         if (wpabuf_len(buf) == 0) {
1095                 wpabuf_free(buf);
1096                 buf = NULL;
1097         }
1098
1099         return buf;
1100 }
1101
1102
1103 /**
1104  * wpa_bss_get_vendor_ie_multi_beacon - Fetch vendor IE data from a BSS entry
1105  * @bss: BSS table entry
1106  * @vendor_type: Vendor type (four octets starting the IE payload)
1107  * Returns: Pointer to the information element payload or %NULL if not found
1108  *
1109  * This function returns concatenated payload of possibly fragmented vendor
1110  * specific information elements in the BSS entry. The caller is responsible for
1111  * freeing the returned buffer.
1112  *
1113  * This function is like wpa_bss_get_vendor_ie_multi(), but uses IE buffer only
1114  * from Beacon frames instead of either Beacon or Probe Response frames.
1115  */
1116 struct wpabuf * wpa_bss_get_vendor_ie_multi_beacon(const struct wpa_bss *bss,
1117                                                    u32 vendor_type)
1118 {
1119         struct wpabuf *buf;
1120         const u8 *end, *pos;
1121
1122         buf = wpabuf_alloc(bss->beacon_ie_len);
1123         if (buf == NULL)
1124                 return NULL;
1125
1126         pos = (const u8 *) (bss + 1);
1127         pos += bss->ie_len;
1128         end = pos + bss->beacon_ie_len;
1129
1130         while (pos + 1 < end) {
1131                 if (pos + 2 + pos[1] > end)
1132                         break;
1133                 if (pos[0] == WLAN_EID_VENDOR_SPECIFIC && pos[1] >= 4 &&
1134                     vendor_type == WPA_GET_BE32(&pos[2]))
1135                         wpabuf_put_data(buf, pos + 2 + 4, pos[1] - 4);
1136                 pos += 2 + pos[1];
1137         }
1138
1139         if (wpabuf_len(buf) == 0) {
1140                 wpabuf_free(buf);
1141                 buf = NULL;
1142         }
1143
1144         return buf;
1145 }
1146
1147
1148 /**
1149  * wpa_bss_get_max_rate - Get maximum legacy TX rate supported in a BSS
1150  * @bss: BSS table entry
1151  * Returns: Maximum legacy rate in units of 500 kbps
1152  */
1153 int wpa_bss_get_max_rate(const struct wpa_bss *bss)
1154 {
1155         int rate = 0;
1156         const u8 *ie;
1157         int i;
1158
1159         ie = wpa_bss_get_ie(bss, WLAN_EID_SUPP_RATES);
1160         for (i = 0; ie && i < ie[1]; i++) {
1161                 if ((ie[i + 2] & 0x7f) > rate)
1162                         rate = ie[i + 2] & 0x7f;
1163         }
1164
1165         ie = wpa_bss_get_ie(bss, WLAN_EID_EXT_SUPP_RATES);
1166         for (i = 0; ie && i < ie[1]; i++) {
1167                 if ((ie[i + 2] & 0x7f) > rate)
1168                         rate = ie[i + 2] & 0x7f;
1169         }
1170
1171         return rate;
1172 }
1173
1174
1175 /**
1176  * wpa_bss_get_bit_rates - Get legacy TX rates supported in a BSS
1177  * @bss: BSS table entry
1178  * @rates: Buffer for returning a pointer to the rates list (units of 500 kbps)
1179  * Returns: number of legacy TX rates or -1 on failure
1180  *
1181  * The caller is responsible for freeing the returned buffer with os_free() in
1182  * case of success.
1183  */
1184 int wpa_bss_get_bit_rates(const struct wpa_bss *bss, u8 **rates)
1185 {
1186         const u8 *ie, *ie2;
1187         int i, j;
1188         unsigned int len;
1189         u8 *r;
1190
1191         ie = wpa_bss_get_ie(bss, WLAN_EID_SUPP_RATES);
1192         ie2 = wpa_bss_get_ie(bss, WLAN_EID_EXT_SUPP_RATES);
1193
1194         len = (ie ? ie[1] : 0) + (ie2 ? ie2[1] : 0);
1195
1196         r = os_malloc(len);
1197         if (!r)
1198                 return -1;
1199
1200         for (i = 0; ie && i < ie[1]; i++)
1201                 r[i] = ie[i + 2] & 0x7f;
1202
1203         for (j = 0; ie2 && j < ie2[1]; j++)
1204                 r[i + j] = ie2[j + 2] & 0x7f;
1205
1206         *rates = r;
1207         return len;
1208 }