granicus.if.org Git - apache/blob - docs/manual/mod/mod_authz_owner.html.en

   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_owner - 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.5</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.5</a> &gt; <a href="./">Modules</a></div>
  24 <div id="page-content">
  25 <div id="preamble"><h1>Apache Module mod_authz_owner</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_authz_owner.html" title="English">&nbsp;en&nbsp;</a> |
  28 <a href="../fr/mod/mod_authz_owner.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  29 <a href="../ja/mod/mod_authz_owner.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  30 <a href="../ko/mod/mod_authz_owner.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  31 </div>
  32 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Authorization based on file ownership</td></tr>
  33 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  34 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authz_owner_module</td></tr>
  35 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authz_owner.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 authorizes access to files by comparing the userid used
  40     for HTTP authentication (the web userid) with the file-system owner or
  41     group of the requested file. The supplied username and password
  42     must be already properly verified by an authentication module,
  43     such as <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> or
  44     <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>
  45     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
  46     <code>file-group</code>, as follows:</p>
  47
  48     <dl>
  49       <dt><code>file-owner</code></dt>
  50       <dd>The supplied web-username must match the system's name for the
  51       owner of the file being requested. That is, if the operating system
  52       says the requested file is owned by <code>jones</code>, then the
  53       username used to access it through the web must be <code>jones</code>
  54       as well.</dd>
  55
  56       <dt><code>file-group</code></dt>
  57       <dd>The name of the system group that owns the file must be present
  58       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>,
  59       and the web-username must be a member of that group. For example, if
  60       the operating system says the requested file is owned by (system)
  61       group <code>accounts</code>, the group <code>accounts</code> must
  62       appear in the group database and the web-username used in the request
  63       must be a member of that group.</dd>
  64     </dl>
  65
  66     <div class="note"><h3>Note</h3>
  67       <p>If <code class="module"><a href="../mod/mod_authz_owner.html">mod_authz_owner</a></code> is used in order to authorize
  68       a resource that is not actually present in the filesystem
  69       (<em>i.e.</em> a virtual resource), it will deny the access.</p>
  70
  71       <p>Particularly it will never authorize <a href="../content-negotiation.html#multiviews">content negotiated
  72       "MultiViews"</a> resources.</p>
  73     </div>
  74 </div>
  75 <div id="quickview"><h3 class="directives">Directives</h3>
  76 <p>This module provides no
  77             directives.</p>
  78 <h3>Topics</h3>
  79 <ul id="topics">
  80 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Configuration Examples</a></li>
  81 </ul><h3>See also</h3>
  82 <ul class="seealso">
  83 <li><code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code></li>
  84 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  85 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  86 <div class="section">
  87 <h2><a name="examples" id="examples">Configuration Examples</a></h2>
  88
  89     <h3><a name="examples.file-owner" id="examples.file-owner">Require file-owner</a></h3>
  90       <p>Consider a multi-user system running the Apache Web server, with
  91       each user having his or her own files in <code>~/public_html/private</code>. Assuming that there is a single
  92       <code class="directive"><a href="../mod/mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile</a></code> database
  93       that lists all of their web-usernames, and that these usernames match
  94       the system's usernames that actually own the files on the server, then
  95       the following stanza would allow only the user himself access to his
  96       own files. User <code>jones</code> would not be allowed to access
  97       files in <code>/home/smith/public_html/private</code> unless they
  98       were owned by <code>jones</code> instead of <code>smith</code>.</p>
  99
 100       <pre class="prettyprint lang-config">
 101 &lt;Directory /home/*/public_html/private&gt;
 102     AuthType Basic
 103     AuthName MyPrivateFiles
 104     AuthBasicProvider dbm
 105     AuthDBMUserFile /usr/local/apache2/etc/.htdbm-all
 106     Require file-owner
 107 &lt;/Directory&gt;
 108       </pre>
 109
 110
 111
 112     <h3><a name="examples.file-group" id="examples.file-group">Require file-group</a></h3>
 113       <p>Consider a system similar to the one described above, but with
 114       some users that share their project files in
 115       <code>~/public_html/project-foo</code>. The files are owned by the
 116       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
 117       contains all of the web-usernames and their group membership,
 118       <em>i.e.</em> they must be at least member of a group named
 119       <code>foo</code>. So if <code>jones</code> and <code>smith</code>
 120       are both member of the group <code>foo</code>, then both will be
 121       authorized to access the <code>project-foo</code> directories of
 122       each other.</p>
 123
 124       <pre class="prettyprint lang-config">
 125 &lt;Directory /home/*/public_html/project-foo&gt;
 126     AuthType Basic
 127     AuthName "Project Foo Files"
 128     AuthBasicProvider dbm
 129
 130     # combined user/group database
 131     AuthDBMUserFile  /usr/local/apache2/etc/.htdbm-all
 132     AuthDBMGroupFile /usr/local/apache2/etc/.htdbm-all
 133
 134     Satisfy All
 135     Require file-group
 136 &lt;/Directory&gt;
 137       </pre>
 138
 139
 140 </div>
 141 </div>
 142 <div class="bottomlang">
 143 <p><span>Available Languages: </span><a href="../en/mod/mod_authz_owner.html" title="English">&nbsp;en&nbsp;</a> |
 144 <a href="../fr/mod/mod_authz_owner.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
 145 <a href="../ja/mod/mod_authz_owner.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 146 <a href="../ko/mod/mod_authz_owner.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 147 </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>This section is experimental!</strong><br />Comments placed here should not be expected
 148 to last beyond the testing phase of this system, nor do we in any way guarantee that we'll read them.</div><div id="disqus_thread" /><script type="text/javascript"><!--//--><![CDATA[//><!--
 149 var lang = 'en';
 150 var disqus_shortname = 'httpd';
 151 var disqus_identifier = window.location.href.replace(/(current|trunk)/, "2.4").replace(/\/[a-z]{2}\//, "/").replace(window.location.protocol, "http:") + '.' + lang;
 152 if (disqus_identifier.indexOf("httpd.apache.org") != -1) {
 153     (function() {
 154                 var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
 155                 dsq.src = window.location.protocol + '//' + disqus_shortname + '.disqus.com/embed.js';
 156             (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
 157         })();
 158 } else {
 159     var text = document.createTextNode("Comments have been disabled for offline viewing.");
 160     document.getElementById('disqus_thread').appendChild(text);
 161 }
 162 //--><!]]></script></div><div id="footer">
 163 <p class="apache">Copyright 2012 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>
 164 <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[//><!--
 165 if (typeof(prettyPrint) !== undefined) {
 166     prettyPrint();
 167 }
 168 //--><!]]></script>
 169 </body></html>