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)
209 * wps_is_selected_pin_registrar - Check whether WPS IE indicates active PIN
210 * @msg: WPS IE contents from Beacon or Probe Response frame
211 * Returns: 1 if PIN Registrar is active, 0 if not
213 int wps_is_selected_pin_registrar(const struct wpabuf *msg)
215 struct wps_parse_attr attr;
218 * In theory, this could also verify that attr.sel_reg_config_methods
219 * includes WPS_CONFIG_LABEL, WPS_CONFIG_DISPLAY, or WPS_CONFIG_KEYPAD,
220 * but some deployed AP implementations do not set Selected Registrar
221 * Config Methods attribute properly, so it is safer to just use
222 * Device Password ID here.
225 if (wps_parse_msg(msg, &attr) < 0)
228 if (!attr.selected_registrar || *attr.selected_registrar == 0)
231 if (attr.dev_password_id != NULL &&
232 WPA_GET_BE16(attr.dev_password_id) == DEV_PW_PUSHBUTTON)
240 * wps_get_uuid_e - Get UUID-E from WPS IE
241 * @msg: WPS IE contents from Beacon or Probe Response frame
242 * Returns: Pointer to UUID-E or %NULL if not included
244 * The returned pointer is to the msg contents and it remains valid only as
245 * long as the msg buffer is valid.
247 const u8 * wps_get_uuid_e(const struct wpabuf *msg)
249 struct wps_parse_attr attr;
251 if (wps_parse_msg(msg, &attr) < 0)
258 * wps_build_assoc_req_ie - Build WPS IE for (Re)Association Request
259 * @req_type: Value for Request Type attribute
260 * Returns: WPS IE or %NULL on failure
262 * The caller is responsible for freeing the buffer.
264 struct wpabuf * wps_build_assoc_req_ie(enum wps_request_type req_type)
269 wpa_printf(MSG_DEBUG, "WPS: Building WPS IE for (Re)Association "
271 ie = wpabuf_alloc(100);
275 wpabuf_put_u8(ie, WLAN_EID_VENDOR_SPECIFIC);
276 len = wpabuf_put(ie, 1);
277 wpabuf_put_be32(ie, WPS_DEV_OUI_WFA);
279 if (wps_build_version(ie) ||
280 wps_build_req_type(ie, req_type)) {
285 *len = wpabuf_len(ie) - 2;
292 * wps_build_assoc_resp_ie - Build WPS IE for (Re)Association Response
293 * Returns: WPS IE or %NULL on failure
295 * The caller is responsible for freeing the buffer.
297 struct wpabuf * wps_build_assoc_resp_ie(void)
302 wpa_printf(MSG_DEBUG, "WPS: Building WPS IE for (Re)Association "
304 ie = wpabuf_alloc(100);
308 wpabuf_put_u8(ie, WLAN_EID_VENDOR_SPECIFIC);
309 len = wpabuf_put(ie, 1);
310 wpabuf_put_be32(ie, WPS_DEV_OUI_WFA);
312 if (wps_build_version(ie) ||
313 wps_build_resp_type(ie, WPS_RESP_AP)) {
318 *len = wpabuf_len(ie) - 2;
325 * wps_build_probe_req_ie - Build WPS IE for Probe Request
326 * @pbc: Whether searching for PBC mode APs
327 * @dev: Device attributes
329 * @req_type: Value for Request Type attribute
330 * Returns: WPS IE or %NULL on failure
332 * The caller is responsible for freeing the buffer.
334 struct wpabuf * wps_build_probe_req_ie(int pbc, struct wps_device_data *dev,
336 enum wps_request_type req_type)
342 wpa_printf(MSG_DEBUG, "WPS: Building WPS IE for Probe Request");
344 ie = wpabuf_alloc(200);
348 wpabuf_put_u8(ie, WLAN_EID_VENDOR_SPECIFIC);
349 len = wpabuf_put(ie, 1);
350 wpabuf_put_be32(ie, WPS_DEV_OUI_WFA);
353 methods = WPS_CONFIG_PUSHBUTTON;
355 methods = WPS_CONFIG_LABEL | WPS_CONFIG_DISPLAY |
357 #ifdef CONFIG_WPS_UFD
358 methods |= WPS_CONFIG_USBA;
359 #endif /* CONFIG_WPS_UFD */
360 #ifdef CONFIG_WPS_NFC
361 methods |= WPS_CONFIG_NFC_INTERFACE;
362 #endif /* CONFIG_WPS_NFC */
365 if (wps_build_version(ie) ||
366 wps_build_req_type(ie, req_type) ||
367 wps_build_config_methods(ie, methods) ||
368 wps_build_uuid_e(ie, uuid) ||
369 wps_build_primary_dev_type(dev, ie) ||
370 wps_build_rf_bands(dev, ie) ||
371 wps_build_assoc_state(NULL, ie) ||
372 wps_build_config_error(ie, WPS_CFG_NO_ERROR) ||
373 wps_build_dev_password_id(ie, pbc ? DEV_PW_PUSHBUTTON :
379 *len = wpabuf_len(ie) - 2;
385 void wps_free_pending_msgs(struct upnp_pending_message *msgs)
387 struct upnp_pending_message *p, *prev;
392 wpabuf_free(prev->msg);
398 int wps_attr_text(struct wpabuf *data, char *buf, char *end)
400 struct wps_parse_attr attr;
404 if (wps_parse_msg(data, &attr) < 0)
407 if (attr.wps_state) {
408 if (*attr.wps_state == WPS_STATE_NOT_CONFIGURED)
409 ret = os_snprintf(pos, end - pos,
410 "wps_state=unconfigured\n");
411 else if (*attr.wps_state == WPS_STATE_CONFIGURED)
412 ret = os_snprintf(pos, end - pos,
413 "wps_state=configured\n");
416 if (ret < 0 || ret >= end - pos)
421 if (attr.ap_setup_locked && *attr.ap_setup_locked) {
422 ret = os_snprintf(pos, end - pos,
423 "wps_ap_setup_locked=1\n");
424 if (ret < 0 || ret >= end - pos)
429 if (attr.selected_registrar && *attr.selected_registrar) {
430 ret = os_snprintf(pos, end - pos,
431 "wps_selected_registrar=1\n");
432 if (ret < 0 || ret >= end - pos)
437 if (attr.dev_password_id) {
438 ret = os_snprintf(pos, end - pos,
439 "wps_device_password_id=%u\n",
440 WPA_GET_BE16(attr.dev_password_id));
441 if (ret < 0 || ret >= end - pos)
446 if (attr.sel_reg_config_methods) {
447 ret = os_snprintf(pos, end - pos,
448 "wps_selected_registrar_config_methods="
450 WPA_GET_BE16(attr.sel_reg_config_methods));
451 if (ret < 0 || ret >= end - pos)
456 if (attr.primary_dev_type) {
457 char devtype[WPS_DEV_TYPE_BUFSIZE];
458 ret = os_snprintf(pos, end - pos,
459 "wps_primary_device_type=%s\n",
460 wps_dev_type_bin2str(attr.primary_dev_type,
463 if (ret < 0 || ret >= end - pos)
469 char *str = os_malloc(attr.dev_name_len + 1);
473 for (i = 0; i < attr.dev_name_len; i++) {
474 if (attr.dev_name[i] < 32)
477 str[i] = attr.dev_name[i];
480 ret = os_snprintf(pos, end - pos, "wps_device_name=%s\n", str);
482 if (ret < 0 || ret >= end - pos)
487 if (attr.config_methods) {
488 ret = os_snprintf(pos, end - pos,
489 "wps_config_methods=0x%04x\n",
490 WPA_GET_BE16(attr.config_methods));
491 if (ret < 0 || ret >= end - pos)