Gio.DebugControllerDBus¶
- Subclasses:
None
Methods¶
- Inherited:
GObject.Object (37), Gio.DebugController (2), Gio.Initable (2)
- Structs:
class |
|
|
Virtual Methods¶
- Inherited:
|
Properties¶
- Inherited:
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w/co |
The D-Bus connection to expose the debugging interface on. |
Signals¶
- Inherited:
Name |
Short Description |
---|---|
Emitted when a D-Bus peer is trying to change the debug settings and used to determine if that is authorized. |
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent_instance |
r |
Class Details¶
- class Gio.DebugControllerDBus(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
Gio.DebugControllerDBus
is an implementation ofGio.DebugController
which exposes debug settings as a D-Bus object.It is a
Gio.Initable
object, and will register an object at/org/gtk/Debugging
on the bus given asGio.DebugControllerDBus
:connection
once it’s initialized. The object will be unregistered when the last reference to theGio.DebugControllerDBus
is dropped.This D-Bus object can be used by remote processes to enable or disable debug output in this process. Remote processes calling
org.gtk.Debugging.SetDebugEnabled()
will affect the value ofGio.DebugController
:debug-enabled
and, by default,GLib.log_get_debug_enabled
(). default.By default, no processes are allowed to call
SetDebugEnabled()
unless aGio.DebugControllerDBus
::authorize
signal handler is installed. This is because the process may be privileged, or might expose sensitive information in its debug output. You may want to restrict the ability to enable debug output to privileged users or processes.One option is to install a D-Bus security policy which restricts access to
SetDebugEnabled()
, installing something like the following in$datadir/dbus-1/system.d/
:<?xml version="1.0"?> <!--*-nxml-*--> <!DOCTYPE busconfig PUBLIC "-//freedesktop//DTD D-BUS Bus Configuration 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd"> <busconfig> <policy user="root"> <allow send_destination="com.example.MyService" send_interface="org.gtk.Debugging"/> </policy> <policy context="default"> <deny send_destination="com.example.MyService" send_interface="org.gtk.Debugging"/> </policy> </busconfig>
This will prevent the
SetDebugEnabled()
method from being called by all except root. It will not prevent theDebugEnabled
property from being read, as it’s accessed through theorg.freedesktop.DBus.Properties
interface.Another option is to use polkit to allow or deny requests on a case-by-case basis, allowing for the possibility of dynamic authorisation. To do this, connect to the
Gio.DebugControllerDBus
::authorize
signal and query polkit in it:g_autoptr(GError) child_error = NULL; g_autoptr(GDBusConnection) connection = g_bus_get_sync (G_BUS_TYPE_SYSTEM, NULL, NULL); gulong debug_controller_authorize_id = 0; // Set up the debug controller. debug_controller = G_DEBUG_CONTROLLER (g_debug_controller_dbus_new (priv->connection, NULL, &child_error)); if (debug_controller == NULL) { g_error ("Could not register debug controller on bus: %s"), child_error->message); } debug_controller_authorize_id = g_signal_connect (debug_controller, "authorize", G_CALLBACK (debug_controller_authorize_cb), self); static gboolean debug_controller_authorize_cb (GDebugControllerDBus *debug_controller, GDBusMethodInvocation *invocation, gpointer user_data) { g_autoptr(PolkitAuthority) authority = NULL; g_autoptr(PolkitSubject) subject = NULL; g_autoptr(PolkitAuthorizationResult) auth_result = NULL; g_autoptr(GError) local_error = NULL; GDBusMessage *message; GDBusMessageFlags message_flags; PolkitCheckAuthorizationFlags flags = POLKIT_CHECK_AUTHORIZATION_FLAGS_NONE; message = g_dbus_method_invocation_get_message (invocation); message_flags = g_dbus_message_get_flags (message); authority = polkit_authority_get_sync (NULL, &local_error); if (authority == NULL) { g_warning ("Failed to get polkit authority: %s", local_error->message); return FALSE; } if (message_flags & G_DBUS_MESSAGE_FLAGS_ALLOW_INTERACTIVE_AUTHORIZATION) flags |= POLKIT_CHECK_AUTHORIZATION_FLAGS_ALLOW_USER_INTERACTION; subject = polkit_system_bus_name_new (g_dbus_method_invocation_get_sender (invocation)); auth_result = polkit_authority_check_authorization_sync (authority, subject, "com.example.MyService.set-debug-enabled", NULL, flags, NULL, &local_error); if (auth_result == NULL) { g_warning ("Failed to get check polkit authorization: %s", local_error->message); return FALSE; } return polkit_authorization_result_get_is_authorized (auth_result); }
New in version 2.72.
- classmethod new(connection, cancellable)[source]¶
- Parameters:
connection (
Gio.DBusConnection
) – aGio.DBusConnection
to register the debug object oncancellable (
Gio.Cancellable
orNone
) – aGio.Cancellable
, orNone
- Raises:
- Returns:
a new
Gio.DebugControllerDBus
, orNone
on failure- Return type:
Create a new
Gio.DebugControllerDBus
and synchronously initialize it.Initializing the object will export the debug object on connection. The object will remain registered until the last reference to the
Gio.DebugControllerDBus
is dropped.Initialization may fail if registering the object on connection fails.
New in version 2.72.
- stop()[source]¶
Stop the debug controller, unregistering its object from the bus.
Any pending method calls to the object will complete successfully, but new ones will return an error. This method will block until all pending
Gio.DebugControllerDBus
::authorize
signals have been handled. This is expected to not take long, as it will just be waiting for threads to join. If anyGio.DebugControllerDBus
::authorize
signal handlers are still executing in other threads, this will block until after they have returned.This method will be called automatically when the final reference to the
Gio.DebugControllerDBus
is dropped. You may want to call it explicitly to know when the controller has been fully removed from the bus, or to break reference count cycles.Calling this method from within a
Gio.DebugControllerDBus
::authorize
signal handler will cause a deadlock and must not be done.New in version 2.72.
- do_authorize(invocation) virtual¶
- Parameters:
invocation (
Gio.DBusMethodInvocation
) –- Return type:
Signal Details¶
- Gio.DebugControllerDBus.signals.authorize(debug_controller_d_bus, invocation)¶
- Signal Name:
authorize
- Flags:
- Parameters:
debug_controller_d_bus (
Gio.DebugControllerDBus
) – The object which received the signalinvocation (
Gio.DBusMethodInvocation
) – AGio.DBusMethodInvocation
.
- Returns:
- Return type:
Emitted when a D-Bus peer is trying to change the debug settings and used to determine if that is authorized.
This signal is emitted in a dedicated worker thread, so handlers are allowed to perform blocking I/O. This means that, for example, it is appropriate to call
polkit_authority_check_authorization_sync()
to check authorization using polkit.If
False
is returned then no further handlers are run and the request to change the debug settings is rejected.Otherwise, if
True
is returned, signal emission continues. If no handlers returnFalse
, then the debug settings are allowed to be changed.Signal handlers must not modify invocation, or cause it to return a value.
The default class handler just returns
True
.New in version 2.72.
Property Details¶
- Gio.DebugControllerDBus.props.connection¶
- Name:
connection
- Type:
- Default Value:
- Flags:
The D-Bus connection to expose the debugging interface on.
Typically this will be the same connection (to the system or session bus) which the rest of the application or service’s D-Bus objects are registered on.
New in version 2.72.