granicus.if.org Git - apache/blob - docs/manual/mod/mod_dav.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_dav - 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_dav</h1>
  26 <div class="toplang">
  27 <p><span>Available Languages: </span><a href="../en/mod/mod_dav.html" title="English">&nbsp;en&nbsp;</a> |
  28 <a href="../ja/mod/mod_dav.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
  29 <a href="../ko/mod/mod_dav.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
  30 </div>
  31 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Distributed Authoring and Versioning
  32 (<a href="http://www.webdav.org/">WebDAV</a>) functionality</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>dav_module</td></tr>
  35 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_dav.c</td></tr></table>
  36 <h3>Summary</h3>
  37
  38     <p>This module provides class 1 and class 2 <a href="http://www.webdav.org">WebDAV</a> ('Web-based Distributed
  39     Authoring and Versioning') functionality for Apache. This
  40     extension to the HTTP protocol allows creating, moving,
  41     copying, and deleting resources and collections on a remote web
  42     server.</p>
  43 </div>
  44 <div id="quickview"><h3 class="directives">Directives</h3>
  45 <ul id="toc">
  46 <li><img alt="" src="../images/down.gif" /> <a href="#dav">Dav</a></li>
  47 <li><img alt="" src="../images/down.gif" /> <a href="#davdepthinfinity">DavDepthInfinity</a></li>
  48 <li><img alt="" src="../images/down.gif" /> <a href="#davmintimeout">DavMinTimeout</a></li>
  49 </ul>
  50 <h3>Topics</h3>
  51 <ul id="topics">
  52 <li><img alt="" src="../images/down.gif" /> <a href="#example">Enabling WebDAV</a></li>
  53 <li><img alt="" src="../images/down.gif" /> <a href="#security">Security Issues</a></li>
  54 <li><img alt="" src="../images/down.gif" /> <a href="#complex">Complex Configurations</a></li>
  55 </ul><h3>See also</h3>
  56 <ul class="seealso">
  57 <li><code class="directive"><a href="../mod/mod_dav_fs.html#davlockdb">DavLockDB</a></code></li>
  58 <li><code class="directive"><a href="../mod/core.html#limitxmlrequestbody">LimitXMLRequestBody</a></code></li>
  59 <li><a href="http://www.webdav.org">WebDAV Resources</a></li>
  60 </ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
  61 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  62 <div class="section">
  63 <h2><a name="example" id="example">Enabling WebDAV</a></h2>
  64     <p>To enable <code class="module"><a href="../mod/mod_dav.html">mod_dav</a></code>, add the following to a
  65     container in your <code>httpd.conf</code> file:</p>
  66
  67     <pre class="prettyprint lang-config">Dav On</pre>
  68
  69
  70     <p>This enables the DAV file system provider, which is implemented
  71     by the <code class="module"><a href="../mod/mod_dav_fs.html">mod_dav_fs</a></code> module. Therefore, that module
  72     must be compiled into the server or loaded at runtime using the
  73     <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code> directive.</p>
  74
  75     <p>In addition, a location for the DAV lock database must be
  76     specified in the global section of your <code>httpd.conf</code>
  77     file using the <code class="directive"><a href="../mod/mod_dav_fs.html#davlockdb">DavLockDB</a></code>
  78     directive:</p>
  79
  80     <pre class="prettyprint lang-config">
  81       DavLockDB /usr/local/apache2/var/DavLock
  82     </pre>
  83
  84
  85     <p>The directory containing the lock database file must be
  86     writable by the <code class="directive"><a href="../mod/mod_unixd.html#user">User</a></code>
  87     and <code class="directive"><a href="../mod/mod_unixd.html#group">Group</a></code> under which
  88     Apache is running.</p>
  89
  90     <p>You may wish to add a <code class="directive"><a href="../mod/core.html#limit">&lt;Limit&gt;</a></code> clause inside the <code class="directive"><a href="../mod/core.html#location">&lt;Location&gt;</a></code> directive to limit access to
  91     DAV-enabled locations. If you want to set the maximum amount of
  92     bytes that a DAV client can send at one request, you have to use
  93     the <code class="directive"><a href="../mod/core.html#limitxmlrequestbody">LimitXMLRequestBody</a></code>
  94     directive. The "normal" <code class="directive"><a href="../mod/core.html#limitrequestbody">LimitRequestBody</a></code> directive has no effect on DAV
  95     requests.</p>
  96
  97     <div class="example"><h3>Full Example</h3><pre class="prettyprint lang-config">
  98 DavLockDB /usr/local/apache2/var/DavLock
  99
 100 &lt;Directory /usr/local/apache2/htdocs/foo&gt;
 101     Require all granted
 102     Dav On
 103
 104     AuthType Basic
 105     AuthName DAV
 106     AuthUserFile user.passwd
 107
 108     &lt;LimitExcept GET POST OPTIONS&gt;
 109         Require user admin
 110     &lt;/LimitExcept&gt;
 111 &lt;/Directory&gt;
 112       </pre>
 113 </div>
 114
 115 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 116 <div class="section">
 117 <h2><a name="security" id="security">Security Issues</a></h2>
 118
 119     <p>Since DAV access methods allow remote clients to manipulate
 120     files on the server, you must take particular care to assure that
 121     your server is secure before enabling <code class="module"><a href="../mod/mod_dav.html">mod_dav</a></code>.</p>
 122
 123     <p>Any location on the server where DAV is enabled should be
 124     protected by authentication.  The use of HTTP Basic Authentication
 125     is not recommended. You should use at least HTTP Digest
 126     Authentication, which is provided by the
 127     <code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code> module. Nearly all WebDAV clients
 128     support this authentication method. An alternative is Basic
 129     Authentication over an <a href="../ssl/">SSL</a> enabled
 130     connection.</p>
 131
 132     <p>In order for <code class="module"><a href="../mod/mod_dav.html">mod_dav</a></code> to manage files, it must
 133     be able to write to the directories and files under its control
 134     using the <code class="directive"><a href="../mod/mod_unixd.html#user">User</a></code> and
 135     <code class="directive"><a href="../mod/mod_unixd.html#group">Group</a></code> under which
 136     Apache is running.  New files created will also be owned by this
 137     <code class="directive"><a href="../mod/mod_unixd.html#user">User</a></code> and <code class="directive"><a href="../mod/mod_unixd.html#group">Group</a></code>.  For this reason, it is
 138     important to control access to this account.  The DAV repository
 139     is considered private to Apache; modifying files outside of Apache
 140     (for example using FTP or filesystem-level tools) should not be
 141     allowed.</p>
 142
 143     <p><code class="module"><a href="../mod/mod_dav.html">mod_dav</a></code> may be subject to various kinds of
 144     denial-of-service attacks.  The <code class="directive"><a href="../mod/core.html#limitxmlrequestbody">LimitXMLRequestBody</a></code> directive can be
 145     used to limit the amount of memory consumed in parsing large DAV
 146     requests.  The <code class="directive"><a href="#davdepthinfinity">DavDepthInfinity</a></code> directive can be
 147     used to prevent <code>PROPFIND</code> requests on a very large
 148     repository from consuming large amounts of memory.  Another
 149     possible denial-of-service attack involves a client simply filling
 150     up all available disk space with many large files.  There is no
 151     direct way to prevent this in Apache, so you should avoid giving
 152     DAV access to untrusted users.</p>
 153 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 154 <div class="section">
 155 <h2><a name="complex" id="complex">Complex Configurations</a></h2>
 156
 157     <p>One common request is to use <code class="module"><a href="../mod/mod_dav.html">mod_dav</a></code> to
 158     manipulate dynamic files (PHP scripts, CGI scripts, etc).  This is
 159     difficult because a <code>GET</code> request will always run the
 160     script, rather than downloading its contents.  One way to avoid
 161     this is to map two different URLs to the content, one of which
 162     will run the script, and one of which will allow it to be
 163     downloaded and manipulated with DAV.</p>
 164
 165 <pre class="prettyprint lang-config">
 166 Alias /phparea /home/gstein/php_files
 167 Alias /php-source /home/gstein/php_files
 168 &lt;Location /php-source&gt;
 169     DAV On
 170     ForceType text/plain
 171 &lt;/Location&gt;
 172 </pre>
 173
 174
 175     <p>With this setup, <code>http://example.com/phparea</code> can be
 176     used to access the output of the PHP scripts, and
 177     <code>http://example.com/php-source</code> can be used with a DAV
 178     client to manipulate them.</p>
 179 </div>
 180 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 181 <div class="directive-section"><h2><a name="Dav" id="Dav">Dav</a> <a name="dav" id="dav">Directive</a></h2>
 182 <table class="directive">
 183 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable WebDAV HTTP methods</td></tr>
 184 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Dav On|Off|<var>provider-name</var></code></td></tr>
 185 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Dav Off</code></td></tr>
 186 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
 187 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 188 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dav</td></tr>
 189 </table>
 190     <p>Use the <code class="directive">Dav</code> directive to enable the
 191     WebDAV HTTP methods for the given container:</p>
 192
 193     <pre class="prettyprint lang-config">
 194 &lt;Location /foo&gt;
 195     Dav On
 196 &lt;/Location&gt;
 197     </pre>
 198
 199
 200     <p>The value <code>On</code> is actually an alias for the default
 201     provider <code>filesystem</code> which is served by the <code class="module"><a href="../mod/mod_dav_fs.html">mod_dav_fs</a></code> module. Note, that once you have DAV enabled
 202     for some location, it <em>cannot</em> be disabled for sublocations.
 203     For a complete configuration example have a look at the <a href="#example">section above</a>.</p>
 204
 205     <div class="warning">
 206       Do not enable WebDAV until you have secured your server. Otherwise
 207       everyone will be able to distribute files on your system.
 208     </div>
 209
 210 </div>
 211 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 212 <div class="directive-section"><h2><a name="DavDepthInfinity" id="DavDepthInfinity">DavDepthInfinity</a> <a name="davdepthinfinity" id="davdepthinfinity">Directive</a></h2>
 213 <table class="directive">
 214 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Allow PROPFIND, Depth: Infinity requests</td></tr>
 215 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DavDepthInfinity on|off</code></td></tr>
 216 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DavDepthInfinity off</code></td></tr>
 217 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
 218 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 219 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dav</td></tr>
 220 </table>
 221     <p>Use the <code class="directive">DavDepthInfinity</code> directive to
 222     allow the processing of <code>PROPFIND</code> requests containing the
 223     header 'Depth: Infinity'. Because this type of request could constitute
 224     a denial-of-service attack, by default it is not allowed.</p>
 225
 226 </div>
 227 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 228 <div class="directive-section"><h2><a name="DavMinTimeout" id="DavMinTimeout">DavMinTimeout</a> <a name="davmintimeout" id="davmintimeout">Directive</a></h2>
 229 <table class="directive">
 230 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Minimum amount of time the server holds a lock on
 231 a DAV resource</td></tr>
 232 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DavMinTimeout <var>seconds</var></code></td></tr>
 233 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DavMinTimeout 0</code></td></tr>
 234 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
 235 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 236 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dav</td></tr>
 237 </table>
 238     <p>When a client requests a DAV resource lock, it can also
 239     specify a time when the lock will be automatically removed by
 240     the server. This value is only a request, and the server can
 241     ignore it or inform the client of an arbitrary value.</p>
 242
 243     <p>Use the <code class="directive">DavMinTimeout</code> directive to specify, in
 244     seconds, the minimum lock timeout to return to a client.
 245     Microsoft Web Folders defaults to a timeout of 120 seconds; the
 246     <code class="directive">DavMinTimeout</code> can override this to a higher value
 247     (like 600 seconds) to reduce the chance of the client losing
 248     the lock due to network latency.</p>
 249
 250     <div class="example"><h3>Example</h3><pre class="prettyprint lang-config">
 251 &lt;Location /MSWord&gt;
 252     DavMinTimeout 600
 253 &lt;/Location&gt;
 254     </pre>
 255 </div>
 256
 257 </div>
 258 </div>
 259 <div class="bottomlang">
 260 <p><span>Available Languages: </span><a href="../en/mod/mod_dav.html" title="English">&nbsp;en&nbsp;</a> |
 261 <a href="../ja/mod/mod_dav.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 262 <a href="../ko/mod/mod_dav.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 263 </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>
 264 <script type="text/javascript"><!--//--><![CDATA[//><!--
 265 var comments_shortname = 'httpd';
 266 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_dav.html';
 267 (function(w, d) {
 268     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 269         d.write('<div id="comments_thread"><\/div>');
 270         var s = d.createElement('script');
 271         s.type = 'text/javascript';
 272         s.async = true;
 273         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 274         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 275     }
 276     else {
 277         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 278     }
 279 })(window, document);
 280 //--><!]]></script></div><div id="footer">
 281 <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>
 282 <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[//><!--
 283 if (typeof(prettyPrint) !== 'undefined') {
 284     prettyPrint();
 285 }
 286 //--><!]]></script>
 287 </body></html>