draft-ietf-webdav-acl-08.txt | draft-ietf-webdav-acl-09.txt | |||
---|---|---|---|---|
INTERNET-DRAFT Geoffrey Clemm, Rational Software | INTERNET-DRAFT Geoffrey Clemm, Rational Software | |||
draft-ietf-webdav-acl-08 Anne Hopkins, Microsoft Corporation | draft-ietf-webdav-acl-09 Anne Hopkins, Microsoft Corporation | |||
Eric Sedlar, Oracle Corporation | Eric Sedlar, Oracle Corporation | |||
Jim Whitehead, U.C. Santa Cruz | Jim Whitehead, U.C. Santa Cruz | |||
Expires November 7, 2002 May 7, 2002 | Expires January 26, 2003 July 26, 2002 | |||
WebDAV Access Control Protocol | WebDAV Access Control Protocol | |||
Status of this Memo | Status of this Memo | |||
This document is an Internet-Draft and is in full conformance with | This document is an Internet-Draft and is subject to all provisions | |||
all provisions of Section 10 of RFC2026. | of Section 10 of RFC2026. | |||
Internet-Drafts are working documents of the Internet Engineering | Internet-Drafts are working documents of the Internet Engineering | |||
Task Force (IETF), its areas, and its working groups. Note that other | Task Force (IETF), its areas, and its working groups. Note that other | |||
groups may also distribute working documents as Internet-Drafts. | groups may also distribute working documents as Internet-Drafts. | |||
Internet-Drafts are draft documents valid for a maximum of six months | Internet-Drafts are draft documents valid for a maximum of six months | |||
and may be updated, replaced, or obsoleted by other documents at any | and may be updated, replaced, or obsoleted by other documents at any | |||
time. It is inappropriate to use Internet- Drafts as reference | time. It is inappropriate to use Internet- Drafts as reference | |||
material or to cite them other than as "work in progress." | material or to cite them other than as "work in progress." | |||
The list of current Internet-Drafts can be accessed at | The list of current Internet-Drafts can be accessed at | |||
http://www.ietf.org/ietf/1id-abstracts.txt | http://www.ietf.org/ietf/1id-abstracts.txt | |||
The list of Internet-Draft Shadow Directories can be accessed at | The list of Internet-Draft Shadow Directories can be accessed at | |||
http://www.ietf.org/shadow.html. | http://www.ietf.org/shadow.html. | |||
Abstract | Abstract | |||
This document specifies a set of methods, headers, and message bodies | This document specifies a set of methods, headers, message bodies, | |||
that define Access Control extensions to the WebDAV Distributed | properties, and reports that define Access Control extensions to the | |||
Authoring Protocol. This protocol permits a client to read and modify | WebDAV Distributed Authoring Protocol. This protocol permits a client | |||
access control lists that instruct a server whether to allow or deny | to read and modify access control lists that instruct a server | |||
operations upon a resource (such as HTTP method invocations) by a | whether to allow or deny operations upon a resource (such as | |||
given principal. | HyperText Transfer Protocol (HTTP) method invocations) by a given | |||
principal. A lightweight representation of principals as Web | ||||
resources supports integration of a wide range of user management | ||||
repositories. Search operations allow discovery and manipulation of | ||||
principals using human names. | ||||
This document is a product of the Web Distributed Authoring and | This document is a product of the Web Distributed Authoring and | |||
Versioning (WebDAV) working group of the Internet Engineering Task | Versioning (WebDAV) working group of the Internet Engineering Task | |||
Force. Comments on this draft are welcomed, and should be addressed | Force. Comments on this draft are welcomed, and should be addressed | |||
to the acl@webdav.org mailing list. Other related documents can be | to the acl@webdav.org mailing list. Other related documents can be | |||
found at http://www.webdav.org/acl/, and | found at http://www.webdav.org/acl/, and | |||
http://www.ics.uci.edu/pub/ietf/webdav/. | http://www.ics.uci.edu/pub/ietf/webdav/. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 1] | Clemm, Hopkins, Sedlar, Whitehead [Page 1] | |||
Table of Contents | Table of Contents | |||
1 INTRODUCTION...................................................4 | 1 INTRODUCTION....................................................4 | |||
1.1 Terms........................................................7 | 1.1 Terms.........................................................7 | |||
1.2 Notational Conventions.......................................8 | 1.2 Notational Conventions........................................8 | |||
2 PRINCIPALS.....................................................8 | 2 PRINCIPALS......................................................8 | |||
3 PRIVILEGES.....................................................9 | 3 PRIVILEGES......................................................9 | |||
3.1 DAV:read Privilege...........................................10 | 3.1 DAV:read Privilege...........................................10 | |||
3.2 DAV:write Privilege..........................................10 | 3.2 DAV:write Privilege..........................................10 | |||
3.3 DAV:write-properties.........................................11 | 3.3 DAV:write-properties.........................................10 | |||
3.4 DAV:write-content............................................11 | 3.4 DAV:write-content............................................11 | |||
3.5 DAV:unlock...................................................11 | 3.5 DAV:unlock...................................................11 | |||
3.6 DAV:read-acl Privilege.......................................12 | 3.6 DAV:read-acl Privilege.......................................12 | |||
3.7 DAV:read-current-user-privilege-set Privilege................12 | 3.7 DAV:read-current-user-privilege-set Privilege................12 | |||
3.8 DAV:write-acl Privilege......................................12 | 3.8 DAV:write-acl Privilege......................................12 | |||
3.9 DAV:all Privilege............................................12 | 3.9 DAV:all Privilege............................................12 | |||
3.10 Aggregation of Predefined Privileges........................12 | 3.10 Aggregation of Predefined Privileges........................12 | |||
4 PRINCIPAL PROPERTIES...........................................13 | 4 PRINCIPAL PROPERTIES...........................................13 | |||
4.1 DAV:alternate-URI-set........................................13 | 4.1 DAV:alternate-URI-set........................................14 | |||
4.2 DAV:principal-URL............................................14 | 4.2 DAV:principal-URL............................................14 | |||
4.3 DAV:group-membership.........................................14 | 4.3 DAV:group-member-set.........................................14 | |||
4.4 DAV:group-membership.........................................14 | ||||
5 ACCESS CONTROL PROPERTIES......................................14 | 5 ACCESS CONTROL PROPERTIES......................................15 | |||
5.1 DAV:owner....................................................14 | 5.1 DAV:owner....................................................15 | |||
5.1.1 Example: Retrieving DAV:owner............................15 | 5.1.1 Example: Retrieving DAV:owner............................15 | |||
5.1.2 Example: An Attempt to Set DAV:owner.....................16 | 5.1.2 Example: An Attempt to Set DAV:owner.....................16 | |||
5.2 DAV:supported-privilege-set..................................17 | 5.2 DAV:supported-privilege-set..................................17 | |||
5.2.1 Example: Retrieving a List of Privileges Supported on a | 5.2.1 Example: Retrieving a List of Privileges Supported on a | |||
Resource.......................................................18 | Resource.......................................................18 | |||
5.3 DAV:current-user-privilege-set...............................20 | 5.3 DAV:current-user-privilege-set...............................20 | |||
5.3.1 Example: Retrieving the User's Current Set of Assigned | 5.3.1 Example: Retrieving the User's Current Set of Assigned | |||
Privileges.....................................................21 | Privileges.....................................................21 | |||
5.4 DAV:acl......................................................22 | 5.4 DAV:acl......................................................22 | |||
5.4.1 ACE Principal............................................22 | 5.4.1 ACE Principal............................................22 | |||
5.4.2 ACE Grant and Deny.......................................23 | 5.4.2 ACE Grant and Deny.......................................24 | |||
5.4.3 ACE Protection...........................................24 | 5.4.3 ACE Protection...........................................24 | |||
5.4.4 ACE Inheritance..........................................24 | 5.4.4 ACE Inheritance..........................................24 | |||
5.4.5 Example: Retrieving a Resource's Access Control List.....24 | 5.4.5 Example: Retrieving a Resource's Access Control List.....25 | |||
5.5 DAV:inherited-acl............................................26 | 5.5 DAV:acl-semantics............................................26 | |||
5.6 DAV:acl-semantics............................................26 | 5.5.1 Example: Retrieving DAV:acl-semantics....................27 | |||
5.6.1 Example: Retrieving DAV:acl-semantics....................26 | 5.6 DAV:inherited-acl-set........................................28 | |||
5.7 DAV:principal-collection-set.................................28 | 5.7 DAV:principal-collection-set.................................28 | |||
5.7.1 Example: Retrieving DAV:principal-collection-set.........29 | 5.7.1 Example: Retrieving DAV:principal-collection-set.........29 | |||
5.8 Example: PROPFIND to retrieve access control properties......30 | 5.8 Example: PROPFIND to retrieve access control properties......30 | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 2] | Clemm, Hopkins, Sedlar, Whitehead [Page 2] | |||
6 ACL SEMANTICS.................................................34 | 6 ACL SEMANTICS..................................................34 | |||
6.1 ACE Combination.............................................34 | 6.1 ACE Combination..............................................34 | |||
6.1.1 DAV:first-match ACE Combination.........................34 | 6.1.1 DAV:first-match ACE Combination..........................34 | |||
6.1.2 DAV:all-grant-before-any-deny ACE Combination...........34 | 6.1.2 DAV:all-grant-before-any-deny ACE Combination............34 | |||
6.1.3 DAV:specific-deny-overrides-grant ACE Combination.......34 | 6.1.3 DAV:specific-deny-overrides-grant ACE Combination........35 | |||
6.2 ACE Ordering................................................35 | 6.2 ACE Ordering.................................................35 | |||
6.2.1 DAV:deny-before-grant ACE Ordering......................35 | 6.2.1 DAV:deny-before-grant ACE Ordering.......................35 | |||
6.3 Allowed ACE.................................................35 | 6.3 Allowed ACE..................................................35 | |||
6.3.1 DAV:principal-only-one-ace ACE Constraint...............35 | 6.3.1 DAV:principal-only-one-ace ACE Constraint................35 | |||
6.3.2 DAV:grant-only ACE Constraint...........................35 | 6.3.2 DAV:grant-only ACE Constraint............................35 | |||
6.3.3 DAV:no-invert ACE Constraint............................35 | 6.3.3 DAV:no-invert ACE Constraint.............................36 | |||
6.3.4 DAV:no-acl-inherit ACE Constraint.......................36 | 6.4 Required Principals..........................................36 | |||
6.4 Required Principals.........................................36 | ||||
7 ACCESS CONTROL AND EXISTING METHODS...........................36 | 7 ACCESS CONTROL AND EXISTING METHODS............................36 | |||
7.1 OPTIONS.....................................................36 | 7.1 OPTIONS......................................................36 | |||
7.1.1 Example - OPTIONS.......................................36 | 7.1.1 Example - OPTIONS........................................36 | |||
7.2 MOVE........................................................37 | 7.2 MOVE.........................................................37 | |||
7.3 COPY........................................................37 | 7.3 COPY.........................................................37 | |||
7.4 DELETE......................................................37 | 7.4 DELETE.......................................................37 | |||
7.5 LOCK........................................................37 | 7.5 LOCK.........................................................37 | |||
8 ACCESS CONTROL METHODS........................................37 | 8 ACCESS CONTROL METHODS.........................................37 | |||
8.1 ACL.........................................................37 | 8.1 ACL..........................................................37 | |||
8.1.1 ACL Preconditions.......................................38 | 8.1.1 ACL Preconditions........................................38 | |||
8.1.2 Example: the ACL method.................................40 | 8.1.2 Example: the ACL method..................................40 | |||
8.1.3 Example: ACL method failure due to protected ACE conflict | 8.1.3 Example: ACL method failure due to protected ACE | |||
.....41 | conflict ................................................41 | |||
8.1.4 Example: ACL method failure due to an inherited ACE conflict | 8.1.4 Example: ACL method failure due to an inherited ACE | |||
.....42 | conflict ................................................42 | |||
8.1.5 Example: ACL method failure due to an attempt to set grant | 8.1.5 Example: ACL method failure due to an attempt to set | |||
and deny in a single ACE......................................43 | grant and deny in a single ACE ..........................43 | |||
9 ACCESS CONTROL REPORTS........................................44 | 9 ACCESS CONTROL REPORTS.........................................44 | |||
9.1 REPORT Method...............................................44 | 9.1 REPORT Method................................................44 | |||
9.2 DAV:acl-principal-prop-set Report...........................44 | 9.2 DAV:acl-principal-prop-set Report............................44 | |||
9.2.1 Example: DAV:acl-principal-prop-set Report..............45 | 9.2.1 Example: DAV:acl-principal-prop-set Report...............45 | |||
9.3 DAV:principal-match REPORT..................................46 | 9.3 DAV:principal-match REPORT...................................46 | |||
9.3.1 Example: DAV:principal-match REPORT.....................47 | 9.3.1 Example: DAV:principal-match REPORT......................48 | |||
9.4 DAV:principal-property-search REPORT........................48 | 9.4 DAV:principal-property-search REPORT.........................48 | |||
9.4.1 Matching................................................50 | 9.4.1 Matching.................................................51 | |||
9.4.2 Example: successful DAV:principal-property-search REPORT | 9.4.2 Example: successful DAV:principal-property-search REPORT 51 | |||
.....51 | 9.4.3 Example: Unsuccessful DAV:principal-property-search | |||
9.4.3 Example: Unsuccessful DAV:principal-property-search REPORT | REPORT ..................................................53 | |||
.....53 | 9.5 DAV:principal-search-property-set REPORT.....................54 | |||
9.5 DAV:principal-search-property-set REPORT....................54 | 9.5.1 Example: DAV:principal-search-property-set REPORT........56 | |||
9.5.1 Example: DAV:principal-search-property-set REPORT.......55 | ||||
10 XML PROCESSING..............................................56 | 10 XML PROCESSING...............................................57 | |||
11 INTERNATIONALIZATION CONSIDERATIONS.........................56 | 11 INTERNATIONALIZATION CONSIDERATIONS..........................57 | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 3] | Clemm, Hopkins, Sedlar, Whitehead [Page 3] | |||
12 SECURITY CONSIDERATIONS......................................57 | 12 SECURITY CONSIDERATIONS......................................58 | |||
12.1 Increased Risk of Compromised Users.........................57 | 12.1 Increased Risk of Compromised Users.........................58 | |||
12.2 Risks of the DAV:read-acl and DAV:current-user-privilege-set | 12.2 Risks of the DAV:read-acl and DAV:current-user-privilege-set | |||
Privileges.......................................................57 | Privileges.......................................................58 | |||
12.3 No Foreknowledge of Initial ACL.............................58 | 12.3 No Foreknowledge of Initial ACL.............................59 | |||
13 AUTHENTICATION...............................................58 | 13 AUTHENTICATION...............................................59 | |||
14 IANA CONSIDERATIONS..........................................59 | 14 IANA CONSIDERATIONS..........................................60 | |||
15 INTELLECTUAL PROPERTY........................................59 | 15 INTELLECTUAL PROPERTY........................................60 | |||
16 ACKNOWLEDGEMENTS.............................................59 | 16 ACKNOWLEDGEMENTS.............................................60 | |||
17 REFERENCES...................................................60 | 17 REFERENCES...................................................61 | |||
17.1 Normative References........................................60 | 17.1 Normative References........................................61 | |||
17.2 Informational References....................................61 | 17.2 Informational References....................................61 | |||
18 AUTHORS' ADDRESSES...........................................61 | 18 AUTHORS' ADDRESSES...........................................62 | |||
19 APPENDICES...................................................62 | 19 APPENDICES...................................................63 | |||
19.1 WebDAV XML Document Type Definition Addendum................62 | 19.1 WebDAV XML Document Type Definition Addendum................63 | |||
1 INTRODUCTION | 1 INTRODUCTION | |||
The goal of the WebDAV access control extensions is to provide an | The goal of the WebDAV access control extensions is to provide an | |||
interoperable mechanism for handling discretionary access control | interoperable mechanism for handling discretionary access control | |||
for content and metadata managed by WebDAV servers. WebDAV access | for content and metadata managed by WebDAV servers. WebDAV access | |||
control can be implemented on content repositories with security as | control can be implemented on content repositories with security as | |||
simple as that of a UNIX file system, as well as more sophisticated | simple as that of a UNIX file system, as well as more sophisticated | |||
models. The underlying principle of access control is that who you | models. The underlying principle of access control is that who you | |||
are determines what operations you can perform on a resource. The | are determines what operations you can perform on a resource. The | |||
skipping to change at line 204 | skipping to change at line 207 | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 4] | Clemm, Hopkins, Sedlar, Whitehead [Page 4] | |||
resources. There is no guarantee that the URLs identifying | resources. There is no guarantee that the URLs identifying | |||
principals will be meaningful to a human. For example, | principals will be meaningful to a human. For example, | |||
http://www.dav.org/u/256432 and | http://www.dav.org/u/256432 and | |||
http://www.dav.org/people/Greg.Stein are both valid URLs that could | http://www.dav.org/people/Greg.Stein are both valid URLs that could | |||
be used to identify the same principal. To remedy this, every | be used to identify the same principal. To remedy this, every | |||
principal resource has the DAV:displayname property containing a | principal resource has the DAV:displayname property containing a | |||
human-readable name for the principal. | human-readable name for the principal. | |||
Since a principal can be identified by multiple URLs, it raises the | Since a principal can be identified by multiple URLs, it raises the | |||
problem of determining exactly which principal's operations are | problem of determining exactly which principal is being referenced | |||
being described in a given ACE. It is impossible for a client to | in a given ACE. It is impossible for a client to determine that an | |||
determine that an ACE granting the read privilege to | ACE granting the read privilege to | |||
http://www.dav.org/people/Greg.Stein also affects the principal at | http://www.dav.org/people/Greg.Stein also affects the principal at | |||
http://www.dav.org/u/256432. That is, a client has no mechanism for | http://www.dav.org/u/256432. That is, a client has no mechanism for | |||
determining that two URLs identify the same principal resource. As | determining that two URLs identify the same principal resource. As | |||
a result, this specification requires clients to use just one of | a result, this specification requires clients to use just one of | |||
the many possible URLs for a principal when creating ACEs. A client | the many possible URLs for a principal when creating ACEs. A client | |||
can discover which URL to use by retrieving the DAV:principal-URL | can discover which URL to use by retrieving the DAV:principal-URL | |||
property (Section 4.2) from a principal resource. No matter which | property (Section 4.2) from a principal resource. No matter which | |||
of the principal's URLs is used with PROPFIND, the property always | of the principal's URLs is used with PROPFIND, the property always | |||
returns the same URL. | returns the same URL. | |||
Once a system has hundreds to thousands of principals, the problem | With a system having hundreds to thousands of principals, the | |||
arises of how to allow a human operator of client software to | problem arises of how to allow a human operator of client software | |||
select just one of these principals. One approach is to use broad | to select just one of these principals. One approach is to use | |||
collection hierarchies to spread the principals over a large number | broad collection hierarchies to spread the principals over a large | |||
of collections, yielding few principals per collection. An example | number of collections, yielding few principals per collection. An | |||
of this is a two level hierarchy with the first level containing 36 | example of this is a two level hierarchy with the first level | |||
collections (a-z, 0-9), and the second level being another 36, | containing 36 collections (a-z, 0-9), and the second level being | |||
creating collections /a/a/, /a/b/, ..., /a/z/, such that a | another 36, creating collections /a/a/, /a/b/, ..., /a/z/, such | |||
principal with last name "Stein" would appear at /s/t/Stein. In | that a principal with last name "Stein" would appear at /s/t/Stein. | |||
effect, this pre-computes a common query, search on last name, and | In effect, this pre-computes a common query, search on last name, | |||
encodes it into a hierarchy. The drawback with this scheme is that | and encodes it into a hierarchy. The drawback with this scheme is | |||
it handles only a small set of predefined queries, and drilling | that it handles only a small set of predefined queries, and | |||
down through the collection hierarchy adds unnecessary steps | drilling down through the collection hierarchy adds unnecessary | |||
(navigate down/up) when the user already knows the principal's | steps (navigate down/up) when the user already knows the | |||
name. While organizing principal URLs into a hierarchy is a valid | principal's name. While organizing principal URLs into a hierarchy | |||
namespace organization, users should not be forced to navigate this | is a valid namespace organization, users should not be forced to | |||
hierarchy to select a principal. | navigate this hierarchy to select a principal. | |||
This specification provides the capability to perform substring | This specification provides the capability to perform substring | |||
searches on a small set of properties on the resources representing | searches over a small set of properties on the resources | |||
principals. This permits searches based on last name, first name, | representing principals. This permits searches based on last name, | |||
user name, job title, etc. Two separate searches are supported, | first name, user name, job title, etc. Two separate searches are | |||
both via the REPORT method, one to search principal resources, the | supported, both via the REPORT method, one to search principal | |||
other to determine which properties may be searched at all. | resources (DAV:principal-property-search, Section 9.4), the other | |||
to determine which properties may be searched at all | ||||
(DAV:principal-search-property-set, Section 9.5). | ||||
Clemm, Hopkins, Sedlar, Whitehead [Page 5] | Clemm, Hopkins, Sedlar, Whitehead [Page 5] | |||
Once a principal has been identified in an ACE, a server evaluating | Once a principal has been identified in an ACE, a server evaluating | |||
that ACE must know the identity of the principal making a protocol | that ACE must know the identity of the principal making a protocol | |||
request, and must validate that that principal is who they claim to | request, and must validate that that principal is who they claim to | |||
be, a process known as authentication. This specification | be, a process known as authentication. This specification | |||
intentionally omits discussion of authentication, as the HTTP | intentionally omits discussion of authentication, as the HTTP | |||
protocol already has a number of authentication mechanisms | protocol already has a number of authentication mechanisms | |||
[RFC2617]. Some authentication mechanism (such as HTTP Digest | [RFC2617]. Some authentication mechanism (such as HTTP Digest | |||
Authentication, which all WebDAV compliant implementations are | Authentication, which all WebDAV compliant implementations are | |||
required to support) must be available to validate the identity of | required to support) must be available to validate the identity of | |||
a principal. | a principal. | |||
The following issues are out of scope for this document: | The following issues are out of scope for this document: | |||
* Access control that applies only to a particular property | * Access control that applies only to a particular property on a | |||
on a resource (excepting the access control properties | resource (excepting the access control properties DAV:acl and | |||
DAV:acl and DAV:current-user-privilege-set), rather than | DAV:current-user-privilege-set), rather than the entire | |||
the entire resource, | resource, | |||
* Role-based security (where a role can be seen as a | * Role-based security (where a role can be seen as a dynamically | |||
dynamically defined group of principals), | defined group of principals), | |||
* Specification of the ways an ACL on a resource is | * Specification of the ways an ACL on a resource is initialized, | |||
initialized, | ||||
* Specification of an ACL that applies globally to all | * Specification of an ACL that applies globally to all | |||
resources, rather than to a particular resource. | resources, rather than to a particular resource. | |||
* Creation and maintenance of resources representing people | * Creation and maintenance of resources representing people or | |||
or computational agents (principals), and groups of these. | computational agents (principals), and groups of these. | |||
This specification is organized as follows. Section 1.1 defines key | This specification is organized as follows. Section 1.1 defines key | |||
concepts used throughout the specification, and is followed by a | concepts used throughout the specification, and is followed by a | |||
more in-depth discussion of principals (Section 2), and privileges | more in-depth discussion of principals (Section 2), and privileges | |||
(Section 3). Properties defined on principals are specified in | (Section 3). Properties defined on principals are specified in | |||
Section 4, and access control properties for content resources are | Section 4, and access control properties for content resources are | |||
specified in Section 5. The semantics of access control lists are | specified in Section 5. The semantics of access control lists are | |||
described in Section 6, including sections on ACE combination | described in Section 6, including sections on ACE combination | |||
(Section 6.1), ACE ordering (Section 6.2), and principals required | (Section 6.1), ACE ordering (Section 6.2), and principals required | |||
to be present in an ACE (Section 6.3.2). Client discovery of access | to be present in an ACE (Section 6.3.2). Client discovery of access | |||
control capability using OPTIONS is described in Section 7.1. | control capability using OPTIONS is described in Section 7.1. | |||
Interactions between access control functionality and existing HTTP | Interactions between access control functionality and existing HTTP | |||
and WebDAV methods are described in the remainder of Section 7. The | and WebDAV methods are described in the remainder of Section 7. The | |||
access control setting method, ACL, is specified in Section 8. Four | access control setting method, ACL, is specified in Section 8. Four | |||
reports that provide limited server-side searching capabilities are | reports that provide limited server-side searching capabilities are | |||
described in Section 9. Sections on XML processing (Section 10), | described in Section 9. Sections on XML processing (Section 10), | |||
Internationalization considerations (Section 11), security | Internationalization considerations (Section 11), security | |||
considerations (Section 12), and authentication (Section 13) round | considerations (Section 12), and authentication (Section 13) round | |||
out the specification. An appendix (Section 19.1) provides an XML | out the specification. An appendix (Section 19.1) provides an XML | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 6] | ||||
Document Type Definition (DTD) for the XML elements defined in the | Document Type Definition (DTD) for the XML elements defined in the | |||
specification. | specification. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 6] | ||||
1.1 Terms | 1.1 Terms | |||
This draft uses the terms defined in HTTP [RFC2616] and WebDAV | This draft uses the terms defined in HTTP [RFC2616] and WebDAV | |||
[RFC2518]. In addition, the following terms are defined: | [RFC2518]. In addition, the following terms are defined: | |||
principal | principal | |||
A "principal" is a distinct human or computational actor that | A "principal" is a distinct human or computational actor that | |||
initiates access to network resources. In this protocol, a | initiates access to network resources. In this protocol, a | |||
principal is an HTTP resource that represents such an actor. | principal is an HTTP resource that represents such an actor. | |||
skipping to change at line 318 | skipping to change at line 321 | |||
privilege | privilege | |||
A "privilege" controls access to a particular set of HTTP | A "privilege" controls access to a particular set of HTTP | |||
operations on a resource. | operations on a resource. | |||
aggregate privilege | aggregate privilege | |||
An "aggregate privilege" is a privilege that contains a set of | An "aggregate privilege" is a privilege that contains a set of | |||
other privileges. | other privileges. | |||
abstract privilege | abstract privilege | |||
The modifier "abstract", when applied to a privilege, means the | The modifier "abstract", when applied to a privilege on a resource, | |||
privilege cannot be set in an access control element (ACE). | means the privilege cannot be set in an access control element | |||
(ACE) on that resource . | ||||
access control list (ACL) | access control list (ACL) | |||
An "ACL" is a list of access control elements that define access | An "ACL" is a list of access control elements that define access | |||
control to a particular resource. | control to a particular resource. | |||
access control element (ACE) | access control element (ACE) | |||
An "ACE" either grants or denies a particular set of (non-abstract) | An "ACE" either grants or denies a particular set of (non-abstract) | |||
privileges for a particular principal. | privileges for a particular principal. | |||
inherited ACE | inherited ACE | |||
An "inherited ACE" is an ACE that is dynamically shared from the | An "inherited ACE" is an ACE that is dynamically shared from the | |||
ACL of another resource. When a shared ACE changes on the primary | ACL of another resource. When a shared ACE changes on the primary | |||
resource, it is also changed on inheriting resources. | resource, it is also changed on inheriting resources. | |||
protected property | protected property | |||
A "protected property" is one whose value cannot be updated except | A "protected property" is one whose value cannot be updated except | |||
by a method explicitly defined as updating that specific property. | by a method explicitly defined as updating that specific property. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 7] | ||||
In particular, a protected property cannot be updated with a | In particular, a protected property cannot be updated with a | |||
PROPPATCH request. | PROPPATCH request. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 7] | ||||
1.2 Notational Conventions | 1.2 Notational Conventions | |||
The augmented BNF used by this document to describe protocol | The augmented BNF used by this document to describe protocol | |||
elements is described in Section 2.1 of [RFC2616]. Because this | elements is described in Section 2.1 of [RFC2616]. Because this | |||
augmented BNF uses the basic production rules provided in Section | augmented BNF uses the basic production rules provided in Section | |||
2.2 of [RFC2616], those rules apply to this document as well. | 2.2 of [RFC2616], those rules apply to this 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 | "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in | |||
this document are to be interpreted as described in [RFC2119]. | this document are to be interpreted as described in [RFC2119]. | |||
Definitions of XML elements in this document use XML element type | Definitions of XML elements in this document use XML element type | |||
declarations (as found in XML Document Type Declarations), | declarations (as found in XML Document Type Declarations), | |||
described in Section 3.2 of [REC-XML]. When an XML element type in | described in Section 3.2 of [REC-XML]. When an XML element type in | |||
the "DAV:" namespace is referenced in this document outside of the | the "DAV:" namespace is referenced in this document outside of the | |||
context of an XML fragment, the string "DAV:" will be prefixed to | context of an XML fragment, the string "DAV:" will be prefixed to | |||
the element type. | the element name. | |||
2 PRINCIPALS | 2 PRINCIPALS | |||
A principal is a network resource that represents a distinct human | A principal is a network resource that represents a distinct human | |||
or computational actor that initiates access to network resources. | or computational actor that initiates access to network resources. | |||
Users and groups are represented as principals in many | Users and groups are represented as principals in many | |||
implementations; other types of principals are also possible. A URI | implementations; other types of principals are also possible. A URI | |||
of any scheme MAY be used to identify a principal resource. | of any scheme MAY be used to identify a principal resource. | |||
However, servers implementing this specification MUST expose | However, servers implementing this specification MUST expose | |||
principal resources at an http(s) URL, which is a privileged scheme | principal resources at an http(s) URL, which is a privileged scheme | |||
that points to resources that have additional properties, as | that points to resources that have additional properties, as | |||
described in Section 4. So, a principal resource can have multiple | described in Section 4. So, a principal resource can have multiple | |||
URIs, one of which has to be an http(s) scheme URL. Although an | URIs, one of which has to be an http(s) scheme URL. Although an | |||
implementation SHOULD support PROPFIND and MAY support PROPPATCH to | implementation SHOULD support PROPFIND and MAY support PROPPATCH to | |||
access and modify information about a principal, it is not required | access and modify information about a principal, it is not required | |||
to do so. | to do so. | |||
A principal resource may be a group. A group is represented as a | A principal resource may be a group, where a group is a principal | |||
WebDAV collection, where the members of the group are members of | that represents a set of other principals, called the members of | |||
the WebDAV collection. If a person or computational agent matches | the group. If a person or computational agent matches a principal | |||
a principal resource that is a member of a group, they also match | resource that is a member of a group, they also match the group. | |||
the group. Membership in a group is recursive, so if a principal is | Membership in a group is recursive, so if a principal is a member | |||
a member of group GRPA, and GRPA is a member of group GRPB, then | of group GRPA, and GRPA is a member of group GRPB, then the | |||
the principal is also a member of GRPB. | principal is also a member of GRPB. | |||
Implementer's Note: It is possible for the collection that | ||||
represents a group to have non-principals as collection members. | ||||
When enumerating the membership of a group, it is necessary to | ||||
Clemm, Hopkins, Sedlar, Whitehead [Page 8] | Clemm, Hopkins, Sedlar, Whitehead [Page 8] | |||
retrieve the DAV:resourcetype property of a collection member, | ||||
and check it for the DAV:principal XML element (described in | ||||
Section 4). If the DAV:principal XML element is not present, the | ||||
resource is not a principal and may be ignored for the purposes | ||||
of determining group membership. | ||||
For example, the collection /FOO/, representing a group, has two | ||||
members, Bar and Baz. Bar is a principal but Baz is not. | ||||
Therefore when determining which principals belong to the group, | ||||
a client would enumerate the membership using PROPFIND while | ||||
asking for the DAV:resourcetype property, and see that only Bar | ||||
has the DAV:principal XML element. Therefore, Bar is the only | ||||
principal that is a member of the group represented by /FOO/. | ||||
3 PRIVILEGES | 3 PRIVILEGES | |||
Ability to perform a given method on a resource SHOULD be | Ability to perform a given method on a resource SHOULD be | |||
controlled by one or more privileges. Authors of protocol | controlled by one or more privileges. Authors of protocol | |||
extensions that define new HTTP methods SHOULD specify which | extensions that define new HTTP methods SHOULD specify which | |||
privileges (by defining new privileges, or mapping to ones below) | privileges (by defining new privileges, or mapping to ones below) | |||
are required to perform the method. A principal with no privileges | are required to perform the method. A principal with no privileges | |||
to a resource SHOULD be denied any HTTP access to that resource, | to a resource SHOULD be denied any HTTP access to that resource, | |||
unless the principal matches an ACE constructed using the DAV:all, | unless the principal matches an ACE constructed using the DAV:all, | |||
DAV:authenticated, or DAV:unauthenticated pseudo-principals (see | DAV:authenticated, or DAV:unauthenticated pseudo-principals (see | |||
Section 5.4.1). | Section 5.4.1). | |||
Privileges may be containers of other privileges, in which case | Privileges may be containers of other privileges, in which case | |||
they are termed aggregate privileges. If a principal is granted or | they are termed "aggregate privileges". If a principal is granted | |||
denied an aggregate privilege, it is semantically equivalent to | or denied an aggregate privilege, it is semantically equivalent to | |||
granting or denying each of the aggregated privileges individually. | granting or denying each of the aggregated privileges individually. | |||
For example, an implementation may define add-member and remove- | For example, an implementation may define add-member and remove- | |||
member privileges that control the ability to add and remove an | member privileges that control the ability to add and remove a | |||
internal member of a group. Since these privileges control the | member of a group. Since these privileges control the ability to | |||
ability to update the state of a group, these privileges would be | update the state of a group, these privileges would be aggregated | |||
aggregated by the DAV:write privilege on a group, and granting the | by the DAV:write privilege on a group, and granting the DAV:write | |||
DAV:write privilege on a group would also grant the add-member and | privilege on a group would also grant the add-member and remove- | |||
remove-member privileges. | member privileges. | |||
Privileges may have the quality of being abstract, in which case | ||||
they cannot be set in an ACE. Aggregate and non-aggregate | ||||
privileges are both capable of being abstract. Abstract privileges | ||||
are useful for modeling privileges that otherwise would not be | ||||
exposed via the protocol. Abstract privileges also provide server | ||||
implementations with flexibility in implementing the privileges | ||||
defined in this specification. For example, if a server is | ||||
incapable of separating the read resource capability from the read | ||||
ACL capability, it can still model the DAV:read and DAV:read-acl | ||||
privileges defined in this specification by declaring them | ||||
Clemm, Hopkins, Sedlar, Whitehead [Page 9] | Privileges may be declared to be "abstract" for a given resource, | |||
abstract, and containing them within a non-abstract aggregate | in which case they cannot be set in an ACE on that resource. | |||
privilege (say, read-all) that holds DAV:read, and DAV:read-acl. In | Aggregate and non-aggregate privileges are both capable of being | |||
this way, it is possible to set the aggregate privilege, read-all, | abstract. Abstract privileges are useful for modeling privileges | |||
thus coupling the setting of DAV:read and DAV:read-acl, but it is | that otherwise would not be exposed via the protocol. Abstract | |||
not possible to set DAV:read, or DAV:read-acl individually. Since | privileges also provide server implementations with flexibility in | |||
aggregate privileges can be abstract, it is also possible to use | implementing the privileges defined in this specification. For | |||
abstract privileges to group or organize non-abstract privileges. | example, if a server is incapable of separating the read resource | |||
Privilege containment loops are not allowed, hence a privilege MUST | capability from the read ACL capability, it can still model the | |||
NOT contain itself. For example, DAV:read cannot contain DAV:read. | DAV:read and DAV:read-acl privileges defined in this specification | |||
by declaring them abstract, and containing them within a non- | ||||
abstract aggregate privilege (say, read-all) that holds DAV:read, | ||||
and DAV:read-acl. In this way, it is possible to set the aggregate | ||||
privilege, read-all, thus coupling the setting of DAV:read and | ||||
DAV:read-acl, but it is not possible to set DAV:read, or DAV:read- | ||||
acl individually. Since aggregate privileges can be abstract, it is | ||||
also possible to use abstract privileges to group or organize non- | ||||
abstract privileges. Privilege containment loops are not allowed; | ||||
therefore, a privilege MUST NOT contain itself. For example, | ||||
DAV:read cannot contain DAV:read. | ||||
The set of privileges that apply to a particular resource may vary | The set of privileges that apply to a particular resource may vary | |||
with the DAV:resourcetype of the resource, as well as between | with the DAV:resourcetype of the resource, as well as between | |||
different server implementations. To promote interoperability, | different server implementations. To promote interoperability, | |||
however, this specification defines a set of well-known privileges | however, this specification defines a set of well-known privileges | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 9] | ||||
(e.g. DAV:read, DAV:write, DAV:read-acl, DAV:write-acl, DAV:read- | (e.g. DAV:read, DAV:write, DAV:read-acl, DAV:write-acl, DAV:read- | |||
current-user-privilege-set, and DAV:all), which can at least be | current-user-privilege-set, and DAV:all), which can at least be | |||
used to classify the other privileges defined on a particular | used to classify the other privileges defined on a particular | |||
resource. The access permissions on null resources (defined in | resource. The access permissions on null resources (defined in | |||
[RFC2518], Section 3) are solely those they inherit (if any), and | [RFC2518], Section 3) are solely those they inherit (if any), and | |||
they are not discoverable (i.e., the access control properties | they are not discoverable (i.e., the access control properties | |||
specified in Section 5 are not defined on null resources). On the | specified in Section 5 are not defined on null resources). On the | |||
transition from null to stateful resource, the initial access | transition from null to stateful resource, the initial access | |||
control list is set by the server's default ACL value policy (if | control list is set by the server's default ACL value policy (if | |||
any). | any). | |||
skipping to change at line 475 | skipping to change at line 461 | |||
defined in this specification. Privileges defined by individual | defined in this specification. Privileges defined by individual | |||
implementations MUST NOT use the DAV: namespace, and instead should | implementations MUST NOT use the DAV: namespace, and instead should | |||
use a namespace that they control, such as an http scheme URL. | use a namespace that they control, such as an http scheme URL. | |||
3.1 DAV:read Privilege | 3.1 DAV:read Privilege | |||
The read privilege controls methods that return information about | The read privilege controls methods that return information about | |||
the state of the resource, including the resource's properties. | the state of the resource, including the resource's properties. | |||
Affected methods include GET and PROPFIND. Any implementation- | Affected methods include GET and PROPFIND. Any implementation- | |||
defined privilege that also controls access to GET and PROPFIND | defined privilege that also controls access to GET and PROPFIND | |||
must be aggregated under dav:readùif an ACL grants access to | must be aggregated under DAV:readùif an ACL grants access to | |||
dav:read, the client may expect that no other privilege needs to be | DAV:read, the client may expect that no other privilege needs to be | |||
granted to have access to GET and PROPFIND. Additionally, the read | granted to have access to GET and PROPFIND. Additionally, the read | |||
privilege MAY control the OPTIONS method. | privilege MAY control the OPTIONS method. | |||
<!ELEMENT read EMPTY> | <!ELEMENT read EMPTY> | |||
3.2 DAV:write Privilege | 3.2 DAV:write Privilege | |||
The write privilege controls methods that lock a resource or modify | The write privilege controls methods that lock a resource or modify | |||
the content, dead properties, or (in the case of a collection) | the content, dead properties, or (in the case of a collection) | |||
membership of the resource, such as PUT and PROPPATCH. Note that | membership of the resource, such as PUT and PROPPATCH. Note that | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 10] | ||||
state modification is also controlled via locking (see section 5.3 | state modification is also controlled via locking (see section 5.3 | |||
of [WEBDAV]), so effective write access requires that both write | of [WEBDAV]), so effective write access requires that both write | |||
privileges and write locking requirements are satisfied. Any | privileges and write locking requirements are satisfied. Any | |||
implementation-defined privilege that also controls access to | implementation-defined privilege that also controls access to | |||
methods modifying content, dead properties or collection membership | methods modifying content, dead properties or collection membership | |||
must be aggregated under dav:write, e.g. if an ACL grants access to | must be aggregated under DAV:write, e.g. if an ACL grants access to | |||
dav:write, the client may expect that no other privilege needs to | DAV:write, the client may expect that no other privilege needs to | |||
be granted to have access to PUT and PROPPATCH. | be granted to have access to PUT and PROPPATCH. | |||
<!ELEMENT write EMPTY> | <!ELEMENT write EMPTY> | |||
3.3 DAV:write-properties | 3.3 DAV:write-properties | |||
The DAV:write-properties privilege controls methods that modify the | The DAV:write-properties privilege controls methods that modify the | |||
dead properties of the resource, such as PROPPATCH. Whether this | dead properties of the resource, such as PROPPATCH. Whether this | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 10] | ||||
privilege may be used to control access to any live properties is | privilege may be used to control access to any live properties is | |||
determined by the implementation. Any implementation-defined | determined by the implementation. Any implementation-defined | |||
privilege that also controls access to methods modifying dead | privilege that also controls access to methods modifying dead | |||
properties must be aggregated under dav:write-propertiesùe.g. if an | properties must be aggregated under DAV:write-propertiesùe.g. if an | |||
ACL grants access to dav:write-properties, the client can safely | ACL grants access to DAV:write-properties, the client can safely | |||
expect that no other privilege needs to be granted to have access | expect that no other privilege needs to be granted to have access | |||
to PROPPATCH. | to PROPPATCH. | |||
<!ELEMENT write-properties EMPTY> | <!ELEMENT write-properties EMPTY> | |||
3.4 DAV:write-content | 3.4 DAV:write-content | |||
The DAV:write-content privilege controls methods that modify the | The DAV:write-content privilege controls methods that modify the | |||
content or (in the case of a collection) membership of the | content or (in the case of a collection) membership of the | |||
resource, such as PUT and DELETE. Any implementation-defined | resource, such as PUT and DELETE. Any implementation-defined | |||
privilege that also controls access to content or alteration of | privilege that also controls access to content or alteration of | |||
collection membership must be aggregated under dav:write-contentù | collection membership must be aggregated under DAV:write-contentù | |||
e.g. if an ACL grants access to dav:write-content, the client can | e.g. if an ACL grants access to DAV:write-content, the client can | |||
safely expect that no other privilege needs to be granted to have | safely expect that no other privilege needs to be granted to have | |||
access to PUT or DELETE. | access to PUT or DELETE. | |||
<!ELEMENT write-content EMPTY> | <!ELEMENT write-content EMPTY> | |||
3.5 DAV:unlock | 3.5 DAV:unlock | |||
The dav:unlock privilege controls the use of the UNLOCK method to | The DAV:unlock privilege controls the use of the UNLOCK method by a | |||
unlock a resource. (Note that while the set of users who may lock | principal other than the lock owner (the principal that created a | |||
a resource is most commonly the same set of users who may modify a | lock can always perform an UNLOCK). While the set of users who may | |||
resource, servers may allow various kinds of administrators to | lock a resource is most commonly the same set of users who may | |||
unlock resources locked by others.) Any privilege controlling | modify a resource, servers may allow various kinds of | |||
access to UNLOCK must be aggregated under dav:unlock. | administrators to unlock resources locked by others. Any privilege | |||
controlling access by non-lock owners to UNLOCK MUST be aggregated | ||||
under DAV:unlock. | ||||
A lock owner can always remove a lock by issuing an UNLOCK with the | ||||
correct lock token and authentication credentials. That is, even if | ||||
a principal does not have DAV:unlock privilege, they can still | ||||
remove locks they own. Principals other than the lock owner can | ||||
remove a lock only if they have DAV:unlock privilege and they issue | ||||
an UNLOCK with the correct lock token. Lock timeout is not affected | ||||
by the DAV:unlock privilege. | ||||
<!ELEMENT unlock EMPTY> | <!ELEMENT unlock EMPTY> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 11] | Clemm, Hopkins, Sedlar, Whitehead [Page 11] | |||
3.6 DAV:read-acl Privilege | 3.6 DAV:read-acl Privilege | |||
The DAV:read-acl privilege controls the use of PROPFIND to retrieve | The DAV:read-acl privilege controls the use of PROPFIND to retrieve | |||
the DAV:acl property of the resource. | the DAV:acl property of the resource. | |||
<!ELEMENT read-acl EMPTY> | <!ELEMENT read-acl EMPTY> | |||
skipping to change at line 609 | skipping to change at line 605 | |||
current-user-privilege-set. | current-user-privilege-set. | |||
DAV:read MUST NOT contain DAV:write, DAV:write-acl, DAV:write- | DAV:read MUST NOT contain DAV:write, DAV:write-acl, DAV:write- | |||
properties, or DAV:write-content. | properties, or DAV:write-content. | |||
DAV:write MUST contain DAV:write-properties and DAV:write-content. | DAV:write MUST contain DAV:write-properties and DAV:write-content. | |||
4 PRINCIPAL PROPERTIES | 4 PRINCIPAL PROPERTIES | |||
Principals are manifested to clients as a WebDAV resource, | Principals are manifested to clients as a WebDAV resource, | |||
identified by a URL. A principal MUST have a DAV:displayname | identified by a URL. A principal MUST have a non-empty | |||
property (defined in Section 13.2 of [RFC2518]), and a | DAV:displayname property (defined in Section 13.2 of [RFC2518]), | |||
DAV:resourcetype property (defined in Section 13.9 of [RFC2518]). | and a DAV:resourcetype property (defined in Section 13.9 of | |||
Additionally, a principal MUST report the DAV:principal empty XML | [RFC2518]). Additionally, a principal MUST report the | |||
element in the value of the DAV:resourcetype property in addition | DAV:principal XML element in the value of the DAV:resourcetype | |||
to all other reported elements. For example, a group would report | property. The element type declaration for DAV:principal is: | |||
DAV:collection and DAV:principal elements. The element type | ||||
declaration for DAV:principal is: | ||||
<!ELEMENT principal EMPTY> | <!ELEMENT principal EMPTY> | |||
This protocol defines the following additional property for a | This protocol defines the following additional properties for a | |||
principal. Since it is expensive, for many servers, to retrieve | principal. Since it can be expensive for a server to retrieve | |||
access control information, the name and value of this property | access control information, the name and value of these properties | |||
SHOULD NOT be returned by a PROPFIND allprop request (as defined in | SHOULD NOT be returned by a PROPFIND allprop request (as defined in | |||
Section 12.14.1 of [RFC2518]). | Section 12.14.1 of [RFC2518]). | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 13] | ||||
4.1 DAV:alternate-URI-set | 4.1 DAV:alternate-URI-set | |||
This protected property, if non-empty, contains the URIs of network | This protected property, if non-empty, contains the URIs of network | |||
resources with additional descriptive information about the | resources with additional descriptive information about the | |||
principal. This property identifies additional network resources | principal. This property identifies additional network resources | |||
(i.e., it contains one or more URIs) that may be consulted by a | (i.e., it contains one or more URIs) that may be consulted by a | |||
client to gain additional knowledge concerning a principal. One | client to gain additional knowledge concerning a principal. One | |||
expected use for this property is the storage of an ldap [RFC2255] | expected use for this property is the storage of an LDAP [RFC2255] | |||
scheme URL. A user-agent encountering an ldap URL could use LDAP | scheme URL. A user-agent encountering an LDAP URL could use LDAP | |||
[RFC2589] to retrieve additional machine-readable directory | [RFC2589] to retrieve additional machine-readable directory | |||
information about the principal, and display that information in | information about the principal, and display that information in | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 13] | ||||
its user interface. Support for this property is REQUIRED, and the | its user interface. Support for this property is REQUIRED, and the | |||
value is empty if no alternate URI exists for the principal. | value is empty if no alternate URI exists for the principal. | |||
<!ELEMENT alternate-URI-set (href*)> | <!ELEMENT alternate-URI-set (href*)> | |||
4.2 DAV:principal-URL | 4.2 DAV:principal-URL | |||
A principal may have many URLs, but there must be one primary URL | A principal may have many URLs, but there must be one primary URL | |||
that clients can use to uniquely identify a principalùthe | that clients can use to uniquely identify a principalùthe | |||
principal-URL. This protected property contains the URL that MUST | principal-URL. This protected property contains the URL that MUST | |||
be used to identify this principal in an ACL request. | be used to identify this principal in an ACL request. Support for | |||
this property is REQUIRED. | ||||
<!ELEMENT principal-URL (href)> | <!ELEMENT principal-URL (href)> | |||
4.3 DAV:group-membership | 4.3 DAV:group-member-set | |||
This property of a group principal identifies the principals that | ||||
are direct members of this group. Since a group may be a member of | ||||
another group, a group may also have indirect members (i.e. the | ||||
members of its direct members). A URL in the DAV:group-member-set | ||||
for a principal MUST be the DAV:principal-URL of that principal. | ||||
<!ELEMENT group-member-set (href*)> | ||||
4.4 DAV:group-membership | ||||
This protected property identifies the groups in which the | This protected property identifies the groups in which the | |||
principal is directly a member. Note that a server may allow a | principal is directly a member. Note that a server may allow a | |||
group to be a member of another group, in which case the DAV:group- | group to be a member of another group, in which case the DAV:group- | |||
membership of those other groups would need to be queried in order | membership of those other groups would need to be queried in order | |||
to determine the groups in which the principal is indirectly a | to determine the groups in which the principal is indirectly a | |||
member. | member. Support for this property is REQUIRED. | |||
<!ELEMENT group-membership (href*)> | <!ELEMENT group-membership (href*)> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 14] | ||||
5 ACCESS CONTROL PROPERTIES | 5 ACCESS CONTROL PROPERTIES | |||
This specification defines a number of new properties for WebDAV | This specification defines a number of new properties for WebDAV | |||
resources. Access control properties may be retrieved just like | resources. Access control properties may be retrieved just like | |||
other WebDAV properties, using the PROPFIND method. Since it is | other WebDAV properties, using the PROPFIND method. Since it is | |||
expensive, for many servers, to retrieve access control | expensive, for many servers, to retrieve access control | |||
information, a PROPFIND allprop request (as defined in Section | information, a PROPFIND allprop request (as defined in Section | |||
12.14.1 of [RFC2518]) SHOULD NOT return the names and values of the | 12.14.1 of [RFC2518]) SHOULD NOT return the names and values of the | |||
properties defined in this section. | properties defined in this section. | |||
skipping to change at line 686 | skipping to change at line 691 | |||
Section 3 of [RFC2518]) MUST NOT contain the following properties: | Section 3 of [RFC2518]) MUST NOT contain the following properties: | |||
5.1 DAV:owner | 5.1 DAV:owner | |||
This protected property identifies a particular principal as being | This protected property identifies a particular principal as being | |||
the "owner" of the resource. Since the owner of a resource often | the "owner" of the resource. Since the owner of a resource often | |||
has special access control capabilities (e.g., the owner frequently | has special access control capabilities (e.g., the owner frequently | |||
has permanent DAV:write-acl privilege), clients might display the | has permanent DAV:write-acl privilege), clients might display the | |||
resource owner in their user interface. | resource owner in their user interface. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 14] | ||||
<!ELEMENT owner (href)> | <!ELEMENT owner (href)> | |||
5.1.1 Example: Retrieving DAV:owner | 5.1.1 Example: Retrieving DAV:owner | |||
This example shows a client request for the value of the DAV:owner | This example shows a client request for the value of the DAV:owner | |||
property from a collection resource with URL | property from a collection resource with URL | |||
http://www.webdav.org/papers/. The principal making the request is | http://www.webdav.org/papers/. The principal making the request is | |||
authenticated using Digest authentication. The value of DAV:owner | authenticated using Digest authentication. The value of DAV:owner | |||
is the URL http://www.webdav.org/_acl/users/gstein, wrapped in the | is the URL http://www.webdav.org/acl/users/gstein, wrapped in the | |||
DAV:href XML element. | DAV:href XML element. | |||
>> Request << | >> Request << | |||
PROPFIND /papers/ HTTP/1.1 | PROPFIND /papers/ HTTP/1.1 | |||
Host: www.webdav.org | Host: www.webdav.org | |||
Content-type: text/xml; charset="utf-8" | Content-type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
Depth: 0 | Depth: 0 | |||
Authorization: Digest username="jim", | Authorization: Digest username="jim", | |||
realm="jim@webdav.org", nonce="...", | realm="jim@webdav.org", nonce="...", | |||
uri="/papers/", response="...", opaque="..." | uri="/papers/", response="...", opaque="..." | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:propfind xmlns:D="DAV:"> | <D:propfind xmlns:D="DAV:"> | |||
<D:prop> | <D:prop> | |||
<D:owner/> | <D:owner/> | |||
</D:prop> | </D:prop> | |||
</D:propfind> | </D:propfind> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 15] | ||||
>> Response << | >> Response << | |||
HTTP/1.1 207 Multi-Status | HTTP/1.1 207 Multi-Status | |||
Content-Type: text/xml; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:multistatus xmlns:D="DAV:"> | <D:multistatus xmlns:D="DAV:"> | |||
<D:response> | <D:response> | |||
<D:href>http://www.webdav.org/papers/</D:href> | <D:href>http://www.webdav.org/papers/</D:href> | |||
<D:propstat> | <D:propstat> | |||
<D:prop> | <D:prop> | |||
<D:owner> | <D:owner> | |||
<D:href>http://www.webdav.org/_acl/users/gstein</D:href> | <D:href>http://www.webdav.org/acl/users/gstein</D:href> | |||
</D:owner> | </D:owner> | |||
</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> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 15] | ||||
</D:response> | </D:response> | |||
</D:multistatus> | </D:multistatus> | |||
5.1.2 Example: An Attempt to Set DAV:owner | 5.1.2 Example: An Attempt to Set DAV:owner | |||
The following example shows a client request to modify the value of | The following example shows a client request to modify the value of | |||
the DAV:owner property on the resource with URL | the DAV:owner property on the resource with URL | |||
<http://www.webdav.org/papers>. Since DAV:owner is a protected | <http://www.webdav.org/papers>. Since DAV:owner is a protected | |||
property, the server responds with a 207 (Multi-Status) response | property, the server responds with a 207 (Multi-Status) response | |||
that contains a 403 (Forbidden) status code for the act of setting | that contains a 403 (Forbidden) status code for the act of setting | |||
skipping to change at line 764 | skipping to change at line 767 | |||
Content-type: text/xml; charset="utf-8" | Content-type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
Depth: 0 | Depth: 0 | |||
Authorization: Digest username="jim", | Authorization: Digest username="jim", | |||
realm="jim@webdav.org", nonce="...", | realm="jim@webdav.org", nonce="...", | |||
uri="/papers/", response="...", opaque="..." | uri="/papers/", response="...", opaque="..." | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:propertyupdate xmlns:D="DAV:"> | <D:propertyupdate xmlns:D="DAV:"> | |||
<D:set> | <D:set> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 16] | ||||
<D:prop> | <D:prop> | |||
<D:owner> | <D:owner> | |||
<D:href>http://www.webdav.org/acl/users/jim</D:href> | ||||
<D:href>http://www.webdav.org/_acl/users/jim</D:href> | ||||
</D:owner> | </D:owner> | |||
</D:prop> | </D:prop> | |||
</D:set> | </D:set> | |||
</D:propertyupdate> | </D:propertyupdate> | |||
>> Response << | >> Response << | |||
HTTP/1.1 207 Multi-Status | HTTP/1.1 207 Multi-Status | |||
Content-Type: text/xml; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:multistatus xmlns:D="DAV:"> | <D:multistatus xmlns:D="DAV:"> | |||
<D:response> | <D:response> | |||
<D:href>http://www.webdav.org/papers/</D:href> | <D:href>http://www.webdav.org/papers/</D:href> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 16] | ||||
<D:propstat> | <D:propstat> | |||
<D:prop><D:owner/></D:prop> | <D:prop><D:owner/></D:prop> | |||
<D:status>HTTP/1.1 403 Forbidden</D:status> | <D:status>HTTP/1.1 403 Forbidden</D:status> | |||
<D:responsedescription> | <D:responsedescription> | |||
Failure to set protected property (DAV:owner) | Failure to set protected property (DAV:owner) | |||
</D:responsedescription> | </D:responsedescription> | |||
</D:propstat> | </D:propstat> | |||
</D:response> | </D:response> | |||
</D:multistatus> | </D:multistatus> | |||
5.2 DAV:supported-privilege-set | 5.2 DAV:supported-privilege-set | |||
This is a protected property that identifies the privileges | This is a protected property that identifies the privileges defined | |||
defined for the resource. | for the resource. | |||
<!ELEMENT supported-privilege-set (supported-privilege*)> | <!ELEMENT supported-privilege-set (supported-privilege*)> | |||
Each privilege appears as an XML element, where aggregate | Each privilege appears as an XML element, where aggregate | |||
privileges list as sub-elements all of the privileges that they | privileges list as sub-elements all of the privileges that they | |||
aggregate. | aggregate. | |||
<!ELEMENT supported-privilege | <!ELEMENT supported-privilege | |||
(privilege, abstract?, description, supported-privilege*)> | (privilege, abstract?, description, supported-privilege*)> | |||
<!ELEMENT privilege ANY> | <!ELEMENT privilege ANY> | |||
An abstract privilege MUST NOT be used in an ACE for that resource. | An abstract privilege MUST NOT be used in an ACE for that resource. | |||
Servers MUST fail an attempt to set an abstract privilege. | Servers MUST fail an attempt to set an abstract privilege. | |||
<!ELEMENT abstract EMPTY> | <!ELEMENT abstract EMPTY> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 17] | ||||
A description is a human-readable description of what this | A description is a human-readable description of what this | |||
privilege controls access to. Servers MUST indicate the human | privilege controls access to. Servers MUST indicate the human | |||
language of the description using the xml:lang attribute and SHOULD | language of the description using the xml:lang attribute and SHOULD | |||
consider the HTTP Accept-Language request header when selecting one | consider the HTTP Accept-Language request header when selecting one | |||
of multiple available languages. | of multiple available languages. | |||
<!ELEMENT description #PCDATA> | <!ELEMENT description #PCDATA> | |||
It is envisioned that a WebDAV ACL-aware administrative client | It is envisioned that a WebDAV ACL-aware administrative client | |||
would list the supported privileges in a dialog box, and allow the | would list the supported privileges in a dialog box, and allow the | |||
user to choose non-abstract privileges to apply in an ACE. The | user to choose non-abstract privileges to apply in an ACE. The | |||
privileges tree is useful programmatically to map well-known | privileges tree is useful programmatically to map well-known | |||
privileges (defined by WebDAV or other standards groups) into | privileges (defined by WebDAV or other standards groups) into | |||
privileges that are supported by any particular server | privileges that are supported by any particular server | |||
implementation. The privilege tree also serves to hide complexity | implementation. The privilege tree also serves to hide complexity | |||
in implementations allowing large number of privileges to be | in implementations allowing large number of privileges to be | |||
defined by displaying aggregates to the user. | defined by displaying aggregates to the user. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 17] | ||||
5.2.1 Example: Retrieving a List of Privileges Supported on a | 5.2.1 Example: Retrieving a List of Privileges Supported on a | |||
Resource | Resource | |||
This example shows a client request for the DAV:supported- | This example shows a client request for the DAV:supported- | |||
privilege-set property on the resource | privilege-set property on the resource | |||
http://www.webdav.org/papers/. The value of the DAV:supported- | http://www.webdav.org/papers/. The value of the DAV:supported- | |||
privilege-set property is a tree of supported privileges (using | privilege-set property is a tree of supported privileges (using | |||
"[XML Namespace , localname]" to identify each privilege): | "[XML Namespace , localname]" to identify each privilege): | |||
[DAV:, all] (aggregate, abstract) | [DAV:, all] (aggregate, abstract) | |||
| | | | |||
+-- [DAV:, read] (aggregate) | +-- [DAV:, read] (aggregate) | |||
| | | | |||
+-- [DAV:, read-acl] (abstract) | +-- [DAV:, read-acl] (abstract) | |||
+-- [DAV:, read-current-user-privilege-set] | +-- [DAV:, read-current-user-privilege-set] (abstract) | |||
(abstract) | ||||
| | | | |||
+-- [DAV:, write] (aggregate) | +-- [DAV:, write] (aggregate) | |||
| | | | |||
+-- [DAV:, write-acl] (abstract) | +-- [DAV:, write-acl] (abstract) | |||
+-- [DAV:, write-properties] | +-- [DAV:, write-properties] | |||
+-- [DAV:, write-content] | +-- [DAV:, write-content] | |||
| | | | |||
+-- [DAV:, unlock] | +-- [DAV:, unlock] | |||
This privilege tree is not normative (except that it reflects the | This privilege tree is not normative (except that it reflects the | |||
normative aggregation rules given in Section 3.10), and many | normative aggregation rules given in Section 3.10), and many | |||
possible privilege trees are possible. | possible privilege trees are possible. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 18] | ||||
>> Request << | >> Request << | |||
PROPFIND /papers/ HTTP/1.1 | PROPFIND /papers/ HTTP/1.1 | |||
Host: www.webdav.org | Host: www.webdav.org | |||
Content-type: text/xml; charset="utf-8" | Content-type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
Depth: 0 | Depth: 0 | |||
Authorization: Digest username="gclemm", | Authorization: Digest username="gclemm", | |||
realm="gclemm@webdav.org", nonce="...", | realm="gclemm@webdav.org", nonce="...", | |||
uri="/papers/", response="...", opaque="..." | uri="/papers/", response="...", opaque="..." | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:propfind xmlns:D="DAV:"> | <D:propfind xmlns:D="DAV:"> | |||
<D:prop> | <D:prop> | |||
<D:supported-privilege-set/> | <D:supported-privilege-set/> | |||
</D:prop> | </D:prop> | |||
</D:propfind> | </D:propfind> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 18] | ||||
>> Response << | >> Response << | |||
HTTP/1.1 207 Multi-Status | HTTP/1.1 207 Multi-Status | |||
Content-Type: text/xml; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:multistatus xmlns:D="DAV:"> | <D:multistatus xmlns:D="DAV:"> | |||
<D:response> | <D:response> | |||
<D:href>http://www.webdav.org/papers/</D:href> | <D:href>http://www.webdav.org/papers/</D:href> | |||
skipping to change at line 910 | skipping to change at line 913 | |||
<D:description xml:lang="en">Read any | <D:description xml:lang="en">Read any | |||
object</D:description> | object</D:description> | |||
<D:supported-privilege> | <D:supported-privilege> | |||
<D:privilege> <D:read-acl/> </D:privilege> | <D:privilege> <D:read-acl/> </D:privilege> | |||
<D:abstract/> | <D:abstract/> | |||
<D:description xml:lang="en">Read | <D:description xml:lang="en">Read | |||
ACL</D:description> | ACL</D:description> | |||
</D:supported-privilege> | </D:supported-privilege> | |||
<D:supported-privilege> | <D:supported-privilege> | |||
<D:privilege> | <D:privilege> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 19] | ||||
<D:read-current-user-privilege-set/> | <D:read-current-user-privilege-set/> | |||
</D:privilege> | </D:privilege> | |||
<D:abstract/> | <D:abstract/> | |||
<D:description xml:lang="en">Read current user | <D:description xml:lang="en">Read current user | |||
privilege set property</D:description> | privilege set property</D:description> | |||
</D:supported-privilege> | </D:supported-privilege> | |||
</D:supported-privilege> | </D:supported-privilege> | |||
<D:supported-privilege> | <D:supported-privilege> | |||
<D:privilege> <D:write/> </D:privilege> | <D:privilege> <D:write/> </D:privilege> | |||
<D:description xml:lang="en">Write any | <D:description xml:lang="en">Write any | |||
object</D:description> | object</D:description> | |||
<D:supported-privilege> | <D:supported-privilege> | |||
<D:privilege> <D:write-acl/> </D:privilege> | <D:privilege> <D:write-acl/> </D:privilege> | |||
<D:description xml:lang="en">Write | <D:description xml:lang="en">Write | |||
ACL</D:description> | ACL</D:description> | |||
<D:abstract/> | <D:abstract/> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 19] | ||||
</D:supported-privilege> | </D:supported-privilege> | |||
<D:supported-privilege> | <D:supported-privilege> | |||
<D:privilege> <D:write-properties/> | <D:privilege> <D:write-properties/> </D:privilege> | |||
</D:privilege> | ||||
<D:description xml:lang="en">Write | <D:description xml:lang="en">Write | |||
properties</D:description> | properties</D:description> | |||
</D:supported-privilege> | </D:supported-privilege> | |||
<D:supported-privilege> | <D:supported-privilege> | |||
<D:privilege> <D:write-content/> </D:privilege> | <D:privilege> <D:write-content/> </D:privilege> | |||
<D:description xml:lang="en">Write resource | <D:description xml:lang="en">Write resource | |||
content</D:description> | content</D:description> | |||
</D:supported-privilege> | </D:supported-privilege> | |||
</D:supported-privilege> | </D:supported-privilege> | |||
<D:supported-privilege> | <D:supported-privilege> | |||
skipping to change at line 961 | skipping to change at line 963 | |||
</D:response> | </D:response> | |||
</D:multistatus> | </D:multistatus> | |||
5.3 DAV:current-user-privilege-set | 5.3 DAV:current-user-privilege-set | |||
DAV:current-user-privilege-set is a protected property containing | DAV:current-user-privilege-set is a protected property containing | |||
the exact set of privileges (as computed by the server) granted to | the exact set of privileges (as computed by the server) granted to | |||
the currently authenticated HTTP user. Aggregate privileges and | the currently authenticated HTTP user. Aggregate privileges and | |||
their contained privileges are listed. A user-agent can use the | their contained privileges are listed. A user-agent can use the | |||
value of this property to adjust its user interface to make actions | value of this property to adjust its user interface to make actions | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 20] | ||||
inaccessible (e.g., by graying out a menu item or button) for which | inaccessible (e.g., by graying out a menu item or button) for which | |||
the current principal does not have permission. This is | the current principal does not have permission. This is | |||
particularly useful for an access control user interface, which can | particularly useful for an access control user interface, which can | |||
be constructed without knowing the ACE combining semantics of the | be constructed without knowing the ACE combining semantics of the | |||
server. This property is also useful for determining what | server. This property is also useful for determining what | |||
operations the current principal can perform, without having to | operations the current principal can perform, without having to | |||
actually execute an operation. | actually execute an operation. | |||
<!ELEMENT current-user-privilege-set (privilege*)> | <!ELEMENT current-user-privilege-set (privilege*)> | |||
<!ELEMENT privilege ANY> | <!ELEMENT privilege ANY> | |||
If the current user is granted a specific privilege, that privilege | If the current user is granted a specific privilege, that privilege | |||
must belong to the set of privileges that may be set on this | must belong to the set of privileges that may be set on this | |||
resource. Therefore, each element in the DAV:current-user- | resource. Therefore, each element in the DAV:current-user- | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 20] | ||||
privilege-set property MUST identify a non-abstract privilege from | privilege-set property MUST identify a non-abstract privilege from | |||
the DAV:supported-privilege-set property. | the DAV:supported-privilege-set property. | |||
5.3.1 Example: Retrieving the User's Current Set of Assigned | 5.3.1 Example: Retrieving the User's Current Set of Assigned | |||
Privileges | Privileges | |||
Continuing the example from Section 5.2.1, this example shows a | Continuing the example from Section 5.2.1, this example shows a | |||
client requesting the DAV:current-user-privilege-set property from | client requesting the DAV:current-user-privilege-set property from | |||
the resource with URL http://www.webdav.org/papers/. The username | the resource with URL http://www.webdav.org/papers/. The username | |||
of the principal making the request is "khare", and Digest | of the principal making the request is "khare", and Digest | |||
skipping to change at line 1010 | skipping to change at line 1012 | |||
PROPFIND /papers/ HTTP/1.1 | PROPFIND /papers/ HTTP/1.1 | |||
Host: www.webdav.org | Host: www.webdav.org | |||
Content-type: text/xml; charset="utf-8" | Content-type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
Depth: 0 | Depth: 0 | |||
Authorization: Digest username="khare", | Authorization: Digest username="khare", | |||
realm="khare@webdav.org", nonce="...", | realm="khare@webdav.org", nonce="...", | |||
uri="/papers/", response="...", opaque="..." | uri="/papers/", response="...", opaque="..." | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 21] | ||||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:propfind xmlns:D="DAV:"> | <D:propfind xmlns:D="DAV:"> | |||
<D:prop> | <D:prop> | |||
<D:current-user-privilege-set/> | <D:current-user-privilege-set/> | |||
</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; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 21] | ||||
<D:multistatus xmlns:D="DAV:"> | <D:multistatus xmlns:D="DAV:"> | |||
<D:response> | <D:response> | |||
<D:href>http://www.webdav.org/papers/</D:href> | <D:href>http://www.webdav.org/papers/</D:href> | |||
<D:propstat> | <D:propstat> | |||
<D:prop> | <D:prop> | |||
<D:current-user-privilege-set> | <D:current-user-privilege-set> | |||
<D:privilege> <D:read/> </D:privilege> | <D:privilege> <D:read/> </D:privilege> | |||
</D:current-user-privilege-set> | </D:current-user-privilege-set> | |||
</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> | |||
5.4 DAV:acl | 5.4 DAV:acl | |||
This is a protected property that specifies the list of access | This is a protected property that specifies the list of access | |||
control entries (ACEs), which define what principals are to get | control entries (ACEs), which define what principals are to get | |||
what privileges for this resource. | what privileges for this resource. | |||
<!ELEMENT acl (ace | inherited-acl)* > | <!ELEMENT acl (ace*) > | |||
Each DAV:ace element specifies the set of privileges to be either | Each DAV:ace element specifies the set of privileges to be either | |||
granted or denied to a single principal. If the DAV:acl property | granted or denied to a single principal. If the DAV:acl property | |||
is empty, no principal is granted any privilege. | is empty, no principal is granted any privilege. | |||
<!ELEMENT ace (invert | principal, (grant|deny), protected?, | <!ELEMENT ace (invert | principal, (grant|deny), protected?, | |||
inherited?)> | inherited?)> | |||
5.4.1 ACE Principal | 5.4.1 ACE Principal | |||
The DAV:principal element identifies the principal to which this | The DAV:principal element identifies the principal to which this | |||
ACE applies. | ACE applies. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 22] | ||||
<!ELEMENT principal ((href) | <!ELEMENT principal ((href) | |||
| all | authenticated | unauthenticated | | all | authenticated | unauthenticated | |||
| property | self)> | | property | self)> | |||
The current user matches DAV:href only if that user is | The current user matches DAV:href only if that user is | |||
authenticated as being (or being a member of) the principal | authenticated as being (or being a member of) the principal | |||
identified by the URL contained by that DAV:href. | identified by the URL contained by that DAV:href. | |||
The current user always matches DAV:all. | The current user always matches DAV:all. | |||
<!ELEMENT all EMPTY> | <!ELEMENT all EMPTY> | |||
The current user matches DAV:authenticated only if authenticated. | The current user matches DAV:authenticated only if authenticated. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 22] | ||||
<!ELEMENT authenticated EMPTY> | <!ELEMENT authenticated EMPTY> | |||
The current user matches DAV:unauthenticated only if not | The current user matches DAV:unauthenticated only if not | |||
authenticated. | authenticated. | |||
<!ELEMENT unauthenticated EMPTY> | <!ELEMENT unauthenticated EMPTY> | |||
DAV:all is the union of DAV:authenticated, and DAV:unauthenticated. | DAV:all is the union of DAV:authenticated, and DAV:unauthenticated. | |||
For a given request, the user matches either DAV:authenticated, or | For a given request, the user matches either DAV:authenticated, or | |||
DAV:unauthenticated, but not both (that is, DAV:authenticated and | DAV:unauthenticated, but not both (that is, DAV:authenticated and | |||
skipping to change at line 1101 | skipping to change at line 1102 | |||
authenticated as being (or being a member of) that principal. For | authenticated as being (or being a member of) that principal. For | |||
example, if the DAV:property element contained <DAV:owner/>, the | example, if the DAV:property element contained <DAV:owner/>, the | |||
current user would match the DAV:property principal only if the | current user would match the DAV:property principal only if the | |||
current user is authenticated as matching the principal identified | current user is authenticated as matching the principal identified | |||
by the DAV:owner property of the resource. | by the DAV:owner property of the resource. | |||
<!ELEMENT property ANY> | <!ELEMENT property ANY> | |||
Alternately, some servers may support ACEs applying to those users | Alternately, some servers may support ACEs applying to those users | |||
NOT matching the current principal, e.g. all users not in a | NOT matching the current principal, e.g. all users not in a | |||
particular group. This can be done by wrapping the dav:principal | particular group. This can be done by wrapping the DAV:principal | |||
element with dav:invert. | element with DAV:invert. | |||
<!ELEMENT invert principal> | <!ELEMENT invert principal> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 23] | ||||
The current user matches DAV:self in a DAV:acl property of the | The current user matches DAV:self in a DAV:acl property of the | |||
resource only if that resource is a principal and that principal | resource only if that resource is a principal and that principal | |||
matches the current user or, if the principal is a group, a member | matches the current user or, if the principal is a group, a member | |||
of that group matches the current user. | of that group matches the current user. | |||
<!ELEMENT self EMPTY> | <!ELEMENT self EMPTY> | |||
5.4.2 ACE Grant and Deny | 5.4.2 ACE Grant and Deny | |||
Each DAV:grant or DAV:deny element specifies the set of privileges | Each DAV:grant or DAV:deny element specifies the set of privileges | |||
to be either granted or denied to the specified principal. A | to be either granted or denied to the specified principal. A | |||
DAV:grant or DAV:deny element of the DAV:acl of a resource MUST | DAV:grant or DAV:deny element of the DAV:acl of a resource MUST | |||
only contain non-abstract elements specified in the DAV:supported- | only contain non-abstract elements specified in the DAV:supported- | |||
privilege-set of that resource. | privilege-set of that resource. | |||
<!ELEMENT grant (privilege+)> | <!ELEMENT grant (privilege+)> | |||
<!ELEMENT deny (privilege+)> | <!ELEMENT deny (privilege+)> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 23] | ||||
<!ELEMENT privilege ANY> | <!ELEMENT privilege ANY> | |||
5.4.3 ACE Protection | 5.4.3 ACE Protection | |||
A server indicates an ACE is protected by including the | A server indicates an ACE is protected by including the | |||
DAV:protected element in the ACE. If the ACL of a resource contains | DAV:protected element in the ACE. If the ACL of a resource contains | |||
an ACE with a DAV:protected element, an attempt to remove that ACE | an ACE with a DAV:protected element, an attempt to remove that ACE | |||
from the ACL MUST fail. | from the ACL MUST fail. | |||
<!ELEMENT protected EMPTY> | <!ELEMENT protected EMPTY> | |||
skipping to change at line 1154 | skipping to change at line 1154 | |||
Note that ACE inheritance is not the same as ACL initialization. | Note that ACE inheritance is not the same as ACL initialization. | |||
ACL initialization defines the ACL that a newly created resource | ACL initialization defines the ACL that a newly created resource | |||
will use (if not specified). ACE inheritance refers to an ACE that | will use (if not specified). ACE inheritance refers to an ACE that | |||
is logically shared - where an update to the resource containing an | is logically shared - where an update to the resource containing an | |||
ACE will affect the ACE of each resource that inherits that ACE. | ACE will affect the ACE of each resource that inherits that ACE. | |||
The method by which ACLs are initialized or by which ACEs are | The method by which ACLs are initialized or by which ACEs are | |||
inherited is not defined by this document. | inherited is not defined by this document. | |||
<!ELEMENT inherited (href)> | <!ELEMENT inherited (href)> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 24] | ||||
5.4.5 Example: Retrieving a Resource's Access Control List | 5.4.5 Example: Retrieving a Resource's Access Control List | |||
Continuing the example from Sections 5.2.1 and 5.3.1, this example | Continuing the example from Sections 5.2.1 and 5.3.1, this example | |||
shows a client requesting the DAV:acl property from the resource | shows a client requesting the DAV:acl property from the resource | |||
with URL http://www.webdav.org/papers/. There are two ACEs defined | with URL http://www.webdav.org/papers/. There are two ACEs defined | |||
in this ACL: | in this ACL: | |||
ACE #1: The group identified by URL | ACE #1: The group identified by URL | |||
http://www.webdav.org/_acl/groups/maintainers/ (the group of site | http://www.webdav.org/acl/groups/maintainers (the group of site | |||
maintainers) is granted DAV:write privilege. Since (for this | maintainers) is granted DAV:write privilege. Since (for this | |||
example) DAV:write contains the DAV:write-acl privilege (see | example) DAV:write contains the DAV:write-acl privilege (see | |||
Section 5.2.1), this means the "maintainers" group can also modify | Section 5.2.1), this means the "maintainers" group can also modify | |||
the access control list. | the access control list. | |||
ACE #2: All principals (DAV:all) are granted the DAV:read | ACE #2: All principals (DAV:all) are granted the DAV:read | |||
privilege. Since (for this example) DAV:read contains DAV:read-acl | privilege. Since (for this example) DAV:read contains DAV:read-acl | |||
and DAV:read-current-user-privilege-set, this means all users | and DAV:read-current-user-privilege-set, this means all users | |||
(including all members of the "maintainers" group) can read the | (including all members of the "maintainers" group) can read the | |||
DAV:acl property and the DAV:current-user-privilege-set property. | DAV:acl property and the DAV:current-user-privilege-set property. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 24] | ||||
>> Request << | >> Request << | |||
PROPFIND /papers/ HTTP/1.1 | PROPFIND /papers/ HTTP/1.1 | |||
Host: www.webdav.org | Host: www.webdav.org | |||
Content-type: text/xml; charset="utf-8" | Content-type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
Depth: 0 | Depth: 0 | |||
Authorization: Digest username="masinter", | Authorization: Digest username="masinter", | |||
realm="masinter@webdav.org", nonce="...", | realm="webdav.org", nonce="...", | |||
uri="/papers/", response="...", opaque="..." | uri="/papers/", response="...", opaque="..." | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:propfind xmlns:D="DAV:"> | <D:propfind xmlns:D="DAV:"> | |||
<D:prop> | <D:prop> | |||
<D:acl/> | <D:acl/> | |||
</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; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:multistatus xmlns:D="DAV:"> | <D:multistatus xmlns:D="DAV:"> | |||
<D:response> | <D:response> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 25] | ||||
<D:href>http://www.webdav.org/papers/</D:href> | <D:href>http://www.webdav.org/papers/</D:href> | |||
<D:propstat> | <D:propstat> | |||
<D:prop> | <D:prop> | |||
<D:acl> | <D:acl> | |||
<D:ace> | <D:ace> | |||
<D:principal> | <D:principal> | |||
<D:href> | <D:href>http://www.webdav.org/acl/groups/maintainers</D:href> | |||
http://www.webdav.org/_acl/groups/maintainers/ | ||||
</D:href> | ||||
</D:principal> | </D:principal> | |||
<D:grant> | <D:grant> | |||
<D:privilege> <D:write/> </D:privilege> | <D:privilege> <D:write/> </D:privilege> | |||
</D:grant> | </D:grant> | |||
</D:ace> | </D:ace> | |||
<D:ace> | <D:ace> | |||
<D:principal> | <D:principal> | |||
<D:all/> | <D:all/> | |||
</D:principal> | </D:principal> | |||
<D:grant> | <D:grant> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 25] | ||||
<D:privilege> <D:read/> </D:privilege> | <D:privilege> <D:read/> </D:privilege> | |||
</D:grant> | </D:grant> | |||
</D:ace> | </D:ace> | |||
</D:acl> | </D:acl> | |||
</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> | |||
5.5 DAV:inherited-acl | 5.5 DAV:acl-semantics | |||
This is a protected property that lists a set of other resources | ||||
whose ACLs also control the access to this resource. To have a | ||||
privilege on a resource, not only must the ACEs defined in the ACL | ||||
on that resource grant the privilege, but so must each ACL in a | ||||
dav:inherited-acl tag. Effectively, the privileges granted by the | ||||
current ACL are ANDÆed with the privileges granted by each | ||||
inherited ACL. The order in which the inherited-acl tag appears in | ||||
an ACL is relevant, regardless of the ACL semantics (see below). | ||||
<!ELEMENT inherited-acl (href)> | ||||
5.6 DAV:acl-semantics | ||||
This is a protected property that defines the ACL semantics. These | This is a protected property that defines the ACL semantics of the | |||
ACEs specified in the DAV:acl property of this resource. These | ||||
semantics define how multiple ACEs that match the current user are | semantics define how multiple ACEs that match the current user are | |||
combined, what are the constraints on how ACEs can be ordered, and | combined, what are the constraints on how ACEs can be ordered, and | |||
which principals must have an ACE. A client user interface could | which principals must have an ACE. A client user interface could | |||
use the value of this property to provide feedback to a human | use the value of this property to provide feedback to a human | |||
operator concerning the impact of proposed changes to an ACL. | operator concerning the impact of proposed changes to an ACL. | |||
Alternately, a client can use this property to help it determine, | Alternately, a client can use this property to help it determine, | |||
before submitting an ACL method invocation, what ACL changes it | before submitting an ACL method invocation, what ACL changes it | |||
needs to make to accomplish a specific goal (or whether that goal | needs to make to accomplish a specific goal (or whether that goal | |||
is even achievable on this server). | is even achievable on this server). | |||
Since it is not practical to require all implementations to use the | Since it is not practical to require all implementations to use the | |||
same ACL semantics, the DAV:acl-semantics property is used to | same ACL semantics, the DAV:acl-semantics property is used to | |||
identify the ACL semantics for a particular resource. The DAV:acl- | identify the ACL semantics for a particular resource. The DAV:acl- | |||
semantics element is defined in Section 6. | semantics element is defined in Section 6. | |||
5.6.1 Example: Retrieving DAV:acl-semantics | Clemm, Hopkins, Sedlar, Whitehead [Page 26] | |||
5.5.1 Example: Retrieving DAV:acl-semantics | ||||
In this example, the client requests the value of the DAV:acl- | In this example, the client requests the value of the DAV:acl- | |||
semantics property. Digest authentication provides credentials for | semantics property. Digest authentication provides credentials for | |||
the principal operating the client. In this example, the ACE | the principal operating the client. In this example, the ACE | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 26] | ||||
combination semantics are DAV:first-match, described in Section | combination semantics are DAV:first-match, described in Section | |||
6.1.1, the ACE ordering semantics are not specified (some value | 6.1.1, the ACE ordering semantics are not specified (some value | |||
other than DAV:deny-before-grant, described in Section 6.2.1), the | other than DAV:deny-before-grant, described in Section 6.2.1), the | |||
DAV:allowed-ace element states that only one ACE is permitted for | DAV:allowed-ace element states that only one ACE is permitted for | |||
each principal, and an ACE describing the privileges granted the | each principal, and an ACE describing the privileges granted the | |||
DAV:all principal must exist in every ACL. | DAV:all principal must exist in every ACL. | |||
>> Request << | >> Request << | |||
PROPFIND /papers/ HTTP/1.1 | PROPFIND /papers/ HTTP/1.1 | |||
skipping to change at line 1312 | skipping to change at line 1297 | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:multistatus xmlns:D="DAV:"> | <D:multistatus xmlns:D="DAV:"> | |||
<D:response> | <D:response> | |||
<D:href>http://www.webdav.org/papers/</D:href> | <D:href>http://www.webdav.org/papers/</D:href> | |||
<D:propstat> | <D:propstat> | |||
<D:prop> | <D:prop> | |||
<D:acl-semantics> | <D:acl-semantics> | |||
<D:ace-combination> | <D:ace-combination> | |||
<D:first-match/> | <D:first-match/> | |||
</D:ace-combination> | </D:ace-combination> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 27] | ||||
<D:ace-ordering/> | <D:ace-ordering/> | |||
<D:allowed-ace> | <D:allowed-ace> | |||
<D:principal-only-one-ace/> | <D:principal-only-one-ace/> | |||
</D:allowed-ace> | </D:allowed-ace> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 27] | ||||
<D:required-principal> | <D:required-principal> | |||
<D:all/> | <D:all/> | |||
</D:required-principal> | </D:required-principal> | |||
</D:acl-semantics> | </D:acl-semantics> | |||
</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> | |||
5.6 DAV:inherited-acl-set | ||||
This protected property contains a set of URLs that identify other | ||||
resources that also control the access to this resource. To have a | ||||
privilege on a resource, not only must the ACL on that resource | ||||
(specified in the DAV:acl property of that resource) grant the | ||||
privilege, but so must the ACL of each resource identified in the | ||||
DAV:inherited-acl-set property of that resource. Effectively, the | ||||
privileges granted by the current ACL are ANDed with the privileges | ||||
granted by each inherited ACL. | ||||
<!ELEMENT inherited-acl-set (href*)> | ||||
Note that the ACL semantics of a resource are specified in the | ||||
DAV:acl-semantics property of that resource, and therefore each | ||||
inherited ACL can have different ACL semantics. | ||||
5.7 DAV:principal-collection-set | 5.7 DAV:principal-collection-set | |||
This protected property of a resource contains a set of URLs that | This protected property of a resource contains a set of URLs that | |||
identify the root collections that contain the principals that are | identify the root collections that contain the principals that are | |||
available on the server that implements this resource. An access | available on the server that implements this resource. A WebDAV | |||
control protocol user agent could use the contents of | Access Control Protocol user agent could use the contents of | |||
DAV:principal-collection-set to retrieve the DAV:displayname | DAV:principal-collection-set to retrieve the DAV:displayname | |||
property (specified in Section 13.2 of [RFC2518]) of all principals | property (specified in Section 13.2 of [RFC2518]) of all principals | |||
on that server, thereby yielding human-readable names for each | on that server, thereby yielding human-readable names for each | |||
principal that could be displayed in a user interface. | principal that could be displayed in a user interface. | |||
<!ELEMENT principal-collection-set (href*)> | <!ELEMENT principal-collection-set (href*)> | |||
Since different servers can control different parts of the URL | Since different servers can control different parts of the URL | |||
namespace, different resources on the same host MAY have different | namespace, different resources on the same host MAY have different | |||
DAV:principal-collection-set values. The collections specified in | DAV:principal-collection-set values. The collections specified in | |||
the DAV:principal-collection-set MAY be located on different hosts | the DAV:principal-collection-set MAY be located on different hosts | |||
from the resource. The URLs in DAV:principal-collection-set SHOULD | from the resource. The URLs in DAV:principal-collection-set SHOULD | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 28] | ||||
be http or https scheme URLs. For security and scalability reasons, | be http or https scheme URLs. For security and scalability reasons, | |||
a server MAY report only a subset of the entire set of known | a server MAY report only a subset of the entire set of known | |||
principal collections, and therefore clients should not assume they | principal collections, and therefore clients should not assume they | |||
have retrieved an exhaustive listing. Additionally, a server MAY | have retrieved an exhaustive listing. Additionally, a server MAY | |||
elect to report none of the principal collections it knows about, | elect to report none of the principal collections it knows about, | |||
in which case the property value would be empty. | in which case the property value would be empty. | |||
The value of DAV:principal-collection-set gives the scope of the | The value of DAV:principal-collection-set gives the scope of the | |||
DAV:principal-property-search REPORT (defined in Section 9.4). | DAV:principal-property-search REPORT (defined in Section 9.4). | |||
Clients use the DAV:principal-property-search REPORT to populate | Clients use the DAV:principal-property-search REPORT to populate | |||
their user interface with a list of principals. Therefore, servers | their user interface with a list of principals. Therefore, servers | |||
that limit a client's ability to obtain principal information will | that limit a client's ability to obtain principal information will | |||
interfere with the client's ability to manipulate access control | interfere with the client's ability to manipulate access control | |||
lists, due to the difficulty of getting the URL of a principal for | lists, due to the difficulty of getting the URL of a principal for | |||
use in an ACE. | use in an ACE. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 28] | ||||
5.7.1 Example: Retrieving DAV:principal-collection-set | 5.7.1 Example: Retrieving DAV:principal-collection-set | |||
In this example, the client requests the value of the | In this example, the client requests the value of the | |||
DAV:principal-collection-set property on the collection resource | DAV:principal-collection-set property on the collection resource | |||
identified by URL http://www.webdav.org/papers/. The property | identified by URL http://www.webdav.org/papers/. The property | |||
contains the two URLs, http://www.webdav.org/_acl/users/ and | contains the two URLs, http://www.webdav.org/acl/users/ and | |||
http://www.webdav.org/_acl/groups/, both wrapped in <DAV:href> XML | http://www.webdav.org/acl/groups/, both wrapped in DAV:href XML | |||
elements. Digest authentication provides credentials for the | elements. Digest authentication provides credentials for the | |||
principal operating the client. | principal operating the client. | |||
The client might reasonably follow this request with two separate | The client might reasonably follow this request with two separate | |||
PROPFIND requests to retrieve the DAV:displayname property of the | PROPFIND requests to retrieve the DAV:displayname property of the | |||
members of the two collections (/_acl/users/ and /_acl_groups/). | members of the two collections (/acl/users and /acl/groups). This | |||
This information could be used when displaying a user interface for | information could be used when displaying a user interface for | |||
creating access control entries. | creating access control entries. | |||
>> Request << | >> Request << | |||
PROPFIND /papers/ HTTP/1.1 | PROPFIND /papers/ HTTP/1.1 | |||
Host: www.webdav.org | Host: www.webdav.org | |||
Content-type: text/xml; charset="utf-8" | Content-type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
Depth: 0 | Depth: 0 | |||
Authorization: Digest username="yarong", | Authorization: Digest username="yarong", | |||
realm="yarong@webdav.org", nonce="...", | realm="yarong@webdav.org", nonce="...", | |||
uri="/papers/", response="...", opaque="..." | uri="/papers/", response="...", opaque="..." | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:propfind xmlns:D="DAV:"> | <D:propfind xmlns:D="DAV:"> | |||
<D:prop> | <D:prop> | |||
<D:principal-collection-set/> | <D:principal-collection-set/> | |||
</D:prop> | </D:prop> | |||
</D:propfind> | </D:propfind> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 29] | ||||
>> Response << | >> Response << | |||
HTTP/1.1 207 Multi-Status | HTTP/1.1 207 Multi-Status | |||
Content-Type: text/xml; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:multistatus xmlns:D="DAV:"> | <D:multistatus xmlns:D="DAV:"> | |||
<D:response> | <D:response> | |||
<D:href>http://www.webdav.org/papers/</D:href> | <D:href>http://www.webdav.org/papers/</D:href> | |||
<D:propstat> | <D:propstat> | |||
<D:prop> | <D:prop> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 29] | ||||
<D:principal-collection-set> | <D:principal-collection-set> | |||
<D:href> | <D:href>http://www.webdav.org/acl/users/</D:href> | |||
http://www.webdav.org/_acl/users/ | <D:href>http://www.webdav.org/acl/groups/</D:href> | |||
</D:href> | ||||
<D:href> | ||||
http://www.webdav.org/_acl/groups/ | ||||
</D:href> | ||||
</D:principal-collection-set> | </D:principal-collection-set> | |||
</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> | |||
5.8 Example: PROPFIND to retrieve access control properties | 5.8 Example: PROPFIND to retrieve access control properties | |||
The following example shows how access control information can be | The following example shows how access control information can be | |||
skipping to change at line 1448 | skipping to change at line 1446 | |||
Authorization: Digest username="ejw", | Authorization: Digest username="ejw", | |||
realm="users@foo.org", nonce="...", | realm="users@foo.org", nonce="...", | |||
uri="/top/container/", response="...", opaque="..." | uri="/top/container/", response="...", opaque="..." | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:propfind xmlns:D="DAV:"> | <D:propfind xmlns:D="DAV:"> | |||
<D:prop> | <D:prop> | |||
<D:owner/> | <D:owner/> | |||
<D:supported-privilege-set/> | <D:supported-privilege-set/> | |||
<D:current-user-privilege-set/> | <D:current-user-privilege-set/> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 30] | ||||
<D:acl/> | <D:acl/> | |||
</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; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 30] | ||||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:multistatus | <D:multistatus | |||
xmlns:D="DAV:" | xmlns:D="DAV:" | |||
xmlns:A="http://www.webdav.org/acl/"> <D:response> | xmlns:A="http://www.webdav.org/acl/"> <D:response> | |||
<D:href>http://www.foo.org/top/container/</D:href> | <D:href>http://www.foo.org/top/container/</D:href> | |||
<D:propstat> | <D:propstat> | |||
<D:prop> | <D:prop> | |||
<D:owner> | <D:owner> | |||
<D:href>http://www.foo.org/users/gclemm</D:href> | <D:href>http://www.foo.org/users/gclemm</D:href> </D:owner> | |||
</D:owner> | ||||
<D:supported-privilege-set> | <D:supported-privilege-set> | |||
<D:supported-privilege> | <D:supported-privilege> | |||
<D:privilege> <D:all/> </D:privilege> | <D:privilege> <D:all/> </D:privilege> | |||
<D:abstract/> | <D:abstract/> | |||
<D:description xml:lang="en">Any | <D:description xml:lang="en">Any operation</D:description> | |||
operation</D:description> | ||||
<D:supported-privilege> | <D:supported-privilege> | |||
<D:privilege> <D:read/> </D:privilege> | <D:privilege> <D:read/> </D:privilege> | |||
<D:description xml:lang="en">Read any | <D:description xml:lang="en">Read any | |||
object</D:description> | object</D:description> | |||
</D:supported-privilege> | </D:supported-privilege> | |||
<D:supported-privilege> | <D:supported-privilege> | |||
<D:privilege> <D:write/> </D:privilege> | <D:privilege> <D:write/> </D:privilege> | |||
<D:abstract/> | <D:abstract/> | |||
<D:description xml:lang="en">Write any | <D:description xml:lang="en">Write any | |||
object</D:description> | object</D:description> | |||
skipping to change at line 1499 | skipping to change at line 1496 | |||
</D:supported-privilege> | </D:supported-privilege> | |||
<D:supported-privilege> | <D:supported-privilege> | |||
<D:privilege> <A:update/> </D:privilege> | <D:privilege> <A:update/> </D:privilege> | |||
<D:description xml:lang="en">Update an | <D:description xml:lang="en">Update an | |||
object</D:description> | object</D:description> | |||
</D:supported-privilege> | </D:supported-privilege> | |||
<D:supported-privilege> | <D:supported-privilege> | |||
<D:privilege> <A:delete/> </D:privilege> | <D:privilege> <A:delete/> </D:privilege> | |||
<D:description xml:lang="en">Delete an | <D:description xml:lang="en">Delete an | |||
object</D:description> | object</D:description> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 31] | ||||
</D:supported-privilege> | </D:supported-privilege> | |||
</D:supported-privilege> | </D:supported-privilege> | |||
<D:supported-privilege> | <D:supported-privilege> | |||
<D:privilege> <D:read-acl/> </D:privilege> | <D:privilege> <D:read-acl/> </D:privilege> | |||
<D:description xml:lang="en">Read the | <D:description xml:lang="en">Read the ACL</D:description> | |||
ACL</D:description> | ||||
</D:supported-privilege> | </D:supported-privilege> | |||
<D:supported-privilege> | <D:supported-privilege> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 31] | ||||
<D:privilege> <D:write-acl/> </D:privilege> | <D:privilege> <D:write-acl/> </D:privilege> | |||
<D:description xml:lang="en">Write the | <D:description xml:lang="en">Write the | |||
ACL</D:description> | ACL</D:description> | |||
</D:supported-privilege> | </D:supported-privilege> | |||
</D:supported-privilege> | </D:supported-privilege> | |||
</D:supported-privilege-set> | </D:supported-privilege-set> | |||
<D:current-user-privilege-set> | <D:current-user-privilege-set> | |||
<D:privilege> <D:read/> </D:privilege> | <D:privilege> <D:read/> </D:privilege> | |||
<D:privilege> <D:read-acl/> </D:privilege> | <D:privilege> <D:read-acl/> </D:privilege> | |||
</D:current-user-privilege-set> | </D:current-user-privilege-set> | |||
skipping to change at line 1531 | skipping to change at line 1527 | |||
<D:principal> | <D:principal> | |||
<D:href>http://www.foo.org/users/esedlar</D:href> | <D:href>http://www.foo.org/users/esedlar</D:href> | |||
</D:principal> | </D:principal> | |||
<D:grant> | <D:grant> | |||
<D:privilege> <D:read/> </D:privilege> | <D:privilege> <D:read/> </D:privilege> | |||
<D:privilege> <D:write/> </D:privilege> | <D:privilege> <D:write/> </D:privilege> | |||
<D:privilege> <D:read-acl/> </D:privilege> </D:grant> | <D:privilege> <D:read-acl/> </D:privilege> </D:grant> | |||
</D:ace> | </D:ace> | |||
<D:ace> | <D:ace> | |||
<D:principal> | <D:principal> | |||
<D:href>http://www.foo.org/groups/marketing/</D:href> | <D:href>http://www.foo.org/groups/marketing</D:href> | |||
</D:principal> | </D:principal> | |||
<D:deny> | <D:deny> | |||
<D:privilege> <D:read/> </D:privilege> </D:deny> | <D:privilege> <D:read/> </D:privilege> </D:deny> | |||
</D:ace> | </D:ace> | |||
<D:ace> | <D:ace> | |||
<D:principal> | <D:principal> | |||
<D:property> <D:owner/> </D:property> </D:principal> | <D:property> <D:owner/> </D:property> </D:principal> | |||
<D:grant> | <D:grant> | |||
<D:privilege> <D:read-acl/> </D:privilege> | <D:privilege> <D:read-acl/> </D:privilege> | |||
<D:privilege> <D:write-acl/> </D:privilege> </D:grant> | <D:privilege> <D:write-acl/> </D:privilege> </D:grant> | |||
</D:ace> | </D:ace> | |||
<D:ace> | <D:ace> | |||
<D:principal> <D:all/> </D:principal> | <D:principal> <D:all/> </D:principal> | |||
<D:grant> | <D:grant> | |||
<D:privilege> <D:read/> </D:privilege></D:grant> | <D:privilege> <D:read/> </D:privilege></D:grant> | |||
<D:inherited> | <D:inherited> | |||
<D:href>http://www.foo.org/top/</D:href> | <D:href>http://www.foo.org/top</D:href> </D:inherited> | |||
</D:inherited> | ||||
</D:ace> </D:acl> | </D:ace> </D:acl> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 32] | ||||
</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:response> </D:multistatus> | </D:propstat> </D:response> </D:multistatus> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 32] | ||||
The value of the DAV:owner property is a single DAV:href XML | The value of the DAV:owner property is a single DAV:href XML | |||
element containing the URL of the principal that owns this | element containing the URL of the principal that owns this | |||
resource. | resource. | |||
The value of the DAV:supported-privilege-set property is a tree of | The value of the DAV:supported-privilege-set property is a tree of | |||
supported privileges (using "[XML Namespace , localname]" to | supported privileges (using "[XML Namespace , localname]" to | |||
identify each privilege): | identify each privilege): | |||
[DAV:, all] (aggregate, abstract) | [DAV:, all] (aggregate, abstract) | |||
| | | | |||
+-- [DAV:, read] | +-- [DAV:, read] | |||
+-- [DAV:, write] (aggregate, abstract) | +-- [DAV:, write] (aggregate, abstract) | |||
| | | | |||
+-- [http://www.webdav.org/acl/, create] | +-- [http://www.webdav.org/acl, create] | |||
+-- [http://www.webdav.org/acl/, update] | +-- [http://www.webdav.org/acl, update] | |||
+-- [http://www.webdav.org/acl/, delete] | +-- [http://www.webdav.org/acl, delete] | |||
+-- [DAV:, read-acl] | +-- [DAV:, read-acl] | |||
+-- [DAV:, write-acl] | +-- [DAV:, write-acl] | |||
The DAV:current-user-privilege-set property contains two | The DAV:current-user-privilege-set property contains two | |||
privileges, DAV:read, and DAV:read-acl. This indicates that the | privileges, DAV:read, and DAV:read-acl. This indicates that the | |||
current authenticated user only has the ability to read the | current authenticated user only has the ability to read the | |||
resource, and read the DAV:acl property on the resource. | resource, and read the DAV:acl property on the resource. | |||
The DAV:acl property contains a set of four ACEs: | The DAV:acl property contains a set of four ACEs: | |||
ACE #1: The principal identified by the URL | ACE #1: The principal identified by the URL | |||
http://www.foo.org/users/esedlar is granted the DAV:read, | http://www.foo.org/users/esedlar is granted the DAV:read, | |||
DAV:write, and DAV:read-acl privileges. | DAV:write, and DAV:read-acl privileges. | |||
ACE #2: The principals identified by the URL | ACE #2: The principals identified by the URL | |||
http://www.foo.org/groups/marketing/ are denied the DAV:read | http://www.foo.org/groups/marketing are denied the DAV:read | |||
privilege. In this example, the principal URL identifies a group. | privilege. In this example, the principal URL identifies a group. | |||
ACE #3: In this ACE, the principal is a property principal, | ACE #3: In this ACE, the principal is a property principal, | |||
specifically the DAV:owner property. When evaluating this ACE, the | specifically the DAV:owner property. When evaluating this ACE, the | |||
value of the DAV:owner property is retrieved, and is examined to | value of the DAV:owner property is retrieved, and is examined to | |||
see if it contains a DAV:href XML element. If so, the URL within | see if it contains a DAV:href XML element. If so, the URL within | |||
the DAV:href element is read, and identifies a principal. In this | the DAV:href element is read, and identifies a principal. In this | |||
ACE, the owner is granted DAV:read-acl, and DAV:write-acl | ACE, the owner is granted DAV:read-acl, and DAV:write-acl | |||
privileges. | privileges. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 33] | ||||
ACE #4: This ACE grants the DAV:all principal (all users) the | ACE #4: This ACE grants the DAV:all principal (all users) the | |||
DAV:read privilege. This ACE is inherited from the resource | DAV:read privilege. This ACE is inherited from the resource | |||
http://www.foo.org/top/, the parent collection of this resource. | http://www.foo.org/top, the parent collection of this resource. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 33] | ||||
6 ACL SEMANTICS | 6 ACL SEMANTICS | |||
The ACL semantics define how multiple ACEs that match the current | The ACL semantics define how multiple ACEs that match the current | |||
user are combined, what are the constraints on how ACEs can be | user are combined, what are the constraints on how ACEs can be | |||
ordered, and which principals must have an ACE. | ordered, and which principals must have an ACE. | |||
<!ELEMENT acl-semantics (ace-combination?, ace-ordering?, | <!ELEMENT acl-semantics (ace-combination?, ace-ordering?, allowed- | |||
allowed-ace?, required-principal?)> | ace?, required-principal?)> | |||
6.1 ACE Combination | 6.1 ACE Combination | |||
The DAV:ace-combination element defines how privileges from | The DAV:ace-combination element defines how privileges from | |||
multiple ACEs that match the current user will be combined to | multiple ACEs that match the current user will be combined to | |||
determine the access privileges for that user. Multiple ACEs may | determine the access privileges for that user. Multiple ACEs may | |||
match the same user because the same principal can appear in | match the same user because the same principal can appear in | |||
multiple ACEs, because multiple principals can identify the same | multiple ACEs, because multiple principals can identify the same | |||
user, and because one principal can be a member of another | user, and because one principal can be a member of another | |||
principal. | principal. | |||
skipping to change at line 1644 | skipping to change at line 1640 | |||
6.1.2 DAV:all-grant-before-any-deny ACE Combination | 6.1.2 DAV:all-grant-before-any-deny ACE Combination | |||
The ACEs are evaluated in the order in which they appear in the | The ACEs are evaluated in the order in which they appear in the | |||
ACL. If an evaluated ACE denies a privilege needed for the | ACL. If an evaluated ACE denies a privilege needed for the | |||
request, the request MUST fail. If all ACEs have been evaluated | request, the request MUST fail. If all ACEs have been evaluated | |||
without the user being granted all privileges needed for the | without the user being granted all privileges needed for the | |||
request, the request MUST fail. | request, the request MUST fail. | |||
<!ELEMENT all-grant-before-any-deny EMPTY> | <!ELEMENT all-grant-before-any-deny EMPTY> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 34] | ||||
6.1.3 DAV:specific-deny-overrides-grant ACE Combination | 6.1.3 DAV:specific-deny-overrides-grant ACE Combination | |||
All ACEs in the ACL are evaluated. An "individual ACE" is one | All ACEs in the ACL are evaluated. An "individual ACE" is one | |||
whose principal matches the current user. A "group ACE" is one | whose principal matches the current user. A "group ACE" is one | |||
whose principal is a group that has a member that matches the | whose principal is a group that has a member that matches the | |||
current user. A privilege is granted if it is granted by an | current user. A privilege is granted if it is granted by an | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 34] | ||||
individual ACE and not denied by an individual ACE, or if it is | individual ACE and not denied by an individual ACE, or if it is | |||
granted by a group ACE and not denied by an individual or group | granted by a group ACE and not denied by an individual or group | |||
ACE. A request MUST fail if any of its needed privileges are not | ACE. A request MUST fail if any of its needed privileges are not | |||
granted. | granted. | |||
<!ELEMENT specific-deny-overrides-grant EMPTY> | <!ELEMENT specific-deny-overrides-grant EMPTY> | |||
6.2 ACE Ordering | 6.2 ACE Ordering | |||
The DAV:ace-ordering element defines a constraint on how the ACEs | The DAV:ace-ordering element defines a constraint on how the ACEs | |||
skipping to change at line 1694 | skipping to change at line 1689 | |||
per resource. | per resource. | |||
<!ELEMENT principal-only-one-ace EMPTY> | <!ELEMENT principal-only-one-ace EMPTY> | |||
6.3.2 DAV:grant-only ACE Constraint | 6.3.2 DAV:grant-only ACE Constraint | |||
This element indicates that ACEs with deny clauses are not allowed. | This element indicates that ACEs with deny clauses are not allowed. | |||
<!ELEMENT grant-only EMPTY> | <!ELEMENT grant-only EMPTY> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 35] | ||||
6.3.3 DAV:no-invert ACE Constraint | 6.3.3 DAV:no-invert ACE Constraint | |||
This element indicates that ACEs with the <invert> element are not | This element indicates that ACEs with the <invert> element are not | |||
allowed. | allowed. | |||
<!ELEMENT no-invert EMPTY> | <!ELEMENT no-invert EMPTY> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 35] | ||||
6.3.4 DAV:no-acl-inherit ACE Constraint | ||||
This element indicates that ACLs with the <inherited-acl> element | ||||
are not allowed. | ||||
<!ELEMENT no-acl-inherit EMPTY> | ||||
6.4 Required Principals | 6.4 Required Principals | |||
The required principal elements identify which principals must have | The required principal elements identify which principals must have | |||
an ACE defined in the ACL. | an ACE defined in the ACL. | |||
<!ELEMENT required-principal | <!ELEMENT required-principal | |||
(all? | authenticated? | unauthenticated? | self? | href* | | (all? | authenticated? | unauthenticated? | self? | href* | | |||
property*)> | property*)> | |||
For example, the following element requires that the ACL contain a | For example, the following element requires that the ACL contain a | |||
skipping to change at line 1734 | skipping to change at line 1722 | |||
7 ACCESS CONTROL AND EXISTING METHODS | 7 ACCESS CONTROL AND EXISTING METHODS | |||
This section defines the impact of access control functionality on | This section defines the impact of access control functionality on | |||
existing methods. | existing methods. | |||
7.1 OPTIONS | 7.1 OPTIONS | |||
If the server supports access control, it MUST return "access- | If the server supports access control, it MUST return "access- | |||
control" as a field in the DAV response header from an OPTIONS | control" as a field in the DAV response header from an OPTIONS | |||
request on any resource implemented by that server. | request on any resource implemented by that server. A value of | |||
"access-control" in the DAV header MUST indicate that the server | ||||
supports all MUST level requirements and REQUIRED features | ||||
specified in this document. | ||||
7.1.1 Example - OPTIONS | 7.1.1 Example - OPTIONS | |||
>> Request << | >> Request << | |||
OPTIONS /foo.html HTTP/1.1 | OPTIONS /foo.html HTTP/1.1 | |||
Host: www.webdav.org | Host: www.webdav.org | |||
Content-Length: 0 | Content-Length: 0 | |||
>> Response << | >> Response << | |||
skipping to change at line 1797 | skipping to change at line 1788 | |||
ACEs that a client can modify with an ACL request). A lock does not | ACEs that a client can modify with an ACL request). A lock does not | |||
protect inherited or protected ACEs, since a client cannot modify | protect inherited or protected ACEs, since a client cannot modify | |||
them with an ACL request on that resource. | them with an ACL request on that resource. | |||
8 ACCESS CONTROL METHODS | 8 ACCESS CONTROL METHODS | |||
8.1 ACL | 8.1 ACL | |||
The ACL method modifies the access control list (which can be read | The ACL method modifies the access control list (which can be read | |||
via the DAV:acl property) of a resource. Specifically, the ACL | via the DAV:acl property) of a resource. Specifically, the ACL | |||
method only permits modification to ACEs that are not inherited, | ||||
and are not protected. An ACL method invocation modifies all non- | ||||
Clemm, Hopkins, Sedlar, Whitehead [Page 37] | Clemm, Hopkins, Sedlar, Whitehead [Page 37] | |||
method only permits modification to ACEs that are not inherited, | ||||
and are not protected. An ACL method invocation modifies all non- | ||||
inherited and non-protected ACEs in a resource's access control | inherited and non-protected ACEs in a resource's access control | |||
list to exactly match the ACEs contained within in the DAV:acl XML | list to exactly match the ACEs contained within in the DAV:acl XML | |||
element (specified in Section 5.4) of the request body. An ACL | element (specified in Section 5.4) of the request body. An ACL | |||
request body MUST contain only one DAV:acl XML element. Unless the | request body MUST contain only one DAV:acl XML element. Unless the | |||
non-inherited and non-protected ACEs of the DAV:acl property of the | non-inherited and non-protected ACEs of the DAV:acl property of the | |||
resource can be updated to be exactly the value specified in the | resource can be updated to be exactly the value specified in the | |||
ACL request, the ACL request MUST fail. | ACL request, the ACL request MUST fail. | |||
It is possible that the ACEs visible to the current user in the | It is possible that the ACEs visible to the current user in the | |||
DAV:acl property may only be a portion of the complete set of ACEs | DAV:acl property may only be a portion of the complete set of ACEs | |||
skipping to change at line 1848 | skipping to change at line 1839 | |||
(DAV:no-ace-conflict): The ACEs submitted in the ACL request MUST | (DAV:no-ace-conflict): The ACEs submitted in the ACL request MUST | |||
NOT conflict with each other. What is considered a conflict | NOT conflict with each other. What is considered a conflict | |||
depends on the ACL semantics of that resource. | depends on the ACL semantics of that resource. | |||
(DAV:no-protected-ace-conflict): The ACEs submitted in the ACL | (DAV:no-protected-ace-conflict): The ACEs submitted in the ACL | |||
request MUST NOT conflict with the protected ACEs on the resource. | request MUST NOT conflict with the protected ACEs on the resource. | |||
For example, if the resource has a protected ACE granting DAV:write | For example, if the resource has a protected ACE granting DAV:write | |||
to a given principal, then it would not be consistent if the ACL | to a given principal, then it would not be consistent if the ACL | |||
request submitted an ACE denying DAV:write to the same principal. | request submitted an ACE denying DAV:write to the same principal. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 38] | ||||
(DAV:no-inherited-ace-conflict): The ACEs submitted in the ACL | (DAV:no-inherited-ace-conflict): The ACEs submitted in the ACL | |||
request MUST NOT conflict with the inherited ACEs on the resource. | request MUST NOT conflict with the inherited ACEs on the resource. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 38] | ||||
For example, if the resource inherits an ACE from its parent | For example, if the resource inherits an ACE from its parent | |||
collection granting DAV:write to a given principal, then it would | collection granting DAV:write to a given principal, then it would | |||
not be consistent if the ACL request submitted an ACE denying | not be consistent if the ACL request submitted an ACE denying | |||
DAV:write to the same principal. Note that reporting of this error | DAV:write to the same principal. Note that reporting of this error | |||
will be implementation-dependent. Implementations have the choice | will be implementation-dependent. Implementations have the choice | |||
to either report this error, or to allow the ACE to be set, and | to either report this error, or to allow the ACE to be set, and | |||
then let normal ACE evaluation rules determine whether the new ACE | then let normal ACE evaluation rules determine whether the new ACE | |||
has any impact on the privileges available to a specific principal. | has any impact on the privileges available to a specific principal. | |||
(DAV:limited-number-of-aces): The number of ACEs submitted in the | (DAV:limited-number-of-aces): The number of ACEs submitted in the | |||
skipping to change at line 1880 | skipping to change at line 1870 | |||
(DAV:principal-only-one-ace): The ACL request MUST NOT result in | (DAV:principal-only-one-ace): The ACL request MUST NOT result in | |||
more than one ACE for a given principal. This precondition applies | more than one ACE for a given principal. This precondition applies | |||
only when the ACL semantics of the resource includes the | only when the ACL semantics of the resource includes the | |||
DAV:principal-only-one-ace constraint (defined in Section 6.3.1). | DAV:principal-only-one-ace constraint (defined in Section 6.3.1). | |||
(DAV:grant-only): The ACEs submitted in the ACL request MUST NOT | (DAV:grant-only): The ACEs submitted in the ACL request MUST NOT | |||
include a deny ACE. This precondition applies only when the ACL | include a deny ACE. This precondition applies only when the ACL | |||
semantics of the resource includes the DAV:grant-only constraint | semantics of the resource includes the DAV:grant-only constraint | |||
(defined in Section 6.3.2). | (defined in Section 6.3.2). | |||
(DAV:no-invert): The ACL request MUST NOT include a <dav:invert> | (DAV:no-invert): The ACL request MUST NOT include a DAV:invert | |||
element. This precondition applies only when the ACL semantics of | element. This precondition applies only when the ACL semantics of | |||
the resource includes the DAV:no-invert constraint (defined in | the resource includes the DAV:no-invert constraint (defined in | |||
Section 6.3.4). | Section 6.3.4). | |||
(DAV:no-acl-inherit): The ACL request MUST NOT include a | ||||
<dav:inherited-acl> element. This precondition applies only when | ||||
the ACL semantics of the resource includes the DAV:no-acl-inherit | ||||
constraint (defined in Section 6.3.4). | ||||
(DAV:no-abstract): The ACL request MUST NOT attempt to grant or | (DAV:no-abstract): The ACL request MUST NOT attempt to grant or | |||
deny an abstract privilege (see Section 5.2). | deny an abstract privilege (see Section 5.2). | |||
(DAV:not-supported-privilege): The ACEs submitted in the ACL | (DAV:not-supported-privilege): The ACEs submitted in the ACL | |||
request MUST be supported by the resource. | request MUST be supported by the resource. | |||
(DAV:missing-required-principal): The result of the ACL request | (DAV:missing-required-principal): The result of the ACL request | |||
MUST have at least one ACE for each principal identified in a | MUST have at least one ACE for each principal identified in a | |||
DAV:required-principal XML element in the ACL semantics of that | DAV:required-principal XML element in the ACL semantics of that | |||
resource (see Section 6.3.2). | resource (see Section 6.3.2). | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 39] | ||||
(DAV:recognized-principal): Every principal URL in the ACL request | (DAV:recognized-principal): Every principal URL in the ACL request | |||
MUST identify a principal resource. | MUST identify a principal resource. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 39] | ||||
(DAV:allowed-principal): The principals specified in the ACEs | (DAV:allowed-principal): The principals specified in the ACEs | |||
submitted in the ACL request MUST be allowed as principals for the | submitted in the ACL request MUST be allowed as principals for the | |||
resource. For example, a server where only authenticated principals | resource. For example, a server where only authenticated principals | |||
can access resources would not allow the DAV:all or | can access resources would not allow the DAV:all or | |||
DAV:unauthenticated principals to be used in an ACE, since these | DAV:unauthenticated principals to be used in an ACE, since these | |||
would allow unauthenticated access to resources. | would allow unauthenticated access to resources. | |||
8.1.2 Example: the ACL method | 8.1.2 Example: the ACL method | |||
In the following example, user "fielding", authenticated by | In the following example, user "fielding", authenticated by | |||
skipping to change at line 1950 | skipping to change at line 1935 | |||
</D:grant> | </D:grant> | |||
</D:ace> | </D:ace> | |||
<D:ace> | <D:ace> | |||
<D:principal> | <D:principal> | |||
<D:property> <D:owner/> </D:property> | <D:property> <D:owner/> </D:property> | |||
</D:principal> | </D:principal> | |||
<D:grant> | <D:grant> | |||
<D:privilege> <D:read-acl/> </D:privilege> | <D:privilege> <D:read-acl/> </D:privilege> | |||
<D:privilege> <D:write-acl/> </D:privilege> | <D:privilege> <D:write-acl/> </D:privilege> | |||
</D:grant> | </D:grant> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 40] | ||||
</D:ace> | </D:ace> | |||
<D:ace> | <D:ace> | |||
<D:principal> <D:all/> </D:principal> | <D:principal> <D:all/> </D:principal> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 40] | ||||
<D:grant> | <D:grant> | |||
<D:privilege> <D:read/> </D:privilege> | <D:privilege> <D:read/> </D:privilege> | |||
</D:grant> | </D:grant> | |||
</D:ace> </D:acl> | </D:ace> </D:acl> | |||
>> Response << | >> Response << | |||
HTTP/1.1 200 OK | HTTP/1.1 200 OK | |||
8.1.3 Example: ACL method failure due to protected ACE conflict | 8.1.3 Example: ACL method failure due to protected ACE conflict | |||
skipping to change at line 2000 | skipping to change at line 1985 | |||
<D:ace> | <D:ace> | |||
<D:principal> | <D:principal> | |||
<D:href>http://www.foo.org/users/esedlar</D:href> | <D:href>http://www.foo.org/users/esedlar</D:href> | |||
</D:principal> | </D:principal> | |||
<D:deny> | <D:deny> | |||
<D:privilege> <D:write/> </D:privilege> | <D:privilege> <D:write/> </D:privilege> | |||
</D:deny> | </D:deny> | |||
</D:ace> | </D:ace> | |||
</D:acl> | </D:acl> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 41] | ||||
>> Response << | >> Response << | |||
HTTP/1.1 403 Forbidden | HTTP/1.1 403 Forbidden | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 41] | ||||
Content-Type: text/xml; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:error xmlns:D="DAV:"> | <D:error xmlns:D="DAV:"> | |||
<D:no-protected-ace-conflict/> | <D:no-protected-ace-conflict/> | |||
</D:error> | </D:error> | |||
8.1.4 Example: ACL method failure due to an inherited ACE conflict | 8.1.4 Example: ACL method failure due to an inherited ACE conflict | |||
skipping to change at line 2049 | skipping to change at line 2035 | |||
Host: www.foo.org | Host: www.foo.org | |||
Content-Type: text/xml; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxxx | Content-Length: xxxx | |||
Authorization: Digest username="ejw", | Authorization: Digest username="ejw", | |||
realm="users@foo.org", nonce="...", | realm="users@foo.org", nonce="...", | |||
uri="/top/index.html", response="...", opaque="..." | uri="/top/index.html", response="...", opaque="..." | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:acl xmlns:D="DAV:" xmlns:F="http://www.foo.org/privs/"> | <D:acl xmlns:D="DAV:" xmlns:F="http://www.foo.org/privs/"> | |||
<D:ace> | <D:ace> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 42] | ||||
<D:principal> | <D:principal> | |||
<D:href>http://www.foo.org/users/ejw</D:href> | <D:href>http://www.foo.org/users/ejw</D:href> | |||
</D:principal> | </D:principal> | |||
<D:grant><D:write/></D:grant> | <D:grant><D:write/></D:grant> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 42] | ||||
</D:ace> | </D:ace> | |||
</D:acl> | </D:acl> | |||
>> Response << | >> Response << | |||
HTTP/1.1 403 Forbidden | HTTP/1.1 403 Forbidden | |||
Content-Type: text/xml; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
skipping to change at line 2077 | skipping to change at line 2063 | |||
</D:error> | </D:error> | |||
8.1.5 Example: ACL method failure due to an attempt to set grant and | 8.1.5 Example: ACL method failure due to an attempt to set grant and | |||
deny in a single ACE. | deny in a single ACE. | |||
In this example, user "ygoland", authenticated by information in | In this example, user "ygoland", authenticated by information in | |||
the Authorization header, tries to change the access control list | the Authorization header, tries to change the access control list | |||
on the resource http://www.foo.org/diamond/engagement-ring.gif. The | on the resource http://www.foo.org/diamond/engagement-ring.gif. The | |||
ACL request includes a single, syntactically and semantically | ACL request includes a single, syntactically and semantically | |||
incorrect ACE, which attempts to grant the group identified by the | incorrect ACE, which attempts to grant the group identified by the | |||
URL http://www.foo.org/users/friends/ DAV:read privilege and deny | URL http://www.foo.org/users/friends DAV:read privilege and deny | |||
the principal identified by URL http://www.foo.org/users/ygoland-so | the principal identified by URL http://www.foo.org/users/ygoland-so | |||
(i.e., the user "ygoland-so") DAV:read privilege. However, it is | (i.e., the user "ygoland-so") DAV:read privilege. However, it is | |||
illegal to have multiple principal elements, as well as both a | illegal to have multiple principal elements, as well as both a | |||
grant and deny element in the same ACE, so the request fails due to | grant and deny element in the same ACE, so the request fails due to | |||
poor syntax. | poor syntax. | |||
>> Request << | >> Request << | |||
ACL /diamond/engagement-ring.gif HTTP/1.1 | ACL /diamond/engagement-ring.gif HTTP/1.1 | |||
Host: www.foo.org | Host: www.foo.org | |||
Content-Type: text/xml; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxxx | Content-Length: xxxx | |||
Authorization: Digest username="ygoland", | Authorization: Digest username="ygoland", | |||
realm="users@foo.org", nonce="...", | realm="users@foo.org", nonce="...", | |||
uri="/diamond/engagement-ring.gif", response="...", | uri="/diamond/engagement-ring.gif", response="...", opaque="..." | |||
opaque="..." | ||||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:acl xmlns:D="DAV:"> | <D:acl xmlns:D="DAV:"> | |||
<D:ace> | <D:ace> | |||
<D:principal> | <D:principal> | |||
<D:href>http://www.foo.org/users/friends</D:href> | ||||
Clemm, Hopkins, Sedlar, Whitehead [Page 43] | ||||
<D:href>http://www.foo.org/users/friends/</D:href> | ||||
</D:principal> | </D:principal> | |||
<D:grant><D:read/></D:grant> | <D:grant><D:read/></D:grant> | |||
<D:principal> | <D:principal> | |||
<D:href>http://www.foo.org/users/ygoland-so</D:href> | <D:href>http://www.foo.org/users/ygoland-so</D:href> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 43] | ||||
</D:principal> | </D:principal> | |||
<D:deny><D:read/></D:deny> | <D:deny><D:read/></D:deny> | |||
</D:ace> | </D:ace> | |||
</D:acl> | </D:acl> | |||
>> Response << | >> Response << | |||
HTTP/1.1 400 Bad Request | HTTP/1.1 400 Bad Request | |||
Content-Length: 0 | Content-Length: 0 | |||
skipping to change at line 2134 | skipping to change at line 2119 | |||
The REPORT method (defined in Section 3.6 of [RFC3253]) provides an | The REPORT method (defined in Section 3.6 of [RFC3253]) provides an | |||
extensible mechanism for obtaining information about a resource. | extensible mechanism for obtaining information about a resource. | |||
Unlike the PROPFIND method, which returns the value of one or more | Unlike the PROPFIND method, which returns the value of one or more | |||
named properties, the REPORT method can involve more complex | named properties, the REPORT method can involve more complex | |||
processing. REPORT is valuable in cases where the server has access | processing. REPORT is valuable in cases where the server has access | |||
to all of the information needed to perform the complex request | to all of the information needed to perform the complex request | |||
(such as a query), and where it would require multiple requests for | (such as a query), and where it would require multiple requests for | |||
the client to retrieve the information needed to perform the same | the client to retrieve the information needed to perform the same | |||
request. | request. | |||
A server that supports the WebDAV Access Control Protocol MUST | ||||
support the DAV:expand-property report (defined in Section 3.8 of | ||||
[RFC3253]). | ||||
9.2 DAV:acl-principal-prop-set Report | 9.2 DAV:acl-principal-prop-set Report | |||
The DAV:acl-principal-prop-set report returns, for all principals | The DAV:acl-principal-prop-set report returns, for all principals | |||
in the DAV:acl property that are identified by http(s) URLs or by a | in the DAV:acl property (of the Request-URI) that are identified by | |||
DAV:property principal, the value of the properties specified in | http(s) URLs or by a DAV:property principal, the value of the | |||
the REPORT request body. In the case where a principal URL appears | properties specified in the REPORT request body. In the case where | |||
multiple times, the DAV:acl-principal-prop-set report MUST return | a principal URL appears multiple times, the DAV:acl-principal-prop- | |||
the properties for that principal only once. | set report MUST return the properties for that principal only once. | |||
Support for this report is REQUIRED. | ||||
One expected use of this report is to retrieve the human readable | ||||
name (found in the DAV:displayname property) of each principal | ||||
found in an ACL. This is useful for constructing user interfaces | ||||
that show each ACE in a human readable form. | ||||
Marshalling | Marshalling | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 44] | ||||
The request body MUST be a DAV:acl-principal-prop-set XML element. | The request body MUST be a DAV:acl-principal-prop-set XML element. | |||
<!ELEMENT acl-principal-prop-set ANY> | <!ELEMENT acl-principal-prop-set ANY> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 44] | ||||
ANY value: a sequence of one or more elements, with at most one | ANY value: a sequence of one or more elements, with at most one | |||
DAV:prop element. | DAV:prop element. | |||
prop: see RFC 2518, Section 12.11 | prop: see RFC 2518, Section 12.11 | |||
This report is only defined when the Depth header has value "0"; | ||||
other values result in a 400 (Bad Request) error response. Note | ||||
that [RFC3253], Section 3.6, states that if the Depth header is not | ||||
present, it defaults to a value of "0". | ||||
The response body for a successful request MUST be a | The response body for a successful request MUST be a | |||
DAV:multistatus XML element (i.e., the response uses the same | DAV:multistatus XML element (i.e., the response uses the same | |||
format as the response for PROPFIND). | format as the response for PROPFIND). | |||
multistatus: see RFC 2518, Section 12.9 | multistatus: see RFC 2518, Section 12.9 | |||
The response body for a successful DAV:acl-principal-prop-set | The response body for a successful DAV:acl-principal-prop-set | |||
REPORT request MUST contain a DAV:response element for each | REPORT request MUST contain a DAV:response element for each | |||
principal identified by an http(s) URL listed in a DAV:principal | principal identified by an http(s) URL listed in a DAV:principal | |||
XML element of an ACE within the DAV:acl property of the resource | XML element of an ACE within the DAV:acl property of the resource | |||
skipping to change at line 2179 | skipping to change at line 2178 | |||
ACEs: | ACEs: | |||
ACE #1: All principals (DAV:all) have DAV:read and DAV:read- | ACE #1: All principals (DAV:all) have DAV:read and DAV:read- | |||
current-user-privilege-set access. | current-user-privilege-set access. | |||
ACE #2: The principal identified by | ACE #2: The principal identified by | |||
http://www.webdav.org/people/gstein (the user "gstein") is granted | http://www.webdav.org/people/gstein (the user "gstein") is granted | |||
DAV:write, DAV:write-acl, DAV:read-acl privileges. | DAV:write, DAV:write-acl, DAV:read-acl privileges. | |||
ACE #3: The group identified by | ACE #3: The group identified by | |||
http://www.webdav.org/groups/authors/ (the "authors" group) is | http://www.webdav.org/groups/authors (the "authors" group) is | |||
granted DAV:write and DAV:read-acl privileges. | granted DAV:write and DAV:read-acl privileges. | |||
The following example shows a DAV:acl-principal-prop-set report | The following example shows a DAV:acl-principal-prop-set report | |||
requesting the DAV:displayname property. It returns the value of | requesting the DAV:displayname property. It returns the value of | |||
DAV:displayname for resources http://www.webdav.org/people/gstein | DAV:displayname for resources http://www.webdav.org/people/gstein | |||
and http://www.webdav.org/groups/authors/ , but not for DAV:all, | and http://www.webdav.org/groups/authors , but not for DAV:all, | |||
since this is not an http(s) URL. | since this is not an http(s) URL. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 45] | ||||
>> Request << | >> Request << | |||
REPORT /index.html HTTP/1.1 | REPORT /index.html HTTP/1.1 | |||
Host: www.webdav.org | Host: www.webdav.org | |||
Content-Type: text/xml; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxxx | Content-Length: xxxx | |||
Depth: 0 | ||||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:acl-principal-prop-set xmlns:D="DAV:"> | <D:acl-principal-prop-set xmlns:D="DAV:"> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 45] | ||||
<D:prop> | <D:prop> | |||
<D:displayname/> | <D:displayname/> | |||
</D:prop> | </D:prop> | |||
</D:acl-principal-prop-set> | </D:acl-principal-prop-set> | |||
>> Response << | >> Response << | |||
HTTP/1.1 207 Multi-Status | HTTP/1.1 207 Multi-Status | |||
Content-Type: text/xml; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxxx | Content-Length: xxxx | |||
skipping to change at line 2222 | skipping to change at line 2221 | |||
<D:response> | <D:response> | |||
<D:href>http://www.webdav.org/people/gstein</D:href> | <D:href>http://www.webdav.org/people/gstein</D:href> | |||
<D:propstat> | <D:propstat> | |||
<D:prop> | <D:prop> | |||
<D:displayname>Greg Stein</D:displayname> | <D:displayname>Greg Stein</D:displayname> | |||
</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.webdav.org/groups/authors/</D:href> | <D:href>http://www.webdav.org/groups/authors</D:href> | |||
<D:propstat> | <D:propstat> | |||
<D:prop> | <D:prop> | |||
<D:displayname>Site authors</D:displayname> | <D:displayname>Site authors</D:displayname> | |||
</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> | |||
9.3 DAV:principal-match REPORT | 9.3 DAV:principal-match REPORT | |||
The DAV:principal-match REPORT is used to identify all members of a | The DAV:principal-match REPORT is used to identify all members (at | |||
collection that match the current user. In particular, if the | any depth) of the collection identified by the Request-URI that | |||
collection contains principals, the report can be used to identify | match the current user. In particular, if the collection contains | |||
all members of the collection that match the current user. | ||||
Alternatively, if the collection contains resources that have a | ||||
property that identifies a principal (e.g. DAV:owner), then the | ||||
report can be used to identify all members of the collection whose | ||||
property identifies a principal that matches the current user. For | ||||
example, this report can return all of the resources in a | ||||
collection hierarchy that are owned by the current user. | ||||
Marshalling: | ||||
Clemm, Hopkins, Sedlar, Whitehead [Page 46] | Clemm, Hopkins, Sedlar, Whitehead [Page 46] | |||
principals, the report can be used to identify all members of the | ||||
collection that match the current user. Alternatively, if the | ||||
collection contains resources that have a property that identifies | ||||
a principal (e.g. DAV:owner), the report can be used to identify | ||||
all members of the collection whose property identifies a principal | ||||
that matches the current user. For example, this report can return | ||||
all of the resources in a collection hierarchy that are owned by | ||||
the current user. Support for this report is REQUIRED. | ||||
Marshalling: | ||||
The request body MUST be a DAV:principal-match XML element. | The request body MUST be a DAV:principal-match XML element. | |||
<!ELEMENT principal-match ((principal-property | self), prop?)> | <!ELEMENT principal-match ((principal-property | self), prop?)> | |||
<!ELEMENT principal-property ANY> | <!ELEMENT principal-property ANY> | |||
ANY value: an element whose value identifies a property. The | ANY value: an element whose value identifies a property. The | |||
expectation is the value of the named property typically | expectation is the value of the named property typically contains | |||
contains an href element that contains the URI of a principal | an href element that contains the URI of a principal | |||
<!ELEMENT self EMPTY> | <!ELEMENT self EMPTY> | |||
prop: see RFC 2518, Section 12.11 | prop: see RFC 2518, Section 12.11 | |||
This report is only defined when the Depth header has value "0"; | ||||
other values result in a 400 (Bad Request) error response. Note | ||||
that [RFC3253], Section 3.6, states that if the Depth header is not | ||||
present, it defaults to a value of "0". | ||||
The response body for a successful request MUST be a | The response body for a successful request MUST be a | |||
DAV:multistatus XML element. | DAV:multistatus XML element. | |||
multistatus: see RFC 2518, Section 12.9 | multistatus: see RFC 2518, Section 12.9 | |||
The response body for a successful DAV:principal-match REPORT | The response body for a successful DAV:principal-match REPORT | |||
request MUST contain a DAV:response element for each member of the | request MUST contain a DAV:response element for each member of the | |||
collection that matches the current user. When the DAV:principal- | collection that matches the current user. When the DAV:principal- | |||
property element is used, a match occurs if the current user is | property element is used, a match occurs if the current user is | |||
matched by the principal identified by the URI found in the | matched by the principal identified by the URI found in the | |||
DAV:href element of the property identified by the DAV:principal- | DAV:href element of the property identified by the DAV:principal- | |||
property element. When the DAV:self element is used in a | property element. When the DAV:self element is used in a | |||
DAV:principal-match report issued against a group, it matches a | DAV:principal-match report issued against a group, it matches a | |||
member of the group if that child (a principal resource) identifies | member of the group if that child (a principal resource) identifies | |||
the same principal as the current user. | the same principal as the current user. | |||
If DAV:prop is specified in the request body, the properties | If DAV:prop is specified in the request body, the properties | |||
specified in the DAV:prop element MUST be reported in the | specified in the DAV:prop element MUST be reported in the | |||
DAV:response elements. | DAV:response elements. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 47] | ||||
9.3.1 Example: DAV:principal-match REPORT | 9.3.1 Example: DAV:principal-match REPORT | |||
The following example identifies the members of the collection | The following example identifies the members of the collection | |||
identified by the URL http://www.webdav.org/doc/ that are owned by | identified by the URL http://www.webdav.org/doc that are owned by | |||
the current user. The current user ("gclemm") is authenticated | the current user. The current user ("gclemm") is authenticated | |||
using Digest authentication. | using Digest authentication. | |||
>> Request << | >> Request << | |||
REPORT /doc/ HTTP/1.1 | REPORT /doc/ HTTP/1.1 | |||
Host: www.webdav.org | Host: www.webdav.org | |||
Authorization: Digest username="gclemm", | Authorization: Digest username="gclemm", | |||
realm="gclemm@webdav.org", nonce="...", | realm="gclemm@webdav.org", nonce="...", | |||
uri="/papers/", response="...", opaque="..." | uri="/papers/", response="...", opaque="..." | |||
Content-Type: text/xml; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxxx | Content-Length: xxxx | |||
Depth: infinity | Depth: 0 | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 47] | ||||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:principal-match xmlns:D="DAV:"> | <D:principal-match xmlns:D="DAV:"> | |||
<D:principal-property> | <D:principal-property> | |||
<D:owner/> | <D:owner/> | |||
</D:principal-property> | </D:principal-property> | |||
</D:principal-match> | </D:principal-match> | |||
>> Response << | >> Response << | |||
HTTP/1.1 207 Multi-Status | HTTP/1.1 207 Multi-Status | |||
skipping to change at line 2324 | skipping to change at line 2329 | |||
<D:status>HTTP/1.1 200 OK</D:status> | <D:status>HTTP/1.1 200 OK</D:status> | |||
</D:response> | </D:response> | |||
<D:response> | <D:response> | |||
<D:href>http://www.webdav.org/doc/img/bar.gif</D:href> | <D:href>http://www.webdav.org/doc/img/bar.gif</D:href> | |||
<D:status>HTTP/1.1 200 OK</D:status> | <D:status>HTTP/1.1 200 OK</D:status> | |||
</D:response> | </D:response> | |||
</D:multistatus> | </D:multistatus> | |||
9.4 DAV:principal-property-search REPORT | 9.4 DAV:principal-property-search REPORT | |||
The DAV:principal-property-search REPORT performs a substring | The DAV:principal-property-search REPORT performs a search for all | |||
search on the character data value of specified properties. The | principals whose properties contain character data that matches the | |||
server may perform caseless matching of substrings. Only properties | search criteria specified in the request. One expected use of this | |||
defined on principal resources are searched. For implementation | report is to discover the URL of a principal associated with a | |||
efficiency, servers do not typically support substring searching on | ||||
all properties. A client can discover the set of searchable | Clemm, Hopkins, Sedlar, Whitehead [Page 48] | |||
properties by using the DAV:principal-search-property-set REPORT, | given person or group by searching for them by name. This is done | |||
defined in Section 9.5. | by searching over DAV:displayname, which is defined on all | |||
principals. | ||||
The actual search method (exact matching vs. substring matching vs, | ||||
prefix-matching, case-sensitivity) deliberately is left to the | ||||
server implementation to allow implementation on a wide set of | ||||
possible user management systems. In cases where the implementation | ||||
of DAV:principal-property-search is not constrained by the | ||||
semantics of an underlying user management repository, preferred | ||||
default semantics are caseless substring matches. | ||||
For implementation efficiency, servers do not typically support | ||||
searching on all properties. A client can discover the set of | ||||
searchable properties by using the DAV:principal-search-property- | ||||
set REPORT, defined in Section 9.5. | ||||
Support for the DAV:principal-property-search report is REQUIRED. | ||||
Implementation Note: The value of a WebDAV property is a | Implementation Note: The value of a WebDAV property is a | |||
sequence of well-formed XML, and hence can include any character | sequence of well-formed XML, and hence can include any character | |||
in the Unicode/ISO-10646 standard, that is, most known | in the Unicode/ISO-10646 standard, that is, most known | |||
characters in human languages. Due to the idiosyncrasies of case | characters in human languages. Due to the idiosyncrasies of case | |||
mapping across human languages, implementation of caseless | mapping across human languages, implementation of case- | |||
matching is non-trivial. Implementors are strongly encouraged to | insensitive matching is non-trivial. Implementors of servers | |||
that do perform substring matching are strongly encouraged to | ||||
consult [CaseMap], especially Section 2.3 ("Caseless Matching"), | consult [CaseMap], especially Section 2.3 ("Caseless Matching"), | |||
for guidance when implementing their caseless matching | for guidance when implementing their case-insensitive matching | |||
algorithms. | algorithms. | |||
Marshalling: | Implementation Note: Some implementations of this protocol will | |||
use an LDAP repository for storage of principal metadata. The | ||||
Clemm, Hopkins, Sedlar, Whitehead [Page 48] | schema describing each attribute (akin to a WebDAV property) in | |||
The scope of the DAV:principal-property-search REPORT is all | an LDAP repository specifies whether it supports case-sensitive | |||
principal resources that are members of a collection identified in | or caseless searching. One of the benefits of leaving the search | |||
DAV:principal-collection-set. If a group is in the scope of the | method to the discretion of the server implementation is the | |||
DAV:principal-property-search REPORT, all members of that group are | default LDAP attribute search behavior can be used when | |||
also in the scope. | implementing the DAV:principal-property-search report. | |||
Servers MUST support the DAV:principal-property-search REPORT on | ||||
all principal collections identified in the value of a | ||||
DAV:principal-collection-set property. | ||||
Marshalling: | ||||
The request body MUST be a DAV:principal-property-search XML | The request body MUST be a DAV:principal-property-search XML | |||
element containing a search specification and an optional list of | element containing a search specification and an optional list of | |||
properties. For every principal that matches the search | properties. For every principal that matches the search | |||
specification, the response will contain the value of the | specification, the response will contain the value of the requested | |||
properties on that principal. | properties on that principal. | |||
<!ELEMENT principal-property-search ((property-search+), prop?)> | <!ELEMENT principal-property-search | |||
((property-search+), prop?, apply-to-principal-collection-set?) > | ||||
Clemm, Hopkins, Sedlar, Whitehead [Page 49] | ||||
By default, the report searches all members (at any depth) of the | ||||
collection identified by the Request-URI. If DAV:apply-to- | ||||
principal-collection-set is specified in the request body, the | ||||
request is applied instead to each collection identified by the | ||||
DAV:prinicipal-collection-set property of the resource identified | ||||
by the Request-URI. | ||||
The DAV:property-search element contains a prop element enumerating | The DAV:property-search element contains a prop element enumerating | |||
the properties to be searched and a substring element, containing | the properties to be searched and a match element, containing the | |||
the search string, and an optional tag indicating whether or not | search string. | |||
case-insensitive string matching should be done (the default is | ||||
implementation-dependent). | ||||
<!ELEMENT property-search (prop, substring, caseless?) > | <!ELEMENT property-search (prop, match) > | |||
prop: see RFC 2518, Section 12.11 | prop: see RFC 2518, Section 12.11 | |||
<!ELEMENT substring #PCDATA > | <!ELEMENT match #PCDATA > | |||
<!ELEMENT caseless EMPTY> | ||||
Multiple property-search elements or multiple elements within a | Multiple property-search elements or multiple elements within a | |||
DAV:prop element will be interpreted with a logical AND. An empty | DAV:prop element will be interpreted with a logical AND. | |||
DAV:substring element will match all properties specified in its | ||||
parent DAV:property-search element. | This report is only defined when the Depth header has value "0"; | |||
other values result in a 400 (Bad Request) error response. Note | ||||
that [RFC3253], Section 3.6, states that if the Depth header is not | ||||
present, it defaults to a value of "0". | ||||
The response body for a successful request MUST be a | The response body for a successful request MUST be a | |||
DAV:multistatus XML element. | DAV:multistatus XML element. | |||
multistatus: see RFC 2518, Section 12.9 | multistatus: see RFC 2518, Section 12.9 | |||
The response body for a successful DAV:principal-property-search | The response body for a successful DAV:principal-property-search | |||
REPORT request MUST contain a DAV:response element for each | REPORT request MUST contain a DAV:response element for each | |||
principal whose property values satisfy the search specification | principal whose property values satisfy the search specification | |||
given in DAV:principal-property-search. | given in DAV:principal-property-search. | |||
The response body for an unsuccessful DAV:principal-property-search | ||||
REPORT request MUST contain, after the XML element indicating the | ||||
failed precondition or postcondition, a DAV:prop element containing | ||||
the property that caused the pre/postcondition to fail. | ||||
If DAV:prop is specified in the request body, the properties | If DAV:prop is specified in the request body, the properties | |||
specified in the DAV:prop element MUST be reported in the | specified in the DAV:prop element MUST be reported in the | |||
DAV:response elements. | DAV:response elements. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 49] | ||||
Preconditions: | Preconditions: | |||
(DAV:non-searchable-property): All properties specified in the | (DAV:property-must-be-searchable): All properties specified in the | |||
DAV:principal-property-search REPORT must be searchable. | DAV:principal-property-search REPORT must be searchable. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 50] | ||||
9.4.1 Matching | 9.4.1 Matching | |||
There are several cases to consider when matching strings. The | There are several cases to consider when matching strings. The | |||
easiest case is when a property value is "simple" and has only | easiest case is when a property value is "simple" and has only | |||
character information item content (see [REC-XML-INFOSET]). For | character information item content (see [REC-XML-INFOSET]). For | |||
example, the search string "julian" would match the DAV:displayname | example, the search string "julian" would match the DAV:displayname | |||
property with value "Julian Reschke". Note that the on-the-wire | property with value "Julian Reschke". Note that the on-the-wire | |||
marshalling of DAV:displayname in this case is: | marshalling of DAV:displayname in this case is: | |||
<D:displayname xmlns:D="DAV:">Julian Reschke</D:displayname> | <D:displayname xmlns:D="DAV:">Julian Reschke</D:displayname> | |||
The name of the property is encoded into the XML element | The name of the property is encoded into the XML element | |||
information item, and the character information item content of the | information item, and the character information item content of the | |||
property is "Julian Reschke". | property is "Julian Reschke". | |||
The more complicated case occurred when properties have mixed | A more complicated case occurs when properties have mixed content | |||
content (that is, compound values consisting of multiple child | (that is, compound values consisting of multiple child element | |||
element items, other types of information items, and character | items, other types of information items, and character information | |||
information item content). Consider the property | item content). Consider the property "aprop" in the namespace | |||
http://www.webdav.org/props/aprop, marshalled as: | "http://www.webdav.org/props/", marshalled as: | |||
<W:aprop xmlns:W="http://www.webdav.org/props/"> | <W:aprop xmlns:W="http://www.webdav.org/props/"> | |||
{cdata 0}<W:elem1>{cdata 1}</W:elem1> | {cdata 0}<W:elem1>{cdata 1}</W:elem1> | |||
<W:elem2>{cdata 2}</W:elem2>{cdata 3} | <W:elem2>{cdata 2}</W:elem2>{cdata 3} | |||
</W:aprop> | </W:aprop> | |||
In this case, substring matching is performed on each individual | In this case, matching is performed on each individual contiguous | |||
contiguous sequence of character information items. In the example | sequence of character information items. In the example above, a | |||
above, a search string would be compared to the four following | search string would be compared to the four following strings: | |||
strings: | ||||
{cdata 0} | {cdata 0} | |||
{cdata 1} | {cdata 1} | |||
{cdata 2} | {cdata 2} | |||
{cdata 3} | {cdata 3} | |||
That is, four individual substring matches would be performed, one | That is, four individual matches would be performed, one each for | |||
each for {cdata 0}, {cdata 1}, {cdata 2}, and {cdata 3}. | {cdata 0}, {cdata 1}, {cdata 2}, and {cdata 3}. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 50] | ||||
9.4.2 Example: successful DAV:principal-property-search REPORT | 9.4.2 Example: successful DAV:principal-property-search REPORT | |||
In this example, the client requests the principal URLs of all | In this example, the client requests the principal URLs of all | |||
users whose DAV:displayname property contains the substring "doE" | users whose DAV:displayname property contains the substring "doE" | |||
and whose http://BigCorp.com/ns/title property (that is, their | and whose "title" property in the namespace | |||
professional title) contains "Sales". In addition, the client | "http://BigCorp.com/ns/" (that is, their professional title) | |||
requests five properties to be returned with the matching | contains "Sales". In addition, the client requests five properties | |||
principals: | to be returned with the matching principals: | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 51] | ||||
In the DAV: namespace: displayname | In the DAV: namespace: displayname | |||
In the http://www.BigCorp.com/ns/ namespace: department, phone, | In the http://www.BigCorp.com/ns/ namespace: department, phone, | |||
office, salary | office, salary | |||
The response shows that two principal resources meet the search | The response shows that two principal resources meet the search | |||
specification, "John Doe" and "Zygdoebert Smith". The property | specification, "John Doe" and "Zygdoebert Smith". The property | |||
"salary" in namespace "http://www.BigCorp.com/ns/" is not returned, | "salary" in namespace "http://www.BigCorp.com/ns/" is not returned, | |||
since the principal making the request does not have sufficient | since the principal making the request does not have sufficient | |||
access permissions to read this property. | access permissions to read this property. | |||
>> Request << | >> Request << | |||
REPORT /users/ HTTP/1.1 | REPORT /users/ HTTP/1.1 | |||
Host: www.BigCorp.com | Host: www.BigCorp.com | |||
Content-Type: text/xml; charset=utf-8 | Content-Type: text/xml; charset=utf-8 | |||
Content-Length: xxxx | Content-Length: xxxx | |||
Depth: 0 | ||||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:principal-property-search xmlns:D="DAV:"> | <D:principal-property-search xmlns:D="DAV:"> | |||
<D:property-search> | <D:property-search> | |||
<D:prop> | <D:prop> | |||
<D:displayname/> | <D:displayname/> | |||
</D:prop> | </D:prop> | |||
<D:substring>doE</D:substring> | <D:match>doE</D:match> | |||
<D:caseless/> | ||||
</D:property-search> | </D:property-search> | |||
<D:property-search> | <D:property-search> | |||
<D:prop xmlns:B="http://www.BigCorp.com/ns/"> | <D:prop xmlns:B="http://www.BigCorp.com/ns/"> | |||
<B:title/> | <B:title/> | |||
</D:prop> | </D:prop> | |||
<D:substring>Sales</D: substring> | <D:match>Sales</D:match> | |||
</D:property-search> | </D:property-search> | |||
<D:prop xmlns:B="http://www.BigCorp.com/ns/"> | <D:prop xmlns:B="http://www.BigCorp.com/ns/"> | |||
<D:displayname/> | <D:displayname/> | |||
<B:department/> | <B:department/> | |||
<B:phone/> | <B:phone/> | |||
<B:office/> | <B:office/> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 51] | ||||
<B:salary/> | <B:salary/> | |||
</D:prop> | </D:prop> | |||
</D:principal-property-search> | </D:principal-property-search> | |||
>> Response << | >> Response << | |||
HTTP/1.1 207 Multi-Status | HTTP/1.1 207 Multi-Status | |||
Content-Type: text/xml; charset=utf-8 | Content-Type: text/xml; charset=utf-8 | |||
Content-Length: xxxx | Content-Length: xxxx | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 52] | ||||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:multistatus xmlns:D="DAV:" xmlns:B="http://BigCorp.com/ns/"> | <D:multistatus xmlns:D="DAV:" xmlns:B="http://BigCorp.com/ns/"> | |||
<D:response> | <D:response> | |||
<D:href>http://www.BigCorp.com/users/jdoe</D:href> | <D:href>http://www.BigCorp.com/users/jdoe</D:href> | |||
<D:propstat> | <D:propstat> | |||
<D:prop> | <D:prop> | |||
<D:displayname>John Doe</D:displayname> | <D:displayname>John Doe</D:displayname> | |||
<B:department>Widget Sales</B:department> | <B:department>Widget Sales</B:department> | |||
<B:phone>234-4567</B:phone> | <B:phone>234-4567</B:phone> | |||
<B:office>209</B:office> | <B:office>209</B:office> | |||
skipping to change at line 2533 | skipping to change at line 2564 | |||
<B:department>Gadget Sales</B:department> | <B:department>Gadget Sales</B:department> | |||
<B:phone>234-7654</B:phone> | <B:phone>234-7654</B:phone> | |||
<B:office>114</B:office> | <B:office>114</B:office> | |||
</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> | |||
<D:prop> | <D:prop> | |||
<B:salary/> | <B:salary/> | |||
</D:prop> | </D:prop> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 52] | ||||
<D:status>HTTP/1.1 403 Forbidden</D:status> | <D:status>HTTP/1.1 403 Forbidden</D:status> | |||
</D:propstat> | </D:propstat> | |||
</D:response> | </D:response> | |||
</D:multistatus> | </D:multistatus> | |||
9.4.3 Example: Unsuccessful DAV:principal-property-search REPORT | 9.4.3 Example: Unsuccessful DAV:principal-property-search REPORT | |||
In this example, the client requests a search on the non-searchable | In this example, the client requests a search on the non-searchable | |||
property "phone" in the namespace "http://www.BigCorp.com/ns/". | property "phone" in the namespace "http://www.BigCorp.com/ns/". | |||
The response is a 403 (Forbidden), with a response body containing | The response is a 403 (Forbidden), with a response body containing | |||
a DAV:non-searchable-property XML element as the value of a | ||||
Clemm, Hopkins, Sedlar, Whitehead [Page 53] | ||||
a DAV:property-must-be-searchable XML element as the value of a | ||||
DAV:error XML element. | DAV:error XML element. | |||
>> Request << | >> Request << | |||
REPORT /users/ HTTP/1.1 | REPORT /users/ HTTP/1.1 | |||
Host: www.BigCorp.com | Host: www.BigCorp.com | |||
Content-Type: text/xml; charset=utf-8 | Content-Type: text/xml; charset=utf-8 | |||
Content-Length: xxxx | Content-Length: xxxx | |||
Depth: 0 | ||||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:principal-property-search xmlns:D="DAV:"> | <D:principal-property-search xmlns:D="DAV:"> | |||
<D:property-search> | <D:property-search> | |||
<D:prop xmlns:B="http://www.BigCorp.com/ns/"> | <D:prop xmlns:B="http://www.BigCorp.com/ns/"> | |||
<B:phone/> | <B:phone/> | |||
</D:prop> | </D:prop> | |||
<D:caseless-substring>232</D:caseless-substring> | <D:match>232</D:match> | |||
</D:property-search> | </D:property-search> | |||
</D:principal-property-search> | </D:principal-property-search> | |||
>> Response << | >> Response << | |||
HTTP/1.1 403 FORBIDDEN | HTTP/1.1 403 Forbidden | |||
Content-Type: text/xml; charset=utf-8 | Content-Type: text/xml; charset=utf-8 | |||
Content-Length: xxxx | Content-Length: xxxx | |||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:error xmlns:D="DAV:"> | <D:error xmlns:D="DAV:"> | |||
<D:non-searchable-property> | <D:property-must-be-searchable> | |||
<D:prop xmlns:B="http://www.BigCorp.com/ns/"> | <D:prop xmlns:B="http://www.BigCorp.com/ns/"> | |||
<B:phone/> | <B:phone/> | |||
</D:prop> | </D:prop> | |||
</D:non-searchable-property> | </D:property-must-be-searchable> | |||
</D:error> | </D:error> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 53] | ||||
9.5 DAV:principal-search-property-set REPORT | 9.5 DAV:principal-search-property-set REPORT | |||
The DAV:principal-search-property-set REPORT identifies those | The DAV:principal-search-property-set REPORT identifies those | |||
properties that may be searched using the DAV:principal-property- | properties that may be searched using the DAV:principal-property- | |||
search REPORT (defined in Section 9.4). | search REPORT (defined in Section 9.4). | |||
Servers MUST support the DAV:principal-search-property-set REPORT | Servers MUST support the DAV:principal-search-property-set REPORT | |||
on all principal collections identified in the value of a | on all collections identified in the value of a DAV:principal- | |||
DAV:principal-collection-set property. | collection-set property. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 54] | ||||
An access control protocol user agent could use the results of the | An access control protocol user agent could use the results of the | |||
DAV:principal-search-property-set REPORT to present a query | DAV:principal-search-property-set REPORT to present a query | |||
interface to the user for retrieving principals. | interface to the user for retrieving principals. | |||
Marshalling: | Support for this report is REQUIRED. | |||
Implementation Note: Some clients will have only limited screen | ||||
real estate for the display of lists of searchable properties. | ||||
In this case, a user might appreciate having the most frequently | ||||
searched properties be displayed on-screen, rather than having | ||||
to scroll through a long list of searchable properties. One | ||||
mechanism for signaling the most frequently searched properties | ||||
is to return them towards the start of a list of properties. A | ||||
client can then preferentially display the list of properties in | ||||
order, increasing the likelihood that the most frequently | ||||
searched properties will appear on-screen, and will not require | ||||
scrolling for their selection. | ||||
Marshalling: | ||||
The request body MUST be an empty DAV:principal-search-property-set | The request body MUST be an empty DAV:principal-search-property-set | |||
XML element. | XML element. | |||
This report is only defined when the Depth header has value "0"; | ||||
other values result in a 400 (Bad Request) error response. Note | ||||
that [RFC3253], Section 3.6, states that if the Depth header is not | ||||
present, it defaults to a value of "0". | ||||
The response body MUST bea DAV:principal-search-property-set XML | The response body MUST bea DAV:principal-search-property-set XML | |||
element, containing a DAV:principal-search-property XML element for | element, containing a DAV:principal-search-property XML element for | |||
each property that may be searched with the DAV:principal-property- | each property that may be searched with the DAV:principal-property- | |||
search REPORT. A server MAY limit its response to just a subset of | search REPORT. A server MAY limit its response to just a subset of | |||
the searchable properties, such as those likely to be useful to an | the searchable properties, such as those likely to be useful to an | |||
interactive access control client. | interactive access control client. | |||
<!ELEMENT principal-search-property-set (principal-search- | <!ELEMENT principal-search-property-set (principal-search- | |||
property*) > | property*) > | |||
Each DAV:principal-search-property XML element contains exactly one | Each DAV:principal-search-property XML element contains exactly one | |||
searchable property, and a description of the property. | searchable property, and a description of the property. | |||
<!ELEMENT principal-search-property (prop, description) > | <!ELEMENT principal-search-property (prop, description) > | |||
The DAV:prop element contains one principal property on which the | The DAV:prop element contains one principal property on which the | |||
server is able to perform a DAV:principal-property-search REPORT. | server is able to perform a DAV:principal-property-search REPORT. | |||
prop: see RFC 2518, Section 12.11 | prop: see RFC 2518, Section 12.11 | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 55] | ||||
The description element is a human-readable description of what | The description element is a human-readable description of what | |||
information this property represents. Servers MUST indicate the | information this property represents. Servers MUST indicate the | |||
human language of the description using the xml:lang attribute and | human language of the description using the xml:lang attribute and | |||
SHOULD consider the HTTP Accept-Language request header when | SHOULD consider the HTTP Accept-Language request header when | |||
selecting one of multiple available languages. | selecting one of multiple available languages. | |||
<!ELEMENT description #PCDATA > | <!ELEMENT description #PCDATA > | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 54] | ||||
9.5.1 Example: DAV:principal-search-property-set REPORT | 9.5.1 Example: DAV:principal-search-property-set REPORT | |||
In this example, the client determines the set of searchable | In this example, the client determines the set of searchable | |||
principal properties by requesting the DAV:principal-search- | principal properties by requesting the DAV:principal-search- | |||
property-set REPORT on the root of the server's principal URL | property-set REPORT on the root of the server's principal URL | |||
collection set, identified by http://www.BigCorp.com/users/. | collection set, identified by http://www.BigCorp.com/users/. | |||
>> Request << | >> Request << | |||
REPORT /users/ HTTP/1.1 | REPORT /users/ HTTP/1.1 | |||
Host: www.BigCorp.com | Host: www.BigCorp.com | |||
Content-Type: text/xml; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
Accept-Language: en, de | Accept-Language: en, de | |||
Authorization: BASIC d2FubmFtYWs6cGFzc3dvcmQ= | Authorization: BASIC d2FubmFtYWs6cGFzc3dvcmQ= | |||
Depth: 0 | ||||
<?xml version="1.0" encoding="utf-8" ?> | <?xml version="1.0" encoding="utf-8" ?> | |||
<D:principal-search-property-set xmlns:D="DAV:"/> | <D:principal-search-property-set xmlns:D="DAV:"/> | |||
>> Response << | >> Response << | |||
HTTP/1.1 200 OK | HTTP/1.1 200 OK | |||
Content-Type: text/xml; charset="utf-8" | Content-Type: text/xml; charset="utf-8" | |||
Content-Length: xxx | Content-Length: xxx | |||
skipping to change at line 2666 | skipping to change at line 2717 | |||
<D:principal-search-property> | <D:principal-search-property> | |||
<D:prop> | <D:prop> | |||
<D:displayname/> | <D:displayname/> | |||
</D:prop> | </D:prop> | |||
<D:description xml:lang="en">Full name</D:description> | <D:description xml:lang="en">Full name</D:description> | |||
</D:principal-search-property> | </D:principal-search-property> | |||
<D:principal-search-property> | <D:principal-search-property> | |||
<D:prop xmlns:B="http://BigCorp.com/ns/"> | <D:prop xmlns:B="http://BigCorp.com/ns/"> | |||
<B:title/> | <B:title/> | |||
</D:prop> | </D:prop> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 56] | ||||
<D:description xml:lang="en">Job title</D:description> | <D:description xml:lang="en">Job title</D:description> | |||
</D:principal-search-property> | </D:principal-search-property> | |||
</D:principal-search-property-set> | </D:principal-search-property-set> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 55] | ||||
10 XML PROCESSING | 10 XML PROCESSING | |||
Implementations of this specification MUST support the XML element | Implementations of this specification MUST support the XML element | |||
ignore rule, as specified in Section 23.3.2 of [RFC2518], and the | ignore rule, as specified in Section 23.3.2 of [RFC2518], and the | |||
XML Namespacerecommendation [REC-XML-NAMES]. | XML Namespacerecommendation [REC-XML-NAMES]. | |||
Note that use of the DAV namespace is reserved for XML elements and | Note that use of the DAV namespace is reserved for XML elements and | |||
property names defined in a standards-track or Experimental IETF | property names defined in a standards-track or Experimental IETF | |||
RFC. | RFC. | |||
skipping to change at line 2714 | skipping to change at line 2766 | |||
return. | return. | |||
For XML elements other than the description element, it is expected | For XML elements other than the description element, it is expected | |||
that implementations will treat the property names, privilege | that implementations will treat the property names, privilege | |||
names, and values as tokens, and convert these tokens into human- | names, and values as tokens, and convert these tokens into human- | |||
readable text in the user's language and character set when | readable text in the user's language and character set when | |||
displayed to a person. Only a generic WebDAV property display | displayed to a person. Only a generic WebDAV property display | |||
utility would display these values in their raw form to a human | utility would display these values in their raw form to a human | |||
user. | user. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 57] | ||||
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., 200 (OK)). While the possibility exists that a | of the code (e.g., 200 (OK)). While the possibility exists that a | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 56] | ||||
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 | internationalized applications will ignore this message, and | |||
display an appropriate message in the user's language and character | display an appropriate message in the user's language and character | |||
set. | set. | |||
Further internationalization considerations for this protocol are | Further internationalization considerations for this protocol are | |||
described in the WebDAV Distributed Authoring protocol | described in the WebDAV Distributed Authoring protocol | |||
specification [RFC2518]. | specification [RFC2518]. | |||
12 SECURITY CONSIDERATIONS | 12 SECURITY CONSIDERATIONS | |||
skipping to change at line 2764 | skipping to change at line 2815 | |||
The ability to read the access privileges (stored in the DAV:acl | The ability to read the access privileges (stored in the DAV:acl | |||
property), or the privileges permitted the currently authenticated | property), or the privileges permitted the currently authenticated | |||
user (stored in the DAV:current-user-privilege-set property) on a | user (stored in the DAV:current-user-privilege-set property) on a | |||
resource may seem innocuous, since reading an ACL cannot possibly | resource may seem innocuous, since reading an ACL cannot possibly | |||
affect the resource's state. However, if all resources have world- | affect the resource's state. However, if all resources have world- | |||
readable ACLs, it is possible to perform an exhaustive search for | readable ACLs, it is possible to perform an exhaustive search for | |||
those resources that have inadvertently left themselves in a | those resources that have inadvertently left themselves in a | |||
vulnerable state, such as being world-writeable. In particular, the | vulnerable state, such as being world-writeable. In particular, the | |||
property retrieval method PROPFIND, executed with Depth infinity on | property retrieval method PROPFIND, executed with Depth infinity on | |||
an entire hierarchy, is a very efficient way to retrieve the | an entire hierarchy, is a very efficient way to retrieve the | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 58] | ||||
DAV:acl or DAV:current-user-privilege-set properties. Once found, | DAV:acl or DAV:current-user-privilege-set properties. Once found, | |||
this vulnerability can be exploited by a denial of service attack | this vulnerability can be exploited by a denial of service attack | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 57] | ||||
in which the open resource is repeatedly overwritten. Alternately, | in which the open resource is repeatedly overwritten. Alternately, | |||
writeable resources can be modified in undesirable ways. | writeable resources can be modified in undesirable ways. | |||
To reduce this risk, read-acl privileges should not be granted to | To reduce this risk, read-acl privileges should not be granted to | |||
unauthenticated principals, and restrictions on read-acl and read- | unauthenticated principals, and restrictions on read-acl and read- | |||
current-user-privilege-set privileges for authenticated principals | current-user-privilege-set privileges for authenticated principals | |||
should be carefully analyzed when deploying this protocol. Access | should be carefully analyzed when deploying this protocol. Access | |||
to the current-user-privilege-set property will involve a tradeoff | to the current-user-privilege-set property will involve a tradeoff | |||
of usability versus security. When the current-user-privilege-set | of usability versus security. When the current-user-privilege-set | |||
is visible, user interfaces are expected to provide enhanced | is visible, user interfaces are expected to provide enhanced | |||
skipping to change at line 2810 | skipping to change at line 2861 | |||
exists with the initial ACL before its new ACL can be set. | exists with the initial ACL before its new ACL can be set. | |||
Several factors mitigate this risk. Human principals are often | Several factors mitigate this risk. Human principals are often | |||
aware of the default access permissions in their editing | aware of the default access permissions in their editing | |||
environments and take this into account when writing information. | environments and take this into account when writing information. | |||
Furthermore, default privilege policies are usually very | Furthermore, default privilege policies are usually very | |||
conservative, limiting the privileges granted by the initial ACL. | conservative, limiting the privileges granted by the initial ACL. | |||
13 AUTHENTICATION | 13 AUTHENTICATION | |||
Authentication mechanisms defined for use with HTTP and WebDAV | Authentication mechanisms defined for use with HTTP and WebDAV also | |||
also apply to this WebDAV Access Control Protocol, in particular | apply to this WebDAV Access Control Protocol, in particular the | |||
the Basic and Digest authentication mechanisms defined in | Basic and Digest authentication mechanisms defined in [RFC2617]. | |||
[RFC2617]. | ||||
Clemm, Hopkins, Sedlar, Whitehead [Page 58] | Clemm, Hopkins, Sedlar, Whitehead [Page 59] | |||
14 IANA CONSIDERATIONS | 14 IANA CONSIDERATIONS | |||
This document uses the namespace defined by [RFC2518] for XML | This document uses the namespace defined by [RFC2518] for XML | |||
elements. All other IANA considerations mentioned in [RFC2518] | elements. All other IANA considerations mentioned in [RFC2518] also | |||
also applicable to WebDAV ACL. | applicable to this specification. | |||
15 INTELLECTUAL PROPERTY | 15 INTELLECTUAL PROPERTY | |||
The following notice is copied from RFC 2026, section 10.4, and | The following notice is copied from RFC 2026, section 10.4, and | |||
describes the position of the IETF concerning intellectual property | describes the position of the IETF concerning intellectual property | |||
claims made against this document. | 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 | |||
skipping to change at line 2854 | skipping to change at line 2904 | |||
rights that may cover technology that may be required to practice | rights that may cover technology that may be required to practice | |||
this standard. Please address the information to the IETF | this standard. Please address the information to the IETF | |||
Executive Director. | Executive Director. | |||
16 ACKNOWLEDGEMENTS | 16 ACKNOWLEDGEMENTS | |||
This protocol is the collaborative product of the WebDAV ACL design | This protocol is the collaborative product of the WebDAV ACL design | |||
team: Bernard Chester, Geoff Clemm, Anne Hopkins, Barry Lind, Sean | team: Bernard Chester, Geoff Clemm, Anne Hopkins, Barry Lind, Sean | |||
Lyndersay, Eric Sedlar, Greg Stein, and Jim Whitehead. The authors | Lyndersay, Eric Sedlar, Greg Stein, and Jim Whitehead. The authors | |||
are grateful for the detailed review and comments provided by Jim | are grateful for the detailed review and comments provided by Jim | |||
Amsden, Gino Basso, Murthy Chintalapati, Dennis Hamilton, Laurie | Amsden, Dylan Barrell, Gino Basso, Murthy Chintalapati, Lisa | |||
Harper, Ron Jacobs, Chris Knight, Remy Maucherat, Larry Masinter, | Dusseault, Stefan Eissing, Tim Ellison, Yaron Goland, Dennis | |||
Yaron Goland, Lisa Dusseault, Joe Orton, Stefan Eissing, Julian | Hamilton, Laurie Harper, Eckehard Hermann, Ron Jacobs, Chris | |||
Reschke, Keith Wannamaker, Tim Ellison, Peter Raymond, and Dylan | Knight, Remy Maucherat, Larry Masinter, Joe Orton, Peter Raymond, | |||
Barrell. We thank Keith Wannamaker for the initial text of the | Julian Reschke, and Keith Wannamaker. We thank Keith Wannamaker for | |||
principal property search sections. Prior work on WebDAV access | the initial text of the principal property search sections. Prior | |||
control protocols has been performed by Yaron Goland, Paul Leach, | work on WebDAV access control protocols has been performed by Yaron | |||
Lisa Dusseault, Howard Palmer, and Jon Radoff. We would like to | Goland, Paul Leach, Lisa Dusseault, Howard Palmer, and Jon Radoff. | |||
acknowledge the foundation laid for us by the authors of the | We would like to acknowledge the foundation laid for us by the | |||
authors of the DeltaV, WebDAV and HTTP protocols upon which this | ||||
Clemm, Hopkins, Sedlar, Whitehead [Page 59] | Clemm, Hopkins, Sedlar, Whitehead [Page 60] | |||
DeltaV, WebDAV and HTTP protocols upon which this protocol is | protocol is layered, and the invaluable feedback from the WebDAV | |||
layered, and the invaluable feedback from the WebDAV working group. | working group. | |||
17 REFERENCES | 17 REFERENCES | |||
17.1 Normative References | 17.1 Normative References | |||
[RFC2119] 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, March, 1997. | Requirement Levels." RFC 2119, BCP 14, March, 1997. | |||
[REC-XML] T. Bray, J. Paoli, C.M. Sperberg-McQueen, "Extensible | [REC-XML] T. Bray, J. Paoli, C.M. Sperberg-McQueen, "Extensible | |||
Markup Language (XML)." World Wide Web Consortium Recommendation | Markup Language (XML)." World Wide Web Consortium Recommendation | |||
skipping to change at line 2911 | skipping to change at line 2962 | |||
[RFC2368] P. Hoffman, L. Masinter, J. Zawinski, "The mailto URL | [RFC2368] P. Hoffman, L. Masinter, J. Zawinski, "The mailto URL | |||
scheme." RFC 2368, July, 1998. | scheme." RFC 2368, July, 1998. | |||
[RFC3023] M. Murata, S. St.Laurent, D. Kohn, "XML Media Types." RFC | [RFC3023] M. Murata, S. St.Laurent, D. Kohn, "XML Media Types." RFC | |||
3023, January, 2001. | 3023, January, 2001. | |||
[UTF-8] F. Yergeau, "UTF-8, a transformation format of Unicode and | [UTF-8] F. Yergeau, "UTF-8, a transformation format of Unicode and | |||
ISO 10646." RFC 2279, January, 1998. | ISO 10646." RFC 2279, January, 1998. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 60] | ||||
17.2 Informational References | 17.2 Informational References | |||
[RFC2026] S.Bradner, "The Internet Standards Process - Revision 3." | [RFC2026] S.Bradner, "The Internet Standards Process - Revision 3." | |||
RFC 2026, BCP 9. Harvard, October, 1996. | RFC 2026, BCP 9. Harvard, October, 1996. | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 61] | ||||
[RFC2255] T. Howes, M. Smith, "The LDAP URL Format." RFC 2255. | [RFC2255] T. Howes, M. Smith, "The LDAP URL Format." RFC 2255. | |||
Netscape, December, 1997. | Netscape, December, 1997. | |||
[RFC2251] M. Wahl, T. Howes, S. Kille, "Lightweight Directory | [RFC2251] M. Wahl, T. Howes, S. Kille, "Lightweight Directory | |||
Access Protocol (v3)." RFC 2251. Critical Angle, Netscape, Isode, | Access Protocol (v3)." RFC 2251. Critical Angle, Netscape, Isode, | |||
December, 1997. | December, 1997. | |||
[CaseMap] M. Davis, "Case Mappings", Unicode Standard Annex #21, | [CaseMap] M. Davis, "Case Mappings", Unicode Standard Annex #21, | |||
March 26, 2001. http://www.unicode.org/unicode/reports/tr21 | March 26, 2001. http://www.unicode.org/unicode/reports/tr21 | |||
skipping to change at line 2955 | skipping to change at line 3006 | |||
Email: esedlar@us.oracle.com | Email: esedlar@us.oracle.com | |||
Jim Whitehead | Jim Whitehead | |||
U.C. Santa Cruz | U.C. Santa Cruz | |||
Dept. of Computer Science | Dept. of Computer Science | |||
Baskin Engineering | Baskin Engineering | |||
1156 High Street | 1156 High Street | |||
Santa Cruz, CA 95064 | Santa Cruz, CA 95064 | |||
Email: ejw@cse.ucsc.edu | Email: ejw@cse.ucsc.edu | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 61] | Clemm, Hopkins, Sedlar, Whitehead [Page 62] | |||
19 APPENDICES | 19 APPENDICES | |||
19.1 WebDAV XML Document Type Definition Addendum | 19.1 WebDAV XML Document Type Definition Addendum | |||
All XML elements defined in this Document Type Definition (DTD) | All XML elements defined in this Document Type Definition (DTD) | |||
belong to the DAV namespace. This DTD should be viewed as an | belong to the DAV namespace. This DTD should be viewed as an | |||
addendum to the DTD provided in [RFC2518], section 23.1. | addendum to the DTD provided in [RFC2518], section 23.1. | |||
<!-- Privileges --> | <!-- Privileges --> | |||
skipping to change at line 2982 | skipping to change at line 3033 | |||
<!ELEMENT read-current-user-privilege-set EMPTY> | <!ELEMENT read-current-user-privilege-set EMPTY> | |||
<!ELEMENT write-acl EMPTY> | <!ELEMENT write-acl EMPTY> | |||
<!ELEMENT all EMPTY> | <!ELEMENT all EMPTY> | |||
<!-- Principal Properties (Section 4) --> | <!-- Principal Properties (Section 4) --> | |||
<!ELEMENT principal EMPTY> | <!ELEMENT principal EMPTY> | |||
<!ELEMENT alternate-URI-set (href*)> | <!ELEMENT alternate-URI-set (href*)> | |||
<!ELEMENT principal-URL (href)> | <!ELEMENT principal-URL (href)> | |||
<!ELEMENT group-member-set (href*)> | ||||
<!ELEMENT group-membership (href*)> | <!ELEMENT group-membership (href*)> | |||
<!-- Access Control Properties (Section 5) --> | <!-- Access Control Properties (Section 5) --> | |||
<!-- DAV:owner Property (Section 5.1) --> | <!-- DAV:owner Property (Section 5.1) --> | |||
<!ELEMENT owner (href prop?)> | <!ELEMENT owner (href prop?)> | |||
<!ELEMENT prop (see [RFC2518], section 12.11)> | <!ELEMENT prop (see [RFC2518], section 12.11)> | |||
<!-- DAV:supported-privilege-set Property (Section 5.2) --> | <!-- DAV:supported-privilege-set Property (Section 5.2) --> | |||
<!ELEMENT supported-privilege-set (supported-privilege*)> | <!ELEMENT supported-privilege-set (supported-privilege*)> | |||
<!ELEMENT supported-privilege | <!ELEMENT supported-privilege | |||
(privilege, abstract?, description, supported-privilege*)> | (privilege, abstract?, description, supported-privilege*)> | |||
<!ELEMENT privilege ANY> | <!ELEMENT privilege ANY> | |||
<!ELEMENT abstract EMPTY> | <!ELEMENT abstract EMPTY> | |||
<!ELEMENT description #PCDATA> | <!ELEMENT description #PCDATA> | |||
<!ELEMENT privilege ANY> | <!ELEMENT privilege ANY> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 62] | Clemm, Hopkins, Sedlar, Whitehead [Page 63] | |||
<!-- DAV:current-user-privilege-set Property (Section 5.3) --> | <!-- DAV:current-user-privilege-set Property (Section 5.3) --> | |||
<!ELEMENT current-user-privilege-set (privilege*)> | <!ELEMENT current-user-privilege-set (privilege*)> | |||
<!-- DAV:acl Property (Section 5.4) --> | <!-- DAV:acl Property (Section 5.4) --> | |||
<!ELEMENT acl (ace | inherited-acl)* > | <!ELEMENT acl (ace)* > | |||
<!ELEMENT inherited-acl (href)> | ||||
<!ELEMENT ace (invert | principal, (grant|deny), protected?, | <!ELEMENT ace (invert | principal, (grant|deny), protected?, | |||
inherited?)> | inherited?)> | |||
<!ELEMENT invert principal> | <!ELEMENT invert principal> | |||
<!ELEMENT inherited-acl (href)> | ||||
<!ELEMENT principal ((href, prop?) | <!ELEMENT principal ((href, prop?) | |||
| all | authenticated | unauthenticated | | all | authenticated | unauthenticated | |||
| property | self)> | | property | self)> | |||
<!ELEMENT prop (see [RFC2518], section 12.11)> | <!ELEMENT prop (see [RFC2518], section 12.11)> | |||
<!ELEMENT all EMPTY> | <!ELEMENT all EMPTY> | |||
<!ELEMENT authenticated EMPTY> | <!ELEMENT authenticated EMPTY> | |||
<!ELEMENT unauthenticated EMPTY> | <!ELEMENT unauthenticated EMPTY> | |||
<!ELEMENT property ANY> | <!ELEMENT property ANY> | |||
<!ELEMENT self EMPTY> | <!ELEMENT self EMPTY> | |||
<!ELEMENT grant (privilege+)> | <!ELEMENT grant (privilege+)> | |||
<!ELEMENT deny (privilege+)> | <!ELEMENT deny (privilege+)> | |||
<!ELEMENT privilege ANY> | <!ELEMENT privilege ANY> | |||
<!ELEMENT protected EMPTY> | <!ELEMENT protected EMPTY> | |||
<!ELEMENT inherited (href)> | <!ELEMENT inherited (href)> | |||
<!-- DAV:principal-collection-set Property (Section 5.7) --> | <!-- DAV:inherited-acl-set Property (Section 5.6) --> | |||
<!ELEMENT inherited-acl-set (href*)> | ||||
<!-- DAV:principal-collection-set Property (Section 5.6) --> | ||||
<!ELEMENT principal-collection-set (href*)> | <!ELEMENT principal-collection-set (href*)> | |||
<!-- DAV:acl-semantics Property (Section 6) --> | <!-- DAV:acl-semantics Property (Section 6) --> | |||
<!ELEMENT acl-semantics (ace-combination?, ace-ordering?, | <!ELEMENT acl-semantics (ace-combination?, ace-ordering?, allowed- | |||
allowed-ace?, required-principal?)> | ace?, required-principal?)> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 64] | ||||
<!ELEMENT ace-combination | <!ELEMENT ace-combination | |||
(first-match | all-grant-before-any-deny | specific-deny- | (first-match | all-grant-before-any-deny | specific-deny- | |||
overrides-grant)> | overrides-grant)> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 63] | ||||
<!ELEMENT first-match EMPTY> | <!ELEMENT first-match EMPTY> | |||
<!ELEMENT all-grant-before-any-deny EMPTY> | <!ELEMENT all-grant-before-any-deny EMPTY> | |||
<!ELEMENT specific-deny-overrides-grant EMPTY> | <!ELEMENT specific-deny-overrides-grant EMPTY> | |||
<!ELEMENT ace-ordering (deny-before-grant)? > | <!ELEMENT ace-ordering (deny-before-grant)? > | |||
<!ELEMENT deny-before-grant EMPTY> | <!ELEMENT deny-before-grant EMPTY> | |||
<!ELEMENT allowed-ace (principal-only-one-ace | grant-only | | <!ELEMENT allowed-ace (principal-only-one-ace | grant-only | | |||
no-invert | no-acl-inherit)*> | no-invert | no-acl-inherit)*> | |||
<!ELEMENT principal-only-one-ace EMPTY> | <!ELEMENT principal-only-one-ace EMPTY> | |||
skipping to change at line 3088 | skipping to change at line 3141 | |||
<!-- REPORTs (Section 9) --> | <!-- REPORTs (Section 9) --> | |||
<!ELEMENT acl-principal-prop-set ANY> | <!ELEMENT acl-principal-prop-set ANY> | |||
ANY value: a sequence of one or more elements, with at most one | ANY value: a sequence of one or more elements, with at most one | |||
DAV:prop element. | DAV:prop element. | |||
<!ELEMENT principal-match ((principal-property | self), prop?)> | <!ELEMENT principal-match ((principal-property | self), prop?)> | |||
<!ELEMENT principal-property ANY> | <!ELEMENT principal-property ANY> | |||
ANY value: an element whose value identifies a property. The | ANY value: an element whose value identifies a property. The | |||
expectation is the value of the named property typically | expectation is the value of the named property typically contains | |||
contains an href element that contains the URI of a principal | an href element that contains the URI of a principal | |||
<!ELEMENT self EMPTY> | ||||
<!ELEMENT principal-property-search ((property-search+), prop?) | Clemm, Hopkins, Sedlar, Whitehead [Page 65] | |||
> | <!ELEMENT self EMPTY> | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 64] | <!ELEMENT principal-property-search ((property-search+), prop?) > | |||
<!ELEMENT property-search (prop, substring, caseless?) > | <!ELEMENT property-search (prop, match) > | |||
<!ELEMENT substring #PCDATA > | <!ELEMENT match #PCDATA > | |||
<!ELEMENT caseless EMPTY> | ||||
<!ELEMENT non-searchable-property (prop) > | ||||
<!ELEMENT principal-search-property-set (principal-search- | <!ELEMENT principal-search-property-set (principal-search- | |||
property*) > | property*) > | |||
<!ELEMENT principal-search-property (prop, description) > | <!ELEMENT principal-search-property (prop, description) > | |||
Clemm, Hopkins, Sedlar, Whitehead [Page 65] | Clemm, Hopkins, Sedlar, Whitehead [Page 66] | |||
End of changes. | ||||
This html diff was produced by rfcdiff 1.23, available from http://www.levkowetz.com/ietf/tools/rfcdiff/ |