mod_authz_groupfile.xml revision 860b4efe27e7c1c9a2bf5c872b29c90f76849b51
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<?xml version="1.0"?>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
f6096b958c8b58c4709860d7c4dcdde5deeacb7aEvan Hunt<!-- $LastChangedRevision$ -->
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<!--
90e0af6bc6c1bcafad126e1779fc478c0aeaeb8fEvan Hunt Licensed to the Apache Software Foundation (ASF) under one or more
f6b909274159da7aaad8463c90f15018136cf6cbTinderbox User contributor license agreements. See the NOTICE file distributed with
90e0af6bc6c1bcafad126e1779fc478c0aeaeb8fEvan Hunt this work for additional information regarding copyright ownership.
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews The ASF licenses this file to You under the Apache License, Version 2.0
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews (the "License"); you may not use this file except in compliance with
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews the License. You may obtain a copy of the License at
90e0af6bc6c1bcafad126e1779fc478c0aeaeb8fEvan Hunt
19c7b1a0293498a3e36692c59646ed6e15ffc8d0Tinderbox User http://www.apache.org/licenses/LICENSE-2.0
83a28ca274521e15086fc39febde507bcc4e145eMark Andrews
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt Unless required by applicable law or agreed to in writing, software
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt distributed under the License is distributed on an "AS IS" BASIS,
90e0af6bc6c1bcafad126e1779fc478c0aeaeb8fEvan Hunt WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
544e2b48ece5724f2c4a0d6636048a72335cfd54Evan Hunt See the License for the specific language governing permissions and
544e2b48ece5724f2c4a0d6636048a72335cfd54Evan Hunt limitations under the License.
58f15381f7f69f4e986d7014fda4feb223b8b36cEvan Hunt-->
58f15381f7f69f4e986d7014fda4feb223b8b36cEvan Hunt
90e0af6bc6c1bcafad126e1779fc478c0aeaeb8fEvan Hunt<modulesynopsis metafile="mod_authz_groupfile.xml.meta">
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt
30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1Mark Andrews<name>mod_authz_groupfile</name>
448884248519a8edade1b51aa7d20140b12764a9Evan Hunt<description>Group authorization using plaintext files</description>
90e0af6bc6c1bcafad126e1779fc478c0aeaeb8fEvan Hunt<status>Base</status>
90e0af6bc6c1bcafad126e1779fc478c0aeaeb8fEvan Hunt<sourcefile>mod_authz_groupfile.c</sourcefile>
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt<identifier>authz_groupfile_module</identifier>
90e0af6bc6c1bcafad126e1779fc478c0aeaeb8fEvan Hunt<compatibility>Available in Apache 2.1 and later</compatibility>
90e0af6bc6c1bcafad126e1779fc478c0aeaeb8fEvan Hunt
90e0af6bc6c1bcafad126e1779fc478c0aeaeb8fEvan Hunt<summary>
90e0af6bc6c1bcafad126e1779fc478c0aeaeb8fEvan Hunt <p>This module provides authorization capabilities so that
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt authenticated users can be allowed or denied access to portions
30eec077db2bdcb6f2a0dc388a3cdde2ede75ec1Mark Andrews of the web site by group membership. Similar functionality is
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt provided by <module>mod_authz_dbm</module>.</p>
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt</summary>
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt<seealso><directive module="mod_authz_core">Require</directive></seealso>
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt<directivesynopsis>
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt<name>AuthGroupFile</name>
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt<description>Sets the name of a text file containing the list
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Huntof user groups for authorization</description>
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt<syntax>AuthGroupFile <var>file-path</var></syntax>
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt<contextlist><context>directory</context><context>.htaccess</context>
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt</contextlist>
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt<override>AuthConfig</override>
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt<usage>
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt <p>The <directive>AuthGroupFile</directive> directive sets the
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt name of a textual file containing the list of user groups for user
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt authorization. <var>File-path</var> is the path to the group
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt file. If it is not absolute, it is treated as relative to the <directive
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt module="core">ServerRoot</directive>.</p>
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt <p>Each line of the group file contains a groupname followed by a
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt colon, followed by the member usernames separated by spaces.</p>
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt <example><title>Example:</title>
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt mygroup: bob joe anne
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt </example>
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt
59f34c1fc775bf1817c49f5b4a121285f9608efcEvan Hunt <p>Note that searching large text files is <em>very</em>
448e23ed619dfa617df5666ad8df28ef2d9772bfCurtis Blackburn inefficient; <directive module="mod_authz_dbm"
d2647cd5fd919c2a3ccd983a0ef9e6cfca68824cMark Andrews >AuthDBMGroupFile</directive> provides a much better performance.</p>
b243aa40f97cb2f77fbe746977d61f0a8c2e9194Mark Andrews
d2647cd5fd919c2a3ccd983a0ef9e6cfca68824cMark Andrews <note type="warning"><title>Security</title>
544e2b48ece5724f2c4a0d6636048a72335cfd54Evan Hunt <p>Make sure that the <directive>AuthGroupFile</directive> is
d2647cd5fd919c2a3ccd983a0ef9e6cfca68824cMark Andrews stored outside the document tree of the web-server; do <em>not</em>
d2647cd5fd919c2a3ccd983a0ef9e6cfca68824cMark Andrews put it in the directory that it protects. Otherwise, clients may
d2647cd5fd919c2a3ccd983a0ef9e6cfca68824cMark Andrews be able to download the <directive>AuthGroupFile</directive>.</p>
d2647cd5fd919c2a3ccd983a0ef9e6cfca68824cMark Andrews </note>
d2647cd5fd919c2a3ccd983a0ef9e6cfca68824cMark Andrews</usage>
d2647cd5fd919c2a3ccd983a0ef9e6cfca68824cMark Andrews</directivesynopsis>
d2647cd5fd919c2a3ccd983a0ef9e6cfca68824cMark Andrews
d2647cd5fd919c2a3ccd983a0ef9e6cfca68824cMark Andrews</modulesynopsis>
d2647cd5fd919c2a3ccd983a0ef9e6cfca68824cMark Andrews