Sasl

Object Hierarchy:

Description:

[ CCode ( type_id = "camel_sasl_get_type ()" ) ]
public abstract class Sasl : Object

SASL (Secure Authentication and Security Layer) support.

Sasl is an abstract base class for pluggable authentication mechanisms used by connection-based mail services. It implements the Secure Authentication part of SASL, providing a challenge-response interface that can be invoked multiple times until authentication completes.

Non-SASL authentication mechanisms that fit the same challenge-response design (such as LOGIN and NTLM) are also wrapped in Sasl subclasses to simplify their use.

Instances are created via the for_service factory function, which looks up the named mechanism. The main API is challenge, which takes a server challenge token and returns the client's response token. A base64 convenience wrapper, challenge_base64, is provided for protocols that exchange base64-encoded tokens.

Available built-in mechanisms include: ANONYMOUS, CRAM-MD5, DIGEST-MD5, GSSAPI (Kerberos), LOGIN, NTLM, PLAIN, POPB4SMTP, and XOAUTH2 variants.

All known sub-classes:

Namespace: Camel

Package: camel-1.2

Content:

Properties:

public bool authenticated { get; set; }
Authenticated
public string mechanism { get; construct; }
Mechanism
public Service service { get; construct; }
Service
public string service_name { get; construct; }
Service Name

Static methods:

public static unowned ServiceAuthType? authtype (string mechanism)
public static List<unowned ServiceAuthType?> authtype_list (bool include_plain)
public static Sasl? for_service (string service_name, string mechanism, Service service)
public static bool is_xoauth2_alias (string? mechanism)
Checks whether exists a Sasl method for the mechanism and whether it derives from SaslXOAuth2.

Creation methods:

protected Sasl ()

Methods:

public async ByteArray? challenge (ByteArray? token, int io_priority, Cancellable? cancellable = null) throws Error
If token is null, asynchronously generate the initial SASL message to send to the server.
public async string challenge_base64 (string token, int io_priority, Cancellable? cancellable = null) throws Error
As with challenge , but the challenge token and the response are both base64-encoded.
public string challenge_base64_sync (string token, Cancellable? cancellable = null) throws Error
As with challenge_sync, but the challenge token and the response are both base64-encoded.
public virtual ByteArray? challenge_sync (ByteArray? token, Cancellable? cancellable = null) throws Error
If token is null, generate the initial SASL message to send to the server.
public bool get_authenticated ()
public unowned string get_mechanism ()
public unowned Service get_service ()
public unowned string get_service_name ()
public void set_authenticated (bool authenticated)
public async bool try_empty_password (int io_priority, Cancellable? cancellable = null) throws Error
Asynchronously determine whether this can be used for password-less authentication, for example single-sign-on using system credentials.
public virtual bool try_empty_password_sync (Cancellable? cancellable = null) throws Error

Fields:

public class unowned ServiceAuthType? auth_type

Inherited Members:

All known members inherited from class GLib.Object