src/wps/wps.c

   1 /*
   2  * Wi-Fi Protected Setup
   3  * Copyright (c) 2007-2009, 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 "crypto/dh_group5.h"
  19 #include "common/ieee802_11_defs.h"
  20 #include "wps_i.h"
  21 #include "wps_dev_attr.h"
  22
  23
  24 #ifdef CONFIG_WPS_TESTING
  25 int wps_version_number = 0x20;
  26 int wps_testing_dummy_cred = 0;
  27 #endif /* CONFIG_WPS_TESTING */
  28
  29
  30 /**
  31  * wps_init - Initialize WPS Registration protocol data
  32  * @cfg: WPS configuration
  33  * Returns: Pointer to allocated data or %NULL on failure
  34  *
  35  * This function is used to initialize WPS data for a registration protocol
  36  * instance (i.e., each run of registration protocol as a Registrar of
  37  * Enrollee. The caller is responsible for freeing this data after the
  38  * registration run has been completed by calling wps_deinit().
  39  */
  40 struct wps_data * wps_init(const struct wps_config *cfg)
  41 {
  42         struct wps_data *data = os_zalloc(sizeof(*data));
  43         if (data == NULL)
  44                 return NULL;
  45         data->wps = cfg->wps;
  46         data->registrar = cfg->registrar;
  47         if (cfg->registrar) {
  48                 os_memcpy(data->uuid_r, cfg->wps->uuid, WPS_UUID_LEN);
  49         } else {
  50                 os_memcpy(data->mac_addr_e, cfg->wps->dev.mac_addr, ETH_ALEN);
  51                 os_memcpy(data->uuid_e, cfg->wps->uuid, WPS_UUID_LEN);
  52         }
  53         if (cfg->pin) {
  54                 data->dev_pw_id = data->wps->oob_dev_pw_id == 0 ?
  55                         cfg->dev_pw_id : data->wps->oob_dev_pw_id;
  56                 data->dev_password = os_malloc(cfg->pin_len);
  57                 if (data->dev_password == NULL) {
  58                         os_free(data);
  59                         return NULL;
  60                 }
  61                 os_memcpy(data->dev_password, cfg->pin, cfg->pin_len);
  62                 data->dev_password_len = cfg->pin_len;
  63         }
  64
  65         data->pbc = cfg->pbc;
  66         if (cfg->pbc) {
  67                 /* Use special PIN '00000000' for PBC */
  68                 data->dev_pw_id = DEV_PW_PUSHBUTTON;
  69                 os_free(data->dev_password);
  70                 data->dev_password = os_malloc(8);
  71                 if (data->dev_password == NULL) {
  72                         os_free(data);
  73                         return NULL;
  74                 }
  75                 os_memset(data->dev_password, '0', 8);
  76                 data->dev_password_len = 8;
  77         }
  78
  79         data->state = data->registrar ? RECV_M1 : SEND_M1;
  80
  81         if (cfg->assoc_wps_ie) {
  82                 struct wps_parse_attr attr;
  83                 wpa_hexdump_buf(MSG_DEBUG, "WPS: WPS IE from (Re)AssocReq",
  84                                 cfg->assoc_wps_ie);
  85                 if (wps_parse_msg(cfg->assoc_wps_ie, &attr) < 0) {
  86                         wpa_printf(MSG_DEBUG, "WPS: Failed to parse WPS IE "
  87                                    "from (Re)AssocReq");
  88                 } else if (attr.request_type == NULL) {
  89                         wpa_printf(MSG_DEBUG, "WPS: No Request Type attribute "
  90                                    "in (Re)AssocReq WPS IE");
  91                 } else {
  92                         wpa_printf(MSG_DEBUG, "WPS: Request Type (from WPS IE "
  93                                    "in (Re)AssocReq WPS IE): %d",
  94                                    *attr.request_type);
  95                         data->request_type = *attr.request_type;
  96                 }
  97         }
  98
  99         if (cfg->new_ap_settings) {
 100                 data->new_ap_settings =
 101                         os_malloc(sizeof(*data->new_ap_settings));
 102                 if (data->new_ap_settings == NULL) {
 103                         os_free(data);
 104                         return NULL;
 105                 }
 106                 os_memcpy(data->new_ap_settings, cfg->new_ap_settings,
 107                           sizeof(*data->new_ap_settings));
 108         }
 109
 110         if (cfg->peer_addr)
 111                 os_memcpy(data->peer_dev.mac_addr, cfg->peer_addr, ETH_ALEN);
 112         if (cfg->p2p_dev_addr)
 113                 os_memcpy(data->p2p_dev_addr, cfg->p2p_dev_addr, ETH_ALEN);
 114
 115         data->use_psk_key = cfg->use_psk_key;
 116
 117         return data;
 118 }
 119
 120
 121 /**
 122  * wps_deinit - Deinitialize WPS Registration protocol data
 123  * @data: WPS Registration protocol data from wps_init()
 124  */
 125 void wps_deinit(struct wps_data *data)
 126 {
 127         if (data->wps_pin_revealed) {
 128                 wpa_printf(MSG_DEBUG, "WPS: Full PIN information revealed and "
 129                            "negotiation failed");
 130                 if (data->registrar)
 131                         wps_registrar_invalidate_pin(data->wps->registrar,
 132                                                      data->uuid_e);
 133         } else if (data->registrar)
 134                 wps_registrar_unlock_pin(data->wps->registrar, data->uuid_e);
 135
 136         wpabuf_free(data->dh_privkey);
 137         wpabuf_free(data->dh_pubkey_e);
 138         wpabuf_free(data->dh_pubkey_r);
 139         wpabuf_free(data->last_msg);
 140         os_free(data->dev_password);
 141         os_free(data->new_psk);
 142         wps_device_data_free(&data->peer_dev);
 143         os_free(data->new_ap_settings);
 144         dh5_free(data->dh_ctx);
 145         os_free(data);
 146 }
 147
 148
 149 /**
 150  * wps_process_msg - Process a WPS message
 151  * @wps: WPS Registration protocol data from wps_init()
 152  * @op_code: Message OP Code
 153  * @msg: Message data
 154  * Returns: Processing result
 155  *
 156  * This function is used to process WPS messages with OP Codes WSC_ACK,
 157  * WSC_NACK, WSC_MSG, and WSC_Done. The caller (e.g., EAP server/peer) is
 158  * responsible for reassembling the messages before calling this function.
 159  * Response to this message is built by calling wps_get_msg().
 160  */
 161 enum wps_process_res wps_process_msg(struct wps_data *wps,
 162                                      enum wsc_op_code op_code,
 163                                      const struct wpabuf *msg)
 164 {
 165         if (wps->registrar)
 166                 return wps_registrar_process_msg(wps, op_code, msg);
 167         else
 168                 return wps_enrollee_process_msg(wps, op_code, msg);
 169 }
 170
 171
 172 /**
 173  * wps_get_msg - Build a WPS message
 174  * @wps: WPS Registration protocol data from wps_init()
 175  * @op_code: Buffer for returning message OP Code
 176  * Returns: The generated WPS message or %NULL on failure
 177  *
 178  * This function is used to build a response to a message processed by calling
 179  * wps_process_msg(). The caller is responsible for freeing the buffer.
 180  */
 181 struct wpabuf * wps_get_msg(struct wps_data *wps, enum wsc_op_code *op_code)
 182 {
 183         if (wps->registrar)
 184                 return wps_registrar_get_msg(wps, op_code);
 185         else
 186                 return wps_enrollee_get_msg(wps, op_code);
 187 }
 188
 189
 190 /**
 191  * wps_is_selected_pbc_registrar - Check whether WPS IE indicates active PBC
 192  * @msg: WPS IE contents from Beacon or Probe Response frame
 193  * Returns: 1 if PBC Registrar is active, 0 if not
 194  */
 195 int wps_is_selected_pbc_registrar(const struct wpabuf *msg)
 196 {
 197         struct wps_parse_attr attr;
 198
 199         /*
 200          * In theory, this could also verify that attr.sel_reg_config_methods
 201          * includes WPS_CONFIG_PUSHBUTTON, but some deployed AP implementations
 202          * do not set Selected Registrar Config Methods attribute properly, so
 203          * it is safer to just use Device Password ID here.
 204          */
 205
 206         if (wps_parse_msg(msg, &attr) < 0 ||
 207             !attr.selected_registrar || *attr.selected_registrar == 0 ||
 208             !attr.dev_password_id ||
 209             WPA_GET_BE16(attr.dev_password_id) != DEV_PW_PUSHBUTTON)
 210                 return 0;
 211
 212 #ifdef CONFIG_WPS_STRICT
 213         if (!attr.sel_reg_config_methods ||
 214             !(WPA_GET_BE16(attr.sel_reg_config_methods) &
 215               WPS_CONFIG_PUSHBUTTON))
 216                 return 0;
 217 #endif /* CONFIG_WPS_STRICT */
 218
 219         return 1;
 220 }
 221
 222
 223 static int is_selected_pin_registrar(struct wps_parse_attr *attr)
 224 {
 225         /*
 226          * In theory, this could also verify that attr.sel_reg_config_methods
 227          * includes WPS_CONFIG_LABEL, WPS_CONFIG_DISPLAY, or WPS_CONFIG_KEYPAD,
 228          * but some deployed AP implementations do not set Selected Registrar
 229          * Config Methods attribute properly, so it is safer to just use
 230          * Device Password ID here.
 231          */
 232
 233         if (!attr->selected_registrar || *attr->selected_registrar == 0)
 234                 return 0;
 235
 236         if (attr->dev_password_id != NULL &&
 237             WPA_GET_BE16(attr->dev_password_id) == DEV_PW_PUSHBUTTON)
 238                 return 0;
 239
 240 #ifdef CONFIG_WPS_STRICT
 241         if (!attr->sel_reg_config_methods ||
 242             !(WPA_GET_BE16(attr->sel_reg_config_methods) &
 243               (WPS_CONFIG_LABEL | WPS_CONFIG_DISPLAY | WPS_CONFIG_KEYPAD)))
 244                 return 0;
 245 #endif /* CONFIG_WPS_STRICT */
 246
 247         return 1;
 248 }
 249
 250
 251 /**
 252  * wps_is_selected_pin_registrar - Check whether WPS IE indicates active PIN
 253  * @msg: WPS IE contents from Beacon or Probe Response frame
 254  * Returns: 1 if PIN Registrar is active, 0 if not
 255  */
 256 int wps_is_selected_pin_registrar(const struct wpabuf *msg)
 257 {
 258         struct wps_parse_attr attr;
 259
 260         if (wps_parse_msg(msg, &attr) < 0)
 261                 return 0;
 262
 263         return is_selected_pin_registrar(&attr);
 264 }
 265
 266
 267 /**
 268  * wps_is_addr_authorized - Check whether WPS IE authorizes MAC address
 269  * @msg: WPS IE contents from Beacon or Probe Response frame
 270  * @addr: MAC address to search for
 271  * @ver1_compat: Whether to use version 1 compatibility mode
 272  * Returns: 1 if address is authorized, 0 if not
 273  */
 274 int wps_is_addr_authorized(const struct wpabuf *msg, const u8 *addr,
 275                            int ver1_compat)
 276 {
 277         struct wps_parse_attr attr;
 278         unsigned int i;
 279         const u8 *pos;
 280         const u8 bcast[ETH_ALEN] = { 0xff, 0xff, 0xff, 0xff, 0xff, 0xff };
 281
 282         if (wps_parse_msg(msg, &attr) < 0)
 283                 return 0;
 284
 285         if (!attr.version2 && ver1_compat) {
 286                 /*
 287                  * Version 1.0 AP - AuthorizedMACs not used, so revert back to
 288                  * old mechanism of using SelectedRegistrar.
 289                  */
 290                 return is_selected_pin_registrar(&attr);
 291         }
 292
 293         if (!attr.authorized_macs)
 294                 return 0;
 295
 296         pos = attr.authorized_macs;
 297         for (i = 0; i < attr.authorized_macs_len / ETH_ALEN; i++) {
 298                 if (os_memcmp(pos, addr, ETH_ALEN) == 0 ||
 299                     os_memcmp(pos, bcast, ETH_ALEN) == 0)
 300                         return 1;
 301                 pos += ETH_ALEN;
 302         }
 303
 304         return 0;
 305 }
 306
 307
 308 /**
 309  * wps_ap_priority_compar - Prioritize WPS IE from two APs
 310  * @wps_a: WPS IE contents from Beacon or Probe Response frame
 311  * @wps_b: WPS IE contents from Beacon or Probe Response frame
 312  * Returns: 1 if wps_b is considered more likely selection for WPS
 313  * provisioning, -1 if wps_a is considered more like, or 0 if no preference
 314  */
 315 int wps_ap_priority_compar(const struct wpabuf *wps_a,
 316                            const struct wpabuf *wps_b)
 317 {
 318         struct wps_parse_attr attr_a, attr_b;
 319         int sel_a, sel_b;
 320
 321         if (wps_a == NULL || wps_parse_msg(wps_a, &attr_a) < 0)
 322                 return 1;
 323         if (wps_b == NULL || wps_parse_msg(wps_b, &attr_b) < 0)
 324                 return -1;
 325
 326         sel_a = attr_a.selected_registrar && *attr_a.selected_registrar != 0;
 327         sel_b = attr_b.selected_registrar && *attr_b.selected_registrar != 0;
 328
 329         if (sel_a && !sel_b)
 330                 return -1;
 331         if (!sel_a && sel_b)
 332                 return 1;
 333
 334         return 0;
 335 }
 336
 337
 338 /**
 339  * wps_get_uuid_e - Get UUID-E from WPS IE
 340  * @msg: WPS IE contents from Beacon or Probe Response frame
 341  * Returns: Pointer to UUID-E or %NULL if not included
 342  *
 343  * The returned pointer is to the msg contents and it remains valid only as
 344  * long as the msg buffer is valid.
 345  */
 346 const u8 * wps_get_uuid_e(const struct wpabuf *msg)
 347 {
 348         struct wps_parse_attr attr;
 349
 350         if (wps_parse_msg(msg, &attr) < 0)
 351                 return NULL;
 352         return attr.uuid_e;
 353 }
 354
 355
 356 /**
 357  * wps_build_assoc_req_ie - Build WPS IE for (Re)Association Request
 358  * @req_type: Value for Request Type attribute
 359  * Returns: WPS IE or %NULL on failure
 360  *
 361  * The caller is responsible for freeing the buffer.
 362  */
 363 struct wpabuf * wps_build_assoc_req_ie(enum wps_request_type req_type)
 364 {
 365         struct wpabuf *ie;
 366         u8 *len;
 367
 368         wpa_printf(MSG_DEBUG, "WPS: Building WPS IE for (Re)Association "
 369                    "Request");
 370         ie = wpabuf_alloc(100);
 371         if (ie == NULL)
 372                 return NULL;
 373
 374         wpabuf_put_u8(ie, WLAN_EID_VENDOR_SPECIFIC);
 375         len = wpabuf_put(ie, 1);
 376         wpabuf_put_be32(ie, WPS_DEV_OUI_WFA);
 377
 378         if (wps_build_version(ie) ||
 379             wps_build_req_type(ie, req_type) ||
 380             wps_build_wfa_ext(ie, 0, NULL, 0)) {
 381                 wpabuf_free(ie);
 382                 return NULL;
 383         }
 384
 385         *len = wpabuf_len(ie) - 2;
 386
 387         return ie;
 388 }
 389
 390
 391 /**
 392  * wps_build_assoc_resp_ie - Build WPS IE for (Re)Association Response
 393  * Returns: WPS IE or %NULL on failure
 394  *
 395  * The caller is responsible for freeing the buffer.
 396  */
 397 struct wpabuf * wps_build_assoc_resp_ie(void)
 398 {
 399         struct wpabuf *ie;
 400         u8 *len;
 401
 402         wpa_printf(MSG_DEBUG, "WPS: Building WPS IE for (Re)Association "
 403                    "Response");
 404         ie = wpabuf_alloc(100);
 405         if (ie == NULL)
 406                 return NULL;
 407
 408         wpabuf_put_u8(ie, WLAN_EID_VENDOR_SPECIFIC);
 409         len = wpabuf_put(ie, 1);
 410         wpabuf_put_be32(ie, WPS_DEV_OUI_WFA);
 411
 412         if (wps_build_version(ie) ||
 413             wps_build_resp_type(ie, WPS_RESP_AP) ||
 414             wps_build_wfa_ext(ie, 0, NULL, 0)) {
 415                 wpabuf_free(ie);
 416                 return NULL;
 417         }
 418
 419         *len = wpabuf_len(ie) - 2;
 420
 421         return ie;
 422 }
 423
 424
 425 /**
 426  * wps_build_probe_req_ie - Build WPS IE for Probe Request
 427  * @pbc: Whether searching for PBC mode APs
 428  * @dev: Device attributes
 429  * @uuid: Own UUID
 430  * @req_type: Value for Request Type attribute
 431  * Returns: WPS IE or %NULL on failure
 432  *
 433  * The caller is responsible for freeing the buffer.
 434  */
 435 struct wpabuf * wps_build_probe_req_ie(int pbc, struct wps_device_data *dev,
 436                                        const u8 *uuid,
 437                                        enum wps_request_type req_type)
 438 {
 439         struct wpabuf *ie;
 440         u16 methods = 0;
 441
 442         wpa_printf(MSG_DEBUG, "WPS: Building WPS IE for Probe Request");
 443
 444         ie = wpabuf_alloc(500);
 445         if (ie == NULL)
 446                 return NULL;
 447
 448         methods |= WPS_CONFIG_PUSHBUTTON;
 449 #ifdef CONFIG_WPS2
 450         /*
 451          * TODO: Should figure out whether this device has a physical or
 452          * virtual pushbutton.
 453          */
 454         methods |= WPS_CONFIG_VIRT_PUSHBUTTON;
 455 #endif /* CONFIG_WPS2 */
 456
 457         /*
 458          * TODO: Should figure out whether this Probe Request was triggered
 459          * using physical or virtual display. Also, if the device has a PIN on
 460          * a label, that should be indicated here.
 461          */
 462         methods |= WPS_CONFIG_DISPLAY |
 463 #ifdef CONFIG_WPS2
 464                 WPS_CONFIG_VIRT_DISPLAY |
 465 #endif /* CONFIG_WPS2 */
 466                 WPS_CONFIG_KEYPAD;
 467 #ifdef CONFIG_WPS_UFD
 468         methods |= WPS_CONFIG_USBA;
 469 #endif /* CONFIG_WPS_UFD */
 470 #ifdef CONFIG_WPS_NFC
 471         methods |= WPS_CONFIG_NFC_INTERFACE;
 472 #endif /* CONFIG_WPS_NFC */
 473
 474         if (wps_build_version(ie) ||
 475             wps_build_req_type(ie, req_type) ||
 476             wps_build_config_methods(ie, methods) ||
 477             wps_build_uuid_e(ie, uuid) ||
 478             wps_build_primary_dev_type(dev, ie) ||
 479             wps_build_rf_bands(dev, ie) ||
 480             wps_build_assoc_state(NULL, ie) ||
 481             wps_build_config_error(ie, WPS_CFG_NO_ERROR) ||
 482             wps_build_dev_password_id(ie, pbc ? DEV_PW_PUSHBUTTON :
 483                                       DEV_PW_DEFAULT) ||
 484 #ifdef CONFIG_WPS2
 485             wps_build_manufacturer(dev, ie) ||
 486             wps_build_model_name(dev, ie) ||
 487             wps_build_model_number(dev, ie) ||
 488             wps_build_dev_name(dev, ie) ||
 489             wps_build_wfa_ext(ie, req_type == WPS_REQ_ENROLLEE, NULL, 0) ||
 490 #endif /* CONFIG_WPS2 */
 491             wps_build_secondary_dev_type(dev, ie)
 492                 ) {
 493                 wpabuf_free(ie);
 494                 return NULL;
 495         }
 496
 497 #ifndef CONFIG_WPS2
 498         if (dev->p2p && wps_build_dev_name(dev, ie)) {
 499                 wpabuf_free(ie);
 500                 return NULL;
 501         }
 502 #endif /* CONFIG_WPS2 */
 503
 504         return wps_ie_encapsulate(ie);
 505 }
 506
 507
 508 void wps_free_pending_msgs(struct upnp_pending_message *msgs)
 509 {
 510         struct upnp_pending_message *p, *prev;
 511         p = msgs;
 512         while (p) {
 513                 prev = p;
 514                 p = p->next;
 515                 wpabuf_free(prev->msg);
 516                 os_free(prev);
 517         }
 518 }
 519
 520
 521 int wps_attr_text(struct wpabuf *data, char *buf, char *end)
 522 {
 523         struct wps_parse_attr attr;
 524         char *pos = buf;
 525         int ret;
 526
 527         if (wps_parse_msg(data, &attr) < 0)
 528                 return -1;
 529
 530         if (attr.wps_state) {
 531                 if (*attr.wps_state == WPS_STATE_NOT_CONFIGURED)
 532                         ret = os_snprintf(pos, end - pos,
 533                                           "wps_state=unconfigured\n");
 534                 else if (*attr.wps_state == WPS_STATE_CONFIGURED)
 535                         ret = os_snprintf(pos, end - pos,
 536                                           "wps_state=configured\n");
 537                 else
 538                         ret = 0;
 539                 if (ret < 0 || ret >= end - pos)
 540                         return pos - buf;
 541                 pos += ret;
 542         }
 543
 544         if (attr.ap_setup_locked && *attr.ap_setup_locked) {
 545                 ret = os_snprintf(pos, end - pos,
 546                                   "wps_ap_setup_locked=1\n");
 547                 if (ret < 0 || ret >= end - pos)
 548                         return pos - buf;
 549                 pos += ret;
 550         }
 551
 552         if (attr.selected_registrar && *attr.selected_registrar) {
 553                 ret = os_snprintf(pos, end - pos,
 554                                   "wps_selected_registrar=1\n");
 555                 if (ret < 0 || ret >= end - pos)
 556                         return pos - buf;
 557                 pos += ret;
 558         }
 559
 560         if (attr.dev_password_id) {
 561                 ret = os_snprintf(pos, end - pos,
 562                                   "wps_device_password_id=%u\n",
 563                                   WPA_GET_BE16(attr.dev_password_id));
 564                 if (ret < 0 || ret >= end - pos)
 565                         return pos - buf;
 566                 pos += ret;
 567         }
 568
 569         if (attr.sel_reg_config_methods) {
 570                 ret = os_snprintf(pos, end - pos,
 571                                   "wps_selected_registrar_config_methods="
 572                                   "0x%04x\n",
 573                                   WPA_GET_BE16(attr.sel_reg_config_methods));
 574                 if (ret < 0 || ret >= end - pos)
 575                         return pos - buf;
 576                 pos += ret;
 577         }
 578
 579         if (attr.primary_dev_type) {
 580                 char devtype[WPS_DEV_TYPE_BUFSIZE];
 581                 ret = os_snprintf(pos, end - pos,
 582                                   "wps_primary_device_type=%s\n",
 583                                   wps_dev_type_bin2str(attr.primary_dev_type,
 584                                                        devtype,
 585                                                        sizeof(devtype)));
 586                 if (ret < 0 || ret >= end - pos)
 587                         return pos - buf;
 588                 pos += ret;
 589         }
 590
 591         if (attr.dev_name) {
 592                 char *str = os_malloc(attr.dev_name_len + 1);
 593                 size_t i;
 594                 if (str == NULL)
 595                         return pos - buf;
 596                 for (i = 0; i < attr.dev_name_len; i++) {
 597                         if (attr.dev_name[i] < 32)
 598                                 str[i] = '_';
 599                         else
 600                                 str[i] = attr.dev_name[i];
 601                 }
 602                 str[i] = '\0';
 603                 ret = os_snprintf(pos, end - pos, "wps_device_name=%s\n", str);
 604                 os_free(str);
 605                 if (ret < 0 || ret >= end - pos)
 606                         return pos - buf;
 607                 pos += ret;
 608         }
 609
 610         if (attr.config_methods) {
 611                 ret = os_snprintf(pos, end - pos,
 612                                   "wps_config_methods=0x%04x\n",
 613                                   WPA_GET_BE16(attr.config_methods));
 614                 if (ret < 0 || ret >= end - pos)
 615                         return pos - buf;
 616                 pos += ret;
 617         }
 618
 619         return pos - buf;
 620 }