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" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <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>
  16 <p class="apache">Apache HTTP Server Version 2.3</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <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.3</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_authz_owner</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_authz_owner.html" title="English">&nbsp;en&nbsp;</a> |
  25 <a href="../fr/mod/mod_authz_owner.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a> |
  26 <a href="../ja/mod/mod_authz_owner.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  27 <a href="../ko/mod/mod_authz_owner.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  28 </div>
  29 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Authorization based on file ownership</td></tr>
  30 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  31 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authz_owner_module</td></tr>
  32 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authz_owner.c</td></tr>
  33 <tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.1 and later</td></tr></table>
  34 <h3>Summary</h3>
  35
  36     <p>This module authorizes access to files by comparing the userid used
  37     for HTTP authentication (the web userid) with the file-system owner or
  38     group of the requested file. The supplied username and password
  39     must be already properly verified by an authentication module,
  40     such as <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> or
  41     <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>
  42     recognizes two arguments for the <code class="directive"><a href="../mod/core.html#require">Require</a></code> directive, <code>file-owner</code> and
  43     <code>file-group</code>, as follows:</p>
  44
  45     <dl>
  46       <dt><code>file-owner</code></dt>
  47       <dd>The supplied web-username must match the system's name for the
  48       owner of the file being requested. That is, if the operating system
  49       says the requested file is owned by <code>jones</code>, then the
  50       username used to access it through the web must be <code>jones</code>
  51       as well.</dd>
  52
  53       <dt><code>file-group</code></dt>
  54       <dd>The name of the system group that owns the file must be present
  55       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>,
  56       and the web-username must be a member of that group. For example, if
  57       the operating system says the requested file is owned by (system)
  58       group <code>accounts</code>, the group <code>accounts</code> must
  59       appear in the group database and the web-username used in the request
  60       must be a member of that group.</dd>
  61     </dl>
  62
  63     <div class="note"><h3>Note</h3>
  64       <p>If <code class="module"><a href="../mod/mod_authz_owner.html">mod_authz_owner</a></code> is used in order to authorize
  65       a resource that is not actually present in the filesystem
  66       (<em>i.e.</em> a virtual resource), it will deny the access.</p>
  67
  68       <p>Particularly it will never authorize <a href="../content-negotiation.html#multiviews">content negotiated
  69       "MultiViews"</a> resources.</p>
  70     </div>
  71 </div>
  72 <div id="quickview"><h3 class="directives">Directives</h3>
  73 <p>This module provides no
  74             directives.</p>
  75 <h3>Topics</h3>
  76 <ul id="topics">
  77 <li><img alt="" src="../images/down.gif" /> <a href="#examples">Configuration Examples</a></li>
  78 </ul><h3>See also</h3>
  79 <ul class="seealso">
  80 <li><code class="directive"><a href="../mod/mod_authz_core.html#require">Require</a></code></li>
  81 </ul></div>
  82 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  83 <div class="section">
  84 <h2><a name="examples" id="examples">Configuration Examples</a></h2>
  85
  86     <h3><a name="examples.file-owner" id="examples.file-owner">Require file-owner</a></h3>
  87       <p>Consider a multi-user system running the Apache Web server, with
  88       each user having his or her own files in <code>~/public_html/private</code>. Assuming that there is a single
  89       <code class="directive"><a href="../mod/mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile</a></code> database
  90       that lists all of their web-usernames, and that these usernames match
  91       the system's usernames that actually own the files on the server, then
  92       the following stanza would allow only the user himself access to his
  93       own files. User <code>jones</code> would not be allowed to access
  94       files in <code>/home/smith/public_html/private</code> unless they
  95       were owned by <code>jones</code> instead of <code>smith</code>.</p>
  96
  97       <div class="example"><p><code>
  98         &lt;Directory /home/*/public_html/private&gt;<br />
  99         <span class="indent">
 100           AuthType Basic<br />
 101           AuthName MyPrivateFiles<br />
 102           AuthBasicProvider dbm<br />
 103           AuthDBMUserFile /usr/local/apache2/etc/.htdbm-all<br />
 104           Require file-owner<br />
 105         </span>
 106         &lt;/Directory&gt;
 107       </code></p></div>
 108
 109
 110     <h3><a name="examples.file-group" id="examples.file-group">Require file-group</a></h3>
 111       <p>Consider a system similar to the one described above, but with
 112       some users that share their project files in
 113       <code>~/public_html/project-foo</code>. The files are owned by the
 114       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
 115       contains all of the web-usernames and their group membership,
 116       <em>i.e.</em> they must be at least member of a group named
 117       <code>foo</code>. So if <code>jones</code> and <code>smith</code>
 118       are both member of the group <code>foo</code>, then both will be
 119       authorized to access the <code>project-foo</code> directories of
 120       each other.</p>
 121
 122       <div class="example"><p><code>
 123         &lt;Directory /home/*/public_html/project-foo&gt;<br />
 124         <span class="indent">
 125           AuthType Basic<br />
 126           AuthName "Project Foo Files"<br />
 127           AuthBasicProvider dbm<br />
 128           <br />
 129           # combined user/group database<br />
 130           AuthDBMUserFile  /usr/local/apache2/etc/.htdbm-all<br />
 131           AuthDBMGroupFile /usr/local/apache2/etc/.htdbm-all<br />
 132           <br />
 133           Satisfy All<br />
 134           Require file-group<br />
 135         </span>
 136         &lt;/Directory&gt;
 137       </code></p></div>
 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 id="footer">
 147 <p class="apache">Copyright 2011 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>
 148 <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>
 149 </body></html>