Create a new Soup.AuthDomain

Parameters:

Object properties

Checks if msg contains appropriate authorization for domain to accept it. Mirroring soup_auth_domain_covers(), this does not check whether or not domain cares if msg is authorized. This is used by SoupServer internally and is probably of no use to anyone else. fact it has authenticated. NULL otherwise.

Parameters:

Soup.Message msg Required (not null)

Returns:

String

Adds path to domain, such that requests under path on domain's server will require authentication (unless overridden by soup_auth_domain_remove_path() or soup_auth_domain_set_filter()). You can also add paths by setting the SOUP_AUTH_DOMAIN_ADD_PATH property, which can also be used to add one or more paths at construct time.

Parameters:

String path Required (not null)

Returns:

none

is destroyed Sets the callback that domain will use to authenticate incoming requests. For each request containing authorization, domain will invoke the callback, and then either accept or reject the request based on callback's return value. You can also set the auth callback by setting the SOUP_AUTH_DOMAIN_BASIC_AUTH_CALLBACK and SOUP_AUTH_DOMAIN_BASIC_AUTH_DATA properties, which can also be used to set the callback at construct time.

Parameters:

Function (AuthDomain domain, Message msg, String username, String password, void* user_data) : none Required (not null)

void* user_data Required (not null)

Function (void* data) : none Required (not null)

Returns:

none

Adds a "WWW-Authenticate" or "Proxy-Authenticate" header to msg, requesting that the client authenticate, and sets msg's status accordingly. This is used by SoupServer internally and is probably of no use to anyone else.

Parameters:

Soup.Message msg Required (not null)

Returns:

none

Checks if msg authenticates to domain via username and SoupAuthDomainGenericAuthCallback.

Parameters:

Soup.Message msg Required (not null)

String username Required (not null)

String password Required (not null)

Returns:

Boolean

Checks if domain requires msg to be authenticated (according to its paths and filter function). This does not actually look at whether msg is authenticated, merely whether or not it needs to be. This is used by SoupServer internally and is probably of no use to anyone else.

Parameters:

Soup.Message msg Required (not null)

Returns:

Boolean

is destroyed Sets the callback that domain will use to authenticate incoming requests. For each request containing authorization, domain will invoke the callback, and then either accept or reject the request based on callback's return value. You can also set the auth callback by setting the SOUP_AUTH_DOMAIN_DIGEST_AUTH_CALLBACK and SOUP_AUTH_DOMAIN_DIGEST_AUTH_DATA properties, which can also be used to set the callback at construct time.

Parameters:

Function (AuthDomain domain, Message msg, String username, void* user_data) : none Required (not null)

void* user_data Required (not null)

Function (void* data) : none Required (not null)

Returns:

none

Gets the realm name associated with domain

Returns:

String

Removes path from domain, such that requests under path on This is not simply an undo-er for soup_auth_domain_add_path(); it can be used to "carve out" a subtree that does not require authentication inside a hierarchy that does. Note also that unlike with soup_auth_domain_add_path(), this cannot be overridden by adding a filter, as filters can only bypass authentication that would otherwise be required, not require it where it would otherwise be unnecessary. You can also remove paths by setting the SOUP_AUTH_DOMAIN_REMOVE_PATH property, which can also be used to remove one or more paths at construct time.

Parameters:

String path Required (not null)

Returns:

none

is destroyed Adds filter as an authentication filter to domain. The filter gets a chance to bypass authentication for certain requests that would otherwise require it. Eg, it might check the message's path in some way that is too complicated to do via the other methods, or it might check the message's method, and allow GETs but not PUTs. The filter function returns TRUE if the request should still require authentication, or FALSE if authentication is unnecessary for this request. To help prevent security holes, your filter should return TRUE by default, and only return FALSE under specifically-tested circumstances, rather than the other way around. Eg, in the example above, where you want to authenticate PUTs but not GETs, you should check if the method is GET and return FALSE in that case, and then return TRUE for all other methods (rather than returning TRUE for PUT and FALSE for all other methods). This way if it turned out (now or later) that some paths supported additional methods besides GET and PUT, those methods would default to being NOT allowed for unauthenticated users. You can also set the filter by setting the SOUP_AUTH_DOMAIN_FILTER and SOUP_AUTH_DOMAIN_FILTER_DATA properties, which can also be used to set the filter at construct time.

Parameters:

Function (AuthDomain domain, Message msg, void* user_data) : none Required (not null)

void* filter_data Required (not null)

Function (void* data) : none Required (not null)

Returns:

none

is destroyed Sets auth_callback as an authentication-handling callback for authenticated via a domain-specific auth callback (eg, SoupAuthDomainDigestAuthCallback), the generic auth callback will be invoked. See SoupAuthDomainGenericAuthCallback for information on what the callback should do.

Parameters:

Function (AuthDomain domain, Message msg, String username, void* user_data) : none Required (not null)

void* auth_data Required (not null)

Function (void* data) : none Required (not null)

Returns:

none

Parameters:

Soup.Message msg Required (not null)

String username Required (not null)

Returns:

Boolean