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"
30 static void wpa_supplicant_gen_assoc_event(struct wpa_supplicant
*wpa_s
)
32 struct wpa_ssid
*ssid
;
33 union wpa_event_data data
;
35 ssid
= wpa_supplicant_get_ssid(wpa_s
);
39 if (wpa_s
->current_ssid
== NULL
) {
40 wpa_s
->current_ssid
= ssid
;
41 if (wpa_s
->current_ssid
!= NULL
)
42 wpas_notify_network_changed(wpa_s
);
44 wpa_supplicant_initiate_eapol(wpa_s
);
45 wpa_printf(MSG_DEBUG
, "Already associated with a configured network - "
46 "generating associated event");
47 os_memset(&data
, 0, sizeof(data
));
48 wpa_supplicant_event(wpa_s
, EVENT_ASSOC
, &data
);
53 static int wpas_wps_in_use(struct wpa_config
*conf
,
54 enum wps_request_type
*req_type
)
56 struct wpa_ssid
*ssid
;
59 for (ssid
= conf
->ssid
; ssid
; ssid
= ssid
->next
) {
60 if (!(ssid
->key_mgmt
& WPA_KEY_MGMT_WPS
))
64 *req_type
= wpas_wps_get_req_type(ssid
);
65 if (!ssid
->eap
.phase1
)
68 if (os_strstr(ssid
->eap
.phase1
, "pbc=1"))
74 #endif /* CONFIG_WPS */
77 int wpa_supplicant_enabled_networks(struct wpa_config
*conf
)
79 struct wpa_ssid
*ssid
= conf
->ssid
;
89 static void wpa_supplicant_assoc_try(struct wpa_supplicant
*wpa_s
,
90 struct wpa_ssid
*ssid
)
98 /* ap_scan=2 mode - try to associate with each SSID. */
100 wpa_printf(MSG_DEBUG
, "wpa_supplicant_scan: Reached "
101 "end of scan list - go back to beginning");
102 wpa_s
->prev_scan_ssid
= WILDCARD_SSID_SCAN
;
103 wpa_supplicant_req_scan(wpa_s
, 0, 0);
107 /* Continue from the next SSID on the next attempt. */
108 wpa_s
->prev_scan_ssid
= ssid
;
110 /* Start from the beginning of the SSID list. */
111 wpa_s
->prev_scan_ssid
= WILDCARD_SSID_SCAN
;
113 wpa_supplicant_associate(wpa_s
, NULL
, ssid
);
117 static int int_array_len(const int *a
)
120 for (i
= 0; a
&& a
[i
]; i
++)
126 static void int_array_concat(int **res
, const int *a
)
131 reslen
= int_array_len(*res
);
132 alen
= int_array_len(a
);
134 n
= os_realloc(*res
, (reslen
+ alen
+ 1) * sizeof(int));
140 for (i
= 0; i
<= alen
; i
++)
141 n
[reslen
+ i
] = a
[i
];
146 static int freq_cmp(const void *a
, const void *b
)
159 static void int_array_sort_unique(int *a
)
167 alen
= int_array_len(a
);
168 qsort(a
, alen
, sizeof(int), freq_cmp
);
172 while (a
[i
] && a
[j
]) {
185 int wpa_supplicant_trigger_scan(struct wpa_supplicant
*wpa_s
,
186 struct wpa_driver_scan_params
*params
)
190 wpa_supplicant_notify_scanning(wpa_s
, 1);
192 if (wpa_s
->drv_flags
& WPA_DRIVER_FLAGS_USER_SPACE_MLME
)
193 ret
= ieee80211_sta_req_scan(wpa_s
, params
);
195 ret
= wpa_drv_scan(wpa_s
, params
);
198 wpa_supplicant_notify_scanning(wpa_s
, 0);
199 wpas_notify_scan_done(wpa_s
, 0);
207 static struct wpa_driver_scan_filter
*
208 wpa_supplicant_build_filter_ssids(struct wpa_config
*conf
, size_t *num_ssids
)
210 struct wpa_driver_scan_filter
*ssids
;
211 struct wpa_ssid
*ssid
;
215 if (!conf
->filter_ssids
)
218 for (count
= 0, ssid
= conf
->ssid
; ssid
; ssid
= ssid
->next
) {
219 if (ssid
->ssid
&& ssid
->ssid_len
)
224 ssids
= os_zalloc(count
* sizeof(struct wpa_driver_scan_filter
));
228 for (ssid
= conf
->ssid
; ssid
; ssid
= ssid
->next
) {
229 if (!ssid
->ssid
|| !ssid
->ssid_len
)
231 os_memcpy(ssids
[*num_ssids
].ssid
, ssid
->ssid
, ssid
->ssid_len
);
232 ssids
[*num_ssids
].ssid_len
= ssid
->ssid_len
;
240 static void wpa_supplicant_scan(void *eloop_ctx
, void *timeout_ctx
)
242 struct wpa_supplicant
*wpa_s
= eloop_ctx
;
243 struct wpa_ssid
*ssid
;
244 int scan_req
= 0, ret
;
245 struct wpabuf
*wps_ie
= NULL
;
248 enum wps_request_type req_type
= WPS_REQ_ENROLLEE_INFO
;
249 #endif /* CONFIG_WPS */
250 struct wpa_driver_scan_params params
;
252 enum wpa_states prev_state
;
254 if (wpa_s
->disconnected
&& !wpa_s
->scan_req
) {
255 wpa_supplicant_set_state(wpa_s
, WPA_DISCONNECTED
);
259 if (!wpa_supplicant_enabled_networks(wpa_s
->conf
) &&
261 wpa_printf(MSG_DEBUG
, "No enabled networks - do not scan");
262 wpa_supplicant_set_state(wpa_s
, WPA_INACTIVE
);
266 if (wpa_s
->conf
->ap_scan
!= 0 &&
267 (wpa_s
->drv_flags
& WPA_DRIVER_FLAGS_WIRED
)) {
268 wpa_printf(MSG_DEBUG
, "Using wired authentication - "
269 "overriding ap_scan configuration");
270 wpa_s
->conf
->ap_scan
= 0;
271 wpas_notify_ap_scan_changed(wpa_s
);
274 if (wpa_s
->conf
->ap_scan
== 0) {
275 wpa_supplicant_gen_assoc_event(wpa_s
);
279 if ((wpa_s
->drv_flags
& WPA_DRIVER_FLAGS_USER_SPACE_MLME
) ||
280 wpa_s
->conf
->ap_scan
== 2)
283 max_ssids
= wpa_s
->max_scan_ssids
;
284 if (max_ssids
> WPAS_MAX_SCAN_SSIDS
)
285 max_ssids
= WPAS_MAX_SCAN_SSIDS
;
289 wps
= wpas_wps_in_use(wpa_s
->conf
, &req_type
);
290 #endif /* CONFIG_WPS */
292 scan_req
= wpa_s
->scan_req
;
295 os_memset(¶ms
, 0, sizeof(params
));
297 prev_state
= wpa_s
->wpa_state
;
298 if (wpa_s
->wpa_state
== WPA_DISCONNECTED
||
299 wpa_s
->wpa_state
== WPA_INACTIVE
)
300 wpa_supplicant_set_state(wpa_s
, WPA_SCANNING
);
302 /* Find the starting point from which to continue scanning */
303 ssid
= wpa_s
->conf
->ssid
;
304 if (wpa_s
->prev_scan_ssid
!= WILDCARD_SSID_SCAN
) {
306 if (ssid
== wpa_s
->prev_scan_ssid
) {
314 if (scan_req
!= 2 && (wpa_s
->conf
->ap_scan
== 2 ||
315 wpa_s
->connect_without_scan
)) {
316 wpa_s
->connect_without_scan
= 0;
317 wpa_supplicant_assoc_try(wpa_s
, ssid
);
319 } else if (wpa_s
->conf
->ap_scan
== 2) {
321 * User-initiated scan request in ap_scan == 2; scan with
326 struct wpa_ssid
*start
= ssid
, *tssid
;
328 if (ssid
== NULL
&& max_ssids
> 1)
329 ssid
= wpa_s
->conf
->ssid
;
331 if (!ssid
->disabled
&& ssid
->scan_ssid
) {
332 wpa_hexdump_ascii(MSG_DEBUG
, "Scan SSID",
333 ssid
->ssid
, ssid
->ssid_len
);
334 params
.ssids
[params
.num_ssids
].ssid
=
336 params
.ssids
[params
.num_ssids
].ssid_len
=
339 if (params
.num_ssids
+ 1 >= max_ssids
)
345 if (ssid
== NULL
&& max_ssids
> 1 &&
346 start
!= wpa_s
->conf
->ssid
)
347 ssid
= wpa_s
->conf
->ssid
;
350 for (tssid
= wpa_s
->conf
->ssid
; tssid
; tssid
= tssid
->next
) {
353 if ((params
.freqs
|| !freqs_set
) && tssid
->scan_freq
) {
354 int_array_concat(¶ms
.freqs
,
357 os_free(params
.freqs
);
362 int_array_sort_unique(params
.freqs
);
366 wpa_s
->prev_scan_ssid
= ssid
;
368 wpa_printf(MSG_DEBUG
, "Include wildcard SSID in the "
372 wpa_printf(MSG_DEBUG
, "Starting AP scan for specific SSID(s)");
374 wpa_s
->prev_scan_ssid
= WILDCARD_SSID_SCAN
;
376 wpa_printf(MSG_DEBUG
, "Starting AP scan for wildcard SSID");
380 if (params
.freqs
== NULL
&& wpa_s
->after_wps
&& wpa_s
->wps_freq
) {
382 * Optimize post-provisioning scan based on channel used
383 * during provisioning.
385 wpa_printf(MSG_DEBUG
, "WPS: Scan only frequency %u MHz that "
386 "was used during provisioning", wpa_s
->wps_freq
);
387 params
.freqs
= os_zalloc(2 * sizeof(int));
389 params
.freqs
[0] = wpa_s
->wps_freq
;
394 wps_ie
= wps_build_probe_req_ie(wps
== 2, &wpa_s
->wps
->dev
,
395 wpa_s
->wps
->uuid
, req_type
);
397 params
.extra_ies
= wpabuf_head(wps_ie
);
398 params
.extra_ies_len
= wpabuf_len(wps_ie
);
401 #endif /* CONFIG_WPS */
403 params
.filter_ssids
= wpa_supplicant_build_filter_ssids(
404 wpa_s
->conf
, ¶ms
.num_filter_ssids
);
406 ret
= wpa_supplicant_trigger_scan(wpa_s
, ¶ms
);
409 os_free(params
.freqs
);
410 os_free(params
.filter_ssids
);
413 wpa_printf(MSG_WARNING
, "Failed to initiate AP scan.");
414 if (prev_state
!= wpa_s
->wpa_state
)
415 wpa_supplicant_set_state(wpa_s
, prev_state
);
416 wpa_supplicant_req_scan(wpa_s
, 1, 0);
422 * wpa_supplicant_req_scan - Schedule a scan for neighboring access points
423 * @wpa_s: Pointer to wpa_supplicant data
424 * @sec: Number of seconds after which to scan
425 * @usec: Number of microseconds after which to scan
427 * This function is used to schedule a scan for neighboring access points after
428 * the specified time.
430 void wpa_supplicant_req_scan(struct wpa_supplicant
*wpa_s
, int sec
, int usec
)
432 /* If there's at least one network that should be specifically scanned
433 * then don't cancel the scan and reschedule. Some drivers do
434 * background scanning which generates frequent scan results, and that
435 * causes the specific SSID scan to get continually pushed back and
436 * never happen, which causes hidden APs to never get probe-scanned.
438 if (eloop_is_timeout_registered(wpa_supplicant_scan
, wpa_s
, NULL
) &&
439 wpa_s
->conf
->ap_scan
== 1) {
440 struct wpa_ssid
*ssid
= wpa_s
->conf
->ssid
;
443 if (!ssid
->disabled
&& ssid
->scan_ssid
)
448 wpa_msg(wpa_s
, MSG_DEBUG
, "Not rescheduling scan to "
449 "ensure that specific SSID scans occur");
454 wpa_msg(wpa_s
, MSG_DEBUG
, "Setting scan request: %d sec %d usec",
456 eloop_cancel_timeout(wpa_supplicant_scan
, wpa_s
, NULL
);
457 eloop_register_timeout(sec
, usec
, wpa_supplicant_scan
, wpa_s
, NULL
);
462 * wpa_supplicant_cancel_scan - Cancel a scheduled scan request
463 * @wpa_s: Pointer to wpa_supplicant data
465 * This function is used to cancel a scan request scheduled with
466 * wpa_supplicant_req_scan().
468 void wpa_supplicant_cancel_scan(struct wpa_supplicant
*wpa_s
)
470 wpa_msg(wpa_s
, MSG_DEBUG
, "Cancelling scan request");
471 eloop_cancel_timeout(wpa_supplicant_scan
, wpa_s
, NULL
);
475 void wpa_supplicant_notify_scanning(struct wpa_supplicant
*wpa_s
,
478 if (wpa_s
->scanning
!= scanning
) {
479 wpa_s
->scanning
= scanning
;
480 wpas_notify_scanning(wpa_s
);
485 static int wpa_scan_get_max_rate(const struct wpa_scan_res
*res
)
491 ie
= wpa_scan_get_ie(res
, WLAN_EID_SUPP_RATES
);
492 for (i
= 0; ie
&& i
< ie
[1]; i
++) {
493 if ((ie
[i
+ 2] & 0x7f) > rate
)
494 rate
= ie
[i
+ 2] & 0x7f;
497 ie
= wpa_scan_get_ie(res
, WLAN_EID_EXT_SUPP_RATES
);
498 for (i
= 0; ie
&& i
< ie
[1]; i
++) {
499 if ((ie
[i
+ 2] & 0x7f) > rate
)
500 rate
= ie
[i
+ 2] & 0x7f;
507 const u8
* wpa_scan_get_ie(const struct wpa_scan_res
*res
, u8 ie
)
511 pos
= (const u8
*) (res
+ 1);
512 end
= pos
+ res
->ie_len
;
514 while (pos
+ 1 < end
) {
515 if (pos
+ 2 + pos
[1] > end
)
526 const u8
* wpa_scan_get_vendor_ie(const struct wpa_scan_res
*res
,
531 pos
= (const u8
*) (res
+ 1);
532 end
= pos
+ res
->ie_len
;
534 while (pos
+ 1 < end
) {
535 if (pos
+ 2 + pos
[1] > end
)
537 if (pos
[0] == WLAN_EID_VENDOR_SPECIFIC
&& pos
[1] >= 4 &&
538 vendor_type
== WPA_GET_BE32(&pos
[2]))
547 struct wpabuf
* wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res
*res
,
553 buf
= wpabuf_alloc(res
->ie_len
);
557 pos
= (const u8
*) (res
+ 1);
558 end
= pos
+ res
->ie_len
;
560 while (pos
+ 1 < end
) {
561 if (pos
+ 2 + pos
[1] > end
)
563 if (pos
[0] == WLAN_EID_VENDOR_SPECIFIC
&& pos
[1] >= 4 &&
564 vendor_type
== WPA_GET_BE32(&pos
[2]))
565 wpabuf_put_data(buf
, pos
+ 2 + 4, pos
[1] - 4);
569 if (wpabuf_len(buf
) == 0) {
578 /* Compare function for sorting scan results. Return >0 if @b is considered
580 static int wpa_scan_result_compar(const void *a
, const void *b
)
582 struct wpa_scan_res
**_wa
= (void *) a
;
583 struct wpa_scan_res
**_wb
= (void *) b
;
584 struct wpa_scan_res
*wa
= *_wa
;
585 struct wpa_scan_res
*wb
= *_wb
;
586 int wpa_a
, wpa_b
, maxrate_a
, maxrate_b
;
588 /* WPA/WPA2 support preferred */
589 wpa_a
= wpa_scan_get_vendor_ie(wa
, WPA_IE_VENDOR_TYPE
) != NULL
||
590 wpa_scan_get_ie(wa
, WLAN_EID_RSN
) != NULL
;
591 wpa_b
= wpa_scan_get_vendor_ie(wb
, WPA_IE_VENDOR_TYPE
) != NULL
||
592 wpa_scan_get_ie(wb
, WLAN_EID_RSN
) != NULL
;
599 /* privacy support preferred */
600 if ((wa
->caps
& IEEE80211_CAP_PRIVACY
) == 0 &&
601 (wb
->caps
& IEEE80211_CAP_PRIVACY
))
603 if ((wa
->caps
& IEEE80211_CAP_PRIVACY
) &&
604 (wb
->caps
& IEEE80211_CAP_PRIVACY
) == 0)
607 /* best/max rate preferred if signal level close enough XXX */
608 if ((wa
->level
&& wb
->level
&& abs(wb
->level
- wa
->level
) < 5) ||
609 (wa
->qual
&& wb
->qual
&& abs(wb
->qual
- wa
->qual
) < 10)) {
610 maxrate_a
= wpa_scan_get_max_rate(wa
);
611 maxrate_b
= wpa_scan_get_max_rate(wb
);
612 if (maxrate_a
!= maxrate_b
)
613 return maxrate_b
- maxrate_a
;
616 /* use freq for channel preference */
618 /* all things being equal, use signal level; if signal levels are
619 * identical, use quality values since some drivers may only report
620 * that value and leave the signal level zero */
621 if (wb
->level
== wa
->level
)
622 return wb
->qual
- wa
->qual
;
623 return wb
->level
- wa
->level
;
628 * wpa_supplicant_get_scan_results - Get scan results
629 * @wpa_s: Pointer to wpa_supplicant data
630 * @info: Information about what was scanned or %NULL if not available
631 * @new_scan: Whether a new scan was performed
632 * Returns: Scan results, %NULL on failure
634 * This function request the current scan results from the driver and updates
635 * the local BSS list wpa_s->bss. The caller is responsible for freeing the
636 * results with wpa_scan_results_free().
638 struct wpa_scan_results
*
639 wpa_supplicant_get_scan_results(struct wpa_supplicant
*wpa_s
,
640 struct scan_info
*info
, int new_scan
)
642 struct wpa_scan_results
*scan_res
;
645 if (wpa_s
->drv_flags
& WPA_DRIVER_FLAGS_USER_SPACE_MLME
)
646 scan_res
= ieee80211_sta_get_scan_results(wpa_s
);
648 scan_res
= wpa_drv_get_scan_results2(wpa_s
);
649 if (scan_res
== NULL
) {
650 wpa_printf(MSG_DEBUG
, "Failed to get scan results");
654 qsort(scan_res
->res
, scan_res
->num
, sizeof(struct wpa_scan_res
*),
655 wpa_scan_result_compar
);
657 wpa_bss_update_start(wpa_s
);
658 for (i
= 0; i
< scan_res
->num
; i
++)
659 wpa_bss_update_scan_res(wpa_s
, scan_res
->res
[i
]);
660 wpa_bss_update_end(wpa_s
, info
, new_scan
);
666 int wpa_supplicant_update_scan_results(struct wpa_supplicant
*wpa_s
)
668 struct wpa_scan_results
*scan_res
;
669 scan_res
= wpa_supplicant_get_scan_results(wpa_s
, NULL
, 0);
670 if (scan_res
== NULL
)
672 wpa_scan_results_free(scan_res
);
678 void wpa_scan_results_free(struct wpa_scan_results
*res
)
685 for (i
= 0; i
< res
->num
; i
++)
686 os_free(res
->res
[i
]);