|RFC(s)||RFC 2518, RFC 4918|
Web Distributed Authoring and Versioning (WebDAV) is an extension of the Hypertext Transfer Protocol (HTTP) that allows clients to perform remote Web content authoring operations. WebDAV is defined in RFC 4918 by a working group of the Internet Engineering Task Force.
The WebDAV protocol provides a framework for users to create, change and move documents on a server. The most important features of the WebDAV protocol include the maintenance of properties about an author or modification date, namespace management, collections, and overwrite protection. Maintenance of properties includes such things as the creation, removal, and querying of file information. Namespace management deals with the ability to copy and move web pages within a server’s namespace. Collections deal with the creation, removal, and listing of various resources. Lastly, overwrite protection handles aspects related to locking of files.
WebDAV began in 1996 when Jim Whitehead, a PhD graduate from UC Irvine, worked with the World Wide Web Consortium (W3C) to host two meetings to discuss the problem of distributed authoring on the World Wide Web with interested people. Tim Berners-Lee's original vision of the Web involved a medium for both reading and writing. In fact, Berners-Lee's first web browser, called WorldWideWeb, could both view and edit web pages; but, as the Web grew, it became a read-only medium for most users. Whitehead and other like-minded people wanted to transcend that limitation.
As work began on the protocol, it became clear that handling both distributed authoring and versioning together would involve too much work and that the tasks would have to be separated. The WebDAV group focused on distributed authoring, and left versioning for the future. (The Delta-V extension added versioning later – see the Extensions section below.)
The WebDAV working group concluded its work in March 2007, after the Internet Engineering Steering Group (IESG) accepted an incremental update to RFC 2518. Other extensions left unfinished at that time, such as the BIND method, have been finished by their individual authors, independent of the formal working group.
WebDAV extends the set of standard HTTP verbs and headers allowed for request methods. The added verbs include:
- copy a resource from one URI to another
- put a lock on a resource. WebDAV supports both shared and exclusive locks.
- create collections (a.k.a. a directory)
- move a resource from one URI to another
- retrieve properties, stored as XML, from a web resource. It is also overloaded to allow one to retrieve the collection structure (also known as directory hierarchy) of a remote system.
- change and delete multiple properties on a resource in a single atomic act
- remove a lock from a resource
- Apache HTTP Server provides WebDAV modules based on both davfs and Apache Subversion (svn).
- Microsoft's IIS also has a WebDAV module.
- Nginx has a very limited optional WebDav module and a third-party module
- SabreDAV is a PHP application that can be used on Apache or Nginx in lieu of their bundled modules
- Nextcloud is a cloud storage PHP application which offers full WebDAV support
- Git supports writing to HTTP remotes, although the "smart" Git protocol for HTTP requiring special server support was made the preferred protocol over WebDAV
- Linux via GVfs, including GNOME Files and via KIO, including Konqueror and Dolphin
- macOS, including native support for CalDAV and CardDAV for which Apple based the design on WebDAV
- Microsoft Windows, including native support in Explorer
- Microsoft Office
- Comparison of WebDAV software
Documents produced by the working group
The WebDAV working group produced several works:
- a requirements document: "Requirements for a Distributed Authoring and Versioning Protocol for the World Wide Web" RFC 2291, issued February 1998
- a base protocol document (excluding versioning, despite its title): "HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)" RFC 4918, issued June 2007 (which updates and supersedes "HTTP Extensions for Distributed Authoring – WebDAV" RFC 2518, issued February 1999)
- the ordered collections protocol: "Web Distributed Authoring and Versioning (WebDAV) Ordered Collections Protocol" RFC 3648, issued December 2003
- the access control protocol: "Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol" RFC 3744, issued May 2004
- a quota specification: "Quota and Size Properties for Distributed Authoring and Versioning (DAV) Collections" RFC 4331, issued February 2006
- a redirect specification: "Web Distributed Authoring and Versioning (WebDAV) Redirect Reference Resources" RFC 4437, issued March 2006
Other documents published through IETF
- the versioning protocol: "Versioning Extensions to WebDAV (Web Distributed Authoring and Versioning)" RFC 3253 (created by the Delta-V working group)
- a specification of WebDAV property datatypes: "Datatypes for Web Distributed Authoring and Versioning (WebDAV) Properties" RFC 4316
- a document defining how to initiate mounting of a WebDAV resource: "Mounting Web Distributed Authoring and Versioning (WebDAV) Servers" RFC 4709
- a calendar access protocol: "Calendaring Extensions to WebDAV (CalDAV)" RFC 4791
- a query protocol: "Web Distributed Authoring and Versioning (WebDAV) SEARCH" RFC 5323
- an extension to the WebDAV ACL specification: "WebDAV Current Principal Extension" RFC 5397
- an extension to the WebDAV MKCOL method: "Extended MKCOL for Web Distributed Authoring and Versioning (WebDAV)" RFC 5689
- an extension of the collection model, defining creation and discovery of additional bindings to a resource: "Binding Extensions to Web Distributed Authoring and Versioning (WebDAV)" RFC 5842
- an application of POST to WebDAV collections: "Using POST to Add Members to Web Distributed Authoring and Versioning (WebDAV) Collections" RFC 5995
- an extension which allows synchronizing large collections efficiently: "Collection Synchronization for Web Distributed Authoring and Versioning (WebDAV)" RFC 6578
Extensions and derivatives
For searching and locating, the DAV Searching and Locating (DASL) working group never produced any official standard although there are a number of implementations of its last draft. Work continued as non-working-group activity. The WebDAV Search specification attempts to pick up where the working group left off, and was published as RFC 5323 in November 2008.
For calendaring, CalDAV is a protocol allowing calendar access via WebDAV. CalDAV models calendar events as HTTP resources in iCalendar format, and models calendars containing events as WebDAV collections.
For MS Exchange interoperability, WebDAV can be used for reading/updating/deleting items in a mailbox or public folder. WebDAV for Exchange has been extended by Microsoft to accommodate working with messaging data. Exchange Server version 2000, 2003, and 2007 support WebDAV. However, WebDAV support has been discontinued in Exchange 2010 in favor of Exchange Web Services (EWS), a SOAP/XML based API.
Additional Windows-specific extensions
As part of the Windows Server Protocols (WSPP) documentation set, Microsoft published the following protocol documents detailing extensions to WebDAV:
- [MS-WDVME]: Web Distributed Authoring and Versioning (WebDAV) Protocol: Microsoft Extensions. These extensions include a new verb and new headers, and properties that enable previously unmanageable file types and optimize protocol interactions for file system clients. These extensions introduce new functionality into WebDAV, optimize processing, and eliminate the need for special-case processing.
- [MS-WDV]: Web Distributed Authoring and Versioning (WebDAV) Protocol: Client Extensions. The client extensions in this specification extend the WebDAV Protocol by introducing new headers that both enable the file types that are not currently manageable and optimize protocol interactions for file system clients. These extensions do not introduce new functionality into the WebDAV Protocol, but instead optimize processing and eliminate the need for special-case processing.
- [MS-WDVSE]: Web Distributed Authoring and Versioning (WebDAV) Protocol: Server Extensions. The server extensions in this specification extend WebDAV by introducing new HTTP request and response headers that both enable the file types that are not currently manageable and optimize protocol interactions for file system clients. This specification also introduces a new WebDAV method that is used to send search queries to disparate search providers.
- [MS-WEBDAVE]: Web Distributed Authoring and Versioning Error Extensions Protocol Specification. This SharePoint Front-End Protocol describes extended error codes and extended error handling mechanism specified in [MS-WDV] to enable compliant servers to report error condition details on a server response.
Alternatives to WebDAV
- File Transfer Protocol (FTP), a simple network protocol based on IP, allows users to transfer files between network hosts. FTPS extends FTP for secure traffic.
- SSH File Transfer Protocol (SFTP), an extension of the Secure Shell protocol (SSH) version 2.0, provides secure file-transfer capability
- A distributed file system such as the Server Message Block (SMB) protocol allows Microsoft Windows and open-source Samba clients to access and manage files and folders remotely on a suitable file server
- AtomPub, an HTTP-based protocol for creating and updating web resources, can be used for some of the use cases of WebDAV. It is based on standard HTTP verbs with standardized collection resources that behave somewhat like the WebDAV model of directories.
- CMIS, a standard consisting of a set of Web services for sharing information among disparate content repositories, seeks to ensure interoperability for people and applications using multiple content repositories; it has both SOAP- and AtomPub-based interfaces
- Wiki software, such as MediaWiki.
- Linked Data Platform (LDP), a Linked Data specification defining a set of integration patterns for building RESTful HTTP services that are capable of read-write of RDF data.
- "Proposed agenda for San Mateo Meeting". 1996.
- "Brief mtg. summary". 1996.
- "Re: Updated agenda".
- "Module ngx_http_dav_module". nginx website. Retrieved 15 July 2016.
- "Module nginx-dav-ext-module". github.com. Retrieved 2 August 2016.
- "Nextcloud 11 User Manual". nextcloud.com. Retrieved 19 September 2017.
- WebDav SEARCH
- Discontinued Features: Exchange 2010 SP1 Help Microsoft TechNet
- "WSPP – Windows Server Protocols documentation". 2011.
- "MS-WDVME – Web Distributed Authoring and Versioning (WebDAV) Protocol: Microsoft Extensions". 2014.
- "MS-WDV – Web Distributed Authoring and Versioning (WebDAV) Protocol: Client Extensions". 2011.
- "MS-WDVSE – Web Distributed Authoring and Versioning (WebDAV) Protocol: Server Extensions". 2011.
- "MS-WEBDAVE – Web Distributed Authoring and Versioning Error Extensions Protocol Specification". 2011.