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 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Licensed to the Apache Software Foundation (ASF) under one or more
   8  contributor license agreements.  See the NOTICE file distributed with
   9  this work for additional information regarding copyright ownership.
  10  The ASF licenses this file to You under the Apache License, Version 2.0
  11  (the "License"); you may not use this file except in compliance with
  12  the License.  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_authz_user.xml.meta">
  24
  25 <name>mod_authz_user</name>
  26 <description>User Authorization</description>
  27 <status>Base</status>
  28 <sourcefile>mod_authz_user.c</sourcefile>
  29 <identifier>authz_user_module</identifier>
  30
  31 <summary>
  32     <p>This module provides authorization capabilities so that
  33     authenticated users can be allowed or denied access to portions
  34     of the web site. <module>mod_authz_user</module> grants
  35     access if the authenticated user is listed in a <code>Require user</code>
  36     directive. Alternatively <code>Require valid-user</code> can be used to
  37     grant access to all successfully authenticated users.</p>
  38 </summary>
  39 <seealso><directive module="mod_authz_core">Require</directive></seealso>
  40
  41 <section id="requiredirectives"><title>The Require Directives</title>
  42
  43     <p>Apache's <directive module="mod_authz_core">Require</directive>
  44     directives are used during the authorization phase to ensure that
  45     a user is allowed to access a resource.  mod_authz_user extends the
  46     authorization types with <code>user</code> and <code>valid-user</code>.
  47     </p>
  48
  49     <p>Since v2.4.8, <a href="../expr.html">expressions</a> are supported
  50     within the user require directives.</p>
  51
  52 <section id="requser"><title>Require user</title>
  53
  54     <p>This directive specifies a list of users that are allowed to gain
  55     access.</p>
  56
  57     <highlight language="config">
  58       Require user john paul george ringo
  59     </highlight>
  60
  61 </section>
  62
  63 <section id="reqvaliduser"><title>Require valid-user</title>
  64
  65     <p>When this directive is specified, any successfully authenticated
  66     user will be allowed to gain access.</p>
  67
  68     <highlight language="config">
  69       Require valid-user
  70     </highlight>
  71
  72 </section>
  73
  74 </section>
  75
  76 </modulesynopsis>