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 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_authz_groupfile - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <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" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <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>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <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>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_authz_groupfile</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_authz_groupfile.html" title="English">&nbsp;en&nbsp;</a> |
  30 <a href="../fr/mod/mod_authz_groupfile.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  31 <a href="../ja/mod/mod_authz_groupfile.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  32 <a href="../ko/mod/mod_authz_groupfile.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  33 </div>
  34 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Group authorization using plaintext files</td></tr>
  35 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
  36 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authz_groupfile_module</td></tr>
  37 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authz_groupfile.c</td></tr></table>
  38 <h3>Summary</h3>
  39
  40     <p>This module provides authorization capabilities so that
  41     authenticated users can be allowed or denied access to portions
  42     of the web site by group membership. Similar functionality is
  43     provided by <code class="module"><a href="../mod/mod_authz_dbm.html">mod_authz_dbm</a></code>.</p>
  44 </div>
  45 <div id="quickview"><h3>Topics</h3>
  46 <ul id="topics">
  47 <li><img alt="" src="../images/down.gif" /> <a href="#requiredirectives">The Require Directives</a></li>
  48 </ul><h3 class="directives">Directives</h3>
  49 <ul id="toc">
  50 <li><img alt="" src="../images/down.gif" /> <a href="#authgroupfile">AuthGroupFile</a></li>
  51 </ul>
  52 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_authz_groupfile">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_authz_groupfile">Report a bug</a></li></ul><h3>See also</h3>
  53 <ul class="seealso">
  54 <li><code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code></li>
  55 <li><a href="#comments_section">Comments</a></li></ul></div>
  56 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  57 <div class="section">
  58 <h2><a name="requiredirectives" id="requiredirectives">The Require Directives</a></h2>
  59
  60     <p>Apache's <code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code>
  61     directives are used during the authorization phase to ensure that
  62     a user is allowed to access a resource.  mod_authz_groupfile extends the
  63     authorization types with <code>group</code> and <code>group-file</code>.
  64     </p>
  65
  66     <p>Since v2.4.8, <a href="../expr.html">expressions</a> are supported
  67     within the groupfile require directives.</p>
  68
  69 <h3><a name="reqgroup" id="reqgroup">Require group</a></h3>
  70
  71     <p>This directive specifies group membership that is required for the
  72     user to gain access.</p>
  73
  74     <pre class="prettyprint lang-config">Require group admin</pre>
  75
  76
  77
  78
  79 <h3><a name="reqfilegroup" id="reqfilegroup">Require file-group</a></h3>
  80
  81     <p>When this directive is specified, the filesystem permissions on
  82     the file being accessed are consulted. The user must be a member of
  83     a group with the same name as the group that owns the file.
  84     See <code class="module"><a href="../mod/mod_authz_owner.html">mod_authz_owner</a></code> for more
  85     details.</p>
  86
  87     <pre class="prettyprint lang-config">Require file-group</pre>
  88
  89
  90
  91
  92 </div>
  93 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  94 <div class="directive-section"><h2><a name="AuthGroupFile" id="AuthGroupFile">AuthGroupFile</a> <a name="authgroupfile" id="authgroupfile">Directive</a></h2>
  95 <table class="directive">
  96 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the name of a text file containing the list
  97 of user groups for authorization</td></tr>
  98 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthGroupFile <var>file-path</var></code></td></tr>
  99 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
 100 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
 101 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
 102 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_groupfile</td></tr>
 103 </table>
 104     <p>The <code class="directive">AuthGroupFile</code> directive sets the
 105     name of a textual file containing the list of user groups for user
 106     authorization. <var>File-path</var> is the path to the group
 107     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>
 108
 109     <p>Each line of the group file contains a groupname followed by a
 110     colon, followed by the member usernames separated by spaces.</p>
 111
 112     <div class="example"><h3>Example:</h3><p><code>
 113       mygroup: bob joe anne
 114     </code></p></div>
 115
 116     <p>Note that searching large text files is <em>very</em>
 117     inefficient; <code class="directive"><a href="../mod/mod_authz_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a></code> provides a much better performance.</p>
 118
 119     <div class="warning"><h3>Security</h3>
 120       <p>Make sure that the <code class="directive">AuthGroupFile</code> is
 121       stored outside the document tree of the web-server; do <em>not</em>
 122       put it in the directory that it protects. Otherwise, clients may
 123       be able to download the <code class="directive">AuthGroupFile</code>.</p>
 124     </div>
 125
 126 </div>
 127 </div>
 128 <div class="bottomlang">
 129 <p><span>Available Languages: </span><a href="../en/mod/mod_authz_groupfile.html" title="English">&nbsp;en&nbsp;</a> |
 130 <a href="../fr/mod/mod_authz_groupfile.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 131 <a href="../ja/mod/mod_authz_groupfile.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 132 <a href="../ko/mod/mod_authz_groupfile.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 133 </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>
 134 <script type="text/javascript"><!--//--><![CDATA[//><!--
 135 var comments_shortname = 'httpd';
 136 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_authz_groupfile.html';
 137 (function(w, d) {
 138     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 139         d.write('<div id="comments_thread"><\/div>');
 140         var s = d.createElement('script');
 141         s.type = 'text/javascript';
 142         s.async = true;
 143         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 144         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 145     }
 146     else {
 147         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 148     }
 149 })(window, document);
 150 //--><!]]></script></div><div id="footer">
 151 <p class="apache">Copyright 2016 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>
 152 <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[//><!--
 153 if (typeof(prettyPrint) !== 'undefined') {
 154     prettyPrint();
 155 }
 156 //--><!]]></script>
 157 </body></html>