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