mod_auth_basic.xml revision ac1a656380fb9c5636a1f41b7e284f8eb2d60011
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<?xml version="1.0"?>
530eba85dbd41b8a0fa5255d3648d1440199a661slive<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
e942c741056732f50da2074b36fe59805d370650slive<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
5f5d1b4cc970b7f06ff8ef6526128e9a27303d88nd<!-- $LastChangedRevision$ -->
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd<!--
3d81f57512275ca06a60a9bcbd23c1f8b429fdf2colm Licensed to the Apache Software Foundation (ASF) under one or more
08cb74ca432a8c24e39f17dedce527e6a47b8001jerenkrantz contributor license agreements. See the NOTICE file distributed with
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd this work for additional information regarding copyright ownership.
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd The ASF licenses this file to You under the Apache License, Version 2.0
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd (the "License"); you may not use this file except in compliance with
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd the License. You may obtain a copy of the License at
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd http://www.apache.org/licenses/LICENSE-2.0
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd Unless required by applicable law or agreed to in writing, software
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd distributed under the License is distributed on an "AS IS" BASIS,
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd See the License for the specific language governing permissions and
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd limitations under the License.
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd-->
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd
7db9f691a00ead175b03335457ca296a33ddf31bnd<modulesynopsis metafile="mod_auth_basic.xml.meta">
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<name>mod_auth_basic</name>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Basic authentication</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<status>Base</status>
530eba85dbd41b8a0fa5255d3648d1440199a661slive<sourcefile>mod_auth_basic.c</sourcefile>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<identifier>auth_basic_module</identifier>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<compatibility>Available in Apache 2.1 and later</compatibility>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<summary>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <p>This module allows the use of HTTP Basic Authentication to
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna restrict access by looking up users in the given providers.
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna HTTP Digest Authentication is provided by
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <module>mod_auth_digest</module>. This module should
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna usually be combined with at least one authentication module
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna such as <module>mod_authn_file</module> and one authorization
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna module such as <module>mod_authz_user</module>.</p>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna</summary>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<seealso><directive module="mod_authn_core">AuthName</directive></seealso>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<seealso><directive module="mod_authn_core">AuthType</directive></seealso>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<seealso><directive module="mod_authz_core">Require</directive></seealso>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<seealso><directive module="mod_authz_core">Match</directive></seealso>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<seealso><a href="/howto/auth.html">Authentication howto</a></seealso>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<directivesynopsis>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<name>AuthBasicProvider</name>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<description>Sets the authentication provider(s) for this location</description>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<syntax>AuthBasicProvider <var>provider-name</var>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna[<var>provider-name</var>] ...</syntax>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<default>AuthBasicProvider file</default>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<contextlist><context>directory</context><context>.htaccess</context>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna</contextlist>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<override>AuthConfig</override>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna<usage>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <p>The <directive>AuthBasicProvider</directive> directive sets
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna which provider is used to authenticate the users for this location.
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna The default <code>file</code> provider is implemented
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna by the <module>mod_authn_file</module> module. Make sure
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna that the chosen provider module is present in the server.</p>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <example><title>Example</title>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna &lt;Location /secure&gt;<br />
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <indent>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna AuthType basic<br />
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna AuthName "private area"<br />
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna AuthBasicProvider dbm<br />
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna AuthDBMType SDBM<br />
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna AuthDBMUserFile /www/etc/dbmpasswd<br />
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna Require valid-user<br />
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna </indent>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna &lt;/Location&gt;
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna </example>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <p>Providers are implemented by <module>mod_authn_dbm</module>,
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna <module>mod_authn_file</module>, <module>mod_authn_dbd</module>,
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna and <module>mod_authnz_ldap</module>.</p>
7e8f5c6496b3825b6b128e2aacc4b1b09d28553dpquerna</usage>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive
313bb560bc5c323cfd40c9cad7335b4b8e060aedkess<directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<name>AuthBasicAuthoritative</name>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<description>Sets whether authorization and authentication are passed to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivelower level modules</description>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<syntax>AuthBasicAuthoritative On|Off</syntax>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<default>AuthBasicAuthoritative On</default>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele<contextlist><context>directory</context><context>.htaccess</context>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</contextlist>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<override>AuthConfig</override>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<usage>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <p>Normally, each authorization module listed in <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_auth_basic">AuthBasicProvider</directive> will attempt
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive to verify the user, and if the user is not found in any provider,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive access will be denied. Setting the
fb77c505254b6e9c925e23e734463e87574f8f40kess <directive>AuthBasicAuthoritative</directive> directive explicitly
fb77c505254b6e9c925e23e734463e87574f8f40kess to <code>Off</code> allows for both authentication and
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive authorization to be passed on to other non-provider-based modules
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive if there is <strong>no userID</strong> or <strong>rule</strong>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive matching the supplied userID. This should only be necessary when
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive combining <module>mod_auth_basic</module> with third-party modules
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive that are not configured with the <directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive module="mod_auth_basic">AuthBasicProvider</directive>
fb77c505254b6e9c925e23e734463e87574f8f40kess directive. When using such modules, the order of processing
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive is determined in the modules' source code and is not configurable.</p>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</usage>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive</directivesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive
fb77c505254b6e9c925e23e734463e87574f8f40kess</modulesynopsis>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive