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