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