AuthDomain

Object Hierarchy:

Description:

[ CCode ( type_id = "soup_auth_domain_get_type ()" ) ]
public abstract class AuthDomain : Object

Server-side authentication.

A AuthDomain manages authentication for all or part of a [class@Server]. To make a server require authentication, first create an appropriate subclass of AuthDomain, and then add it to the server with [ method@Server.add_auth_domain].

In order for an auth domain to have any effect, you must add one or more paths to it (via [method@AuthDomain.add_path]). To require authentication for all ordinary requests, add the path `"/"`. (Note that this does not include the special `"*"` URI (eg, "OPTIONS *"), which must be added as a separate path if you want to cover it.)

If you need greater control over which requests should and shouldn't be authenticated, add paths covering everything you *might* want authenticated, and then use a filter ([method@AuthDomain.set_filter] to bypass authentication for those requests that don't need it.

All known sub-classes:

AuthDomainBasic

AuthDomainDigest

Namespace: Soup

Package: libsoup-3.0

Content:

Properties:

public AuthDomainFilter filter { get; set; }
The [callback@AuthDomainFilter] for the domain.
public void* filter_data { get; set; }
Data to pass to the [callback@AuthDomainFilter].
public AuthDomainGenericAuthCallback generic_auth_callback { get; set; }
The [callback@AuthDomainGenericAuthCallback].
public void* generic_auth_data { get; set; }
The data to pass to the [callback@AuthDomainGenericAuthCallback].
public bool proxy { get; construct; }
Whether or not this is a proxy auth domain.
public string realm { get; construct; }
The realm of this auth domain.

Creation methods:

protected AuthDomain ()

Methods:

public virtual string accepts (ServerMessage msg, string header)
public string? accepts_authorization (ServerMessage msg)
Checks if msg contains appropriate authorization for this to accept it.
public void add_path (string path)
Adds path to this.
public virtual string challenge (ServerMessage msg)
Adds a "WWW-Authenticate" or "Proxy-Authenticate" header to msg .
public virtual bool check_password (ServerMessage msg, string username, string password)
Checks if msg authenticates to this via username and password.
public bool covers (ServerMessage msg)
Checks if this requires msg to be authenticated (according to its paths and filter function).
public unowned string get_realm ()
Gets the realm name associated with this.
public void remove_path (string path)
Removes path from this.
public void set_filter (owned AuthDomainFilter filter)
Adds filter as an authentication filter to this.
public void set_generic_auth_callback (owned AuthDomainGenericAuthCallback auth_callback)
Sets auth_callback as an authentication-handling callback for this.

Inherited Members:

All known members inherited from class GLib.Object