2 * Wi-Fi Protected Setup
3 * Copyright (c) 2007-2009, 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.
18 #include "crypto/dh_group5.h"
19 #include "common/ieee802_11_defs.h"
21 #include "wps_dev_attr.h"
25 * wps_init - Initialize WPS Registration protocol data
26 * @cfg: WPS configuration
27 * Returns: Pointer to allocated data or %NULL on failure
29 * This function is used to initialize WPS data for a registration protocol
30 * instance (i.e., each run of registration protocol as a Registrar of
31 * Enrollee. The caller is responsible for freeing this data after the
32 * registration run has been completed by calling wps_deinit().
34 struct wps_data
* wps_init(const struct wps_config
*cfg
)
36 struct wps_data
*data
= os_zalloc(sizeof(*data
));
40 data
->registrar
= cfg
->registrar
;
42 os_memcpy(data
->uuid_r
, cfg
->wps
->uuid
, WPS_UUID_LEN
);
44 os_memcpy(data
->mac_addr_e
, cfg
->wps
->dev
.mac_addr
, ETH_ALEN
);
45 os_memcpy(data
->uuid_e
, cfg
->wps
->uuid
, WPS_UUID_LEN
);
48 data
->dev_pw_id
= data
->wps
->oob_dev_pw_id
== 0 ?
49 DEV_PW_DEFAULT
: data
->wps
->oob_dev_pw_id
;
50 data
->dev_password
= os_malloc(cfg
->pin_len
);
51 if (data
->dev_password
== NULL
) {
55 os_memcpy(data
->dev_password
, cfg
->pin
, cfg
->pin_len
);
56 data
->dev_password_len
= cfg
->pin_len
;
61 /* Use special PIN '00000000' for PBC */
62 data
->dev_pw_id
= DEV_PW_PUSHBUTTON
;
63 os_free(data
->dev_password
);
64 data
->dev_password
= os_malloc(8);
65 if (data
->dev_password
== NULL
) {
69 os_memset(data
->dev_password
, '0', 8);
70 data
->dev_password_len
= 8;
73 data
->state
= data
->registrar
? RECV_M1
: SEND_M1
;
75 if (cfg
->assoc_wps_ie
) {
76 struct wps_parse_attr attr
;
77 wpa_hexdump_buf(MSG_DEBUG
, "WPS: WPS IE from (Re)AssocReq",
79 if (wps_parse_msg(cfg
->assoc_wps_ie
, &attr
) < 0) {
80 wpa_printf(MSG_DEBUG
, "WPS: Failed to parse WPS IE "
82 } else if (attr
.request_type
== NULL
) {
83 wpa_printf(MSG_DEBUG
, "WPS: No Request Type attribute "
84 "in (Re)AssocReq WPS IE");
86 wpa_printf(MSG_DEBUG
, "WPS: Request Type (from WPS IE "
87 "in (Re)AssocReq WPS IE): %d",
89 data
->request_type
= *attr
.request_type
;
93 if (cfg
->new_ap_settings
) {
94 data
->new_ap_settings
=
95 os_malloc(sizeof(*data
->new_ap_settings
));
96 if (data
->new_ap_settings
== NULL
) {
100 os_memcpy(data
->new_ap_settings
, cfg
->new_ap_settings
,
101 sizeof(*data
->new_ap_settings
));
105 os_memcpy(data
->peer_dev
.mac_addr
, cfg
->peer_addr
, ETH_ALEN
);
107 data
->use_psk_key
= cfg
->use_psk_key
;
114 * wps_deinit - Deinitialize WPS Registration protocol data
115 * @data: WPS Registration protocol data from wps_init()
117 void wps_deinit(struct wps_data
*data
)
119 if (data
->wps_pin_revealed
) {
120 wpa_printf(MSG_DEBUG
, "WPS: Full PIN information revealed and "
121 "negotiation failed");
123 wps_registrar_invalidate_pin(data
->wps
->registrar
,
125 } else if (data
->registrar
)
126 wps_registrar_unlock_pin(data
->wps
->registrar
, data
->uuid_e
);
128 wpabuf_free(data
->dh_privkey
);
129 wpabuf_free(data
->dh_pubkey_e
);
130 wpabuf_free(data
->dh_pubkey_r
);
131 wpabuf_free(data
->last_msg
);
132 os_free(data
->dev_password
);
133 os_free(data
->new_psk
);
134 wps_device_data_free(&data
->peer_dev
);
135 os_free(data
->new_ap_settings
);
136 dh5_free(data
->dh_ctx
);
142 * wps_process_msg - Process a WPS message
143 * @wps: WPS Registration protocol data from wps_init()
144 * @op_code: Message OP Code
146 * Returns: Processing result
148 * This function is used to process WPS messages with OP Codes WSC_ACK,
149 * WSC_NACK, WSC_MSG, and WSC_Done. The caller (e.g., EAP server/peer) is
150 * responsible for reassembling the messages before calling this function.
151 * Response to this message is built by calling wps_get_msg().
153 enum wps_process_res
wps_process_msg(struct wps_data
*wps
,
154 enum wsc_op_code op_code
,
155 const struct wpabuf
*msg
)
158 return wps_registrar_process_msg(wps
, op_code
, msg
);
160 return wps_enrollee_process_msg(wps
, op_code
, msg
);
165 * wps_get_msg - Build a WPS message
166 * @wps: WPS Registration protocol data from wps_init()
167 * @op_code: Buffer for returning message OP Code
168 * Returns: The generated WPS message or %NULL on failure
170 * This function is used to build a response to a message processed by calling
171 * wps_process_msg(). The caller is responsible for freeing the buffer.
173 struct wpabuf
* wps_get_msg(struct wps_data
*wps
, enum wsc_op_code
*op_code
)
176 return wps_registrar_get_msg(wps
, op_code
);
178 return wps_enrollee_get_msg(wps
, op_code
);
183 * wps_is_selected_pbc_registrar - Check whether WPS IE indicates active PBC
184 * @msg: WPS IE contents from Beacon or Probe Response frame
185 * Returns: 1 if PBC Registrar is active, 0 if not
187 int wps_is_selected_pbc_registrar(const struct wpabuf
*msg
)
189 struct wps_parse_attr attr
;
192 * In theory, this could also verify that attr.sel_reg_config_methods
193 * includes WPS_CONFIG_PUSHBUTTON, but some deployed AP implementations
194 * do not set Selected Registrar Config Methods attribute properly, so
195 * it is safer to just use Device Password ID here.
198 if (wps_parse_msg(msg
, &attr
) < 0 ||
199 !attr
.selected_registrar
|| *attr
.selected_registrar
== 0 ||
200 !attr
.dev_password_id
||
201 WPA_GET_BE16(attr
.dev_password_id
) != DEV_PW_PUSHBUTTON
)
208 static int is_selected_pin_registrar(struct wps_parse_attr
*attr
)
211 * In theory, this could also verify that attr.sel_reg_config_methods
212 * includes WPS_CONFIG_LABEL, WPS_CONFIG_DISPLAY, or WPS_CONFIG_KEYPAD,
213 * but some deployed AP implementations do not set Selected Registrar
214 * Config Methods attribute properly, so it is safer to just use
215 * Device Password ID here.
218 if (!attr
->selected_registrar
|| *attr
->selected_registrar
== 0)
221 if (attr
->dev_password_id
!= NULL
&&
222 WPA_GET_BE16(attr
->dev_password_id
) == DEV_PW_PUSHBUTTON
)
230 * wps_is_selected_pin_registrar - Check whether WPS IE indicates active PIN
231 * @msg: WPS IE contents from Beacon or Probe Response frame
232 * Returns: 1 if PIN Registrar is active, 0 if not
234 int wps_is_selected_pin_registrar(const struct wpabuf
*msg
)
236 struct wps_parse_attr attr
;
238 if (wps_parse_msg(msg
, &attr
) < 0)
241 return is_selected_pin_registrar(&attr
);
246 * wps_is_addr_authorized - Check whether WPS IE authorizes MAC address
247 * @msg: WPS IE contents from Beacon or Probe Response frame
248 * @addr: MAC address to search for
249 * @ver1_compat: Whether to use version 1 compatibility mode
250 * Returns: 1 if address is authorized, 0 if not
252 int wps_is_addr_authorized(const struct wpabuf
*msg
, const u8
*addr
,
255 struct wps_parse_attr attr
;
259 if (wps_parse_msg(msg
, &attr
) < 0)
262 if (!attr
.version2
&& ver1_compat
) {
264 * Version 1.0 AP - AuthorizedMACs not used, so revert back to
265 * old mechanism of using SelectedRegistrar.
267 return is_selected_pin_registrar(&attr
);
270 if (!attr
.authorized_macs
)
273 pos
= attr
.authorized_macs
;
274 for (i
= 0; i
< attr
.authorized_macs_len
/ ETH_ALEN
; i
++) {
275 if (os_memcmp(pos
, addr
, ETH_ALEN
) == 0)
285 * wps_ap_priority_compar - Prioritize WPS IE from two APs
286 * @wps_a: WPS IE contents from Beacon or Probe Response frame
287 * @wps_b: WPS IE contents from Beacon or Probe Response frame
288 * Returns: 1 if wps_b is considered more likely selection for WPS
289 * provisioning, -1 if wps_a is considered more like, or 0 if no preference
291 int wps_ap_priority_compar(const struct wpabuf
*wps_a
,
292 const struct wpabuf
*wps_b
)
294 struct wps_parse_attr attr_a
, attr_b
;
297 if (wps_a
== NULL
|| wps_parse_msg(wps_a
, &attr_a
) < 0)
299 if (wps_b
== NULL
|| wps_parse_msg(wps_b
, &attr_b
) < 0)
302 sel_a
= attr_a
.selected_registrar
&& *attr_a
.selected_registrar
!= 0;
303 sel_b
= attr_b
.selected_registrar
&& *attr_b
.selected_registrar
!= 0;
315 * wps_get_uuid_e - Get UUID-E from WPS IE
316 * @msg: WPS IE contents from Beacon or Probe Response frame
317 * Returns: Pointer to UUID-E or %NULL if not included
319 * The returned pointer is to the msg contents and it remains valid only as
320 * long as the msg buffer is valid.
322 const u8
* wps_get_uuid_e(const struct wpabuf
*msg
)
324 struct wps_parse_attr attr
;
326 if (wps_parse_msg(msg
, &attr
) < 0)
333 * wps_build_assoc_req_ie - Build WPS IE for (Re)Association Request
334 * @req_type: Value for Request Type attribute
335 * Returns: WPS IE or %NULL on failure
337 * The caller is responsible for freeing the buffer.
339 struct wpabuf
* wps_build_assoc_req_ie(enum wps_request_type req_type
)
344 wpa_printf(MSG_DEBUG
, "WPS: Building WPS IE for (Re)Association "
346 ie
= wpabuf_alloc(100);
350 wpabuf_put_u8(ie
, WLAN_EID_VENDOR_SPECIFIC
);
351 len
= wpabuf_put(ie
, 1);
352 wpabuf_put_be32(ie
, WPS_DEV_OUI_WFA
);
354 if (wps_build_version(ie
) ||
355 wps_build_req_type(ie
, req_type
) ||
356 wps_build_version2(ie
)) {
361 *len
= wpabuf_len(ie
) - 2;
368 * wps_build_assoc_resp_ie - Build WPS IE for (Re)Association Response
369 * Returns: WPS IE or %NULL on failure
371 * The caller is responsible for freeing the buffer.
373 struct wpabuf
* wps_build_assoc_resp_ie(void)
378 wpa_printf(MSG_DEBUG
, "WPS: Building WPS IE for (Re)Association "
380 ie
= wpabuf_alloc(100);
384 wpabuf_put_u8(ie
, WLAN_EID_VENDOR_SPECIFIC
);
385 len
= wpabuf_put(ie
, 1);
386 wpabuf_put_be32(ie
, WPS_DEV_OUI_WFA
);
388 if (wps_build_version(ie
) ||
389 wps_build_resp_type(ie
, WPS_RESP_AP
) ||
390 wps_build_version2(ie
)) {
395 *len
= wpabuf_len(ie
) - 2;
402 * wps_build_probe_req_ie - Build WPS IE for Probe Request
403 * @pbc: Whether searching for PBC mode APs
404 * @dev: Device attributes
406 * @req_type: Value for Request Type attribute
407 * Returns: WPS IE or %NULL on failure
409 * The caller is responsible for freeing the buffer.
411 struct wpabuf
* wps_build_probe_req_ie(int pbc
, struct wps_device_data
*dev
,
413 enum wps_request_type req_type
)
419 wpa_printf(MSG_DEBUG
, "WPS: Building WPS IE for Probe Request");
421 ie
= wpabuf_alloc(200);
425 wpabuf_put_u8(ie
, WLAN_EID_VENDOR_SPECIFIC
);
426 len
= wpabuf_put(ie
, 1);
427 wpabuf_put_be32(ie
, WPS_DEV_OUI_WFA
);
430 methods
= WPS_CONFIG_PUSHBUTTON
;
432 methods
= WPS_CONFIG_LABEL
| WPS_CONFIG_DISPLAY
|
434 #ifdef CONFIG_WPS_UFD
435 methods
|= WPS_CONFIG_USBA
;
436 #endif /* CONFIG_WPS_UFD */
437 #ifdef CONFIG_WPS_NFC
438 methods
|= WPS_CONFIG_NFC_INTERFACE
;
439 #endif /* CONFIG_WPS_NFC */
442 if (wps_build_version(ie
) ||
443 wps_build_req_type(ie
, req_type
) ||
444 wps_build_config_methods(ie
, methods
) ||
445 wps_build_uuid_e(ie
, uuid
) ||
446 wps_build_primary_dev_type(dev
, ie
) ||
447 wps_build_rf_bands(dev
, ie
) ||
448 wps_build_assoc_state(NULL
, ie
) ||
449 wps_build_config_error(ie
, WPS_CFG_NO_ERROR
) ||
450 wps_build_dev_password_id(ie
, pbc
? DEV_PW_PUSHBUTTON
:
452 wps_build_version2(ie
) ||
453 (req_type
== WPS_REQ_ENROLLEE
&&
454 wps_build_req_to_enroll(ie
))) {
459 *len
= wpabuf_len(ie
) - 2;
465 void wps_free_pending_msgs(struct upnp_pending_message
*msgs
)
467 struct upnp_pending_message
*p
, *prev
;
472 wpabuf_free(prev
->msg
);
478 int wps_attr_text(struct wpabuf
*data
, char *buf
, char *end
)
480 struct wps_parse_attr attr
;
484 if (wps_parse_msg(data
, &attr
) < 0)
487 if (attr
.wps_state
) {
488 if (*attr
.wps_state
== WPS_STATE_NOT_CONFIGURED
)
489 ret
= os_snprintf(pos
, end
- pos
,
490 "wps_state=unconfigured\n");
491 else if (*attr
.wps_state
== WPS_STATE_CONFIGURED
)
492 ret
= os_snprintf(pos
, end
- pos
,
493 "wps_state=configured\n");
496 if (ret
< 0 || ret
>= end
- pos
)
501 if (attr
.ap_setup_locked
&& *attr
.ap_setup_locked
) {
502 ret
= os_snprintf(pos
, end
- pos
,
503 "wps_ap_setup_locked=1\n");
504 if (ret
< 0 || ret
>= end
- pos
)
509 if (attr
.selected_registrar
&& *attr
.selected_registrar
) {
510 ret
= os_snprintf(pos
, end
- pos
,
511 "wps_selected_registrar=1\n");
512 if (ret
< 0 || ret
>= end
- pos
)
517 if (attr
.dev_password_id
) {
518 ret
= os_snprintf(pos
, end
- pos
,
519 "wps_device_password_id=%u\n",
520 WPA_GET_BE16(attr
.dev_password_id
));
521 if (ret
< 0 || ret
>= end
- pos
)
526 if (attr
.sel_reg_config_methods
) {
527 ret
= os_snprintf(pos
, end
- pos
,
528 "wps_selected_registrar_config_methods="
530 WPA_GET_BE16(attr
.sel_reg_config_methods
));
531 if (ret
< 0 || ret
>= end
- pos
)
536 if (attr
.primary_dev_type
) {
537 char devtype
[WPS_DEV_TYPE_BUFSIZE
];
538 ret
= os_snprintf(pos
, end
- pos
,
539 "wps_primary_device_type=%s\n",
540 wps_dev_type_bin2str(attr
.primary_dev_type
,
543 if (ret
< 0 || ret
>= end
- pos
)
549 char *str
= os_malloc(attr
.dev_name_len
+ 1);
553 for (i
= 0; i
< attr
.dev_name_len
; i
++) {
554 if (attr
.dev_name
[i
] < 32)
557 str
[i
] = attr
.dev_name
[i
];
560 ret
= os_snprintf(pos
, end
- pos
, "wps_device_name=%s\n", str
);
562 if (ret
< 0 || ret
>= end
- pos
)
567 if (attr
.config_methods
) {
568 ret
= os_snprintf(pos
, end
- pos
,
569 "wps_config_methods=0x%04x\n",
570 WPA_GET_BE16(attr
.config_methods
));
571 if (ret
< 0 || ret
>= end
- pos
)