2 * WPA Supplicant / dbus-based control interface
3 * Copyright (c) 2006, Dan Williams <dcbw@redhat.com> and Red Hat, Inc.
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
10 #include <dbus/dbus.h>
15 #include "../config.h"
16 #include "../wpa_supplicant_i.h"
19 #include "dbus_old_handlers.h"
20 #include "dbus_common_i.h"
24 * wpas_dbus_decompose_object_path - Decompose an interface object path into parts
25 * @path: The dbus object path
26 * @network: (out) the configured network this object path refers to, if any
27 * @bssid: (out) the scanned bssid this object path refers to, if any
28 * Returns: The object path of the network interface this path refers to
30 * For a given object path, decomposes the object path into object id, network,
31 * and BSSID parts, if those parts exist.
33 char * wpas_dbus_decompose_object_path(const char *path, char **network,
36 const unsigned int dev_path_prefix_len =
37 strlen(WPAS_DBUS_PATH_INTERFACES "/");
41 /* Be a bit paranoid about path */
42 if (!path || strncmp(path, WPAS_DBUS_PATH_INTERFACES "/",
46 /* Ensure there's something at the end of the path */
47 if ((path + dev_path_prefix_len)[0] == '\0')
50 obj_path_only = os_strdup(path);
51 if (obj_path_only == NULL)
54 next_sep = strchr(obj_path_only + dev_path_prefix_len, '/');
55 if (next_sep != NULL) {
56 const char *net_part = strstr(next_sep,
57 WPAS_DBUS_NETWORKS_PART "/");
58 const char *bssid_part = strstr(next_sep,
59 WPAS_DBUS_BSSIDS_PART "/");
61 if (network && net_part) {
62 /* Deal with a request for a configured network */
63 const char *net_name = net_part +
64 strlen(WPAS_DBUS_NETWORKS_PART "/");
67 *network = os_strdup(net_name);
68 } else if (bssid && bssid_part) {
69 /* Deal with a request for a scanned BSSID */
70 const char *bssid_name = bssid_part +
71 strlen(WPAS_DBUS_BSSIDS_PART "/");
72 if (strlen(bssid_name))
73 *bssid = os_strdup(bssid_name);
78 /* Cut off interface object path before "/" */
87 * wpas_dbus_new_invalid_iface_error - Return a new invalid interface error message
88 * @message: Pointer to incoming dbus message this error refers to
89 * Returns: A dbus error message
91 * Convenience function to create and return an invalid interface error
93 DBusMessage * wpas_dbus_new_invalid_iface_error(DBusMessage *message)
95 return dbus_message_new_error(message, WPAS_ERROR_INVALID_IFACE,
96 "wpa_supplicant knows nothing about "
102 * wpas_dbus_new_invalid_network_error - Return a new invalid network error message
103 * @message: Pointer to incoming dbus message this error refers to
104 * Returns: a dbus error message
106 * Convenience function to create and return an invalid network error
108 DBusMessage * wpas_dbus_new_invalid_network_error(DBusMessage *message)
110 return dbus_message_new_error(message, WPAS_ERROR_INVALID_NETWORK,
111 "The requested network does not exist.");
116 * wpas_dbus_new_invalid_bssid_error - Return a new invalid bssid error message
117 * @message: Pointer to incoming dbus message this error refers to
118 * Returns: a dbus error message
120 * Convenience function to create and return an invalid bssid error
122 static DBusMessage * wpas_dbus_new_invalid_bssid_error(DBusMessage *message)
124 return dbus_message_new_error(message, WPAS_ERROR_INVALID_BSSID,
125 "The BSSID requested was invalid.");
130 * wpas_dispatch_network_method - dispatch messages for configured networks
131 * @message: the incoming dbus message
132 * @wpa_s: a network interface's data
133 * @network_id: id of the configured network we're interested in
134 * Returns: a reply dbus message, or a dbus error message
136 * This function dispatches all incoming dbus messages for configured networks.
138 static DBusMessage * wpas_dispatch_network_method(DBusMessage *message,
139 struct wpa_supplicant *wpa_s,
142 DBusMessage *reply = NULL;
143 const char *method = dbus_message_get_member(message);
144 struct wpa_ssid *ssid;
146 ssid = wpa_config_get_network(wpa_s->conf, network_id);
148 return wpas_dbus_new_invalid_network_error(message);
150 if (!strcmp(method, "set"))
151 reply = wpas_dbus_iface_set_network(message, wpa_s, ssid);
152 else if (!strcmp(method, "enable"))
153 reply = wpas_dbus_iface_enable_network(message, wpa_s, ssid);
154 else if (!strcmp(method, "disable"))
155 reply = wpas_dbus_iface_disable_network(message, wpa_s, ssid);
162 * wpas_dispatch_bssid_method - dispatch messages for scanned networks
163 * @message: the incoming dbus message
164 * @wpa_s: a network interface's data
165 * @bssid: bssid of the scanned network we're interested in
166 * Returns: a reply dbus message, or a dbus error message
168 * This function dispatches all incoming dbus messages for scanned networks.
170 static DBusMessage * wpas_dispatch_bssid_method(DBusMessage *message,
171 struct wpa_supplicant *wpa_s,
172 const char *bssid_txt)
177 if (hexstr2bin(bssid_txt, bssid, ETH_ALEN) < 0)
178 return wpas_dbus_new_invalid_bssid_error(message);
180 bss = wpa_bss_get_bssid(wpa_s, bssid);
182 return wpas_dbus_new_invalid_bssid_error(message);
184 /* Dispatch the method call against the scanned bssid */
185 if (os_strcmp(dbus_message_get_member(message), "properties") == 0)
186 return wpas_dbus_bssid_properties(message, wpa_s, bss);
193 * wpas_iface_message_handler - Dispatch messages for interfaces or networks
194 * @connection: Connection to the system message bus
195 * @message: An incoming dbus message
196 * @user_data: A pointer to a dbus control interface data structure
197 * Returns: Whether or not the message was handled
199 * This function dispatches all incoming dbus messages for network interfaces,
200 * or objects owned by them, such as scanned BSSIDs and configured networks.
202 static DBusHandlerResult wpas_iface_message_handler(DBusConnection *connection,
203 DBusMessage *message,
206 struct wpa_supplicant *wpa_s = user_data;
207 const char *method = dbus_message_get_member(message);
208 const char *path = dbus_message_get_path(message);
209 const char *msg_interface = dbus_message_get_interface(message);
210 char *iface_obj_path = NULL;
211 char *network = NULL;
213 DBusMessage *reply = NULL;
215 /* Caller must specify a message interface */
219 iface_obj_path = wpas_dbus_decompose_object_path(path, &network,
221 if (iface_obj_path == NULL) {
222 reply = wpas_dbus_new_invalid_iface_error(message);
226 /* Make sure the message's object path actually refers to the
227 * wpa_supplicant structure it's supposed to (which is wpa_s)
229 if (wpa_supplicant_get_iface_by_dbus_path(wpa_s->global,
230 iface_obj_path) != wpa_s) {
231 reply = wpas_dbus_new_invalid_iface_error(message);
235 if (network && !strcmp(msg_interface, WPAS_DBUS_IFACE_NETWORK)) {
236 /* A method for one of this interface's configured networks */
237 int nid = strtoul(network, NULL, 10);
239 reply = wpas_dispatch_network_method(message, wpa_s,
242 reply = wpas_dbus_new_invalid_network_error(message);
243 } else if (bssid && !strcmp(msg_interface, WPAS_DBUS_IFACE_BSSID)) {
244 /* A method for one of this interface's scanned BSSIDs */
245 reply = wpas_dispatch_bssid_method(message, wpa_s, bssid);
246 } else if (!strcmp(msg_interface, WPAS_DBUS_IFACE_INTERFACE)) {
247 /* A method for an interface only. */
248 if (!strcmp(method, "scan"))
249 reply = wpas_dbus_iface_scan(message, wpa_s);
250 else if (!strcmp(method, "scanResults"))
251 reply = wpas_dbus_iface_scan_results(message, wpa_s);
252 else if (!strcmp(method, "addNetwork"))
253 reply = wpas_dbus_iface_add_network(message, wpa_s);
254 else if (!strcmp(method, "removeNetwork"))
255 reply = wpas_dbus_iface_remove_network(message, wpa_s);
256 else if (!strcmp(method, "selectNetwork"))
257 reply = wpas_dbus_iface_select_network(message, wpa_s);
258 else if (!strcmp(method, "capabilities"))
259 reply = wpas_dbus_iface_capabilities(message, wpa_s);
260 else if (!strcmp(method, "disconnect"))
261 reply = wpas_dbus_iface_disconnect(message, wpa_s);
262 else if (!strcmp(method, "setAPScan"))
263 reply = wpas_dbus_iface_set_ap_scan(message, wpa_s);
264 else if (!strcmp(method, "setSmartcardModules"))
265 reply = wpas_dbus_iface_set_smartcard_modules(message,
267 else if (!strcmp(method, "state"))
268 reply = wpas_dbus_iface_get_state(message, wpa_s);
269 else if (!strcmp(method, "scanning"))
270 reply = wpas_dbus_iface_get_scanning(message, wpa_s);
271 else if (!strcmp(method, "setBlobs"))
272 reply = wpas_dbus_iface_set_blobs(message, wpa_s);
273 else if (!strcmp(method, "removeBlobs"))
274 reply = wpas_dbus_iface_remove_blobs(message, wpa_s);
276 else if (!os_strcmp(method, "wpsPbc"))
277 reply = wpas_dbus_iface_wps_pbc(message, wpa_s);
278 else if (!os_strcmp(method, "wpsPin"))
279 reply = wpas_dbus_iface_wps_pin(message, wpa_s);
280 else if (!os_strcmp(method, "wpsReg"))
281 reply = wpas_dbus_iface_wps_reg(message, wpa_s);
282 #endif /* CONFIG_WPS */
283 else if (!os_strcmp(method, "flush"))
284 reply = wpas_dbus_iface_flush(message, wpa_s);
287 /* If the message was handled, send back the reply */
289 if (!dbus_message_get_no_reply(message))
290 dbus_connection_send(connection, reply, NULL);
291 dbus_message_unref(reply);
295 os_free(iface_obj_path);
298 return reply ? DBUS_HANDLER_RESULT_HANDLED :
299 DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
304 * wpas_message_handler - dispatch incoming dbus messages
305 * @connection: connection to the system message bus
306 * @message: an incoming dbus message
307 * @user_data: a pointer to a dbus control interface data structure
308 * Returns: whether or not the message was handled
310 * This function dispatches all incoming dbus messages to the correct
311 * handlers, depending on what the message's target object path is,
312 * and what the method call is.
314 static DBusHandlerResult wpas_message_handler(DBusConnection *connection,
315 DBusMessage *message, void *user_data)
317 struct wpas_dbus_priv *ctrl_iface = user_data;
320 const char *msg_interface;
321 DBusMessage *reply = NULL;
323 method = dbus_message_get_member(message);
324 path = dbus_message_get_path(message);
325 msg_interface = dbus_message_get_interface(message);
326 if (!method || !path || !ctrl_iface || !msg_interface)
327 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
329 /* Validate the method interface */
330 if (strcmp(msg_interface, WPAS_DBUS_INTERFACE) != 0)
331 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
333 if (!strcmp(path, WPAS_DBUS_PATH)) {
334 /* dispatch methods against our global dbus interface here */
335 if (!strcmp(method, "addInterface")) {
336 reply = wpas_dbus_global_add_interface(
337 message, ctrl_iface->global);
338 } else if (!strcmp(method, "removeInterface")) {
339 reply = wpas_dbus_global_remove_interface(
340 message, ctrl_iface->global);
341 } else if (!strcmp(method, "getInterface")) {
342 reply = wpas_dbus_global_get_interface(
343 message, ctrl_iface->global);
344 } else if (!strcmp(method, "setDebugParams")) {
345 reply = wpas_dbus_global_set_debugparams(
346 message, ctrl_iface->global);
350 /* If the message was handled, send back the reply */
352 if (!dbus_message_get_no_reply(message))
353 dbus_connection_send(connection, reply, NULL);
354 dbus_message_unref(reply);
357 return reply ? DBUS_HANDLER_RESULT_HANDLED :
358 DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
363 * wpa_supplicant_dbus_notify_scan_results - Send a scan results signal
364 * @wpa_s: %wpa_supplicant network interface data
365 * Returns: 0 on success, -1 on failure
367 * Notify listeners that this interface has updated scan results.
369 void wpa_supplicant_dbus_notify_scan_results(struct wpa_supplicant *wpa_s)
371 struct wpas_dbus_priv *iface = wpa_s->global->dbus;
372 DBusMessage *_signal;
374 /* Do nothing if the control interface is not turned on */
378 _signal = dbus_message_new_signal(wpa_s->dbus_path,
379 WPAS_DBUS_IFACE_INTERFACE,
380 "ScanResultsAvailable");
381 if (_signal == NULL) {
382 wpa_printf(MSG_ERROR, "dbus: Not enough memory to send scan "
386 dbus_connection_send(iface->con, _signal, NULL);
387 dbus_message_unref(_signal);
392 * wpa_supplicant_dbus_notify_state_change - Send a state change signal
393 * @wpa_s: %wpa_supplicant network interface data
394 * @new_state: new state wpa_supplicant is entering
395 * @old_state: old state wpa_supplicant is leaving
396 * Returns: 0 on success, -1 on failure
398 * Notify listeners that wpa_supplicant has changed state
400 void wpa_supplicant_dbus_notify_state_change(struct wpa_supplicant *wpa_s,
401 enum wpa_states new_state,
402 enum wpa_states old_state)
404 struct wpas_dbus_priv *iface;
405 DBusMessage *_signal = NULL;
406 const char *new_state_str, *old_state_str;
408 if (wpa_s->dbus_path == NULL)
409 return; /* Skip signal since D-Bus setup is not yet ready */
411 /* Do nothing if the control interface is not turned on */
412 if (wpa_s->global == NULL)
414 iface = wpa_s->global->dbus;
418 /* Only send signal if state really changed */
419 if (new_state == old_state)
422 _signal = dbus_message_new_signal(wpa_s->dbus_path,
423 WPAS_DBUS_IFACE_INTERFACE,
425 if (_signal == NULL) {
426 wpa_printf(MSG_ERROR,
427 "dbus: wpa_supplicant_dbus_notify_state_change: "
428 "could not create dbus signal; likely out of "
433 new_state_str = wpa_supplicant_state_txt(new_state);
434 old_state_str = wpa_supplicant_state_txt(old_state);
435 if (new_state_str == NULL || old_state_str == NULL) {
436 wpa_printf(MSG_ERROR,
437 "dbus: wpa_supplicant_dbus_notify_state_change: "
438 "Could not convert state strings");
442 if (!dbus_message_append_args(_signal,
443 DBUS_TYPE_STRING, &new_state_str,
444 DBUS_TYPE_STRING, &old_state_str,
445 DBUS_TYPE_INVALID)) {
446 wpa_printf(MSG_ERROR,
447 "dbus: wpa_supplicant_dbus_notify_state_change: "
448 "Not enough memory to construct state change "
453 dbus_connection_send(iface->con, _signal, NULL);
456 dbus_message_unref(_signal);
461 * wpa_supplicant_dbus_notify_scanning - send scanning status
462 * @wpa_s: %wpa_supplicant network interface data
463 * Returns: 0 on success, -1 on failure
465 * Notify listeners of interface scanning state changes
467 void wpa_supplicant_dbus_notify_scanning(struct wpa_supplicant *wpa_s)
469 struct wpas_dbus_priv *iface = wpa_s->global->dbus;
470 DBusMessage *_signal;
471 dbus_bool_t scanning = wpa_s->scanning ? TRUE : FALSE;
473 /* Do nothing if the control interface is not turned on */
477 _signal = dbus_message_new_signal(wpa_s->dbus_path,
478 WPAS_DBUS_IFACE_INTERFACE,
480 if (_signal == NULL) {
481 wpa_printf(MSG_ERROR, "dbus: Not enough memory to send scan "
486 if (dbus_message_append_args(_signal,
487 DBUS_TYPE_BOOLEAN, &scanning,
488 DBUS_TYPE_INVALID)) {
489 dbus_connection_send(iface->con, _signal, NULL);
491 wpa_printf(MSG_ERROR, "dbus: Not enough memory to construct "
494 dbus_message_unref(_signal);
499 void wpa_supplicant_dbus_notify_wps_cred(struct wpa_supplicant *wpa_s,
500 const struct wps_credential *cred)
502 struct wpas_dbus_priv *iface;
503 DBusMessage *_signal = NULL;
505 /* Do nothing if the control interface is not turned on */
506 if (wpa_s->global == NULL)
508 iface = wpa_s->global->dbus;
512 _signal = dbus_message_new_signal(wpa_s->dbus_path,
513 WPAS_DBUS_IFACE_INTERFACE,
515 if (_signal == NULL) {
516 wpa_printf(MSG_ERROR,
517 "dbus: wpa_supplicant_dbus_notify_wps_cred: "
518 "Could not create dbus signal; likely out of "
523 if (!dbus_message_append_args(_signal,
524 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE,
525 &cred->cred_attr, cred->cred_attr_len,
526 DBUS_TYPE_INVALID)) {
527 wpa_printf(MSG_ERROR,
528 "dbus: wpa_supplicant_dbus_notify_wps_cred: "
529 "Not enough memory to construct signal");
533 dbus_connection_send(iface->con, _signal, NULL);
536 dbus_message_unref(_signal);
538 #else /* CONFIG_WPS */
539 void wpa_supplicant_dbus_notify_wps_cred(struct wpa_supplicant *wpa_s,
540 const struct wps_credential *cred)
543 #endif /* CONFIG_WPS */
545 void wpa_supplicant_dbus_notify_certification(struct wpa_supplicant *wpa_s,
546 int depth, const char *subject,
547 const char *cert_hash,
548 const struct wpabuf *cert)
550 struct wpas_dbus_priv *iface;
551 DBusMessage *_signal = NULL;
553 const char *cert_hex;
556 /* Do nothing if the control interface is not turned on */
557 if (wpa_s->global == NULL)
559 iface = wpa_s->global->dbus;
563 _signal = dbus_message_new_signal(wpa_s->dbus_path,
564 WPAS_DBUS_IFACE_INTERFACE,
566 if (_signal == NULL) {
567 wpa_printf(MSG_ERROR,
568 "dbus: wpa_supplicant_dbus_notify_certification: "
569 "Could not create dbus signal; likely out of "
574 hash = cert_hash ? cert_hash : "";
575 cert_hex = cert ? wpabuf_head(cert) : "";
576 cert_hex_len = cert ? wpabuf_len(cert) : 0;
578 if (!dbus_message_append_args(_signal,
579 DBUS_TYPE_INT32,&depth,
580 DBUS_TYPE_STRING, &subject,
581 DBUS_TYPE_STRING, &hash,
582 DBUS_TYPE_ARRAY, DBUS_TYPE_BYTE,
583 &cert_hex, cert_hex_len,
584 DBUS_TYPE_INVALID)) {
585 wpa_printf(MSG_ERROR,
586 "dbus: wpa_supplicant_dbus_notify_certification: "
587 "Not enough memory to construct signal");
591 dbus_connection_send(iface->con, _signal, NULL);
594 dbus_message_unref(_signal);
600 * wpa_supplicant_dbus_ctrl_iface_init - Initialize dbus control interface
601 * @global: Pointer to global data from wpa_supplicant_init()
602 * Returns: 0 on success, -1 on failure
604 * Initialize the dbus control interface and start receiving commands from
605 * external programs over the bus.
607 int wpa_supplicant_dbus_ctrl_iface_init(struct wpas_dbus_priv *iface)
611 DBusObjectPathVTable wpas_vtable = {
612 NULL, &wpas_message_handler, NULL, NULL, NULL, NULL
615 /* Register the message handler for the global dbus interface */
616 if (!dbus_connection_register_object_path(iface->con,
617 WPAS_DBUS_PATH, &wpas_vtable,
619 wpa_printf(MSG_ERROR, "dbus: Could not set up message "
624 /* Register our service with the message bus */
625 dbus_error_init(&error);
626 switch (dbus_bus_request_name(iface->con, WPAS_DBUS_SERVICE,
628 case DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER:
631 case DBUS_REQUEST_NAME_REPLY_EXISTS:
632 case DBUS_REQUEST_NAME_REPLY_IN_QUEUE:
633 case DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER:
634 wpa_printf(MSG_ERROR, "dbus: Could not request service name: "
635 "already registered");
638 wpa_printf(MSG_ERROR, "dbus: Could not request service name: "
639 "%s %s", error.name, error.message);
642 dbus_error_free(&error);
647 wpa_printf(MSG_DEBUG, "Providing DBus service '" WPAS_DBUS_SERVICE
655 * wpas_dbus_register_new_iface - Register a new interface with dbus
656 * @wpa_s: %wpa_supplicant interface description structure to register
657 * Returns: 0 on success, -1 on error
659 * Registers a new interface with dbus and assigns it a dbus object path.
661 int wpas_dbus_register_iface(struct wpa_supplicant *wpa_s)
663 struct wpas_dbus_priv *ctrl_iface = wpa_s->global->dbus;
664 DBusConnection * con;
666 DBusObjectPathVTable vtable = {
667 NULL, &wpas_iface_message_handler, NULL, NULL, NULL, NULL
670 /* Do nothing if the control interface is not turned on */
671 if (ctrl_iface == NULL)
674 con = ctrl_iface->con;
675 next = ctrl_iface->next_objid++;
677 /* Create and set the interface's object path */
678 wpa_s->dbus_path = os_zalloc(WPAS_DBUS_OBJECT_PATH_MAX);
679 if (wpa_s->dbus_path == NULL)
681 os_snprintf(wpa_s->dbus_path, WPAS_DBUS_OBJECT_PATH_MAX,
682 WPAS_DBUS_PATH_INTERFACES "/%u",
685 /* Register the message handler for the interface functions */
686 if (!dbus_connection_register_fallback(con, wpa_s->dbus_path, &vtable,
688 wpa_printf(MSG_ERROR, "dbus: Could not set up message "
689 "handler for interface %s", wpa_s->ifname);
698 * wpas_dbus_unregister_iface - Unregister an interface from dbus
699 * @wpa_s: wpa_supplicant interface structure
700 * Returns: 0 on success, -1 on failure
702 * Unregisters the interface with dbus
704 int wpas_dbus_unregister_iface(struct wpa_supplicant *wpa_s)
706 struct wpas_dbus_priv *ctrl_iface;
709 /* Do nothing if the control interface is not turned on */
710 if (wpa_s == NULL || wpa_s->global == NULL)
712 ctrl_iface = wpa_s->global->dbus;
713 if (ctrl_iface == NULL)
716 con = ctrl_iface->con;
717 if (!dbus_connection_unregister_object_path(con, wpa_s->dbus_path))
720 os_free(wpa_s->dbus_path);
721 wpa_s->dbus_path = NULL;
728 * wpa_supplicant_get_iface_by_dbus_path - Get a new network interface
729 * @global: Pointer to global data from wpa_supplicant_init()
730 * @path: Pointer to a dbus object path representing an interface
731 * Returns: Pointer to the interface or %NULL if not found
733 struct wpa_supplicant * wpa_supplicant_get_iface_by_dbus_path(
734 struct wpa_global *global, const char *path)
736 struct wpa_supplicant *wpa_s;
738 for (wpa_s = global->ifaces; wpa_s; wpa_s = wpa_s->next) {
739 if (strcmp(wpa_s->dbus_path, path) == 0)