docs/manual/mod/mod_authz_owner.html.en - httpd - Git at Google

 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
 <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
 <!--
         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
               This file is generated from xml source: DO NOT EDIT
         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
       -->
 <title>mod_authz_owner - Apache HTTP Server Version 2.4</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" />
 <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" />
 <script src="../style/scripts/prettify.min.js" type="text/javascript">
 </script>

 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
 <body>
 <div id="page-header">
 <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>
 <p class="apache">Apache HTTP Server Version 2.4</p>
 <img alt="" src="../images/feather.png" /></div>
 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
 <div id="path">
 <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.4</a> &gt; <a href="./">Modules</a></div>
 <div id="page-content">
 <div id="preamble"><h1>Apache Module mod_authz_owner</h1>
 <div class="toplang">
 <p><span>Available Languages: </span><a href="../en/mod/mod_authz_owner.html" title="English">&nbsp;en&nbsp;</a> |
 <a href="../fr/mod/mod_authz_owner.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 <a href="../ja/mod/mod_authz_owner.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 <a href="../ko/mod/mod_authz_owner.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 </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#Status">Status:</a></th><td>Extension</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#SourceFile">Source File:</a></th><td>mod_authz_owner.c</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,
     such as <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> or
     <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/mod_authz_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
       (<em>i.e.</em> a virtual resource), it will deny the access.</p>

       <p>Particularly it will never authorize <a href="../content-negotiation.html#multiviews">content negotiated
       "MultiViews"</a> resources.</p>
     </div>
 </div>
 <div id="quickview"><a href="https://www.apache.org/foundation/contributing.html" class="badge"><img src="https://www.apache.org/images/SupportApache-small.png" alt="Support Apache!" /></a><h3>Topics</h3>
 <ul id="topics">
 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Configuration Examples</a></li>
 </ul><h3 class="directives">Directives</h3>
 <p>This module provides no
             directives.</p>
 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_authz_owner">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_authz_owner">Report a bug</a></li></ul><h3>See also</h3>
 <ul class="seealso">
 <li><code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code></li>
 <li><a href="#comments_section">Comments</a></li></ul></div>
 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 <div class="section">
 <h2><a name="examples" id="examples">Configuration Examples</a></h2>

     <h3><a name="examples.file-owner" id="examples.file-owner">Require file-owner</a></h3>
       <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
       files in <code>/home/smith/public_html/private</code> unless they
       were owned by <code>jones</code> instead of <code>smith</code>.</p>

       <pre class="prettyprint lang-config">&lt;Directory "/home/*/public_html/private"&gt;
     AuthType Basic
     AuthName MyPrivateFiles
     AuthBasicProvider dbm
     AuthDBMUserFile "/usr/local/apache2/etc/.htdbm-all"
     Require file-owner
 &lt;/Directory&gt;</pre>


     <h3><a name="examples.file-group" id="examples.file-group">Require file-group</a></h3>
       <p>Consider a system similar to the one described above, but with
       some users that share their project files in
       <code>~/public_html/project-foo</code>. The files are owned by the
       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,
       <em>i.e.</em> they must be at least member of a group named
       <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>

       <pre class="prettyprint lang-config">&lt;Directory "/home/*/public_html/project-foo"&gt;
     AuthType Basic
     AuthName "Project Foo Files"
     AuthBasicProvider dbm

     # combined user/group database
     AuthDBMUserFile  "/usr/local/apache2/etc/.htdbm-all"
     AuthDBMGroupFile "/usr/local/apache2/etc/.htdbm-all"

     Satisfy All
     Require file-group
 &lt;/Directory&gt;</pre>


 </div>
 </div>
 <div class="bottomlang">
 <p><span>Available Languages: </span><a href="../en/mod/mod_authz_owner.html" title="English">&nbsp;en&nbsp;</a> |
 <a href="../fr/mod/mod_authz_owner.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 <a href="../ja/mod/mod_authz_owner.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 <a href="../ko/mod/mod_authz_owner.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 </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 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 Libera.chat, or sent to our <a href="https://httpd.apache.org/lists.html">mailing lists</a>.</div>
 <script type="text/javascript"><!--//--><![CDATA[//><!--
 var comments_shortname = 'httpd';
 var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_authz_owner.html';
 (function(w, d) {
     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
         d.write('<div id="comments_thread"><\/div>');
         var s = d.createElement('script');
         s.type = 'text/javascript';
         s.async = true;
         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
     }
     else {
         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
     }
 })(window, document);
 //--><!]]></script></div><div id="footer">
 <p class="apache">Copyright 2022 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>
 <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[//><!--
 if (typeof(prettyPrint) !== 'undefined') {
     prettyPrint();
 }
 //--><!]]></script>
 </body></html>
	<?xml version="1.0" encoding="UTF-8"?>
	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
	<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
	<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
	<!--
	XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
	This file is generated from xml source: DO NOT EDIT
	XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
	-->
	<title>mod_authz_owner - Apache HTTP Server Version 2.4</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" />
	<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" />
	<script src="../style/scripts/prettify.min.js" type="text/javascript">
	</script>

	<link href="../images/favicon.ico" rel="shortcut icon" /></head>
	<body>
	<div id="page-header">
	<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>
	<p class="apache">Apache HTTP Server Version 2.4</p>
	<img alt="" src="../images/feather.png" /></div>
	<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
	<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/">Documentation</a> > <a href="../">Version 2.4</a> > <a href="./">Modules</a></div>
	<div id="page-content">
	<div id="preamble"><h1>Apache Module mod_authz_owner</h1>
	<div class="toplang">
	<p><span>Available Languages: </span><a href="../en/mod/mod_authz_owner.html" title="English"> en </a> \|
	<a href="../fr/mod/mod_authz_owner.html" hreflang="fr" rel="alternate" title="Français"> fr </a> \|
	<a href="../ja/mod/mod_authz_owner.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> \|
	<a href="../ko/mod/mod_authz_owner.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
	</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#Status">Status:</a></th><td>Extension</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#SourceFile">Source File:</a></th><td>mod_authz_owner.c</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,
	such as <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> or
	<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/mod_authz_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
	(<em>i.e.</em> a virtual resource), it will deny the access.</p>

	<p>Particularly it will never authorize <a href="../content-negotiation.html#multiviews">content negotiated
	"MultiViews"</a> resources.</p>
	</div>
	</div>
	<div id="quickview"><a href="https://www.apache.org/foundation/contributing.html" class="badge"><img src="https://www.apache.org/images/SupportApache-small.png" alt="Support Apache!" /></a><h3>Topics</h3>
	<ul id="topics">
	<li><img alt="" src="../images/down.gif" /> <a href="#examples">Configuration Examples</a></li>
	</ul><h3 class="directives">Directives</h3>
	<p>This module provides no
	directives.</p>
	<h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_authz_owner">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_authz_owner">Report a bug</a></li></ul><h3>See also</h3>
	<ul class="seealso">
	<li><code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code></li>
	<li><a href="#comments_section">Comments</a></li></ul></div>
	<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
	<div class="section">
	<h2><a name="examples" id="examples">Configuration Examples</a></h2>

	<h3><a name="examples.file-owner" id="examples.file-owner">Require file-owner</a></h3>
	<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
	files in <code>/home/smith/public_html/private</code> unless they
	were owned by <code>jones</code> instead of <code>smith</code>.</p>

	<pre class="prettyprint lang-config"><Directory "/home/*/public_html/private">
	AuthType Basic
	AuthName MyPrivateFiles
	AuthBasicProvider dbm
	AuthDBMUserFile "/usr/local/apache2/etc/.htdbm-all"
	Require file-owner
	</Directory></pre>



	<h3><a name="examples.file-group" id="examples.file-group">Require file-group</a></h3>
	<p>Consider a system similar to the one described above, but with
	some users that share their project files in
	<code>~/public_html/project-foo</code>. The files are owned by the
	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,
	<em>i.e.</em> they must be at least member of a group named
	<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>

	<pre class="prettyprint lang-config"><Directory "/home/*/public_html/project-foo">
	AuthType Basic
	AuthName "Project Foo Files"
	AuthBasicProvider dbm

	# combined user/group database
	AuthDBMUserFile "/usr/local/apache2/etc/.htdbm-all"
	AuthDBMGroupFile "/usr/local/apache2/etc/.htdbm-all"

	Satisfy All
	Require file-group
	</Directory></pre>


	</div>
	</div>
	<div class="bottomlang">
	<p><span>Available Languages: </span><a href="../en/mod/mod_authz_owner.html" title="English"> en </a> \|
	<a href="../fr/mod/mod_authz_owner.html" hreflang="fr" rel="alternate" title="Français"> fr </a> \|
	<a href="../ja/mod/mod_authz_owner.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> \|
	<a href="../ko/mod/mod_authz_owner.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
	</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 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 Libera.chat, or sent to our <a href="https://httpd.apache.org/lists.html">mailing lists</a>.</div>
	<script type="text/javascript"><!--//--><![CDATA[//><!--
	var comments_shortname = 'httpd';
	var comments_identifier = 'http://httpd.apache.org/docs/2.4/mod/mod_authz_owner.html';
	(function(w, d) {
	if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
	d.write('<div id="comments_thread"><\/div>');
	var s = d.createElement('script');
	s.type = 'text/javascript';
	s.async = true;
	s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
	(d.getElementsByTagName('head')[0] \|\| d.getElementsByTagName('body')[0]).appendChild(s);
	}
	else {
	d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
	}
	})(window, document);
	//--><!]]></script></div><div id="footer">
	<p class="apache">Copyright 2022 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>
	<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[//><!--
	if (typeof(prettyPrint) !== 'undefined') {
	prettyPrint();
	}
	//--><!]]></script>
	</body></html>