GDBusAuthObserver: GIO Reference Manual

GDBusAuthObserver

GDBusAuthObserver — Object used for authenticating connections

Functions

GDBusAuthObserver *	g_dbus_auth_observer_new ()
gboolean	g_dbus_auth_observer_authorize_authenticated_peer ()
gboolean	g_dbus_auth_observer_allow_mechanism ()

Signals

gboolean	allow-mechanism	Run Last
gboolean	authorize-authenticated-peer	Run Last

Types and Values

GDBusAuthObserver

Object Hierarchy

    GObject
    ╰── GDBusAuthObserver

Includes

#include <gio/gio.h>

Description

The GDBusAuthObserver type provides a mechanism for participating in how a GDBusServer (or a GDBusConnection) authenticates remote peers. Simply instantiate a GDBusAuthObserver and connect to the signals you are interested in. Note that new signals may be added in the future

Controlling Authentication

For example, if you only want to allow D-Bus connections from processes owned by the same uid as the server, you would use a signal handler like the following:

static gboolean
on_authorize_authenticated_peer (GDBusAuthObserver *observer,
                                 GIOStream         *stream,
                                 GCredentials      *credentials,
                                 gpointer           user_data)
{
  gboolean authorized;

  authorized = FALSE;
  if (credentials != NULL)
    {
      GCredentials *own_credentials;
      own_credentials = g_credentials_new ();
      if (g_credentials_is_same_user (credentials, own_credentials, NULL))
        authorized = TRUE;
      g_object_unref (own_credentials);
    }

  return authorized;
}

Functions

g_dbus_auth_observer_new ()

GDBusAuthObserver *
g_dbus_auth_observer_new (void);

Creates a new GDBusAuthObserver object.

Returns

A GDBusAuthObserver. Free with g_object_unref().

Since: 2.26

g_dbus_auth_observer_authorize_authenticated_peer ()

gboolean
g_dbus_auth_observer_authorize_authenticated_peer
                               (GDBusAuthObserver *observer,
                                GIOStream *stream,
                                GCredentials *credentials);

Emits the “authorize-authenticated-peer” signal on observer .

Parameters

observer	A GDBusAuthObserver.
stream	A GIOStream for the GDBusConnection.
credentials	Credentials received from the peer or `NULL`.	[nullable]

Returns

TRUE if the peer is authorized, FALSE if not.

Since: 2.26

g_dbus_auth_observer_allow_mechanism ()

gboolean
g_dbus_auth_observer_allow_mechanism (GDBusAuthObserver *observer,
                                      const gchar *mechanism);

Emits the “allow-mechanism” signal on observer .

Parameters

observer	A GDBusAuthObserver.
mechanism	The name of the mechanism, e.g. `DBUS_COOKIE_SHA1`.

Returns

TRUE if mechanism can be used to authenticate the other peer, FALSE if not.

Since: 2.34

Types and Values