| <?xml version="1.0" encoding="UTF-8"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head> |
| <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" /> |
| <!-- |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| This file is generated from xml source: DO NOT EDIT |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| --> |
| <title>mod_dav - Apache HTTP Server Version 2.5</title> |
| <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> |
| <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> |
| <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" /> |
| <script src="../style/scripts/prettify.min.js" type="text/javascript"> |
| </script> |
| |
| <link href="../images/favicon.ico" rel="shortcut icon" /></head> |
| <body> |
| <div id="page-header"> |
| <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> |
| <p class="apache">Apache HTTP Server Version 2.5</p> |
| <img alt="" src="../images/feather.png" /></div> |
| <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> |
| <div id="path"> |
| <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div> |
| <div id="page-content"> |
| <div id="preamble"><h1>Apache Module mod_dav</h1> |
| <div class="toplang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_dav.html" title="English"> en </a> | |
| <a href="../fr/mod/mod_dav.html" hreflang="fr" rel="alternate" title="Français"> fr </a> | |
| <a href="../ja/mod/mod_dav.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | |
| <a href="../ko/mod/mod_dav.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> |
| </div> |
| <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Distributed Authoring and Versioning |
| (<a href="http://www.webdav.org/">WebDAV</a>) functionality</td></tr> |
| <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>dav_module</td></tr> |
| <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_dav.c</td></tr></table> |
| <h3>Summary</h3> |
| |
| <p>This module provides class 1 and class 2 <a href="http://www.webdav.org">WebDAV</a> ('Web-based Distributed |
| Authoring and Versioning') functionality for Apache. This |
| extension to the HTTP protocol allows creating, moving, |
| copying, and deleting resources and collections on a remote web |
| server.</p> |
| </div> |
| <div id="quickview"><h3>Topics</h3> |
| <ul id="topics"> |
| <li><img alt="" src="../images/down.gif" /> <a href="#example">Enabling WebDAV</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#security">Security Issues</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#complex">Complex Configurations</a></li> |
| </ul><h3 class="directives">Directives</h3> |
| <ul id="toc"> |
| <li><img alt="" src="../images/down.gif" /> <a href="#dav">Dav</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#davbasepath">DavBasePath</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#davdepthinfinity">DavDepthInfinity</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#davmintimeout">DavMinTimeout</a></li> |
| <li><img alt="" src="../images/down.gif" /> <a href="#davmsext">DavMSext</a></li> |
| </ul> |
| <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__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_dav">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_dav">Report a bug</a></li></ul><h3>See also</h3> |
| <ul class="seealso"> |
| <li><code class="module"><a href="../mod/mod_dav_fs.html">mod_dav_fs</a></code></li> |
| <li><code class="directive"><a href="../mod/core.html#limitxmlrequestbody">LimitXMLRequestBody</a></code></li> |
| <li><a href="#comments_section">Comments</a></li></ul></div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="example" id="example">Enabling WebDAV</a> <a title="Permanent link" href="#example" class="permalink">¶</a></h2> |
| <p>To enable <code class="module"><a href="../mod/mod_dav.html">mod_dav</a></code>, add the following to a |
| container in your <code>httpd.conf</code> file:</p> |
| |
| <pre class="prettyprint lang-config">Dav On</pre> |
| |
| |
| <p>This enables the DAV file system provider, which is implemented |
| by the <code class="module"><a href="../mod/mod_dav_fs.html">mod_dav_fs</a></code> module. Therefore, that module |
| must be compiled into the server or loaded at runtime using the |
| <code class="directive"><a href="../mod/mod_so.html#loadmodule">LoadModule</a></code> directive.</p> |
| |
| <p>You may wish to add a <code class="directive"><a href="../mod/core.html#limit"><Limit></a></code> clause inside the <code class="directive"><a href="../mod/core.html#location"><Location></a></code> directive to limit access to |
| DAV-enabled locations. If you want to set the maximum amount of |
| bytes that a DAV client can send at one request, you have to use |
| the <code class="directive"><a href="../mod/core.html#limitxmlrequestbody">LimitXMLRequestBody</a></code> |
| directive. The "normal" <code class="directive"><a href="../mod/core.html#limitrequestbody">LimitRequestBody</a></code> directive has no effect on DAV |
| requests.</p> |
| |
| <div class="example"><h3>Full Example</h3><pre class="prettyprint lang-config"><Directory "/usr/local/apache2/htdocs/foo"> |
| Require all granted |
| Dav On |
| |
| AuthType Basic |
| AuthName "DAV" |
| AuthUserFile "user.passwd" |
| |
| <LimitExcept GET POST OPTIONS> |
| Require user admin |
| </LimitExcept> |
| </Directory></pre> |
| </div> |
| |
| </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="security" id="security">Security Issues</a> <a title="Permanent link" href="#security" class="permalink">¶</a></h2> |
| |
| <p>Since DAV access methods allow remote clients to manipulate |
| files on the server, you must take particular care to assure that |
| your server is secure before enabling <code class="module"><a href="../mod/mod_dav.html">mod_dav</a></code>.</p> |
| |
| <p>Any location on the server where DAV is enabled should be |
| protected by authentication. The use of HTTP Basic Authentication |
| is not recommended. You should use at least HTTP Digest |
| Authentication, which is provided by the |
| <code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code> module. Nearly all WebDAV clients |
| support this authentication method. An alternative is Basic |
| Authentication over an <a href="../ssl/">SSL</a> enabled |
| connection.</p> |
| |
| <p>In order for <code class="module"><a href="../mod/mod_dav.html">mod_dav</a></code> to manage files, it must |
| be able to write to the directories and files under its control |
| using the <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> under which |
| Apache is running. New files created will also be owned by this |
| <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 |
| important to control access to this account. The DAV repository |
| is considered private to Apache; modifying files outside of Apache |
| (for example using FTP or filesystem-level tools) should not be |
| allowed.</p> |
| |
| <p><code class="module"><a href="../mod/mod_dav.html">mod_dav</a></code> may be subject to various kinds of |
| denial-of-service attacks. The <code class="directive"><a href="../mod/core.html#limitxmlrequestbody">LimitXMLRequestBody</a></code> directive can be |
| used to limit the amount of memory consumed in parsing large DAV |
| requests. The <code class="directive"><a href="#davdepthinfinity">DavDepthInfinity</a></code> directive can be |
| used to prevent <code>PROPFIND</code> requests on a very large |
| repository from consuming large amounts of memory. Another |
| possible denial-of-service attack involves a client simply filling |
| up all available disk space with many large files. There is no |
| direct way to prevent this in Apache, so you should avoid giving |
| DAV access to untrusted users.</p> |
| </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="section"> |
| <h2><a name="complex" id="complex">Complex Configurations</a> <a title="Permanent link" href="#complex" class="permalink">¶</a></h2> |
| |
| <p>One common request is to use <code class="module"><a href="../mod/mod_dav.html">mod_dav</a></code> to |
| manipulate dynamic files (PHP scripts, CGI scripts, etc). This is |
| difficult because a <code>GET</code> request will always run the |
| script, rather than downloading its contents. One way to avoid |
| this is to map two different URLs to the content, one of which |
| will run the script, and one of which will allow it to be |
| downloaded and manipulated with DAV.</p> |
| |
| <pre class="prettyprint lang-config">Alias "/phparea" "/home/gstein/php_files" |
| Alias "/php-source" "/home/gstein/php_files" |
| <Location "/php-source"> |
| Dav On |
| ForceType text/plain |
| </Location></pre> |
| |
| |
| <p>With this setup, <code>http://example.com/phparea</code> can be |
| used to access the output of the PHP scripts, and |
| <code>http://example.com/php-source</code> can be used with a DAV |
| client to manipulate them.</p> |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="Dav" id="Dav">Dav</a> <a name="dav" id="dav">Directive</a> <a title="Permanent link" href="#dav" class="permalink">¶</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable WebDAV HTTP methods</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>Dav On|Off|<var>provider-name</var></code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>Dav Off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dav</td></tr> |
| </table> |
| <p>Use the <code class="directive">Dav</code> directive to enable the |
| WebDAV HTTP methods for the given container:</p> |
| |
| <pre class="prettyprint lang-config"><Location "/foo"> |
| Dav On |
| </Location></pre> |
| |
| |
| <p>The value <code>On</code> is actually an alias for the default |
| 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 |
| for some location, it <em>cannot</em> be disabled for sublocations. |
| For a complete configuration example have a look at the <a href="#example">section above</a>.</p> |
| |
| <div class="warning"> |
| Do not enable WebDAV until you have secured your server. Otherwise |
| everyone will be able to distribute files on your system. |
| </div> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="DavBasePath" id="DavBasePath">DavBasePath</a> <a name="davbasepath" id="davbasepath">Directive</a> <a title="Permanent link" href="#davbasepath" class="permalink">¶</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configure repository root path</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DavBasePath <var>root-path</var></code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>None</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dav</td></tr> |
| <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in version 2.4.58 and later</td></tr> |
| </table> |
| <p>If a DAV repository is configured using a regular expression |
| match (such as <code class="directive"><a href="../mod/core.html#locationmatch">LocationMatch</a></code>) |
| then <code class="module"><a href="../mod/mod_dav.html">mod_dav</a></code> will not be able to find the root of |
| the repository from the pathname alone. Third-party providers (for |
| example, Subversion's <a href="https://svnbook.red-bean.com/en/1.7/svn.ref.mod_dav_svn.conf.html">mod_dav_svn</a>) |
| may fail to handle requests without the correct repository root.</p> |
| |
| <p>To allow providers to work correctly in such a configuration, |
| <code class="directive">DavBasePath</code> must be used.</p> |
| |
| <div class="example"><h3>Example</h3><pre class="prettyprint lang-config"><LocationMatch "^/repos/"> |
| Dav svn |
| DavBasePath /repos |
| SVNParentPath /var/svn |
| </LocationMatch></pre> |
| </div> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="DavDepthInfinity" id="DavDepthInfinity">DavDepthInfinity</a> <a name="davdepthinfinity" id="davdepthinfinity">Directive</a> <a title="Permanent link" href="#davdepthinfinity" class="permalink">¶</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Allow PROPFIND, Depth: Infinity requests</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DavDepthInfinity on|off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DavDepthInfinity off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dav</td></tr> |
| </table> |
| <p>Use the <code class="directive">DavDepthInfinity</code> directive to |
| allow the processing of <code>PROPFIND</code> requests containing the |
| header 'Depth: Infinity'. Because this type of request could constitute |
| a denial-of-service attack, by default it is not allowed.</p> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="DavMinTimeout" id="DavMinTimeout">DavMinTimeout</a> <a name="davmintimeout" id="davmintimeout">Directive</a> <a title="Permanent link" href="#davmintimeout" class="permalink">¶</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Minimum amount of time the server holds a lock on |
| a DAV resource</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DavMinTimeout <var>seconds</var></code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DavMinTimeout 0</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dav</td></tr> |
| </table> |
| <p>When a client requests a DAV resource lock, it can also |
| specify a time when the lock will be automatically removed by |
| the server. This value is only a request, and the server can |
| ignore it or inform the client of an arbitrary value.</p> |
| |
| <p>Use the <code class="directive">DavMinTimeout</code> directive to specify, in |
| seconds, the minimum lock timeout to return to a client. |
| Microsoft Web Folders defaults to a timeout of 120 seconds; the |
| <code class="directive">DavMinTimeout</code> can override this to a higher value |
| (like 600 seconds) to reduce the chance of the client losing |
| the lock due to network latency.</p> |
| |
| <div class="example"><h3>Example</h3><pre class="prettyprint lang-config"><Location "/MSWord"> |
| DavMinTimeout 600 |
| </Location></pre> |
| </div> |
| |
| </div> |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="DavMSext" id="DavMSext">DavMSext</a> <a name="davmsext" id="davmsext">Directive</a> <a title="Permanent link" href="#davmsext" class="permalink">¶</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable support for Microsoft extensions</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>DavMSext None | [+|-]WDV | All</code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>DavMSext None</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_dav</td></tr> |
| </table> |
| <p>The <code class="directive">DavMSext</code> directive enables support |
| for Microsoft extensions. Possible values are:</p> |
| <ul> |
| <li><code>None</code> No Microsoft extension is enabled.</li> |
| <li><code>WDV</code> Enable support for |
| <a href="https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wdv">MS-WDV</a>. |
| </li> |
| <li><code>All</code> All implemented Microsoft extension |
| are enabled. Currently, this is means <code>WDV</code> as |
| it is the only Microsoft extension implemented.</li> |
| </ul> |
| |
| |
| </div> |
| </div> |
| <div class="bottomlang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_dav.html" title="English"> en </a> | |
| <a href="../fr/mod/mod_dav.html" hreflang="fr" rel="alternate" title="Français"> fr </a> | |
| <a href="../ja/mod/mod_dav.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | |
| <a href="../ko/mod/mod_dav.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> |
| </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&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed 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 Libera.chat, or sent to our <a href="https://httpd.apache.org/lists.html">mailing lists</a>.</div> |
| <script type="text/javascript"><!--//--><![CDATA[//><!-- |
| var comments_shortname = 'httpd'; |
| var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_dav.html'; |
| (function(w, d) { |
| if (w.location.hostname.toLowerCase() == "httpd.apache.org") { |
| d.write('<div id="comments_thread"><\/div>'); |
| var s = d.createElement('script'); |
| s.type = 'text/javascript'; |
| s.async = true; |
| s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; |
| (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); |
| } |
| else { |
| d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); |
| } |
| })(window, document); |
| //--><!]]></script></div><div id="footer"> |
| <p class="apache">Copyright 2023 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> |
| <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[//><!-- |
| if (typeof(prettyPrint) !== 'undefined') { |
| prettyPrint(); |
| } |
| //--><!]]></script> |
| </body></html> |
