Service-side Channel Authentication interfaces

Service-side Channel Authentication interfaces — GInterfaces to implement authentication channels

Functions

void (*tp_svc_channel_interface_sasl_authentication1_abort_sasl_impl) ()
void (*tp_svc_channel_interface_sasl_authentication1_accept_sasl_impl) ()
void tp_svc_channel_interface_sasl_authentication1_emit_new_challenge ()
void tp_svc_channel_interface_sasl_authentication1_emit_sasl_status_changed ()
void tp_svc_channel_interface_sasl_authentication1_implement_abort_sasl ()
void tp_svc_channel_interface_sasl_authentication1_implement_accept_sasl ()
void tp_svc_channel_interface_sasl_authentication1_implement_respond ()
void tp_svc_channel_interface_sasl_authentication1_implement_start_mechanism ()
void tp_svc_channel_interface_sasl_authentication1_implement_start_mechanism_with_data ()
void (*tp_svc_channel_interface_sasl_authentication1_respond_impl) ()
void tp_svc_channel_interface_sasl_authentication1_return_from_abort_sasl ()
void tp_svc_channel_interface_sasl_authentication1_return_from_accept_sasl ()
void tp_svc_channel_interface_sasl_authentication1_return_from_respond ()
void tp_svc_channel_interface_sasl_authentication1_return_from_start_mechanism ()
void tp_svc_channel_interface_sasl_authentication1_return_from_start_mechanism_with_data ()
void (*tp_svc_channel_interface_sasl_authentication1_start_mechanism_impl) ()
void (*tp_svc_channel_interface_sasl_authentication1_start_mechanism_with_data_impl) ()
void (*tp_svc_channel_interface_captcha_authentication1_answer_captchas_impl) ()
void (*tp_svc_channel_interface_captcha_authentication1_cancel_captcha_impl) ()
void (*tp_svc_channel_interface_captcha_authentication1_get_captcha_data_impl) ()
void (*tp_svc_channel_interface_captcha_authentication1_get_captchas_impl) ()
void tp_svc_channel_interface_captcha_authentication1_implement_answer_captchas ()
void tp_svc_channel_interface_captcha_authentication1_implement_cancel_captcha ()
void tp_svc_channel_interface_captcha_authentication1_implement_get_captcha_data ()
void tp_svc_channel_interface_captcha_authentication1_implement_get_captchas ()
void tp_svc_channel_interface_captcha_authentication1_return_from_answer_captchas ()
void tp_svc_channel_interface_captcha_authentication1_return_from_cancel_captcha ()
void tp_svc_channel_interface_captcha_authentication1_return_from_get_captcha_data ()
void tp_svc_channel_interface_captcha_authentication1_return_from_get_captchas ()

Signals

void new-challenge Has Details
void s-as-lstatus-changed Has Details

Types and Values

  TpSvcChannelTypeServerAuthentication1
  TpSvcChannelTypeServerAuthentication1Class
  TpSvcChannelInterfaceSASLAuthentication1
  TpSvcChannelInterfaceSASLAuthentication1Class
  TpSvcChannelInterfaceCaptchaAuthentication1
  TpSvcChannelInterfaceCaptchaAuthentication1Class

Object Hierarchy

    GInterface
    ├── TpSvcChannelInterfaceCaptchaAuthentication1
    ├── TpSvcChannelInterfaceSASLAuthentication1
    ╰── TpSvcChannelTypeServerAuthentication1

Known Implementations

TpSvcChannelTypeServerAuthentication1 is implemented by TpBasePasswordChannel.

TpSvcChannelInterfaceSASLAuthentication1 is implemented by TpBasePasswordChannel.

Includes

#include <telepathy-glib/telepathy-glib-dbus.h>

Description

The ServerAuthentication channel type represents a request for client/UI processes to carry out authentication with a server.

The SASLAuthentication interface allows authentication via SASL, and also allows providing a simple password to the connection manager for it to use with SASL or non-SASL mechanisms.

The CaptchaAuthentication interface (since 0.17.5) allows interactive captcha-solving so that the user can prove that they are not a bot, on protocols requiring this.

Functions

tp_svc_channel_interface_sasl_authentication1_abort_sasl_impl ()

void
(*tp_svc_channel_interface_sasl_authentication1_abort_sasl_impl)
                               (TpSvcChannelInterfaceSASLAuthentication1 *self,
                                guint in_Reason,
                                const gchar *in_Debug_Message,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method AbortSASL on interface im.telepathy.v1.Channel.Interface.SASLAuthentication1.

Parameters

self

The object implementing this interface

  

in_Reason

guint (FIXME, generate documentation)

  

in_Debug_Message

const gchar * (FIXME, generate documentation)

  

invocation

Used to return values or throw an error

  

tp_svc_channel_interface_sasl_authentication1_accept_sasl_impl ()

void
(*tp_svc_channel_interface_sasl_authentication1_accept_sasl_impl)
                               (TpSvcChannelInterfaceSASLAuthentication1 *self,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method AcceptSASL on interface im.telepathy.v1.Channel.Interface.SASLAuthentication1.

Parameters

self

The object implementing this interface

  

invocation

Used to return values or throw an error

  

tp_svc_channel_interface_sasl_authentication1_emit_new_challenge ()

void
tp_svc_channel_interface_sasl_authentication1_emit_new_challenge
                               (gpointer instance,
                                const GArray *arg_Challenge_Data);

Type-safe wrapper around g_signal_emit to emit the NewChallenge signal on interface im.telepathy.v1.Channel.Interface.SASLAuthentication1.

Parameters

instance

The object implementing this interface

  

arg_Challenge_Data

const GArray * (FIXME, generate documentation)

  

tp_svc_channel_interface_sasl_authentication1_emit_sasl_status_changed ()

void
tp_svc_channel_interface_sasl_authentication1_emit_sasl_status_changed
                               (gpointer instance,
                                guint arg_Status,
                                const gchar *arg_Reason,
                                GHashTable *arg_Details);

Type-safe wrapper around g_signal_emit to emit the SASLStatusChanged signal on interface im.telepathy.v1.Channel.Interface.SASLAuthentication1.

Parameters

instance

The object implementing this interface

  

arg_Status

guint (FIXME, generate documentation)

  

arg_Reason

const gchar * (FIXME, generate documentation)

  

arg_Details

GHashTable * (FIXME, generate documentation)

  

tp_svc_channel_interface_sasl_authentication1_implement_abort_sasl ()

void
tp_svc_channel_interface_sasl_authentication1_implement_abort_sasl
                               (TpSvcChannelInterfaceSASLAuthentication1Class *klass,
                                tp_svc_channel_interface_sasl_authentication1_abort_sasl_impl impl);

Register an implementation for the AbortSASL method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

  

impl

A callback used to implement the AbortSASL D-Bus method

  

tp_svc_channel_interface_sasl_authentication1_implement_accept_sasl ()

void
tp_svc_channel_interface_sasl_authentication1_implement_accept_sasl
                               (TpSvcChannelInterfaceSASLAuthentication1Class *klass,
                                tp_svc_channel_interface_sasl_authentication1_accept_sasl_impl impl);

Register an implementation for the AcceptSASL method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

  

impl

A callback used to implement the AcceptSASL D-Bus method

  

tp_svc_channel_interface_sasl_authentication1_implement_respond ()

void
tp_svc_channel_interface_sasl_authentication1_implement_respond
                               (TpSvcChannelInterfaceSASLAuthentication1Class *klass,
                                tp_svc_channel_interface_sasl_authentication1_respond_impl impl);

Register an implementation for the Respond method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

  

impl

A callback used to implement the Respond D-Bus method

  

tp_svc_channel_interface_sasl_authentication1_implement_start_mechanism ()

void
tp_svc_channel_interface_sasl_authentication1_implement_start_mechanism
                               (TpSvcChannelInterfaceSASLAuthentication1Class *klass,
                                tp_svc_channel_interface_sasl_authentication1_start_mechanism_impl impl);

Register an implementation for the StartMechanism method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

  

impl

A callback used to implement the StartMechanism D-Bus method

  

tp_svc_channel_interface_sasl_authentication1_implement_start_mechanism_with_data ()

void
tp_svc_channel_interface_sasl_authentication1_implement_start_mechanism_with_data
                               (TpSvcChannelInterfaceSASLAuthentication1Class *klass,
                                tp_svc_channel_interface_sasl_authentication1_start_mechanism_with_data_impl impl);

Register an implementation for the StartMechanismWithData method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

  

impl

A callback used to implement the StartMechanismWithData D-Bus method

  

tp_svc_channel_interface_sasl_authentication1_respond_impl ()

void
(*tp_svc_channel_interface_sasl_authentication1_respond_impl)
                               (TpSvcChannelInterfaceSASLAuthentication1 *self,
                                const GArray *in_Response_Data,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method Respond on interface im.telepathy.v1.Channel.Interface.SASLAuthentication1.

Parameters

self

The object implementing this interface

  

in_Response_Data

const GArray * (FIXME, generate documentation)

  

invocation

Used to return values or throw an error

  

tp_svc_channel_interface_sasl_authentication1_return_from_abort_sasl ()

void
tp_svc_channel_interface_sasl_authentication1_return_from_abort_sasl
                               (GDBusMethodInvocation *invocation);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

  

tp_svc_channel_interface_sasl_authentication1_return_from_accept_sasl ()

void
tp_svc_channel_interface_sasl_authentication1_return_from_accept_sasl
                               (GDBusMethodInvocation *invocation);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

  

tp_svc_channel_interface_sasl_authentication1_return_from_respond ()

void
tp_svc_channel_interface_sasl_authentication1_return_from_respond
                               (GDBusMethodInvocation *invocation);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

  

tp_svc_channel_interface_sasl_authentication1_return_from_start_mechanism ()

void
tp_svc_channel_interface_sasl_authentication1_return_from_start_mechanism
                               (GDBusMethodInvocation *invocation);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

  

tp_svc_channel_interface_sasl_authentication1_return_from_start_mechanism_with_data ()

void
tp_svc_channel_interface_sasl_authentication1_return_from_start_mechanism_with_data
                               (GDBusMethodInvocation *invocation);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

  

tp_svc_channel_interface_sasl_authentication1_start_mechanism_impl ()

void
(*tp_svc_channel_interface_sasl_authentication1_start_mechanism_impl)
                               (TpSvcChannelInterfaceSASLAuthentication1 *self,
                                const gchar *in_Mechanism,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method StartMechanism on interface im.telepathy.v1.Channel.Interface.SASLAuthentication1.

Parameters

self

The object implementing this interface

  

in_Mechanism

const gchar * (FIXME, generate documentation)

  

invocation

Used to return values or throw an error

  

tp_svc_channel_interface_sasl_authentication1_start_mechanism_with_data_impl ()

void
(*tp_svc_channel_interface_sasl_authentication1_start_mechanism_with_data_impl)
                               (TpSvcChannelInterfaceSASLAuthentication1 *self,
                                const gchar *in_Mechanism,
                                const GArray *in_Initial_Data,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method StartMechanismWithData on interface im.telepathy.v1.Channel.Interface.SASLAuthentication1.

Parameters

self

The object implementing this interface

  

in_Mechanism

const gchar * (FIXME, generate documentation)

  

in_Initial_Data

const GArray * (FIXME, generate documentation)

  

invocation

Used to return values or throw an error

  

tp_svc_channel_interface_captcha_authentication1_answer_captchas_impl ()

void
(*tp_svc_channel_interface_captcha_authentication1_answer_captchas_impl)
                               (TpSvcChannelInterfaceCaptchaAuthentication1 *self,
                                GHashTable *in_Answers,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method AnswerCaptchas on interface im.telepathy.v1.Channel.Interface.CaptchaAuthentication1.

Parameters

self

The object implementing this interface

  

in_Answers

GHashTable * (FIXME, generate documentation)

  

invocation

Used to return values or throw an error

  

tp_svc_channel_interface_captcha_authentication1_cancel_captcha_impl ()

void
(*tp_svc_channel_interface_captcha_authentication1_cancel_captcha_impl)
                               (TpSvcChannelInterfaceCaptchaAuthentication1 *self,
                                guint in_Reason,
                                const gchar *in_Debug_Message,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method CancelCaptcha on interface im.telepathy.v1.Channel.Interface.CaptchaAuthentication1.

Parameters

self

The object implementing this interface

  

in_Reason

guint (FIXME, generate documentation)

  

in_Debug_Message

const gchar * (FIXME, generate documentation)

  

invocation

Used to return values or throw an error

  

tp_svc_channel_interface_captcha_authentication1_get_captcha_data_impl ()

void
(*tp_svc_channel_interface_captcha_authentication1_get_captcha_data_impl)
                               (TpSvcChannelInterfaceCaptchaAuthentication1 *self,
                                guint in_ID,
                                const gchar *in_Mime_Type,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method GetCaptchaData on interface im.telepathy.v1.Channel.Interface.CaptchaAuthentication1.

Parameters

self

The object implementing this interface

  

in_ID

guint (FIXME, generate documentation)

  

in_Mime_Type

const gchar * (FIXME, generate documentation)

  

invocation

Used to return values or throw an error

  

tp_svc_channel_interface_captcha_authentication1_get_captchas_impl ()

void
(*tp_svc_channel_interface_captcha_authentication1_get_captchas_impl)
                               (TpSvcChannelInterfaceCaptchaAuthentication1 *self,
                                GDBusMethodInvocation *invocation);

The signature of an implementation of the D-Bus method GetCaptchas on interface im.telepathy.v1.Channel.Interface.CaptchaAuthentication1.

Parameters

self

The object implementing this interface

  

invocation

Used to return values or throw an error

  

tp_svc_channel_interface_captcha_authentication1_implement_answer_captchas ()

void
tp_svc_channel_interface_captcha_authentication1_implement_answer_captchas
                               (TpSvcChannelInterfaceCaptchaAuthentication1Class *klass,
                                tp_svc_channel_interface_captcha_authentication1_answer_captchas_impl impl);

Register an implementation for the AnswerCaptchas method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

  

impl

A callback used to implement the AnswerCaptchas D-Bus method

  

tp_svc_channel_interface_captcha_authentication1_implement_cancel_captcha ()

void
tp_svc_channel_interface_captcha_authentication1_implement_cancel_captcha
                               (TpSvcChannelInterfaceCaptchaAuthentication1Class *klass,
                                tp_svc_channel_interface_captcha_authentication1_cancel_captcha_impl impl);

Register an implementation for the CancelCaptcha method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

  

impl

A callback used to implement the CancelCaptcha D-Bus method

  

tp_svc_channel_interface_captcha_authentication1_implement_get_captcha_data ()

void
tp_svc_channel_interface_captcha_authentication1_implement_get_captcha_data
                               (TpSvcChannelInterfaceCaptchaAuthentication1Class *klass,
                                tp_svc_channel_interface_captcha_authentication1_get_captcha_data_impl impl);

Register an implementation for the GetCaptchaData method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

  

impl

A callback used to implement the GetCaptchaData D-Bus method

  

tp_svc_channel_interface_captcha_authentication1_implement_get_captchas ()

void
tp_svc_channel_interface_captcha_authentication1_implement_get_captchas
                               (TpSvcChannelInterfaceCaptchaAuthentication1Class *klass,
                                tp_svc_channel_interface_captcha_authentication1_get_captchas_impl impl);

Register an implementation for the GetCaptchas method in the vtable of an implementation of this interface. To be called from the interface init function.

Parameters

klass

A class whose instances implement this interface

  

impl

A callback used to implement the GetCaptchas D-Bus method

  

tp_svc_channel_interface_captcha_authentication1_return_from_answer_captchas ()

void
tp_svc_channel_interface_captcha_authentication1_return_from_answer_captchas
                               (GDBusMethodInvocation *invocation);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

  

tp_svc_channel_interface_captcha_authentication1_return_from_cancel_captcha ()

void
tp_svc_channel_interface_captcha_authentication1_return_from_cancel_captcha
                               (GDBusMethodInvocation *invocation);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

  

tp_svc_channel_interface_captcha_authentication1_return_from_get_captcha_data ()

void
tp_svc_channel_interface_captcha_authentication1_return_from_get_captcha_data
                               (GDBusMethodInvocation *invocation,
                                const GArray *out_Captcha_Data);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

  

out_Captcha_Data

const GArray * (FIXME, generate documentation)

  

tp_svc_channel_interface_captcha_authentication1_return_from_get_captchas ()

void
tp_svc_channel_interface_captcha_authentication1_return_from_get_captchas
                               (GDBusMethodInvocation *invocation,
                                const GPtrArray *out_Captcha_Info,
                                guint out_Number_Required,
                                const gchar *out_Language);

Return successfully by calling g_dbus_method_invocation_return_value().

Parameters

invocation

The D-Bus method invocation context

  

out_Captcha_Info

const GPtrArray * (FIXME, generate documentation)

  

out_Number_Required

guint (FIXME, generate documentation)

  

out_Language

const gchar * (FIXME, generate documentation)

  

Types and Values

TpSvcChannelTypeServerAuthentication1

typedef struct _TpSvcChannelTypeServerAuthentication1 TpSvcChannelTypeServerAuthentication1;

Dummy typedef representing any implementation of this interface.

TpSvcChannelTypeServerAuthentication1Class

typedef struct _TpSvcChannelTypeServerAuthentication1Class TpSvcChannelTypeServerAuthentication1Class;

The class of TpSvcChannelTypeServerAuthentication1. This interface has no D-Bus methods, so an implementation can typically pass NULL to G_IMPLEMENT_INTERFACE() as the interface initialization function.

TpSvcChannelInterfaceSASLAuthentication1

typedef struct _TpSvcChannelInterfaceSASLAuthentication1 TpSvcChannelInterfaceSASLAuthentication1;

Dummy typedef representing any implementation of this interface.

TpSvcChannelInterfaceSASLAuthentication1Class

typedef struct _TpSvcChannelInterfaceSASLAuthentication1Class TpSvcChannelInterfaceSASLAuthentication1Class;

The class of TpSvcChannelInterfaceSASLAuthentication1.

In a full implementation of this interface (i.e. all methods implemented), the interface initialization function used in G_IMPLEMENT_INTERFACE() would typically look like this:

static void
implement_channel_interface_sasl_authentication1 (gpointer klass,
    gpointer unused G_GNUC_UNUSED)
{
#define IMPLEMENT(x) tp_svc_channel_interface_sasl_authentication1_implement_##x (\
  klass, my_object_##x)
  IMPLEMENT (start_mechanism);
  IMPLEMENT (start_mechanism_with_data);
  IMPLEMENT (respond);
  IMPLEMENT (accept_sasl);
  IMPLEMENT (abort_sasl);
#undef IMPLEMENT
}

TpSvcChannelInterfaceCaptchaAuthentication1

typedef struct _TpSvcChannelInterfaceCaptchaAuthentication1 TpSvcChannelInterfaceCaptchaAuthentication1;

Dummy typedef representing any implementation of this interface.

TpSvcChannelInterfaceCaptchaAuthentication1Class

typedef struct _TpSvcChannelInterfaceCaptchaAuthentication1Class TpSvcChannelInterfaceCaptchaAuthentication1Class;

The class of TpSvcChannelInterfaceCaptchaAuthentication1.

In a full implementation of this interface (i.e. all methods implemented), the interface initialization function used in G_IMPLEMENT_INTERFACE() would typically look like this:

static void
implement_channel_interface_captcha_authentication1 (gpointer klass,
    gpointer unused G_GNUC_UNUSED)
{
#define IMPLEMENT(x) tp_svc_channel_interface_captcha_authentication1_implement_##x (\
  klass, my_object_##x)
  IMPLEMENT (get_captchas);
  IMPLEMENT (get_captcha_data);
  IMPLEMENT (answer_captchas);
  IMPLEMENT (cancel_captcha);
#undef IMPLEMENT
}

Signal Details

The “new-challenge” signal

void
user_function (TpSvcChannelInterfaceSASLAuthentication1 *self,
               GArray_guchar_                           *arg_Challenge_Data,
               gpointer                                  user_data)

The NewChallenge D-Bus signal is emitted whenever this GObject signal is.

Parameters

self

an object

  

arg_Challenge_Data

const GArray * (FIXME, generate documentation)

  

user_data

user data set when the signal handler was connected.

  

Flags: Has Details

The “s-as-lstatus-changed” signal

void
user_function (TpSvcChannelInterfaceSASLAuthentication1 *self,
               guint                                     arg_Status,
               gchar                                    *arg_Reason,
               gpointer                                  user_data)

The SASLStatusChanged D-Bus signal is emitted whenever this GObject signal is.

Parameters

self

an object

  

arg_Status

guint (FIXME, generate documentation)

  

arg_Reason

const gchar * (FIXME, generate documentation)

  

arg_Details

GHashTable * (FIXME, generate documentation)

  

user_data

user data set when the signal handler was connected.

  

Flags: Has Details

Generated by GTK-Doc V1.20