GI.Gio.Objects.DBusAuthObserver

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

# {auth-observer}

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:

C code

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

Since: 2.26

Exported types

newtype DBusAuthObserver

Memory-managed wrapper type.

Constructors

DBusAuthObserver (ManagedPtr DBusAuthObserver)

Instances

Eq DBusAuthObserver

Defined in GI.Gio.Objects.DBusAuthObserver

Methods

(==) :: DBusAuthObserver -> DBusAuthObserver -> Bool

(/=) :: DBusAuthObserver -> DBusAuthObserver -> Bool

GObject DBusAuthObserver

Defined in GI.Gio.Objects.DBusAuthObserver

Methods

gobjectType :: IO GType

IsGValue DBusAuthObserver

Convert DBusAuthObserver to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Objects.DBusAuthObserver

Methods

toGValue :: DBusAuthObserver -> IO GValue

fromGValue :: GValue -> IO DBusAuthObserver

HasParentTypes DBusAuthObserver

Defined in GI.Gio.Objects.DBusAuthObserver

type ParentTypes DBusAuthObserver

Defined in GI.Gio.Objects.DBusAuthObserver

type ParentTypes DBusAuthObserver = '[Object]

class (GObject o, IsDescendantOf DBusAuthObserver o) => IsDBusAuthObserver o

Type class for types which can be safely cast to DBusAuthObserver, for instance with toDBusAuthObserver.

Instances

(GObject o, IsDescendantOf DBusAuthObserver o) => IsDBusAuthObserver o

Defined in GI.Gio.Objects.DBusAuthObserver

toDBusAuthObserver :: (MonadIO m, IsDBusAuthObserver o) => o -> m DBusAuthObserver

Cast to DBusAuthObserver, for types for which this is known to be safe. For general casts, use castTo.

noDBusAuthObserver :: Maybe DBusAuthObserver

A convenience alias for Nothing :: Maybe DBusAuthObserver.

Methods

Overloaded methods

allowMechanism

dBusAuthObserverAllowMechanism

Arguments

:: (HasCallStack, MonadIO m, IsDBusAuthObserver a)

=> a

observer: A DBusAuthObserver.

-> Text

mechanism: The name of the mechanism, e.g. DBUS_COOKIE_SHA1.

-> m Bool

Returns: True if mechanism can be used to authenticate the other peer, False if not.

Emits the allowMechanism signal on observer.

Since: 2.34

authorizeAuthenticatedPeer

dBusAuthObserverAuthorizeAuthenticatedPeer

Arguments

:: (HasCallStack, MonadIO m, IsDBusAuthObserver a, IsIOStream b, IsCredentials c)

=> a

observer: A DBusAuthObserver.

-> b

stream: A IOStream for the DBusConnection.

-> Maybe c

credentials: Credentials received from the peer or Nothing.

-> m Bool

Returns: True if the peer is authorized, False if not.

Emits the authorizeAuthenticatedPeer signal on observer.

Since: 2.26

new

dBusAuthObserverNew

Arguments

:: (HasCallStack, MonadIO m)

=> m DBusAuthObserver

Returns: A DBusAuthObserver. Free with objectUnref.

Creates a new DBusAuthObserver object.

Since: 2.26

Signals

allowMechanism

type C_DBusAuthObserverAllowMechanismCallback = Ptr () -> CString -> Ptr () -> IO CInt

Type for the callback on the (unwrapped) C side.

type DBusAuthObserverAllowMechanismCallback

Arguments

 = Text

mechanism: The name of the mechanism, e.g. DBUS_COOKIE_SHA1.

-> IO Bool

Returns: True if mechanism can be used to authenticate the other peer, False if not.

Emitted to check if mechanism is allowed to be used.

Since: 2.34

afterDBusAuthObserverAllowMechanism :: (IsDBusAuthObserver a, MonadIO m) => a -> DBusAuthObserverAllowMechanismCallback -> m SignalHandlerId

Connect a signal handler for the allowMechanism signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dBusAuthObserver #allowMechanism callback

genClosure_DBusAuthObserverAllowMechanism :: MonadIO m => DBusAuthObserverAllowMechanismCallback -> m (GClosure C_DBusAuthObserverAllowMechanismCallback)

Wrap the callback into a GClosure.

mk_DBusAuthObserverAllowMechanismCallback :: C_DBusAuthObserverAllowMechanismCallback -> IO (FunPtr C_DBusAuthObserverAllowMechanismCallback)

Generate a function pointer callable from C code, from a C_DBusAuthObserverAllowMechanismCallback.

noDBusAuthObserverAllowMechanismCallback :: Maybe DBusAuthObserverAllowMechanismCallback

A convenience synonym for Nothing :: Maybe DBusAuthObserverAllowMechanismCallback.

onDBusAuthObserverAllowMechanism :: (IsDBusAuthObserver a, MonadIO m) => a -> DBusAuthObserverAllowMechanismCallback -> m SignalHandlerId

Connect a signal handler for the allowMechanism signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dBusAuthObserver #allowMechanism callback

wrap_DBusAuthObserverAllowMechanismCallback :: DBusAuthObserverAllowMechanismCallback -> C_DBusAuthObserverAllowMechanismCallback

Wrap a DBusAuthObserverAllowMechanismCallback into a C_DBusAuthObserverAllowMechanismCallback.

authorizeAuthenticatedPeer

type C_DBusAuthObserverAuthorizeAuthenticatedPeerCallback = Ptr () -> Ptr IOStream -> Ptr Credentials -> Ptr () -> IO CInt

Type for the callback on the (unwrapped) C side.

type DBusAuthObserverAuthorizeAuthenticatedPeerCallback

Arguments

 = IOStream

stream: A IOStream for the DBusConnection.

-> Maybe Credentials

credentials: Credentials received from the peer or Nothing.

-> IO Bool

Returns: True if the peer is authorized, False if not.

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

Since: 2.26

afterDBusAuthObserverAuthorizeAuthenticatedPeer :: (IsDBusAuthObserver a, MonadIO m) => a -> DBusAuthObserverAuthorizeAuthenticatedPeerCallback -> m SignalHandlerId

Connect a signal handler for the authorizeAuthenticatedPeer signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dBusAuthObserver #authorizeAuthenticatedPeer callback

genClosure_DBusAuthObserverAuthorizeAuthenticatedPeer :: MonadIO m => DBusAuthObserverAuthorizeAuthenticatedPeerCallback -> m (GClosure C_DBusAuthObserverAuthorizeAuthenticatedPeerCallback)

Wrap the callback into a GClosure.

mk_DBusAuthObserverAuthorizeAuthenticatedPeerCallback :: C_DBusAuthObserverAuthorizeAuthenticatedPeerCallback -> IO (FunPtr C_DBusAuthObserverAuthorizeAuthenticatedPeerCallback)

Generate a function pointer callable from C code, from a C_DBusAuthObserverAuthorizeAuthenticatedPeerCallback.

noDBusAuthObserverAuthorizeAuthenticatedPeerCallback :: Maybe DBusAuthObserverAuthorizeAuthenticatedPeerCallback

A convenience synonym for Nothing :: Maybe DBusAuthObserverAuthorizeAuthenticatedPeerCallback.

onDBusAuthObserverAuthorizeAuthenticatedPeer :: (IsDBusAuthObserver a, MonadIO m) => a -> DBusAuthObserverAuthorizeAuthenticatedPeerCallback -> m SignalHandlerId

Connect a signal handler for the authorizeAuthenticatedPeer signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dBusAuthObserver #authorizeAuthenticatedPeer callback

wrap_DBusAuthObserverAuthorizeAuthenticatedPeerCallback :: DBusAuthObserverAuthorizeAuthenticatedPeerCallback -> C_DBusAuthObserverAuthorizeAuthenticatedPeerCallback

Wrap a DBusAuthObserverAuthorizeAuthenticatedPeerCallback into a C_DBusAuthObserverAuthorizeAuthenticatedPeerCallback.