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_supplicant *wpa_s,
56 enum wps_request_type *req_type)
58 struct wpa_ssid *ssid;
61 for (ssid = wpa_s->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"))
75 wpa_s->wps->dev.p2p = 1;
78 *req_type = WPS_REQ_ENROLLEE_INFO;
80 #endif /* CONFIG_P2P */
84 #endif /* CONFIG_WPS */
87 int wpa_supplicant_enabled_networks(struct wpa_config *conf)
89 struct wpa_ssid *ssid = conf->ssid;
100 static void wpa_supplicant_assoc_try(struct wpa_supplicant *wpa_s,
101 struct wpa_ssid *ssid)
109 /* ap_scan=2 mode - try to associate with each SSID. */
111 wpa_dbg(wpa_s, MSG_DEBUG, "wpa_supplicant_assoc_try: Reached "
112 "end of scan list - go back to beginning");
113 wpa_s->prev_scan_ssid = WILDCARD_SSID_SCAN;
114 wpa_supplicant_req_scan(wpa_s, 0, 0);
118 /* Continue from the next SSID on the next attempt. */
119 wpa_s->prev_scan_ssid = ssid;
121 /* Start from the beginning of the SSID list. */
122 wpa_s->prev_scan_ssid = WILDCARD_SSID_SCAN;
124 wpa_supplicant_associate(wpa_s, NULL, ssid);
128 static int int_array_len(const int *a)
131 for (i = 0; a && a[i]; i++)
137 static void int_array_concat(int **res, const int *a)
142 reslen = int_array_len(*res);
143 alen = int_array_len(a);
145 n = os_realloc(*res, (reslen + alen + 1) * sizeof(int));
151 for (i = 0; i <= alen; i++)
152 n[reslen + i] = a[i];
157 static int freq_cmp(const void *a, const void *b)
170 static void int_array_sort_unique(int *a)
178 alen = int_array_len(a);
179 qsort(a, alen, sizeof(int), freq_cmp);
183 while (a[i] && a[j]) {
196 int wpa_supplicant_trigger_scan(struct wpa_supplicant *wpa_s,
197 struct wpa_driver_scan_params *params)
201 wpa_supplicant_notify_scanning(wpa_s, 1);
203 if (wpa_s->drv_flags & WPA_DRIVER_FLAGS_USER_SPACE_MLME)
204 ret = ieee80211_sta_req_scan(wpa_s, params);
206 ret = wpa_drv_scan(wpa_s, params);
209 wpa_supplicant_notify_scanning(wpa_s, 0);
210 wpas_notify_scan_done(wpa_s, 0);
218 static struct wpa_driver_scan_filter *
219 wpa_supplicant_build_filter_ssids(struct wpa_config *conf, size_t *num_ssids)
221 struct wpa_driver_scan_filter *ssids;
222 struct wpa_ssid *ssid;
226 if (!conf->filter_ssids)
229 for (count = 0, ssid = conf->ssid; ssid; ssid = ssid->next) {
230 if (ssid->ssid && ssid->ssid_len)
235 ssids = os_zalloc(count * sizeof(struct wpa_driver_scan_filter));
239 for (ssid = conf->ssid; ssid; ssid = ssid->next) {
240 if (!ssid->ssid || !ssid->ssid_len)
242 os_memcpy(ssids[*num_ssids].ssid, ssid->ssid, ssid->ssid_len);
243 ssids[*num_ssids].ssid_len = ssid->ssid_len;
251 static void wpa_supplicant_optimize_freqs(
252 struct wpa_supplicant *wpa_s, struct wpa_driver_scan_params *params)
255 if (params->freqs == NULL && wpa_s->p2p_in_provisioning &&
257 /* Optimize provisioning state scan based on GO information */
258 if (wpa_s->p2p_in_provisioning < 5 &&
259 wpa_s->go_params->freq > 0) {
260 wpa_dbg(wpa_s, MSG_DEBUG, "P2P: Scan only GO "
261 "preferred frequency %d MHz",
262 wpa_s->go_params->freq);
263 params->freqs = os_zalloc(2 * sizeof(int));
265 params->freqs[0] = wpa_s->go_params->freq;
266 } else if (wpa_s->p2p_in_provisioning < 8 &&
267 wpa_s->go_params->freq_list[0]) {
268 wpa_dbg(wpa_s, MSG_DEBUG, "P2P: Scan only common "
270 int_array_concat(¶ms->freqs,
271 wpa_s->go_params->freq_list);
273 int_array_sort_unique(params->freqs);
275 wpa_s->p2p_in_provisioning++;
277 #endif /* CONFIG_P2P */
280 if (params->freqs == NULL && wpa_s->after_wps && wpa_s->wps_freq) {
282 * Optimize post-provisioning scan based on channel used
283 * during provisioning.
285 wpa_dbg(wpa_s, MSG_DEBUG, "WPS: Scan only frequency %u MHz "
286 "that was used during provisioning", wpa_s->wps_freq);
287 params->freqs = os_zalloc(2 * sizeof(int));
289 params->freqs[0] = wpa_s->wps_freq;
293 #endif /* CONFIG_WPS */
297 static struct wpabuf *
298 wpa_supplicant_extra_ies(struct wpa_supplicant *wpa_s,
299 struct wpa_driver_scan_params *params)
301 struct wpabuf *wps_ie = NULL;
304 enum wps_request_type req_type = WPS_REQ_ENROLLEE_INFO;
306 wps = wpas_wps_in_use(wpa_s, &req_type);
309 wps_ie = wps_build_probe_req_ie(wps == 2, &wpa_s->wps->dev,
310 wpa_s->wps->uuid, req_type,
313 params->extra_ies = wpabuf_head(wps_ie);
314 params->extra_ies_len = wpabuf_len(wps_ie);
320 size_t ielen = p2p_scan_ie_buf_len(wpa_s->global->p2p);
321 if (wpabuf_resize(&wps_ie, ielen) == 0) {
322 wpas_p2p_scan_ie(wpa_s, wps_ie);
323 params->extra_ies = wpabuf_head(wps_ie);
324 params->extra_ies_len = wpabuf_len(wps_ie);
327 #endif /* CONFIG_P2P */
329 #endif /* CONFIG_WPS */
335 static void wpa_supplicant_scan(void *eloop_ctx, void *timeout_ctx)
337 struct wpa_supplicant *wpa_s = eloop_ctx;
338 struct wpa_ssid *ssid;
339 int scan_req = 0, ret;
340 struct wpabuf *wps_ie;
341 struct wpa_driver_scan_params params;
343 enum wpa_states prev_state;
345 if (wpa_s->wpa_state == WPA_INTERFACE_DISABLED) {
346 wpa_dbg(wpa_s, MSG_DEBUG, "Skip scan - interface disabled");
350 if (wpa_s->disconnected && !wpa_s->scan_req) {
351 wpa_supplicant_set_state(wpa_s, WPA_DISCONNECTED);
355 if (!wpa_supplicant_enabled_networks(wpa_s->conf) &&
357 wpa_dbg(wpa_s, MSG_DEBUG, "No enabled networks - do not scan");
358 wpa_supplicant_set_state(wpa_s, WPA_INACTIVE);
362 if (wpa_s->conf->ap_scan != 0 &&
363 (wpa_s->drv_flags & WPA_DRIVER_FLAGS_WIRED)) {
364 wpa_dbg(wpa_s, MSG_DEBUG, "Using wired authentication - "
365 "overriding ap_scan configuration");
366 wpa_s->conf->ap_scan = 0;
367 wpas_notify_ap_scan_changed(wpa_s);
370 if (wpa_s->conf->ap_scan == 0) {
371 wpa_supplicant_gen_assoc_event(wpa_s);
376 if (wpas_p2p_in_progress(wpa_s)) {
377 if (wpa_s->wpa_state == WPA_SCANNING) {
378 wpa_dbg(wpa_s, MSG_DEBUG, "Delay station mode scan "
379 "while P2P operation is in progress");
380 wpa_supplicant_req_scan(wpa_s, 5, 0);
382 wpa_dbg(wpa_s, MSG_DEBUG, "Do not request scan while "
383 "P2P operation is in progress");
387 #endif /* CONFIG_P2P */
389 if ((wpa_s->drv_flags & WPA_DRIVER_FLAGS_USER_SPACE_MLME) ||
390 wpa_s->conf->ap_scan == 2)
393 max_ssids = wpa_s->max_scan_ssids;
394 if (max_ssids > WPAS_MAX_SCAN_SSIDS)
395 max_ssids = WPAS_MAX_SCAN_SSIDS;
398 scan_req = wpa_s->scan_req;
401 os_memset(¶ms, 0, sizeof(params));
403 prev_state = wpa_s->wpa_state;
404 if (wpa_s->wpa_state == WPA_DISCONNECTED ||
405 wpa_s->wpa_state == WPA_INACTIVE)
406 wpa_supplicant_set_state(wpa_s, WPA_SCANNING);
408 if (scan_req != 2 && wpa_s->connect_without_scan) {
409 for (ssid = wpa_s->conf->ssid; ssid; ssid = ssid->next) {
410 if (ssid == wpa_s->connect_without_scan)
413 wpa_s->connect_without_scan = NULL;
415 wpa_printf(MSG_DEBUG, "Start a pre-selected network "
416 "without scan step");
417 wpa_supplicant_associate(wpa_s, NULL, ssid);
422 /* Find the starting point from which to continue scanning */
423 ssid = wpa_s->conf->ssid;
424 if (wpa_s->prev_scan_ssid != WILDCARD_SSID_SCAN) {
426 if (ssid == wpa_s->prev_scan_ssid) {
434 if (scan_req != 2 && wpa_s->conf->ap_scan == 2) {
435 wpa_s->connect_without_scan = NULL;
436 wpa_supplicant_assoc_try(wpa_s, ssid);
438 } else if (wpa_s->conf->ap_scan == 2) {
440 * User-initiated scan request in ap_scan == 2; scan with
445 struct wpa_ssid *start = ssid, *tssid;
447 if (ssid == NULL && max_ssids > 1)
448 ssid = wpa_s->conf->ssid;
450 if (!ssid->disabled && ssid->scan_ssid) {
451 wpa_hexdump_ascii(MSG_DEBUG, "Scan SSID",
452 ssid->ssid, ssid->ssid_len);
453 params.ssids[params.num_ssids].ssid =
455 params.ssids[params.num_ssids].ssid_len =
458 if (params.num_ssids + 1 >= max_ssids)
464 if (ssid == NULL && max_ssids > 1 &&
465 start != wpa_s->conf->ssid)
466 ssid = wpa_s->conf->ssid;
469 for (tssid = wpa_s->conf->ssid; tssid; tssid = tssid->next) {
472 if ((params.freqs || !freqs_set) && tssid->scan_freq) {
473 int_array_concat(¶ms.freqs,
476 os_free(params.freqs);
481 int_array_sort_unique(params.freqs);
485 wpa_s->prev_scan_ssid = ssid;
487 wpa_dbg(wpa_s, MSG_DEBUG, "Include wildcard SSID in "
491 wpa_dbg(wpa_s, MSG_DEBUG, "Starting AP scan for specific "
494 wpa_s->prev_scan_ssid = WILDCARD_SSID_SCAN;
496 wpa_dbg(wpa_s, MSG_DEBUG, "Starting AP scan for wildcard "
500 wpa_supplicant_optimize_freqs(wpa_s, ¶ms);
501 wps_ie = wpa_supplicant_extra_ies(wpa_s, ¶ms);
503 if (params.freqs == NULL && wpa_s->next_scan_freqs) {
504 wpa_dbg(wpa_s, MSG_DEBUG, "Optimize scan based on previously "
505 "generated frequency list");
506 params.freqs = wpa_s->next_scan_freqs;
508 os_free(wpa_s->next_scan_freqs);
509 wpa_s->next_scan_freqs = NULL;
511 params.filter_ssids = wpa_supplicant_build_filter_ssids(
512 wpa_s->conf, ¶ms.num_filter_ssids);
514 ret = wpa_supplicant_trigger_scan(wpa_s, ¶ms);
517 os_free(params.freqs);
518 os_free(params.filter_ssids);
521 wpa_msg(wpa_s, MSG_WARNING, "Failed to initiate AP scan");
522 if (prev_state != wpa_s->wpa_state)
523 wpa_supplicant_set_state(wpa_s, prev_state);
524 wpa_supplicant_req_scan(wpa_s, 1, 0);
530 * wpa_supplicant_req_scan - Schedule a scan for neighboring access points
531 * @wpa_s: Pointer to wpa_supplicant data
532 * @sec: Number of seconds after which to scan
533 * @usec: Number of microseconds after which to scan
535 * This function is used to schedule a scan for neighboring access points after
536 * the specified time.
538 void wpa_supplicant_req_scan(struct wpa_supplicant *wpa_s, int sec, int usec)
540 /* If there's at least one network that should be specifically scanned
541 * then don't cancel the scan and reschedule. Some drivers do
542 * background scanning which generates frequent scan results, and that
543 * causes the specific SSID scan to get continually pushed back and
544 * never happen, which causes hidden APs to never get probe-scanned.
546 if (eloop_is_timeout_registered(wpa_supplicant_scan, wpa_s, NULL) &&
547 wpa_s->conf->ap_scan == 1) {
548 struct wpa_ssid *ssid = wpa_s->conf->ssid;
551 if (!ssid->disabled && ssid->scan_ssid)
556 wpa_dbg(wpa_s, MSG_DEBUG, "Not rescheduling scan to "
557 "ensure that specific SSID scans occur");
562 wpa_dbg(wpa_s, MSG_DEBUG, "Setting scan request: %d sec %d usec",
564 eloop_cancel_timeout(wpa_supplicant_scan, wpa_s, NULL);
565 eloop_register_timeout(sec, usec, wpa_supplicant_scan, wpa_s, NULL);
570 * wpa_supplicant_cancel_scan - Cancel a scheduled scan request
571 * @wpa_s: Pointer to wpa_supplicant data
573 * This function is used to cancel a scan request scheduled with
574 * wpa_supplicant_req_scan().
576 void wpa_supplicant_cancel_scan(struct wpa_supplicant *wpa_s)
578 wpa_dbg(wpa_s, MSG_DEBUG, "Cancelling scan request");
579 eloop_cancel_timeout(wpa_supplicant_scan, wpa_s, NULL);
583 void wpa_supplicant_notify_scanning(struct wpa_supplicant *wpa_s,
586 if (wpa_s->scanning != scanning) {
587 wpa_s->scanning = scanning;
588 wpas_notify_scanning(wpa_s);
593 static int wpa_scan_get_max_rate(const struct wpa_scan_res *res)
599 ie = wpa_scan_get_ie(res, WLAN_EID_SUPP_RATES);
600 for (i = 0; ie && i < ie[1]; i++) {
601 if ((ie[i + 2] & 0x7f) > rate)
602 rate = ie[i + 2] & 0x7f;
605 ie = wpa_scan_get_ie(res, WLAN_EID_EXT_SUPP_RATES);
606 for (i = 0; ie && i < ie[1]; i++) {
607 if ((ie[i + 2] & 0x7f) > rate)
608 rate = ie[i + 2] & 0x7f;
615 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie)
619 pos = (const u8 *) (res + 1);
620 end = pos + res->ie_len;
622 while (pos + 1 < end) {
623 if (pos + 2 + pos[1] > end)
634 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
639 pos = (const u8 *) (res + 1);
640 end = pos + res->ie_len;
642 while (pos + 1 < end) {
643 if (pos + 2 + pos[1] > end)
645 if (pos[0] == WLAN_EID_VENDOR_SPECIFIC && pos[1] >= 4 &&
646 vendor_type == WPA_GET_BE32(&pos[2]))
655 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
661 buf = wpabuf_alloc(res->ie_len);
665 pos = (const u8 *) (res + 1);
666 end = pos + res->ie_len;
668 while (pos + 1 < end) {
669 if (pos + 2 + pos[1] > end)
671 if (pos[0] == WLAN_EID_VENDOR_SPECIFIC && pos[1] >= 4 &&
672 vendor_type == WPA_GET_BE32(&pos[2]))
673 wpabuf_put_data(buf, pos + 2 + 4, pos[1] - 4);
677 if (wpabuf_len(buf) == 0) {
686 struct wpabuf * wpa_scan_get_vendor_ie_multi_beacon(
687 const struct wpa_scan_res *res, u32 vendor_type)
692 if (res->beacon_ie_len == 0)
694 buf = wpabuf_alloc(res->beacon_ie_len);
698 pos = (const u8 *) (res + 1);
700 end = pos + res->beacon_ie_len;
702 while (pos + 1 < end) {
703 if (pos + 2 + pos[1] > end)
705 if (pos[0] == WLAN_EID_VENDOR_SPECIFIC && pos[1] >= 4 &&
706 vendor_type == WPA_GET_BE32(&pos[2]))
707 wpabuf_put_data(buf, pos + 2 + 4, pos[1] - 4);
711 if (wpabuf_len(buf) == 0) {
720 /* Compare function for sorting scan results. Return >0 if @b is considered
722 static int wpa_scan_result_compar(const void *a, const void *b)
724 struct wpa_scan_res **_wa = (void *) a;
725 struct wpa_scan_res **_wb = (void *) b;
726 struct wpa_scan_res *wa = *_wa;
727 struct wpa_scan_res *wb = *_wb;
728 int wpa_a, wpa_b, maxrate_a, maxrate_b;
730 /* WPA/WPA2 support preferred */
731 wpa_a = wpa_scan_get_vendor_ie(wa, WPA_IE_VENDOR_TYPE) != NULL ||
732 wpa_scan_get_ie(wa, WLAN_EID_RSN) != NULL;
733 wpa_b = wpa_scan_get_vendor_ie(wb, WPA_IE_VENDOR_TYPE) != NULL ||
734 wpa_scan_get_ie(wb, WLAN_EID_RSN) != NULL;
741 /* privacy support preferred */
742 if ((wa->caps & IEEE80211_CAP_PRIVACY) == 0 &&
743 (wb->caps & IEEE80211_CAP_PRIVACY))
745 if ((wa->caps & IEEE80211_CAP_PRIVACY) &&
746 (wb->caps & IEEE80211_CAP_PRIVACY) == 0)
749 /* best/max rate preferred if signal level close enough XXX */
750 if ((wa->level && wb->level && abs(wb->level - wa->level) < 5) ||
751 (wa->qual && wb->qual && abs(wb->qual - wa->qual) < 10)) {
752 maxrate_a = wpa_scan_get_max_rate(wa);
753 maxrate_b = wpa_scan_get_max_rate(wb);
754 if (maxrate_a != maxrate_b)
755 return maxrate_b - maxrate_a;
758 /* use freq for channel preference */
760 /* all things being equal, use signal level; if signal levels are
761 * identical, use quality values since some drivers may only report
762 * that value and leave the signal level zero */
763 if (wb->level == wa->level)
764 return wb->qual - wa->qual;
765 return wb->level - wa->level;
770 /* Compare function for sorting scan results when searching a WPS AP for
771 * provisioning. Return >0 if @b is considered better. */
772 static int wpa_scan_result_wps_compar(const void *a, const void *b)
774 struct wpa_scan_res **_wa = (void *) a;
775 struct wpa_scan_res **_wb = (void *) b;
776 struct wpa_scan_res *wa = *_wa;
777 struct wpa_scan_res *wb = *_wb;
778 int uses_wps_a, uses_wps_b;
779 struct wpabuf *wps_a, *wps_b;
782 /* Optimization - check WPS IE existence before allocated memory and
783 * doing full reassembly. */
784 uses_wps_a = wpa_scan_get_vendor_ie(wa, WPS_IE_VENDOR_TYPE) != NULL;
785 uses_wps_b = wpa_scan_get_vendor_ie(wb, WPS_IE_VENDOR_TYPE) != NULL;
786 if (uses_wps_a && !uses_wps_b)
788 if (!uses_wps_a && uses_wps_b)
791 if (uses_wps_a && uses_wps_b) {
792 wps_a = wpa_scan_get_vendor_ie_multi(wa, WPS_IE_VENDOR_TYPE);
793 wps_b = wpa_scan_get_vendor_ie_multi(wb, WPS_IE_VENDOR_TYPE);
794 res = wps_ap_priority_compar(wps_a, wps_b);
802 * Do not use current AP security policy as a sorting criteria during
803 * WPS provisioning step since the AP may get reconfigured at the
804 * completion of provisioning.
807 /* all things being equal, use signal level; if signal levels are
808 * identical, use quality values since some drivers may only report
809 * that value and leave the signal level zero */
810 if (wb->level == wa->level)
811 return wb->qual - wa->qual;
812 return wb->level - wa->level;
814 #endif /* CONFIG_WPS */
818 * wpa_supplicant_get_scan_results - Get scan results
819 * @wpa_s: Pointer to wpa_supplicant data
820 * @info: Information about what was scanned or %NULL if not available
821 * @new_scan: Whether a new scan was performed
822 * Returns: Scan results, %NULL on failure
824 * This function request the current scan results from the driver and updates
825 * the local BSS list wpa_s->bss. The caller is responsible for freeing the
826 * results with wpa_scan_results_free().
828 struct wpa_scan_results *
829 wpa_supplicant_get_scan_results(struct wpa_supplicant *wpa_s,
830 struct scan_info *info, int new_scan)
832 struct wpa_scan_results *scan_res;
834 int (*compar)(const void *, const void *) = wpa_scan_result_compar;
836 if (wpa_s->drv_flags & WPA_DRIVER_FLAGS_USER_SPACE_MLME)
837 scan_res = ieee80211_sta_get_scan_results(wpa_s);
839 scan_res = wpa_drv_get_scan_results2(wpa_s);
840 if (scan_res == NULL) {
841 wpa_dbg(wpa_s, MSG_DEBUG, "Failed to get scan results");
846 if (wpas_wps_in_progress(wpa_s)) {
847 wpa_dbg(wpa_s, MSG_DEBUG, "WPS: Order scan results with WPS "
848 "provisioning rules");
849 compar = wpa_scan_result_wps_compar;
851 #endif /* CONFIG_WPS */
853 qsort(scan_res->res, scan_res->num, sizeof(struct wpa_scan_res *),
856 wpa_bss_update_start(wpa_s);
857 for (i = 0; i < scan_res->num; i++)
858 wpa_bss_update_scan_res(wpa_s, scan_res->res[i]);
859 wpa_bss_update_end(wpa_s, info, new_scan);
865 int wpa_supplicant_update_scan_results(struct wpa_supplicant *wpa_s)
867 struct wpa_scan_results *scan_res;
868 scan_res = wpa_supplicant_get_scan_results(wpa_s, NULL, 0);
869 if (scan_res == NULL)
871 wpa_scan_results_free(scan_res);
877 void wpa_scan_results_free(struct wpa_scan_results *res)
884 for (i = 0; i < res->num; i++)
885 os_free(res->res[i]);