granicus.if.org Git - apache/blob - docs/manual/mod/mod_authz_user.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4
   5 <!--
   6  Copyright 2002-2004 The Apache Software Foundation
   7
   8  Licensed under the Apache License, Version 2.0 (the "License");
   9  you may not use this file except in compliance with the License.
  10  You may obtain a copy of the License at
  11
  12      http://www.apache.org/licenses/LICENSE-2.0
  13
  14  Unless required by applicable law or agreed to in writing, software
  15  distributed under the License is distributed on an "AS IS" BASIS,
  16  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  See the License for the specific language governing permissions and
  18  limitations under the License.
  19 -->
  20
  21 <modulesynopsis metafile="mod_authz_user.xml.meta">
  22
  23 <name>mod_authz_user</name>
  24 <description>User Authorization</description>
  25 <status>Base</status>
  26 <sourcefile>mod_authz_user.c</sourcefile>
  27 <identifier>authz_user_module</identifier>
  28 <compatibility>Available in Apache 2.1 and later</compatibility>
  29
  30 <summary>
  31     <p>This module provides authorization capabilities so that
  32     authenticated users can be allowed or denied access to portions
  33     of the web site. <module>mod_authz_user</module> grants
  34     access if the authenticated user is listed in a <code>Require user</code>
  35     directive. Alternatively <code>require valid-user</code> can be used to
  36     grant access to all successfully authenticated users.</p>
  37 </summary>
  38 <seealso><directive module="core">Require</directive></seealso>
  39 <seealso><directive module="core">Satisfy</directive></seealso>
  40
  41 <directivesynopsis>
  42 <name>AuthzUserAuthoritative</name>
  43 <description>Sets whether authorization will be passed on to lower level
  44 modules</description>
  45 <syntax>AuthzUserAuthoritative On|Off</syntax>
  46 <default>AuthzUserAuthoritative On</default>
  47 <contextlist><context>directory</context><context>.htaccess</context>
  48 </contextlist>
  49 <override>AuthConfig</override>
  50
  51 <usage>
  52     <p>Setting the <directive>AuthzUserAuthoritative</directive>
  53     directive explicitly to <code>Off</code> allows for
  54     user authorization to be passed on to lower level modules (as defined
  55     in the <code>modules.c</code> files) if there is <strong>no
  56     user</strong> matching the supplied userID.</p>
  57
  58     <p>By default, control is not passed on and an unknown user
  59     will result in an Authentication Required reply. Not
  60     setting it to <code>Off</code> thus keeps the system secure and forces
  61     an NCSA compliant behaviour.</p>
  62 </usage>
  63 </directivesynopsis>
  64
  65 </modulesynopsis>