mod_authz_owner.html.en revision 67c026fea89b4faf173772b5944b6aa006ca6eb0
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>mod_authz_owner - Apache HTTP Server</title>
<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
<body>
<div id="page-header">
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
<p class="apache">Apache HTTP Server Version 2.1</p>
<div id="path">
<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.1</a> > <a href="./">Modules</a></div>
<div id="page-content">
<div id="preamble"><h1>Apache Module mod_authz_owner</h1>
<div class="toplang">
</div>
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Authorization based on file ownership</td></tr>
<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>authz_owner_module</td></tr>
<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table>
<h3>Summary</h3>
<p>This module authorizes access to files by comparing the userid used
for HTTP authentication (the web userid) with the file-system owner or
group of the requested file. The supplied username and password
must be already properly verified by an authentication module,
<code class="module"><a href="/mod/mod_auth_digest.html">mod_auth_digest</a></code>. <code class="module"><a href="/mod/mod_authz_owner.html">mod_authz_owner</a></code>
recognizes two arguments for the <code class="directive"><a href="/mod/core.html#require">Require</a></code> directive, <code>file-owner</code> and
<code>file-group</code>, as follows:</p>
<dl>
<dt><code>file-owner</code></dt>
<dd>The supplied web-username must match the system's name for the
owner of the file being requested. That is, if the operating system
says the requested file is owned by <code>jones</code>, then the
username used to access it through the web must be <code>jones</code>
as well.</dd>
<dt><code>file-group</code></dt>
<dd>The name of the system group that owns the file must be present
in a group database, which is provided, for example, by <code class="module"><a href="/mod/mod_authz_groupfile.html">mod_authz_groupfile</a></code> or <code class="module"><a href="/mod/mod_authz_dbm.html">mod_authz_dbm</a></code>,
and the web-username must be a member of that group. For example, if
the operating system says the requested file is owned by (system)
group <code>accounts</code>, the group <code>accounts</code> must
appear in the group database and the web-username used in the request
must be a member of that group.</dd>
</dl>
<div class="note"><h3>Note</h3>
<p>If <code class="module"><a href="/mod/mod_authz_owner.html">mod_authz_owner</a></code> is used in order to authorize
a resource that is not actually present in the filesystem
<p>Particularly it will never authorize <a href="/content-negotiation.html#multiviews">content negotiated
"MultiViews"</a> resources.</p>
</div>
</div>
<div id="quickview"><h3 class="directives">Directives</h3>
<ul id="toc">
<li><img alt="" src="/images/down.gif" /> <a href="#authzownerauthoritative">AuthzOwnerAuthoritative</a></li>
</ul>
<h3>Topics</h3>
<ul id="topics">
</ul><h3>See also</h3>
<ul class="seealso">
</ul></div>
<div class="section">
<h2><a name="examples" id="examples">Configuration Examples</a></h2>
<p>Consider a multi-user system running the Apache Web server, with
each user having his or her own files in <code>~/public_html/private</code>. Assuming that there is a single
<code class="directive"><a href="/mod/mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile</a></code> database
that lists all of their web-usernames, and that these usernames match
the system's usernames that actually own the files on the server, then
the following stanza would allow only the user himself access to his
own files. User <code>jones</code> would not be allowed to access
were owned by <code>jones</code> instead of <code>smith</code>.</p>
<div class="example"><p><code>
<span class="indent">
AuthType Basic<br />
AuthName MyPrivateFiles<br />
AuthBasicProvider dbm<br />
Satisfy All<br />
Require file-owner<br />
</span>
</Directory>
</code></p></div>
<p>Consider a system similar to the one described above, but with
some users that share their project files in
system group <code>foo</code> and there is a single <code class="directive"><a href="/mod/mod_authz_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a></code> database that
contains all of the web-usernames and their group membership,
<code>foo</code>. So if <code>jones</code> and <code>smith</code>
are both member of the group <code>foo</code>, then both will be
authorized to access the <code>project-foo</code> directories of
each other.</p>
<div class="example"><p><code>
<span class="indent">
AuthType Basic<br />
AuthName "Project Foo Files"<br />
AuthBasicProvider dbm<br />
<br />
<br />
Satisfy All<br />
Require file-group<br />
</span>
</Directory>
</code></p></div>
</div>
<div class="directive-section"><h2><a name="AuthzOwnerAuthoritative" id="AuthzOwnerAuthoritative">AuthzOwnerAuthoritative</a> <a name="authzownerauthoritative" id="authzownerauthoritative">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether authorization will be passed on to lower level
modules</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthzOwnerAuthoritative On|Off</code></td></tr>
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthzOwnerAuthoritative On</code></td></tr>
</table>
<p>Setting the <code class="directive">AuthzOwnerAuthoritative</code>
directive explicitly to <code>Off</code> allows for
user authorization to be passed on to lower level modules (as defined
<ul>
<li>in the case of <code>file-owner</code> the file-system owner does not
match the supplied web-username or could not be determined, or</li>
<li>in the case of <code>file-group</code> the file-system group does not
contain the supplied web-username or could not be determined.</li>
</ul>
<p>Note that setting the value to <code>Off</code> also allows the
combination of <code>file-owner</code> and <code>file-group</code>, so
access will be allowed if either one or the other (or both) match.</p>
<p>By default, control is not passed on and an authorization failure
will result in an "Authentication Required" reply. Not
setting it to <code>Off</code> thus keeps the system secure and forces
an NCSA compliant behaviour.</p>
</div>
</div>
<div class="bottomlang">
</div><div id="footer">
<p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div>
</body></html>