2 * WPA Supplicant / dbus-based control interface (WPS)
3 * Copyright (c) 2006, Dan Williams <dcbw@redhat.com> and Red Hat, Inc.
4 * Copyright (c) 2009, Witold Sowa <witold.sowa@gmail.com>
6 * This software may be distributed under the terms of the BSD license.
7 * See README for more details.
13 #include "../config.h"
14 #include "../wpa_supplicant_i.h"
15 #include "../wps_supplicant.h"
16 #include "../driver_i.h"
18 #include "dbus_new_helpers.h"
20 #include "dbus_new_handlers.h"
21 #include "dbus_dict_helpers.h"
24 struct wps_start_params {
25 int role; /* 0 - not set, 1 - enrollee, 2 - registrar */
26 int type; /* 0 - not set, 1 - pin, 2 - pbc */
33 static int wpas_dbus_handler_wps_role(DBusMessage *message,
34 DBusMessageIter *entry_iter,
35 struct wps_start_params *params,
38 DBusMessageIter variant_iter;
41 dbus_message_iter_recurse(entry_iter, &variant_iter);
42 if (dbus_message_iter_get_arg_type(&variant_iter) !=
45 "dbus: WPS.Start - Wrong Role type, string required");
46 *reply = wpas_dbus_error_invalid_args(message,
47 "Role must be a string");
50 dbus_message_iter_get_basic(&variant_iter, &val);
51 if (os_strcmp(val, "enrollee") == 0)
53 else if (os_strcmp(val, "registrar") == 0)
56 wpa_printf(MSG_DEBUG, "dbus: WPS.Start - Unknown role %s", val);
57 *reply = wpas_dbus_error_invalid_args(message, val);
64 static int wpas_dbus_handler_wps_type(DBusMessage *message,
65 DBusMessageIter *entry_iter,
66 struct wps_start_params *params,
69 DBusMessageIter variant_iter;
72 dbus_message_iter_recurse(entry_iter, &variant_iter);
73 if (dbus_message_iter_get_arg_type(&variant_iter) != DBUS_TYPE_STRING) {
75 "dbus: WPS.Start - Wrong Type type, string required");
76 *reply = wpas_dbus_error_invalid_args(message,
77 "Type must be a string");
80 dbus_message_iter_get_basic(&variant_iter, &val);
81 if (os_strcmp(val, "pin") == 0)
83 else if (os_strcmp(val, "pbc") == 0)
86 wpa_printf(MSG_DEBUG, "dbus: WPS.Start - Unknown type %s",
88 *reply = wpas_dbus_error_invalid_args(message, val);
95 static int wpas_dbus_handler_wps_bssid(DBusMessage *message,
96 DBusMessageIter *entry_iter,
97 struct wps_start_params *params,
100 DBusMessageIter variant_iter, array_iter;
103 dbus_message_iter_recurse(entry_iter, &variant_iter);
104 if (dbus_message_iter_get_arg_type(&variant_iter) != DBUS_TYPE_ARRAY ||
105 dbus_message_iter_get_element_type(&variant_iter) !=
107 wpa_printf(MSG_DEBUG,
108 "dbus: WPS.Start - Wrong Bssid type, byte array required");
109 *reply = wpas_dbus_error_invalid_args(
110 message, "Bssid must be a byte array");
113 dbus_message_iter_recurse(&variant_iter, &array_iter);
114 dbus_message_iter_get_fixed_array(&array_iter, ¶ms->bssid, &len);
115 if (len != ETH_ALEN) {
116 wpa_printf(MSG_DEBUG, "dbus: WPS.Start - Wrong Bssid length %d",
118 *reply = wpas_dbus_error_invalid_args(message,
119 "Bssid is wrong length");
126 static int wpas_dbus_handler_wps_pin(DBusMessage *message,
127 DBusMessageIter *entry_iter,
128 struct wps_start_params *params,
131 DBusMessageIter variant_iter;
133 dbus_message_iter_recurse(entry_iter, &variant_iter);
134 if (dbus_message_iter_get_arg_type(&variant_iter) != DBUS_TYPE_STRING) {
135 wpa_printf(MSG_DEBUG,
136 "dbus: WPS.Start - Wrong Pin type, string required");
137 *reply = wpas_dbus_error_invalid_args(message,
138 "Pin must be a string");
141 dbus_message_iter_get_basic(&variant_iter, ¶ms->pin);
147 static int wpas_dbus_handler_wps_p2p_dev_addr(DBusMessage *message,
148 DBusMessageIter *entry_iter,
149 struct wps_start_params *params,
152 DBusMessageIter variant_iter, array_iter;
155 dbus_message_iter_recurse(entry_iter, &variant_iter);
156 if (dbus_message_iter_get_arg_type(&variant_iter) != DBUS_TYPE_ARRAY ||
157 dbus_message_iter_get_element_type(&variant_iter) !=
159 wpa_printf(MSG_DEBUG,
160 "dbus: WPS.Start - Wrong P2PDeviceAddress type, byte array required");
161 *reply = wpas_dbus_error_invalid_args(
162 message, "P2PDeviceAddress must be a byte array");
165 dbus_message_iter_recurse(&variant_iter, &array_iter);
166 dbus_message_iter_get_fixed_array(&array_iter, ¶ms->p2p_dev_addr,
168 if (len != ETH_ALEN) {
169 wpa_printf(MSG_DEBUG,
170 "dbus: WPS.Start - Wrong P2PDeviceAddress length %d",
172 *reply = wpas_dbus_error_invalid_args(
173 message, "P2PDeviceAddress has wrong length");
178 #endif /* CONFIG_P2P */
181 static int wpas_dbus_handler_wps_start_entry(DBusMessage *message, char *key,
182 DBusMessageIter *entry_iter,
183 struct wps_start_params *params,
186 if (os_strcmp(key, "Role") == 0)
187 return wpas_dbus_handler_wps_role(message, entry_iter,
189 else if (os_strcmp(key, "Type") == 0)
190 return wpas_dbus_handler_wps_type(message, entry_iter,
192 else if (os_strcmp(key, "Bssid") == 0)
193 return wpas_dbus_handler_wps_bssid(message, entry_iter,
195 else if (os_strcmp(key, "Pin") == 0)
196 return wpas_dbus_handler_wps_pin(message, entry_iter,
199 else if (os_strcmp(key, "P2PDeviceAddress") == 0)
200 return wpas_dbus_handler_wps_p2p_dev_addr(message, entry_iter,
202 #endif /* CONFIG_P2P */
204 wpa_printf(MSG_DEBUG, "dbus: WPS.Start - unknown key %s", key);
205 *reply = wpas_dbus_error_invalid_args(message, key);
211 * wpas_dbus_handler_wps_start - Start WPS configuration
212 * @message: Pointer to incoming dbus message
213 * @wpa_s: %wpa_supplicant data structure
214 * Returns: DBus message dictionary on success or DBus error on failure
216 * Handler for "Start" method call. DBus dictionary argument contains
217 * information about role (enrollee or registrar), authorization method
218 * (pin or push button) and optionally pin and bssid. Returned message
219 * has a dictionary argument which may contain newly generated pin (optional).
221 DBusMessage * wpas_dbus_handler_wps_start(DBusMessage *message,
222 struct wpa_supplicant *wpa_s)
224 DBusMessage *reply = NULL;
225 DBusMessageIter iter, dict_iter, entry_iter;
226 struct wps_start_params params;
228 char npin[9] = { '\0' };
231 os_memset(¶ms, 0, sizeof(params));
232 dbus_message_iter_init(message, &iter);
234 dbus_message_iter_recurse(&iter, &dict_iter);
235 while (dbus_message_iter_get_arg_type(&dict_iter) ==
236 DBUS_TYPE_DICT_ENTRY) {
237 dbus_message_iter_recurse(&dict_iter, &entry_iter);
239 dbus_message_iter_get_basic(&entry_iter, &key);
240 dbus_message_iter_next(&entry_iter);
242 if (wpas_dbus_handler_wps_start_entry(message, key,
247 dbus_message_iter_next(&dict_iter);
251 if (wpa_s->ap_iface && params.type == 1) {
252 if (params.pin == NULL) {
253 wpa_printf(MSG_DEBUG,
254 "dbus: WPS.Start - Pin required for registrar role");
255 return wpas_dbus_error_invalid_args(
256 message, "Pin required for registrar role.");
258 ret = wpa_supplicant_ap_wps_pin(wpa_s,
261 npin, sizeof(npin), 0);
262 } else if (wpa_s->ap_iface) {
263 ret = wpa_supplicant_ap_wps_pbc(wpa_s,
265 params.p2p_dev_addr);
267 #endif /* CONFIG_AP */
268 if (params.role == 0) {
269 wpa_printf(MSG_DEBUG, "dbus: WPS.Start - Role not specified");
270 return wpas_dbus_error_invalid_args(message,
271 "Role not specified");
272 } else if (params.role == 2) {
273 if (params.pin == NULL) {
274 wpa_printf(MSG_DEBUG,
275 "dbus: WPS.Start - Pin required for registrar role");
276 return wpas_dbus_error_invalid_args(
277 message, "Pin required for registrar role.");
279 ret = wpas_wps_start_reg(wpa_s, params.bssid, params.pin,
281 } else if (params.type == 0) {
282 wpa_printf(MSG_DEBUG, "dbus: WPS.Start - Type not specified");
283 return wpas_dbus_error_invalid_args(message,
284 "Type not specified");
285 } else if (params.type == 1) {
286 ret = wpas_wps_start_pin(wpa_s, params.bssid,
290 os_snprintf(npin, sizeof(npin), "%08d", ret);
292 ret = wpas_wps_start_pbc(wpa_s, params.bssid, 0);
296 wpa_printf(MSG_DEBUG,
297 "dbus: WPS.Start wpas_wps_failed in role %s and key %s",
298 (params.role == 1 ? "enrollee" : "registrar"),
299 (params.type == 0 ? "" :
300 (params.type == 1 ? "pin" : "pbc")));
301 return wpas_dbus_error_unknown_error(message,
305 reply = dbus_message_new_method_return(message);
307 return wpas_dbus_error_no_memory(message);
309 dbus_message_iter_init_append(reply, &iter);
310 if (!wpa_dbus_dict_open_write(&iter, &dict_iter) ||
311 (os_strlen(npin) > 0 &&
312 !wpa_dbus_dict_append_string(&dict_iter, "Pin", npin)) ||
313 !wpa_dbus_dict_close_write(&iter, &dict_iter)) {
314 dbus_message_unref(reply);
315 return wpas_dbus_error_no_memory(message);
323 * wpas_dbus_handler_wps_cancel - Cancel ongoing WPS configuration
324 * @message: Pointer to incoming dbus message
325 * @wpa_s: %wpa_supplicant data structure
326 * Returns: NULL on success or DBus error on failure
328 * Handler for "Cancel" method call. Returns NULL if WPS cancel successfull
329 * or DBus error on WPS cancel failure
331 DBusMessage * wpas_dbus_handler_wps_cancel(DBusMessage *message,
332 struct wpa_supplicant *wpa_s)
334 if (wpas_wps_cancel(wpa_s))
335 return wpas_dbus_error_unknown_error(message,
336 "WPS cancel failed");
343 * wpas_dbus_getter_process_credentials - Check if credentials are processed
344 * @message: Pointer to incoming dbus message
345 * @wpa_s: %wpa_supplicant data structure
346 * Returns: TRUE on success, FALSE on failure
348 * Getter for "ProcessCredentials" property. Returns returned boolean will be
349 * true if wps_cred_processing configuration field is not equal to 1 or false
352 dbus_bool_t wpas_dbus_getter_process_credentials(
353 const struct wpa_dbus_property_desc *property_desc,
354 DBusMessageIter *iter, DBusError *error, void *user_data)
356 struct wpa_supplicant *wpa_s = user_data;
357 dbus_bool_t process = wpa_s->conf->wps_cred_processing != 1;
359 return wpas_dbus_simple_property_getter(iter, DBUS_TYPE_BOOLEAN,
365 * wpas_dbus_setter_process_credentials - Set credentials_processed conf param
366 * @iter: Pointer to incoming dbus message iter
367 * @error: Location to store error on failure
368 * @user_data: Function specific data
369 * Returns: TRUE on success, FALSE on failure
371 * Setter for "ProcessCredentials" property. Sets credentials_processed on 2
372 * if boolean argument is true or on 1 if otherwise.
374 dbus_bool_t wpas_dbus_setter_process_credentials(
375 const struct wpa_dbus_property_desc *property_desc,
376 DBusMessageIter *iter, DBusError *error, void *user_data)
378 struct wpa_supplicant *wpa_s = user_data;
379 dbus_bool_t process_credentials, old_pc;
381 if (!wpa_s->dbus_new_path)
383 if (!wpas_dbus_simple_property_setter(iter, error, DBUS_TYPE_BOOLEAN,
384 &process_credentials))
387 old_pc = wpa_s->conf->wps_cred_processing != 1;
388 wpa_s->conf->wps_cred_processing = (process_credentials ? 2 : 1);
390 if ((wpa_s->conf->wps_cred_processing != 1) != old_pc)
391 wpa_dbus_mark_property_changed(wpa_s->global->dbus,
392 wpa_s->dbus_new_path,
393 WPAS_DBUS_NEW_IFACE_WPS,
394 "ProcessCredentials");
401 * wpas_dbus_getter_config_methods - Get current WPS configuration methods
402 * @iter: Pointer to incoming dbus message iter
403 * @error: Location to store error on failure
404 * @user_data: Function specific data
405 * Returns: TRUE on success, FALSE on failure
407 * Getter for "ConfigMethods" property. Returned boolean will be true if
408 * providing the relevant string worked, or false otherwise.
410 dbus_bool_t wpas_dbus_getter_config_methods(
411 const struct wpa_dbus_property_desc *property_desc,
412 DBusMessageIter *iter, DBusError *error, void *user_data)
414 struct wpa_supplicant *wpa_s = user_data;
415 char *methods = wpa_s->conf->config_methods;
419 return wpas_dbus_simple_property_getter(iter, DBUS_TYPE_STRING,
425 * wpas_dbus_setter_config_methods - Set WPS configuration methods
426 * @iter: Pointer to incoming dbus message iter
427 * @error: Location to store error on failure
428 * @user_data: Function specific data
429 * Returns: TRUE on success, FALSE on failure
431 * Setter for "ConfigMethods" property. Sets the methods string, apply such
432 * change and returns true on success. Returns false otherwise.
434 dbus_bool_t wpas_dbus_setter_config_methods(
435 const struct wpa_dbus_property_desc *property_desc,
436 DBusMessageIter *iter, DBusError *error, void *user_data)
438 struct wpa_supplicant *wpa_s = user_data;
439 char *methods, *new_methods;
441 if (!wpas_dbus_simple_property_setter(iter, error, DBUS_TYPE_STRING,
445 new_methods = os_strdup(methods);
449 os_free(wpa_s->conf->config_methods);
450 wpa_s->conf->config_methods = new_methods;
452 wpa_s->conf->changed_parameters |= CFG_CHANGED_CONFIG_METHODS;
453 wpa_supplicant_update_config(wpa_s);