2 * Wi-Fi Protected Setup
3 * Copyright (c) 2007-2008, 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.
19 #include "wps_dev_attr.h"
20 #include "ieee802_11_defs.h"
24 * wps_init - Initialize WPS Registration protocol data
25 * @cfg: WPS configuration
26 * Returns: Pointer to allocated data or %NULL on failure
28 * This function is used to initialize WPS data for a registration protocol
29 * instance (i.e., each run of registration protocol as a Registrar of
30 * Enrollee. The caller is responsible for freeing this data after the
31 * registration run has been completed by calling wps_deinit().
33 struct wps_data * wps_init(const struct wps_config *cfg)
35 struct wps_data *data = os_zalloc(sizeof(*data));
39 data->registrar = cfg->registrar;
41 os_memcpy(data->uuid_r, cfg->wps->uuid, WPS_UUID_LEN);
43 os_memcpy(data->mac_addr_e, cfg->wps->dev.mac_addr, ETH_ALEN);
44 os_memcpy(data->uuid_e, cfg->wps->uuid, WPS_UUID_LEN);
47 data->dev_pw_id = DEV_PW_DEFAULT;
48 data->dev_password = os_malloc(cfg->pin_len);
49 if (data->dev_password == NULL) {
53 os_memcpy(data->dev_password, cfg->pin, cfg->pin_len);
54 data->dev_password_len = cfg->pin_len;
59 /* Use special PIN '00000000' for PBC */
60 data->dev_pw_id = DEV_PW_PUSHBUTTON;
61 os_free(data->dev_password);
62 data->dev_password = os_malloc(8);
63 if (data->dev_password == NULL) {
67 os_memset(data->dev_password, '0', 8);
68 data->dev_password_len = 8;
71 data->state = data->registrar ? RECV_M1 : SEND_M1;
73 if (cfg->assoc_wps_ie) {
74 struct wps_parse_attr attr;
75 wpa_hexdump_buf(MSG_DEBUG, "WPS: WPS IE from (Re)AssocReq",
77 if (wps_parse_msg(cfg->assoc_wps_ie, &attr) < 0) {
78 wpa_printf(MSG_DEBUG, "WPS: Failed to parse WPS IE "
80 } else if (attr.request_type == NULL) {
81 wpa_printf(MSG_DEBUG, "WPS: No Request Type attribute "
82 "in (Re)AssocReq WPS IE");
84 wpa_printf(MSG_DEBUG, "WPS: Request Type (from WPS IE "
85 "in (Re)AssocReq WPS IE): %d",
87 data->request_type = *attr.request_type;
96 * wps_deinit - Deinitialize WPS Registration protocol data
97 * @data: WPS Registration protocol data from wps_init()
99 void wps_deinit(struct wps_data *data)
101 if (data->wps_pin_revealed) {
102 wpa_printf(MSG_DEBUG, "WPS: Full PIN information revealed and "
103 "negotiation failed");
105 wps_registrar_invalidate_pin(data->registrar,
107 } else if (data->registrar)
108 wps_registrar_unlock_pin(data->registrar, data->uuid_e);
110 wpabuf_free(data->dh_privkey);
111 wpabuf_free(data->dh_pubkey_e);
112 wpabuf_free(data->dh_pubkey_r);
113 wpabuf_free(data->last_msg);
114 os_free(data->dev_password);
115 os_free(data->new_psk);
116 wps_device_data_free(&data->peer_dev);
122 * wps_process_msg - Process a WPS message
123 * @wps: WPS Registration protocol data from wps_init()
124 * @op_code: Message OP Code
126 * Returns: Processing result
128 * This function is used to process WPS messages with OP Codes WSC_ACK,
129 * WSC_NACK, WSC_MSG, and WSC_Done. The caller (e.g., EAP server/peer) is
130 * responsible for reassembling the messages before calling this function.
131 * Response to this message is built by calling wps_get_msg().
133 enum wps_process_res wps_process_msg(struct wps_data *wps,
134 enum wsc_op_code op_code,
135 const struct wpabuf *msg)
138 return wps_registrar_process_msg(wps, op_code, msg);
140 return wps_enrollee_process_msg(wps, op_code, msg);
145 * wps_get_msg - Build a WPS message
146 * @wps: WPS Registration protocol data from wps_init()
147 * @op_code: Buffer for returning message OP Code
148 * Returns: The generated WPS message or %NULL on failure
150 * This function is used to build a response to a message processed by calling
151 * wps_process_msg(). The caller is responsible for freeing the buffer.
153 struct wpabuf * wps_get_msg(struct wps_data *wps, enum wsc_op_code *op_code)
156 return wps_registrar_get_msg(wps, op_code);
158 return wps_enrollee_get_msg(wps, op_code);
163 * wps_is_selected_pbc_registrar - Check whether WPS IE indicates active PBC
164 * @msg: WPS IE contents from Beacon or Probe Response frame
165 * Returns: 1 if PBC Registrar is active, 0 if not
167 int wps_is_selected_pbc_registrar(const struct wpabuf *msg)
169 struct wps_parse_attr attr;
172 * In theory, this could also verify that attr.sel_reg_config_methods
173 * includes WPS_CONFIG_PUSHBUTTON, but some deployed AP implementations
174 * do not set Selected Registrar Config Methods attribute properly, so
175 * it is safer to just use Device Password ID here.
178 if (wps_parse_msg(msg, &attr) < 0 ||
179 !attr.selected_registrar || *attr.selected_registrar == 0 ||
180 !attr.dev_password_id ||
181 WPA_GET_BE16(attr.dev_password_id) != DEV_PW_PUSHBUTTON)
189 * wps_is_selected_pbc_registrar - Check whether WPS IE indicates active PIN
190 * @msg: WPS IE contents from Beacon or Probe Response frame
191 * Returns: 1 if PIN Registrar is active, 0 if not
193 int wps_is_selected_pin_registrar(const struct wpabuf *msg)
195 struct wps_parse_attr attr;
198 * In theory, this could also verify that attr.sel_reg_config_methods
199 * includes WPS_CONFIG_LABEL, WPS_CONFIG_DISPLAY, or WPS_CONFIG_KEYPAD,
200 * but some deployed AP implementations do not set Selected Registrar
201 * Config Methods attribute properly, so it is safer to just use
202 * Device Password ID here.
205 if (wps_parse_msg(msg, &attr) < 0 ||
206 !attr.selected_registrar || *attr.selected_registrar == 0 ||
207 !attr.dev_password_id ||
208 WPA_GET_BE16(attr.dev_password_id) == DEV_PW_PUSHBUTTON)
216 * wps_get_uuid_e - Get UUID-E from WPS IE
217 * @msg: WPS IE contents from Beacon or Probe Response frame
218 * Returns: Pointer to UUID-E or %NULL if not included
220 * The returned pointer is to the msg contents and it remains valid only as
221 * long as the msg buffer is valid.
223 const u8 * wps_get_uuid_e(const struct wpabuf *msg)
225 struct wps_parse_attr attr;
227 if (wps_parse_msg(msg, &attr) < 0)
234 * wps_build_assoc_req_ie - Build WPS IE for (Re)Association Request
235 * @req_type: Value for Request Type attribute
236 * Returns: WPS IE or %NULL on failure
238 * The caller is responsible for freeing the buffer.
240 struct wpabuf * wps_build_assoc_req_ie(enum wps_request_type req_type)
245 wpa_printf(MSG_DEBUG, "WPS: Building WPS IE for (Re)Association "
247 ie = wpabuf_alloc(100);
251 wpabuf_put_u8(ie, WLAN_EID_VENDOR_SPECIFIC);
252 len = wpabuf_put(ie, 1);
253 wpabuf_put_be32(ie, WPS_DEV_OUI_WFA);
255 if (wps_build_version(ie) ||
256 wps_build_req_type(ie, req_type)) {
261 *len = wpabuf_len(ie) - 2;
268 * wps_build_probe_req_ie - Build WPS IE for Probe Request
269 * @pbc: Whether searching for PBC mode APs
270 * @dev: Device attributes
272 * @req_type: Value for Request Type attribute
273 * Returns: WPS IE or %NULL on failure
275 * The caller is responsible for freeing the buffer.
277 struct wpabuf * wps_build_probe_req_ie(int pbc, struct wps_device_data *dev,
279 enum wps_request_type req_type)
285 wpa_printf(MSG_DEBUG, "WPS: Building WPS IE for Probe Request");
287 ie = wpabuf_alloc(200);
291 wpabuf_put_u8(ie, WLAN_EID_VENDOR_SPECIFIC);
292 len = wpabuf_put(ie, 1);
293 wpabuf_put_be32(ie, WPS_DEV_OUI_WFA);
296 methods = WPS_CONFIG_PUSHBUTTON;
298 methods = WPS_CONFIG_LABEL | WPS_CONFIG_DISPLAY |
301 if (wps_build_version(ie) ||
302 wps_build_req_type(ie, req_type) ||
303 wps_build_config_methods(ie, methods) ||
304 wps_build_uuid_e(ie, uuid) ||
305 wps_build_primary_dev_type(dev, ie) ||
306 wps_build_rf_bands(dev, ie) ||
307 wps_build_assoc_state(NULL, ie) ||
308 wps_build_config_error(ie, WPS_CFG_NO_ERROR) ||
309 wps_build_dev_password_id(ie, pbc ? DEV_PW_PUSHBUTTON :
315 *len = wpabuf_len(ie) - 2;