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

Exported types

newtype DBusAuthObserver

Constructors

DBusAuthObserver (ManagedPtr DBusAuthObserver)

Instances

GObject DBusAuthObserver

Methods

gobjectType :: DBusAuthObserver -> IO GType

IsObject DBusAuthObserver

IsDBusAuthObserver DBusAuthObserver

((~) * info (ResolveDBusAuthObserverMethod t DBusAuthObserver), MethodInfo * info DBusAuthObserver p) => IsLabel t (DBusAuthObserver -> p)

Methods

fromLabel :: Proxy# Symbol t -> DBusAuthObserver -> p

((~) * info (ResolveDBusAuthObserverMethod t DBusAuthObserver), MethodInfo * info DBusAuthObserver p) => IsLabelProxy t (DBusAuthObserver -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> DBusAuthObserver -> p

HasAttributeList * DBusAuthObserver

type AttributeList DBusAuthObserver

type AttributeList DBusAuthObserver

type SignalList DBusAuthObserver

type SignalList DBusAuthObserver

class GObject o => IsDBusAuthObserver o

Instances

(GObject a, UnknownAncestorError Constraint DBusAuthObserver a) => IsDBusAuthObserver a

IsDBusAuthObserver DBusAuthObserver

toDBusAuthObserver :: IsDBusAuthObserver o => o -> IO DBusAuthObserver

noDBusAuthObserver :: Maybe DBusAuthObserver

Methods

allowMechanism

data DBusAuthObserverAllowMechanismMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m, IsDBusAuthObserver a) => MethodInfo * DBusAuthObserverAllowMechanismMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusAuthObserverAllowMechanismMethodInfo a -> signature -> s

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 DBusAuthObserver::allow-mechanism signal on observer.

Since: 2.34

authorizeAuthenticatedPeer

data DBusAuthObserverAuthorizeAuthenticatedPeerMethodInfo

Instances

((~) * signature (b -> Maybe c -> m Bool), MonadIO m, IsDBusAuthObserver a, IsIOStream b, IsCredentials c) => MethodInfo * DBusAuthObserverAuthorizeAuthenticatedPeerMethodInfo a signature

Methods

overloadedMethod :: MethodProxy DBusAuthObserverAuthorizeAuthenticatedPeerMethodInfo a -> signature -> s

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 DBusAuthObserver::authorize-authenticated-peer 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 DBusAuthObserverAllowMechanismCallback = Text -> IO Bool

data DBusAuthObserverAllowMechanismSignalInfo

Instances

SignalInfo DBusAuthObserverAllowMechanismSignalInfo

Associated Types

type HaskellCallbackType DBusAuthObserverAllowMechanismSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o DBusAuthObserverAllowMechanismSignalInfo -> o -> HaskellCallbackType DBusAuthObserverAllowMechanismSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType DBusAuthObserverAllowMechanismSignalInfo

type HaskellCallbackType DBusAuthObserverAllowMechanismSignalInfo = DBusAuthObserverAllowMechanismCallback

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

genClosure_DBusAuthObserverAllowMechanism :: DBusAuthObserverAllowMechanismCallback -> IO Closure

mk_DBusAuthObserverAllowMechanismCallback :: C_DBusAuthObserverAllowMechanismCallback -> IO (FunPtr C_DBusAuthObserverAllowMechanismCallback)

noDBusAuthObserverAllowMechanismCallback :: Maybe DBusAuthObserverAllowMechanismCallback

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

wrap_DBusAuthObserverAllowMechanismCallback :: DBusAuthObserverAllowMechanismCallback -> Ptr () -> CString -> Ptr () -> IO CInt

authorizeAuthenticatedPeer

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

type DBusAuthObserverAuthorizeAuthenticatedPeerCallback = IOStream -> Maybe Credentials -> IO Bool

data DBusAuthObserverAuthorizeAuthenticatedPeerSignalInfo

Instances

SignalInfo DBusAuthObserverAuthorizeAuthenticatedPeerSignalInfo

Associated Types

type HaskellCallbackType DBusAuthObserverAuthorizeAuthenticatedPeerSignalInfo :: *

Methods

connectSignal :: GObject o => SignalProxy o DBusAuthObserverAuthorizeAuthenticatedPeerSignalInfo -> o -> HaskellCallbackType DBusAuthObserverAuthorizeAuthenticatedPeerSignalInfo -> SignalConnectMode -> IO SignalHandlerId

type HaskellCallbackType DBusAuthObserverAuthorizeAuthenticatedPeerSignalInfo

type HaskellCallbackType DBusAuthObserverAuthorizeAuthenticatedPeerSignalInfo = DBusAuthObserverAuthorizeAuthenticatedPeerCallback

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

genClosure_DBusAuthObserverAuthorizeAuthenticatedPeer :: DBusAuthObserverAuthorizeAuthenticatedPeerCallback -> IO Closure

mk_DBusAuthObserverAuthorizeAuthenticatedPeerCallback :: C_DBusAuthObserverAuthorizeAuthenticatedPeerCallback -> IO (FunPtr C_DBusAuthObserverAuthorizeAuthenticatedPeerCallback)

noDBusAuthObserverAuthorizeAuthenticatedPeerCallback :: Maybe DBusAuthObserverAuthorizeAuthenticatedPeerCallback

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

wrap_DBusAuthObserverAuthorizeAuthenticatedPeerCallback :: DBusAuthObserverAuthorizeAuthenticatedPeerCallback -> Ptr () -> Ptr IOStream -> Ptr Credentials -> Ptr () -> IO CInt