soup/org.gtkkn.bindings.soup/AuthDomain

AuthDomain

open class AuthDomain(pointer: <Error class: unknown class><<Error class: unknown class>>)

Server-side authentication.

A #SoupAuthDomain manages authentication for all or part of a class@Server. To make a server require authentication, first create an appropriate subclass of #SoupAuthDomain, 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.

Skipped during bindings generation

method filter: Property has no getter
method filter-data: Property has no getter nor setter
method generic-auth-callback: Property has no getter
method generic-auth-data: Property has no getter nor setter
method proxy: Property has no getter nor setter

Inheritors

AuthDomainBasic

AuthDomainDigest

Constructors

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

object Companion

Properties

open val realm: String

The realm of this auth domain.

soupAuthDomainPointer

val soupAuthDomainPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

open fun accepts(msg: ServerMessage): String?

Checks if @msg contains appropriate authorization for @domain to accept it.

open fun addPath(path: String)

Adds @path to @domain.

open fun challenge(msg: ServerMessage)

Adds a "WWW-Authenticate" or "Proxy-Authenticate" header to @msg.

open fun checkPassword(msg: ServerMessage, username: String, password: String): Boolean

Checks if @msg authenticates to @domain via @username and

open fun covers(msg: ServerMessage): Boolean

Checks if @domain requires @msg to be authenticated (according to its paths and filter function).

open fun removePath(path: String)

Removes @path from @domain.

open fun setFilter(filter: AuthDomainFilter)

Adds @filter as an authentication filter to @domain.

setGenericAuthCallback

open fun setGenericAuthCallback(authCallback: AuthDomainGenericAuthCallback)

Sets @auth_callback as an authentication-handling callback for @domain.