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" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  12 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  13 </script>
  14
  15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  16 <body>
  17 <div id="page-header">
  18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  19 <p class="apache">Apache HTTP Server Version 2.5</p>
  20 <img alt="" src="../images/feather.gif" /></div>
  21 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  22 <div id="path">
  23 <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/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_authz_groupfile</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_authz_groupfile.html" title="English">&nbsp;en&nbsp;</a> |
  28 <a href="../fr/mod/mod_authz_groupfile.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  29 <a href="../ja/mod/mod_authz_groupfile.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  30 <a href="../ko/mod/mod_authz_groupfile.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  31 </div>
  32 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Group authorization using plaintext files</td></tr>
  33 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  34 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authz_groupfile_module</td></tr>
  35 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authz_groupfile.c</td></tr></table>
  36 <h3>Summary</h3>
  37
  38     <p>This module provides authorization capabilities so that
  39     authenticated users can be allowed or denied access to portions
  40     of the web site by group membership. Similar functionality is
  41     provided by <code class="module"><a href="../mod/mod_authz_dbm.html">mod_authz_dbm</a></code>.</p>
  42 </div>
  43 <div id="quickview"><h3 class="directives">Directives</h3>
  44 <ul id="toc">
  45 <li><img alt="" src="../images/down.gif" /> <a href="#authgroupfile">AuthGroupFile</a></li>
  46 </ul>
  47 <h3>Topics</h3>
  48 <ul id="topics">
  49 <li><img alt="" src="../images/down.gif" /> <a href="#requiredirectives">The Require Directives</a></li>
  50 </ul><h3>See also</h3>
  51 <ul class="seealso">
  52 <li><code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code></li>
  53 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  54 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  55 <div class="section">
  56 <h2><a name="requiredirectives" id="requiredirectives">The Require Directives</a></h2>
  57
  58     <p>Apache's <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code>
  59     directives are used during the authorization phase to ensure that
  60     a user is allowed to access a resource.  mod_authz_groupfile extends the
  61     authorization types with <code>group</code> and <code>group-file</code>.
  62     </p>
  63
  64     <p>Since v2.4.8, <a href="../expr.html">expressions</a> are supported
  65     within the groupfile require directives.</p>
  66
  67 <h3><a name="reqgroup" id="reqgroup">Require group</a></h3>
  68
  69     <p>This directive specifies group membership that is required for the
  70     user to gain access.</p>
  71
  72     <pre class="prettyprint lang-config">Require group admin</pre>
  73
  74
  75
  76
  77 <h3><a name="reqfilegroup" id="reqfilegroup">Require file-group</a></h3>
  78
  79     <p>When this directive is specified, the user must be a member of the group
  80     assigned to the file being accessed.</p>
  81
  82     <pre class="prettyprint lang-config">Require file-group</pre>
  83
  84
  85
  86
  87 </div>
  88 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  89 <div class="directive-section"><h2><a name="AuthGroupFile" id="AuthGroupFile">AuthGroupFile</a> <a name="authgroupfile" id="authgroupfile">Directive</a></h2>
  90 <table class="directive">
  91 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the name of a text file containing the list
  92 of user groups for authorization</td></tr>
  93 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthGroupFile <var>file-path</var></code></td></tr>
  94 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
  95 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
  96 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
  97 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_groupfile</td></tr>
  98 </table>
  99     <p>The <code class="directive">AuthGroupFile</code> directive sets the
 100     name of a textual file containing the list of user groups for user
 101     authorization. <var>File-path</var> is the path to the group
 102     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>
 103
 104     <p>Each line of the group file contains a groupname followed by a
 105     colon, followed by the member usernames separated by spaces.</p>
 106
 107     <div class="example"><h3>Example:</h3><p><code>
 108       mygroup: bob joe anne
 109     </code></p></div>
 110
 111     <p>Note that searching large text files is <em>very</em>
 112     inefficient; <code class="directive"><a href="../mod/mod_authz_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a></code> provides a much better performance.</p>
 113
 114     <div class="warning"><h3>Security</h3>
 115       <p>Make sure that the <code class="directive">AuthGroupFile</code> is
 116       stored outside the document tree of the web-server; do <em>not</em>
 117       put it in the directory that it protects. Otherwise, clients may
 118       be able to download the <code class="directive">AuthGroupFile</code>.</p>
 119     </div>
 120
 121 </div>
 122 </div>
 123 <div class="bottomlang">
 124 <p><span>Available Languages: </span><a href="../en/mod/mod_authz_groupfile.html" title="English">&nbsp;en&nbsp;</a> |
 125 <a href="../fr/mod/mod_authz_groupfile.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 126 <a href="../ja/mod/mod_authz_groupfile.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 127 <a href="../ko/mod/mod_authz_groupfile.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 128 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 129 <script type="text/javascript"><!--//--><![CDATA[//><!--
 130 var comments_shortname = 'httpd';
 131 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_authz_groupfile.html';
 132 (function(w, d) {
 133     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 134         d.write('<div id="comments_thread"><\/div>');
 135         var s = d.createElement('script');
 136         s.type = 'text/javascript';
 137         s.async = true;
 138         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 139         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 140     }
 141     else {
 142         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 143     }
 144 })(window, document);
 145 //--><!]]></script></div><div id="footer">
 146 <p class="apache">Copyright 2014 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>
 147 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 148 if (typeof(prettyPrint) !== 'undefined') {
 149     prettyPrint();
 150 }
 151 //--><!]]></script>
 152 </body></html>