github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/mod/mod_authz_groupfile.html.en (about)

     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.2</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" /><link href="http://httpd.apache.org/docs/current/mod/mod_authz_groupfile.html" rel="canonical" /></head>
    18  <body>
    19  <div id="page-header">
    20  <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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.2</p>
    22  <img alt="" src="../images/feather.gif" /></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.2</a> &gt; <a href="./">Modules</a></div>
    26  <div id="page-content">
    27  <div class="retired"><h4>Please note</h4>
    28              <p> This document refers to a legacy release (<strong>2.2</strong>) of Apache httpd. The active release (<strong>2.4</strong>) is documented <a href="http://httpd.apache.org/docs/current">here</a>. If you have not already upgraded, please follow <a href="http://httpd.apache.org/docs/current/upgrading.html">this link</a> for more information.</p>
    29          <p>You may follow <a href="http://httpd.apache.org/docs/current/mod/mod_authz_groupfile.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Apache Module mod_authz_groupfile</h1>
    30  <div class="toplang">
    31  <p><span>Available Languages: </span><a href="../en/mod/mod_authz_groupfile.html" title="English">&nbsp;en&nbsp;</a> |
    32  <a href="../ja/mod/mod_authz_groupfile.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
    33  <a href="../ko/mod/mod_authz_groupfile.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
    34  </div>
    35  <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Group authorization using plaintext files</td></tr>
    36  <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
    37  <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authz_groupfile_module</td></tr>
    38  <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authz_groupfile.c</td></tr>
    39  <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table>
    40  <h3>Summary</h3>
    41  
    42      <p>This module provides authorization capabilities so that
    43      authenticated users can be allowed or denied access to portions
    44      of the web site by group membership. Similar functionality is
    45      provided by <code class="module"><a href="../mod/mod_authz_dbm.html">mod_authz_dbm</a></code>.</p>
    46  </div>
    47  <div id="quickview"><h3 class="directives">Directives</h3>
    48  <ul id="toc">
    49  <li><img alt="" src="../images/down.gif" /> <a href="#authgroupfile">AuthGroupFile</a></li>
    50  <li><img alt="" src="../images/down.gif" /> <a href="#authzgroupfileauthoritative">AuthzGroupFileAuthoritative</a></li>
    51  </ul>
    52  <h3>See also</h3>
    53  <ul class="seealso">
    54  <li><code class="directive"><a href="../mod/core.html#require">Require</a></code></li>
    55  <li><code class="directive"><a href="../mod/core.html#satisfy">Satisfy</a></code></li>
    56  </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
    57  
    58  <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
    59  <div class="directive-section"><h2><a name="AuthGroupFile" id="AuthGroupFile">AuthGroupFile</a> <a name="authgroupfile" id="authgroupfile">Directive</a></h2>
    60  <table class="directive">
    61  <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the name of a text file containing the list
    62  of user groups for authorization</td></tr>
    63  <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthGroupFile <var>file-path</var></code></td></tr>
    64  <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
    65  <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
    66  <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
    67  <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authz_groupfile</td></tr>
    68  </table>
    69      <p>The <code class="directive">AuthGroupFile</code> directive sets the
    70      name of a textual file containing the list of user groups for user
    71      authorization. <var>File-path</var> is the path to the group
    72      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>
    73  
    74      <p>Each line of the group file contains a groupname followed by a
    75      colon, followed by the member usernames separated by spaces.</p>
    76  
    77      <div class="example"><h3>Example:</h3><p><code>
    78        mygroup: bob joe anne
    79      </code></p></div> 
    80  
    81      <p>Note that searching large text files is <em>very</em>
    82      inefficient; <code class="directive"><a href="../mod/mod_authz_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a></code> provides a much better performance.</p>
    83  
    84      <div class="warning"><h3>Security</h3>
    85        <p>Make sure that the <code class="directive">AuthGroupFile</code> is
    86        stored outside the document tree of the web-server; do <em>not</em>
    87        put it in the directory that it protects. Otherwise, clients may
    88        be able to download the <code class="directive">AuthGroupFile</code>.</p>
    89      </div>
    90  
    91  </div>
    92  <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
    93  <div class="directive-section"><h2><a name="AuthzGroupFileAuthoritative" id="AuthzGroupFileAuthoritative">AuthzGroupFileAuthoritative</a> <a name="authzgroupfileauthoritative" id="authzgroupfileauthoritative">Directive</a></h2>
    94  <table class="directive">
    95  <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether authorization will be passed on to lower level
    96  modules</td></tr>
    97  <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthzGroupFileAuthoritative On|Off</code></td></tr>
    98  <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthzGroupFileAuthoritative On</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>Setting the <code class="directive">AuthzGroupFileAuthoritative</code>
   105      directive explicitly to <code>Off</code> allows for
   106      group authorization to be passed on to lower level modules (as defined
   107      in the <code>modules.c</code> files) if there is <strong>no
   108      group</strong> matching the supplied userID.</p>
   109  
   110      <p>By default, control is not passed on and an unknown group
   111      will result in an Authentication Required reply. Not
   112      setting it thus keeps the system secure and forces an NCSA
   113      compliant behaviour.</p>
   114  
   115      <div class="warning"><h3>Security</h3>
   116        <p>Do consider the implications of allowing a user to
   117        allow fall-through in his <code>.htaccess</code> file; and verify
   118        that this is really what you want; Generally it is easier to just
   119        secure a single <code>.htpasswd</code> file, than it is to secure
   120        a database which might have more access interfaces.</p>
   121      </div>
   122  
   123  </div>
   124  </div>
   125  <div class="bottomlang">
   126  <p><span>Available Languages: </span><a href="../en/mod/mod_authz_groupfile.html" title="English">&nbsp;en&nbsp;</a> |
   127  <a href="../ja/mod/mod_authz_groupfile.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
   128  <a href="../ko/mod/mod_authz_groupfile.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
   129  </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>
   130  <script type="text/javascript"><!--//--><![CDATA[//><!--
   131  var comments_shortname = 'httpd';
   132  var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_authz_groupfile.html';
   133  (function(w, d) {
   134      if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
   135          d.write('<div id="comments_thread"><\/div>');
   136          var s = d.createElement('script');
   137          s.type = 'text/javascript';
   138          s.async = true;
   139          s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
   140          (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
   141      }
   142      else { 
   143          d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
   144      }
   145  })(window, document);
   146  //--><!]]></script></div><div id="footer">
   147  <p class="apache">Copyright 2017 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>
   148  <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.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[//><!--
   149  if (typeof(prettyPrint) !== 'undefined') {
   150      prettyPrint();
   151  }
   152  //--><!]]></script>
   153  </body></html>