2 * WPA Supplicant / dbus-based control interface
3 * Copyright (c) 2006, Dan Williams <dcbw@redhat.com> and Red Hat, Inc.
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.
16 #include <dbus/dbus.h>
21 #include "../config.h"
22 #include "../wpa_supplicant_i.h"
25 #include "dbus_old_handlers.h"
26 #include "dbus_common.h"
27 #include "dbus_common_i.h"
31 * wpas_dbus_decompose_object_path - Decompose an interface object path into parts
32 * @path: The dbus object path
33 * @network: (out) the configured network this object path refers to, if any
34 * @bssid: (out) the scanned bssid this object path refers to, if any
35 * Returns: The object path of the network interface this path refers to
37 * For a given object path, decomposes the object path into object id, network,
38 * and BSSID parts, if those parts exist.
40 char * wpas_dbus_decompose_object_path(const char *path, char **network,
43 const unsigned int dev_path_prefix_len =
44 strlen(WPAS_DBUS_PATH_INTERFACES "/");
48 /* Be a bit paranoid about path */
49 if (!path || strncmp(path, WPAS_DBUS_PATH_INTERFACES "/",
53 /* Ensure there's something at the end of the path */
54 if ((path + dev_path_prefix_len)[0] == '\0')
57 obj_path_only = os_strdup(path);
58 if (obj_path_only == NULL)
61 next_sep = strchr(obj_path_only + dev_path_prefix_len, '/');
62 if (next_sep != NULL) {
63 const char *net_part = strstr(next_sep,
64 WPAS_DBUS_NETWORKS_PART "/");
65 const char *bssid_part = strstr(next_sep,
66 WPAS_DBUS_BSSIDS_PART "/");
68 if (network && net_part) {
69 /* Deal with a request for a configured network */
70 const char *net_name = net_part +
71 strlen(WPAS_DBUS_NETWORKS_PART "/");
74 *network = os_strdup(net_name);
75 } else if (bssid && bssid_part) {
76 /* Deal with a request for a scanned BSSID */
77 const char *bssid_name = bssid_part +
78 strlen(WPAS_DBUS_BSSIDS_PART "/");
79 if (strlen(bssid_name))
80 *bssid = os_strdup(bssid_name);
85 /* Cut off interface object path before "/" */
94 * wpas_dbus_new_invalid_iface_error - Return a new invalid interface error message
95 * @message: Pointer to incoming dbus message this error refers to
96 * Returns: A dbus error message
98 * Convenience function to create and return an invalid interface error
100 DBusMessage * wpas_dbus_new_invalid_iface_error(DBusMessage *message)
102 return dbus_message_new_error(message, WPAS_ERROR_INVALID_IFACE,
103 "wpa_supplicant knows nothing about "
109 * wpas_dbus_new_invalid_network_error - Return a new invalid network error message
110 * @message: Pointer to incoming dbus message this error refers to
111 * Returns: a dbus error message
113 * Convenience function to create and return an invalid network error
115 DBusMessage * wpas_dbus_new_invalid_network_error(DBusMessage *message)
117 return dbus_message_new_error(message, WPAS_ERROR_INVALID_NETWORK,
118 "The requested network does not exist.");
123 * wpas_dbus_new_invalid_bssid_error - Return a new invalid bssid error message
124 * @message: Pointer to incoming dbus message this error refers to
125 * Returns: a dbus error message
127 * Convenience function to create and return an invalid bssid error
129 static DBusMessage * wpas_dbus_new_invalid_bssid_error(DBusMessage *message)
131 return dbus_message_new_error(message, WPAS_ERROR_INVALID_BSSID,
132 "The BSSID requested was invalid.");
137 * wpas_dispatch_network_method - dispatch messages for configured networks
138 * @message: the incoming dbus message
139 * @wpa_s: a network interface's data
140 * @network_id: id of the configured network we're interested in
141 * Returns: a reply dbus message, or a dbus error message
143 * This function dispatches all incoming dbus messages for configured networks.
145 static DBusMessage * wpas_dispatch_network_method(DBusMessage *message,
146 struct wpa_supplicant *wpa_s,
149 DBusMessage *reply = NULL;
150 const char *method = dbus_message_get_member(message);
151 struct wpa_ssid *ssid;
153 ssid = wpa_config_get_network(wpa_s->conf, network_id);
155 return wpas_dbus_new_invalid_network_error(message);
157 if (!strcmp(method, "set"))
158 reply = wpas_dbus_iface_set_network(message, wpa_s, ssid);
159 else if (!strcmp(method, "enable"))
160 reply = wpas_dbus_iface_enable_network(message, wpa_s, ssid);
161 else if (!strcmp(method, "disable"))
162 reply = wpas_dbus_iface_disable_network(message, wpa_s, ssid);
169 * wpas_dispatch_bssid_method - dispatch messages for scanned networks
170 * @message: the incoming dbus message
171 * @wpa_s: a network interface's data
172 * @bssid: bssid of the scanned network we're interested in
173 * Returns: a reply dbus message, or a dbus error message
175 * This function dispatches all incoming dbus messages for scanned networks.
177 static DBusMessage * wpas_dispatch_bssid_method(DBusMessage *message,
178 struct wpa_supplicant *wpa_s,
179 const char *bssid_txt)
184 if (hexstr2bin(bssid_txt, bssid, ETH_ALEN) < 0)
185 return wpas_dbus_new_invalid_bssid_error(message);
187 bss = wpa_bss_get_bssid(wpa_s, bssid);
189 return wpas_dbus_new_invalid_bssid_error(message);
191 /* Dispatch the method call against the scanned bssid */
192 if (os_strcmp(dbus_message_get_member(message), "properties") == 0)
193 return wpas_dbus_bssid_properties(message, wpa_s, bss);
200 * wpas_iface_message_handler - Dispatch messages for interfaces or networks
201 * @connection: Connection to the system message bus
202 * @message: An incoming dbus message
203 * @user_data: A pointer to a dbus control interface data structure
204 * Returns: Whether or not the message was handled
206 * This function dispatches all incoming dbus messages for network interfaces,
207 * or objects owned by them, such as scanned BSSIDs and configured networks.
209 static DBusHandlerResult wpas_iface_message_handler(DBusConnection *connection,
210 DBusMessage *message,
213 struct wpa_supplicant *wpa_s = user_data;
214 const char *method = dbus_message_get_member(message);
215 const char *path = dbus_message_get_path(message);
216 const char *msg_interface = dbus_message_get_interface(message);
217 char *iface_obj_path = NULL;
218 char *network = NULL;
220 DBusMessage *reply = NULL;
222 /* Caller must specify a message interface */
226 iface_obj_path = wpas_dbus_decompose_object_path(path, &network,
228 if (iface_obj_path == NULL) {
229 reply = wpas_dbus_new_invalid_iface_error(message);
233 /* Make sure the message's object path actually refers to the
234 * wpa_supplicant structure it's supposed to (which is wpa_s)
236 if (wpa_supplicant_get_iface_by_dbus_path(wpa_s->global,
237 iface_obj_path) != wpa_s) {
238 reply = wpas_dbus_new_invalid_iface_error(message);
242 if (network && !strcmp(msg_interface, WPAS_DBUS_IFACE_NETWORK)) {
243 /* A method for one of this interface's configured networks */
244 int nid = strtoul(network, NULL, 10);
246 reply = wpas_dispatch_network_method(message, wpa_s,
249 reply = wpas_dbus_new_invalid_network_error(message);
250 } else if (bssid && !strcmp(msg_interface, WPAS_DBUS_IFACE_BSSID)) {
251 /* A method for one of this interface's scanned BSSIDs */
252 reply = wpas_dispatch_bssid_method(message, wpa_s, bssid);
253 } else if (!strcmp(msg_interface, WPAS_DBUS_IFACE_INTERFACE)) {
254 /* A method for an interface only. */
255 if (!strcmp(method, "scan"))
256 reply = wpas_dbus_iface_scan(message, wpa_s);
257 else if (!strcmp(method, "scanResults"))
258 reply = wpas_dbus_iface_scan_results(message, wpa_s);
259 else if (!strcmp(method, "addNetwork"))
260 reply = wpas_dbus_iface_add_network(message, wpa_s);
261 else if (!strcmp(method, "removeNetwork"))
262 reply = wpas_dbus_iface_remove_network(message, wpa_s);
263 else if (!strcmp(method, "selectNetwork"))
264 reply = wpas_dbus_iface_select_network(message, wpa_s);
265 else if (!strcmp(method, "capabilities"))
266 reply = wpas_dbus_iface_capabilities(message, wpa_s);
267 else if (!strcmp(method, "disconnect"))
268 reply = wpas_dbus_iface_disconnect(message, wpa_s);
269 else if (!strcmp(method, "setAPScan"))
270 reply = wpas_dbus_iface_set_ap_scan(message, wpa_s);
271 else if (!strcmp(method, "setSmartcardModules"))
272 reply = wpas_dbus_iface_set_smartcard_modules(message,
274 else if (!strcmp(method, "state"))
275 reply = wpas_dbus_iface_get_state(message, wpa_s);
276 else if (!strcmp(method, "scanning"))
277 reply = wpas_dbus_iface_get_scanning(message, wpa_s);
278 else if (!strcmp(method, "setBlobs"))
279 reply = wpas_dbus_iface_set_blobs(message, wpa_s);
280 else if (!strcmp(method, "removeBlobs"))
281 reply = wpas_dbus_iface_remove_blobs(message, wpa_s);
283 else if (!os_strcmp(method, "wpsPbc"))
284 reply = wpas_dbus_iface_wps_pbc(message, wpa_s);
285 else if (!os_strcmp(method, "wpsPin"))
286 reply = wpas_dbus_iface_wps_pin(message, wpa_s);
287 else if (!os_strcmp(method, "wpsReg"))
288 reply = wpas_dbus_iface_wps_reg(message, wpa_s);
289 #endif /* CONFIG_WPS */
292 /* If the message was handled, send back the reply */
294 if (!dbus_message_get_no_reply(message))
295 dbus_connection_send(connection, reply, NULL);
296 dbus_message_unref(reply);
300 os_free(iface_obj_path);
303 return reply ? DBUS_HANDLER_RESULT_HANDLED :
304 DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
309 * wpas_message_handler - dispatch incoming dbus messages
310 * @connection: connection to the system message bus
311 * @message: an incoming dbus message
312 * @user_data: a pointer to a dbus control interface data structure
313 * Returns: whether or not the message was handled
315 * This function dispatches all incoming dbus messages to the correct
316 * handlers, depending on what the message's target object path is,
317 * and what the method call is.
319 static DBusHandlerResult wpas_message_handler(DBusConnection *connection,
320 DBusMessage *message, void *user_data)
322 struct wpas_dbus_priv *ctrl_iface = user_data;
325 const char *msg_interface;
326 DBusMessage *reply = NULL;
328 method = dbus_message_get_member(message);
329 path = dbus_message_get_path(message);
330 msg_interface = dbus_message_get_interface(message);
331 if (!method || !path || !ctrl_iface || !msg_interface)
332 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
334 /* Validate the method interface */
335 if (strcmp(msg_interface, WPAS_DBUS_INTERFACE) != 0)
336 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
338 if (!strcmp(path, WPAS_DBUS_PATH)) {
339 /* dispatch methods against our global dbus interface here */
340 if (!strcmp(method, "addInterface")) {
341 reply = wpas_dbus_global_add_interface(
342 message, ctrl_iface->global);
343 } else if (!strcmp(method, "removeInterface")) {
344 reply = wpas_dbus_global_remove_interface(
345 message, ctrl_iface->global);
346 } else if (!strcmp(method, "getInterface")) {
347 reply = wpas_dbus_global_get_interface(
348 message, ctrl_iface->global);
349 } else if (!strcmp(method, "setDebugParams")) {
350 reply = wpas_dbus_global_set_debugparams(
351 message, ctrl_iface->global);
355 /* If the message was handled, send back the reply */
357 if (!dbus_message_get_no_reply(message))
358 dbus_connection_send(connection, reply, NULL);
359 dbus_message_unref(reply);
362 return reply ? DBUS_HANDLER_RESULT_HANDLED :
363 DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
368 * wpa_supplicant_dbus_notify_scan_results - Send a scan results signal
369 * @wpa_s: %wpa_supplicant network interface data
370 * Returns: 0 on success, -1 on failure
372 * Notify listeners that this interface has updated scan results.
374 void wpa_supplicant_dbus_notify_scan_results(struct wpa_supplicant *wpa_s)
376 struct wpas_dbus_priv *iface = wpa_s->global->dbus;
377 DBusMessage *_signal;
379 /* Do nothing if the control interface is not turned on */
383 _signal = dbus_message_new_signal(wpa_s->dbus_path,
384 WPAS_DBUS_IFACE_INTERFACE,
385 "ScanResultsAvailable");
386 if (_signal == NULL) {
387 wpa_printf(MSG_ERROR, "dbus: Not enough memory to send scan "
391 dbus_connection_send(iface->con, _signal, NULL);
392 dbus_message_unref(_signal);
397 * wpa_supplicant_dbus_notify_state_change - Send a state change signal
398 * @wpa_s: %wpa_supplicant network interface data
399 * @new_state: new state wpa_supplicant is entering
400 * @old_state: old state wpa_supplicant is leaving
401 * Returns: 0 on success, -1 on failure
403 * Notify listeners that wpa_supplicant has changed state
405 void wpa_supplicant_dbus_notify_state_change(struct wpa_supplicant *wpa_s,
406 enum wpa_states new_state,
407 enum wpa_states old_state)
409 struct wpas_dbus_priv *iface;
410 DBusMessage *_signal = NULL;
411 const char *new_state_str, *old_state_str;
413 /* Do nothing if the control interface is not turned on */
414 if (wpa_s->global == NULL)
416 iface = wpa_s->global->dbus;
420 /* Only send signal if state really changed */
421 if (new_state == old_state)
424 _signal = dbus_message_new_signal(wpa_s->dbus_path,
425 WPAS_DBUS_IFACE_INTERFACE,
427 if (_signal == NULL) {
428 wpa_printf(MSG_ERROR,
429 "dbus: wpa_supplicant_dbus_notify_state_change: "
430 "could not create dbus signal; likely out of "
435 new_state_str = wpa_supplicant_state_txt(new_state);
436 old_state_str = wpa_supplicant_state_txt(old_state);
437 if (new_state_str == NULL || old_state_str == NULL) {
438 wpa_printf(MSG_ERROR,
439 "dbus: wpa_supplicant_dbus_notify_state_change: "
440 "Could not convert state strings");
444 if (!dbus_message_append_args(_signal,
445 DBUS_TYPE_STRING, &new_state_str,
446 DBUS_TYPE_STRING, &old_state_str,
447 DBUS_TYPE_INVALID)) {
448 wpa_printf(MSG_ERROR,
449 "dbus: wpa_supplicant_dbus_notify_state_change: "
450 "Not enough memory to construct state change "
455 dbus_connection_send(iface->con, _signal, NULL);
458 dbus_message_unref(_signal);
463 * wpa_supplicant_dbus_notify_scanning - send scanning status
464 * @wpa_s: %wpa_supplicant network interface data
465 * Returns: 0 on success, -1 on failure
467 * Notify listeners of interface scanning state changes
469 void wpa_supplicant_dbus_notify_scanning(struct wpa_supplicant *wpa_s)
471 struct wpas_dbus_priv *iface = wpa_s->global->dbus;
472 DBusMessage *_signal;
473 dbus_bool_t scanning = wpa_s->scanning ? TRUE : FALSE;
475 /* Do nothing if the control interface is not turned on */
479 _signal = dbus_message_new_signal(wpa_s->dbus_path,
480 WPAS_DBUS_IFACE_INTERFACE,
482 if (_signal == NULL) {
483 wpa_printf(MSG_ERROR, "dbus: Not enough memory to send scan "
488 if (dbus_message_append_args(_signal,
489 DBUS_TYPE_BOOLEAN, &scanning,
490 DBUS_TYPE_INVALID)) {
491 dbus_connection_send(iface->con, _signal, NULL);
493 wpa_printf(MSG_ERROR, "dbus: Not enough memory to construct "
496 dbus_message_unref(_signal);
501 void wpa_supplicant_dbus_notify_wps_cred(struct wpa_supplicant *wpa_s,
502 const struct wps_credential *cred)
504 struct wpas_dbus_priv *iface;
505 DBusMessage *_signal = NULL;
507 /* Do nothing if the control interface is not turned on */
508 if (wpa_s->global == NULL)
510 iface = wpa_s->global->dbus;
514 _signal = dbus_message_new_signal(wpa_s->dbus_path,
515 WPAS_DBUS_IFACE_INTERFACE,
517 if (_signal == NULL) {
518 wpa_printf(MSG_ERROR,
519 "dbus: wpa_supplicant_dbus_notify_wps_cred: "
520 "Could not create dbus signal; likely out of "
525 if (!dbus_message_append_args(_signal,
526 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE,
527 &cred->cred_attr, cred->cred_attr_len,
528 DBUS_TYPE_INVALID)) {
529 wpa_printf(MSG_ERROR,
530 "dbus: wpa_supplicant_dbus_notify_wps_cred: "
531 "Not enough memory to construct signal");
535 dbus_connection_send(iface->con, _signal, NULL);
538 dbus_message_unref(_signal);
540 #else /* CONFIG_WPS */
541 void wpa_supplicant_dbus_notify_wps_cred(struct wpa_supplicant *wpa_s,
542 const struct wps_credential *cred)
545 #endif /* CONFIG_WPS */
549 * wpa_supplicant_dbus_ctrl_iface_init - Initialize dbus control interface
550 * @global: Pointer to global data from wpa_supplicant_init()
551 * Returns: 0 on success, -1 on failure
553 * Initialize the dbus control interface and start receiving commands from
554 * external programs over the bus.
556 int wpa_supplicant_dbus_ctrl_iface_init(struct wpas_dbus_priv *iface)
560 DBusObjectPathVTable wpas_vtable = {
561 NULL, &wpas_message_handler, NULL, NULL, NULL, NULL
564 /* Register the message handler for the global dbus interface */
565 if (!dbus_connection_register_object_path(iface->con,
566 WPAS_DBUS_PATH, &wpas_vtable,
568 wpa_printf(MSG_ERROR, "dbus: Could not set up message "
573 /* Register our service with the message bus */
574 dbus_error_init(&error);
575 switch (dbus_bus_request_name(iface->con, WPAS_DBUS_SERVICE,
577 case DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER:
580 case DBUS_REQUEST_NAME_REPLY_EXISTS:
581 case DBUS_REQUEST_NAME_REPLY_IN_QUEUE:
582 case DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER:
583 wpa_printf(MSG_ERROR, "dbus: Could not request service name: "
584 "already registered");
587 wpa_printf(MSG_ERROR, "dbus: Could not request service name: "
588 "%s %s", error.name, error.message);
591 dbus_error_free(&error);
596 wpa_printf(MSG_DEBUG, "Providing DBus service '" WPAS_DBUS_SERVICE
604 * wpas_dbus_register_new_iface - Register a new interface with dbus
605 * @wpa_s: %wpa_supplicant interface description structure to register
606 * Returns: 0 on success, -1 on error
608 * Registers a new interface with dbus and assigns it a dbus object path.
610 int wpas_dbus_register_iface(struct wpa_supplicant *wpa_s)
612 struct wpas_dbus_priv *ctrl_iface = wpa_s->global->dbus;
613 DBusConnection * con;
615 DBusObjectPathVTable vtable = {
616 NULL, &wpas_iface_message_handler, NULL, NULL, NULL, NULL
619 /* Do nothing if the control interface is not turned on */
620 if (ctrl_iface == NULL)
623 con = ctrl_iface->con;
624 next = ctrl_iface->next_objid++;
626 /* Create and set the interface's object path */
627 wpa_s->dbus_path = os_zalloc(WPAS_DBUS_OBJECT_PATH_MAX);
628 if (wpa_s->dbus_path == NULL)
630 os_snprintf(wpa_s->dbus_path, WPAS_DBUS_OBJECT_PATH_MAX,
631 WPAS_DBUS_PATH_INTERFACES "/%u",
634 /* Register the message handler for the interface functions */
635 if (!dbus_connection_register_fallback(con, wpa_s->dbus_path, &vtable,
637 wpa_printf(MSG_ERROR, "dbus: Could not set up message "
638 "handler for interface %s", wpa_s->ifname);
647 * wpas_dbus_unregister_iface - Unregister an interface from dbus
648 * @wpa_s: wpa_supplicant interface structure
649 * Returns: 0 on success, -1 on failure
651 * Unregisters the interface with dbus
653 int wpas_dbus_unregister_iface(struct wpa_supplicant *wpa_s)
655 struct wpas_dbus_priv *ctrl_iface;
658 /* Do nothing if the control interface is not turned on */
659 if (wpa_s == NULL || wpa_s->global == NULL)
661 ctrl_iface = wpa_s->global->dbus;
662 if (ctrl_iface == NULL)
665 con = ctrl_iface->con;
666 if (!dbus_connection_unregister_object_path(con, wpa_s->dbus_path))
669 os_free(wpa_s->dbus_path);
670 wpa_s->dbus_path = NULL;
677 * wpa_supplicant_get_iface_by_dbus_path - Get a new network interface
678 * @global: Pointer to global data from wpa_supplicant_init()
679 * @path: Pointer to a dbus object path representing an interface
680 * Returns: Pointer to the interface or %NULL if not found
682 struct wpa_supplicant * wpa_supplicant_get_iface_by_dbus_path(
683 struct wpa_global *global, const char *path)
685 struct wpa_supplicant *wpa_s;
687 for (wpa_s = global->ifaces; wpa_s; wpa_s = wpa_s->next) {
688 if (strcmp(wpa_s->dbus_path, path) == 0)