2 * WPA Supplicant - Scanning
3 * Copyright (c) 2003-2010, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
15 #include "utils/includes.h"
17 #include "utils/common.h"
18 #include "utils/eloop.h"
19 #include "common/ieee802_11_defs.h"
21 #include "wpa_supplicant_i.h"
24 #include "wps_supplicant.h"
25 #include "p2p_supplicant.h"
32 static void wpa_supplicant_gen_assoc_event(struct wpa_supplicant *wpa_s)
34 struct wpa_ssid *ssid;
35 union wpa_event_data data;
37 ssid = wpa_supplicant_get_ssid(wpa_s);
41 if (wpa_s->current_ssid == NULL) {
42 wpa_s->current_ssid = ssid;
43 if (wpa_s->current_ssid != NULL)
44 wpas_notify_network_changed(wpa_s);
46 wpa_supplicant_initiate_eapol(wpa_s);
47 wpa_dbg(wpa_s, MSG_DEBUG, "Already associated with a configured "
48 "network - generating associated event");
49 os_memset(&data, 0, sizeof(data));
50 wpa_supplicant_event(wpa_s, EVENT_ASSOC, &data);
55 static int wpas_wps_in_use(struct wpa_config *conf,
56 enum wps_request_type *req_type)
58 struct wpa_ssid *ssid;
61 for (ssid = conf->ssid; ssid; ssid = ssid->next) {
62 if (!(ssid->key_mgmt & WPA_KEY_MGMT_WPS))
66 *req_type = wpas_wps_get_req_type(ssid);
67 if (!ssid->eap.phase1)
70 if (os_strstr(ssid->eap.phase1, "pbc=1"))
76 #endif /* CONFIG_WPS */
79 int wpa_supplicant_enabled_networks(struct wpa_config *conf)
81 struct wpa_ssid *ssid = conf->ssid;
92 static void wpa_supplicant_assoc_try(struct wpa_supplicant *wpa_s,
93 struct wpa_ssid *ssid)
101 /* ap_scan=2 mode - try to associate with each SSID. */
103 wpa_dbg(wpa_s, MSG_DEBUG, "wpa_supplicant_assoc_try: Reached "
104 "end of scan list - go back to beginning");
105 wpa_s->prev_scan_ssid = WILDCARD_SSID_SCAN;
106 wpa_supplicant_req_scan(wpa_s, 0, 0);
110 /* Continue from the next SSID on the next attempt. */
111 wpa_s->prev_scan_ssid = ssid;
113 /* Start from the beginning of the SSID list. */
114 wpa_s->prev_scan_ssid = WILDCARD_SSID_SCAN;
116 wpa_supplicant_associate(wpa_s, NULL, ssid);
120 static int int_array_len(const int *a)
123 for (i = 0; a && a[i]; i++)
129 static void int_array_concat(int **res, const int *a)
134 reslen = int_array_len(*res);
135 alen = int_array_len(a);
137 n = os_realloc(*res, (reslen + alen + 1) * sizeof(int));
143 for (i = 0; i <= alen; i++)
144 n[reslen + i] = a[i];
149 static int freq_cmp(const void *a, const void *b)
162 static void int_array_sort_unique(int *a)
170 alen = int_array_len(a);
171 qsort(a, alen, sizeof(int), freq_cmp);
175 while (a[i] && a[j]) {
188 int wpa_supplicant_trigger_scan(struct wpa_supplicant *wpa_s,
189 struct wpa_driver_scan_params *params)
193 wpa_supplicant_notify_scanning(wpa_s, 1);
195 if (wpa_s->drv_flags & WPA_DRIVER_FLAGS_USER_SPACE_MLME)
196 ret = ieee80211_sta_req_scan(wpa_s, params);
198 ret = wpa_drv_scan(wpa_s, params);
201 wpa_supplicant_notify_scanning(wpa_s, 0);
202 wpas_notify_scan_done(wpa_s, 0);
210 static struct wpa_driver_scan_filter *
211 wpa_supplicant_build_filter_ssids(struct wpa_config *conf, size_t *num_ssids)
213 struct wpa_driver_scan_filter *ssids;
214 struct wpa_ssid *ssid;
218 if (!conf->filter_ssids)
221 for (count = 0, ssid = conf->ssid; ssid; ssid = ssid->next) {
222 if (ssid->ssid && ssid->ssid_len)
227 ssids = os_zalloc(count * sizeof(struct wpa_driver_scan_filter));
231 for (ssid = conf->ssid; ssid; ssid = ssid->next) {
232 if (!ssid->ssid || !ssid->ssid_len)
234 os_memcpy(ssids[*num_ssids].ssid, ssid->ssid, ssid->ssid_len);
235 ssids[*num_ssids].ssid_len = ssid->ssid_len;
243 static void wpa_supplicant_scan(void *eloop_ctx, void *timeout_ctx)
245 struct wpa_supplicant *wpa_s = eloop_ctx;
246 struct wpa_ssid *ssid;
247 int scan_req = 0, ret;
248 struct wpabuf *wps_ie = NULL;
251 enum wps_request_type req_type = WPS_REQ_ENROLLEE_INFO;
252 #endif /* CONFIG_WPS */
253 struct wpa_driver_scan_params params;
255 enum wpa_states prev_state;
257 if (wpa_s->wpa_state == WPA_INTERFACE_DISABLED) {
258 wpa_dbg(wpa_s, MSG_DEBUG, "Skip scan - interface disabled");
262 if (wpa_s->disconnected && !wpa_s->scan_req) {
263 wpa_supplicant_set_state(wpa_s, WPA_DISCONNECTED);
267 if (!wpa_supplicant_enabled_networks(wpa_s->conf) &&
269 wpa_dbg(wpa_s, MSG_DEBUG, "No enabled networks - do not scan");
270 wpa_supplicant_set_state(wpa_s, WPA_INACTIVE);
274 if (wpa_s->conf->ap_scan != 0 &&
275 (wpa_s->drv_flags & WPA_DRIVER_FLAGS_WIRED)) {
276 wpa_dbg(wpa_s, MSG_DEBUG, "Using wired authentication - "
277 "overriding ap_scan configuration");
278 wpa_s->conf->ap_scan = 0;
279 wpas_notify_ap_scan_changed(wpa_s);
282 if (wpa_s->conf->ap_scan == 0) {
283 wpa_supplicant_gen_assoc_event(wpa_s);
288 if (wpas_p2p_in_progress(wpa_s)) {
289 if (wpa_s->wpa_state == WPA_SCANNING) {
290 wpa_dbg(wpa_s, MSG_DEBUG, "Delay station mode scan "
291 "while P2P operation is in progress");
292 wpa_supplicant_req_scan(wpa_s, 5, 0);
294 wpa_dbg(wpa_s, MSG_DEBUG, "Do not request scan while "
295 "P2P operation is in progress");
299 #endif /* CONFIG_P2P */
301 if ((wpa_s->drv_flags & WPA_DRIVER_FLAGS_USER_SPACE_MLME) ||
302 wpa_s->conf->ap_scan == 2)
305 max_ssids = wpa_s->max_scan_ssids;
306 if (max_ssids > WPAS_MAX_SCAN_SSIDS)
307 max_ssids = WPAS_MAX_SCAN_SSIDS;
311 wps = wpas_wps_in_use(wpa_s->conf, &req_type);
312 #endif /* CONFIG_WPS */
314 scan_req = wpa_s->scan_req;
317 os_memset(¶ms, 0, sizeof(params));
319 prev_state = wpa_s->wpa_state;
320 if (wpa_s->wpa_state == WPA_DISCONNECTED ||
321 wpa_s->wpa_state == WPA_INACTIVE)
322 wpa_supplicant_set_state(wpa_s, WPA_SCANNING);
324 if (scan_req != 2 && wpa_s->connect_without_scan) {
325 for (ssid = wpa_s->conf->ssid; ssid; ssid = ssid->next) {
326 if (ssid == wpa_s->connect_without_scan)
329 wpa_s->connect_without_scan = NULL;
331 wpa_printf(MSG_DEBUG, "Start a pre-selected network "
332 "without scan step");
333 wpa_supplicant_associate(wpa_s, NULL, ssid);
338 /* Find the starting point from which to continue scanning */
339 ssid = wpa_s->conf->ssid;
340 if (wpa_s->prev_scan_ssid != WILDCARD_SSID_SCAN) {
342 if (ssid == wpa_s->prev_scan_ssid) {
350 if (scan_req != 2 && wpa_s->conf->ap_scan == 2) {
351 wpa_s->connect_without_scan = NULL;
352 wpa_supplicant_assoc_try(wpa_s, ssid);
354 } else if (wpa_s->conf->ap_scan == 2) {
356 * User-initiated scan request in ap_scan == 2; scan with
361 struct wpa_ssid *start = ssid, *tssid;
363 if (ssid == NULL && max_ssids > 1)
364 ssid = wpa_s->conf->ssid;
366 if (!ssid->disabled && ssid->scan_ssid) {
367 wpa_hexdump_ascii(MSG_DEBUG, "Scan SSID",
368 ssid->ssid, ssid->ssid_len);
369 params.ssids[params.num_ssids].ssid =
371 params.ssids[params.num_ssids].ssid_len =
374 if (params.num_ssids + 1 >= max_ssids)
380 if (ssid == NULL && max_ssids > 1 &&
381 start != wpa_s->conf->ssid)
382 ssid = wpa_s->conf->ssid;
385 for (tssid = wpa_s->conf->ssid; tssid; tssid = tssid->next) {
388 if ((params.freqs || !freqs_set) && tssid->scan_freq) {
389 int_array_concat(¶ms.freqs,
392 os_free(params.freqs);
397 int_array_sort_unique(params.freqs);
401 wpa_s->prev_scan_ssid = ssid;
403 wpa_dbg(wpa_s, MSG_DEBUG, "Include wildcard SSID in "
407 wpa_dbg(wpa_s, MSG_DEBUG, "Starting AP scan for specific "
410 wpa_s->prev_scan_ssid = WILDCARD_SSID_SCAN;
412 wpa_dbg(wpa_s, MSG_DEBUG, "Starting AP scan for wildcard "
417 wpa_s->wps->dev.p2p = 1;
420 req_type = WPS_REQ_ENROLLEE_INFO;
423 if (params.freqs == NULL && wpa_s->p2p_in_provisioning &&
425 /* Optimize provisioning state scan based on GO information */
426 if (wpa_s->p2p_in_provisioning < 5 &&
427 wpa_s->go_params->freq > 0) {
428 wpa_dbg(wpa_s, MSG_DEBUG, "P2P: Scan only GO "
429 "preferred frequency %d MHz",
430 wpa_s->go_params->freq);
431 params.freqs = os_zalloc(2 * sizeof(int));
433 params.freqs[0] = wpa_s->go_params->freq;
434 } else if (wpa_s->p2p_in_provisioning < 8 &&
435 wpa_s->go_params->freq_list[0]) {
436 wpa_dbg(wpa_s, MSG_DEBUG, "P2P: Scan only common "
438 int_array_concat(¶ms.freqs,
439 wpa_s->go_params->freq_list);
441 int_array_sort_unique(params.freqs);
443 wpa_s->p2p_in_provisioning++;
445 #endif /* CONFIG_P2P */
448 if (params.freqs == NULL && wpa_s->after_wps && wpa_s->wps_freq) {
450 * Optimize post-provisioning scan based on channel used
451 * during provisioning.
453 wpa_dbg(wpa_s, MSG_DEBUG, "WPS: Scan only frequency %u MHz "
454 "that was used during provisioning", wpa_s->wps_freq);
455 params.freqs = os_zalloc(2 * sizeof(int));
457 params.freqs[0] = wpa_s->wps_freq;
462 wps_ie = wps_build_probe_req_ie(wps == 2, &wpa_s->wps->dev,
463 wpa_s->wps->uuid, req_type,
466 params.extra_ies = wpabuf_head(wps_ie);
467 params.extra_ies_len = wpabuf_len(wps_ie);
470 #endif /* CONFIG_WPS */
474 if (wpabuf_resize(&wps_ie, 100) == 0) {
475 wpas_p2p_scan_ie(wpa_s, wps_ie);
476 params.extra_ies = wpabuf_head(wps_ie);
477 params.extra_ies_len = wpabuf_len(wps_ie);
480 #endif /* CONFIG_P2P */
482 if (params.freqs == NULL && wpa_s->next_scan_freqs) {
483 wpa_dbg(wpa_s, MSG_DEBUG, "Optimize scan based on previously "
484 "generated frequency list");
485 params.freqs = wpa_s->next_scan_freqs;
487 os_free(wpa_s->next_scan_freqs);
488 wpa_s->next_scan_freqs = NULL;
490 params.filter_ssids = wpa_supplicant_build_filter_ssids(
491 wpa_s->conf, ¶ms.num_filter_ssids);
493 ret = wpa_supplicant_trigger_scan(wpa_s, ¶ms);
496 os_free(params.freqs);
497 os_free(params.filter_ssids);
500 wpa_msg(wpa_s, MSG_WARNING, "Failed to initiate AP scan");
501 if (prev_state != wpa_s->wpa_state)
502 wpa_supplicant_set_state(wpa_s, prev_state);
503 wpa_supplicant_req_scan(wpa_s, 1, 0);
509 * wpa_supplicant_req_scan - Schedule a scan for neighboring access points
510 * @wpa_s: Pointer to wpa_supplicant data
511 * @sec: Number of seconds after which to scan
512 * @usec: Number of microseconds after which to scan
514 * This function is used to schedule a scan for neighboring access points after
515 * the specified time.
517 void wpa_supplicant_req_scan(struct wpa_supplicant *wpa_s, int sec, int usec)
519 /* If there's at least one network that should be specifically scanned
520 * then don't cancel the scan and reschedule. Some drivers do
521 * background scanning which generates frequent scan results, and that
522 * causes the specific SSID scan to get continually pushed back and
523 * never happen, which causes hidden APs to never get probe-scanned.
525 if (eloop_is_timeout_registered(wpa_supplicant_scan, wpa_s, NULL) &&
526 wpa_s->conf->ap_scan == 1) {
527 struct wpa_ssid *ssid = wpa_s->conf->ssid;
530 if (!ssid->disabled && ssid->scan_ssid)
535 wpa_dbg(wpa_s, MSG_DEBUG, "Not rescheduling scan to "
536 "ensure that specific SSID scans occur");
541 wpa_dbg(wpa_s, MSG_DEBUG, "Setting scan request: %d sec %d usec",
543 eloop_cancel_timeout(wpa_supplicant_scan, wpa_s, NULL);
544 eloop_register_timeout(sec, usec, wpa_supplicant_scan, wpa_s, NULL);
549 * wpa_supplicant_cancel_scan - Cancel a scheduled scan request
550 * @wpa_s: Pointer to wpa_supplicant data
552 * This function is used to cancel a scan request scheduled with
553 * wpa_supplicant_req_scan().
555 void wpa_supplicant_cancel_scan(struct wpa_supplicant *wpa_s)
557 wpa_dbg(wpa_s, MSG_DEBUG, "Cancelling scan request");
558 eloop_cancel_timeout(wpa_supplicant_scan, wpa_s, NULL);
562 void wpa_supplicant_notify_scanning(struct wpa_supplicant *wpa_s,
565 if (wpa_s->scanning != scanning) {
566 wpa_s->scanning = scanning;
567 wpas_notify_scanning(wpa_s);
572 static int wpa_scan_get_max_rate(const struct wpa_scan_res *res)
578 ie = wpa_scan_get_ie(res, WLAN_EID_SUPP_RATES);
579 for (i = 0; ie && i < ie[1]; i++) {
580 if ((ie[i + 2] & 0x7f) > rate)
581 rate = ie[i + 2] & 0x7f;
584 ie = wpa_scan_get_ie(res, WLAN_EID_EXT_SUPP_RATES);
585 for (i = 0; ie && i < ie[1]; i++) {
586 if ((ie[i + 2] & 0x7f) > rate)
587 rate = ie[i + 2] & 0x7f;
594 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie)
598 pos = (const u8 *) (res + 1);
599 end = pos + res->ie_len;
601 while (pos + 1 < end) {
602 if (pos + 2 + pos[1] > end)
613 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
618 pos = (const u8 *) (res + 1);
619 end = pos + res->ie_len;
621 while (pos + 1 < end) {
622 if (pos + 2 + pos[1] > end)
624 if (pos[0] == WLAN_EID_VENDOR_SPECIFIC && pos[1] >= 4 &&
625 vendor_type == WPA_GET_BE32(&pos[2]))
634 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
640 buf = wpabuf_alloc(res->ie_len);
644 pos = (const u8 *) (res + 1);
645 end = pos + res->ie_len;
647 while (pos + 1 < end) {
648 if (pos + 2 + pos[1] > end)
650 if (pos[0] == WLAN_EID_VENDOR_SPECIFIC && pos[1] >= 4 &&
651 vendor_type == WPA_GET_BE32(&pos[2]))
652 wpabuf_put_data(buf, pos + 2 + 4, pos[1] - 4);
656 if (wpabuf_len(buf) == 0) {
665 struct wpabuf * wpa_scan_get_vendor_ie_multi_beacon(
666 const struct wpa_scan_res *res, u32 vendor_type)
671 if (res->beacon_ie_len == 0)
673 buf = wpabuf_alloc(res->beacon_ie_len);
677 pos = (const u8 *) (res + 1);
679 end = pos + res->beacon_ie_len;
681 while (pos + 1 < end) {
682 if (pos + 2 + pos[1] > end)
684 if (pos[0] == WLAN_EID_VENDOR_SPECIFIC && pos[1] >= 4 &&
685 vendor_type == WPA_GET_BE32(&pos[2]))
686 wpabuf_put_data(buf, pos + 2 + 4, pos[1] - 4);
690 if (wpabuf_len(buf) == 0) {
699 /* Compare function for sorting scan results. Return >0 if @b is considered
701 static int wpa_scan_result_compar(const void *a, const void *b)
703 struct wpa_scan_res **_wa = (void *) a;
704 struct wpa_scan_res **_wb = (void *) b;
705 struct wpa_scan_res *wa = *_wa;
706 struct wpa_scan_res *wb = *_wb;
707 int wpa_a, wpa_b, maxrate_a, maxrate_b;
709 /* WPA/WPA2 support preferred */
710 wpa_a = wpa_scan_get_vendor_ie(wa, WPA_IE_VENDOR_TYPE) != NULL ||
711 wpa_scan_get_ie(wa, WLAN_EID_RSN) != NULL;
712 wpa_b = wpa_scan_get_vendor_ie(wb, WPA_IE_VENDOR_TYPE) != NULL ||
713 wpa_scan_get_ie(wb, WLAN_EID_RSN) != NULL;
720 /* privacy support preferred */
721 if ((wa->caps & IEEE80211_CAP_PRIVACY) == 0 &&
722 (wb->caps & IEEE80211_CAP_PRIVACY))
724 if ((wa->caps & IEEE80211_CAP_PRIVACY) &&
725 (wb->caps & IEEE80211_CAP_PRIVACY) == 0)
728 /* best/max rate preferred if signal level close enough XXX */
729 if ((wa->level && wb->level && abs(wb->level - wa->level) < 5) ||
730 (wa->qual && wb->qual && abs(wb->qual - wa->qual) < 10)) {
731 maxrate_a = wpa_scan_get_max_rate(wa);
732 maxrate_b = wpa_scan_get_max_rate(wb);
733 if (maxrate_a != maxrate_b)
734 return maxrate_b - maxrate_a;
737 /* use freq for channel preference */
739 /* all things being equal, use signal level; if signal levels are
740 * identical, use quality values since some drivers may only report
741 * that value and leave the signal level zero */
742 if (wb->level == wa->level)
743 return wb->qual - wa->qual;
744 return wb->level - wa->level;
749 /* Compare function for sorting scan results when searching a WPS AP for
750 * provisioning. Return >0 if @b is considered better. */
751 static int wpa_scan_result_wps_compar(const void *a, const void *b)
753 struct wpa_scan_res **_wa = (void *) a;
754 struct wpa_scan_res **_wb = (void *) b;
755 struct wpa_scan_res *wa = *_wa;
756 struct wpa_scan_res *wb = *_wb;
757 int uses_wps_a, uses_wps_b;
758 struct wpabuf *wps_a, *wps_b;
761 /* Optimization - check WPS IE existence before allocated memory and
762 * doing full reassembly. */
763 uses_wps_a = wpa_scan_get_vendor_ie(wa, WPS_IE_VENDOR_TYPE) != NULL;
764 uses_wps_b = wpa_scan_get_vendor_ie(wb, WPS_IE_VENDOR_TYPE) != NULL;
765 if (uses_wps_a && !uses_wps_b)
767 if (!uses_wps_a && uses_wps_b)
770 if (uses_wps_a && uses_wps_b) {
771 wps_a = wpa_scan_get_vendor_ie_multi(wa, WPS_IE_VENDOR_TYPE);
772 wps_b = wpa_scan_get_vendor_ie_multi(wb, WPS_IE_VENDOR_TYPE);
773 res = wps_ap_priority_compar(wps_a, wps_b);
781 * Do not use current AP security policy as a sorting criteria during
782 * WPS provisioning step since the AP may get reconfigured at the
783 * completion of provisioning.
786 /* all things being equal, use signal level; if signal levels are
787 * identical, use quality values since some drivers may only report
788 * that value and leave the signal level zero */
789 if (wb->level == wa->level)
790 return wb->qual - wa->qual;
791 return wb->level - wa->level;
793 #endif /* CONFIG_WPS */
797 * wpa_supplicant_get_scan_results - Get scan results
798 * @wpa_s: Pointer to wpa_supplicant data
799 * @info: Information about what was scanned or %NULL if not available
800 * @new_scan: Whether a new scan was performed
801 * Returns: Scan results, %NULL on failure
803 * This function request the current scan results from the driver and updates
804 * the local BSS list wpa_s->bss. The caller is responsible for freeing the
805 * results with wpa_scan_results_free().
807 struct wpa_scan_results *
808 wpa_supplicant_get_scan_results(struct wpa_supplicant *wpa_s,
809 struct scan_info *info, int new_scan)
811 struct wpa_scan_results *scan_res;
813 int (*compar)(const void *, const void *) = wpa_scan_result_compar;
815 if (wpa_s->drv_flags & WPA_DRIVER_FLAGS_USER_SPACE_MLME)
816 scan_res = ieee80211_sta_get_scan_results(wpa_s);
818 scan_res = wpa_drv_get_scan_results2(wpa_s);
819 if (scan_res == NULL) {
820 wpa_dbg(wpa_s, MSG_DEBUG, "Failed to get scan results");
825 if (wpas_wps_in_progress(wpa_s)) {
826 wpa_dbg(wpa_s, MSG_DEBUG, "WPS: Order scan results with WPS "
827 "provisioning rules");
828 compar = wpa_scan_result_wps_compar;
830 #endif /* CONFIG_WPS */
832 qsort(scan_res->res, scan_res->num, sizeof(struct wpa_scan_res *),
835 wpa_bss_update_start(wpa_s);
836 for (i = 0; i < scan_res->num; i++)
837 wpa_bss_update_scan_res(wpa_s, scan_res->res[i]);
838 wpa_bss_update_end(wpa_s, info, new_scan);
844 int wpa_supplicant_update_scan_results(struct wpa_supplicant *wpa_s)
846 struct wpa_scan_results *scan_res;
847 scan_res = wpa_supplicant_get_scan_results(wpa_s, NULL, 0);
848 if (scan_res == NULL)
850 wpa_scan_results_free(scan_res);
856 void wpa_scan_results_free(struct wpa_scan_results *res)
863 for (i = 0; i < res->num; i++)
864 os_free(res->res[i]);