granicus.if.org Git - apache/blob - docs/manual/mod/mod_authz_groupfile.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_authz_groupfile - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16 <p class="apache">Apache HTTP Server Version 2.1</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.1</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_authz_groupfile</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_authz_groupfile.html" title="English">&nbsp;en&nbsp;</a> |
  25 <a href="../ko/mod/mod_authz_groupfile.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  26 </div>
  27 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Group authorization using plaintext files</td></tr>
  28 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  29 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authz_groupfile_module</td></tr>
  30 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authz_groupfile.c</td></tr>
  31 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table>
  32 <h3>Summary</h3>
  33
  34     <p>This module provides authorization capabilities so that
  35     authenticated users can be allowed or denied access to portions
  36     of the web site by group membership. Similar functionality is
  37     provided by <code class="module"><a href="../mod/mod_authz_dbm.html">mod_authz_dbm</a></code>.</p>
  38 </div>
  39 <div id="quickview"><h3 class="directives">Directives</h3>
  40 <ul id="toc">
  41 <li><img alt="" src="../images/down.gif" /> <a href="#authgroupfile">AuthGroupFile</a></li>
  42 <li><img alt="" src="../images/down.gif" /> <a href="#authzgroupfileauthoritative">AuthzGroupFileAuthoritative</a></li>
  43 </ul>
  44 <h3>See also</h3>
  45 <ul class="seealso">
  46 <li><code class="directive"><a href="../mod/core.html#require">Require</a></code></li>
  47 <li><code class="directive"><a href="../mod/core.html#satisfy">Satisfy</a></code></li>
  48 </ul></div>
  49
  50 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  51 <div class="directive-section"><h2><a name="AuthGroupFile" id="AuthGroupFile">AuthGroupFile</a> <a name="authgroupfile" id="authgroupfile">Directive</a></h2>
  52 <table class="directive">
  53 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the name of a text file containing the list
  54 of user groups for authentication</td></tr>
  55 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthGroupFile <var>file-path</var></code></td></tr>
  56 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  57 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  58 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  59 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_groupfile</td></tr>
  60 </table>
  61     <p>The <code class="directive">AuthGroupFile</code> directive sets the
  62     name of a textual file containing the list of user groups for user
  63     authentication. <var>File-path</var> is the path to the group
  64     file. If it is not absolute, it is treated as relative to the <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>.</p>
  65
  66     <p>Each line of the group file contains a groupname followed by a
  67     colon, followed by the member usernames separated by spaces.</p>
  68
  69     <div class="example"><h3>Example:</h3><p><code>
  70       mygroup: bob joe anne
  71     </code></p></div>
  72
  73     <p>Note that searching large text files is <em>very</em>
  74     inefficient; <code class="directive"><a href="../mod/mod_authz_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a></code> provides a much better performance.</p>
  75
  76     <div class="warning"><h3>Security</h3>
  77       <p>Make sure that the <code class="directive">AuthGroupFile</code> is
  78       stored outside the document tree of the web-server; do <em>not</em>
  79       put it in the directory that it protects. Otherwise, clients may
  80       be able to download the <code class="directive">AuthGroupFile</code>.</p>
  81     </div>
  82
  83 </div>
  84 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  85 <div class="directive-section"><h2><a name="AuthzGroupFileAuthoritative" id="AuthzGroupFileAuthoritative">AuthzGroupFileAuthoritative</a> <a name="authzgroupfileauthoritative" id="authzgroupfileauthoritative">Directive</a></h2>
  86 <table class="directive">
  87 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether authorization will be passed on to lower level
  88 modules</td></tr>
  89 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthzGroupFileAuthoritative On|Off</code></td></tr>
  90 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthzGroupFileAuthoritative On</code></td></tr>
  91 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  92 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  93 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  94 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_groupfile</td></tr>
  95 </table>
  96     <p>Setting the <code class="directive">AuthzGroupFileAuthoritative</code>
  97     directive explicitly to <code>Off</code> allows for
  98     group authorization to be passed on to lower level modules (as defined
  99     in the <code>modules.c</code> files) if there is <strong>no
 100     group</strong> matching the supplied userID.</p>
 101
 102     <p>By default, control is not passed on and an unknown group
 103     will result in an Authentication Required reply. Not
 104     setting it thus keeps the system secure and forces an NCSA
 105     compliant behaviour.</p>
 106
 107     <div class="warning"><h3>Security</h3>
 108       <p>Do consider the implications of allowing a user to
 109       allow fall-through in his <code>.htaccess</code> file; and verify
 110       that this is really what you want; Generally it is easier to just
 111       secure a single <code>.htpasswd</code> file, than it is to secure
 112       a database which might have more access interfaces.</p>
 113     </div>
 114
 115 </div>
 116 </div>
 117 <div class="bottomlang">
 118 <p><span>Available Languages: </span><a href="../en/mod/mod_authz_groupfile.html" title="English">&nbsp;en&nbsp;</a> |
 119 <a href="../ko/mod/mod_authz_groupfile.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 120 </div><div id="footer">
 121 <p class="apache">Copyright 1999-2004 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 122 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 123 </body></html>