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/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.4</p> 20<img alt="" src="/images/feather.gif" /></div> 21<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 22<div id="path"> 23<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.4</a> > <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"> en </a> | 28<a href="/fr/mod/mod_authz_groupfile.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 29<a href="/ja/mod/mod_authz_groupfile.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 30<a href="/ko/mod/mod_authz_groupfile.html" hreflang="ko" rel="alternate" title="Korean"> ko </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> 36<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table> 37<h3>Summary</h3> 38 39 <p>This module provides authorization capabilities so that 40 authenticated users can be allowed or denied access to portions 41 of the web site by group membership. Similar functionality is 42 provided by <code class="module"><a href="/mod/mod_authz_dbm.html">mod_authz_dbm</a></code>.</p> 43</div> 44<div id="quickview"><h3 class="directives">Directives</h3> 45<ul id="toc"> 46<li><img alt="" src="/images/down.gif" /> <a href="#authgroupfile">AuthGroupFile</a></li> 47</ul> 48<h3>Topics</h3> 49<ul id="topics"> 50<li><img alt="" src="/images/down.gif" /> <a href="#requiredirectives">The Require Directives</a></li> 51</ul><h3>See also</h3> 52<ul class="seealso"> 53<li><code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code></li> 54</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 55<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 56<div class="section"> 57<h2><a name="requiredirectives" id="requiredirectives">The Require Directives</a></h2> 58 59 <p>Apache's <code class="directive"><a href="/mod/mod_authz_core.html#require">Require</a></code> 60 directives are used during the authorization phase to ensure that 61 a user is allowed to access a resource. mod_authz_groupfile extends the 62 authorization types with <code>group</code> and <code>group-file</code>. 63 </p> 64 65 <p>Since v2.5.0, <a href="/expr.html">expressions</a> are supported 66 within the groupfile require directives.</p> 67 68<h3><a name="reqgroup" id="reqgroup">Require group</a></h3> 69 70 <p>This directive specifies group membership that is required for the 71 user to gain access.</p> 72 73 <pre class="prettyprint lang-config">Require group admin</pre> 74 75 76 77 78<h3><a name="reqfilegroup" id="reqfilegroup">Require file-group</a></h3> 79 80 <p>When this directive is specified, the user must be a member of the group 81 assigned to the file being accessed.</p> 82 83 <pre class="prettyprint lang-config">Require file-group</pre> 84 85 86 87 88</div> 89<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 90<div class="directive-section"><h2><a name="AuthGroupFile" id="AuthGroupFile">AuthGroupFile</a> <a name="authgroupfile" id="authgroupfile">Directive</a></h2> 91<table class="directive"> 92<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the name of a text file containing the list 93of user groups for authorization</td></tr> 94<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthGroupFile <var>file-path</var></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>The <code class="directive">AuthGroupFile</code> directive sets the 101 name of a textual file containing the list of user groups for user 102 authorization. <var>File-path</var> is the path to the group 103 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> 104 105 <p>Each line of the group file contains a groupname followed by a 106 colon, followed by the member usernames separated by spaces.</p> 107 108 <div class="example"><h3>Example:</h3><p><code> 109 mygroup: bob joe anne 110 </code></p></div> 111 112 <p>Note that searching large text files is <em>very</em> 113 inefficient; <code class="directive"><a href="/mod/mod_authz_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a></code> provides a much better performance.</p> 114 115 <div class="warning"><h3>Security</h3> 116 <p>Make sure that the <code class="directive">AuthGroupFile</code> is 117 stored outside the document tree of the web-server; do <em>not</em> 118 put it in the directory that it protects. Otherwise, clients may 119 be able to download the <code class="directive">AuthGroupFile</code>.</p> 120 </div> 121 122</div> 123</div> 124<div class="bottomlang"> 125<p><span>Available Languages: </span><a href="/en/mod/mod_authz_groupfile.html" title="English"> en </a> | 126<a href="/fr/mod/mod_authz_groupfile.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> | 127<a href="/ja/mod/mod_authz_groupfile.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | 128<a href="/ko/mod/mod_authz_groupfile.html" hreflang="ko" rel="alternate" title="Korean"> ko </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&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[//><!-- 131var comments_shortname = 'httpd'; 132var comments_identifier = 'http://httpd.apache.org/docs/2.4/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 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> 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[//><!-- 149if (typeof(prettyPrint) !== 'undefined') { 150 prettyPrint(); 151} 152//--><!]]></script> 153</body></html>
