draft-ietf-webdav-protocol-08.txt   draft-ietf-webdav-protocol-09.txt 
WEBDAV Working Group Y.Y. Goland, Microsoft WEBDAV Working Group Y.Y. Goland, Microsoft
INTERNET DRAFT E.J. Whitehead, Jr., UC Irvine INTERNET DRAFT E.J. Whitehead, Jr., UC Irvine
<draft-ietf-webdav-protocol-08> A. Faizi, Netscape <draft-ietf-webdav-protocol-09> A. Faizi, Netscape
S.R. Carter, Novell S.R. Carter, Novell
D. Jensen, Novell D. Jensen, Novell
Expires September, 1998 April 7, 1998 Expires September, 1998 October 22, 1998
Extensions for Distributed Authoring on the World Wide Web -- WEBDAV HTTP Extensions for Distributed Authoring -- WEBDAV
Status of this Memo Status of this Memo
This document is an Internet-Draft. Internet-Drafts are working This document is an Internet-Draft. Internet-Drafts are working
documents of the Internet Engineering Task Force (IETF), its areas, documents of the Internet Engineering Task Force (IETF), its areas,
and its working groups. Note that other groups may also distribute and its working groups. Note that other groups may also distribute
working documents as Internet-Drafts. working documents as Internet-Drafts.
Internet-Drafts are draft documents valid for a maximum of six Internet-Drafts are draft documents valid for a maximum of six
months and may be updated, replaced, or made obsolete by other months and may be updated, replaced, or made obsolete by other
documents at any time. It is inappropriate to use Internet-Drafts as documents at any time. It is inappropriate to use Internet-Drafts as
reference material or to cite them other than as "work in progress". reference material or to cite them other than as "work in progress".
To view the entire list of current Internet-Drafts, please check To learn the current status of any Internet-Draft, please check the
the "1id-abstracts.txt" listing contained in the Internet-Drafts "1id-abstracts.txt" listing contained in the Internet-Drafts Shadow
Shadow Directories on ftp.is.co.za (Africa), ftp.nordu.net Directories on ftp.is.co.za (Africa), nic.nordu.net (Europe),
(Northern Europe), ftp.nis.garr.it (Southern Europe), munnari.oz.au munnari.oz.au (Pacific Rim), ftp.ietf.org (US East Coast), or
(Pacific Rim), ftp.ietf.org (US East Coast), or ftp.isi.edu ftp.isi.edu (US West Coast).
(US West Coast).
Distribution of this document is unlimited. Please send comments to Distribution of this document is unlimited. Please send comments to
the Distributed Authoring and Versioning (WEBDAV) working group at the Distributed Authoring and Versioning (WEBDAV) working group at
<w3c-dist-auth@w3.org>, which may be joined by sending a message <w3c-dist-auth@w3.org>, which may be joined by sending a message
with subject "subscribe" to <w3c-dist-auth-request@w3.org>. with subject "subscribe" to <w3c-dist-auth-request@w3.org>.
Discussions of the WEBDAV working group are archived at Discussions of the WEBDAV working group are archived at
<URL:http://www.w3.org/pub/WWW/Archives/Public/w3c-dist-auth>. <URL:http://www.w3.org/pub/WWW/Archives/Public/w3c-dist-auth>.
Abstract Abstract
This document specifies a set of methods, headers, and content-types This document specifies a set of methods, headers, and content-types
ancillary to HTTP/1.1 for the management of resource properties, ancillary to HTTP/1.1 for the management of resource properties,
creation and management of resource collections, namespace creation and management of resource collections, namespace
manipulation, and resource locking (collision avoidance). manipulation, and resource locking (collision avoidance).
Contents Contents
STATUS OF THIS MEMO ..................................................1 STATUS OF THIS MEMO...................................................1
ABSTRACT .............................................................1 ABSTRACT..............................................................1
CONTENTS .............................................................2 CONTENTS..............................................................2
1 INTRODUCTION .......................................................7 1 INTRODUCTION .......................................................7
2 NOTATIONAL CONVENTIONS .............................................8 2 NOTATIONAL CONVENTIONS .............................................8
3 DATA MODEL FOR RESOURCE PROPERTIES .................................8 3 TERMINOLOGY ........................................................8
3.1 The Resource Property Model .....................................8
3.2 Existing Metadata Proposals .....................................9
3.3 Properties and HTTP Headers ....................................10
3.4 Property Values ................................................10
3.5 Property Names .................................................10
3.6 Media Independent Links ........................................11
4 COLLECTIONS OF WEB RESOURCES ......................................11 4 DATA MODEL FOR RESOURCE PROPERTIES .................................9
4.1 Collection Resources ...........................................11 4.1 The Resource Property Model .....................................9
4.2 Creation and Retrieval of Collection Resources .................12 4.2 Existing Metadata Proposals ....................................10
4.3 HTTP URL Namespace Model .......................................12 4.3 Properties and HTTP Headers ....................................10
4.4 Source Resources and Output Resources ..........................12 4.4 Property Values ................................................10
4.5 Property Names .................................................11
4.6 Media Independent Links ........................................11
5 LOCKING ...........................................................13 5 COLLECTIONS OF WEB RESOURCES ......................................11
5.1 Exclusive Vs. Shared Locks .....................................14 5.1 HTTP URL Namespace Model .......................................12
5.2 Required Support ...............................................15 5.2 Collection Resources ...........................................12
5.3 Lock Tokens ....................................................15 5.3 Creation and Retrieval of Collection Resources .................13
5.4 opaquelocktoken Lock Token URI Scheme ..........................15 5.4 Source Resources and Output Resources ..........................14
5.5 Lock Capability Discovery ......................................16
5.6 Active Lock Discovery ..........................................16
5.7 Usage Considerations ...........................................16
6 WRITE LOCK ........................................................17 6 LOCKING ...........................................................15
6.1 Methods Restricted by Write Locks ..............................17 6.1 Exclusive Vs. Shared Locks .....................................15
6.2 Write Locks and Properties .....................................18 6.2 Required Support ...............................................16
6.3 Write Locks and Null Resources .................................18 6.3 Lock Tokens ....................................................16
6.4 Write Locks and Collections ....................................18 6.4 opaquelocktoken Lock Token URI Scheme ..........................17
6.5 Write Locks and the If Request Header ..........................19 6.4.1 Node Field Generation Without the IEEE 802 Address ..........17
6.5.1 Example - Write Lock .........................................19 6.5 Lock Capability Discovery ......................................19
6.6 Write Locks and COPY/MOVE ......................................20 6.6 Active Lock Discovery ..........................................19
6.7 Refreshing Write Locks .........................................20 6.7 Usage Considerations ...........................................19
7 HTTP METHODS FOR DISTRIBUTED AUTHORING ............................20 7 WRITE LOCK ........................................................20
7.1 PROPFIND .......................................................21 7.1 Methods Restricted by Write Locks ..............................20
7.1.1 Example - Retrieving Named Properties ........................22 7.2 Write Locks and Lock Tokens ....................................20
7.1.2 Example - Using allprop to Retrieve All Properties ...........23 7.3 Write Locks and Properties .....................................20
7.1.3 Example - Using propname to Retrieve all Property Names ......25 7.4 Write Locks and Null Resources .................................21
7.2 PROPPATCH ......................................................27 7.5 Write Locks and Collections ....................................21
7.2.1 Status Codes for use with Multi-Status .......................27 7.6 Write Locks and the If Request Header ..........................22
7.2.2 Example - PROPPATCH ..........................................28 7.6.1 Example - Write Lock ........................................22
7.3 MKCOL Method ...................................................29 7.7 Write Locks and COPY/MOVE ......................................22
7.3.1 Request ......................................................29 7.8 Refreshing Write Locks .........................................23
7.3.2 Response Codes ...............................................30
7.3.3 Example - MKCOL ..............................................30
7.4 GET, HEAD for Collections ......................................31
7.5 POST for Collections ...........................................31 8 HTTP METHODS FOR DISTRIBUTED AUTHORING ............................23
7.6 DELETE .........................................................31 8.1 PROPFIND .......................................................24
7.6.1 DELETE for Non-Collection Resources ..........................31 8.1.1 Example - Retrieving Named Properties .......................25
7.6.2 DELETE for Collections .......................................31 8.1.2 Example - Using allprop to Retrieve All Properties ..........26
8.1.3 Example - Using propname to Retrieve all Property Names .....29
7.7 PUT ............................................................32 8.2 PROPPATCH ......................................................30
7.7.1 PUT for Non-Collection Resources .............................32 8.2.1 Status Codes for use with 207 (Multi-Status) ................31
7.7.2 PUT for Collections ..........................................33 8.2.2 Example - PROPPATCH .........................................31
7.8 COPY Method ....................................................33 8.3 MKCOL Method ...................................................32
7.8.1 COPY for HTTP/1.1 resources ..................................33 8.3.1 Request .....................................................32
7.8.2 COPY for Properties ..........................................34 8.3.2 Status Codes ................................................33
7.8.3 COPY for Collections .........................................34 8.3.3 Example - MKCOL .............................................33
7.8.4 COPY and the Overwrite Header ................................35
7.8.5 Status Codes .................................................35
7.8.6 Example - COPY with Overwrite ................................36
7.8.7 Example - COPY with No Overwrite .............................36
7.8.8 Example - COPY of a Collection ...............................36
7.9 MOVE Method ....................................................37 8.4 GET, HEAD for Collections ......................................34
7.9.1 MOVE for Properties ..........................................37
7.9.2 MOVE for Collections .........................................38
7.9.3 MOVE and the Overwrite Header ................................38
7.9.4 Status Codes .................................................39
7.9.5 Example - MOVE of a Non-Collection ...........................39
7.9.6 Example - MOVE of a Collection ...............................39
7.10 LOCK Method ...................................................40 8.5 POST for Collections ...........................................34
7.10.1 Operation ...................................................40
7.10.2 The Effect of Locks on Properties and Collections ...........41
7.10.3 Locking Replicated Resources ................................41
7.10.4 Depth and Locking ...........................................41
7.10.5 Interaction with other Methods ..............................42
7.10.6 Lock Compatibility Table ....................................42
7.10.7 Status Codes ................................................42
7.10.8 Example - Simple Lock Request ...............................43
7.10.9 Example - Refreshing a Write Lock ...........................44
7.10.10 Example - Multi-Resource Lock Request ......................45
7.11 UNLOCK Method .................................................46 8.6 DELETE .........................................................34
7.11.1 Example - UNLOCK ............................................46 8.6.1 DELETE for Non-Collection Resources .........................34
8.6.2 DELETE for Collections ......................................34
8 HTTP HEADERS FOR DISTRIBUTED AUTHORING ............................47 8.7 PUT ............................................................35
8.1 DAV Header .....................................................47 8.7.1 PUT for Non-Collection Resources ............................35
8.2 Depth Header ...................................................47 8.7.2 PUT for Collections .........................................36
8.3 Destination Header .............................................48
8.4 If Header ......................................................48
8.4.1 No-tag-list Production .......................................49
8.4.2 Tagged-list Production .......................................49
8.4.3 not Production ...............................................50
8.4.4 Matching Function ............................................50
8.4.5 If Header and Non-DAV Compliant Proxies ......................51
8.5 Lock-Token Request Header ......................................51
8.6 Overwrite Header ...............................................51
8.7 Status-URI Response Header .....................................51
8.8 Timeout Request Header .........................................52
9 STATUS CODE EXTENSIONS TO HTTP/1.1 ................................53 8.8 COPY Method ....................................................36
9.1 102 Processing .................................................53 8.8.1 COPY for HTTP/1.1 resources .................................36
9.2 207 Multi-Status ...............................................53 8.8.2 COPY for Properties .........................................36
9.3 422 Unprocessable Entity .......................................53 8.8.3 COPY for Collections ........................................37
9.4 423 Locked .....................................................53 8.8.4 COPY and the Overwrite Header ...............................38
9.5 424 Method Failure .............................................53 8.8.5 Status Codes ................................................38
9.6 425 Insufficient Space on Resource .............................53 8.8.6 Example - COPY with Overwrite ...............................39
8.8.7 Example - COPY with No Overwrite ............................39
8.8.8 Example - COPY of a Collection ..............................39
10 MULTI-STATUS RESPONSE ............................................54 8.9 MOVE Method ....................................................40
8.9.1 MOVE for Properties .........................................40
8.9.2 MOVE for Collections ........................................41
8.9.3 MOVE and the Overwrite Header ...............................42
8.9.4 Status Codes ................................................42
8.9.5 Example - MOVE of a Non-Collection ..........................42
8.9.6 Example - MOVE of a Collection ..............................43
11 XML ELEMENT DEFINITIONS ..........................................54 8.10 LOCK Method ....................................................43
11.1 activelock XML Element ........................................54 8.10.1 Operation ...................................................44
11.1.1 depth XML Element ...........................................54 8.10.2 The Effect of Locks on Properties and Collections ...........44
11.1.2 locktoken XML Element .......................................54 8.10.3 Locking Replicated Resources ................................44
11.1.3 timeout XML Element .........................................54 8.10.4 Depth and Locking ...........................................44
11.2 collection XML Element ........................................55 8.10.5 Interaction with other Methods ..............................45
11.3 href XML Element ..............................................55 8.10.6 Lock Compatibility Table ....................................45
11.4 link XML Element ..............................................55 8.10.7 Status Codes ................................................46
11.4.1 dst XML Element .............................................55 8.10.8 Example - Simple Lock Request ...............................46
11.4.2 src XML Element .............................................55 8.10.9 Example - Refreshing a Write Lock ...........................48
11.5 lockentry XML Element .........................................56 8.10.10 Example - Multi-Resource Lock Request ......................49
11.6 lockinfo XML Element ..........................................56
11.7 lockscope XML Element .........................................56
11.7.1 exclusive XML Element .......................................56
11.7.2 shared XML Element ..........................................56
11.8 locktype XML Element ..........................................56
11.8.1 write XML Element ...........................................57
11.9 multistatus XML Element .......................................57
11.9.1 response XML Element ........................................57
11.9.2 responsedescription XML Element .............................58
11.10 owner XML Element ............................................58
11.11 prop XML element .............................................58
11.12 propertybehavior XML element .................................59
11.12.1 keepalive XML element ......................................59
11.12.2 omit XML element ...........................................59
11.13 propertyupdate XML element ...................................60
11.13.1 remove XML element .........................................60
11.13.2 set XML element ............................................60
11.14 propfind XML Element .........................................60
11.14.1 allprop XML Element ........................................61
11.14.2 propname XML Element .......................................61
12 DAV PROPERTIES ...................................................61 8.11 UNLOCK Method ..................................................50
12.1 creationdate Property .........................................61 8.11.1 Example - UNLOCK ............................................50
12.2 displayname Property ..........................................61
12.3 getcontentlanguage Property ...................................62
12.4 getcontentlength Property .....................................62
12.5 getcontenttype Property .......................................62
12.6 getetag Property ..............................................62
12.7 getlastmodified Property ......................................63
12.8 lockdiscovery Property ........................................63
12.8.1 Example - Retrieving the lockdiscovery Property .............63
12.9 resourcetype Property .........................................64
12.10 source Property ..............................................65
12.10.1 Example - A source Property ................................65
12.11 supportedlock Property .......................................66
12.11.1 Example - Retrieving the supportedlock Property ............66
13 DAV XML PROCESSING INSTRUCTIONS ..................................67 9 HTTP HEADERS FOR DISTRIBUTED AUTHORING ............................51
9.1 DAV Header .....................................................51
9.2 Depth Header ...................................................51
9.3 Destination Header .............................................52
9.4 If Header ......................................................52
9.4.1 No-tag-list Production ......................................53
9.4.2 Tagged-list Production ......................................53
9.4.3 not Production ..............................................54
9.4.4 Matching Function ...........................................54
9.4.5 If Header and Non-DAV Compliant Proxies .....................55
9.5 Lock-Token Header ..............................................55
9.6 Overwrite Header ...............................................55
9.7 Status-URI Response Header .....................................55
9.8 Timeout Request Header .........................................56
14 DAV COMPLIANCE CLASSES ...........................................67 10 STATUS CODE EXTENSIONS TO HTTP/1.1 ..............................57
14.1 Class 1 .......................................................68 10.1 102 Processing .................................................57
14.2 Class 2 .......................................................68 10.2 207 Multi-Status ...............................................57
10.3 422 Unprocessable Entity .......................................57
10.4 423 Locked .....................................................58
10.5 424 Failed Dependency ..........................................58
10.6 507 Insufficient Storage .......................................58
15 INTERNATIONALIZATION CONSIDERATIONS ..............................68 11 MULTI-STATUS RESPONSE ...........................................58
16 SECURITY CONSIDERATIONS ..........................................69 12 XML ELEMENT DEFINITIONS .........................................58
16.1 Authentication of Clients .....................................69 12.1 activelock XML Element .........................................58
16.2 Denial of Service .............................................70 12.1.1 depth XML Element ...........................................59
16.3 Security through Obscurity ....................................70 12.1.2 locktoken XML Element .......................................59
16.4 Privacy Issues Connected to Locks .............................71 12.1.3 timeout XML Element .........................................59
16.5 Privacy Issues Connected to Properties ........................71 12.2 collection XML Element .........................................59
16.6 Reduction of Security due to Source Link ......................71
17 IANA CONSIDERATIONS ..............................................71 12.3 href XML Element ...............................................59
18 TERMINOLOGY ......................................................72 12.4 link XML Element ...............................................60
19 COPYRIGHT ........................................................73 12.4.1 dst XML Element .............................................60
20 INTELLECTUAL PROPERTY ............................................73 12.4.2 src XML Element .............................................60
21 ACKNOWLEDGEMENTS .................................................74 12.5 lockentry XML Element ..........................................60
22 REFERENCES .......................................................75 12.6 lockinfo XML Element ...........................................60
22.1 Normative References ..........................................75 12.7 lockscope XML Element ..........................................61
22.2 Informational References ......................................75 12.7.1 exclusive XML Element .......................................61
23 AUTHORS' ADDRESSES ...............................................77 12.7.2 shared XML Element ..........................................61
24 APPENDICES .......................................................78 12.8 locktype XML Element ...........................................61
24.1 Appendix 1 - WebDAV Document Type Definition ..................78 12.8.1 write XML Element ...........................................61
24.2 Appendix 2 - ISO 8601 Date and Time Profile ...................79 12.9 multistatus XML Element ........................................62
24.3 Appendix 3 - Notes on Processing XML Elements .................80 12.9.1 response XML Element ........................................62
24.3.1 Notes on Empty XML Elements .................................80 12.9.2 responsedescription XML Element .............................63
24.3.2 Notes on Illegal XML Processing .............................80 12.10owner XML Element ..............................................63
24.4 Appendix 4 -- XML Namespaces for WebDAV .......................82 12.11prop XML element ...............................................63
24.4.1 Introduction ................................................82 12.12propertybehavior XML element ...................................63
24.4.2 Namespace Declaration PI ....................................83 12.12.1 keepalive XML element ......................................64
24.4.3 Placing Declarations in Documents ...........................84 12.12.2 omit XML element ...........................................64
24.4.4 Prolog with Namespace Declarations ..........................84 12.13propertyupdate XML element .....................................64
24.4.5 Qualified Names .............................................84 12.13.1 remove XML element .........................................65
24.4.6 Universal Names .............................................85 12.13.2 set XML element ............................................65
24.4.7 Using Qualified Names .......................................85 12.14propfind XML Element ...........................................65
24.4.8 Processing instruction ......................................85 12.14.1 allprop XML Element ........................................65
24.4.9 Scope and Meaning of Qualified Names ........................85 12.14.2 propname XML Element .......................................66
13 DAV PROPERTIES ..................................................66
13.1 creationdate Property ..........................................66
13.2 displayname Property ...........................................66
13.3 getcontentlanguage Property ....................................67
13.4 getcontentlength Property ......................................67
13.5 getcontenttype Property ........................................67
13.6 getetag Property ...............................................67
13.7 getlastmodified Property .......................................68
13.8 lockdiscovery Property .........................................68
13.8.1 Example - Retrieving the lockdiscovery Property .............68
13.9 resourcetype Property ..........................................69
13.10source Property ................................................70
13.10.1 Example - A source Property ................................70
13.11supportedlock Property .........................................71
13.11.1 Example - Retrieving the supportedlock Property ............71
14 INSTRUCTIONS FOR PROCESSING XML IN DAV ..........................72
15 DAV COMPLIANCE CLASSES ..........................................73
15.1 Class 1 ........................................................73
15.2 Class 2 ........................................................73
16 INTERNATIONALIZATION CONSIDERATIONS .............................73
17 SECURITY CONSIDERATIONS .........................................75
17.1 Authentication of Clients ......................................75
17.2 Denial of Service ..............................................75
17.3 Security through Obscurity .....................................76
17.4 Privacy Issues Connected to Locks ..............................76
17.5 Privacy Issues Connected to Properties .........................76
17.6 Reduction of Security due to Source Link .......................76
17.7 Implications of XML External Entities ..........................77
17.8 Risks Connected with Lock Tokens ...............................77
18 IANA CONSIDERATIONS .............................................78
19 COPYRIGHT .......................................................78
20 INTELLECTUAL PROPERTY ...........................................79
21 ACKNOWLEDGEMENTS ................................................80
22 REFERENCES ......................................................81
22.1 Normative References ...........................................81
22.2 Informational References .......................................82
23 AUTHORS' ADDRESSES ..............................................83
24 APPENDICES ......................................................84
24.1 Appendix 1 - WebDAV Document Type Definition ...................84
24.2 Appendix 2 - ISO 8601 Date and Time Profile ....................85
24.3 Appendix 3 - Notes on Processing XML Elements ..................86
24.3.1 Notes on Empty XML Elements .................................86
24.3.2 Notes on Illegal XML Processing .............................86
24.4 Appendix 4 -- XML Namespaces for WebDAV ........................88
24.4.1 Introduction ................................................88
24.4.2 Motivation and Summary ......................................88
24.4.3 Declaring Namespaces ........................................89
24.4.4 Qualified Names .............................................90
24.4.5 Using Qualified Names .......................................91
24.4.6 Applying Namespaces to Elements and Attributes ..............92
24.4.7 Uniqueness of Attributes ....................................94
24.4.8 Conformance .................................................95
24.4.9 Meaning of Qualified Names ..................................95
1 Introduction 1 Introduction
This document describes an extension to the HTTP/1.1 protocol that This document describes an extension to the HTTP/1.1 protocol that
allows clients to perform remote web content authoring operations. allows clients to perform remote web content authoring operations.
This extension provides a coherent set of methods, headers, request This extension provides a coherent set of methods, headers, request
entity body formats, and response entity body formats that provide entity body formats, and response entity body formats that provide
operations for: operations for:
Properties: The ability to create, remove, and query information Properties: The ability to create, remove, and query information
skipping to change at page 7, line 31 skipping to change at page 7, line 31
Locking: The ability to keep more than one person from working on a Locking: The ability to keep more than one person from working on a
document at the same time. This prevents the "lost update problem," document at the same time. This prevents the "lost update problem,"
in which modifications are lost as first one author then another in which modifications are lost as first one author then another
writes changes without merging the other author's changes. writes changes without merging the other author's changes.
Namespace Operations: The ability to instruct the server to copy and Namespace Operations: The ability to instruct the server to copy and
move Web resources. move Web resources.
Requirements and rationale for these operations are described in a Requirements and rationale for these operations are described in a
companion document, "Requirements for a Distributed Authoring and companion document, "Requirements for a Distributed Authoring and
Versioning Protocol for the World Wide Web" [Slein et al., 1998]. Versioning Protocol for the World Wide Web" [RFC2291].
The sections below provide a detailed introduction to resource The sections below provide a detailed introduction to resource
properties (section 3), collections of resources (section 4), and properties (section 3), collections of resources (section 5), and
locking operations (section 5). These sections introduce the locking operations (section 6). These sections introduce the
abstractions manipulated by the WebDAV-specific HTTP methods abstractions manipulated by the WebDAV-specific HTTP methods
described in section 7, "HTTP Methods for Distributed Authoring". described in section 8, "HTTP Methods for Distributed Authoring".
In HTTP/1.1, method parameter information was exclusively encoded in In HTTP/1.1, method parameter information was exclusively encoded in
HTTP headers. Unlike HTTP/1.1, WebDAV, encodes method parameter HTTP headers. Unlike HTTP/1.1, WebDAV encodes method parameter
information either in an Extensible Markup Language (XML) [Bray, information either in an Extensible Markup Language (XML) [REC-XML]
Paoli, Sperberg-McQueen, 1998] request entity body, or in an HTTP request entity body, or in an HTTP header. The use of XML to encode
header. The use of XML to encode method parameters was motivated by method parameters was motivated by the ability to add extra XML
the ability to add extra XML elements to existing structures, elements to existing structures, providing extensibility; and by
providing extensibility, and by XML's ability to encode information XML's ability to encode information in ISO 10646 character sets,
in ISO 10646 character sets, providing internationalization support. providing internationalization support. As a rule of thumb,
As a rule of thumb, parameters are encoded in XML entity bodies when parameters are encoded in XML entity bodies when they have unbounded
they have unbounded length, or when they may be shown to a human length, or when they may be shown to a human user and hence require
user and hence require encoding in an ISO 10646 character set. encoding in an ISO 10646 character set. Otherwise, parameters are
Otherwise, parameters are encoded within HTTP headers. Section 8 encoded within HTTP headers. Section 9 describes the new HTTP
describes the new HTTP headers used with WebDAV methods. headers used with WebDAV methods.
In addition to encoding method parameters, XML is used in WebDAV to In addition to encoding method parameters, XML is used in WebDAV to
encode the responses from methods, providing the extensibility and encode the responses from methods, providing the extensibility and
internationalization advantages of XML for method output, as well as internationalization advantages of XML for method output, as well as
input. input.
XML elements used in this specification are defined in section 11. XML elements used in this specification are defined in section 12.
The XML namespace extension (Appendix 4) is also used in this The XML namespace extension (Appendix 4) is also used in this
specification in order to allow for new XML elements to be added specification in order to allow for new XML elements to be added
without fear of colliding with other element names. without fear of colliding with other element names.
While the status codes provided by HTTP/1.1 are sufficient to While the status codes provided by HTTP/1.1 are sufficient to
describe most error conditions encountered by WebDAV methods, there describe most error conditions encountered by WebDAV methods, there
are some errors that do not fall neatly into the existing are some errors that do not fall neatly into the existing
categories. New status codes developed for the WebDAV methods are categories. New status codes developed for the WebDAV methods are
defined in section 9. Since some WebDAV methods may operate over defined in section 10. Since some WebDAV methods may operate over
many resources, the Multi-Status response has been introduced to many resources, the Multi-Status response has been introduced to
return status information for multiple resources. The Multi-Status return status information for multiple resources. The Multi-Status
response is described in section 10. response is described in section 11.
WebDAV employs the property mechanism to store information about the WebDAV employs the property mechanism to store information about the
current state of the resource. For example, when a lock is taken current state of the resource. For example, when a lock is taken
out on a resource, a lock information property describes the current out on a resource, a lock information property describes the current
state of the lock. Section 12 defines the properties used within the state of the lock. Section 13 defines the properties used within the
WebDAV specification. WebDAV specification.
Finishing off the specification are sections on what it means to be Finishing off the specification are sections on what it means to be
compliant with this specification (section 14), on compliant with this specification (section 15), on
internationalization support (section 15), and on security (section internationalization support (section 16), and on security (section
16). 17).
2 Notational Conventions 2 Notational Conventions
Since this document describes a set of extensions to the HTTP/1.1 Since this document describes a set of extensions to the HTTP/1.1
protocol, the augmented BNF used herein to describe protocol protocol, the augmented BNF used herein to describe protocol
elements is exactly the same as described in section 2.1 of elements is exactly the same as described in section 2.1 of
[Fielding et al., 1997]. Since this augmented BNF uses the basic [RFC2068]. Since this augmented BNF uses the basic production rules
production rules provided in section 2.2 of [Fielding et al., 1997], provided in section 2.2 of [RFC2068], these rules apply to this
these rules apply to this document as well. document as well.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in RFC 2119 [Bradner, document are to be interpreted as described in RFC 2119 [RFC2119].
1997].
3 Data Model for Resource Properties 3 Terminology
3.1 The Resource Property Model URI/URL - As defined in [RFC2396].
Collection - A resource that contains member resources and meets the
requirements in section 5 of this specification.
Member Resource - A resource contained by a collection.
Internal Member Resource - A member resource of a collection whose
URI is immediately relative to the URI of the collection.
Property - A name/value pair that contains descriptive information
about a resource.
Live Property - A property whose semantics and syntax are enforced
by the server. For example, the live "getcontentlength" property
has its value, the length of the entity returned by a GET request,
automatically calculated by the server.
Dead Property - A property whose semantics and syntax are not
enforced by the server. The server only records the value of a dead
property; the client is responsible for maintaining the consistency
of the syntax and semantics of a dead property.
Null Resource - A resource which responds with a 404 (Not Found) to
any HTTP/1.1 or DAV method except for PUT, MKCOL, OPTIONS and LOCK.
A NULL resource MUST NOT appear as a member of its parent
collection.
4 Data Model for Resource Properties
4.1 The Resource Property Model
Properties are pieces of data that describe the state of a resource. Properties are pieces of data that describe the state of a resource.
Properties are data about data. Properties are data about data.
Properties are used in distributed authoring environments to provide Properties are used in distributed authoring environments to provide
for efficient discovery and management of resources. For example, a for efficient discovery and management of resources. For example, a
'subject' property might allow for the indexing of all resources by 'subject' property might allow for the indexing of all resources by
their subject, and an 'author' property might allow for the their subject, and an 'author' property might allow for the
discovery of what authors have written which documents. discovery of what authors have written which documents.
The DAV property model consists of name/value pairs. The name of a The DAV property model consists of name/value pairs. The name of a
property identifies the property's syntax and semantics, and property identifies the property's syntax and semantics, and
provides an address by which to refer to its syntax and semantics. provides an address by which to refer to its syntax and semantics.
There are two categories of properties: "live" and "dead". A live There are two categories of properties: "live" and "dead". A live
property has its syntax and semantics enforced by the server. Live property has its syntax and semantics enforced by the server. Live
properties include cases where a) the value of a property is read- properties include cases where a) the value of a property is read-
only, maintained by the server, and b) the value of the property is only, maintained by the server, and b) the value of the property is
maintained by the client, but the server performs syntax checking on maintained by the client, but the server performs syntax checking on
submitted values. A dead property has its syntax and semantics submitted values. All instances of a given live property MUST comply
enforced by the client; the server merely records the value of the with the definition associated with that property name. A dead
property verbatim. property has its syntax and semantics enforced by the client; the
server merely records the value of the property verbatim.
3.2 Existing Metadata Proposals 4.2 Existing Metadata Proposals
Properties have long played an essential role in the maintenance of Properties have long played an essential role in the maintenance of
large document repositories, and many current proposals contain some large document repositories, and many current proposals contain some
notion of a property, or discuss web metadata more generally. These notion of a property, or discuss web metadata more generally. These
include PICS [Miller et al., 1996], PICS-NG, XML, Web Collections, include PICS [REC-PICS], PICS-NG, XML, Web Collections, and several
and several proposals on representing relationships within HTML. proposals on representing relationships within HTML. Work on PICS-NG
Work on PICS-NG and Web Collections has been subsumed by the and Web Collections has been subsumed by the Resource Definition
Resource Definition Framework (RDF) metadata activity of the World Framework (RDF) metadata activity of the World Wide Web Consortium.
Wide Web Consortium. RDF consists of a network-based data model and RDF consists of a network-based data model and an XML representation
an XML representation of that model. of that model.
Some proposals come from a digital library perspective. These Some proposals come from a digital library perspective. These
include the Dublin Core [Weibel et al., 1995] metadata set and the include the Dublin Core [RFC2413] metadata set and the Warwick
Warwick Framework [Lagoze, 1996], a container architecture for Framework [Lagoze, 1996], a container architecture for different
different metadata schemas. The literature includes many examples metadata schemas. The literature includes many examples of
of metadata, including MARC [MARC, 1994], a bibliographic metadata metadata, including MARC [USMARC], a bibliographic metadata format,
format, and RFC 1807 [Lasher, Cohen, 1995], a technical report and a technical report bibliographic format employed by the Dienst
bibliographic format employed by the Dienst system. Additionally, system [RFC1807]. Additionally, the proceedings from the first IEEE
the proceedings from the first IEEE Metadata conference describe Metadata conference describe many community-specific metadata sets.
many community-specific metadata sets.
Participants of the 1996 Metadata II Workshop in Warwick, UK Participants of the 1996 Metadata II Workshop in Warwick, UK
[Lagoze, 1996], noted that "new metadata sets will develop as the [Lagoze, 1996], noted that "new metadata sets will develop as the
networked infrastructure matures" and "different communities will networked infrastructure matures" and "different communities will
propose, design, and be responsible for different types of propose, design, and be responsible for different types of
metadata." These observations can be corroborated by noting that metadata." These observations can be corroborated by noting that
many community-specific sets of metadata already exist, and there is many community-specific sets of metadata already exist, and there is
significant motivation for the development of new forms of metadata significant motivation for the development of new forms of metadata
as many communities increasingly make their data available in as many communities increasingly make their data available in
digital form, requiring a metadata format to assist data location digital form, requiring a metadata format to assist data location
and cataloging. and cataloging.
3.3 Properties and HTTP Headers 4.3 Properties and HTTP Headers
Properties already exist, in a limited sense, in HTTP message Properties already exist, in a limited sense, in HTTP message
headers. However, in distributed authoring environments a headers. However, in distributed authoring environments a
relatively large number of properties are needed to describe the relatively large number of properties are needed to describe the
state of a resource, and setting/returning them all through HTTP state of a resource, and setting/returning them all through HTTP
headers is inefficient. Thus a mechanism is needed which allows a headers is inefficient. Thus a mechanism is needed which allows a
principal to identify a set of properties in which the principal is principal to identify a set of properties in which the principal is
interested and to set or retrieve just those properties. interested and to set or retrieve just those properties.
3.4 Property Values 4.4 Property Values
The value of a property is, at minimum, well formed XML.
The value of a property when expressed in XML MUST be well formed.
XML has been chosen because it is a flexible, self-describing, XML has been chosen because it is a flexible, self-describing,
structured data format that supports rich schema definitions, and structured data format that supports rich schema definitions, and
because of its support for multiple character sets. XML's self- because of its support for multiple character sets. XML's self-
describing nature allows any property's value to be extended by describing nature allows any property's value to be extended by
adding new elements. Older clients will not break when they adding new elements. Older clients will not break when they
encounter extensions because they will still have the data specified encounter extensions because they will still have the data specified
in the original schema and will ignore elements they do not in the original schema and will ignore elements they do not
understand. XML's support for multiple character sets allows any understand. XML's support for multiple character sets allows any
human-readable property to be encoded and read in a character set human-readable property to be encoded and read in a character set
familiar to the user. familiar to the user. XML's support for multiple human languages,
using the "xml:lang" attribute, handles cases where the same
character set is employed by multiple human languages.
3.5 Property Names 4.5 Property Names
A property name is a universally unique identifier that is A property name is a universally unique identifier that is
associated with a schema that provides information about the syntax associated with a schema that provides information about the syntax
and semantics of the property. and semantics of the property.
Because a property's name is universally unique, clients can depend Because a property's name is universally unique, clients can depend
upon consistent behavior for a particular property across multiple upon consistent behavior for a particular property across multiple
resources, so long as that property is "live" on the resources in resources, on the same and across different servers, so long as that
question. property is "live" on the resources in question, and the
implementation of the live property is faithful to its definition.
The XML namespace mechanism, which is based on URIs, is used to name The XML namespace mechanism, which is based on URIs [RFC2396], is
properties because it prevents namespace collisions and provides for used to name properties because it prevents namespace collisions and
varying degrees of administrative control. provides for varying degrees of administrative control.
The property namespace is flat; that is, no hierarchy of properties The property namespace is flat; that is, no hierarchy of properties
is explicitly recognized. Thus, if a property A and a property A/B is explicitly recognized. Thus, if a property A and a property A/B
exist on a resource, there is no recognition of any relationship exist on a resource, there is no recognition of any relationship
between the two properties. It is expected that a separate between the two properties. It is expected that a separate
specification will eventually be produced which will address issues specification will eventually be produced which will address issues
relating to hierarchical properties. relating to hierarchical properties.
Finally, it is not possible to define the same property twice on a Finally, it is not possible to define the same property twice on a
single resource, as this would cause a collision in the resource's single resource, as this would cause a collision in the resource's
property namespace. property namespace.
3.6 Media Independent Links 4.6 Media Independent Links
Although HTML resources support links to other resources, the Web Although HTML resources support links to other resources, the Web
needs more general support for links between resources of any media needs more general support for links between resources of any media
type. WebDAV provides such links. A WebDAV link is a special type type. WebDAV provides such links. A WebDAV link is a special type
of property value, formally defined in section 11.4, that allows of property value, formally defined in section 12.4, that allows
typed connections to be established between resources of any media typed connections to be established between resources of any media
type. The property value consists of source and destination Uniform type. The property value consists of source and destination Uniform
Resource Locators (URLs); the property name identifies the link Resource Locators (URLs); the property name identifies the link
type. type.
4 Collections of Web Resources 5 Collections of Web Resources
This section provides a description of a new type of Web resource, This section provides a description of a new type of Web resource,
the collection, and discusses its interactions with the HTTP URL the collection, and discusses its interactions with the HTTP URL
namespace. The purpose of a collection resource is to model namespace. The purpose of a collection resource is to model
collection-like objects (e.g., file system directories) within a collection-like objects (e.g., file system directories) within a
server's namespace. server's namespace.
All DAV compliant resources MUST support the HTTP URL namespace All DAV compliant resources MUST support the HTTP URL namespace
model specified herein. model specified herein.
4.1 Collection Resources 5.1 HTTP URL Namespace Model
The HTTP URL namespace is a hierarchical namespace where the
hierarchy is delimited with the "/" character.
An HTTP URL namespace is said to be consistent if it meets the
following rule: for every non-null resource A, there exists a non-
null resource B that is a collection and has resource A as an
internal member. The root of the namespace is exempt from the
previous rule.
Neither HTTP/1.1 nor WebDAV require that the entire HTTP URL
namespace be consistent. However, certain WebDAV methods are
prohibited from producing results that cause namespace
inconsistencies.
5.2 Collection Resources
A collection is a resource whose state consists of at least a list A collection is a resource whose state consists of at least a list
of internal members and a set of properties, but which may have of internal members and a set of properties, but which may have
additional state such as entity bodies returned by GET. An internal additional state such as entity bodies returned by GET. An internal
member resource MUST have a URI that is immediately relative to the member resource MUST have a URI that is immediately relative to the
base URI of the collection. That is, the internal member's URI is base URI of the collection. That is, the internal member's URI is
equal to the parent collection's URI plus an additional segment equal to the parent collection's URI plus an additional segment
where segment is defined in section 3.2.1 of RFC 2068 [Fielding et where segment is defined in section 3.2.1 of RFC 2068 [Fielding et
al., 1996]. al., 1996].
Any given internal member MUST only belong to the collection once, Any given internal member MUST only belong to the collection once,
i.e., it is illegal to have multiple instances of the same URI in a i.e., it is illegal to have multiple instances of the same URI in a
collection. Properties defined on collections behave exactly as do collection. Properties defined on collections behave exactly as do
properties on non-collection resources. properties on non-collection resources.
WebDAV servers MUST treat HTTP URL namespaces as collections, For all WebDAV compliant resources A and B for which B is the parent
regardless of whether they were created with the MKCOL method of A in the HTTP URL namespace hierarchy, B MUST be a collection
described in section 7.3. which has A as an internal member. So, if http://foo.com/bar/blah is
WebDAV compliant and if http://foo.com/bar/ is WebDAV compliant then
http://foo.com/bar/ must be a collection and must contain
http://foo.com/bar/blah as an internal member.
Collection resources MAY list their non-WebDAV compliant children in
the HTTP URL namespace hierarchy as internal members but are not
required to do so. For example, if http://foo.com/bar/blah is not
WebDAV compliant and http://foo.com/bar/ is a collection then
http://foo.com/bar/blah may or may not be listed as an internal
member of http://foo.com/bar/.
If a WebDAV compliant resource has no WebDAV compliant children in
the HTTP URL namespace hierarchy then the WebDAV compliant resource
is not required to be a collection.
There is a standing convention that when a collection is referred to There is a standing convention that when a collection is referred to
by its name without a trailing slash, the trailing slash is by its name without a trailing slash, the trailing slash is
automatically appended. Due to this, a resource may accept a URI automatically appended. Due to this, a resource may accept a URI
without a trailing "/" to point to a collection. In this case it without a trailing "/" to point to a collection. In this case it
SHOULD return a content-location header in the response pointing to SHOULD return a content-location header in the response pointing to
the URL ending with the "/". For example, if a client invokes a the URL ending with the "/". For example, if a client invokes a
method on http://foo.bar/blah (no trailing slash), the resource method on http://foo.bar/blah (no trailing slash), the resource
http://foo.bar/blah/ (trailing slash) may respond as if the http://foo.bar/blah/ (trailing slash) may respond as if the
operation were invoked on it, and should return a content-location operation were invoked on it, and should return a content-location
header with http://foo.bar/blah/ in it. In general clients SHOULD header with http://foo.bar/blah/ in it. In general clients SHOULD
use the "/" form of collection names. use the "/" form of collection names.
4.2 Creation and Retrieval of Collection Resources A resource MAY be a collection but not be WebDAV compliant. That
is, the resource may comply with all the rules set out in this
specification regarding how a collection is to behave without
necessarily supporting all methods that a WebDAV compliant resource
is required to support. In such a case the resource may return the
dav:resourcetype property with the value dav:collection but MUST NOT
return a DAV header containing the value "1" on an OPTIONS response.
5.3 Creation and Retrieval of Collection Resources
This document specifies the MKCOL method to create new collection This document specifies the MKCOL method to create new collection
resources, rather than using the existing HTTP/1.1 PUT or POST resources, rather than using the existing HTTP/1.1 PUT or POST
method, for the following reasons: method, for the following reasons:
In HTTP/1.1, the PUT method is defined to store the request body at In HTTP/1.1, the PUT method is defined to store the request body at
the location specified by the Request-URI. While a description the location specified by the Request-URI. While a description
format for a collection can readily be constructed for use with PUT, format for a collection can readily be constructed for use with PUT,
the implications of sending such a description to the server are the implications of sending such a description to the server are
undesirable. For example, if a description of a collection that undesirable. For example, if a description of a collection that
skipping to change at page 12, line 32 skipping to change at page 14, line 5
DELETE functionality with an access control scheme based on methods. DELETE functionality with an access control scheme based on methods.
While the POST method is sufficiently open-ended that a "create a While the POST method is sufficiently open-ended that a "create a
collection" POST command could be constructed, this is undesirable collection" POST command could be constructed, this is undesirable
because it would be difficult to separate access control for because it would be difficult to separate access control for
collection creation from other uses of POST. collection creation from other uses of POST.
The exact definition of the behavior of GET and PUT on collections The exact definition of the behavior of GET and PUT on collections
is defined later in this document. is defined later in this document.
4.3 HTTP URL Namespace Model 5.4 Source Resources and Output Resources
The HTTP URL Namespace is a hierarchical namespace where the
hierarchy is delimited with the "/" character. DAV compliant
resources MUST maintain the consistency of the HTTP URL namespace.
For example, if the collection http://www.foo.bar.org/a/ exists, but
http://www.foo.bar.org/a/b/ does not exist, an attempt to create
http://www.foo.bar.org/a/b/c must fail.
4.4 Source Resources and Output Resources
For many resources, the entity returned by a GET method exactly For many resources, the entity returned by a GET method exactly
matches the persistent state of the resource, for example, a GIF matches the persistent state of the resource, for example, a GIF
file stored on a disk. For this simple case, the URL at which a file stored on a disk. For this simple case, the URL at which a
resource is accessed is identical to the URL at which the source resource is accessed is identical to the URL at which the source
(the persistent state) of the resource is accessed. This is also (the persistent state) of the resource is accessed. This is also
the case for HTML source files that are not processed by the server the case for HTML source files that are not processed by the server
prior to transmission. prior to transmission.
However, the server can sometimes process HTML resources before they However, the server can sometimes process HTML resources before they
skipping to change at page 13, line 31 skipping to change at page 14, line 47
source resource(s) is desired, the source resource(s) should be source resource(s) is desired, the source resource(s) should be
given a location in the URI namespace. This source location should given a location in the URI namespace. This source location should
not be one of the locations at which the generated output is not be one of the locations at which the generated output is
retrievable, since in general it is impossible for the server to retrievable, since in general it is impossible for the server to
differentiate requests for source resources from requests for differentiate requests for source resources from requests for
process output resources. There is often a many-to-many process output resources. There is often a many-to-many
relationship between source resources and output resources. relationship between source resources and output resources.
On WebDAV compliant servers the URI of the source resource(s) may be On WebDAV compliant servers the URI of the source resource(s) may be
stored in a link on the output resource with type DAV:source (see stored in a link on the output resource with type DAV:source (see
section 12.10 for a description of the source link property). section 13.10 for a description of the source link property).
Storing the source URIs in links on the output resources places the Storing the source URIs in links on the output resources places the
burden of discovering the source on the authoring client. Note that burden of discovering the source on the authoring client. Note that
the value of a source link is not guaranteed to point to the correct the value of a source link is not guaranteed to point to the correct
source. Source links may break or incorrect values may be entered. source. Source links may break or incorrect values may be entered.
Also note that not all servers will allow the client to set the Also note that not all servers will allow the client to set the
source link value. For example a server which generates source source link value. For example a server which generates source
links on the fly for its CGI files will most likely not allow a links on the fly for its CGI files will most likely not allow a
client to set the source link value. client to set the source link value.
5 Locking 6 Locking
The ability to lock a resource provides a mechanism for serializing The ability to lock a resource provides a mechanism for serializing
access to that resource. Using a lock, an authoring client can access to that resource. Using a lock, an authoring client can
provide a reasonable guarantee that another principal will not provide a reasonable guarantee that another principal will not
modify a resource while it is being edited. In this way, a client modify a resource while it is being edited. In this way, a client
can prevent the "lost update" problem. can prevent the "lost update" problem.
This specification allows locks to vary over two client-specified This specification allows locks to vary over two client-specified
parameters, the number of principals involved (exclusive vs. shared) parameters, the number of principals involved (exclusive vs. shared)
and the type of access to be granted. This document defines locking and the type of access to be granted. This document defines locking
for only one access type, write. However, the syntax is extensible, for only one access type, write. However, the syntax is extensible,
and permits the eventual specification of locking for other access and permits the eventual specification of locking for other access
types. types.
5.1 Exclusive Vs. Shared Locks 6.1 Exclusive Vs. Shared Locks
The most basic form of lock is an exclusive lock. This is a lock The most basic form of lock is an exclusive lock. This is a lock
where the access right in question is only granted to a single where the access right in question is only granted to a single
principal. The need for this arbitration results from a desire to principal. The need for this arbitration results from a desire to
avoid having to merge results. avoid having to merge results.
However, there are times when the goal of a lock is not to exclude However, there are times when the goal of a lock is not to exclude
others from exercising an access right but rather to provide a others from exercising an access right but rather to provide a
mechanism for principals to indicate that they intend to exercise mechanism for principals to indicate that they intend to exercise
their access rights. Shared locks are provided for this case. A their access rights. Shared locks are provided for this case. A
skipping to change at page 15, line 5 skipping to change at page 16, line 20
rigid. An exclusive lock is used to enforce a particular editing rigid. An exclusive lock is used to enforce a particular editing
process: take out an exclusive lock, read the resource, perform process: take out an exclusive lock, read the resource, perform
edits, write the resource, release the lock. This editing process edits, write the resource, release the lock. This editing process
has the problem that locks are not always properly released, for has the problem that locks are not always properly released, for
example when a program crashes, or when a lock owner leaves without example when a program crashes, or when a lock owner leaves without
unlocking a resource. While both timeouts and administrative action unlocking a resource. While both timeouts and administrative action
can be used to remove an offending lock, neither mechanism may be can be used to remove an offending lock, neither mechanism may be
available when needed; the timeout may be long or the administrator available when needed; the timeout may be long or the administrator
may not be available. may not be available.
5.2 Required Support 6.2 Required Support
A WebDAV compliant server is not required to support locking in any A WebDAV compliant server is not required to support locking in any
form. If the server does support locking it may choose to support form. If the server does support locking it may choose to support
any combination of exclusive and shared locks for any access types. any combination of exclusive and shared locks for any access types.
The reason for this flexibility is that locking policy strikes to The reason for this flexibility is that locking policy strikes to
the very heart of the resource management and versioning systems the very heart of the resource management and versioning systems
employed by various storage repositories. These repositories employed by various storage repositories. These repositories
require control over what sort of locking will be made available. require control over what sort of locking will be made available.
For example, some repositories only support shared write locks while For example, some repositories only support shared write locks while
others only provide support for exclusive write locks while yet others only provide support for exclusive write locks while yet
others use no locking at all. As each system is sufficiently others use no locking at all. As each system is sufficiently
different to merit exclusion of certain locking features, this different to merit exclusion of certain locking features, this
specification leaves locking as the sole axis of negotiation within specification leaves locking as the sole axis of negotiation within
WebDAV. WebDAV.
5.3 Lock Tokens 6.3 Lock Tokens
A lock token is a type of state token, represented as a URI, which A lock token is a type of state token, represented as a URI, which
identifies a particular lock. A lock token is returned by every identifies a particular lock. A lock token is returned by every
successful LOCK operation in the lockdiscovery property in the successful LOCK operation in the lockdiscovery property in the
response body, and can also be found through lock discovery on a response body, and can also be found through lock discovery on a
resource. resource.
Lock token URIs MUST be unique across all resources for all time. Lock token URIs MUST be unique across all resources for all time.
This uniqueness constraint allows lock tokens to be submitted across This uniqueness constraint allows lock tokens to be submitted across
resources and servers without fear of confusion. resources and servers without fear of confusion.
skipping to change at page 15, line 41 skipping to change at page 17, line 4
This uniqueness constraint allows lock tokens to be submitted across This uniqueness constraint allows lock tokens to be submitted across
resources and servers without fear of confusion. resources and servers without fear of confusion.
This specification provides a lock token URI scheme called This specification provides a lock token URI scheme called
opaquelocktoken that meets the uniqueness requirements. However opaquelocktoken that meets the uniqueness requirements. However
resources are free to return any URI scheme so long as it meets the resources are free to return any URI scheme so long as it meets the
uniqueness requirements. uniqueness requirements.
Having a lock token provides no special access rights. Anyone can Having a lock token provides no special access rights. Anyone can
find out anyone else's lock token by performing lock discovery. find out anyone else's lock token by performing lock discovery.
Locks MUST be enforced based upon whatever authentication mechanism Locks MUST be enforced based upon whatever authentication mechanism
is used by the server, not based on the secrecy of the token values. is used by the server, not based on the secrecy of the token values.
5.4 opaquelocktoken Lock Token URI Scheme 6.4 opaquelocktoken Lock Token URI Scheme
The opaquelocktoken URI scheme is designed to be unique across all The opaquelocktoken URI scheme is designed to be unique across all
resources for all time. Due to this uniqueness quality, a client resources for all time. Due to this uniqueness quality, a client
may submit an opaque lock token in an If header on a resource other may submit an opaque lock token in an If header on a resource other
than the one that returned it. than the one that returned it.
All resources MUST recognize the opaquelocktoken scheme and, at All resources MUST recognize the opaquelocktoken scheme and, at
minimum, recognize that the lock token does not refer to an minimum, recognize that the lock token does not refer to an
outstanding lock on the resource. outstanding lock on the resource.
In order to guarantee uniqueness across all resources for all time In order to guarantee uniqueness across all resources for all time
the opaquelocktoken requires the use of the Universally Unique the opaquelocktoken requires the use of the globally unique
Identifier (UUID, also known as a Globally Unique Identifier, or identifier (GUID) mechanism, as described in [ISO-11578].
GUID) mechanism, as described in [Leach, Salz, 1998].
Opaquelocktoken generators, however, have a choice of how they Opaquelocktoken generators, however, have a choice of how they
create these tokens. They can either generate a new UUID for every create these tokens. They can either generate a new GUID for every
lock token they create or they can create a single UUID and then add lock token they create or they can create a single GUID and then
extension characters. If the second method is selected then the add extension characters. If the second method is selected then the
program generating the extensions MUST guarantee that the same program generating the extensions MUST guarantee that the same
extension will never be used twice with the associated UUID. extension will never be used twice with the associated GUID.
OpaqueLockToken-URI = "opaquelocktoken:" UUID [Extension] ; The OpaqueLockToken-URI = "opaquelocktoken:" GUID [Extension] ; The
UUID production is the string form of a UUID, as defined in [Leach, GUID production is the string representation of a GUID, as defined
Salz, 1998]. Note that white space (LWS) is not allowed between in [ISO-11578]. Note that white space (LWS) is not allowed between
elements of this production. elements of this production.
Extension = path ; path is defined in section 3.2.1 of RFC 2068 Extension = path ; path is defined in section 3.2.1 of RFC 2068
[Fielding et al., 1996] [Fielding et al., 1996]
5.5 Lock Capability Discovery 6.4.1 Node Field Generation Without the IEEE 802 Address
GUIDs, as defined in [ISO-11578], contain a "node" field which
contains one of the IEEE 802 addresses for the server machine. As
noted in section 17.8, there are several security risks associated
with exposing a machine's IEEE 802 address. This section provides an
alternate mechanism for generating the "node" field of a GUID which
does not employ an IEEE 802 address. WebDAV servers MAY use this
algorithm for creating the node field when generating GUIDs. The
text in this section is quoted from section 4 of draft-leach-uuids-
guids-01 (expired).
The ideal solution is to obtain a 47 bit cryptographic quality
random number, and use it as the low 47 bits of the node ID, with
the most significant bit of the first octet of the node ID set to 1.
This bit is the unicast/multicast bit, which will never be set in
IEEE 802 addresses obtained from network cards; hence, there can
never be a conflict between GUIDs generated by machines with and
without network cards.
If a system does not have a primitive to generate cryptographic
quality random numbers, then in most systems there are usually a
fairly large number of sources of randomness available from which
one can be generated. Such sources are system specific, but often
include:
- the percent of memory in use
- the size of main memory in bytes
- the amount of free main memory in bytes
- the size of the paging or swap file in bytes
- free bytes of paging or swap file
- the total size of user virtual address space in bytes
- the total available user address space bytes
- the size of boot disk drive in bytes
- the free disk space on boot drive in bytes
- the current time
- the amount of time since the system booted
- the individual sizes of files in various system directories
- the creation, last read, and modification times of files in
various system directories
- the utilization factors of various system resources (heap, etc.)
- current mouse cursor position
- current caret position
- current number of running processes, threads
- handles or IDs of the desktop window and the active window
- the value of stack pointer of the caller
- the process and thread ID of caller
- various processor architecture specific performance counters
(instructions executed, cache misses, TLB misses)
(Note that it is precisely the above kinds of sources of randomness
that are used to seed cryptographic quality random number generators
on systems without special hardware for their construction.)
In addition, items such as the computer's name and the name of the
operating system, while not strictly speaking random, will help
differentiate the results from those obtained by other systems.
The exact algorithm to generate a node ID using these data is system
specific, because both the data available and the functions to
obtain them are often very system specific. However, assuming that
one can concatenate all the values from the randomness sources into
a buffer, and that a cryptographic hash function such as MD5 is
available, then any 6 bytes of the MD5 hash of the buffer, with the
multicast bit (the high bit of the first byte) set will be an
appropriately random node ID.
Other hash functions, such as SHA-1, can also be used. The only
requirement is that the result be suitably random _ in the sense
that the outputs from a set uniformly distributed inputs are
themselves uniformly distributed, and that a single bit change in
the input can be expected to cause half of the output bits to
change.
6.5 Lock Capability Discovery
Since server lock support is optional, a client trying to lock a Since server lock support is optional, a client trying to lock a
resource on a server can either try the lock and hope for the best, resource on a server can either try the lock and hope for the best,
or perform some form of discovery to determine what lock or perform some form of discovery to determine what lock
capabilities the server supports. This is known as lock capability capabilities the server supports. This is known as lock capability
discovery. Lock capability discovery differs from discovery of discovery. Lock capability discovery differs from discovery of
supported access control types, since there may be access control supported access control types, since there may be access control
types without corresponding lock types. A client can determine what types without corresponding lock types. A client can determine what
lock types the server supports by retrieving the supportedlock lock types the server supports by retrieving the supportedlock
property. property.
Any DAV compliant resource that supports the LOCK method MUST Any DAV compliant resource that supports the LOCK method MUST
support the supportedlock property. support the supportedlock property.
5.6 Active Lock Discovery 6.6 Active Lock Discovery
If another principal locks a resource that a principal wishes to If another principal locks a resource that a principal wishes to
access, it is useful for the second principal to be able to find out access, it is useful for the second principal to be able to find out
who the first principal is. For this purpose the lockdiscovery who the first principal is. For this purpose the lockdiscovery
property is provided. This property lists all outstanding locks, property is provided. This property lists all outstanding locks,
describes their type, and where available, provides their lock describes their type, and where available, provides their lock
token. token.
Any DAV compliant resource that supports the LOCK method MUST Any DAV compliant resource that supports the LOCK method MUST
support the lockdiscovery property. support the lockdiscovery property.
5.7 Usage Considerations 6.7 Usage Considerations
Although the locking mechanisms specified here provide some help in Although the locking mechanisms specified here provide some help in
preventing lost updates, they cannot guarantee that updates will preventing lost updates, they cannot guarantee that updates will
never be lost. Consider the following scenario: never be lost. Consider the following scenario:
Two clients A and B are interested in editing the resource Two clients A and B are interested in editing the resource
'index.html'. Client A is an HTTP client rather than a WebDAV 'index.html'. Client A is an HTTP client rather than a WebDAV
client, and so does not know how to perform locking. client, and so does not know how to perform locking.
Client A doesn't lock the document, but does a GET and begins Client A doesn't lock the document, but does a GET and begins
skipping to change at page 17, line 42 skipping to change at page 20, line 26
they interact with a WebDAV server that supports locking. they interact with a WebDAV server that supports locking.
HTTP 1.1 clients can be good citizens, avoiding overwriting other HTTP 1.1 clients can be good citizens, avoiding overwriting other
clients' changes, by using entity tags in If-Match headers with any clients' changes, by using entity tags in If-Match headers with any
requests that would modify resources. requests that would modify resources.
Information managers may attempt to prevent overwrites by Information managers may attempt to prevent overwrites by
implementing client-side procedures requiring locking before implementing client-side procedures requiring locking before
modifying WebDAV resources. modifying WebDAV resources.
6 Write Lock 7 Write Lock
This section describes the semantics specific to the write lock This section describes the semantics specific to the write lock
type. The write lock is a specific instance of a lock type, and is type. The write lock is a specific instance of a lock type, and is
the only lock type described in this specification. the only lock type described in this specification.
6.1 Methods Restricted by Write Locks 7.1 Methods Restricted by Write Locks
A write lock MUST prevent a principal without the lock from A write lock MUST prevent a principal without the lock from
successfully executing a PUT, POST, PROPPATCH, LOCK, UNLOCK, MOVE, successfully executing a PUT, POST, PROPPATCH, LOCK, UNLOCK, MOVE,
DELETE, or MKCOL on the locked resource. All other current methods, DELETE, or MKCOL on the locked resource. All other current methods,
GET in particular, function independent of the lock. GET in particular, function independently of the lock.
Note, however, that as new methods are created it will be necessary Note, however, that as new methods are created it will be necessary
to specify how they interact with a write lock. to specify how they interact with a write lock.
6.2 Write Locks and Properties 7.2 Write Locks and Lock Tokens
A successful request for an exclusive or shared write lock MUST
result in the generation of a unique lock token associated with the
requesting principal. Thus if five principals have a shared write
lock on the same resource there will be five lock tokens, one for
each principal.
7.3 Write Locks and Properties
While those without a write lock may not alter a property on a While those without a write lock may not alter a property on a
resource it is still possible for the values of live properties to resource it is still possible for the values of live properties to
change, even while locked, due to the requirements of their schemas. change, even while locked, due to the requirements of their schemas.
Only dead properties and live properties defined to respect locks Only dead properties and live properties defined to respect locks
are guaranteed not to change while write locked. are guaranteed not to change while write locked.
6.3 Write Locks and Null Resources 7.4 Write Locks and Null Resources
It is possible to assert a write lock on a null resource in order to It is possible to assert a write lock on a null resource in order to
lock the name. lock the name.
A write locked null resource, referred to as a lock-null resource, A write locked null resource, referred to as a lock-null resource,
MUST respond with a 404 Not Found or 405 Method Not Allowed to any MUST respond with a 404 (Not Found) or 405 (Method Not Allowed) to
HTTP/1.1 or DAV methods except for PUT, MKCOL, OPTIONS, PROPFIND, any HTTP/1.1 or DAV methods except for PUT, MKCOL, OPTIONS,
LOCK, and UNLOCK. A lock-null resource MUST appear as a member of PROPFIND, LOCK, and UNLOCK. A lock-null resource MUST appear as a
its parent collection. Additionally the lock-null resource MUST member of its parent collection. Additionally the lock-null
have defined on it all mandatory DAV properties. Most of these resource MUST have defined on it all mandatory DAV properties. Most
properties, such as all the get* properties, will have no value as a of these properties, such as all the get* properties, will have no
lock-null resource does not support the GET method. Lock-Null value as a lock-null resource does not support the GET method.
resources MUST have defined values for lockdiscovery and Lock-Null resources MUST have defined values for lockdiscovery and
supportedlock properties. supportedlock properties.
Until a method such as PUT or MKCOL is successfully executed on the Until a method such as PUT or MKCOL is successfully executed on the
lock-null resource the resource MUST stay in the lock-null state. lock-null resource the resource MUST stay in the lock-null state.
However, once a PUT or MKCOL is successfully executed on a lock-null However, once a PUT or MKCOL is successfully executed on a lock-null
resource the resources ceases to be in the lock-null state. resource the resource ceases to be in the lock-null state.
If the resource is unlocked, for any reason, without a PUT, MKCOL, If the resource is unlocked, for any reason, without a PUT, MKCOL,
or similar method having been successfully executed upon it then the or similar method having been successfully executed upon it then the
resource MUST return to the null state. resource MUST return to the null state.
6.4 Write Locks and Collections 7.5 Write Locks and Collections
A write lock on a collection prevents the addition or removal of A write lock on a collection, whether created by a "Depth: 0" or
"Depth: infinity" lock request, prevents the addition or removal of
members of the collection by non-lock owners. As a consequence, members of the collection by non-lock owners. As a consequence,
when a principal issues a request to create a new internal member of when a principal issues a request to create a new internal member of
a write locked collection using PUT or POST, or to remove an a write locked collection using PUT or POST, or to remove an
existing internal member of a write locked collection using DELETE, existing internal member of a write locked collection using DELETE,
this request MUST fail if the principal does not have a write lock this request MUST fail if the principal does not have a write lock
on the collection. on the collection.
However, if a write lock request is issued to a collection However, if a write lock request is issued to a collection
containing internal member resources that are currently locked in a containing internal member resources that are currently locked in a
manner which conflicts with the write lock, the request MUST fail manner which conflicts with the write lock, the request MUST fail
with a 423 Locked status code. with a 423 (Locked) status code.
If a lock owner causes a resource to be added as an internal member If a lock owner causes a resource to be added as an internal member
of a locked collection then the new resource MUST be automatically of a locked collection then the new resource MUST be automatically
added to the lock. This is the only mechanism that allows a added to the lock. This is the only mechanism that allows a
resource to be added to a write lock. Thus, for example, if the resource to be added to a write lock. Thus, for example, if the
collection /a/b/ is write locked and the resource /c is moved to collection /a/b/ is write locked and the resource /c is moved to
/a/b/c then /a/b/c will be added to the write lock. /a/b/c then /a/b/c will be added to the write lock.
6.5 Write Locks and the If Request Header 7.6 Write Locks and the If Request Header
If a user agent is not required to have knowledge about a lock when If a user agent is not required to have knowledge about a lock when
requesting an operation on a locked resource, the following scenario requesting an operation on a locked resource, the following scenario
might occur. Program A, run by User A, takes out a write lock on a might occur. Program A, run by User A, takes out a write lock on a
resource. Program B, also run by User A, has no knowledge of the resource. Program B, also run by User A, has no knowledge of the
lock taken out by Program A, yet performs a PUT to the locked lock taken out by Program A, yet performs a PUT to the locked
resource. In this scenario, the PUT succeeds because locks are resource. In this scenario, the PUT succeeds because locks are
associated with a principal, not a program, and thus program B, associated with a principal, not a program, and thus program B,
because it is acting with principal A's credential, is allowed to because it is acting with principal A's credential, is allowed to
perform the PUT. However, had program B known about the lock, it perform the PUT. However, had program B known about the lock, it
skipping to change at page 19, line 32 skipping to change at page 22, line 29
from accidentally ignoring locks taken out by other programs with from accidentally ignoring locks taken out by other programs with
the same authorization. the same authorization.
In order to prevent these collisions a lock token MUST be submitted In order to prevent these collisions a lock token MUST be submitted
by an authorized principal in the If header for all locked resources by an authorized principal in the If header for all locked resources
that a method may interact with or the method MUST fail. For that a method may interact with or the method MUST fail. For
example, if a resource is to be moved and both the source and example, if a resource is to be moved and both the source and
destination are locked then two lock tokens must be submitted, one destination are locked then two lock tokens must be submitted, one
for the source and the other for the destination. for the source and the other for the destination.
6.5.1 Example - Write Lock 7.6.1 Example - Write Lock
>>Request >>Request
COPY /~fielding/index.html HTTP/1.1 COPY /~fielding/index.html HTTP/1.1
Host: www.ics.uci.edu Host: www.ics.uci.edu
Destination: http://www.ics.uci.edu/users/f/fielding/index.html Destination: http://www.ics.uci.edu/users/f/fielding/index.html
If: <http://www.ics.uci.edu/users/f/fielding/index.html> If: <http://www.ics.uci.edu/users/f/fielding/index.html>
(<opaquelocktoken:f81d4fae-7dec-11d0-a765-00a0c91e6bf6>) (<opaquelocktoken:f81d4fae-7dec-11d0-a765-00a0c91e6bf6>)
>>Response >>Response
skipping to change at page 20, line 5 skipping to change at page 22, line 51
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
In this example, even though both the source and destination are In this example, even though both the source and destination are
locked, only one lock token must be submitted, for the lock on the locked, only one lock token must be submitted, for the lock on the
destination. This is because the source resource is not modified by destination. This is because the source resource is not modified by
a COPY, and hence unaffected by the write lock. In this example, a COPY, and hence unaffected by the write lock. In this example,
user agent authentication has previously occurred via a mechanism user agent authentication has previously occurred via a mechanism
outside the scope of the HTTP protocol, in the underlying transport outside the scope of the HTTP protocol, in the underlying transport
layer. layer.
6.6 Write Locks and COPY/MOVE 7.7 Write Locks and COPY/MOVE
A COPY method invocation MUST NOT duplicate any write locks active A COPY method invocation MUST NOT duplicate any write locks active
on the source. However, as previously noted, if the COPY copies the on the source. However, as previously noted, if the COPY copies the
resource into a collection that is depth locked then the resource resource into a collection that is locked with "Depth: infinity",
will be added to the lock. then the resource will be added to the lock.
A MOVE MUST NOT move the write lock with the resource although the A successful MOVE request on a write locked resource MUST NOT move
resource is subject to being added to an existing lock as specified the write lock with the resource. However, the resource is subject
in section 6.4. For example, if the MOVE makes the resource a child to being added to an existing lock at the destination, as specified
of a collection that is depth locked then the resource will be under in section 7.5. For example, if the MOVE makes the resource a child
that collection's lock. Additionally, if a depth locked resource is of a collection that is locked with "Depth: infinity", then the
moved to a destination that is within the scope of the same depth resource will be added to that collection's lock. Additionally, if a
lock (e.g., within the namespace tree covered by the lock), the resource locked with "Depth: infinity" is moved to a destination
moved resource will again be a member of the lock. In both these that is within the scope of the same lock (e.g., within the
examples, as specified in section 6.5, an If header must be namespace tree covered by the lock), the moved resource will again
submitted containing a lock token for both the source and be a added to the lock. In both these examples, as specified in
destination. section 7.6, an If header must be submitted containing a lock token
for both the source and destination.
6.7 Refreshing Write Locks 7.8 Refreshing Write Locks
A client MUST NOT submit the same write lock request twice. Note A client MUST NOT submit the same write lock request twice. Note
that a client is always aware it is resubmitting the same lock that a client is always aware it is resubmitting the same lock
request because it must include the lock token in the If header in request because it must include the lock token in the If header in
order to make the request for a resource that is already locked. order to make the request for a resource that is already locked.
However, a client may submit a LOCK method with an If header but However, a client may submit a LOCK method with an If header but
without a body. This form of LOCK MUST only be used to "refresh" a without a body. This form of LOCK MUST only be used to "refresh" a
lock. Meaning, at minimum, that any timers associated with the lock lock. Meaning, at minimum, that any timers associated with the lock
MUST be re-set. MUST be re-set.
skipping to change at page 20, line 46 skipping to change at page 23, line 42
A server may return a Timeout header with a lock refresh that is A server may return a Timeout header with a lock refresh that is
different than the Timeout header returned when the lock was different than the Timeout header returned when the lock was
originally requested. Additionally clients may submit Timeout originally requested. Additionally clients may submit Timeout
headers of arbitrary value with their lock refresh requests. headers of arbitrary value with their lock refresh requests.
Servers, as always, may ignore Timeout headers submitted by the Servers, as always, may ignore Timeout headers submitted by the
client. client.
If an error is received in response to a refresh LOCK request the If an error is received in response to a refresh LOCK request the
client SHOULD assume that the lock was not refreshed. client SHOULD assume that the lock was not refreshed.
7 HTTP Methods for Distributed Authoring 8 HTTP Methods for Distributed Authoring
The following new HTTP methods use XML as a request and response The following new HTTP methods use XML as a request and response
format. All DAV compliant clients and resources MUST use XML format. All DAV compliant clients and resources MUST use XML
parsers that are compliant with [Bray, Paoli, Sperberg-McQueen, parsers that are compliant with [REC-XML]. All XML used in either
1998]. All XML used in either requests or responses MUST be, at requests or responses MUST be, at minimum, well formed. If a server
minimum, well formed. If a server receives ill-formed XML in a receives ill-formed XML in a request it MUST reject the entire
request it MUST reject the entire request with a 400 Bad Request. request with a 400 (Bad Request). If a client receives ill-formed
If a client receives ill-formed XML in a response then it MUST NOT XML in a response then it MUST NOT assume anything about the outcome
assume anything about the outcome of the executed method and SHOULD of the executed method and SHOULD treat the server as
treat the server as malfunctioning. malfunctioning.
7.1 PROPFIND 8.1 PROPFIND
The PROPFIND method retrieves properties defined on the Request-URI, The PROPFIND method retrieves properties defined on the Request-URI,
if the resource does not have any internal members, or on the if the resource does not have any internal members, or on the
Request-URI and potentially its member resources, if the resource Request-URI and potentially its member resources, if the resource
does have internal members. All DAV compliant resources MUST does have internal members. All DAV compliant resources MUST
support the PROPFIND method and the propfind XML element (section support the PROPFIND method and the propfind XML element (section
11.14) along with all XML elements defined for use with that 12.14) along with all XML elements defined for use with that
element. element.
A client may submit a Depth header with a value of "0", "1", or A client may submit a Depth header with a value of "0", "1", or
"infinity" with a PROPFIND on a resource with internal members. DAV "infinity" with a PROPFIND on a resource with internal members. DAV
compliant servers MUST support the "0", "1" and "infinity" compliant servers MUST support the "0", "1" and "infinity"
behaviors. By default, the PROPFIND method without a Depth header behaviors. By default, the PROPFIND method without a Depth header
MUST act as if a "Depth: infinity" header was included. MUST act as if a "Depth: infinity" header was included.
A client may submit a propfind XML element in the body of the A client may submit a propfind XML element in the body of the
request method describing what information is being requested. It request method describing what information is being requested. It
is possible to request particular property values, all property is possible to request particular property values, all property
values, or a list of the names of the resource's properties. A values, or a list of the names of the resource's properties. A
client may choose not to submit a request body. An empty PROPFIND client may choose not to submit a request body. An empty PROPFIND
request body MUST be treated as a request for the names and values request body MUST be treated as a request for the names and values
of all properties. of all properties.
All servers MUST support returning a response of content type All servers MUST support returning a response of content type
text/xml that contains a multistatus XML element that describes the text/xml or application/xml that contains a multistatus XML element
results of the attempts to retrieve the various properties. that describes the results of the attempts to retrieve the various
properties.
If there is an error retrieving a property then a proper error If there is an error retrieving a property then a proper error
result MUST be included in the response. A request to retrieve the result MUST be included in the response. A request to retrieve the
value of a property which does not exist is an error and MUST be value of a property which does not exist is an error and MUST be
noted, if the response uses a multistatus XML element, with a noted, if the response uses a multistatus XML element, with a
response XML element which contains a 404 Not Found status value. response XML element which contains a 404 (Not Found) status value.
Consequently, the multistatus XML element for a resource with Consequently, the multistatus XML element for a resource with
members MUST include a response XML element for each member of the members MUST include a response XML element for each member of the
resource, to whatever depth was requested. Each response XML element resource, to whatever depth was requested. Each response XML element
MUST contain an href XML element that identifies the resource on MUST contain an href XML element that identifies the resource on
which the properties in the prop XML element are defined. Results which the properties in the prop XML element are defined. Results
for a PROPFIND on a resource with internal members are returned as a for a PROPFIND on a resource with internal members are returned as a
flat list whose order of entries is not significant. flat list whose order of entries is not significant.
In the case of allprop and propname, if a principal does not have In the case of allprop and propname, if a principal does not have
the right to know whether a particular property exists then the the right to know whether a particular property exists then the
property should be silently excluded from the response. property should be silently excluded from the response.
The results of this method SHOULD NOT be cached. The results of this method SHOULD NOT be cached.
7.1.1 Example - Retrieving Named Properties 8.1.1 Example - Retrieving Named Properties
>>Request >>Request
PROPFIND /file HTTP/1.1 PROPFIND /file HTTP/1.1
Host: www.foo.bar Host: www.foo.bar
Content-type: text/xml Content-type: text/xml; charset="utf-8"
Content-Length: xyz Content-Length: xyz
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:propfind xmlns:D="DAV:">
<?xml:namespace ns="http://www.foo.bar/boxschema/" prefix="R" ?> <D:prop xmlns:R="http://www.foo.bar/boxschema/">
<D:propfind>
<D:prop>
<R:bigbox/> <R:bigbox/>
<R:author/> <R:author/>
<R:DingALing/> <R:DingALing/>
<R:Random/> <R:Random/>
</D:prop> </D:prop>
</D:propfind> </D:propfind>
>>Response >>Response
HTTP/1.1 207 Multi-Status HTTP/1.1 207 Multi-Status
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xxxxx Content-Length: xxxxx
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:multistatus xmlns:D="DAV:">
<?xml:namespace ns="http://www.foo.bar/boxschema/" prefix="R" ?>
<D:multistatus>
<D:response> <D:response>
<D:href>http://www.foo.bar/file</D:href> <D:href>http://www.foo.bar/file</D:href>
<D:propstat> <D:propstat>
<D:prop> <D:prop xmlns:R="http://www.foo.bar/boxschema/">
<R:bigbox> <R:bigbox>
<R:BoxType>Box type A</R:BoxType> <R:BoxType>Box type A</R:BoxType>
</R:bigbox> </R:bigbox>
<R:author> <R:author>
<R:Name>J.J. Johnson</R:Name> <R:Name>J.J. Johnson</R:Name>
</R:author> </R:author>
</D:prop> </D:prop>
<D:status>HTTP/1.1 200 OK</D:status> <D:status>HTTP/1.1 200 OK</D:status>
</D:propstat> </D:propstat>
<D:propstat> <D:propstat>
skipping to change at page 23, line 7 skipping to change at page 26, line 4
<D:prop><R:DingALing/><R:Random/></D:prop> <D:prop><R:DingALing/><R:Random/></D:prop>
<D:status>HTTP/1.1 403 Forbidden</D:status> <D:status>HTTP/1.1 403 Forbidden</D:status>
<D:responsedescription> The user does not have access to <D:responsedescription> The user does not have access to
the DingALing property. the DingALing property.
</D:responsedescription> </D:responsedescription>
</D:propstat> </D:propstat>
</D:response> </D:response>
<D:responsedescription> There has been an access violation error. <D:responsedescription> There has been an access violation error.
</D:responsedescription> </D:responsedescription>
</D:multistatus> </D:multistatus>
In this example, PROPFIND is executed on a non-collection resource In this example, PROPFIND is executed on a non-collection resource
http://www.foo.bar/file. The propfind XML element specifies the http://www.foo.bar/file. The propfind XML element specifies the
name of four properties whose values are being requested. In this name of four properties whose values are being requested. In this
case only two properties were returned, since the principal issuing case only two properties were returned, since the principal issuing
the request did not have sufficient access rights to see the third the request did not have sufficient access rights to see the third
and fourth properties. and fourth properties.
7.1.2 Example - Using allprop to Retrieve All Properties 8.1.2 Example - Using allprop to Retrieve All Properties
>>Request >>Request
PROPFIND /container/ HTTP/1.1 PROPFIND /container/ HTTP/1.1
Host: www.foo.bar Host: www.foo.bar
Depth: 1 Depth: 1
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xxxxx Content-Length: xxxxx
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:propfind xmlns:D="DAV:">
<D:propfind>
<D:allprop/> <D:allprop/>
</D:propfind> </D:propfind>
>>Response >>Response
HTTP/1.1 207 Multi-Status HTTP/1.1 207 Multi-Status
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xxxxx Content-Length: xxxxx
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:multistatus xmlns:D="DAV:">
<?xml:namespace ns="http://www.foo.bar/boxschema/" prefix="R" ?>
<D:multistatus>
<D:response> <D:response>
<D:href>http://www.foo.bar/container/</D:href> <D:href>http://www.foo.bar/container/</D:href>
<D:propstat> <D:propstat>
<D:prop> <D:prop xmlns:R="http://www.foo.bar/boxschema/">
<R:bigbox> <R:bigbox>
<R:BoxType>Box type A</R:BoxType> <R:BoxType>Box type A</R:BoxType>
</R:bigbox> </R:bigbox>
<R:author> <R:author>
<R:Name>Hadrian</R:Name> <R:Name>Hadrian</R:Name>
</R:author> </R:author>
<D:creationdate> <D:creationdate>
1997-12-01T17:42:21-08:00 1997-12-01T17:42:21-08:00
</D:creationdate> </D:creationdate>
<D:displayname> <D:displayname>
Example collection Example collection
</D:displayname> </D:displayname>
<D:resourcetype><D:collection/></D:resourcetype> <D:resourcetype><D:collection/></D:resourcetype>
<D:supportedlock> <D:supportedlock>
<D:lockentry> <D:lockentry>
<D:exclusive/><D:write/> <D:lockscope><D:exclusive/></D:lockscope>
<D:locktype><D:write/></D:locktype>
</D:lockentry> </D:lockentry>
<D:lockentry> <D:lockentry>
<D:shared/><D:write/> <D:lockscope><D:shared/></D:lockscope>
<D:locktype><D:write/></D:locktype>
</D:lockentry> </D:lockentry>
</D:supportedlock> </D:supportedlock>
</D:prop> </D:prop>
<D:status>HTTP/1.1 200 OK</D:status> <D:status>HTTP/1.1 200 OK</D:status>
</D:propstat> </D:propstat>
</D:response> </D:response>
<D:response> <D:response>
<D:href>http://www.foo.bar/container/front.html</D:href> <D:href>http://www.foo.bar/container/front.html</D:href>
<D:propstat> <D:propstat>
<D:prop> <D:prop xmlns:R="http://www.foo.bar/boxschema/">
<R:bigbox> <R:bigbox>
<R:BoxType>Box type B</R:BoxType> <R:BoxType>Box type B</R:BoxType>
</R:bigbox> </R:bigbox>
<D:creationdate> <D:creationdate>
1997-12-01T18:27:21-08:00 1997-12-01T18:27:21-08:00
</D:creationdate> </D:creationdate>
<D:displayname> <D:displayname>
Example HTML resource Example HTML resource
</D:displayname> </D:displayname>
<D:getcontentlength> <D:getcontentlength>
skipping to change at page 24, line 46 skipping to change at page 27, line 42
</D:getcontenttype> </D:getcontenttype>
<D:getetag> <D:getetag>
zzyzx zzyzx
</D:getetag> </D:getetag>
<D:getlastmodified> <D:getlastmodified>
Monday, 12-Jan-98 09:25:56 GMT Monday, 12-Jan-98 09:25:56 GMT
</D:getlastmodified> </D:getlastmodified>
<D:resourcetype/> <D:resourcetype/>
<D:supportedlock> <D:supportedlock>
<D:lockentry> <D:lockentry>
<D:exclusive/><D:write/> <D:lockscope><D:exclusive/></D:lockscope>
<D:locktype><D:write/></D:locktype>
</D:lockentry> </D:lockentry>
<D:lockentry> <D:lockentry>
<D:shared/><D:write/> <D:lockscope><D:shared/></D:lockscope>
<D:locktype><D:write/></D:locktype>
</D:lockentry> </D:lockentry>
</D:supportedlock> </D:supportedlock>
</D:prop> </D:prop>
<D:status>HTTP/1.1 200 OK</D:status> <D:status>HTTP/1.1 200 OK</D:status>
</D:propstat> </D:propstat>
</D:response> </D:response>
</D:multistatus> </D:multistatus>
In this example, PROPFIND was invoked on the resource In this example, PROPFIND was invoked on the resource
http://www.foo.bar/container/ with a Depth header of 1, meaning the http://www.foo.bar/container/ with a Depth header of 1, meaning the
request applies to the resource and its children, and a propfind XML request applies to the resource and its children, and a propfind XML
skipping to change at page 25, line 18 skipping to change at page 28, line 18
should return the name and value of all properties defined on each should return the name and value of all properties defined on each
resource. resource.
The resource http://www.foo.bar/container/ has six properties The resource http://www.foo.bar/container/ has six properties
defined on it: defined on it:
http://www.foo.bar/boxschema/bigbox, http://www.foo.bar/boxschema/bigbox,
http://www.foo.bar/boxschema/author, DAV:creationdate, http://www.foo.bar/boxschema/author, DAV:creationdate,
DAV:displayname, DAV:resourcetype, and DAV:supportedlock. DAV:displayname, DAV:resourcetype, and DAV:supportedlock.
The last four properties are WebDAV-specific, defined in section 12. The last four properties are WebDAV-specific, defined in section 13.
Since GET is not supported on this resource, the get* properties Since GET is not supported on this resource, the get* properties
(e.g., getcontentlength) are not defined on this resource. The DAV- (e.g., getcontentlength) are not defined on this resource. The DAV-
specific properties assert that "container" was created on December specific properties assert that "container" was created on December
1, 1997, at 5:42:21PM, in a time zone 8 hours west of GMT 1, 1997, at 5:42:21PM, in a time zone 8 hours west of GMT
(creationdate), has a name of "Example collection" (displayname), a (creationdate), has a name of "Example collection" (displayname), a
collection resource type (resourcetype), and supports exclusive collection resource type (resourcetype), and supports exclusive
write and shared write locks (supportedlock). write and shared write locks (supportedlock).
The resource http://www.foo.bar/container/front.html has nine The resource http://www.foo.bar/container/front.html has nine
properties defined on it: properties defined on it:
skipping to change at page 25, line 45 skipping to change at page 29, line 5
The DAV-specific properties assert that "front.html" was created on The DAV-specific properties assert that "front.html" was created on
December 1, 1997, at 6:27:21PM, in a time zone 8 hours west of GMT December 1, 1997, at 6:27:21PM, in a time zone 8 hours west of GMT
(creationdate), has a name of "Example HTML resource" (displayname), (creationdate), has a name of "Example HTML resource" (displayname),
a content length of 4525 bytes (getcontentlength), a MIME type of a content length of 4525 bytes (getcontentlength), a MIME type of
"text/html" (getcontenttype), an entity tag of "zzyzx" (getetag), "text/html" (getcontenttype), an entity tag of "zzyzx" (getetag),
was last modified on Monday, January 12, 1998, at 09:25:56 GMT was last modified on Monday, January 12, 1998, at 09:25:56 GMT
(getlastmodified), has an empty resource type, meaning that it is (getlastmodified), has an empty resource type, meaning that it is
not a collection (resourcetype), and supports both exclusive write not a collection (resourcetype), and supports both exclusive write
and shared write locks (supportedlock). and shared write locks (supportedlock).
7.1.3 Example - Using propname to Retrieve all Property Names 8.1.3 Example - Using propname to Retrieve all Property Names
>>Request >>Request
PROPFIND /container/ HTTP/1.1 PROPFIND /container/ HTTP/1.1
Host: www.foo.bar Host: www.foo.bar
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xxxxx Content-Length: xxxxx
<?xml version="1.0" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <?xml version="1.0" encoding="utf-8" ?>
<D:propfind> <propfind xmlns="DAV:">
<D:propname/> <propname/>
</D:propfind> </propfind>
>>Response >>Response
HTTP/1.1 207 Multi-Status HTTP/1.1 207 Multi-Status
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xxxx Content-Length: xxxx
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <multistatus xmlns="DAV:">
<?xml:namespace ns="http://www.foo.bar/boxschema/" prefix="R" ?> <response>
<D:multistatus> <href>http://www.foo.bar/container/</href>
<D:response> <propstat>
<D:href>http://www.foo.bar/container/</D:href> <prop xmlns:R="http://www.foo.bar/boxschema/">
<D:propstat>
<D:prop>
<R:bigbox/> <R:bigbox/>
<R:author/> <R:author/>
<D:creationdate/> <creationdate/>
<D:displayname/> <displayname/>
<D:resourcetype/> <resourcetype/>
<D:supportedlock/> <supportedlock/>
</D:prop> </prop>
<D:status>HTTP/1.1 200 OK</D:status> <status>HTTP/1.1 200 OK</status>
</D:propstat> </propstat>
</D:response> </response>
<D:response> <response>
<D:href>http://www.foo.bar/container/front.html</D:href> <href>http://www.foo.bar/container/front.html</href>
<D:propstat> <propstat>
<D:prop> <prop xmlns:R="http://www.foo.bar/boxschema/">
<R:bigbox/> <R:bigbox/>
<D:creationdate/> <creationdate/>
<D:displayname/> <displayname/>
<D:getcontentlength/> <getcontentlength/>
<D:getcontenttype/> <getcontenttype/>
<D:getetag/> <getetag/>
<D:getlastmodified/> <getlastmodified/>
<D:resourcetype/> <resourcetype/>
<D:supportedlock/> <supportedlock/>
</D:prop> </prop>
<D:status>HTTP/1.1 200 OK</D:status> <status>HTTP/1.1 200 OK</status>
</D:propstat> </propstat>
</D:response> </response>
</D:multistatus> </multistatus>
In this example, PROPFIND is invoked on the collection resource In this example, PROPFIND is invoked on the collection resource
http://www.foo.bar/container/, with a propfind XML element http://www.foo.bar/container/, with a propfind XML element
containing the propname XML element, meaning the name of all containing the propname XML element, meaning the name of all
properties should be returned. Since no depth header is present, it properties should be returned. Since no Depth header is present, it
assumes its default value of "infinity", meaning the name of the assumes its default value of "infinity", meaning the name of the
properties on the collection and all its progeny should be returned. properties on the collection and all its progeny should be returned.
Consistent with the previous example, resource Consistent with the previous example, resource
http://www.foo.bar/container/ has six properties defined on it, http://www.foo.bar/container/ has six properties defined on it,
http://www.foo.bar/boxschema/bigbox, http://www.foo.bar/boxschema/bigbox,
http://www.foo.bar/boxschema/author, DAV:creationdate, http://www.foo.bar/boxschema/author, DAV:creationdate,
DAV:displayname, DAV:resourcetype, and DAV:supportedlock. DAV:displayname, DAV:resourcetype, and DAV:supportedlock.
The resource http://www.foo.bar/container/index.html, a member of The resource http://www.foo.bar/container/index.html, a member of
the "container" collection, has nine properties defined on it, the "container" collection, has nine properties defined on it,
http://www.foo.bar/boxschema/bigbox, DAV:creationdate, http://www.foo.bar/boxschema/bigbox, DAV:creationdate,
DAV:displayname, DAV:getcontentlength, DAV:getcontenttype, DAV:displayname, DAV:getcontentlength, DAV:getcontenttype,
DAV:getetag, DAV:getlastmodified, DAV:resourcetype, and DAV:getetag, DAV:getlastmodified, DAV:resourcetype, and
DAV:supportedlock. DAV:supportedlock.
7.2 PROPPATCH This example also demonstrates the use of XML namespace scoping, and
the default namespace. Since the "xmlns" attibute does not contain
an explicit "shorthand name" (prefix) letter, the namespace applies
by default to all enclosed elements. Hence, all elements which do
not explicitly state the namespace to which they belong are members
of the "DAV:" namespace schema.
8.2 PROPPATCH
The PROPPATCH method processes instructions specified in the request The PROPPATCH method processes instructions specified in the request
body to set and/or remove properties defined on the resource body to set and/or remove properties defined on the resource
identified by the Request-URI. identified by the Request-URI.
All DAV compliant resources MUST support the PROPPATCH method and All DAV compliant resources MUST support the PROPPATCH method and
MUST process instructions that are specified using the MUST process instructions that are specified using the
propertyupdate, set, and remove XML elements of the DAV schema. propertyupdate, set, and remove XML elements of the DAV schema.
Execution of the directives in this method is, of course, subject to Execution of the directives in this method is, of course, subject to
access control constraints. DAV compliant resources SHOULD support access control constraints. DAV compliant resources SHOULD support
the setting of arbitrary dead properties. the setting of arbitrary dead properties.
The request message body of a PROPPATCH method MUST contain the The request message body of a PROPPATCH method MUST contain the
propertyupdate XML element. Instruction processing MUST occur in propertyupdate XML element. Instruction processing MUST occur in
the order instructions are received (i.e., from top to bottom). the order instructions are received (i.e., from top to bottom).
Instructions MUST either all be executed or none executed. Thus if Instructions MUST either all be executed or none executed. Thus if
any error occurs during processing all executed instructions MUST be any error occurs during processing all executed instructions MUST be
undone and a proper error result returned. Instruction processing undone and a proper error result returned. Instruction processing
details can be found in the definition of the set and remove details can be found in the definition of the set and remove
instructions in section 11.13. instructions in section 12.13.
7.2.1 Status Codes for use with Multi-Status 8.2.1 Status Codes for use with 207 (Multi-Status)
The following are examples of response codes one would expect to be The following are examples of response codes one would expect to be
used in a Multi-Status response for this method. Note, however, used in a 207 (Multi-Status) response for this method. Note,
that unless explicitly prohibited any 2/3/4/5xx series response code however, that unless explicitly prohibited any 2/3/4/5xx series
may be used in a Multi-Status response. response code may be used in a 207 (Multi-Status) response.
200 OK - The command succeeded. As there can be a mixture of sets 200 (OK) - The command succeeded. As there can be a mixture of sets
and removes in a body, a 201 Created seems inappropriate. and removes in a body, a 201 (Created) seems inappropriate.
403 Forbidden - The client, for reasons the server chooses not to 403 (Forbidden) - The client, for reasons the server chooses not to
specify, cannot alter one of the properties. specify, cannot alter one of the properties.
409 Conflict - The client has provided a value whose semantics are 409 (Conflict) - The client has provided a value whose semantics are
not appropriate for the property. This includes trying to set read- not appropriate for the property. This includes trying to set read-
only properties. only properties.
423 Locked - The specified resource is locked and the client either 423 (Locked) - The specified resource is locked and the client
is not a lock owner or the lock type requires a lock token to be either is not a lock owner or the lock type requires a lock token to
submitted and the client did not submit it. be submitted and the client did not submit it.
425 Insufficient Space on Resource - The server did not have 507 (Insufficient Storage) - The server did not have sufficient
sufficient space to record the property. space to record the property.
7.2.2 Example - PROPPATCH 8.2.2 Example - PROPPATCH
>>Request >>Request
PROPPATCH /bar.html HTTP/1.1 PROPPATCH /bar.html HTTP/1.1
Host: www.foo.com Host: www.foo.com
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xxxx Content-Length: xxxx
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:propertyupdate xmlns:D="DAV:"
<?xml:namespace ns="http://www.w3.com/standards/z39.50/" prefix="Z" xmlns:Z="http://www.w3.com/standards/z39.50/">
?>
<D:propertyupdate>
<D:set> <D:set>
<D:prop> <D:prop>
<Z:authors> <Z:authors>
<Z:Author>Jim Whitehead</Z:Author> <Z:Author>Jim Whitehead</Z:Author>
<Z:Author>Roy Fielding</Z:Author> <Z:Author>Roy Fielding</Z:Author>
</Z:authors> </Z:authors>
</D:prop> </D:prop>
</D:set> </D:set>
<D:remove> <D:remove>
<D:prop><Z:Copyright-Owner/></D:prop> <D:prop><Z:Copyright-Owner/></D:prop>
</D:remove> </D:remove>
</D:propertyupdate> </D:propertyupdate>
>>Response
>>Response
HTTP/1.1 207 Multi-Status HTTP/1.1 207 Multi-Status
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xxxxx Content-Length: xxxxx
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:multistatus xmlns:D="DAV:"
<?xml:namespace ns="http://www.w3.com/standards/z39.50/" prefix="Z" xmlns:Z="http://www.w3.com/standards/z39.50">
?>
<D:multistatus>
<D:response> <D:response>
<D:href>http://www.foo.com/bar.html</D:href> <D:href>http://www.foo.com/bar.html</D:href>
<D:propstat> <D:propstat>
<D:prop><Z:Authors/></D:prop> <D:prop><Z:Authors/></D:prop>
<D:status>HTTP/1.1 424 Method Failure</D:status> <D:status>HTTP/1.1 424 Failed Dependency</D:status>
</D:propstat> </D:propstat>
<D:propstat> <D:propstat>
<D:prop><Z:Copyright-Owner/></D:prop> <D:prop><Z:Copyright-Owner/></D:prop>
<D:status>HTTP/1.1 409 Conflict</D:status> <D:status>HTTP/1.1 409 Conflict</D:status>
</D:propstat> </D:propstat>
<D:responsedescription> Copyright Owner can not be deleted or <D:responsedescription> Copyright Owner can not be deleted or
altered.</D:responsedescription> altered.</D:responsedescription>
</D:response> </D:response>
</D:multistatus> </D:multistatus>
In this example, the client requests the server to set the value of In this example, the client requests the server to set the value of
the http://www.w3.com/standards/z39.50/Authors property, and to the http://www.w3.com/standards/z39.50/Authors property, and to
remove the property http://www.w3.com/standards/z39.50/Copyright- remove the property http://www.w3.com/standards/z39.50/Copyright-
Owner. Since the Copyright-Owner property could not be removed, no Owner. Since the Copyright-Owner property could not be removed, no
property modifications occur. The Method Failure status code for property modifications occur. The 424 (Failed Dependency) status
the Authors property indicates this action would have succeeded if code for the Authors property indicates this action would have
it were not for the conflict with removing the Copyright-Owner succeeded if it were not for the conflict with removing the
property. Copyright-Owner property.
7.3 MKCOL Method 8.3 MKCOL Method
The MKCOL method is used to create a new collection. All DAV The MKCOL method is used to create a new collection. All DAV
compliant resources MUST support the MKCOL method. compliant resources MUST support the MKCOL method.
7.3.1 Request 8.3.1 Request
MKCOL creates a new collection resource at the location specified by MKCOL creates a new collection resource at the location specified by
the Request-URI. If the resource identified by the Request-URI is the Request-URI. If the resource identified by the Request-URI is
non-null then the MKCOL MUST fail. During MKCOL processing, a non-null then the MKCOL MUST fail. During MKCOL processing, a
server MUST make the Request-URI a member of its parent collection, server MUST make the Request-URI a member of its parent collection,
unless the Request-URI is "/". If no such ancestor exists, the unless the Request-URI is "/". If no such ancestor exists, the
method MUST fail. When the MKCOL operation creates a new collection method MUST fail. When the MKCOL operation creates a new collection
resource, all ancestors MUST already exist, or the method MUST fail resource, all ancestors MUST already exist, or the method MUST fail
with a 409 Conflict status code. For example, if a request to with a 409 (Conflict) status code. For example, if a request to
create collection /a/b/c/d/ is made, and neither /a/b/ nor /a/b/c/ create collection /a/b/c/d/ is made, and neither /a/b/ nor /a/b/c/
exists, the request must fail. exists, the request must fail.
When MKCOL is invoked without a request body, the newly created When MKCOL is invoked without a request body, the newly created
collection SHOULD have no members. collection SHOULD have no members.
A MKCOL request message may contain a message body. The behavior of A MKCOL request message may contain a message body. The behavior of
a MKCOL request when the body is present is limited to creating a MKCOL request when the body is present is limited to creating
collections, members of a collection, bodies of members and collections, members of a collection, bodies of members and
properties on the collections or members. If the server receives a properties on the collections or members. If the server receives a
MKCOL request entity type it does not support or understand it MUST MKCOL request entity type it does not support or understand it MUST
respond with a 415 Unsupported Media Type status code. The exact respond with a 415 (Unsupported Media Type) status code. The exact
behavior of MKCOL for various request media types is undefined in behavior of MKCOL for various request media types is undefined in
this document, and will be specified in separate documents. this document, and will be specified in separate documents.
7.3.2 Response Codes 8.3.2 Status Codes
Responses from a MKCOL request MUST NOT be cached as MKCOL has non- Responses from a MKCOL request MUST NOT be cached as MKCOL has non-
idempotent semantics. idempotent semantics.
201 Created - The collection or structured resource was created in 201 (Created) - The collection or structured resource was created in
its entirety. its entirety.
403 Forbidden - This indicates at least one of two conditions: 1) 403 (Forbidden) - This indicates at least one of two conditions: 1)
the server does not allow the creation of collections at the given the server does not allow the creation of collections at the given
location in its namespace, or 2) the parent collection of the location in its namespace, or 2) the parent collection of the
Request-URI exists but cannot accept members. Request-URI exists but cannot accept members.
405 Method Not Allowed - MKCOL can only be executed on a 405 (Method Not Allowed) - MKCOL can only be executed on a
deleted/non-existent resource. deleted/non-existent resource.
409 Conflict - A collection cannot be made at the Request-URI until 409 (Conflict) - A collection cannot be made at the Request-URI
one or more intermediate collections have been created. until one or more intermediate collections have been created.
415 Unsupported Media Type- The server does not support the request 415 (Unsupported Media Type)- The server does not support the
type of the body. request type of the body.
425 Insufficient Space on Resource - The resource does not have 507 (Insufficient Storage) - The resource does not have sufficient
sufficient space to record the state of the resource after the space to record the state of the resource after the execution of
execution of this method. this method.
7.3.3 Example - MKCOL 8.3.3 Example - MKCOL
This example creates a collection called /webdisc/xfiles/ on the This example creates a collection called /webdisc/xfiles/ on the
server www.server.org. server www.server.org.
>>Request >>Request
MKCOL /webdisc/xfiles/ HTTP/1.1 MKCOL /webdisc/xfiles/ HTTP/1.1
Host: www.server.org Host: www.server.org
>>Response >>Response
HTTP/1.1 201 Created HTTP/1.1 201 Created
7.4 GET, HEAD for Collections 8.4 GET, HEAD for Collections
The semantics of GET are unchanged when applied to a collection, The semantics of GET are unchanged when applied to a collection,
since GET is defined as, "retrieve whatever information (in the form since GET is defined as, "retrieve whatever information (in the form
of an entity) is identified by the Request-URI" [Fielding et al., of an entity) is identified by the Request-URI" [RFC2068]. GET when
1997]. GET when applied to a collection may return the contents of applied to a collection may return the contents of an "index.html"
an "index.html" resource, a human-readable view of the contents of resource, a human-readable view of the contents of the collection,
the collection, or something else altogether. Hence it is possible or something else altogether. Hence it is possible that the result
that the result of a GET on a collection will bear no correlation to of a GET on a collection will bear no correlation to the membership
the membership of the collection. of the collection.
Similarly, since the definition of HEAD is a GET without a response Similarly, since the definition of HEAD is a GET without a response
message body, the semantics of HEAD are unmodified when applied to message body, the semantics of HEAD are unmodified when applied to
collection resources. collection resources.
7.5 POST for Collections 8.5 POST for Collections
Since by definition the actual function performed by POST is Since by definition the actual function performed by POST is
determined by the server and often depends on the particular determined by the server and often depends on the particular
resource, the behavior of POST when applied to collections cannot be resource, the behavior of POST when applied to collections cannot be
meaningfully modified because it is largely undefined. Thus the meaningfully modified because it is largely undefined. Thus the
semantics of POST are unmodified when applied to a collection. semantics of POST are unmodified when applied to a collection.
7.6 DELETE 8.6 DELETE
7.6.1 DELETE for Non-Collection Resources 8.6.1 DELETE for Non-Collection Resources
If the DELETE method is issued to a non-collection resource which is If the DELETE method is issued to a non-collection resource which is
an internal member of a collection, then during DELETE processing a an internal member of a collection, then during DELETE processing a
server MUST remove the Request-URI from its parent collection. server MUST remove the Request-URI from its parent collection.
7.6.2 DELETE for Collections 8.6.2 DELETE for Collections
The DELETE method on a collection MUST act as if a "Depth: infinity" The DELETE method on a collection MUST act as if a "Depth: infinity"
header was used on it. A client MUST NOT submit a Depth header with header was used on it. A client MUST NOT submit a Depth header with
a DELETE on a collection with any value but infinity. a DELETE on a collection with any value but infinity.
DELETE instructs that the collection specified in the request-URI DELETE instructs that the collection specified in the Request-URI
and all its internal member resources are to be deleted. and all its internal member resources are to be deleted.
If any member cannot be deleted then all of the member's ancestors If any member cannot be deleted then all of the member's ancestors
MUST NOT be deleted, so as to maintain the namespace. MUST NOT be deleted, so as to maintain the namespace.
Any headers included with DELETE MUST be applied in processing every Any headers included with DELETE MUST be applied in processing every
resource to be deleted. resource to be deleted.
When the DELETE method has completed processing it MUST return a When the DELETE method has completed processing it MUST return a
consistent namespace. consistent namespace.
If an error occurs with a resource other than the resource If an error occurs with a resource other than the resource
identified in the request URI then the response MUST be a 207 Multi- identified in the Request-URI then the response MUST be a 207
Status. 424 Method Failure errors SHOULD NOT be in the 207 Multi- (Multi-Status). 424 (Failed Dependency) errors SHOULD NOT be in the
Status. They can be safely left out because the client will know 207 (Multi-Status). They can be safely left out because the client
that the ancestors of a resource could not be deleted when the will know that the ancestors of a resource could not be deleted when
client receives an error for the ancestor's progeny. Additionally the client receives an error for the ancestor's progeny.
204 No Content errors SHOULD NOT be returned in the 207 Multi- Additionally 204 (No Content) errors SHOULD NOT be returned in the
Status. The reason for this prohibition is that 204 No Content is 207 (Multi-Status). The reason for this prohibition is that 204 (No
the default success code. Content) is the default success code.
7.6.2.1 Example - DELETE 8.6.2.1 Example - DELETE
>>Request >>Request
DELETE /container/ HTTP/1.1 DELETE /container/ HTTP/1.1
Host: www.foo.bar Host: www.foo.bar
>>Response >>Response
HTTP/1.1 207 Multi-Status HTTP/1.1 207 Multi-Status
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xxxxx Content-Length: xxxxx
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="d" ?> <d:multistatus xmlns:d="DAV:">
<d:multistatus>
<d:response> <d:response>
<d:href>http://www.foo.bar/container/resource3</d:href> <d:href>http://www.foo.bar/container/resource3</d:href>
<d:status>HTTP/1.1 423 Locked</d:status> <d:status>HTTP/1.1 423 Locked</d:status>
</d:response> </d:response>
</d:multistatus> </d:multistatus>
In this example the attempt to delete In this example the attempt to delete
http://www.foo.bar/container/resource3 failed because it is locked, http://www.foo.bar/container/resource3 failed because it is locked,
and no lock token was submitted with the request. Consequently, the and no lock token was submitted with the request. Consequently, the
attempt to delete http://www.foo.bar/container/ also failed. Thus attempt to delete http://www.foo.bar/container/ also failed. Thus
the client knows that the attempt to delete the client knows that the attempt to delete
http://www.foo.bar/container/ must have also failed since the parent http://www.foo.bar/container/ must have also failed since the parent
can not be deleted unless its child has also been deleted. Even can not be deleted unless its child has also been deleted. Even
though a Depth header has not been included, a depth of infinity is though a Depth header has not been included, a depth of infinity is
assumed because the method is on a collection. assumed because the method is on a collection.
7.7 PUT 8.7 PUT
7.7.1 PUT for Non-Collection Resources 8.7.1 PUT for Non-Collection Resources
A PUT performed on an existing resource replaces the GET response A PUT performed on an existing resource replaces the GET response
entity of the resource. Properties defined on the resource may be entity of the resource. Properties defined on the resource may be
recomputed during PUT processing but are not otherwise affected. recomputed during PUT processing but are not otherwise affected.
For example, if a server recognizes the content type of the request For example, if a server recognizes the content type of the request
body, it may be able to automatically extract information that could body, it may be able to automatically extract information that could
be profitably exposed as properties. be profitably exposed as properties.
A PUT that would result in the creation of a resource without an A PUT that would result in the creation of a resource without an
appropriately scoped parent collection MUST fail with a 409 appropriately scoped parent collection MUST fail with a 409
Conflict. (Conflict).
7.7.2 PUT for Collections 8.7.2 PUT for Collections
As defined in the HTTP/1.1 specification [Fielding et al., 1997], As defined in the HTTP/1.1 specification [RFC2068], the "PUT method
the "PUT method requests that the enclosed entity be stored under requests that the enclosed entity be stored under the supplied
the supplied Request-URI." Since submission of an entity Request-URI." Since submission of an entity representing a
representing a collection would implicitly encode creation and collection would implicitly encode creation and deletion of
deletion of resources, this specification intentionally does not resources, this specification intentionally does not define a
define a transmission format for creating a collection using PUT. transmission format for creating a collection using PUT. Instead,
Instead, the MKCOL method is defined to create collections. the MKCOL method is defined to create collections.
When the PUT operation creates a new non-collection resource all When the PUT operation creates a new non-collection resource all
ancestors MUST already exist. If all ancestors do not exist, the ancestors MUST already exist. If all ancestors do not exist, the
method MUST fail with a 409 Conflict status code. For example, if method MUST fail with a 409 (Conflict) status code. For example, if
resource /a/b/c/d.html is to be created and /a/b/c/ does not exist, resource /a/b/c/d.html is to be created and /a/b/c/ does not exist,
then the request must fail. then the request must fail.
7.8 COPY Method 8.8 COPY Method
The COPY method creates a duplicate of the source resource, given by The COPY method creates a duplicate of the source resource, given by
the Request-URI, in the destination resource, given by the the Request-URI, in the destination resource, given by the
Destination header. The Destination header MUST be present. The Destination header. The Destination header MUST be present. The
exact behavior of the COPY method depends on the type of the source exact behavior of the COPY method depends on the type of the source
resource. resource.
All WebDAV compliant resources MUST support the COPY method. All WebDAV compliant resources MUST support the COPY method.
However, support for the COPY method does not guarantee the ability However, support for the COPY method does not guarantee the ability
to copy a resource. For example, separate programs may control to copy a resource. For example, separate programs may control
resources on the same server. As a result, it may not be possible resources on the same server. As a result, it may not be possible
to copy a resource to a location that appears to be on the same to copy a resource to a location that appears to be on the same
server. server.
7.8.1 COPY for HTTP/1.1 resources 8.8.1 COPY for HTTP/1.1 resources
When the source resource is not a collection the result of the COPY When the source resource is not a collection the result of the COPY
method is the creation of a new resource at the destination whose method is the creation of a new resource at the destination whose
state and behavior match that of the source resource as closely as state and behavior match that of the source resource as closely as
possible. However, the exact state and behavior of the destination possible. After a successful COPY invocation, all properties on the
resource depend on what information the source resource is able to source resource MUST be duplicated on the destination resource,
provide and what information the destination resource is able to subject to modifying headers and XML elements, following the
accept. definition for copying properties. Since the environment at the
destination may be different than at the source due to factors
Subsequent alterations to the destination resource will not modify outside the scope of control of the server, such as the absence of
the source resource. Subsequent alterations to the source resource resources required for correct operation, it may not be possible to
will not modify the destination resource. completely duplicate the behavior of the resource at the
destination. Subsequent alterations to the destination resource will
All properties on the source resource MUST be duplicated on the not modify the source resource. Subsequent alterations to the
destination resource, subject to modifying headers and XML elements, source resource will not modify the destination resource.
following the definition for copying properties.
7.8.2 COPY for Properties 8.8.2 COPY for Properties
The following section defines how properties on a resource are The following section defines how properties on a resource are
handled during a COPY operation. handled during a COPY operation.
Live properties SHOULD be duplicated as identically behaving live Live properties SHOULD be duplicated as identically behaving live
properties at the destination resource. If a property cannot be properties at the destination resource. If a property cannot be
copied live, then its value MUST be duplicated, octet-for-octet, in copied live, then its value MUST be duplicated, octet-for-octet, in
an identically named, dead property on the destination resource an identically named, dead property on the destination resource
subject to the effects of the propertybehavior XML element. subject to the effects of the propertybehavior XML element.
The propertybehavior XML element can specify that properties are The propertybehavior XML element can specify that properties are
copied on best effort, that all live properties must be successfully copied on best effort, that all live properties must be successfully
copied or the method must fail, or that a specified list of live copied or the method must fail, or that a specified list of live
properties must be successfully copied or the method must fail. The properties must be successfully copied or the method must fail. The
propertybehavior XML element is defined in section 11.12. propertybehavior XML element is defined in section 12.12.
7.8.3 COPY for Collections 8.8.3 COPY for Collections
The COPY method on a collection without a Depth header MUST act as The COPY method on a collection without a Depth header MUST act as
if a Depth header with value "infinity" was included. A client may if a Depth header with value "infinity" was included. A client may
submit a Depth header on a COPY on a collection with a value of "0" submit a Depth header on a COPY on a collection with a value of "0"
or "infinity". DAV compliant servers MUST support the "0" and or "infinity". DAV compliant servers MUST support the "0" and
"infinity" Depth header behaviors. "infinity" Depth header behaviors.
A COPY of depth infinity instructs that the collection specified in A COPY of depth infinity instructs that the collection specified in
the Request-URI is to be copied to the location specified in the the Request-URI is to be copied to the location specified in the
Destination header, and all its internal member resources are to be Destination header, and all its internal member resources are to be
copied to a location relative to it, recursively through all levels copied to a location relative to it, recursively through all levels
of the collection hierarchy. of the collection hierarchy.
A COPY of depth "0" only instructs that the collection and its A COPY of "Depth: 0" only instructs that the collection and its
properties but not its internal members, are to be copied. properties but not its internal members, are to be copied.
Any headers included with a COPY MUST be applied in processing every Any headers included with a COPY MUST be applied in processing every
resource to be copied with the exception of the Destination header. resource to be copied with the exception of the Destination header.
The Destination header only specifies the destination for the The Destination header only specifies the destination for the
Request-URI. When applied to members of the collection specified in Request-URI. When applied to members of the collection specified in
the request-URI the value of Destination is to be modified to the Request-URI the value of Destination is to be modified to
reflect the current location in the hierarchy. So, if the request- reflect the current location in the hierarchy. So, if the Request-
URI is /a/ and the destination is /b/ then when /a/c/d is processed URI is /a/ and the destination is /b/ then when /a/c/d is processed
it must use a destination of /b/c/d. it must use a destination of /b/c/d.
When the COPY method has completed processing it MUST have created a When the COPY method has completed processing it MUST have created a
consistent namespace at the destination. However, if an error consistent namespace at the destination (see section 5.1 for the
occurs while copying an internal member collection, the server MUST definition of namespace consistency). However, if an error occurs
NOT copy any members of this collection. After detecting an error, while copying an internal member collection, the server MUST NOT
the COPY operation SHOULD try to finish as much of the original copy copy any members of this collection (i.e., the server must skip this
operation as possible. So, for example, if an infinite depth copy subtree), as this would create an inconsistent namespace. After
operation is performed on collection /a/, which contains collections detecting an error, the COPY operation SHOULD try to finish as much
/a/b/ and /a/c/, and an error occurs copying /a/b/, an attempt of the original copy operation as possible (i.e., the server should
should still be made to copy /a/c/. Similarly, after encountering an still attempt to copy other subtrees and their members, that are not
error copying a non-collection resource as part of an infinite depth descendents of an error-causing collection). So, for example, if an
copy, the server SHOULD try to finish as much of the original copy infinite depth copy operation is performed on collection /a/, which
operation as possible. contains collections /a/b/ and /a/c/, and an error occurs copying
/a/b/, an attempt should still be made to copy /a/c/. Similarly,
after encountering an error copying a non-collection resource as
part of an infinite depth copy, the server SHOULD try to finish as
much of the original copy operation as possible.
If an error in executing the COPY method occurs with a resource If an error in executing the COPY method occurs with a resource
other than the resource identified in the request URI then the other than the resource identified in the Request-URI then the
response MUST be a 207 Multi-Status. response MUST be a 207 (Multi-Status).
424 Method Failure errors SHOULD NOT be returned in the 207 Multi- The 424 (Failed Dependency) status code SHOULD NOT be returned in
Status from a COPY method. These responses can be safely omitted the 207 (Multi-Status) response from a COPY method. These responses
because the client will know that the progeny of a resource could can be safely omitted because the client will know that the progeny
not be copied when the client receives an error for the parent. of a resource could not be copied when the client receives an error
Additionally 201 Created/204 No Content response codes SHOULD NOT be for the parent. Additionally 201 (Created)/204 (No Content) status
returned as values in 207 Multi-Status responses from COPY methods. codes SHOULD NOT be returned as values in 207 (Multi-Status)
They, too, can be safely omitted because they are the default responses from COPY methods. They, too, can be safely omitted
success codes. because they are the default success codes.
7.8.4 COPY and the Overwrite Header 8.8.4 COPY and the Overwrite Header
If a resource exists at the destination and the Overwrite header is If a resource exists at the destination and the Overwrite header is
"T" then prior to performing the copy the server MUST perform a "T" then prior to performing the copy the server MUST perform a
DELETE with Depth Infinity on the destination resource. If the DELETE with "Depth: infinity" on the destination resource. If the
Overwrite header is set to "F" then the operation will fail. Overwrite header is set to "F" then the operation will fail.
7.8.5 Status Codes 8.8.5 Status Codes
201 Created - The source resource was successfully copied. The copy 201 (Created) - The source resource was successfully copied. The
operation resulted in the creation of a new resource. copy operation resulted in the creation of a new resource.
204 No Content - The source resource was successfully copied to a 204 (No Content) - The source resource was successfully copied to a
pre-existing destination resource. pre-existing destination resource.
412 Precondition Failed - The server was unable to maintain the 403 (Forbidden) _ The source and destination URIs are the same.
409 (Conflict) _ A resource cannot be created at the destination
until one or more intermediate collections have been created.
412 (Precondition Failed) - The server was unable to maintain the
liveness of the properties listed in the propertybehavior XML liveness of the properties listed in the propertybehavior XML
element or the Overwrite header is "F" and the state of the element or the Overwrite header is "F" and the state of the
destination resource is non-null. destination resource is non-null.
423 Locked - The destination resource was locked. 423 (Locked) - The destination resource was locked.
425 Insufficient Space on Resource - The destination resource does 507 (Insufficient Storage) - The destination resource does not have
not have sufficient space to record the state of the resource after sufficient space to record the state of the resource after the
the execution of this method. execution of this method.
502 Bad Gateway - This may occur when the destination is on another 502 (Bad Gateway) - This may occur when the destination is on
server and the destination server refuses to accept the resource. another server and the destination server refuses to accept the
resource.
7.8.6 Example - COPY with Overwrite 8.8.6 Example - COPY with Overwrite
This example shows resource This example shows resource
http://www.ics.uci.edu/~fielding/index.html being copied to the http://www.ics.uci.edu/~fielding/index.html being copied to the
location http://www.ics.uci.edu/users/f/fielding/index.html. The location http://www.ics.uci.edu/users/f/fielding/index.html. The
204 No Content status code indicates the existing resource at the 204 (No Content) status code indicates the existing resource at the
destination was overwritten. destination was overwritten.
>>Request >>Request
COPY /~fielding/index.html HTTP/1.1 COPY /~fielding/index.html HTTP/1.1
Host: www.ics.uci.edu Host: www.ics.uci.edu
Destination: http://www.ics.uci.edu/users/f/fielding/index.html Destination: http://www.ics.uci.edu/users/f/fielding/index.html
>>Response >>Response
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
7.8.7 Example - COPY with No Overwrite 8.8.7 Example - COPY with No Overwrite
The following example shows the same copy operation being performed, The following example shows the same copy operation being performed,
but with the Overwrite header set to "F." A response of 412 but with the Overwrite header set to "F." A response of 412
Precondition Failed is returned because the destination resource has (Precondition Failed) is returned because the destination resource
a non-null state. has a non-null state.
>>Request >>Request
COPY /~fielding/index.html HTTP/1.1 COPY /~fielding/index.html HTTP/1.1
Host: www.ics.uci.edu Host: www.ics.uci.edu
Destination: http://www.ics.uci.edu/users/f/fielding/index.html Destination: http://www.ics.uci.edu/users/f/fielding/index.html
Overwrite: F Overwrite: F
>>Response >>Response
HTTP/1.1 412 Precondition Failed HTTP/1.1 412 Precondition Failed
7.8.8 Example - COPY of a Collection 8.8.8 Example - COPY of a Collection
>>Request >>Request
COPY /container/ HTTP/1.1 COPY /container/ HTTP/1.1
Host: www.foo.bar Host: www.foo.bar
Destination: http://www.foo.bar/othercontainer/ Destination: http://www.foo.bar/othercontainer/
Depth: infinity Depth: infinity
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xxxxx Content-Length: xxxxx
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="d" ?> <d:propertybehavior xmlns:d="DAV:">
<d:propertybehavior>
<d:keepalive>*</d:keepalive> <d:keepalive>*</d:keepalive>
</d:propertybehavior> </d:propertybehavior>
>>Response >>Response
HTTP/1.1 207 Multi-Status HTTP/1.1 207 Multi-Status
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xxxxx Content-Length: xxxxx
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="d" ?> <d:multistatus xmlns:d="DAV:">
<d:multistatus>
<d:response> <d:response>
<d:href>http://www.foo.bar/othercontainer/R2/</d:href> <d:href>http://www.foo.bar/othercontainer/R2/</d:href>
<d:status>HTTP/1.1 412 Precondition Failed</d:status> <d:status>HTTP/1.1 412 Precondition Failed</d:status>
</d:response> </d:response>
</d:multistatus> </d:multistatus>
The Depth header is unnecessary as the default behavior of COPY on a The Depth header is unnecessary as the default behavior of COPY on a
collection is to act as if a "Depth: infinity" header had been collection is to act as if a "Depth: infinity" header had been
submitted. In this example most of the resources, along with the submitted. In this example most of the resources, along with the
collection, were copied successfully. However the collection R2 collection, were copied successfully. However the collection R2
failed, most likely due to a problem with maintaining the liveness failed, most likely due to a problem with maintaining the liveness
of properties (this is specified by the propertybehavior XML of properties (this is specified by the propertybehavior XML
element). Because there was an error copying R2, none of R2's element). Because there was an error copying R2, none of R2's
members were copied. However no errors were listed for those members were copied. However no errors were listed for those
members due to the error minimization rules given in section 7.8.3. members due to the error minimization rules given in section 8.8.3.
7.9 MOVE Method 8.9 MOVE Method
The MOVE operation on a non-collection resource is the logical The MOVE operation on a non-collection resource is the logical
equivalent of a copy (COPY) followed by a delete of the source, equivalent of a copy (COPY) followed by a delete of the source,
where the actions are performed atomically. Consequently, the where the actions are performed atomically. Consequently, the
Destination header MUST be present on all MOVE methods and MUST Destination header MUST be present on all MOVE methods and MUST
follow all COPY requirements for the COPY part of the MOVE method. follow all COPY requirements for the COPY part of the MOVE method.
All DAV compliant resources MUST support the MOVE method. However, All DAV compliant resources MUST support the MOVE method. However,
support for the MOVE method does not guarantee the ability to move a support for the MOVE method does not guarantee the ability to move a
resource to a particular destination. resource to a particular destination.
For example, separate programs may actually control different sets For example, separate programs may actually control different sets
of resources on the same server. Therefore, it may not be possible of resources on the same server. Therefore, it may not be possible
to move a resource within a namespace that appears to belong to the to move a resource within a namespace that appears to belong to the
same server. same server.
If a resource exists at the destination, the destination resource If a resource exists at the destination, the destination resource
will be DELETEd as a side-effect of the MOVE operation, subject to will be DELETEd as a side-effect of the MOVE operation, subject to
the restrictions of the Overwrite header. the restrictions of the Overwrite header.
7.9.1 MOVE for Properties 8.9.1 MOVE for Properties
The behavior of properties on a MOVE, including the effects of the The behavior of properties on a MOVE, including the effects of the
propertybehavior XML element, MUST be the same as specified in propertybehavior XML element, MUST be the same as specified in
section 7.8.2. section 8.8.2.
7.9.2 MOVE for Collections 8.9.2 MOVE for Collections
A MOVE of depth infinity instructs that the collection specified in A MOVE with "Depth: infinity" instructs that the collection
the Request-URI be moved to the location specified in the specified in the Request-URI be moved to the location specified in
Destination header, and all its internal member resources are to be the Destination header, and all its internal member resources are to
moved to locations relative to it, recursively through all levels of be moved to locations relative to it, recursively through all levels
the collection hierarchy. of the collection hierarchy.
The MOVE method on a collection MUST act as if a Depth "infinity" The MOVE method on a collection MUST act as if a "Depth: infinity"
header was used on it. A client MUST NOT submit a Depth header on a header was used on it. A client MUST NOT submit a Depth header on a
MOVE on a collection with any value but "infinity". MOVE on a collection with any value but "infinity".
Any headers included with MOVE MUST be applied in processing every Any headers included with MOVE MUST be applied in processing every
resource to be moved with the exception of the Destination header. resource to be moved with the exception of the Destination header.
The behavior of the Destination header is the same as given for COPY The behavior of the Destination header is the same as given for COPY
on collections. on collections.
When the MOVE method has completed processing it MUST have created a When the MOVE method has completed processing it MUST have created a
consistent namespace on both the source and destination. However, if consistent namespace on both the source and destination (see section
an error occurs while moving an internal member collection, the 5.1 for the definition of namespace consistency). However, if an
server MUST NOT move any members of the failed collection.. In this error occurs while moving an internal member collection, the server
case, after detecting the error, the move operation SHOULD try to MUST NOT move any members of the failed collection (i.e., the server
finish as much of the original move as possible. So, for example, must skip the error-causing subtree), as this would create an
if an infinite depth move is performed on collection /a/, which inconsistent namespace. In this case, after detecting the error, the
contains collections /a/b/ and /a/c/, and an error occurs moving move operation SHOULD try to finish as much of the original move as
/a/b/, an attempt should still be made to try moving /a/c/. possible (i.e., the server should still attempt to move other
Similarly, after encountering an error moving a non-collection subtrees and their members, that are not descendents of an error-
resource as part of an infinite depth move, the server SHOULD try to causing collection). So, for example, if an infinite depth move is
finish as much of the original move operation as possible. performed on collection /a/, which contains collections /a/b/ and
/a/c/, and an error occurs moving /a/b/, an attempt should still be
made to try moving /a/c/. Similarly, after encountering an error
moving a non-collection resource as part of an infinite depth move,
the server SHOULD try to finish as much of the original move
operation as possible.
If an error occurs with a resource other than the resource If an error occurs with a resource other than the resource
identified in the request URI then the response MUST be a 207 Multi- identified in the Request-URI then the response MUST be a 207
Status. (Multi-Status).
424 Method Failure errors SHOULD NOT be returned as values in the The 424 (Failed Dependency) status code SHOULD NOT be returned in
207 Multi-Status from a MOVE method. These errors can be safely the 207 (Multi-Status) response from a MOVE method. These errors
omitted because the client will know that the progeny of a resource can be safely omitted because the client will know that the progeny
could not be moved when the client receives an error for the parent. of a resource could not be moved when the client receives an error
Additionally 201 Created/204 No Content responses SHOULD NOT be for the parent. Additionally 201 (Created)/204 (No Content)
returned as values in 207 Multi-Status responses from MOVES. These responses SHOULD NOT be returned as values in 207 (Multi-Status)
responses can be safely omitted because they are the default success responses from a MOVE. These responses can be safely omitted
codes. because they are the default success codes.
7.9.3 MOVE and the Overwrite Header 8.9.3 MOVE and the Overwrite Header
If a resource exists at the destination and the Overwrite header is If a resource exists at the destination and the Overwrite header is
"T" then prior to performing the move the server MUST perform a "T" then prior to performing the move the server MUST perform a
DELETE with Depth infinity on the destination resource. If the DELETE with "Depth: infinity" on the destination resource. If the
Overwrite header is set to "F" then the operation will fail. Overwrite header is set to "F" then the operation will fail.
7.9.4 Status Codes 8.9.4 Status Codes
201 Created - The source resource was successfully moved, and a new 201 (Created) - The source resource was successfully moved, and a
resource was created at the destination. new resource was created at the destination.
204 No Content - The source resource was successfully moved to a 204 (No Content) - The source resource was successfully moved to a
pre-existing destination resource. pre-existing destination resource.
412 Precondition Failed - The server was unable to maintain the 403 (Forbidden) _ The source and destination URIs are the same.
409 (Conflict) _ A resource cannot be created at the destination
until one or more intermediate collections have been created.
412 (Precondition Failed) - The server was unable to maintain the
liveness of the properties listed in the propertybehavior XML liveness of the properties listed in the propertybehavior XML
element or the Overwrite header is "F" and the state of the element or the Overwrite header is "F" and the state of the
destination resource is non-null. destination resource is non-null.
423 Locked - The source or the destination resource was locked. 423 (Locked) - The source or the destination resource was locked.
502 Bad Gateway - This may occur when the destination is on another 502 (Bad Gateway) - This may occur when the destination is on
server and the destination server refuses to accept the resource. another server and the destination server refuses to accept the
resource.
7.9.5 Example - MOVE of a Non-Collection 8.9.5 Example - MOVE of a Non-Collection
This example shows resource This example shows resource
http://www.ics.uci.edu/~fielding/index.html being moved to the http://www.ics.uci.edu/~fielding/index.html being moved to the
location http://www.ics.uci.edu/users/f/fielding/index.html. The location http://www.ics.uci.edu/users/f/fielding/index.html. The
contents of the destination resource would have been overwritten if contents of the destination resource would have been overwritten if
the destination resource had been non-null. In this case, since the destination resource had been non-null. In this case, since
there was nothing at the destination resource, the response code is there was nothing at the destination resource, the response code is
201 Created. 201 (Created).
>>Request >>Request
MOVE /~fielding/index.html HTTP/1.1 MOVE /~fielding/index.html HTTP/1.1
Host: www.ics.uci.edu Host: www.ics.uci.edu
Destination: http://www.ics.uci.edu/users/f/fielding/index.html Destination: http://www.ics.uci.edu/users/f/fielding/index.html
>>Response >>Response
HTTP/1.1 201 Created HTTP/1.1 201 Created
Content-Location: http://www.ics.uci.edu/users/f/fielding/index.html Location: http://www.ics.uci.edu/users/f/fielding/index.html
7.9.6 Example - MOVE of a Collection 8.9.6 Example - MOVE of a Collection
>>Request >>Request
MOVE /container/ HTTP/1.1 MOVE /container/ HTTP/1.1
Host: www.foo.bar Host: www.foo.bar
Destination: http://www.foo.bar/othercontainer/ Destination: http://www.foo.bar/othercontainer/
Overwrite: F Overwrite: F
If: (<opaquelocktoken:fe184f2e-6eec-41d0-c765-01adc56e6bb4>) If: (<opaquelocktoken:fe184f2e-6eec-41d0-c765-01adc56e6bb4>)
(<opaquelocktoken:e454f3f3-acdc-452a-56c7-00a5c91e4b77>) (<opaquelocktoken:e454f3f3-acdc-452a-56c7-00a5c91e4b77>)
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xyz Content-Length: xyz
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="d" ?> <d:propertybehavior xmlns:d='DAV:'>
<d:propertybehavior>
<d:keepalive>*</d:keepalive> <d:keepalive>*</d:keepalive>
</d:propertybehavior> </d:propertybehavior>
>>Response >>Response
HTTP/1.1 207 Multi-Status HTTP/1.1 207 Multi-Status
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: zzz Content-Length: zzz
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="d" ?> <d:multistatus xmlns:d='DAV:'>
<d:multistatus>
<d:response> <d:response>
<d:href>http://www.foo.bar/othercontainer/C2/</d:href> <d:href>http://www.foo.bar/othercontainer/C2/</d:href>
<d:status>HTTP/1.1 423 Locked</d:status> <d:status>HTTP/1.1 423 Locked</d:status>
</d:response> </d:response>
</d:multistatus> </d:multistatus>
In this example the client has submitted a number of lock tokens In this example the client has submitted a number of lock tokens
with the request. A lock token will need to be submitted for every with the request. A lock token will need to be submitted for every
resource, both source and destination, anywhere in the scope of the resource, both source and destination, anywhere in the scope of the
method, that is locked. In this case the proper lock token was not method, that is locked. In this case the proper lock token was not
submitted for the destination http://www.foo.bar/othercontainer/C2/. submitted for the destination http://www.foo.bar/othercontainer/C2/.
This means that the resource /container/C2/ could not be moved. This means that the resource /container/C2/ could not be moved.
Because there was an error copying /container/C2/, none of Because there was an error copying /container/C2/, none of
/container/C2's members were copied. However no errors were listed /container/C2's members were copied. However no errors were listed
for those members due to the error minimization rules given in for those members due to the error minimization rules given in
section 7.8.3. User agent authentication has previously occurred section 8.8.3. User agent authentication has previously occurred
via a mechanism outside the scope of the HTTP protocol, in an via a mechanism outside the scope of the HTTP protocol, in an
underlying transport layer. underlying transport layer.
7.10 LOCK Method 8.10 LOCK Method
The following sections describe the LOCK method, which is used to The following sections describe the LOCK method, which is used to
take out a lock of any access type. These sections on the LOCK take out a lock of any access type. These sections on the LOCK
method describe only those semantics that are specific to the LOCK method describe only those semantics that are specific to the LOCK
method and are independent of the access type of the lock being method and are independent of the access type of the lock being
requested. requested.
Any resource which supports the LOCK method MUST, at minimum, Any resource which supports the LOCK method MUST, at minimum,
support the XML request and response formats defined herein. support the XML request and response formats defined herein.
7.10.1 Operation 8.10.1 Operation
A LOCK method invocation creates the lock specified by the lockinfo A LOCK method invocation creates the lock specified by the lockinfo
XML element on the Request-URI. Lock method requests SHOULD have a XML element on the Request-URI. Lock method requests SHOULD have a
XML request body which contains an owner XML element for this lock XML request body which contains an owner XML element for this lock
request, unless this is a refresh request. The LOCK request may have request, unless this is a refresh request. The LOCK request may have
a Timeout header. a Timeout header.
Clients MUST assume that locks may arbitrarily disappear at any Clients MUST assume that locks may arbitrarily disappear at any
time, regardless of the value given in the Timeout header. The time, regardless of the value given in the Timeout header. The
Timeout header only indicates the behavior of the server if Timeout header only indicates the behavior of the server if
"extraordinary" circumstances do not occur. For example, an "extraordinary" circumstances do not occur. For example, an
administrator may remove a lock at any time or the system may crash administrator may remove a lock at any time or the system may crash
in such a way that it loses the record of the lock's existence. The in such a way that it loses the record of the lock's existence. The
response MUST contain the value of the lockdiscovery property in a response MUST contain the value of the lockdiscovery property in a
prop XML element. prop XML element.
7.10.2 The Effect of Locks on Properties and Collections In order to indicate the lock token associated with a newly created
lock, a Lock-Token response header MUST be included in the response
for every successful LOCK request for a new lock. Note that the
Lock-Token header would not be returned in the response for a
successful refresh LOCK request because a new lock was not created.
8.10.2 The Effect of Locks on Properties and Collections
The scope of a lock is the entire state of the resource, including The scope of a lock is the entire state of the resource, including
its body and associated properties. As a result, a lock on a its body and associated properties. As a result, a lock on a
resource MUST also lock the resource's properties. resource MUST also lock the resource's properties.
For collections, a lock also affects the ability to add or remove For collections, a lock also affects the ability to add or remove
members. The nature of the effect depends upon the type of access members. The nature of the effect depends upon the type of access
control involved. control involved.
7.10.3 Locking Replicated Resources 8.10.3 Locking Replicated Resources
Some servers automatically replicate resources across multiple URLs. A resource may be made available through more than one URI. However
In such a circumstance the server MUST only accept a lock on one of locks apply to resources, not URIs. Therefore a LOCK request on a
the URLs if the server can guarantee that the lock will be honored resource MUST NOT succeed if can not be honored by all the URIs
across all the URLs. through which the resource is addressable.
7.10.4 Depth and Locking 8.10.4 Depth and Locking
The Depth header may be used with the LOCK method. Values other The Depth header may be used with the LOCK method. Values other
than 0 or infinity MUST NOT be used with the Depth header on a LOCK than 0 or infinity MUST NOT be used with the Depth header on a LOCK
method. All resources that support the LOCK method MUST support the method. All resources that support the LOCK method MUST support the
Depth header. Depth header.
A Depth header of value 0 means to just lock the resource specified A Depth header of value 0 means to just lock the resource specified
by the request-URI. by the Request-URI.
If the Depth header is set to infinity then the resource specified If the Depth header is set to infinity then the resource specified
in the request-URI along with all its internal members, all the way in the Request-URI along with all its internal members, all the way
down the hierarchy, are to be locked. A successful result MUST down the hierarchy, are to be locked. A successful result MUST
return a single lock token which represents all the resources that return a single lock token which represents all the resources that
have been locked. If an UNLOCK is successfully executed on this have been locked. If an UNLOCK is successfully executed on this
token, all associated resources are unlocked. If the lock cannot be token, all associated resources are unlocked. If the lock cannot be
granted to all resources, a 409 Conflict status code MUST be granted to all resources, a 409 (Conflict) status code MUST be
returned with a response entity body containing a multistatus XML returned with a response entity body containing a multistatus XML
element describing which resource(s) prevented the lock from being element describing which resource(s) prevented the lock from being
granted. Hence, partial success is not an option. Either the granted. Hence, partial success is not an option. Either the
entire hierarchy is locked or no resources are locked. entire hierarchy is locked or no resources are locked.
If no depth header is submitted on a LOCK request then the request If no Depth header is submitted on a LOCK request then the request
MUST act as if a Depth of infinity had been submitted. MUST act as if a "Depth:infinity" had been submitted.
7.10.5 Interaction with other Methods 8.10.5 Interaction with other Methods
The interaction of a LOCK with various methods is dependent upon the The interaction of a LOCK with various methods is dependent upon the
lock type. However, independent of lock type, a successful DELETE lock type. However, independent of lock type, a successful DELETE
of a resource MUST cause all of its locks to be removed. of a resource MUST cause all of its locks to be removed.
7.10.6 Lock Compatibility Table 8.10.6 Lock Compatibility Table
The table below describes the behavior that occurs when a lock The table below describes the behavior that occurs when a lock
request is made on a resource. request is made on a resource.
Current lock state/ Shared Lock Exclusive Current lock state/ | Shared Lock | Exclusive
Lock request Lock Lock request | | Lock
None True True =====================+=================+===============
Shared Lock True False None | True | True
Exclusive Lock False False* ---------------------+-----------------+---------------
Shared Lock | True | False
---------------------+-----------------+---------------
Exclusive Lock | False | False*
-------------------------------------------------------
Legend: True = lock may be granted. False = lock MUST NOT be Legend: True = lock may be granted. False = lock MUST NOT be
granted. *=It is illegal for a principal to request the same lock granted. *=It is illegal for a principal to request the same lock
twice. twice.
The current lock state of a resource is given in the leftmost The current lock state of a resource is given in the leftmost
column, and lock requests are listed in the first row. The column, and lock requests are listed in the first row. The
intersection of a row and column gives the result of a lock request. intersection of a row and column gives the result of a lock request.
For example, if a shared lock is held on a resource, and an For example, if a shared lock is held on a resource, and an
exclusive lock is requested, the table entry is "false", indicating exclusive lock is requested, the table entry is "false", indicating
the lock must not be granted. the lock must not be granted.
7.10.7 Status Codes 8.10.7 Status Codes
200 Success - The lock request succeeded and the value of the 200 (OK) - The lock request succeeded and the value of the
lockdiscovery property is included in the body. lockdiscovery property is included in the body.
412 Precondition Failed - The included lock token was not 412 (Precondition Failed) - The included lock token was not
enforceable on this resource or the server could not satisfy the enforceable on this resource or the server could not satisfy the
request in the lockinfo XML element. request in the lockinfo XML element.
423 Locked - The resource is locked, so the method has been 423 (Locked) - The resource is locked, so the method has been
rejected. rejected.
7.10.8 Example - Simple Lock Request 8.10.8 Example - Simple Lock Request
>>Request >>Request
LOCK /workspace/webdav/proposal.doc HTTP/1.1 LOCK /workspace/webdav/proposal.doc HTTP/1.1
Host: webdav.sb.aol.com Host: webdav.sb.aol.com
Timeout: Infinite, Second-4100000000 Timeout: Infinite, Second-4100000000
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xyz Content-Length: xyz
Authorization: Digest username="ejw", Authorization: Digest username="ejw",
realm="ejw@webdav.sb.aol.com", nonce="...", realm="ejw@webdav.sb.aol.com", nonce="...",
uri="/workspace/webdav/proposal.doc", uri="/workspace/webdav/proposal.doc",
response="...", opaque="..." response="...", opaque="..."
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:lockinfo xmlns:D='DAV:'>
<D:lockinfo>
<D:lockscope><D:exclusive/></D:lockscope> <D:lockscope><D:exclusive/></D:lockscope>
<D:locktype><D:write/></D:locktype> <D:locktype><D:write/></D:locktype>
<D:owner> <D:owner>
<D:href>http://www.ics.uci.edu/~ejw/contact.html</D:href> <D:href>http://www.ics.uci.edu/~ejw/contact.html</D:href>
</D:owner> </D:owner>
</D:lockinfo> </D:lockinfo>
>>Response >>Response
HTTP/1.1 200 OK HTTP/1.1 200 OK
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xxxxx Content-Length: xxxxx
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:prop xmlns:D="DAV:">
<D:prop>
<D:lockdiscovery> <D:lockdiscovery>
<D:activelock> <D:activelock>
<D:locktype><D:write/></D:locktype> <D:locktype><D:write/></D:locktype>
<D:lockscope><D:exclusive/></D:lockscope> <D:lockscope><D:exclusive/></D:lockscope>
<D:depth>Infinity</D:depth> <D:depth>Infinity</D:depth>
<D:owner> <D:owner>
<D:href> <D:href>
http://www.ics.uci.edu/~ejw/contact.html http://www.ics.uci.edu/~ejw/contact.html
</D:href> </D:href>
</D:owner> </D:owner>
skipping to change at page 44, line 14 skipping to change at page 48, line 5
This example shows the successful creation of an exclusive write This example shows the successful creation of an exclusive write
lock on resource lock on resource
http://webdav.sb.aol.com/workspace/webdav/proposal.doc. The http://webdav.sb.aol.com/workspace/webdav/proposal.doc. The
resource http://www.ics.uci.edu/~ejw/contact.html contains contact resource http://www.ics.uci.edu/~ejw/contact.html contains contact
information for the owner of the lock. The server has an activity- information for the owner of the lock. The server has an activity-
based timeout policy in place on this resource, which causes the based timeout policy in place on this resource, which causes the
lock to automatically be removed after 1 week (604800 seconds). lock to automatically be removed after 1 week (604800 seconds).
Note that the nonce, response, and opaque fields have not been Note that the nonce, response, and opaque fields have not been
calculated in the Authorization request header. calculated in the Authorization request header.
7.10.9 Example - Refreshing a Write Lock 8.10.9 Example - Refreshing a Write Lock
>>Request >>Request
LOCK /workspace/webdav/proposal.doc HTTP/1.1 LOCK /workspace/webdav/proposal.doc HTTP/1.1
Host: webdav.sb.aol.com Host: webdav.sb.aol.com
Timeout: Infinite, Second-4100000000 Timeout: Infinite, Second-4100000000
If: (<opaquelocktoken:e71d4fae-5dec-22d6-fea5-00a0c91e6be4>) If: (<opaquelocktoken:e71d4fae-5dec-22d6-fea5-00a0c91e6be4>)
Authorization: Digest username="ejw", Authorization: Digest username="ejw",
realm="ejw@webdav.sb.aol.com", nonce="...", realm="ejw@webdav.sb.aol.com", nonce="...",
uri="/workspace/webdav/proposal.doc", uri="/workspace/webdav/proposal.doc",
response="...", opaque="..." response="...", opaque="..."
>>Response >>Response
HTTP/1.1 200 OK HTTP/1.1 200 OK
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xxxxx Content-Length: xxxxx
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:prop xmlns:D="DAV:">
<D:prop>
<D:lockdiscovery> <D:lockdiscovery>
<D:activelock> <D:activelock>
<D:locktype><D:write/></D:locktype> <D:locktype><D:write/></D:locktype>
<D:lockscope><D:exclusive/></D:lockscope> <D:lockscope><D:exclusive/></D:lockscope>
<D:depth>Infinity</D:depth> <D:depth>Infinity</D:depth>
<D:owner> <D:owner>
<D:href> <D:href>
http://www.ics.uci.edu/~ejw/contact.html http://www.ics.uci.edu/~ejw/contact.html
</D:href> </D:href>
</D:owner> </D:owner>
skipping to change at page 45, line 4 skipping to change at page 48, line 45
</D:owner> </D:owner>
<D:timeout>Second-604800</D:timeout> <D:timeout>Second-604800</D:timeout>
<D:locktoken> <D:locktoken>
<D:href> <D:href>
opaquelocktoken:e71d4fae-5dec-22d6-fea5-00a0c91e6be4 opaquelocktoken:e71d4fae-5dec-22d6-fea5-00a0c91e6be4
</D:href> </D:href>
</D:locktoken> </D:locktoken>
</D:activelock> </D:activelock>
</D:lockdiscovery> </D:lockdiscovery>
</D:prop> </D:prop>
This request would refresh the lock, resetting any time outs. This request would refresh the lock, resetting any time outs.
Notice that the client asked for an infinite time out but the server Notice that the client asked for an infinite time out but the server
choose to ignore the request. In this example, the nonce, response, choose to ignore the request. In this example, the nonce, response,
and opaque fields have not been calculated in the Authorization and opaque fields have not been calculated in the Authorization
request header. request header.
7.10.10 Example - Multi-Resource Lock Request 8.10.10 Example - Multi-Resource Lock Request
>>Request >>Request
LOCK /webdav/ HTTP/1.1 LOCK /webdav/ HTTP/1.1
Host: webdav.sb.aol.com Host: webdav.sb.aol.com
Timeout: Infinite, Second-4100000000 Timeout: Infinite, Second-4100000000
Depth: infinity Depth: infinity
Content-Type: text/xml; charset="utf-8"
Content-Length: xxxxx
Authorization: Digest username="ejw", Authorization: Digest username="ejw",
realm="ejw@webdav.sb.aol.com", nonce="...", realm="ejw@webdav.sb.aol.com", nonce="...",
uri="/workspace/webdav/proposal.doc", uri="/workspace/webdav/proposal.doc",
response="...", opaque="..." response="...", opaque="..."
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:lockinfo xmlns:D="DAV:">
<D:lockinfo>
<D:locktype><D:write/></D:locktype> <D:locktype><D:write/></D:locktype>
<D:lockscope><D:exclusive/></D:lockscope> <D:lockscope><D:exclusive/></D:lockscope>
<D:owner> <D:owner>
<D:href>http://www.ics.uci.edu/~ejw/contact.html</D:href> <D:href>http://www.ics.uci.edu/~ejw/contact.html</D:href>
</D:owner> </D:owner>
</D:lockinfo> </D:lockinfo>
>>Response >>Response
HTTP/1.1 207 Multi-Status HTTP/1.1 207 Multi-Status
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xxxxx Content-Length: xxxxx
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:multistatus xmlns:D="DAV:">
<D:multistatus>
<D:response> <D:response>
<D:href>http://webdav.sb.aol.com/webdav/secret</D:href> <D:href>http://webdav.sb.aol.com/webdav/secret</D:href>
<D:status>HTTP/1.1 403 Forbidden</D:status> <D:status>HTTP/1.1 403 Forbidden</D:status>
</D:response> </D:response>
<D:response> <D:response>
<D:href>http://webdav.sb.aol.com/webdav/</D:href> <D:href>http://webdav.sb.aol.com/webdav/</D:href>
<D:propstat> <D:propstat>
<D:prop><D:lockdiscovery/></D:prop> <D:prop><D:lockdiscovery/></D:prop>
<D:status>HTTP/1.1 424 Method Failure</D:status> <D:status>HTTP/1.1 424 Failed Dependency</D:status>
</D:propstat> </D:propstat>
</D:response> </D:response>
</D:multistatus> </D:multistatus>
This example shows a request for an exclusive write lock on a This example shows a request for an exclusive write lock on a
collection and all its children. In this request, the client has collection and all its children. In this request, the client has
specified that it desires an infinite length lock, if available, specified that it desires an infinite length lock, if available,
otherwise a timeout of 4.1 billion seconds, if available. The otherwise a timeout of 4.1 billion seconds, if available. The
request entity body contains the contact information for the request entity body contains the contact information for the
principal taking out the lock, in this case a web page URL. principal taking out the lock, in this case a web page URL.
The error is a 403 Forbidden response on the resource The error is a 403 (Forbidden) response on the resource
http://webdav.sb.aol.com/webdav/secret. Because this resource could http://webdav.sb.aol.com/webdav/secret. Because this resource could
not be locked, none of the resources were locked. Note also that not be locked, none of the resources were locked. Note also that
the lockdiscovery property for the Request-URI has been included as the lockdiscovery property for the Request-URI has been included as
required. In this example the lockdiscovery property is empty which required. In this example the lockdiscovery property is empty which
means that there are no outstanding locks on the resource. means that there are no outstanding locks on the resource.
In this example, the nonce, response, and opaque fields have not In this example, the nonce, response, and opaque fields have not
been calculated in the Authorization request header. been calculated in the Authorization request header.
7.11 UNLOCK Method 8.11 UNLOCK Method
The UNLOCK method removes the lock identified by the lock token in The UNLOCK method removes the lock identified by the lock token in
the Lock-Token request header from the Request-URI, and all other the Lock-Token request header from the Request-URI, and all other
resources included in the lock. If all resources which have been resources included in the lock. If all resources which have been
locked under the submitted lock token can not be unlocked then the locked under the submitted lock token can not be unlocked then the
UNLOCK request MUST fail. UNLOCK request MUST fail.
Any DAV compliant resource which supports the LOCK method MUST Any DAV compliant resource which supports the LOCK method MUST
support the UNLOCK method. support the UNLOCK method.
7.11.1 Example - UNLOCK 8.11.1 Example - UNLOCK
>>Request >>Request
UNLOCK /workspace/webdav/info.doc HTTP/1.1 UNLOCK /workspace/webdav/info.doc HTTP/1.1
Host: webdav.sb.aol.com Host: webdav.sb.aol.com
Lock-Token: <opaquelocktoken:a515cfa4-5da4-22e1-f5b5-00a0451e6bf7> Lock-Token: <opaquelocktoken:a515cfa4-5da4-22e1-f5b5-00a0451e6bf7>
Authorization: Digest username="ejw", Authorization: Digest username="ejw",
realm="ejw@webdav.sb.aol.com", nonce="...", realm="ejw@webdav.sb.aol.com", nonce="...",
uri="/workspace/webdav/proposal.doc", uri="/workspace/webdav/proposal.doc",
response="...", opaque="..." response="...", opaque="..."
>>Response >>Response
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
In this example, the lock identified by the lock token In this example, the lock identified by the lock token
"opaquelocktoken:a515cfa4-5da4-22e1-f5b5-00a0451e6bf7" is "opaquelocktoken:a515cfa4-5da4-22e1-f5b5-00a0451e6bf7" is
successfully removed from the resource successfully removed from the resource
http://webdav.sb.aol.com/workspace/webdav/info.doc. If this lock http://webdav.sb.aol.com/workspace/webdav/info.doc. If this lock
included more than just one resource, the lock is removed from all included more than just one resource, the lock is removed from all
resources included in the lock. The 204 status code is used instead resources included in the lock. The 204 (No Content) status code is
of 200 OK because there is no response entity body. used instead of 200 (OK) because there is no response entity body.
In this example, the nonce, response, and opaque fields have not In this example, the nonce, response, and opaque fields have not
been calculated in the Authorization request header. been calculated in the Authorization request header.
8 HTTP Headers for Distributed Authoring 9 HTTP Headers for Distributed Authoring
8.1 DAV Header 9.1 DAV Header
DAV = "DAV" ":" "1" ["," "2"] ["," 1#extend] DAV = "DAV" ":" "1" ["," "2"] ["," 1#extend]
This header indicates that the resource supports the DAV schema and This header indicates that the resource supports the DAV schema and
protocol as specified. All DAV compliant resources MUST return the protocol as specified. All DAV compliant resources MUST return the
DAV header on all OPTIONS responses. DAV header on all OPTIONS responses.
The value is a list of all compliance classes that the resource The value is a list of all compliance classes that the resource
supports. Note that above a comma has already been added to the 2. supports. Note that above a comma has already been added to the 2.
This is because a resource can not be level 2 compliant unless it is This is because a resource can not be level 2 compliant unless it is
also level 1 compliant. Please refer to section 14 for more details. also level 1 compliant. Please refer to section 15 for more details.
In general, however, support for one compliance class does not In general, however, support for one compliance class does not
entail support for any other. entail support for any other.
8.2 Depth Header 9.2 Depth Header
Depth = "Depth" ":" ("0" | "1" | "infinity") Depth = "Depth" ":" ("0" | "1" | "infinity")
The Depth header is used with methods executed on resources which The Depth header is used with methods executed on resources which
could potentially have internal members to indicate whether the could potentially have internal members to indicate whether the
method is to be applied only to the resource (Depth = 0), to the method is to be applied only to the resource ("Depth: 0"), to the
resource and its immediate children, (Depth = 1), or the resource resource and its immediate children, ("Depth: 1"), or the resource
and all its progeny (Depth = infinity). and all its progeny ("Depth: infinity").
The Depth header is only supported if a method's definition The Depth header is only supported if a method's definition
explicitly provides for such support. explicitly provides for such support.
The following rules are the default behavior for any method that The following rules are the default behavior for any method that
supports the Depth header. A method may override these defaults by supports the Depth header. A method may override these defaults by
defining different behavior in its definition. defining different behavior in its definition.
Methods which support the Depth header may choose not to support all Methods which support the Depth header may choose not to support all
of the header's values and may define, on a case by case basis, the of the header's values and may define, on a case by case basis, the
behavior of the method if a Depth header is not present. For behavior of the method if a Depth header is not present. For
example, the MOVE method only supports Depth = infinity and if a example, the MOVE method only supports "Depth: infinity" and if a
Depth header is not present will act as if a Depth = infinity header Depth header is not present will act as if a "Depth: infinity"
had been applied. header had been applied.
Clients MUST NOT rely upon methods executing on members of their Clients MUST NOT rely upon methods executing on members of their
hierarchies in any particular order or on the execution being atomic hierarchies in any particular order or on the execution being atomic
unless the particular method explicitly provides such guarantees. unless the particular method explicitly provides such guarantees.
Upon execution, a method with a Depth header will perform as much of Upon execution, a method with a Depth header will perform as much of
its assigned task as possible and then return a response specifying its assigned task as possible and then return a response specifying
what it was able to accomplish and what it failed to do. what it was able to accomplish and what it failed to do.
So, for example, an attempt to COPY a hierarchy may result in some So, for example, an attempt to COPY a hierarchy may result in some
of the members being copied and some not. of the members being copied and some not.
Any headers on a method that has a defined interaction with the Any headers on a method that has a defined interaction with the
Depth header MUST be applied to all resources in the scope of the Depth header MUST be applied to all resources in the scope of the
method except where alternative behavior is explicitly defined. For method except where alternative behavior is explicitly defined. For
example, an If-Match header will have its value applied against example, an If-Match header will have its value applied against
every resource in the method's scope and will cause the method to every resource in the method's scope and will cause the method to
fail if the header fails to match. fail if the header fails to match.
If a resource, source or destination, within the scope of the method If a resource, source or destination, within the scope of the method
with a depth header is locked in such a way as to prevent the with a Depth header is locked in such a way as to prevent the
successful execution of the method, then the lock token for that successful execution of the method, then the lock token for that
resource MUST be submitted with the request in the If request resource MUST be submitted with the request in the If request
header. header.
The Depth header only specifies the behavior of the method with The Depth header only specifies the behavior of the method with
regards to internal children. If a resource does not have internal regards to internal children. If a resource does not have internal
children then the Depth header MUST be ignored. children then the Depth header MUST be ignored.
Please note, however, that it is always an error to submit a value Please note, however, that it is always an error to submit a value
for the Depth header that is not allowed by the method's definition. for the Depth header that is not allowed by the method's definition.
Thus submitting a "Depth: 1" on a COPY, even if the resource does Thus submitting a "Depth: 1" on a COPY, even if the resource does
not have internal members, will result in a 400 Bad Request. The not have internal members, will result in a 400 (Bad Request). The
method should fail not because the resource doesn't have internal method should fail not because the resource doesn't have internal
members, but because of the illegal value in the header. members, but because of the illegal value in the header.
8.3 Destination Header 9.3 Destination Header
Destination = "Destination" ":" URI Destination = "Destination" ":" absoluteURI
The Destination header specifies a destination resource for methods The Destination header specifies a destination resource for methods
such as COPY and MOVE, which take two URIs as parameters. such as COPY and MOVE, which take two URIs as parameters. Note that
the absoluteURI production is defined in [RFC2396].
8.4 If Header 9.4 If Header
If = "If" ":" ( 1*No-tag-list | 1*Tagged-list) If = "If" ":" ( 1*No-tag-list | 1*Tagged-list)
No-tag-list = List No-tag-list = List
Tagged-list = Resource 1*List Tagged-list = Resource 1*List
Resource = Coded-url Resource = Coded-url
List = "(" 1*(["Not"](State-token | "[" entity-tag "]")) ")" List = "(" 1*(["Not"](State-token | "[" entity-tag "]")) ")"
State-token = Coded-url State-token = Coded-URL
Coded-url = "<" URI ">" Coded-URL = "<" absoluteURI ">"
The If header is intended to have similar functionality to the If- The If header is intended to have similar functionality to the If-
Match header defined in section 14.25 of [Fielding et al., 1997]. Match header defined in section 14.25 of [RFC2068]. However the If
However the If header is intended for use with any URI which header is intended for use with any URI which represents state
represents state information, referred to as a state token, about a information, referred to as a state token, about a resource as well
resource as well as e-tags. A typical example of a state token is a as ETags. A typical example of a state token is a lock token, and
lock token, and lock tokens are the only state tokens defined in lock tokens are the only state tokens defined in this specification.
this specification.
All DAV compliant resources MUST honor the If header. All DAV compliant resources MUST honor the If header.
The If header's purpose is to describe a series of state lists. If The If header's purpose is to describe a series of state lists. If
the state of the resource to which the header is applied does not the state of the resource to which the header is applied does not
match any of the specified state lists then the request MUST fail match any of the specified state lists then the request MUST fail
with a 412 Precondition Failed. If one of the described state lists with a 412 (Precondition Failed). If one of the described state
matches the state of the resource then the request may succeed. lists matches the state of the resource then the request may
succeed.
8.4.1 No-tag-list Production Note that the absoluteURI production is defined in [RFC2396].
The No-tag-list production describes a series of state tokens and e- 9.4.1 No-tag-list Production
tags. If multiple No-tag-list productions are used then only one
The No-tag-list production describes a series of state tokens and
ETags. If multiple No-tag-list productions are used then one only
needs to match the state of the resource for the method to be needs to match the state of the resource for the method to be
allowed to continue. allowed to continue.
If a method, due to the presence of a Depth or Destination header, If a method, due to the presence of a Depth or Destination header,
is applied to multiple resources then the No-tag-list production is applied to multiple resources then the No-tag-list production
MUST be applied to each resource the method is applied to. MUST be applied to each resource the method is applied to.
8.4.1.1 Example - No-tag-list If Header 9.4.1.1 Example - No-tag-list If Header
If: (<locktoken:a-write-lock-token> ["I am an e-tag"]) (["I am If: (<locktoken:a-write-lock-token> ["I am an ETag"]) (["I am
another e-tag"]) another ETag"])
The previous header would require that any resources within the The previous header would require that any resources within the
scope of the method must either be locked with the specified lock scope of the method must either be locked with the specified lock
token and in the state identified by the "I am an e-tag" e-tag or in token and in the state identified by the "I am an ETag" ETag or in
the state identified by the second e-tag "I am another e-tag". To the state identified by the second ETag "I am another ETag". To put
put the matter more plainly one can think of the previous If header the matter more plainly one can think of the previous If header as
as being in the form (or (and <locktoken:a-write-lock-token> ["I am being in the form (or (and <locktoken:a-write-lock-token> ["I am an
an e-tag"]) (and ["I am another e-tag"])). ETag"]) (and ["I am another ETag"])).
8.4.2 Tagged-list Production 9.4.2 Tagged-list Production
The tagged-list production scopes a list production. That is, it The tagged-list production scopes a list production. That is, it
specifies that the lists following the resource specification only specifies that the lists following the resource specification only
apply to the specified resource. The scope of the resource apply to the specified resource. The scope of the resource
production begins with the list production immediately following the production begins with the list production immediately following the
resource production and ends with the next resource production, if resource production and ends with the next resource production, if
any. any.
When the If header is applied to a particular resource, the Tagged- When the If header is applied to a particular resource, the Tagged-
list productions MUST be searched to determine if any of the listed list productions MUST be searched to determine if any of the listed
resources match the operand resource(s) for the current method. If resources match the operand resource(s) for the current method. If
none of the resource productions match the current resource then the none of the resource productions match the current resource then the
header MUST be ignored. If one of the resource productions does header MUST be ignored. If one of the resource productions does
match the name of the resource under consideration then the list match the name of the resource under consideration then the list
productions following the resource production MUST be applied to the productions following the resource production MUST be applied to the
resource in the manner specified in the previous section. resource in the manner specified in the previous section.
The same URI MUST NOT appear more than once in a resource production The same URI MUST NOT appear more than once in a resource production
in an If header. in an If header.
8.4.2.1 Example - Tagged List If header 9.4.2.1 Example - Tagged List If header
COPY /resource1 HTTP/1.1 COPY /resource1 HTTP/1.1
Host: www.foo.bar Host: www.foo.bar
Destination: http://www.foo.bar/resource2 Destination: http://www.foo.bar/resource2
If: <http://www.foo.bar/resource1> (<locktoken:a-write-lock-token> If: <http://www.foo.bar/resource1> (<locktoken:a-write-lock-token>
[W/"A weak e-tag"]) (["strong e-tag"]) [W/"A weak ETag"]) (["strong ETag"])
<http://www.bar.bar/random>(["another strong e-tag"]) <http://www.bar.bar/random>(["another strong ETag"])
In this example http://www.foo.bar/resource1 is being copied to In this example http://www.foo.bar/resource1 is being copied to
http://www.foo.bar/resource2. When the method is first applied to http://www.foo.bar/resource2. When the method is first applied to
http://www.foo.bar/resource1, resource1 must be in the state http://www.foo.bar/resource1, resource1 must be in the state
specified by "(<locktoken:a-write-lock-token> [W/"A weak e-tag"]) specified by "(<locktoken:a-write-lock-token> [W/"A weak ETag"])
(["strong e-tag"])", that is, it either must be locked with a lock (["strong ETag"])", that is, it either must be locked with a lock
token of "locktoken:a-write-lock-token" and have a weak entity tag token of "locktoken:a-write-lock-token" and have a weak entity tag
W/"A weak e-tag" or it must have a strong entity tag "strong e-tag". W/"A weak ETag" or it must have a strong entity tag "strong ETag".
That is the only success condition since the resource That is the only success condition since the resource
http://www.bar.bar/random never has the method applied to it (the http://www.bar.bar/random never has the method applied to it (the
only other resource listed in the If header) and only other resource listed in the If header) and
http://www.foo.bar/resource2 is not listed in the If header. http://www.foo.bar/resource2 is not listed in the If header.
8.4.3 not Production 9.4.3 not Production
Every state token or e-tag is either current, and hence describes Every state token or ETag is either current, and hence describes the
the state of a resource, or is not current, and does not describe state of a resource, or is not current, and does not describe the
the state of a resource. The boolean operation of matching a state state of a resource. The boolean operation of matching a state token
token or e-tag to the current state of a resource thus resolves to a or ETag to the current state of a resource thus resolves to a true
true or false value. The not production is used to reverse that or false value. The not production is used to reverse that value.
value. The scope of the not production is the state-token or The scope of the not production is the state-token or entity-tag
entity-tag immediately following it. immediately following it.
If: (Not <locktoken:write1> <locktoken:write2>) If: (Not <locktoken:write1> <locktoken:write2>)
When submitted with a request, this If header requires that all When submitted with a request, this If header requires that all
operand resources must not be locked with locktoken:write1 and must operand resources must not be locked with locktoken:write1 and must
be locked with locktoken:write2. be locked with locktoken:write2.
8.4.4 Matching Function 9.4.4 Matching Function
When performing If header processing, the definition of a matching When performing If header processing, the definition of a matching
state token or entity tag is as follows. state token or entity tag is as follows.
Matching entity tag: Where the entity tag matches an entity tag Matching entity tag: Where the entity tag matches an entity tag
associated with that resource. associated with that resource.
Matching state token: Where there is an exact match between the Matching state token: Where there is an exact match between the
state token in the If header and any state token on the resource. state token in the If header and any state token on the resource.
8.4.5 If Header and Non-DAV Compliant Proxies 9.4.5 If Header and Non-DAV Compliant Proxies
Non-DAV compliant proxies will not honor the If header, since they Non-DAV compliant proxies will not honor the If header, since they
will not understand the If header, and HTTP requires non-understood will not understand the If header, and HTTP requires non-understood
headers to be ignored. When communicating with HTTP/1.1 proxies, headers to be ignored. When communicating with HTTP/1.1 proxies,
the "Cache-Control: no-cache" request header MUST be used so as to the "Cache-Control: no-cache" request header MUST be used so as to
prevent the proxy from improperly trying to service the request from prevent the proxy from improperly trying to service the request from
its cache. When dealing with HTTP/1.0 proxies the "Pragma: no- its cache. When dealing with HTTP/1.0 proxies the "Pragma: no-
cache" request header MUST be used for the same reason. cache" request header MUST be used for the same reason.
8.5 Lock-Token Request Header 9.5 Lock-Token Header
Lock-Token = "Lock-Token" ":" Coded-URL Lock-Token = "Lock-Token" ":" Coded-URL
The Lock-Token request header is used with the UNLOCK method to The Lock-Token request header is used with the UNLOCK method to
identify the lock to be removed. The lock token in the Lock-Token identify the lock to be removed. The lock token in the Lock-Token
request header MUST identify a lock that contains the resource request header MUST identify a lock that contains the resource
identified by Request-URI as a member. identified by Request-URI as a member.
8.6 Overwrite Header The Lock-Token response header is used with the LOCK method to
indicate the lock token created as a result of a successful LOCK
request to create a new lock.
9.6 Overwrite Header
Overwrite = "Overwrite" ":" ("T" | "F") Overwrite = "Overwrite" ":" ("T" | "F")
The Overwrite header specifies whether the server should overwrite The Overwrite header specifies whether the server should overwrite
the state of a non-null destination resource during a COPY or MOVE. the state of a non-null destination resource during a COPY or MOVE.
A value of "F" states that the server must not perform the COPY or A value of "F" states that the server must not perform the COPY or
MOVE operation if the state of the destination resource is non-null. MOVE operation if the state of the destination resource is non-null.
If the overwrite header is not included in a COPY or MOVE request If the overwrite header is not included in a COPY or MOVE request
then the resource MUST treat the request as if it has an overwrite then the resource MUST treat the request as if it has an overwrite
header of value "T". While the Overwrite header appears to duplicate header of value "T". While the Overwrite header appears to duplicate
the functionality of the If-Match: * header of HTTP/1.1, If-Match the functionality of the If-Match: * header of HTTP/1.1, If-Match
applies only to the Request-URI, and not to the Destination of a applies only to the Request-URI, and not to the Destination of a
COPY or MOVE. COPY or MOVE.
If a COPY or MOVE is not performed due to the value of the Overwrite If a COPY or MOVE is not performed due to the value of the Overwrite
header, the method MUST fail with a 409 Conflict status code. header, the method MUST fail with a 412 (Precondition Failed) status
code.
All DAV compliant resources MUST support the Overwrite header. All DAV compliant resources MUST support the Overwrite header.
8.7 Status-URI Response Header 9.7 Status-URI Response Header
The Status-URI response header may be used with the 102 Processing The Status-URI response header may be used with the 102 (Processing)
status code to inform the client as to the status of a method. status code to inform the client as to the status of a method.
Status-URI = "Status-URI" ":" *(Status-Code "<" URI ">") ; Status- Status-URI = "Status-URI" ":" *(Status-Code Coded-URL) ; Status-Code
Code is defined in 6.1.1 of [Fielding et al., 1997] is defined in 6.1.1 of [RFC2068]
The URIs listed in the header are source resources which have been The URIs listed in the header are source resources which have been
affected by the outstanding method. The status code indicates the affected by the outstanding method. The status code indicates the
resolution of the method on the identified resource. So, for resolution of the method on the identified resource. So, for
example, if a MOVE method on a collection is outstanding and a 102 example, if a MOVE method on a collection is outstanding and a 102
"Processing" response with a Status-URI response header is returned, (Processing) response with a Status-URI response header is returned,
the included URIs will indicate resources that have had move the included URIs will indicate resources that have had move
attempted on them and what the result was. attempted on them and what the result was.
8.8 Timeout Request Header 9.8 Timeout Request Header
TimeOut = "Timeout" ":" 1#TimeType TimeOut = "Timeout" ":" 1#TimeType
TimeType = ("Second-" DAVTimeOutVal | "Infinite" | Other) TimeType = ("Second-" DAVTimeOutVal | "Infinite" | Other)
DAVTimeOutVal = 1*digit DAVTimeOutVal = 1*digit
Other = Extend field-value ; See section 4.2 of [Fielding et al., Other = Extend field-value ; See section 4.2 of [RFC2068]
1997]
Clients may include Timeout headers in their LOCK requests. Clients may include Timeout headers in their LOCK requests.
However, the server is not required to honor or even consider these However, the server is not required to honor or even consider these
requests. Clients MUST NOT submit a Timeout request header with any requests. Clients MUST NOT submit a Timeout request header with any
method other than a LOCK method. method other than a LOCK method.
A Timeout request header MUST contain at least one TimeType and may A Timeout request header MUST contain at least one TimeType and may
contain multiple TimeType entries. The purpose of listing multiple contain multiple TimeType entries. The purpose of listing multiple
TimeType entries is to indicate multiple different values and value TimeType entries is to indicate multiple different values and value
types that are acceptable to the client. The client lists the types that are acceptable to the client. The client lists the
skipping to change at page 53, line 11 skipping to change at page 57, line 15
of the environment within which the applet is running, the applet of the environment within which the applet is running, the applet
may be turned off without warning. As a result, the applet is may be turned off without warning. As a result, the applet is
likely to ask for a relatively small timeout value so that if the likely to ask for a relatively small timeout value so that if the
applet dies, the lock can be quickly harvested. However, a document applet dies, the lock can be quickly harvested. However, a document
management system is likely to ask for an extremely long timeout management system is likely to ask for an extremely long timeout
because its user may be planning on going off-line. because its user may be planning on going off-line.
A client MUST NOT assume that just because the time-out has expired A client MUST NOT assume that just because the time-out has expired
the lock has been lost. the lock has been lost.
9 Status Code Extensions to HTTP/1.1 10 Status Code Extensions to HTTP/1.1
The following status codes are added to those defined in HTTP/1.1 The following status codes are added to those defined in HTTP/1.1
[Fielding et al., 1997]. [RFC2068].
9.1 102 Processing 10.1 102 Processing
The 102 (Processing) status code is an interim response used to
inform the client that the server has accepted the complete request,
but has not yet completed it. This status code SHOULD only be sent
when the server has a reasonable expectation that the request will
take significant time to complete. As guidance, if a method is
taking longer than 20 seconds (a reasonable, but arbitrary value) to
process the server SHOULD return a 102 (Processing) response. The
server MUST send a final response after the request has been
completed.
Methods can potentially take a long period of time to process, Methods can potentially take a long period of time to process,
especially methods that support the Depth header. In such cases the especially methods that support the Depth header. In such cases the
client may time-out the connection while waiting for a response. To client may time-out the connection while waiting for a response. To
prevent this the server may return a 102 status code to indicate to prevent this the server may return a 102 (Processing) status code to
the client that the server is still processing the method. indicate to the client that the server is still processing the
method.
If a method is taking longer than 20 seconds (a reasonable, but
arbitrary value) to process the server SHOULD return a 102
"Processing" response.
9.2 207 Multi-Status 10.2 207 Multi-Status
The response provides status for multiple independent operations. The 207 (Multi-Status) status code provides status for multiple
independent operations (see section 11 for more information).
9.3 422 Unprocessable Entity 10.3 422 Unprocessable Entity
The server understands the content type of the request entity, but The 422 (Unprocessable Entity) status code means the server
was unable to process the contained instructions. understands the content type of the request entity (hence a
415(Unsupported Media Type) status code is inappropriate), and the
syntax of the request entity is correct (thus a 400 (Bad Request)
status code is inappropriate) but was unable to process the
contained instructions. For example, this error condition may occur
if an XML request body contains well-formed (i.e., syntactically
correct), but semantically erroneous XML instructions.
9.4 423 Locked 10.4 423 Locked
The source or destination resource of a method is locked. The 423 (Locked) status code means the source or destination
resource of a method is locked.
9.5 424 Method Failure 10.5 424 Failed Dependency
The method was not executed on a particular resource within its The 424 (Failed Dependency) status code means that the method could
scope because some part of the method's execution failed causing the not be performed on the resource because the requested action
entire method to be aborted. For example, if a command in a depended on another action and that action failed. For example, if
PROPPATCH method fails then, at minimum, the rest of the commands a command in a PROPPATCH method fails then, at minimum, the rest of
will also fail with 424 Method Failure. the commands will also fail with 424 (Failed Dependency).
9.6 425 Insufficient Space on Resource 10.6 507 Insufficient Storage
The resource does not have sufficient space to record the state of The 507 (Insufficient Storage) status code means the method could
the resource after the execution of this method. not be performed on the resource because the server is unable to
store the representation needed to successfully complete the
request. This condition is considered to be temporary. If the
request which received this status code was the result of a user
action, the request MUST NOT be repeated until it is requested by a
separate user action.
10 Multi-Status Response 11 Multi-Status Response
The default 207 Multi-Status response body is a text/xml HTTP entity The default 207 (Multi-Status) response body is a text/xml or
that contains a single XML element called multistatus, which application/xml HTTP entity that contains a single XML element
contains a set of XML elements called response which contain 200, called multistatus, which contains a set of XML elements called
300, 400, and 500 series status codes generated during the method response which contain 200, 300, 400, and 500 series status codes
invocation. 100 series status codes SHOULD NOT be recorded in a generated during the method invocation. 100 series status codes
response XML element. SHOULD NOT be recorded in a response XML element.
11 XML Element Definitions 12 XML Element Definitions
In the section below, the final line of each section gives the In the section below, the final line of each section gives the
element type declaration using the format defined in [Bray, Paoli, element type declaration using the format defined in [REC-XML]. The
Sperberg-McQueen, 1998]. The "Value" field, where present, specifies "Value" field, where present, specifies futher restrictions on the
futher restrictions on the allowable contents of the XML element allowable contents of the XML element using BNF (i.e., to further
using BNF (i.e., to further restrict the values of a PCDATA restrict the values of a PCDATA element).
element).
11.1 activelock XML Element 12.1 activelock XML Element
Name: activelock Name: activelock
Namespace: DAV: Namespace: DAV:
Purpose: Describes a lock on a resource. Purpose: Describes a lock on a resource.
<!ELEMENT activelock (lockscope, locktype, depth, owner?, timeout?, <!ELEMENT activelock (lockscope, locktype, depth, owner?, timeout?,
locktoken?) > locktoken?) >
11.1.1 depth XML Element 12.1.1 depth XML Element
Name: depth Name: depth
Namespace: DAV: Namespace: DAV:
Purpose: The value of the depth header used to create a lock. Purpose: The value of the Depth header.
Value: "0" | "infinity" Value: "0" | "1" | "infinity"
<!ELEMENT depth (#PCDATA) > <!ELEMENT depth (#PCDATA) >
11.1.2 locktoken XML Element 12.1.2 locktoken XML Element
Name: locktoken Name: locktoken
Namespace: DAV: Namespace: DAV:
Purpose: The lock token associated with a lock. Purpose: The lock token associated with a lock.
Description: The href contains one or more opaque lock token URIs Description: The href contains one or more opaque lock token URIs
which all refer to the same lock (i.e., the OpaqueLockToken-URI which all refer to the same lock (i.e., the OpaqueLockToken-URI
production in section 5.4). production in section 6.4).
<!ELEMENT locktoken (href+) > <!ELEMENT locktoken (href+) >
11.1.3 timeout XML Element 12.1.3 timeout XML Element
Name: timeout Name: timeout
Namespace: DAV: Namespace: DAV:
Purpose: The timeout associated with a lock Purpose: The timeout associated with a lock
Value: TimeType ;Defined in section 8.8 Value: TimeType ;Defined in section 9.8
<!ELEMENT timeout (#PCDATA) > <!ELEMENT timeout (#PCDATA) >
11.2 collection XML Element 12.2 collection XML Element
Name: collection Name: collection
Namespace: DAV: Namespace: DAV:
Purpose: Identifies the associated resource as a collection. The Purpose: Identifies the associated resource as a collection. The
resourcetype property of a collection resource MUST have this value. resourcetype property of a collection resource MUST have this value.
<!ELEMENT collection EMPTY > <!ELEMENT collection EMPTY >
11.3 href XML Element 12.3 href XML Element
Name: href Name: href
Namespace: DAV: Namespace: DAV:
Purpose: Identifies the content of the element as a URI. Purpose: Identifies the content of the element as a URI.
Value: URI ; See section 3.2.1 of [Fielding et al., 1997] Value: URI ; See section 3.2.1 of [RFC2068]
<!ELEMENT href (#PCDATA)> <!ELEMENT href (#PCDATA)>
11.4 link XML Element 12.4 link XML Element
Name: link Name: link
Namespace: DAV: Namespace: DAV:
Purpose: Identifies the property as a link and contains the Purpose: Identifies the property as a link and contains the
source and destination of that link. source and destination of that link.
Description: The link XML element is used to provide the sources and Description: The link XML element is used to provide the sources and
destinations of a link. The name of the property containing the destinations of a link. The name of the property containing the
link XML element provides the type of the link. Link is a multi- link XML element provides the type of the link. Link is a multi-
valued element, so multiple links may be used together to indicate valued element, so multiple links may be used together to indicate
multiple links with the same type. The values in the href XML multiple links with the same type. The values in the href XML
elements inside the src and dst XML elements of the link XML element elements inside the src and dst XML elements of the link XML element
MUST NOT be rejected if they point to resources which do not exist. MUST NOT be rejected if they point to resources which do not exist.
<!ELEMENT link (src+, dst+) > <!ELEMENT link (src+, dst+) >
11.4.1 dst XML Element 12.4.1 dst XML Element
Name: dst Name: dst
Namespace: DAV: Namespace: DAV:
Purpose: Indicates the destination of a link Purpose: Indicates the destination of a link
Value: URI Value: URI
<!ELEMENT dst (#PCDATA) > <!ELEMENT dst (#PCDATA) >
11.4.2 src XML Element 12.4.2 src XML Element
Name: src Name: src
Namespace: DAV: Namespace: DAV:
Purpose: Indicates the source of a link. Purpose: Indicates the source of a link.
Value: URI Value: URI
<!ELEMENT src (#PCDATA) > <!ELEMENT src (#PCDATA) >
11.5 lockentry XML Element 12.5 lockentry XML Element
Name: lockentry Name: lockentry
Namespace: DAV: Namespace: DAV:
Purpose: Defines the types of locks that can be used with the Purpose: Defines the types of locks that can be used with the
resource. resource.
<!ELEMENT lockentry (lockscope, locktype) > <!ELEMENT lockentry (lockscope, locktype) >
11.6 lockinfo XML Element 12.6 lockinfo XML Element
Name: lockinfo Name: lockinfo
Namespace: DAV: Namespace: DAV:
Purpose: The lockinfo XML element is used with a LOCK method to Purpose: The lockinfo XML element is used with a LOCK method to
specify the type of lock the client wishes to have created. specify the type of lock the client wishes to have created.
<!ELEMENT lockinfo (lockscope, locktype, owner?) > <!ELEMENT lockinfo (lockscope, locktype, owner?) >
11.7 lockscope XML Element 12.7 lockscope XML Element
Name: lockscope Name: lockscope
Namespace: DAV: Namespace: DAV:
Purpose: Specifies whether a lock is an exclusive lock, or a Purpose: Specifies whether a lock is an exclusive lock, or a
shared lock. shared lock.
<!ELEMENT lockscope (exclusive | shared) > <!ELEMENT lockscope (exclusive | shared) >
11.7.1 exclusive XML Element 12.7.1 exclusive XML Element
Name: exclusive Name: exclusive
Namespace: DAV: Namespace: DAV:
Purpose: Specifies an exclusive lock Purpose: Specifies an exclusive lock
<!ELEMENT exclusive EMPTY > <!ELEMENT exclusive EMPTY >
11.7.2 shared XML Element 12.7.2 shared XML Element
Name: shared Name: shared
Namespace: DAV: Namespace: DAV:
Purpose: Specifies a shared lock Purpose: Specifies a shared lock
<!ELEMENT shared EMPTY > <!ELEMENT shared EMPTY >
11.8 locktype XML Element 12.8 locktype XML Element
Name: locktype Name: locktype
Namespace: DAV: Namespace: DAV:
Purpose: Specifies the access type of a lock. At present, this Purpose: Specifies the access type of a lock. At present, this
specification only defines one lock type, the write lock. specification only defines one lock type, the write lock.
<!ELEMENT locktype (write) > <!ELEMENT locktype (write) >
11.8.1 write XML Element 12.8.1 write XML Element
Name: write Name: write
Namespace: DAV: Namespace: DAV:
Purpose: Specifies a write lock. Purpose: Specifies a write lock.
<!ELEMENT write EMPTY > <!ELEMENT write EMPTY >
11.9 multistatus XML Element 12.9 multistatus XML Element
Name: multistatus Name: multistatus
Namespace: DAV: Namespace: DAV:
Purpose: Contains multiple response messages. Purpose: Contains multiple response messages.
Description: The responsedescription at the top level is used to Description: The responsedescription at the top level is used to
provide a general message describing the overarching nature of the provide a general message describing the overarching nature of the
response. If this value is available an application may use it response. If this value is available an application may use it
instead of presenting the individual response descriptions contained instead of presenting the individual response descriptions contained
within the responses. within the responses.
<!ELEMENT multistatus (response+, responsedescription?) > <!ELEMENT multistatus (response+, responsedescription?) >
11.9.1 response XML Element 12.9.1 response XML Element
Name: response Name: response
Namespace: DAV: Namespace: DAV:
Purpose: Holds a single response describing the effect of a Purpose: Holds a single response describing the effect of a
method on resource and/or its properties. method on resource and/or its properties.
Description: A particular href MUST NOT appear more than once as the Description: A particular href MUST NOT appear more than once as the
child of a response XML element under a multistatus XML element. child of a response XML element under a multistatus XML element.
This requirement is necessary in order to keep processing costs for This requirement is necessary in order to keep processing costs for
a response to linear time. Essentially, this prevents having to a response to linear time. Essentially, this prevents having to
search in order to group together all the responses by href. There search in order to group together all the responses by href. There
are, however, no requirements regarding ordering based on href are, however, no requirements regarding ordering based on href
values. values.
<!ELEMENT response (href, ((href*, status)|(propstat+)), <!ELEMENT response (href, ((href*, status)|(propstat+)),
responsedescription?) > responsedescription?) >
11.9.1.1 propstat XML Element 12.9.1.1 propstat XML Element
Name: propstat Name: propstat
Namespace: DAV: Namespace: DAV:
Purpose: Groups together a prop and status element that is Purpose: Groups together a prop and status element that is
associated with a particular href element. associated with a particular href element.
Description: The propstat XML element MUST contain one prop XML Description: The propstat XML element MUST contain one prop XML
element and one status XML element. The contents of the prop XML element and one status XML element. The contents of the prop XML
element MUST only list the names of properties to which the result element MUST only list the names of properties to which the result
in the status element applies. in the status element applies.
<!ELEMENT propstat (prop, status) > <!ELEMENT propstat (prop, status, responsedescription?) >
11.9.1.2 status XML Element 12.9.1.2 status XML Element
Name: status Name: status
Namespace: DAV: Namespace: DAV:
Purpose: Holds a single HTTP status-line Purpose: Holds a single HTTP status-line
Value: status-line ;status-line defined in [Fielding et al., Value: status-line ;status-line defined in [RFC2068]
1997]
<!ELEMENT status (#PCDATA) > <!ELEMENT status (#PCDATA) >
11.9.2 responsedescription XML Element 12.9.2 responsedescription XML Element
Name: responsedescription Name: responsedescription
Namespace: DAV: Namespace: DAV:
Purpose: Contains a message that can be displayed to the user Purpose: Contains a message that can be displayed to the user
explaining the nature of the response. explaining the nature of the response.
Description: This XML element provides information suitable to be Description: This XML element provides information suitable to be
presented to a user. presented to a user.
<!ELEMENT responsedescription (#PCDATA) > <!ELEMENT responsedescription (#PCDATA) >
11.10 owner XML Element 12.10 owner XML Element
Name: owner Name: owner
Namespace: DAV: Namespace: DAV:
Purpose: Provides information about the principal taking out a Purpose: Provides information about the principal taking out a
lock. lock.
Description: The owner XML element provides information sufficient Description: The owner XML element provides information sufficient
for either directly contacting a principal (such as a telephone for either directly contacting a principal (such as a telephone
number or Email URI), or for discovering the principal (such as the number or Email URI), or for discovering the principal (such as the
URL of a homepage) who owns a lock. URL of a homepage) who owns a lock.
<!ELEMENT owner ANY> <!ELEMENT owner ANY>
11.11 prop XML element 12.11 prop XML element
Name: prop Name: prop
Namespace: DAV: Namespace: DAV:
Purpose: Contains properties related to a resource. Purpose: Contains properties related to a resource.
Description: The prop XML element is a generic container for Description: The prop XML element is a generic container for
properties defined on resources. All elements inside a prop XML properties defined on resources. All elements inside a prop XML
element MUST define properties related to the resource. No other element MUST define properties related to the resource. No other
elements may be used inside of a prop element. elements may be used inside of a prop element.
<!ELEMENT prop ANY> <!ELEMENT prop ANY>
11.12 propertybehavior XML element 12.12 propertybehavior XML element
Name: propertybehavior Name: propertybehavior
Namespace: DAV: Namespace: DAV:
Purpose: Specifies how properties are handled during a COPY or Purpose: Specifies how properties are handled during a COPY or
MOVE. MOVE.
Description: The propertybehavior XML element specifies how Description: The propertybehavior XML element specifies how
properties are handled during a COPY or MOVE. If this XML element properties are handled during a COPY or MOVE. If this XML element
is not included in the request body then the server is expected to is not included in the request body then the server is expected to
act as defined by the default property handling behavior of the act as defined by the default property handling behavior of the
associated method. All WebDAV compliant resources MUST support the associated method. All WebDAV compliant resources MUST support the
propertybehavior XML element. propertybehavior XML element.
<!ELEMENT propertybehavior (omit | keepalive) > <!ELEMENT propertybehavior (omit | keepalive) >
11.12.1 keepalive XML element 12.12.1 keepalive XML element
Name: keepalive Name: keepalive
Namespace: DAV: Namespace: DAV:
Purpose: Specifies requirements for the copying/moving of live Purpose: Specifies requirements for the copying/moving of live
properties. properties.
Description: If a list of URIs is included as the value of keepalive Description: If a list of URIs is included as the value of keepalive
then the named properties MUST be "live" after they are copied then the named properties MUST be "live" after they are copied
(moved) to the destination resource of a COPY (or MOVE). If the (moved) to the destination resource of a COPY (or MOVE). If the
value "*" is given for the keepalive XML element, this designates value "*" is given for the keepalive XML element, this designates
that all live properties on the source resource MUST be live on the that all live properties on the source resource MUST be live on the
destination. If the requirements specified by the keepalive element destination. If the requirements specified by the keepalive element
can not be honored then the method MUST fail with a 412 Precondition can not be honored then the method MUST fail with a 412
Failed. All DAV compliant resources MUST support the keepalive XML (Precondition Failed). All DAV compliant resources MUST support the
element for use with the COPY and MOVE methods. keepalive XML element for use with the COPY and MOVE methods.
Value: "*" ; #PCDATA value can only be "*" Value: "*" ; #PCDATA value can only be "*"
<!ELEMENT keepalive (#PCDATA | href+) > <!ELEMENT keepalive (#PCDATA | href+) >
11.12.2 omit XML element 12.12.2 omit XML element
Name: omit Name: omit
Namespace: DAV: Namespace: DAV:
Purpose: The omit XML element instructs the server that it should Purpose: The omit XML element instructs the server that it should
use best effort to copy properties but a failure to copy a property use best effort to copy properties but a failure to copy a property
MUST NOT cause the method to fail. MUST NOT cause the method to fail.
Description: The default behavior for a COPY or MOVE is to copy/move Description: The default behavior for a COPY or MOVE is to copy/move
all properties or fail the method. In certain circumstances, such all properties or fail the method. In certain circumstances, such
as when a server copies a resource over another protocol such as as when a server copies a resource over another protocol such as
FTP, it may not be possible to copy/move the properties associated FTP, it may not be possible to copy/move the properties associated
with the resource. Thus any attempt to copy/move over FTP would with the resource. Thus any attempt to copy/move over FTP would
always have to fail because properties could not be moved over, even always have to fail because properties could not be moved over, even
as dead properties. All DAV compliant resources MUST support the as dead properties. All DAV compliant resources MUST support the
omit XML element on COPY/MOVE methods. omit XML element on COPY/MOVE methods.
<!ELEMENT omit EMPTY > <!ELEMENT omit EMPTY >
11.13 propertyupdate XML element 12.13 propertyupdate XML element
Name: propertyupdate Name: propertyupdate
Namespace: DAV: Namespace: DAV:
Purpose: Contains a request to alter the properties on a Purpose: Contains a request to alter the properties on a
resource. resource.
Description: This XML element is a container for the information Description: This XML element is a container for the information
required to modify the properties on the resource. This XML element required to modify the properties on the resource. This XML element
is multi-valued. is multi-valued.
<!ELEMENT propertyupdate (remove | set)+ > <!ELEMENT propertyupdate (remove | set)+ >
11.13.1 remove XML element 12.13.1 remove XML element
Name: remove Name: remove
Namespace: DAV: Namespace: DAV:
Purpose: Lists the DAV properties to be removed from a resource. Purpose: Lists the DAV properties to be removed from a resource.
Description: Remove instructs that the properties specified in prop Description: Remove instructs that the properties specified in prop
should be removed. Specifying the removal of a property that does should be removed. Specifying the removal of a property that does
not exist is not an error. All the XML elements in a prop XML not exist is not an error. All the XML elements in a prop XML
element inside of a remove XML element MUST be empty, as only the element inside of a remove XML element MUST be empty, as only the
names of properties to be removed are required. names of properties to be removed are required.
<!ELEMENT remove (prop) > <!ELEMENT remove (prop) >
11.13.2 set XML element 12.13.2 set XML element
Name: set Name: set
Namespace: DAV: Namespace: DAV:
Purpose: Lists the DAV property values to be set for a resource. Purpose: Lists the DAV property values to be set for a resource.
Description: The set XML element MUST contain only a prop XML Description: The set XML element MUST contain only a prop XML
element. The elements contained by the prop XML element inside the element. The elements contained by the prop XML element inside the
set XML element MUST specify the name and value of properties that set XML element MUST specify the name and value of properties that
are set on the Request-URI. If a property already exists then its are set on the Request-URI. If a property already exists then its
value is replaced. value is replaced. Language tagging information in the property's
value (in the "xml:lang" attribute, if present) MUST be persistently
stored along with the property, and MUST be subsequently retrievable
using PROPFIND.
<!ELEMENT set (prop) > <!ELEMENT set (prop) >
11.14 propfind XML Element 12.14 propfind XML Element
Name: propfind Name: propfind
Namespace: DAV: Namespace: DAV:
Purpose: Specifies the properties to be returned from a PROPFIND Purpose: Specifies the properties to be returned from a PROPFIND
method. Two special elements are specified for use with propfind, method. Two special elements are specified for use with propfind,
allprop and propname. If prop is used inside propfind it MUST only allprop and propname. If prop is used inside propfind it MUST only
contain property names, not values. contain property names, not values.
<!ELEMENT propfind (allprop | propname | prop) > <!ELEMENT propfind (allprop | propname | prop) >
11.14.1 allprop XML Element 12.14.1 allprop XML Element
Name: allprop Name: allprop
Namespace: DAV: Namespace: DAV:
Purpose: The allprop XML element specifies that all property Purpose: The allprop XML element specifies that all property
names and values on the resource are to be returned. names and values on the resource are to be returned.
<!ELEMENT allprop EMPTY > <!ELEMENT allprop EMPTY >
11.14.2 propname XML Element 12.14.2 propname XML Element
Name: propname Name: propname
Namespace: DAV: Namespace: DAV:
Purpose: The propname XML element specifies that only a list of Purpose: The propname XML element specifies that only a list of
property names on the resource is to be returned. property names on the resource is to be returned.
<!ELEMENT propname EMPTY > <!ELEMENT propname EMPTY >
12 DAV Properties 13 DAV Properties
For DAV properties, the name of the property is also the same as the For DAV properties, the name of the property is also the same as the
name of the XML element that contains its value. In the section name of the XML element that contains its value. In the section
below, the final line of each section gives the element type below, the final line of each section gives the element type
declaration using the format defined in [Bray, Paoli, Sperberg- declaration using the format defined in [REC-XML]. The "Value"
McQueen, 1998]. The "Value" field, where present, specifies futher field, where present, specifies futher restrictions on the allowable
restrictions on the allowable contents of the XML element using BNF contents of the XML element using BNF (i.e., to further restrict the
(i.e., to further restrict the values of a PCDATA element). values of a PCDATA element).
12.1 creationdate Property 13.1 creationdate Property
Name: creationdate Name: creationdate
Namespace: DAV: Namespace: DAV:
Purpose: Records the time and date the resource was created. Purpose: Records the time and date the resource was created.
Value: date-time ; See Appendix 2 Value: date-time ; See Appendix 2
Description: The creationdate property should be defined on all DAV Description: The creationdate property should be defined on all DAV
compliant resources. If present, it contains a timestamp of the compliant resources. If present, it contains a timestamp of the
moment when the resource was created (i.e., the moment it had non- moment when the resource was created (i.e., the moment it had non-
null state). null state).
<!ELEMENT creationdate (#PCDATA) > <!ELEMENT creationdate (#PCDATA) >
12.2 displayname Property 13.2 displayname Property
Name: displayname Name: displayname
Namespace: DAV: Namespace: DAV:
Purpose: Provides a name for the resource that is suitable for Purpose: Provides a name for the resource that is suitable for
presentation to a user. presentation to a user.
Description: The displayname property should be defined on all DAV Description: The displayname property should be defined on all DAV
compliant resources. If present, the property contains a compliant resources. If present, the property contains a
description of the resource that is suitable for presentation to a description of the resource that is suitable for presentation to a
user. user.
<!ELEMENT displayname (#PCDATA) > <!ELEMENT displayname (#PCDATA) >
12.3 getcontentlanguage Property 13.3 getcontentlanguage Property
Name: getcontentlanguage Name: getcontentlanguage
Namespace: DAV: Namespace: DAV:
Purpose: Contains the Content-Language header returned by a GET Purpose: Contains the Content-Language header returned by a GET
without accept headers without accept headers
Description: The getcontentlanguage property MUST be defined on any Description: The getcontentlanguage property MUST be defined on any
DAV compliant resource that returns the Content-Language header on a DAV compliant resource that returns the Content-Language header on a
GET. GET.
Value: language-tag ;language-tag is defined in section 14.13 Value: language-tag ;language-tag is defined in section 14.13
of [Fielding et al., 1997] of [RFC2068]
<!ELEMENT getcontentlanguage (#PCDATA) > <!ELEMENT getcontentlanguage (#PCDATA) >
12.4 getcontentlength Property 13.4 getcontentlength Property
Name: getcontentlength Name: getcontentlength
Namespace: DAV: Namespace: DAV:
Purpose: Contains the Content-Length header returned by a GET Purpose: Contains the Content-Length header returned by a GET
without accept headers. without accept headers.
Description: The getcontentlength property MUST be defined on any Description: The getcontentlength property MUST be defined on any
DAV compliant resource that returns the Content-Length header in DAV compliant resource that returns the Content-Length header in
response to a GET. response to a GET.
Value: content-length ; see section 14.14 of [Fielding et al., Value: content-length ; see section 14.14 of [RFC2068]
1997]
<!ELEMENT getcontentlength (#PCDATA) > <!ELEMENT getcontentlength (#PCDATA) >
12.5 getcontenttype Property 13.5 getcontenttype Property
Name: getcontenttype Name: getcontenttype
Namespace: DAV: Namespace: DAV:
Purpose: Contains the Content-Type header returned by a GET Purpose: Contains the Content-Type header returned by a GET
without accept headers. without accept headers.
Description: This getcontenttype property MUST be defined on any DAV Description: This getcontenttype property MUST be defined on any DAV
compliant resource that returns the Content-Type header in response compliant resource that returns the Content-Type header in response
to a GET. to a GET.
Value: media-type ; defined in section 3.7 of [Fielding et Value: media-type ; defined in section 3.7 of [RFC2068]
al., 1997]
<!ELEMENT getcontenttype (#PCDATA) > <!ELEMENT getcontenttype (#PCDATA) >
12.6 getetag Property 13.6 getetag Property
Name: getetag Name: getetag
Namespace: DAV: Namespace: DAV:
Purpose: Contains the ETag header returned by a GET without Purpose: Contains the ETag header returned by a GET without
accept headers. accept headers.
Description: Note that the ETag on a resource may reflect changes in Description: The getetag property MUST be defined on any DAV
any part of the state of the resource, not necessarily just a change compliant resource that returns the Etag header.
to the response to the GET method. For example, a change to a Value: entity-tag ; defined in section 3.11 of [RFC2068]
resource's access permissions may cause the ETag to change. The
getetag property MUST be defined on any DAV compliant resource that
returns the Etag header in response to a GET.
Value: entity-tag ; defined in section 3.11 of [Fielding et
al., 1997]
<!ELEMENT getetag (#PCDATA) > <!ELEMENT getetag (#PCDATA) >
12.7 getlastmodified Property 13.7 getlastmodified Property
Name: getlastmodified Name: getlastmodified
Namespace: DAV: Namespace: DAV:
Purpose: Contains the Last-Modified header returned by a GET Purpose: Contains the Last-Modified header returned by a GET
method without accept headers. method without accept headers.
Description: Note that the last-modified date on a resource may Description: Note that the last-modified date on a resource may
reflect changes in any part of the state of the resource, not reflect changes in any part of the state of the resource, not
necessarily just a change to the response to the GET method. For necessarily just a change to the response to the GET method. For
example, a change in a property may cause the last-modified date to example, a change in a property may cause the last-modified date to
change. The getlastmodified property MUST be defined on any DAV change. The getlastmodified property MUST be defined on any DAV
compliant resource that returns the Last-Modified header in response compliant resource that returns the Last-Modified header in response
to a GET. to a GET.
Value: HTTP-date ; defined in section 3.3.1 of [Fielding et Value: HTTP-date ; defined in section 3.3.1 of [RFC2068]
al., 1997]
<!ELEMENT getlastmodified (#PCDATA) > <!ELEMENT getlastmodified (#PCDATA) >
12.8 lockdiscovery Property 13.8 lockdiscovery Property
Name: lockdiscovery Name: lockdiscovery
Namespace: DAV: Namespace: DAV:
Purpose: Describes the active locks on a resource Purpose: Describes the active locks on a resource
Description: The lockdiscovery property returns a listing of who has Description: The lockdiscovery property returns a listing of who has
a lock, what type of lock he has, the timeout type and the time a lock, what type of lock he has, the timeout type and the time
remaining on the timeout, and the associated lock token. The server remaining on the timeout, and the associated lock token. The server
is free to withhold any or all of this information if the requesting is free to withhold any or all of this information if the requesting
principal does not have sufficient access rights to see the principal does not have sufficient access rights to see the
requested data. requested data.
<!ELEMENT lockdiscovery (activelock)* > <!ELEMENT lockdiscovery (activelock)* >
12.8.1 Example - Retrieving the lockdiscovery Property 13.8.1 Example - Retrieving the lockdiscovery Property
>>Request >>Request
PROPFIND /container/ HTTP/1.1 PROPFIND /container/ HTTP/1.1
Host: www.foo.bar Host: www.foo.bar
Content-Length: xxxx Content-Length: xxxx
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:propfind xmlns:D='DAV:'>
<D:propfind>
<D:prop><D:lockdiscovery/></D:prop> <D:prop><D:lockdiscovery/></D:prop>
</D:propfind> </D:propfind>
>>Response >>Response
HTTP/1.1 207 Multi-Status HTTP/1.1 207 Multi-Status
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
Content-Length: xxxxx Content-Length: xxxxx
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:multistatus xmlns:D='DAV:'>
<D:multistatus>
<D:response> <D:response>
<D:href>http://www.foo.bar/container/</D:href> <D:href>http://www.foo.bar/container/</D:href>
<D:propstat> <D:propstat>
<D:prop> <D:prop>
<D:lockdiscovery> <D:lockdiscovery>
<D:activelock> <D:activelock>
<D:locktype><D:write/></D:locktype> <D:locktype><D:write/></D:locktype>
<D:lockscope><D:exclusive/></D:lockscope> <D:lockscope><D:exclusive/></D:lockscope>
<D:depth>0</D:depth> <D:depth>0</D:depth>
<D:owner>Jane Smith</D:owner> <D:owner>Jane Smith</D:owner>
skipping to change at page 64, line 42 skipping to change at page 69, line 37
</D:locktoken> </D:locktoken>
</D:activelock> </D:activelock>
</D:lockdiscovery> </D:lockdiscovery>
</D:prop> </D:prop>
<D:status>HTTP/1.1 200 OK</D:status> <D:status>HTTP/1.1 200 OK</D:status>
</D:propstat> </D:propstat>
</D:response> </D:response>
</D:multistatus> </D:multistatus>
This resource has a single exclusive write lock on it, with an This resource has a single exclusive write lock on it, with an
infinite timeout. infinite timeout.
12.9 resourcetype Property 13.9 resourcetype Property
Name: resourcetype Name: resourcetype
Namespace: DAV: Namespace: DAV:
Purpose: Specifies the nature of the resource. Purpose: Specifies the nature of the resource.
Description: The resourcetype property MUST be defined on all DAV Description: The resourcetype property MUST be defined on all DAV
compliant resources. The default value is empty. compliant resources. The default value is empty.
<!ELEMENT resourcetype ANY > <!ELEMENT resourcetype ANY >
12.10 source Property 13.10 source Property
Name: source Name: source
Namespace: DAV: Namespace: DAV:
Purpose: The destination of the source link identifies the Purpose: The destination of the source link identifies the
resource that contains the unprocessed source of the link's source. resource that contains the unprocessed source of the link's source.
Description: The source of the link (src) is typically the URI of Description: The source of the link (src) is typically the URI of
the output resource on which the link is defined, and there is the output resource on which the link is defined, and there is
typically only one destination (dst) of the link, which is the URI typically only one destination (dst) of the link, which is the URI
where the unprocessed source of the resource may be accessed. When where the unprocessed source of the resource may be accessed. When
more than one link destination exists, this specification asserts no more than one link destination exists, this specification asserts no
policy on ordering. policy on ordering.
<!ELEMENT source (link)* > <!ELEMENT source (link)* >
12.10.1 Example - A source Property 13.10.1 Example - A source Property
<?xml version="1.0" ?>
<?xml:namespace ns="DAV:" prefix="D" ?>
<?xml:namespace ns="http://www.foocorp.com/Project/" prefix="F" ?>
<D:prop>
<?xml version="1.0" encoding="utf-8" ?>
<D:prop xmlns:D="DAV:" xmlns:F="http://www.foocorp.com/Project/">
<D:source> <D:source>
<D:link> <D:link>
<F:projfiles>Source</F:projfiles> <F:projfiles>Source</F:projfiles>
<D:src>http://foo.bar/program</D:src> <D:src>http://foo.bar/program</D:src>
<D:dst>http://foo.bar/src/main.c</D:dst> <D:dst>http://foo.bar/src/main.c</D:dst>
</D:link> </D:link>
<D:link> <D:link>
<F:projfiles>Library</F:projfiles> <F:projfiles>Library</F:projfiles>
<D:src>http://foo.bar/program</D:src> <D:src>http://foo.bar/program</D:src>
<D:dst>http://foo.bar/src/main.lib</D:dst> <D:dst>http://foo.bar/src/main.lib</D:dst>
skipping to change at page 66, line 5 skipping to change at page 71, line 5
defined in this document, and one which is defined by the schema defined in this document, and one which is defined by the schema
http://www.foocorp.com/project/ (Source, Library, and Makefile). A http://www.foocorp.com/project/ (Source, Library, and Makefile). A
client which only implements the elements in the DAV spec will not client which only implements the elements in the DAV spec will not
understand the foocorp elements and will ignore them, thus seeing understand the foocorp elements and will ignore them, thus seeing
the expected source and destination links. An enhanced client may the expected source and destination links. An enhanced client may
know about the foocorp elements and be able to present the user with know about the foocorp elements and be able to present the user with
additional information about the links. This example demonstrates additional information about the links. This example demonstrates
the power of XML markup, allowing element values to be enhanced the power of XML markup, allowing element values to be enhanced
without breaking older clients. without breaking older clients.
12.11 supportedlock Property 13.11 supportedlock Property
Name: supportedlock Name: supportedlock
Namespace: DAV: Namespace: DAV:
Purpose: To provide a listing of the lock capabilities supported Purpose: To provide a listing of the lock capabilities supported
by the resource. by the resource.
Description: The supportedlock property of a resource returns a Description: The supportedlock property of a resource returns a
listing of the combinations of scope and access types which may be listing of the combinations of scope and access types which may be
specified in a lock request on the resource. Note that the actual specified in a lock request on the resource. Note that the actual
contents are themselves controlled by access controls so a server is contents are themselves controlled by access controls so a server is
not required to provide information the client is not authorized to not required to provide information the client is not authorized to
see. see.
<!ELEMENT supportedlock (lockentry)* > <!ELEMENT supportedlock (lockentry)* >
12.11.1 Example - Retrieving the supportedlock Property 13.11.1 Example - Retrieving the supportedlock Property
>>Request >>Request
PROPFIND /container/ HTTP/1.1 PROPFIND /container/ HTTP/1.1
Host: www.foo.bar Host: www.foo.bar
Content-Length: xxxx Content-Length: xxxx
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:propfind xmlns:D="DAV:">
<D:propfind>
<D:prop><D:supportedlock/></D:prop> <D:prop><D:supportedlock/></D:prop>
</D:propfind> </D:propfind>
>>Response >>Response
HTTP/1.1 207 Multi-Status HTTP/1.1 207 Multi-Status
Content-Type: text/xml Content-Type: text/xml; charset="utf-8"Content-Length: xxxxx
Content-Length: xxxxx
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:multistatus xmlns:D="DAV:">
<D:multistatus>
<D:response> <D:response>
<D:href>http://www.foo.bar/container/</D:href> <D:href>http://www.foo.bar/container/</D:href>
<D:propstat> <D:propstat>
<D:prop> <D:prop>
<D:supportedlock> <D:supportedlock>
<D:lockentry> <D:lockentry>
<D:lockscope><D:exclusive/></D:lockscope> <D:lockscope><D:exclusive/></D:lockscope>
<D:locktype><D:write/></D:locktype> <D:locktype><D:write/></D:locktype>
</D:lockentry> </D:lockentry>
<D:lockentry> <D:lockentry>
<D:lockscope><D:shared/></D:lockscope> <D:lockscope><D:shared/></D:lockscope>
<D:locktype><D:write/></D:locktype> <D:locktype><D:write/></D:locktype>
</D:lockentry> </D:lockentry>
</D:supportedlock> </D:supportedlock>
</D:prop> </D:prop>
<D:status>HTTP/1.1 200 OK</D:status> <D:status>HTTP/1.1 200 OK</D:status>
</D:propstat> </D:propstat>
</D:response> </D:response>
</D:multistatus> </D:multistatus>
13 DAV XML Processing Instructions 14 Instructions for Processing XML in DAV
All DAV compliant resources MUST ignore any unknown XML element and All DAV compliant resources MUST ignore any unknown XML element and
all its children encountered while processing a DAV method that uses all its children encountered while processing a DAV method that uses
XML as its command language. XML as its command language.
This restriction also applies to the processing, by clients, of DAV This restriction also applies to the processing, by clients, of DAV
property values where unknown XML elements SHOULD be ignored unless property values where unknown XML elements SHOULD be ignored unless
the property's schema declares otherwise. the property's schema declares otherwise.
This restriction does not apply to setting dead DAV properties on This restriction does not apply to setting dead DAV properties on
the server where the server MUST record unknown XML elements. the server where the server MUST record unknown XML elements.
Additionally, this restriction does not apply to the use of XML Additionally, this restriction does not apply to the use of XML
where XML happens to be the content type of the entity body, for where XML happens to be the content type of the entity body, for
example, when used as the body of a PUT. example, when used as the body of a PUT.
14 DAV Compliance Classes 15 DAV Compliance Classes
A DAV compliant resource can choose from two classes of compliance. A DAV compliant resource can choose from two classes of compliance.
A client can discover the compliance classes of a resource by A client can discover the compliance classes of a resource by
executing OPTIONS on the resource, and examining the "DAV" header executing OPTIONS on the resource, and examining the "DAV" header
which is returned. which is returned.
Since this document describes extensions to the HTTP/1.1 protocol, Since this document describes extensions to the HTTP/1.1 protocol,
minimally all DAV compliant resources, clients, and proxies MUST be minimally all DAV compliant resources, clients, and proxies MUST be
compliant with [Fielding et al., 1997]. compliant with [RFC2068].
Compliance classes are not necessarily sequential. A resource that Compliance classes are not necessarily sequential. A resource that
is class 2 compliant must also be class 1 compliant; but if is class 2 compliant must also be class 1 compliant; but if
additional compliance classes are defined later, a resource that is additional compliance classes are defined later, a resource that is
class 1, 2, and 4 compliant might not be class 3 compliant. Also class 1, 2, and 4 compliant might not be class 3 compliant. Also
note that identifiers other than numbers may be used as compliance note that identifiers other than numbers may be used as compliance
class identifiers. class identifiers.
14.1 Class 1 15.1 Class 1
A class 1 compliant resource MUST meet all "MUST" requirements in A class 1 compliant resource MUST meet all "MUST" requirements in
all sections of this document. all sections of this document.
Class 1 compliant resources MUST return, at minimum, the value "1" Class 1 compliant resources MUST return, at minimum, the value "1"
in the DAV header on all responses to the OPTIONS method. in the DAV header on all responses to the OPTIONS method.
14.2 Class 2 15.2 Class 2
A class 2 compliant resource MUST meet all class 1 requirements and A class 2 compliant resource MUST meet all class 1 requirements and
support the LOCK method, the supportedlock property, the support the LOCK method, the supportedlock property, the
lockdiscovery property, the Time-Out response header and the Lock- lockdiscovery property, the Time-Out response header and the Lock-
Token request header. A class "2" compliant resource SHOULD also Token request header. A class "2" compliant resource SHOULD also
support the Time-Out request header and the owner XML element. support the Time-Out request header and the owner XML element.
Class 2 compliant resources MUST return, at minimum, the values "1" Class 2 compliant resources MUST return, at minimum, the values "1"
and "2" in the DAV header on all responses to the OPTIONS method. and "2" in the DAV header on all responses to the OPTIONS method.
15 Internationalization Considerations 16 Internationalization Considerations
In the realm of internationalization, this specification complies In the realm of internationalization, this specification complies
with the IETF Character Set Policy [Alvestrand, 1998]. In this with the IETF Character Set Policy [RFC2277]. In this specification,
specification, human-readable fields can be found either in the human-readable fields can be found either in the value of a
value of a property, or in an error message returned in a response property, or in an error message returned in a response entity body.
entity body. In both cases, the human-readable content is encoded In both cases, the human-readable content is encoded using XML,
using XML, which has explicit provisions for character set tagging which has explicit provisions for character set tagging and
and encoding, and requires that XML processors read XML elements encoding, and requires that XML processors read XML elements
encoded, at minimum, using the UTF-8 [Yergeau, 1998] encoding of the encoded, at minimum, using the UTF-8 [UTF-8] encoding of the ISO
ISO 10646 multilingual plane. 10646 multilingual plane. XML examples in this specification
demonstrate use of the charset parameter of the Content-Type header,
as defined in [RFC2376], as well as the XML "encoding" attribute,
which together provide charset identification information for MIME
and XML processors.
XML also provides a language tagging capability for specifying the XML also provides a language tagging capability for specifying the
language of the contents of a particular XML element. XML uses language of the contents of a particular XML element. XML uses
either IANA registered language tags (see RFC 1766, [Alvestrand, either IANA registered language tags (see [RFC1766]) or ISO 639
1995]) or ISO 639 language tags [ISO-639] in the "xml:lang" language tags [ISO-639] in the "xml:lang" attribute of an XML
attribute of an XML element to identify the language of its content element to identify the language of its content and attributes.
and attributes.
WebDAV applications MUST support the character set tagging, WebDAV applications MUST support the character set tagging,
character set encoding, and the language tagging functionality of character set encoding, and the language tagging functionality of
the XML specification. the XML specification. Implementors of WebDAV applications are
strongly encouraged to read "XML Media Types" [RFC2376] for
instruction on which MIME media type to use for XML transport, and
on use of the charset parameter of the Content-Type header.
Names used within this specification fall into three categories: Names used within this specification fall into three categories:
names of protocol elements such as methods and headers, names of XML names of protocol elements such as methods and headers, names of XML
elements, and names of properties. Naming of protocol elements elements, and names of properties. Naming of protocol elements
follows the precedent of HTTP, using English names encoded in follows the precedent of HTTP, using English names encoded in
USASCII for methods and headers. Since these protocol elements are USASCII for methods and headers. Since these protocol elements are
not visible to users, and are in fact simply long token identifiers, not visible to users, and are in fact simply long token identifiers,
they do not need to support encoding in multiple character sets. they do not need to support encoding in multiple character sets.
Similarly, though the names of XML elements used in this Similarly, though the names of XML elements used in this
specification are English names encoded in UTF-8, these names are specification are English names encoded in UTF-8, these names are
skipping to change at page 69, line 34 skipping to change at page 74, line 45
typical application will use a fixed set of properties, and will typical application will use a fixed set of properties, and will
provide a mapping from the property name URI to a human-readable provide a mapping from the property name URI to a human-readable
field when displaying the property name to a user. It is only in field when displaying the property name to a user. It is only in
the case where the set of properties is not known ahead of time that the case where the set of properties is not known ahead of time that
an application need display a property name URI to a user. We an application need display a property name URI to a user. We
recommend that applications provide human-readable property names recommend that applications provide human-readable property names
wherever feasible. wherever feasible.
For error reporting, we follow the convention of HTTP/1.1 status For error reporting, we follow the convention of HTTP/1.1 status
codes, including with each status code a short, English description codes, including with each status code a short, English description
of the code (e.g., 423 (Locked)). While the possibility exists that
of the code (e.g., 423 Locked). While the possibility exists that a a poorly crafted user agent would display this message to a user,
poorly crafted user agent would display this message to a user,
internationalized applications will ignore this message, and display internationalized applications will ignore this message, and display
an appropriate message in the user's language and character set. an appropriate message in the user's language and character set.
Since interoperation of clients and servers does not require locale Since interoperation of clients and servers does not require locale
information, this specification does not specify any mechanism for information, this specification does not specify any mechanism for
transmission of this information. transmission of this information.
16 Security Considerations 17 Security Considerations
This section is provided to detail issues concerning security This section is provided to detail issues concerning security
implications of which WebDAV applications need to be aware. implications of which WebDAV applications need to be aware.
All of the security considerations of HTTP/1.1 also apply to WebDAV. All of the security considerations of HTTP/1.1 (discussed in
In addition, the security risks inherent in remote authoring require [RFC2068]) and XML (discussed in [RFC2376]) also apply to WebDAV. In
addition, the security risks inherent in remote authoring require
stronger authentication technology, introduce several new privacy stronger authentication technology, introduce several new privacy
concerns, and may increase the hazards from poor server design. concerns, and may increase the hazards from poor server design.
These issues are detailed below. These issues are detailed below.
16.1 Authentication of Clients 17.1 Authentication of Clients
Due to their emphasis on authoring, WebDAV servers need to use Due to their emphasis on authoring, WebDAV servers need to use
authentication technology to protect not just access to a network authentication technology to protect not just access to a network
resource, but the integrity of the resource as well. Furthermore, resource, but the integrity of the resource as well. Furthermore,
the introduction of locking functionality requires support for the introduction of locking functionality requires support for
authentication. authentication.
A password sent in the clear over an insecure channel is an A password sent in the clear over an insecure channel is an
inadequate means for protecting the accessibility and integrity of a inadequate means for protecting the accessibility and integrity of a
resource as the password may be intercepted. Since Basic resource as the password may be intercepted. Since Basic
authentication for HTTP/1.1 performs essentially clear text authentication for HTTP/1.1 performs essentially clear text
transmission of a password, Basic authentication MUST NOT be used to transmission of a password, Basic authentication MUST NOT be used to
authenticate a WebDAV client to a server unless the connection is authenticate a WebDAV client to a server unless the connection is
secure. Furthermore, a WebDAV server MUST NOT send Basic secure. Furthermore, a WebDAV server MUST NOT send Basic
authentication credentials in a WWW-Authenticate header unless the authentication credentials in a WWW-Authenticate header unless the
connection is secure. Examples of secure connections include a connection is secure. Examples of secure connections include a
Transport Layer Security (TLS) connection, or a connection over a Transport Layer Security (TLS) connection employing a strong cipher
network which is physically secure, for example, an isolated network suite with mutual authentication of client and server, or a
in a building with restricted access. connection over a network which is physically secure, for example,
an isolated network in a building with restricted access.
WebDAV applications MUST support the Digest authentication scheme WebDAV applications MUST support the Digest authentication scheme
[Franks et al., 1997]. Since Digest authentication verifies that [RFC2069]. Since Digest authentication verifies that both parties to
both parties to a communication know a shared secret, a password, a communication know a shared secret, a password, without having to
without having to send that secret in the clear, Digest send that secret in the clear, Digest authentication avoids the
authentication avoids the security problems inherent in Basic security problems inherent in Basic authentication while providing a
authentication while providing a level of authentication which is level of authentication which is useful in a wide range of
useful in a wide range of scenarios. scenarios.
16.2 Denial of Service 17.2 Denial of Service
Denial of service attacks are of special concern to WebDAV servers. Denial of service attacks are of special concern to WebDAV servers.
WebDAV plus HTTP enables denial of service attacks on every part of WebDAV plus HTTP enables denial of service attacks on every part of
a system's resources. a system's resources.
The underlying storage can be attacked by PUTting extremely large The underlying storage can be attacked by PUTting extremely large
files. files.
Asking for recursive operations on large collections can attack Asking for recursive operations on large collections can attack
processing time. processing time.
Making multiple pipelined requests on multiple connections can Making multiple pipelined requests on multiple connections can
attack network connections. attack network connections.
WebDAV servers need to be aware of the possibility of a denial of WebDAV servers need to be aware of the possibility of a denial of
service attack at all levels. service attack at all levels.
16.3 Security through Obscurity 17.3 Security through Obscurity
WebDAV provides, through the PROPFIND method, a mechanism for WebDAV provides, through the PROPFIND method, a mechanism for
listing the member resources of a collection. This greatly listing the member resources of a collection. This greatly
diminishes the effectiveness of security or privacy techniques that diminishes the effectiveness of security or privacy techniques that
rely only on the difficulty of discovering the names of network rely only on the difficulty of discovering the names of network
resources. Users of WebDAV servers are encouraged to use access resources. Users of WebDAV servers are encouraged to use access
control techniques to prevent unwanted access to resources, rather control techniques to prevent unwanted access to resources, rather
than depending on the relative obscurity of their resource names. than depending on the relative obscurity of their resource names.
16.4 Privacy Issues Connected to Locks 17.4 Privacy Issues Connected to Locks
When submitting a lock request a user agent may also submit an owner When submitting a lock request a user agent may also submit an owner
XML field giving contact information for the person taking out the XML field giving contact information for the person taking out the
lock (for those cases where a person, rather than a robot, is taking lock (for those cases where a person, rather than a robot, is taking
out the lock). This contact information is stored in a lockdiscovery out the lock). This contact information is stored in a lockdiscovery
property on the resource, and can be used by other collaborators to property on the resource, and can be used by other collaborators to
begin negotiation over access to the resource. However, in many begin negotiation over access to the resource. However, in many
cases this contact information can be very private, and should not cases this contact information can be very private, and should not
be widely disseminated. Servers SHOULD limit read access to the be widely disseminated. Servers SHOULD limit read access to the
lockdiscovery property as appropriate. Furthermore, user agents lockdiscovery property as appropriate. Furthermore, user agents
SHOULD provide control over whether contact information is sent at SHOULD provide control over whether contact information is sent at
all, and if contact information is sent, control over exactly what all, and if contact information is sent, control over exactly what
information is sent. information is sent.
16.5 Privacy Issues Connected to Properties 17.5 Privacy Issues Connected to Properties
Since property values are typically used to hold information such as Since property values are typically used to hold information such as
the author of a document, there is the possibility that privacy the author of a document, there is the possibility that privacy
concerns could arise stemming from widespread access to a resource's concerns could arise stemming from widespread access to a resource's
property data. To reduce the risk of inadvertent release of private property data. To reduce the risk of inadvertent release of private
information via properties, servers are encouraged to develop access information via properties, servers are encouraged to develop access
control mechanisms that separate read access to the resource body control mechanisms that separate read access to the resource body
and read access to the resource's properties. This allows a user to and read access to the resource's properties. This allows a user to
control the dissemination of their property data without overly control the dissemination of their property data without overly
restricting access to the resource's contents. restricting access to the resource's contents.
16.6 Reduction of Security due to Source Link 17.6 Reduction of Security due to Source Link
HTTP/1.1 warns against providing read access to script code because HTTP/1.1 warns against providing read access to script code because
it may contain sensitive information. Yet WebDAV, via its source it may contain sensitive information. Yet WebDAV, via its source
link facility, can potentially provide a URL for script resources so link facility, can potentially provide a URL for script resources so
they may be authored. For HTTP/1.1, a server could reasonably they may be authored. For HTTP/1.1, a server could reasonably
prevent access to source resources due to the predominance of read- prevent access to source resources due to the predominance of read-
only access. WebDAV, with its emphasis on authoring, encourages only access. WebDAV, with its emphasis on authoring, encourages
read and write access to source resources, and provides the source read and write access to source resources, and provides the source
link facility to identify the source. This reduces the security link facility to identify the source. This reduces the security
benefits of eliminating access to source resources. Users and benefits of eliminating access to source resources. Users and
administrators of WebDAV servers should be very cautious when administrators of WebDAV servers should be very cautious when
allowing remote authoring of scripts, limiting read and write access allowing remote authoring of scripts, limiting read and write access
to the source resources to authorized principals. to the source resources to authorized principals.
17 IANA Considerations 17.7 Implications of XML External Entities
XML supports a facility known as "external entities", defined in
section 4.2.2 of [REC-XML], which instruct an XML processor to
retrieve and perform an inline include of XML located at a
particular URI. An external XML entity can be used to append or
modify the document type declaration (DTD) associated with an XML
document. An external XML entity can also be used to include XML
within the content of an XML document. For non-validating XML, such
as the XML used in this specification, including an external XML
entity is not required by [REC-XML]. However, [REC-XML] does state
that an XML processor may, at its discretion, include the external
XML entity.
External XML entities have no inherent trustworthiness and are
subject to all the attacks that are endemic to any HTTP GET request.
Furthermore, it is possible for an external XML entity to modify the
DTD, and hence affect the final form of an XML document, in the
worst case significantly modifying its semantics, or exposing the
XML processor to the security risks discussed in [RFC2376].
Therefore, implementers must be aware that external XML entities
should be treated as untrustworthy.
There is also the scalability risk that would accompany a widely
deployed application which made use of external XML entities. In
this situation, it is possible that there would be significant
numbers of requests for one external XML entity, potentially
overloading any server which fields requests for the resource
containing the external XML entity.
17.8 Risks Connected with Lock Tokens
This specification, in section 6.4, requires the use of Globally
Unique Identifiers (GUIDs) for lock tokens, in order to guarantee
their uniqueness across space and time. GUIDs, as defined in [ISO-
11578], contain a "node" field which "consists of the IEEE address,
usually the host address. For systems with multiple IEEE 802 nodes,
any available node address can be used." Since a WebDAV server will
issue many locks over its lifetime, the implication is that it will
also be publicly exposing its IEEE 802 address.
There are several risks associated with exposure of IEEE 802
addresses. Using the IEEE 802 address:
* It is possible to track the movement of hardware from subnet to
subnet.
* It may be possible to identify the manufacturer of the hardware
running a WebDAV server.
* It may be possible to determine the number of each type of
computer running WebDAV.
Section 6.4.1 of this specification details an alternate mechanism
for generating the "node" field of a GUID without using an IEEE 802
address, which alleviates the risks associated with exposure of IEEE
802 addresses by using an alternate source of uniqueness.
18 IANA Considerations
This document defines two namespaces, the namespace of property This document defines two namespaces, the namespace of property
names, and the namespace of WebDAV-specific XML elements used within names, and the namespace of WebDAV-specific XML elements used within
property values. property values.
URLs are used for both names, for several reasons. Assignment of a URLs are used for both names, for several reasons. Assignment of a
URL does not require a request to a central naming authority, and URL does not require a request to a central naming authority, and
hence allow WebDAV property names and XML elements to be quickly hence allow WebDAV property names and XML elements to be quickly
defined by any WebDAV user or application. URLs also provide a defined by any WebDAV user or application. URLs also provide a
unique address space, ensuring that the distributed users of WebDAV unique address space, ensuring that the distributed users of WebDAV
skipping to change at page 72, line 21 skipping to change at page 78, line 40
they create. they create.
This specification defines a distinguished set of property names and This specification defines a distinguished set of property names and
XML elements that are understood by all WebDAV applications. The XML elements that are understood by all WebDAV applications. The
property names and XML elements in this specification are all property names and XML elements in this specification are all
derived from the base URI DAV: by adding a suffix to this URI, for derived from the base URI DAV: by adding a suffix to this URI, for
example, DAV:creationdate for the "creationdate" property. example, DAV:creationdate for the "creationdate" property.
This specification also defines a URI scheme for the encoding of This specification also defines a URI scheme for the encoding of
lock tokens, the opaquelocktoken URI scheme described in section lock tokens, the opaquelocktoken URI scheme described in section
5.4. 6.4.
To ensure correct interoperation based on this specification, IANA To ensure correct interoperation based on this specification, IANA
must reserve the URI namespaces starting with "DAV:" and with must reserve the URI namespaces starting with "DAV:" and with
"opaquelocktoken:" for use by this specification, its revisions, and "opaquelocktoken:" for use by this specification, its revisions, and
related WebDAV specifications. related WebDAV specifications.
18 Terminology
Collection - A resource that contains member resources and meets the
requirements in section 4 of this specification.
Member Resource - A resource contained by a collection.
Internal Member Resource - A member resource of a collection whose
URI is relative to the URI of the collection.
Property - A name/value pair that contains descriptive information
about a resource.
Live Property - A property whose semantics and syntax are enforced
by the server. For example, a live "content-length" property would
have its value, the length of the entity returned by a GET request,
automatically calculated by the server.
Dead Property - A property whose semantics and syntax are not
enforced by the server. The server only records the value of a dead
property; the client is responsible for maintaining the consistency
of the syntax and semantics of a dead property.
Null Resource - A resource which responds with a 404 Not Found to
any HTTP/1.1 or DAV method except for PUT, MKCOL, OPTIONS and LOCK.
A NULL resource MUST NOT appear as a member of its parent
collection.
19 Copyright 19 Copyright
The following copyright notice is copied from RFC 2026 [Bradner, The following copyright notice is copied from RFC 2026 [RFC2026],
1996], section 10.4, and describes the applicable copyright for this section 10.4, and describes the applicable copyright for this
document. document.
Copyright (C) The Internet Society April 5, 1998. All Rights Copyright (C) The Internet Society 1998. All Rights Reserved.
Reserved.
This document and translations of it may be copied and furnished to This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it others, and derivative works that comment on or otherwise explain it
or assist in its implementation may be prepared, copied, published or assist in its implementation may be prepared, copied, published
and distributed, in whole or in part, without restriction of any and distributed, in whole or in part, without restriction of any
kind, provided that the above copyright notice and this paragraph kind, provided that the above copyright notice and this paragraph
are included on all such copies and derivative works. However, this are included on all such copies and derivative works. However, this
document itself may not be modified in any way, such as by removing document itself may not be modified in any way, such as by removing
the copyright notice or references to the Internet Society or other the copyright notice or references to the Internet Society or other
Internet organizations, except as needed for the purpose of Internet organizations, except as needed for the purpose of
skipping to change at page 73, line 40 skipping to change at page 79, line 31
This document and the information contained herein is provided on an This document and the information contained herein is provided on an
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
20 Intellectual Property 20 Intellectual Property
The following notice is copied from RFC 2026 [Bradner, 1996], The following notice is copied from RFC 2026 [RFC2026], section
section 10.4, and describes the position of the IETF concerning 10.4, and describes the position of the IETF concerning intellectual
intellectual property claims made against this document. property claims made against this document.
The IETF takes no position regarding the validity or scope of any The IETF takes no position regarding the validity or scope of any
intellectual property or other rights that might be claimed to intellectual property or other rights that might be claimed to
pertain to the implementation or use other technology described in pertain to the implementation or use other technology described in
this document or the extent to which any license under such rights this document or the extent to which any license under such rights
might or might not be available; neither does it represent that it might or might not be available; neither does it represent that it
has made any effort to identify any such rights. Information on the has made any effort to identify any such rights. Information on the
IETF's procedures with respect to rights in standards-track and IETF's procedures with respect to rights in standards-track and
standards-related documentation can be found in BCP-11. Copies of standards-related documentation can be found in BCP-11. Copies of
claims of rights made available for publication and any assurances claims of rights made available for publication and any assurances
skipping to change at page 74, line 29 skipping to change at page 80, line 23
Babich, Sanford Barr, Dylan Barrell, Bernard Chester, Tim Berners- Babich, Sanford Barr, Dylan Barrell, Bernard Chester, Tim Berners-
Lee, Dan Connolly, Jim Cunningham, Ron Daniel, Jr., Jim Davis, Keith Lee, Dan Connolly, Jim Cunningham, Ron Daniel, Jr., Jim Davis, Keith
Dawson, Mark Day, Brian Deen, Martin Duerst, David Durand, Lee Dawson, Mark Day, Brian Deen, Martin Duerst, David Durand, Lee
Farrell, Chuck Fay, Wesley Felter, Roy Fielding, Mark Fisher, Alan Farrell, Chuck Fay, Wesley Felter, Roy Fielding, Mark Fisher, Alan
Freier, George Florentine, Jim Gettys, Phill Hallam-Baker, Dennis Freier, George Florentine, Jim Gettys, Phill Hallam-Baker, Dennis
Hamilton, Steve Henning, Mead Himelstein, Alex Hopmann, Andre van Hamilton, Steve Henning, Mead Himelstein, Alex Hopmann, Andre van
der Hoek, Ben Laurie, Paul Leach, Ora Lassila, Karen MacArthur, der Hoek, Ben Laurie, Paul Leach, Ora Lassila, Karen MacArthur,
Steven Martin, Larry Masinter, Michael Mealling, Keith Moore, Henrik Steven Martin, Larry Masinter, Michael Mealling, Keith Moore, Henrik
Nielsen, Kenji Ota, Bob Parker, Glenn Peterson, Jon Radoff, Saveen Nielsen, Kenji Ota, Bob Parker, Glenn Peterson, Jon Radoff, Saveen
Reddy, Henry Sanders, Christopher Seiwald, Judith Slein, Mike Reddy, Henry Sanders, Christopher Seiwald, Judith Slein, Mike
Spreitzer, Einar Stefferud, Ralph Swick, Kenji Takahashi, Richard N. Spreitzer, Einar Stefferud, Greg Stein, Ralph Swick, Kenji
Taylor, Robert Thau, John Turner, Sankar Virdhagriswaran, Fabio Takahashi, Richard N. Taylor, Robert Thau, John Turner, Sankar
Vitali, Gregory Woodhouse, and Lauren Wood. Virdhagriswaran, Fabio Vitali, Gregory Woodhouse, and Lauren Wood.
Two from this list deserve special mention. The contributions by Two from this list deserve special mention. The contributions by
Larry Masinter have been invaluable, both in helping the formation Larry Masinter have been invaluable, both in helping the formation
of the working group and in patiently coaching the authors along the of the working group and in patiently coaching the authors along the
way. In so many ways he has set high standards we have toiled to way. In so many ways he has set high standards we have toiled to
meet. The contributions of Judith Slein in clarifying the meet. The contributions of Judith Slein in clarifying the
requirements, and in patiently reviewing draft after draft, both requirements, and in patiently reviewing draft after draft, both
improved this specification and expanded our minds on document improved this specification and expanded our minds on document
management. management.
We would also like to thank John Turner for developing the XML DTD. We would also like to thank John Turner for developing the XML DTD.
22 References 22 References
22.1 Normative References 22.1 Normative References
[Alvestrand, 1995] H. T. Alvestrand, "Tags for the Identification of [RFC1766] H. T. Alvestrand, "Tags for the Identification of
Languages." RFC 1766. Uninett. March, 1995. Languages." RFC 1766. Uninett. March, 1995.
[Alvestrand, 1998] H. T. Alvestrand, "IETF Policy on Character Sets [RFC2277] H. T. Alvestrand, "IETF Policy on Character Sets and
and Languages." RFC 2277, BCP 18. Uninett. January, 1998. Languages." RFC 2277, BCP 18. Uninett. January, 1998.
[Bradner, 1997] S. Bradner, "Key words for use in RFCs to Indicate [RFC2119] S. Bradner, "Key words for use in RFCs to Indicate
Requirement Levels." RFC 2119, BCP 14. Harvard University. March, Requirement Levels." RFC 2119, BCP 14. Harvard
1997. University. March, 1997.
[Bray, Paoli, Sperberg-McQueen, 1998] T. Bray, J. Paoli, C. M. [RFC2396] T. Berners-Lee, R. Fielding, L. Masinter, "Uniform
Sperberg-McQueen, "Extensible Markup Language (XML)." World Wide Web Resource Identifiers (URI): Generic Syntax." RFC 2396.
Consortium Recommendation REC-xml-19980210. MIT/LCS, U.C. Irvine, Xerox. August, 1998.
[REC-XML] T. Bray, J. Paoli, C. M. Sperberg-McQueen, "Extensible
Markup Language (XML)." World Wide Web Consortium
Recommendation REC-xml-19980210.
http://www.w3.org/TR/1998/REC-xml-19980210. http://www.w3.org/TR/1998/REC-xml-19980210.
[Franks et al., 1997] J. Franks, P. Hallam-Baker, J. Hostetler, P. [RFC2069] J. Franks, P. Hallam-Baker, J. Hostetler, P. Leach, A.
Leach, A. Luotonen, E. Sink, and L. Stewart. "An Extension to HTTP : Luotonen, E. Sink, and L. Stewart. "An Extension to HTTP :
Digest Access Authentication" RFC 2069. Northwestern University, Digest Access Authentication" RFC 2069. Northwestern
CERN, Spyglass Inc., Microsoft Corp., Netscape Communications Corp., University, CERN, Spyglass Inc., Microsoft Corp., Netscape
Spyglass Inc., Open Market Inc. January 1997. Communications Corp., Spyglass Inc., Open Market Inc.
January 1997.
[Fielding et al., 1997] R. Fielding, J. Gettys, J. Mogul, H. [RFC2068] R. Fielding, J. Gettys, J. Mogul, H. Frystyk, T. Berners-
Frystyk, T. Berners-Lee, "Hypertext Transfer Protocol -- HTTP/1.1." Lee, "Hypertext Transfer Protocol -- HTTP/1.1." RFC 2068.
RFC 2068. U.C. Irvine, DEC, MIT/LCS. January, 1997. U.C. Irvine, DEC, MIT/LCS. January, 1997.
[ISO-639] ISO (International Organization for Standardization). ISO [ISO-639] ISO (International Organization for Standardization). ISO
639:1988. "Code for the representation of names of languages." 639:1988. "Code for the representation of names of
languages."
[ISO-8601] ISO (International Organization for Standardization). ISO [ISO-8601] ISO (International Organization for Standardization). ISO
8601:1988. "Data elements and interchange formats - Information 8601:1988. "Data elements and interchange formats -
interchange - Representation of dates and times." Information interchange - Representation of dates and
times."
[Leach, Salz, 1998] P. J. Leach, R. Salz, "UUIDs and GUIDs." [ISO-11578] ISO (International Organization for Standardization).
Internet-draft, work-in-progress, February, 1998. ISO/IEC 11578:1996. "Information technology - Open Systems
ftp://ietf.org/internet-drafts/draft-leach-uuids-guids-01.txt Interconnection - Remote Procedure Call (RPC)"
[Yergeau, 1998] F. Yergeau, "UTF-8, a transformation format of [UTF-8] F. Yergeau, "UTF-8, a transformation format of Unicode and
Unicode and ISO 10646." RFC 2279. Alis Technologies. January, 1998. ISO 10646." RFC 2279. Alis Technologies. January, 1998.
22.2 Informational References 22.2 Informational References
[Bradner, 1996] S. Bradner, "The Internet Standards Process - [RFC2026] S. Bradner, "The Internet Standards Process - Revision 3."
Revision 3." RFC 2026, BCP 9. Harvard University. October, 1996. RFC 2026, BCP 9. Harvard University. October, 1996.
[Bray, Hollander, Layman, 1998] T. Bray, D. Hollander, A. Layman, [WD-XML-NAMES] T. Bray, D. Hollander, A. Layman, "Name Spaces in
"Name Spaces in XML" World Wide Web Consortium Working Draft, XML" World Wide Web Consortium Working Draft,
http://www.w3.org/TR/WD-xml-names. http://www.w3.org/TR/WD-xml-names.
[Lasher, Cohen, 1995] R. Lasher, D. Cohen, "A Format for [RFC1807] R. Lasher, D. Cohen, "A Format for Bibliographic Records,"
Bibliographic Records," RFC 1807. Stanford, Myricom. June, 1995. RFC 1807. Stanford, Myricom. June, 1995.
[MARC, 1994] Network Development and MARC Standards, Office, ed. [USMARC] Network Development and MARC Standards, Office, ed. 1994.
1994. "USMARC Format for Bibliographic Data", 1994. Washington, DC: "USMARC Format for Bibliographic Data", 1994. Washington,
Cataloging Distribution Service, Library of Congress. DC: Cataloging Distribution Service, Library of Congress.
[Miller et al., 1996] J. Miller, T. Krauskopf, P. Resnick, W. [REC-PICS] J. Miller, T. Krauskopf, P. Resnick, W. Treese, "PICS
Treese, "PICS Label Distribution Label Syntax and Communication Label Distribution Label Syntax and Communication
Protocols" Version 1.1, World Wide Web Consortium Recommendation Protocols" Version 1.1, World Wide Web Consortium
REC-PICS-labels-961031. http://www.w3.org/pub/WWW/TR/REC-PICS- Recommendation REC-PICS-labels-961031.
labels-961031.html. http://www.w3.org/pub/WWW/TR/REC-PICS-labels-961031.html.
[Slein et al., 1998] J. A. Slein, F. Vitali, E. J. Whitehead, Jr., [RFC2291] J. A. Slein, F. Vitali, E. J. Whitehead, Jr., D. Durand,
D. Durand, "Requirements for Distributed Authoring and Versioning "Requirements for Distributed Authoring and Versioning
Protocol for the World Wide Web." RFC 2291. Xerox, Univ. of Bologna, Protocol for the World Wide Web." RFC 2291. Xerox, Univ.
U.C. Irvine, Boston Univ. February, 1998. of Bologna, U.C. Irvine, Boston Univ. February, 1998.
[Weibel et al., 1995] S. Weibel, J. Godby, E. Miller, R. Daniel, [RFC2413] S. Weibel, J. Kunze, C. Lagoze, M. Wolf, "Dublin Core
"OCLC/NCSA Metadata Workshop Report." Metadata for Resource Discovery." RFC 2413. OCLC, UCSF,
http://purl.oclc.org/metadata/dublin_core_report. Cornell, Reuters. September, 1998.
[RFC2376] E. Whitehead, M. Murata, "XML Media Types." RFC 2376. U.C.
Irvine, Fuji Xerox Info. Systems. July 1998.
23 Authors' Addresses 23 Authors' Addresses
Y. Y. Goland Y. Y. Goland
Microsoft Corporation Microsoft Corporation
One Microsoft Way One Microsoft Way
Redmond, WA 98052-6399 Redmond, WA 98052-6399
Email: yarong@microsoft.com Email: yarong@microsoft.com
E. J. Whitehead, Jr. E. J. Whitehead, Jr.
skipping to change at page 78, line 10 skipping to change at page 84, line 10
1555 N. Technology Way 1555 N. Technology Way
M/S ORM F111 M/S ORM F111
Orem, UT 84097-2399 Orem, UT 84097-2399
Email: dcjensen@novell.com Email: dcjensen@novell.com
24 Appendices 24 Appendices
24.1 Appendix 1 - WebDAV Document Type Definition 24.1 Appendix 1 - WebDAV Document Type Definition
This section provides a document type definition, following the This section provides a document type definition, following the
rules in [Bray, Paoli, Sperberg-McQueen, 1998], for the XML elements rules in [REC-XML], for the XML elements used in the protocol stream
used in the protocol stream and in the values of properties. It and in the values of properties. It collects the element definitions
collects the element definitions given in sections 11 and 12. given in sections 12 and 13.
<!DOCTYPE webdav-1.0 [ <!DOCTYPE webdav-1.0 [
<!--============ XML Elements from Section 11 ==================--> <!--============ XML Elements from Section 12 ==================-->
<!ELEMENT activelock (lockscope, locktype, depth, owner?, timeout?, <!ELEMENT activelock (lockscope, locktype, depth, owner?, timeout?,
locktoken?) > locktoken?) >
<!ELEMENT lockentry (lockscope, locktype) > <!ELEMENT lockentry (lockscope, locktype) >
<!ELEMENT lockinfo (lockscope, locktype, owner?) > <!ELEMENT lockinfo (lockscope, locktype, owner?) >
<!ELEMENT locktype (write) > <!ELEMENT locktype (write) >
<!ELEMENT write EMPTY > <!ELEMENT write EMPTY >
skipping to change at page 78, line 50 skipping to change at page 84, line 50
<!ELEMENT link (src+, dst+) > <!ELEMENT link (src+, dst+) >
<!ELEMENT dst (#PCDATA) > <!ELEMENT dst (#PCDATA) >
<!ELEMENT src (#PCDATA) > <!ELEMENT src (#PCDATA) >
<!ELEMENT multistatus (response+, responsedescription?) > <!ELEMENT multistatus (response+, responsedescription?) >
<!ELEMENT response (href, ((href*, status)|(propstat+)), <!ELEMENT response (href, ((href*, status)|(propstat+)),
responsedescription?) > responsedescription?) >
<!ELEMENT status (#PCDATA) > <!ELEMENT status (#PCDATA) >
<!ELEMENT propstat (prop, status) > <!ELEMENT propstat (prop, status, responsedescription?) >
<!ELEMENT responsedescription (#PCDATA) > <!ELEMENT responsedescription (#PCDATA) >
<!ELEMENT prop ANY > <!ELEMENT prop ANY >
<!ELEMENT propertybehavior (omit | keepalive) > <!ELEMENT propertybehavior (omit | keepalive) >
<!ELEMENT omit EMPTY > <!ELEMENT omit EMPTY >
<!ELEMENT keepalive (#PCDATA | href+) > <!ELEMENT keepalive (#PCDATA | href+) >
<!ELEMENT propertyupdate (remove | set)+ > <!ELEMENT propertyupdate (remove | set)+ >
<!ELEMENT remove (prop) > <!ELEMENT remove (prop) >
<!ELEMENT set (prop) > <!ELEMENT set (prop) >
<!ELEMENT propfind (allprop | propname | prop) > <!ELEMENT propfind (allprop | propname | prop) >
<!ELEMENT allprop EMPTY > <!ELEMENT allprop EMPTY >
<!ELEMENT propname EMPTY > <!ELEMENT propname EMPTY >
<!ELEMENT collection EMPTY > <!ELEMENT collection EMPTY >
<!--=========== Property Elements from Section 12 ===============--> <!--=========== Property Elements from Section 13 ===============-->
<!ELEMENT creationdate (#PCDATA) > <!ELEMENT creationdate (#PCDATA) >
<!ELEMENT displayname (#PCDATA) > <!ELEMENT displayname (#PCDATA) >
<!ELEMENT getcontentlanguage (#PCDATA) > <!ELEMENT getcontentlanguage (#PCDATA) >
<!ELEMENT getcontentlength (#PCDATA) > <!ELEMENT getcontentlength (#PCDATA) >
<!ELEMENT getcontenttype (#PCDATA) > <!ELEMENT getcontenttype (#PCDATA) >
<!ELEMENT getetag (#PCDATA) > <!ELEMENT getetag (#PCDATA) >
<!ELEMENT getlastmodified (#PCDATA) > <!ELEMENT getlastmodified (#PCDATA) >
<!ELEMENT lockdiscovery (activelock)* > <!ELEMENT lockdiscovery (activelock)* >
<!ELEMENT resourcetype ANY > <!ELEMENT resourcetype ANY >
skipping to change at page 80, line 50 skipping to change at page 86, line 48
especially not in the area of the meaning of elements. especially not in the area of the meaning of elements.
There is no kindness in accepting illegal combinations of XML There is no kindness in accepting illegal combinations of XML
elements. At best it will cause an unwanted result and at worst it elements. At best it will cause an unwanted result and at worst it
can cause real damage. can cause real damage.
24.3.2.1 Example - XML Syntax Error 24.3.2.1 Example - XML Syntax Error
The following request body for a PROPFIND method is illegal. The following request body for a PROPFIND method is illegal.
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:propfind xmlns:D="DAV:">
<D:propfind>
<D:allprop/> <D:allprop/>
<D:propname/> <D:propname/>
</D:propfind> </D:propfind>
The definition of the propfind element only allows for the allprop The definition of the propfind element only allows for the allprop
or the propname element, not both. Thus the above is an error and or the propname element, not both. Thus the above is an error and
must be responded to with a 400 Bad Request. must be responded to with a 400 (Bad Request).
Imagine, however, that a server wanted to be "kind" and decided to Imagine, however, that a server wanted to be "kind" and decided to
pick the allprop element as the true element and respond to it. A pick the allprop element as the true element and respond to it. A
client running over a bandwidth limited line who intended to execute client running over a bandwidth limited line who intended to execute
a propname would be in for a big surprise if the server treated the a propname would be in for a big surprise if the server treated the
command as an allprop. command as an allprop.
Additionally, if a server were lenient and decided to reply to this Additionally, if a server were lenient and decided to reply to this
request, the results would vary randomly from server to server, with request, the results would vary randomly from server to server, with
some servers executing the allprop directive, and others executing some servers executing the allprop directive, and others executing
the propname directive. This reduces interoperability rather than the propname directive. This reduces interoperability rather than
increasing it. increasing it.
24.3.2.2 Example - Unknown XML Element 24.3.2.2 Example - Unknown XML Element
skipping to change at page 81, line 28 skipping to change at page 87, line 27
the propname directive. This reduces interoperability rather than the propname directive. This reduces interoperability rather than
increasing it. increasing it.
24.3.2.2 Example - Unknown XML Element 24.3.2.2 Example - Unknown XML Element
The previous example was illegal because it contained two elements The previous example was illegal because it contained two elements
that were explicitly banned from appearing together in the propfind that were explicitly banned from appearing together in the propfind
element. However, XML is an extensible language, so one can imagine element. However, XML is an extensible language, so one can imagine
new elements being defined for use with propfind. Below is the new elements being defined for use with propfind. Below is the
request body of a PROPFIND and, like the previous example, must be request body of a PROPFIND and, like the previous example, must be
rejected with a 400 Bad Request by a server that does not understand rejected with a 400 (Bad Request) by a server that does not
the expired-props element. understand the expired-props element.
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:propfind xmlns:D="DAV:"
<?xml:namespace ns="http://www.foo.bar/standards/props/" prefix="E" xmlns:E="http://www.foo.bar/standards/props/">
?>
<D:propfind>
<E:expired-props/> <E:expired-props/>
</D:propfind> </D:propfind>
To understand why a 400 Bad Request is returned let us look at the To understand why a 400 (Bad Request) is returned let us look at the
request body as the server unfamiliar with expired-props sees it. request body as the server unfamiliar with expired-props sees it.
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:propfind xmlns:D="DAV:"
<?xml:namespace ns="http://www.foo.bar/standards/props/" prefix="E" xmlns:E="http://www.foo.bar/standards/props/">
?>
<D:propfind>
</D:propfind> </D:propfind>
As the server does not understand the expired-props element, by the As the server does not understand the expired-props element,
rules of XML, it must ignore it. Thus the server sees an empty according to the WebDAV-specific XML processing rules specified in
section 14, it must ignore it. Thus the server sees an empty
propfind, which by the definition of the propfind element is propfind, which by the definition of the propfind element is
illegal. illegal.
Please note that had the extension been additive it would not Please note that had the extension been additive it would not
necessarily have resulted in a 400 Bad Request. For example, necessarily have resulted in a 400 (Bad Request). For example,
imagine the following request body for a PROPFIND: imagine the following request body for a PROPFIND:
<?xml version="1.0" ?> <?xml version="1.0" encoding="utf-8" ?>
<?xml:namespace ns="DAV:" prefix="D" ?> <D:propfind xmlns:D="DAV:"
<?xml:namespace ns="http://www.foo.bar/standards/props/" prefix="E" xmlns:E="http://www.foo.bar/standards/props/">
?>
<D:propfind>
<D:propname/> <D:propname/>
<E:leave-out>*boss*</E:leave-out> <E:leave-out>*boss*</E:leave-out>
</D:propfind> </D:propfind>
The previous example contains the fictitious element leave-out. Its The previous example contains the fictitious element leave-out. Its
purpose is to prevent the return of any property whose name matches purpose is to prevent the return of any property whose name matches
the submitted pattern. If the previous example were submitted to a the submitted pattern. If the previous example were submitted to a
server unfamiliar with leave-out, the only result would be that the server unfamiliar with leave-out, the only result would be that the
leave-out element would be ignored and a propname would be executed. leave-out element would be ignored and a propname would be executed.
skipping to change at page 82, line 36 skipping to change at page 88, line 30
24.4.1 Introduction 24.4.1 Introduction
To provide a unique space of XML element names which has To provide a unique space of XML element names which has
decentralized extensibility, this specification uses a feature of decentralized extensibility, this specification uses a feature of
XML known as XML "namespaces". This appendix provides a normative XML known as XML "namespaces". This appendix provides a normative
reference for XML namespace functionality for implementations of reference for XML namespace functionality for implementations of
this specification. All DAV compliant systems MUST support the XML this specification. All DAV compliant systems MUST support the XML
namespace extension as specified in this appendix. namespace extension as specified in this appendix.
The remainder of this appendix is intended to match, as closely as The remainder of this appendix is intended to match, as closely as
needed, the text in WD-xml-names-19980327, "Namespaces in XML", needed, the text in WD-xml-names-19980916, "Namespaces in XML",
edited by Tim Bray, Dave Hollander, and Andrew Layman [Bray, edited by Tim Bray, Dave Hollander, and Andrew Layman [WD-XML-
Hollander, Layman, 1998]. To meet this goal, the text in this NAMES]. To meet this goal, the text in this appendix is mostly
appendix is mostly quoted verbatim from that source. The notational quoted verbatim from sections 1-6 of that source. However, some
conventions and BNF productions in this appendix match those of the minor changes were made, specifically to make the references match
XML specification [Bray, Paoli, Spreberg-McQueen, 1998] the style of this document, and a forward reference to appendix A
(non-normative) of [REC-XML] was removed, as no appendices of [REC-
XML namespaces are based on the use of qualified names, which XML] are duplicated here.
contain a single colon, separating the name into a namespace prefix
and the local name. The prefix, which is mapped to a URI, selects a
namespace. The combination of the universally-managed URI namespace
and the local schema namespace produces names that are guaranteed
universally unique.
URIs can contain characters not allowed in names, and so cannot be
used directly as namespace prefixes. Therefore, the namespace
prefix serves as a proxy for a URI. A special processing
instruction described below is used to declare the association of
the namespace prefix with a URI; software which supports this
namespace proposal must recognize and act on it.
A namespace is declared using a reserved processing instruction as
follows:
24.4.2 Namespace Declaration PI 24.4.2 Motivation and Summary
[1] NamespacePI ::= '<?xml:namespace' (S (PrefixDef | NSDef | We envision applications of Extensible Markup Language (XML) where a
SrcDef))+ '?>' [ NSC: Required Parts ] single XML document may contain elements and attributes that are
[2] NSDef ::= 'ns' Eq SystemLiteral [ NSC: No Fragments ] defined for and used by multiple software modules. One motivation
[3] SrcDef ::= 'src' Eq SystemLiteral for this is modularity; if such a markup vocabulary exists which is
[4] PrefixDef ::= 'prefix' Eq ("'" NCName "'" | '"' NCName '"') well-understood and for which there is useful software available, it
[5] NCName ::= (Letter | '_') (NCNameChar)* /* An XML Name, minus is better to re-use this markup rather than re-invent it.
the ":" */
[6] NCNameChar ::= Letter | Digit | '.' | '-' | '_' |
CombiningChar | Extender
[Definition:] The SystemLiteral in the NSDef production is a URI Such documents, containing multiple markup vocabularies, pose
which functions as a namespace name to identify the namespace. The problems of recognition and collision. Software modules need to be
SystemLiteral in the SrcDef production is an optional URI which may able to recognize the tags and attributes which they are designed to
be used to retrieve the schema, if one is provided. Some namespaces process, even in the face of "collisions" occurring when markup
need no schemas; this specification does not depend on their intended for some other software package uses the same element type
existence, or on the use of any particular machine- or human- or attribute name.
readable syntax in the schema.
[Definition:] The NCName in the PrefixDef production gives the These considerations require that document constructs should have
namespace prefix used to associate names in an XML document with universal names, whose scope extends beyond their containing
this namespace. document. This specification describes a mechanism, XML namespaces,
which accomplishes this.
Namespace Constraint: Required Parts [Definition:] An XML namespace is a collection of names, identified
by a URI, which are used in XML documents as element types and
attribute names. XML namespaces differ from the "namespaces"
conventionally used in co