Remove deprecated scan and set_probe_req_ie driver_ops
[libeap.git] / wpa_supplicant / scan.c
1 /*
2  * WPA Supplicant - Scanning
3  * Copyright (c) 2003-2008, Jouni Malinen <j@w1.fi>
4  *
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.
8  *
9  * Alternatively, this software may be distributed under the terms of BSD
10  * license.
11  *
12  * See README and COPYING for more details.
13  */
14
15 #include "includes.h"
16
17 #include "common.h"
18 #include "eloop.h"
19 #include "config.h"
20 #include "wpa_supplicant_i.h"
21 #include "driver_i.h"
22 #include "mlme.h"
23 #include "wps_supplicant.h"
24 #include "notify.h"
25
26
27 static void wpa_supplicant_gen_assoc_event(struct wpa_supplicant *wpa_s)
28 {
29         struct wpa_ssid *ssid;
30         union wpa_event_data data;
31
32         ssid = wpa_supplicant_get_ssid(wpa_s);
33         if (ssid == NULL)
34                 return;
35
36         if (wpa_s->current_ssid == NULL) {
37                 wpa_s->current_ssid = ssid;
38                 if (wpa_s->current_ssid != NULL)
39                         wpas_notify_network_changed(wpa_s);
40         }
41         wpa_supplicant_initiate_eapol(wpa_s);
42         wpa_printf(MSG_DEBUG, "Already associated with a configured network - "
43                    "generating associated event");
44         os_memset(&data, 0, sizeof(data));
45         wpa_supplicant_event(wpa_s, EVENT_ASSOC, &data);
46 }
47
48
49 #ifdef CONFIG_WPS
50 static int wpas_wps_in_use(struct wpa_config *conf,
51                            enum wps_request_type *req_type)
52 {
53         struct wpa_ssid *ssid;
54         int wps = 0;
55
56         for (ssid = conf->ssid; ssid; ssid = ssid->next) {
57                 if (!(ssid->key_mgmt & WPA_KEY_MGMT_WPS))
58                         continue;
59
60                 wps = 1;
61                 *req_type = wpas_wps_get_req_type(ssid);
62                 if (!ssid->eap.phase1)
63                         continue;
64
65                 if (os_strstr(ssid->eap.phase1, "pbc=1"))
66                         return 2;
67         }
68
69         return wps;
70 }
71 #endif /* CONFIG_WPS */
72
73
74 int wpa_supplicant_enabled_networks(struct wpa_config *conf)
75 {
76         struct wpa_ssid *ssid = conf->ssid;
77         while (ssid) {
78                 if (!ssid->disabled)
79                         return 1;
80                 ssid = ssid->next;
81         }
82         return 0;
83 }
84
85
86 static void wpa_supplicant_assoc_try(struct wpa_supplicant *wpa_s,
87                                      struct wpa_ssid *ssid)
88 {
89         while (ssid) {
90                 if (!ssid->disabled)
91                         break;
92                 ssid = ssid->next;
93         }
94
95         /* ap_scan=2 mode - try to associate with each SSID. */
96         if (ssid == NULL) {
97                 wpa_printf(MSG_DEBUG, "wpa_supplicant_scan: Reached "
98                            "end of scan list - go back to beginning");
99                 wpa_s->prev_scan_ssid = WILDCARD_SSID_SCAN;
100                 wpa_supplicant_req_scan(wpa_s, 0, 0);
101                 return;
102         }
103         if (ssid->next) {
104                 /* Continue from the next SSID on the next attempt. */
105                 wpa_s->prev_scan_ssid = ssid;
106         } else {
107                 /* Start from the beginning of the SSID list. */
108                 wpa_s->prev_scan_ssid = WILDCARD_SSID_SCAN;
109         }
110         wpa_supplicant_associate(wpa_s, NULL, ssid);
111 }
112
113
114 static int int_array_len(const int *a)
115 {
116         int i;
117         for (i = 0; a && a[i]; i++)
118                 ;
119         return i;
120 }
121
122
123 static void int_array_concat(int **res, const int *a)
124 {
125         int reslen, alen, i;
126         int *n;
127
128         reslen = int_array_len(*res);
129         alen = int_array_len(a);
130
131         n = os_realloc(*res, (reslen + alen + 1) * sizeof(int));
132         if (n == NULL) {
133                 os_free(*res);
134                 *res = NULL;
135                 return;
136         }
137         for (i = 0; i <= alen; i++)
138                 n[reslen + i] = a[i];
139         *res = n;
140 }
141
142
143 static int freq_cmp(const void *a, const void *b)
144 {
145         int _a = *(int *) a;
146         int _b = *(int *) b;
147
148         if (_a == 0)
149                 return 1;
150         if (_b == 0)
151                 return -1;
152         return _a - _b;
153 }
154
155
156 static void int_array_sort_unique(int *a)
157 {
158         int alen;
159         int i, j;
160
161         if (a == NULL)
162                 return;
163
164         alen = int_array_len(a);
165         qsort(a, alen, sizeof(int), freq_cmp);
166
167         i = 0;
168         j = 1;
169         while (a[i] && a[j]) {
170                 if (a[i] == a[j]) {
171                         j++;
172                         continue;
173                 }
174                 a[++i] = a[j++];
175         }
176         if (a[i])
177                 i++;
178         a[i] = 0;
179 }
180
181
182 int wpa_supplicant_trigger_scan(struct wpa_supplicant *wpa_s,
183                                 struct wpa_driver_scan_params *params)
184 {
185         int ret;
186
187         wpa_supplicant_notify_scanning(wpa_s, 1);
188
189         if (wpa_s->drv_flags & WPA_DRIVER_FLAGS_USER_SPACE_MLME) {
190                 ieee80211_sta_set_probe_req_ie(wpa_s, params->extra_ies,
191                                                params->extra_ies_len);
192                 ret = ieee80211_sta_req_scan(wpa_s, params->ssids[0].ssid,
193                                              params->ssids[0].ssid_len);
194         } else
195                 ret = wpa_drv_scan(wpa_s, params);
196
197         if (ret) {
198                 wpa_supplicant_notify_scanning(wpa_s, 0);
199                 wpas_notify_scan_done(wpa_s, 0);
200         } else
201                 wpa_s->scan_runs++;
202
203         return ret;
204 }
205
206
207 static void wpa_supplicant_scan(void *eloop_ctx, void *timeout_ctx)
208 {
209         struct wpa_supplicant *wpa_s = eloop_ctx;
210         struct wpa_ssid *ssid;
211         int scan_req = 0, ret;
212         struct wpabuf *wps_ie = NULL;
213         int wps = 0;
214 #ifdef CONFIG_WPS
215         enum wps_request_type req_type = WPS_REQ_ENROLLEE_INFO;
216 #endif /* CONFIG_WPS */
217         struct wpa_driver_scan_params params;
218         size_t max_ssids;
219
220         if (wpa_s->disconnected && !wpa_s->scan_req) {
221                 wpa_supplicant_set_state(wpa_s, WPA_DISCONNECTED);
222                 return;
223         }
224
225         if (!wpa_supplicant_enabled_networks(wpa_s->conf) &&
226             !wpa_s->scan_req) {
227                 wpa_printf(MSG_DEBUG, "No enabled networks - do not scan");
228                 wpa_supplicant_set_state(wpa_s, WPA_INACTIVE);
229                 return;
230         }
231
232         if (wpa_s->conf->ap_scan != 0 &&
233             (wpa_s->drv_flags & WPA_DRIVER_FLAGS_WIRED)) {
234                 wpa_printf(MSG_DEBUG, "Using wired authentication - "
235                            "overriding ap_scan configuration");
236                 wpa_s->conf->ap_scan = 0;
237                 wpas_notify_ap_scan_changed(wpa_s);
238         }
239
240         if (wpa_s->conf->ap_scan == 0) {
241                 wpa_supplicant_gen_assoc_event(wpa_s);
242                 return;
243         }
244
245         if ((wpa_s->drv_flags & WPA_DRIVER_FLAGS_USER_SPACE_MLME) ||
246             wpa_s->conf->ap_scan == 2)
247                 max_ssids = 1;
248         else {
249                 max_ssids = wpa_s->max_scan_ssids;
250                 if (max_ssids > WPAS_MAX_SCAN_SSIDS)
251                         max_ssids = WPAS_MAX_SCAN_SSIDS;
252         }
253
254 #ifdef CONFIG_WPS
255         wps = wpas_wps_in_use(wpa_s->conf, &req_type);
256 #endif /* CONFIG_WPS */
257
258         if (wpa_s->scan_res_tried == 0 && wpa_s->conf->ap_scan == 1 &&
259             !(wpa_s->drv_flags & WPA_DRIVER_FLAGS_USER_SPACE_MLME) &&
260             wps != 2) {
261                 wpa_s->scan_res_tried++;
262                 wpa_printf(MSG_DEBUG, "Trying to get current scan results "
263                            "first without requesting a new scan to speed up "
264                            "initial association");
265                 wpa_supplicant_event(wpa_s, EVENT_SCAN_RESULTS, NULL);
266                 return;
267         }
268
269         scan_req = wpa_s->scan_req;
270         wpa_s->scan_req = 0;
271
272         os_memset(&params, 0, sizeof(params));
273
274         if (wpa_s->wpa_state == WPA_DISCONNECTED ||
275             wpa_s->wpa_state == WPA_INACTIVE)
276                 wpa_supplicant_set_state(wpa_s, WPA_SCANNING);
277
278         /* Find the starting point from which to continue scanning */
279         ssid = wpa_s->conf->ssid;
280         if (wpa_s->prev_scan_ssid != WILDCARD_SSID_SCAN) {
281                 while (ssid) {
282                         if (ssid == wpa_s->prev_scan_ssid) {
283                                 ssid = ssid->next;
284                                 break;
285                         }
286                         ssid = ssid->next;
287                 }
288         }
289
290         if (scan_req != 2 && wpa_s->conf->ap_scan == 2) {
291                 wpa_supplicant_assoc_try(wpa_s, ssid);
292                 return;
293         } else if (wpa_s->conf->ap_scan == 2) {
294                 /*
295                  * User-initiated scan request in ap_scan == 2; scan with
296                  * wildcard SSID.
297                  */
298                 ssid = NULL;
299         } else {
300                 struct wpa_ssid *start = ssid, *tssid;
301                 int freqs_set = 0;
302                 if (ssid == NULL && max_ssids > 1)
303                         ssid = wpa_s->conf->ssid;
304                 while (ssid) {
305                         if (!ssid->disabled && ssid->scan_ssid) {
306                                 wpa_hexdump_ascii(MSG_DEBUG, "Scan SSID",
307                                                   ssid->ssid, ssid->ssid_len);
308                                 params.ssids[params.num_ssids].ssid =
309                                         ssid->ssid;
310                                 params.ssids[params.num_ssids].ssid_len =
311                                         ssid->ssid_len;
312                                 params.num_ssids++;
313                                 if (params.num_ssids + 1 >= max_ssids)
314                                         break;
315                         }
316                         ssid = ssid->next;
317                         if (ssid == start)
318                                 break;
319                         if (ssid == NULL && max_ssids > 1 &&
320                             start != wpa_s->conf->ssid)
321                                 ssid = wpa_s->conf->ssid;
322                 }
323
324                 for (tssid = wpa_s->conf->ssid; tssid; tssid = tssid->next) {
325                         if (tssid->disabled)
326                                 continue;
327                         if ((params.freqs || !freqs_set) && tssid->scan_freq) {
328                                 int_array_concat(&params.freqs,
329                                                  tssid->scan_freq);
330                         } else {
331                                 os_free(params.freqs);
332                                 params.freqs = NULL;
333                         }
334                         freqs_set = 1;
335                 }
336                 int_array_sort_unique(params.freqs);
337         }
338
339         if (ssid) {
340                 wpa_s->prev_scan_ssid = ssid;
341                 if (max_ssids > 1) {
342                         wpa_printf(MSG_DEBUG, "Include wildcard SSID in the "
343                                    "scan request");
344                         params.num_ssids++;
345                 }
346                 wpa_printf(MSG_DEBUG, "Starting AP scan for specific SSID(s)");
347         } else {
348                 wpa_s->prev_scan_ssid = WILDCARD_SSID_SCAN;
349                 params.num_ssids++;
350                 wpa_printf(MSG_DEBUG, "Starting AP scan for wildcard SSID");
351         }
352
353 #ifdef CONFIG_WPS
354         if (wps) {
355                 wps_ie = wps_build_probe_req_ie(wps == 2, &wpa_s->wps->dev,
356                                                 wpa_s->wps->uuid, req_type);
357                 if (wps_ie) {
358                         params.extra_ies = wpabuf_head(wps_ie);
359                         params.extra_ies_len = wpabuf_len(wps_ie);
360                 }
361         }
362 #endif /* CONFIG_WPS */
363
364         ret = wpa_supplicant_trigger_scan(wpa_s, &params);
365
366         wpabuf_free(wps_ie);
367         os_free(params.freqs);
368
369         if (ret) {
370                 wpa_printf(MSG_WARNING, "Failed to initiate AP scan.");
371                 wpa_supplicant_req_scan(wpa_s, 10, 0);
372         } else
373                 wpa_s->scan_runs++;
374 }
375
376
377 /**
378  * wpa_supplicant_req_scan - Schedule a scan for neighboring access points
379  * @wpa_s: Pointer to wpa_supplicant data
380  * @sec: Number of seconds after which to scan
381  * @usec: Number of microseconds after which to scan
382  *
383  * This function is used to schedule a scan for neighboring access points after
384  * the specified time.
385  */
386 void wpa_supplicant_req_scan(struct wpa_supplicant *wpa_s, int sec, int usec)
387 {
388         /* If there's at least one network that should be specifically scanned
389          * then don't cancel the scan and reschedule.  Some drivers do
390          * background scanning which generates frequent scan results, and that
391          * causes the specific SSID scan to get continually pushed back and
392          * never happen, which causes hidden APs to never get probe-scanned.
393          */
394         if (eloop_is_timeout_registered(wpa_supplicant_scan, wpa_s, NULL) &&
395             wpa_s->conf->ap_scan == 1) {
396                 struct wpa_ssid *ssid = wpa_s->conf->ssid;
397
398                 while (ssid) {
399                         if (!ssid->disabled && ssid->scan_ssid)
400                                 break;
401                         ssid = ssid->next;
402                 }
403                 if (ssid) {
404                         wpa_msg(wpa_s, MSG_DEBUG, "Not rescheduling scan to "
405                                 "ensure that specific SSID scans occur");
406                         return;
407                 }
408         }
409
410         wpa_msg(wpa_s, MSG_DEBUG, "Setting scan request: %d sec %d usec",
411                 sec, usec);
412         eloop_cancel_timeout(wpa_supplicant_scan, wpa_s, NULL);
413         eloop_register_timeout(sec, usec, wpa_supplicant_scan, wpa_s, NULL);
414 }
415
416
417 /**
418  * wpa_supplicant_cancel_scan - Cancel a scheduled scan request
419  * @wpa_s: Pointer to wpa_supplicant data
420  *
421  * This function is used to cancel a scan request scheduled with
422  * wpa_supplicant_req_scan().
423  */
424 void wpa_supplicant_cancel_scan(struct wpa_supplicant *wpa_s)
425 {
426         wpa_msg(wpa_s, MSG_DEBUG, "Cancelling scan request");
427         eloop_cancel_timeout(wpa_supplicant_scan, wpa_s, NULL);
428 }
429
430
431 void wpa_supplicant_notify_scanning(struct wpa_supplicant *wpa_s,
432                                     int scanning)
433 {
434         if (wpa_s->scanning != scanning) {
435                 wpa_s->scanning = scanning;
436                 wpas_notify_scanning(wpa_s);
437         }
438 }
439