5f3b29d5b25e0f6e02655d25730ba32741beb3ab
[libeap.git] / wpa_supplicant / wps_supplicant.c
1 /*
2  * wpa_supplicant / WPS integration
3  * Copyright (c) 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 "ieee802_11_defs.h"
19 #include "wpa_common.h"
20 #include "config.h"
21 #include "eap_peer/eap.h"
22 #include "wpa_supplicant_i.h"
23 #include "eloop.h"
24 #include "wpa_ctrl.h"
25 #include "eap_common/eap_wsc_common.h"
26 #include "wps/wps.h"
27 #include "wps/wps_defs.h"
28 #include "wps_supplicant.h"
29
30
31 static void wpas_wps_timeout(void *eloop_ctx, void *timeout_ctx);
32
33
34 int wpas_wps_eapol_cb(struct wpa_supplicant *wpa_s)
35 {
36         eloop_cancel_timeout(wpas_wps_timeout, wpa_s, NULL);
37
38         if (wpa_s->key_mgmt == WPA_KEY_MGMT_WPS && wpa_s->current_ssid &&
39             !(wpa_s->current_ssid->key_mgmt & WPA_KEY_MGMT_WPS)) {
40                 wpa_printf(MSG_DEBUG, "WPS: Network configuration replaced - "
41                            "try to associate with the received credential");
42                 wpa_supplicant_deauthenticate(wpa_s,
43                                               WLAN_REASON_DEAUTH_LEAVING);
44                 wpa_s->reassociate = 1;
45                 wpa_supplicant_req_scan(wpa_s, 0, 0);
46                 return 1;
47         }
48
49         return 0;
50 }
51
52
53 static int wpa_supplicant_wps_cred(void *ctx,
54                                    const struct wps_credential *cred)
55 {
56         struct wpa_supplicant *wpa_s = ctx;
57         struct wpa_ssid *ssid = wpa_s->current_ssid;
58
59         wpa_msg(wpa_s, MSG_INFO, WPS_EVENT_CRED_RECEIVED);
60
61         if (ssid && (ssid->key_mgmt & WPA_KEY_MGMT_WPS)) {
62                 wpa_printf(MSG_DEBUG, "WPS: Replace WPS network block based "
63                            "on the received credential");
64                 os_free(ssid->eap.identity);
65                 ssid->eap.identity = NULL;
66                 ssid->eap.identity_len = 0;
67                 os_free(ssid->eap.phase1);
68                 ssid->eap.phase1 = NULL;
69                 os_free(ssid->eap.eap_methods);
70                 ssid->eap.eap_methods = NULL;
71         } else {
72                 wpa_printf(MSG_DEBUG, "WPS: Create a new network based on the "
73                            "received credential");
74                 ssid = wpa_config_add_network(wpa_s->conf);
75                 if (ssid == NULL)
76                         return -1;
77         }
78
79         wpa_config_set_network_defaults(ssid);
80
81         os_free(ssid->ssid);
82         ssid->ssid = os_malloc(cred->ssid_len);
83         if (ssid->ssid) {
84                 os_memcpy(ssid->ssid, cred->ssid, cred->ssid_len);
85                 ssid->ssid_len = cred->ssid_len;
86         }
87
88         switch (cred->encr_type) {
89         case WPS_ENCR_NONE:
90                 ssid->pairwise_cipher = ssid->group_cipher = WPA_CIPHER_NONE;
91                 break;
92         case WPS_ENCR_WEP:
93                 ssid->pairwise_cipher = ssid->group_cipher =
94                         WPA_CIPHER_WEP40 | WPA_CIPHER_WEP104;
95                 if (cred->key_len > 0 && cred->key_len <= MAX_WEP_KEY_LEN &&
96                     cred->key_idx < NUM_WEP_KEYS) {
97                         os_memcpy(ssid->wep_key[cred->key_idx], cred->key,
98                                   cred->key_len);
99                         ssid->wep_key_len[cred->key_idx] = cred->key_len;
100                         ssid->wep_tx_keyidx = cred->key_idx;
101                 }
102                 break;
103         case WPS_ENCR_TKIP:
104                 ssid->pairwise_cipher = WPA_CIPHER_TKIP;
105                 ssid->group_cipher = WPA_CIPHER_TKIP;
106                 break;
107         case WPS_ENCR_AES:
108                 ssid->pairwise_cipher = WPA_CIPHER_CCMP;
109                 ssid->group_cipher = WPA_CIPHER_CCMP | WPA_CIPHER_TKIP;
110                 break;
111         }
112
113         switch (cred->auth_type) {
114         case WPS_AUTH_OPEN:
115                 ssid->auth_alg = WPA_AUTH_ALG_OPEN;
116                 ssid->key_mgmt = WPA_KEY_MGMT_NONE;
117                 ssid->proto = 0;
118                 break;
119         case WPS_AUTH_SHARED:
120                 ssid->auth_alg = WPA_AUTH_ALG_SHARED;
121                 ssid->key_mgmt = WPA_KEY_MGMT_NONE;
122                 ssid->proto = 0;
123                 break;
124         case WPS_AUTH_WPAPSK:
125                 ssid->auth_alg = WPA_AUTH_ALG_OPEN;
126                 ssid->key_mgmt = WPA_KEY_MGMT_PSK;
127                 ssid->proto = WPA_PROTO_WPA;
128                 break;
129         case WPS_AUTH_WPA:
130                 ssid->auth_alg = WPA_AUTH_ALG_OPEN;
131                 ssid->key_mgmt = WPA_KEY_MGMT_IEEE8021X;
132                 ssid->proto = WPA_PROTO_WPA;
133                 break;
134         case WPS_AUTH_WPA2:
135                 ssid->auth_alg = WPA_AUTH_ALG_OPEN;
136                 ssid->key_mgmt = WPA_KEY_MGMT_IEEE8021X;
137                 ssid->proto = WPA_PROTO_RSN;
138                 break;
139         case WPS_AUTH_WPA2PSK:
140                 ssid->auth_alg = WPA_AUTH_ALG_OPEN;
141                 ssid->key_mgmt = WPA_KEY_MGMT_PSK;
142                 ssid->proto = WPA_PROTO_RSN;
143                 break;
144         }
145
146         if (ssid->key_mgmt == WPA_KEY_MGMT_PSK) {
147                 if (cred->key_len == 2 * PMK_LEN) {
148                         if (hexstr2bin((const char *) cred->key, ssid->psk,
149                                        PMK_LEN)) {
150                                 wpa_printf(MSG_ERROR, "WPS: Invalid Network "
151                                            "Key");
152                                 return -1;
153                         }
154                         ssid->psk_set = 1;
155                 } else if (cred->key_len >= 8 && cred->key_len < 2 * PMK_LEN) {
156                         os_free(ssid->passphrase);
157                         ssid->passphrase = os_malloc(cred->key_len + 1);
158                         if (ssid->passphrase == NULL)
159                                 return -1;
160                         os_memcpy(ssid->passphrase, cred->key, cred->key_len);
161                         ssid->passphrase[cred->key_len] = '\0';
162                         wpa_config_update_psk(ssid);
163                 } else {
164                         wpa_printf(MSG_ERROR, "WPS: Invalid Network Key "
165                                    "length %lu",
166                                    (unsigned long) cred->key_len);
167                         return -1;
168                 }
169         }
170
171 #ifndef CONFIG_NO_CONFIG_WRITE
172         if (wpa_s->conf->update_config &&
173             wpa_config_write(wpa_s->confname, wpa_s->conf)) {
174                 wpa_printf(MSG_DEBUG, "WPS: Failed to update configuration");
175                 return -1;
176         }
177 #endif /* CONFIG_NO_CONFIG_WRITE */
178
179         return 0;
180 }
181
182
183 static void wpa_supplicant_wps_event_m2d(struct wpa_supplicant *wpa_s,
184                                          struct wps_event_m2d *m2d)
185 {
186         wpa_msg(wpa_s, MSG_INFO, WPS_EVENT_M2D
187                 "dev_password_id=%d config_error=%d",
188                 m2d->dev_password_id, m2d->config_error);
189 }
190
191
192 static void wpa_supplicant_wps_event(void *ctx, enum wps_event event,
193                                      union wps_event_data *data)
194 {
195         struct wpa_supplicant *wpa_s = ctx;
196         switch (event) {
197         case WPS_EV_M2D:
198                 wpa_supplicant_wps_event_m2d(wpa_s, &data->m2d);
199                 break;
200         }
201 }
202
203
204 u8 wpas_wps_get_req_type(struct wpa_ssid *ssid)
205 {
206         if (eap_is_wps_pbc_enrollee(&ssid->eap) ||
207             eap_is_wps_pin_enrollee(&ssid->eap))
208                 return WPS_REQ_ENROLLEE;
209         else
210                 return WPS_REQ_REGISTRAR;
211 }
212
213
214 static void wpas_clear_wps(struct wpa_supplicant *wpa_s)
215 {
216         int id;
217         struct wpa_ssid *ssid;
218
219         eloop_cancel_timeout(wpas_wps_timeout, wpa_s, NULL);
220
221         /* Remove any existing WPS network from configuration */
222         ssid = wpa_s->conf->ssid;
223         while (ssid) {
224                 if (ssid->key_mgmt & WPA_KEY_MGMT_WPS) {
225                         if (ssid == wpa_s->current_ssid)
226                                 wpa_s->current_ssid = NULL;
227                         id = ssid->id;
228                 } else
229                         id = -1;
230                 ssid = ssid->next;
231                 if (id >= 0)
232                         wpa_config_remove_network(wpa_s->conf, id);
233         }
234 }
235
236
237 static void wpas_wps_timeout(void *eloop_ctx, void *timeout_ctx)
238 {
239         struct wpa_supplicant *wpa_s = eloop_ctx;
240         wpa_printf(MSG_DEBUG, "WPS: Requested operation timed out");
241         wpas_clear_wps(wpa_s);
242 }
243
244
245 static struct wpa_ssid * wpas_wps_add_network(struct wpa_supplicant *wpa_s,
246                                               int registrar, const u8 *bssid)
247 {
248         struct wpa_ssid *ssid;
249
250         ssid = wpa_config_add_network(wpa_s->conf);
251         if (ssid == NULL)
252                 return NULL;
253         wpa_config_set_network_defaults(ssid);
254         if (wpa_config_set(ssid, "key_mgmt", "WPS", 0) < 0 ||
255             wpa_config_set(ssid, "eap", "WSC", 0) < 0 ||
256             wpa_config_set(ssid, "identity", registrar ?
257                            "\"" WSC_ID_REGISTRAR "\"" :
258                            "\"" WSC_ID_ENROLLEE "\"", 0) < 0) {
259                 wpa_config_remove_network(wpa_s->conf, ssid->id);
260                 return NULL;
261         }
262
263         if (bssid) {
264                 size_t i;
265                 struct wpa_scan_res *res;
266
267                 os_memcpy(ssid->bssid, bssid, ETH_ALEN);
268
269                 /* Try to get SSID from scan results */
270                 if (wpa_s->scan_res == NULL &&
271                     wpa_supplicant_get_scan_results(wpa_s) < 0)
272                         return ssid; /* Could not find any scan results */
273
274                 for (i = 0; i < wpa_s->scan_res->num; i++) {
275                         const u8 *ie;
276
277                         res = wpa_s->scan_res->res[i];
278                         if (os_memcmp(bssid, res->bssid, ETH_ALEN) != 0)
279                                 continue;
280
281                         ie = wpa_scan_get_ie(res, WLAN_EID_SSID);
282                         if (ie == NULL)
283                                 break;
284                         os_free(ssid->ssid);
285                         ssid->ssid = os_malloc(ie[1]);
286                         if (ssid->ssid == NULL)
287                                 break;
288                         os_memcpy(ssid->ssid, ie + 2, ie[1]);
289                         ssid->ssid_len = ie[1];
290                         break;
291                 }
292         }
293
294         return ssid;
295 }
296
297
298 static void wpas_wps_reassoc(struct wpa_supplicant *wpa_s,
299                              struct wpa_ssid *selected)
300 {
301         struct wpa_ssid *ssid;
302
303         /* Mark all other networks disabled and trigger reassociation */
304         ssid = wpa_s->conf->ssid;
305         while (ssid) {
306                 ssid->disabled = ssid != selected;
307                 ssid = ssid->next;
308         }
309         wpa_s->disconnected = 0;
310         wpa_s->reassociate = 1;
311         wpa_supplicant_req_scan(wpa_s, 0, 0);
312 }
313
314
315 int wpas_wps_start_pbc(struct wpa_supplicant *wpa_s, const u8 *bssid)
316 {
317         struct wpa_ssid *ssid;
318         wpas_clear_wps(wpa_s);
319         ssid = wpas_wps_add_network(wpa_s, 0, bssid);
320         if (ssid == NULL)
321                 return -1;
322         wpa_config_set(ssid, "phase1", "\"pbc=1\"", 0);
323         eloop_register_timeout(WPS_PBC_WALK_TIME, 0, wpas_wps_timeout,
324                                wpa_s, NULL);
325         wpas_wps_reassoc(wpa_s, ssid);
326         return 0;
327 }
328
329
330 int wpas_wps_start_pin(struct wpa_supplicant *wpa_s, const u8 *bssid,
331                        const char *pin)
332 {
333         struct wpa_ssid *ssid;
334         char val[30];
335         unsigned int rpin = 0;
336
337         wpas_clear_wps(wpa_s);
338         ssid = wpas_wps_add_network(wpa_s, 0, bssid);
339         if (ssid == NULL)
340                 return -1;
341         if (pin)
342                 os_snprintf(val, sizeof(val), "\"pin=%s\"", pin);
343         else {
344                 rpin = wps_generate_pin();
345                 os_snprintf(val, sizeof(val), "\"pin=%08d\"", rpin);
346         }
347         wpa_config_set(ssid, "phase1", val, 0);
348         eloop_register_timeout(WPS_PBC_WALK_TIME, 0, wpas_wps_timeout,
349                                wpa_s, NULL);
350         wpas_wps_reassoc(wpa_s, ssid);
351         return rpin;
352 }
353
354
355 int wpas_wps_start_reg(struct wpa_supplicant *wpa_s, const u8 *bssid,
356                        const char *pin)
357 {
358         struct wpa_ssid *ssid;
359         char val[30];
360
361         if (!pin)
362                 return -1;
363         wpas_clear_wps(wpa_s);
364         ssid = wpas_wps_add_network(wpa_s, 1, bssid);
365         if (ssid == NULL)
366                 return -1;
367         os_snprintf(val, sizeof(val), "\"pin=%s\"", pin);
368         wpa_config_set(ssid, "phase1", val, 0);
369         eloop_register_timeout(WPS_PBC_WALK_TIME, 0, wpas_wps_timeout,
370                                wpa_s, NULL);
371         wpas_wps_reassoc(wpa_s, ssid);
372         return 0;
373 }
374
375
376 int wpas_wps_init(struct wpa_supplicant *wpa_s)
377 {
378         struct wps_context *wps;
379
380         wps = os_zalloc(sizeof(*wps));
381         if (wps == NULL)
382                 return -1;
383
384         wps->cred_cb = wpa_supplicant_wps_cred;
385         wps->event_cb = wpa_supplicant_wps_event;
386         wps->cb_ctx = wpa_s;
387
388         wps->dev.device_name = wpa_s->conf->device_name;
389         wps->dev.manufacturer = wpa_s->conf->manufacturer;
390         wps->dev.model_name = wpa_s->conf->model_name;
391         wps->dev.model_number = wpa_s->conf->model_number;
392         wps->dev.serial_number = wpa_s->conf->serial_number;
393         if (wpa_s->conf->device_type) {
394                 char *pos;
395                 u8 oui[4];
396                 /* <categ>-<OUI>-<subcateg> */
397                 wps->dev.categ = atoi(wpa_s->conf->device_type);
398                 pos = os_strchr(wpa_s->conf->device_type, '-');
399                 if (pos == NULL) {
400                         wpa_printf(MSG_ERROR, "WPS: Invalid device_type");
401                         os_free(wps);
402                         return -1;
403                 }
404                 pos++;
405                 if (hexstr2bin(pos, oui, 4)) {
406                         wpa_printf(MSG_ERROR, "WPS: Invalid device_type OUI");
407                         os_free(wps);
408                         return -1;
409                 }
410                 wps->dev.oui = WPA_GET_BE32(oui);
411                 pos = os_strchr(pos, '-');
412                 if (pos == NULL) {
413                         wpa_printf(MSG_ERROR, "WPS: Invalid device_type");
414                         os_free(wps);
415                         return -1;
416                 }
417                 pos++;
418                 wps->dev.sub_categ = atoi(pos);
419         }
420         wps->dev.os_version = WPA_GET_BE32(wpa_s->conf->os_version);
421         wps->dev.rf_bands = WPS_RF_24GHZ | WPS_RF_50GHZ; /* TODO: config */
422         os_memcpy(wps->dev.mac_addr, wpa_s->own_addr, ETH_ALEN);
423         os_memcpy(wps->uuid, wpa_s->conf->uuid, 16);
424
425         wpa_s->wps = wps;
426
427         return 0;
428 }
429
430
431 void wpas_wps_deinit(struct wpa_supplicant *wpa_s)
432 {
433         eloop_cancel_timeout(wpas_wps_timeout, wpa_s, NULL);
434
435         if (wpa_s->wps == NULL)
436                 return;
437
438         os_free(wpa_s->wps->network_key);
439         os_free(wpa_s->wps);
440         wpa_s->wps = NULL;
441 }
442
443
444 int wpas_wps_ssid_bss_match(struct wpa_ssid *ssid, struct wpa_scan_res *bss)
445 {
446         struct wpabuf *wps_ie;
447
448         if (!(ssid->key_mgmt & WPA_KEY_MGMT_WPS))
449                 return -1;
450
451         wps_ie = wpa_scan_get_vendor_ie_multi(bss, WPS_IE_VENDOR_TYPE);
452         if (eap_is_wps_pbc_enrollee(&ssid->eap)) {
453                 if (!wps_ie) {
454                         wpa_printf(MSG_DEBUG, "   skip - non-WPS AP");
455                         return 0;
456                 }
457
458                 if (!wps_is_selected_pbc_registrar(wps_ie)) {
459                         wpa_printf(MSG_DEBUG, "   skip - WPS AP "
460                                    "without active PBC Registrar");
461                         wpabuf_free(wps_ie);
462                         return 0;
463                 }
464
465                 /* TODO: overlap detection */
466                 wpa_printf(MSG_DEBUG, "   selected based on WPS IE "
467                            "(Active PBC)");
468                 wpabuf_free(wps_ie);
469                 return 1;
470         }
471
472         if (eap_is_wps_pin_enrollee(&ssid->eap)) {
473                 if (!wps_ie) {
474                         wpa_printf(MSG_DEBUG, "   skip - non-WPS AP");
475                         return 0;
476                 }
477
478                 if (!wps_is_selected_pin_registrar(wps_ie)) {
479                         wpa_printf(MSG_DEBUG, "   skip - WPS AP "
480                                    "without active PIN Registrar");
481                         wpabuf_free(wps_ie);
482                         return 0;
483                 }
484                 wpa_printf(MSG_DEBUG, "   selected based on WPS IE "
485                            "(Active PIN)");
486                 wpabuf_free(wps_ie);
487                 return 1;
488         }
489
490         if (wps_ie) {
491                 wpa_printf(MSG_DEBUG, "   selected based on WPS IE");
492                 wpabuf_free(wps_ie);
493                 return 1;
494         }
495
496         return -1;
497 }
498
499
500 int wpas_wps_ssid_wildcard_ok(struct wpa_ssid *ssid,
501                               struct wpa_scan_res *bss)
502 {
503         struct wpabuf *wps_ie = NULL;
504         int ret = 0;
505
506         if (eap_is_wps_pbc_enrollee(&ssid->eap)) {
507                 wps_ie = wpa_scan_get_vendor_ie_multi(bss, WPS_IE_VENDOR_TYPE);
508                 if (wps_ie && wps_is_selected_pbc_registrar(wps_ie)) {
509                         /* allow wildcard SSID for WPS PBC */
510                         ret = 1;
511                 }
512         } else if (eap_is_wps_pin_enrollee(&ssid->eap)) {
513                 wps_ie = wpa_scan_get_vendor_ie_multi(bss, WPS_IE_VENDOR_TYPE);
514                 if (wps_ie && wps_is_selected_pin_registrar(wps_ie)) {
515                         /* allow wildcard SSID for WPS PIN */
516                         ret = 1;
517                 }
518         }
519
520         wpabuf_free(wps_ie);
521
522         return ret;
523 }
524
525
526 int wpas_wps_scan_pbc_overlap(struct wpa_supplicant *wpa_s,
527                               struct wpa_scan_res *selected,
528                               struct wpa_ssid *ssid)
529 {
530         const u8 *sel_uuid, *uuid;
531         size_t i;
532         struct wpabuf *wps_ie;
533         int ret = 0;
534
535         if (!eap_is_wps_pbc_enrollee(&ssid->eap))
536                 return 0;
537
538         /* Make sure that only one AP is in active PBC mode */
539         wps_ie = wpa_scan_get_vendor_ie_multi(selected, WPS_IE_VENDOR_TYPE);
540         if (wps_ie)
541                 sel_uuid = wps_get_uuid_e(wps_ie);
542         else
543                 sel_uuid = NULL;
544         if (!sel_uuid) {
545                 wpa_printf(MSG_DEBUG, "WPS: UUID-E not available for PBC "
546                            "overlap detection");
547                 wpabuf_free(wps_ie);
548                 return 1;
549         }
550
551         for (i = 0; i < wpa_s->scan_res->num; i++) {
552                 struct wpa_scan_res *bss = wpa_s->scan_res->res[i];
553                 struct wpabuf *ie;
554                 if (bss == selected)
555                         continue;
556                 ie = wpa_scan_get_vendor_ie_multi(bss, WPS_IE_VENDOR_TYPE);
557                 if (!ie)
558                         continue;
559                 if (!wps_is_selected_pbc_registrar(ie)) {
560                         wpabuf_free(ie);
561                         continue;
562                 }
563                 uuid = wps_get_uuid_e(ie);
564                 if (uuid == NULL) {
565                         wpa_printf(MSG_DEBUG, "WPS: UUID-E not available for "
566                                    "PBC overlap detection (other BSS)");
567                         ret = 1;
568                         wpabuf_free(ie);
569                         break;
570                 }
571                 if (os_memcmp(sel_uuid, uuid, 16) != 0) {
572                         ret = 1; /* PBC overlap */
573                         wpabuf_free(ie);
574                         break;
575                 }
576
577                 /* TODO: verify that this is reasonable dual-band situation */
578
579                 wpabuf_free(ie);
580         }
581
582         wpabuf_free(wps_ie);
583
584         return ret;
585 }
586
587
588 void wpas_wps_notify_scan_results(struct wpa_supplicant *wpa_s)
589 {
590         size_t i;
591
592         if (wpa_s->disconnected || wpa_s->wpa_state >= WPA_ASSOCIATED)
593                 return;
594
595         for (i = 0; i < wpa_s->scan_res->num; i++) {
596                 struct wpa_scan_res *bss = wpa_s->scan_res->res[i];
597                 struct wpabuf *ie;
598                 ie = wpa_scan_get_vendor_ie_multi(bss, WPS_IE_VENDOR_TYPE);
599                 if (!ie)
600                         continue;
601                 if (wps_is_selected_pbc_registrar(ie))
602                         wpa_msg(wpa_s, MSG_INFO, WPS_EVENT_AP_AVAILABLE_PBC);
603                 else if (wps_is_selected_pin_registrar(ie))
604                         wpa_msg(wpa_s, MSG_INFO, WPS_EVENT_AP_AVAILABLE_PIN);
605                 else
606                         wpa_msg(wpa_s, MSG_INFO, WPS_EVENT_AP_AVAILABLE);
607                 wpabuf_free(ie);
608                 break;
609         }
610 }