diff options
Diffstat (limited to 'docs/reference/tmpl/soup-auth-domain.sgml')
-rw-r--r-- | docs/reference/tmpl/soup-auth-domain.sgml | 182 |
1 files changed, 0 insertions, 182 deletions
diff --git a/docs/reference/tmpl/soup-auth-domain.sgml b/docs/reference/tmpl/soup-auth-domain.sgml deleted file mode 100644 index 9a055bde..00000000 --- a/docs/reference/tmpl/soup-auth-domain.sgml +++ /dev/null @@ -1,182 +0,0 @@ -<!-- ##### SECTION Title ##### --> -SoupAuthDomain - -<!-- ##### SECTION Short_Description ##### --> -Server-side authentication - -<!-- ##### SECTION Long_Description ##### --> -<para> -A #SoupAuthDomain manages authentication for all or part of a -#SoupServer. To make a server require authentication, first create an -appropriate subclass of #SoupAuthDomain, and then add it to the server -with soup_server_add_auth_domain(). -</para> - -<para> -In order for an auth domain to have any effect, you must add one or -more paths to it (via soup_auth_domain_add_path() or the -%SOUP_AUTH_DOMAIN_ADD_PATH property). To require authentication for -all requests, add the path "/". -</para> - -<para> -If you need greater control over which requests should and shouldn't -be authenticated, add paths covering everything you -<emphasis>might</emphasis> want authenticated, and then use a filter -(soup_auth_domain_set_filter()) to bypass authentication for those -requests that don't need it. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### STRUCT SoupAuthDomain ##### --> -<para> - -</para> - - -<!-- ##### ARG SoupAuthDomain:add-path ##### --> -<para> - -</para> - -<!-- ##### ARG SoupAuthDomain:filter ##### --> -<para> - -</para> - -<!-- ##### ARG SoupAuthDomain:filter-data ##### --> -<para> - -</para> - -<!-- ##### ARG SoupAuthDomain:proxy ##### --> -<para> - -</para> - -<!-- ##### ARG SoupAuthDomain:realm ##### --> -<para> - -</para> - -<!-- ##### ARG SoupAuthDomain:remove-path ##### --> -<para> - -</para> - -<!-- ##### FUNCTION soup_auth_domain_add_path ##### --> -<para> - -</para> - -@domain: -@path: - - -<!-- ##### FUNCTION soup_auth_domain_remove_path ##### --> -<para> - -</para> - -@domain: -@path: - - -<!-- ##### FUNCTION soup_auth_domain_set_filter ##### --> -<para> - -</para> - -@domain: -@filter: -@filter_data: -@dnotify: - - -<!-- ##### FUNCTION soup_auth_domain_get_realm ##### --> -<para> - -</para> - -@domain: -@Returns: - - -<!-- ##### FUNCTION soup_auth_domain_covers ##### --> -<para> - -</para> - -@domain: -@msg: -@Returns: - - -<!-- ##### FUNCTION soup_auth_domain_accepts ##### --> -<para> - -</para> - -@domain: -@msg: -@Returns: - - -<!-- ##### FUNCTION soup_auth_domain_challenge ##### --> -<para> - -</para> - -@domain: -@msg: - - -<!-- ##### MACRO SOUP_AUTH_DOMAIN_REALM ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_AUTH_DOMAIN_PROXY ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_AUTH_DOMAIN_ADD_PATH ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_AUTH_DOMAIN_REMOVE_PATH ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_AUTH_DOMAIN_FILTER ##### --> -<para> - -</para> - - - -<!-- ##### MACRO SOUP_AUTH_DOMAIN_FILTER_DATA ##### --> -<para> - -</para> - - - |