Interface Channel.Type.ServerAuthentication.DRAFT2

Interface Index (Compact) | Summary | Description | Properties | Types

Properties

AuthenticationInformation a{sv} (Auth_Details) Read only
AuthenticationMethod u (Authentication_Type) Read only

Types

Authentication_Type Enum u
Auth_Details Mapping a{sv}
WARNING: This interface is experimental and is likely to cause havoc to your API/ABI if bindings are generated. Do not include this interface in libraries that care about compatibility.
Added in 0.21.UNRELEASED. (draft 2)
Objects implementing this interface must also implement:

Description

The type for a channel representing an authentication step with the server. The actual authentication functionality is implemented by additional interfaces, such as Channel.Interface.SASLAuthentication.DRAFT2, depending on the value of AuthenticationMethod.

Channels of this type SHOULD be signalled and dispatched while the Connection owning them is in the CONNECTING state. Normally, only one channel of this type will exist on a given Connection; if there is more than one, the handler must complete authentication with each of them in turn.

Channels of this type cannot be requested with methods such as CreateChannel. They always have Requested = False, TargetHandleType = None and TargetHandle = 0.

Properties

Accessed using the org.freedesktop.DBus.Properties interface.
(Permalink)

AuthenticationInformation — a{sv} (Auth_Details)

Read only
Dictionary of information given by the CM which can be used by the handler for authentication.
(Permalink)

AuthenticationMethod — u (Authentication_Type)

Read only
This property defines the method used for the current authentication step. The functionality for each method is on a separate interface on the same channel; for example, channels with this property set to Authentication_Type SASL MUST implement Channel.Interface.SASLAuthentication.DRAFT2.

Types

Enum (Permalink)

Authentication_Type — u

The type of authentication offered by a ServerAuthentication channel. At the moment only Authentication_Type_SASL is supported, but Authentication_Type_Captcha is likely to be added in future.

Mapping (Permalink)

Auth_Details — a{sv}

An extensible map representing details provided by the server for authentication. Well-known keys, along with the type expected in the corresponding value:

username (string)
The SASLAuthentication.DRAFT2.AuthorizationIdentity property.
realm (string)
The SASLAuthentication.DRAFT2.DefaultRealm property.
session-id (string)
The jabber-stream-id from the SASLAuthentication.DRAFT2.ExtraContext property.
  • Key — s
    • A key for a detail, which SHOULD be one of the well-known keys, if possible.
  • Value — v
    • The detail's value.