Struct gio::DBusAuthObserver

pub struct DBusAuthObserver { /* private fields */ }

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

Controlling Authentication Mechanisms

By default, a DBusServer or server-side DBusConnection will allow any authentication mechanism to be used. If you only want to allow D-Bus connections with the EXTERNAL mechanism, which makes use of credentials passing and is the recommended mechanism for modern Unix platforms such as Linux and the BSD family, you would use a signal handler like this:

⚠️ The following code is in C ⚠️

static gboolean
on_allow_mechanism (GDBusAuthObserver *observer,
                    const gchar       *mechanism,
                    gpointer           user_data)
{
  if (g_strcmp0 (mechanism, "EXTERNAL") == 0)
    {
      return TRUE;
    }

  return FALSE;
}

Controlling Authorization # {auth-observer}

By default, a DBusServer or server-side DBusConnection will accept connections from any successfully authenticated user (but not from anonymous connections using the ANONYMOUS mechanism). If you only want to allow D-Bus connections from processes owned by the same uid as the server, since GLib 2.68, you should use the DBusServerFlags::AUTHENTICATION_REQUIRE_SAME_USER flag. It’s equivalent to the following signal handler:

⚠️ The following code is in C ⚠️

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;
}

Signals

allow-mechanism

Emitted to check if mechanism is allowed to be used.

authorize-authenticated-peer

Emitted to check if a peer that is successfully authenticated is authorized.

Implements

glib::ObjectExt

Implementations

impl DBusAuthObserver

pub fn new() -> DBusAuthObserver

Creates a new DBusAuthObserver object.

Returns

A DBusAuthObserver. Free with g_object_unref().

pub fn allow_mechanism(&self, mechanism: &str) -> bool

Emits the allow-mechanism signal on self.

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.

pub fn authorize_authenticated_peer( &self, stream: &impl IsA<IOStream>, credentials: Option<&Credentials> ) -> bool

Emits the authorize-authenticated-peer signal on self.

stream

A IOStream for the DBusConnection.

credentials

Credentials received from the peer or None.

Returns

true if the peer is authorized, false if not.

pub fn connect_allow_mechanism<F: Fn(&Self, &str) -> bool + 'static>( &self, f: F ) -> SignalHandlerId

Emitted to check if mechanism is allowed to be used.

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.

pub fn connect_authorize_authenticated_peer<F: Fn(&Self, &IOStream, Option<&Credentials>) -> bool + 'static>( &self, f: F ) -> SignalHandlerId

Emitted to check if a peer that is successfully authenticated is authorized.

stream

A IOStream for the DBusConnection.

credentials

Credentials received from the peer or None.

Returns

true if the peer is authorized, false if not.

Trait Implementations

impl Clone for DBusAuthObserver

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DBusAuthObserver

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DBusAuthObserver

fn default() -> Self

Returns the “default value” for a type.

impl Display for DBusAuthObserver

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for DBusAuthObserver

type ParamSpec = ParamSpecObject

type SetValue = DBusAuthObserver

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, DBusAuthObserver>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for DBusAuthObserver

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DBusAuthObserver

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for DBusAuthObserver

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for DBusAuthObserver

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for DBusAuthObserver

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for DBusAuthObserver

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for DBusAuthObserver