idnits 2.17.1
draft-ietf-vcarddav-carddav-10.txt:
Checking boilerplate required by RFC 5378 and the IETF Trust (see
https://trustee.ietf.org/license-info):
----------------------------------------------------------------------------
** The document seems to lack a License Notice according IETF Trust
Provisions of 28 Dec 2009, Section 6.b.i or Provisions of 12 Sep 2009
Section 6.b -- however, there's a paragraph with a matching beginning.
Boilerplate error?
(You're using the IETF Trust Provisions' Section 6.b License Notice from
12 Feb 2009 rather than one of the newer Notices. See
https://trustee.ietf.org/license-info/.)
Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt:
----------------------------------------------------------------------------
No issues found here.
Checking nits according to https://www.ietf.org/id-info/checklist :
----------------------------------------------------------------------------
No issues found here.
Miscellaneous warnings:
----------------------------------------------------------------------------
== The copyright year in the IETF Trust and authors Copyright Line does not
match the current year
-- The document seems to contain a disclaimer for pre-RFC5378 work, and may
have content which was first submitted before 10 November 2008. The
disclaimer is necessary when there are original authors that you have
been unable to contact, or if some do not wish to grant the BCP78 rights
to the IETF Trust. If you are able to get all authors (current and
original) to grant those rights, you can and should remove the
disclaimer; otherwise, the disclaimer is needed and you can ignore this
comment. (See the Legal Provisions document at
https://trustee.ietf.org/license-info for more information.)
-- The document date (November 9, 2009) is 5282 days in the past. Is this
intentional?
Checking references for intended status: Proposed Standard
----------------------------------------------------------------------------
(See RFCs 3967 and 4897 for information about using normative references
to lower-maturity documents in RFCs)
== Outdated reference: A later version (-22) exists of
draft-ietf-vcarddav-vcardrev-08
** Obsolete normative reference: RFC 2426 (Obsoleted by RFC 6350)
** Obsolete normative reference: RFC 2616 (Obsoleted by RFC 7230, RFC 7231,
RFC 7232, RFC 7233, RFC 7234, RFC 7235)
** Obsolete normative reference: RFC 2617 (Obsoleted by RFC 7235, RFC 7615,
RFC 7616, RFC 7617)
** Obsolete normative reference: RFC 2818 (Obsoleted by RFC 9110)
** Obsolete normative reference: RFC 5246 (Obsoleted by RFC 8446)
Summary: 6 errors (**), 0 flaws (~~), 2 warnings (==), 2 comments (--).
Run idnits with the --verbose option for more detailed information about
the items above.
--------------------------------------------------------------------------------
2 Network Working Group C. Daboo
3 Internet-Draft Apple
4 Intended status: Standards Track November 9, 2009
5 Expires: May 13, 2010
7 vCard Extensions to WebDAV (CardDAV)
8 draft-ietf-vcarddav-carddav-10
10 Status of this Memo
12 This Internet-Draft is submitted to IETF in full conformance with the
13 provisions of BCP 78 and BCP 79. This document may contain material
14 from IETF Documents or IETF Contributions published or made publicly
15 available before November 10, 2008. The person(s) controlling the
16 copyright in some of this material may not have granted the IETF
17 Trust the right to allow modifications of such material outside the
18 IETF Standards Process. Without obtaining an adequate license from
19 the person(s) controlling the copyright in such materials, this
20 document may not be modified outside the IETF Standards Process, and
21 derivative works of it may not be created outside the IETF Standards
22 Process, except to format it for publication as an RFC or to
23 translate it into languages other than English.
25 Internet-Drafts are working documents of the Internet Engineering
26 Task Force (IETF), its areas, and its working groups. Note that
27 other groups may also distribute working documents as Internet-
28 Drafts.
30 Internet-Drafts are draft documents valid for a maximum of six months
31 and may be updated, replaced, or obsoleted by other documents at any
32 time. It is inappropriate to use Internet-Drafts as reference
33 material or to cite them other than as "work in progress."
35 The list of current Internet-Drafts can be accessed at
36 http://www.ietf.org/ietf/1id-abstracts.txt.
38 The list of Internet-Draft Shadow Directories can be accessed at
39 http://www.ietf.org/shadow.html.
41 This Internet-Draft will expire on May 13, 2010.
43 Copyright Notice
45 Copyright (c) 2009 IETF Trust and the persons identified as the
46 document authors. All rights reserved.
48 This document is subject to BCP 78 and the IETF Trust's Legal
49 Provisions Relating to IETF Documents in effect on the date of
50 publication of this document (http://trustee.ietf.org/license-info).
51 Please review these documents carefully, as they describe your rights
52 and restrictions with respect to this document.
54 Abstract
56 This document defines extensions to the Web Distributed Authoring and
57 Versioning (WebDAV) protocol to specify a standard way of accessing,
58 managing, and sharing contact information based on the vCard format.
60 Table of Contents
62 1. Introduction and Overview . . . . . . . . . . . . . . . . . . 4
63 2. Conventions . . . . . . . . . . . . . . . . . . . . . . . . . 5
64 3. Requirements Overview . . . . . . . . . . . . . . . . . . . . 6
65 4. Address Book Data Model . . . . . . . . . . . . . . . . . . . 7
66 4.1. Address Book Server . . . . . . . . . . . . . . . . . . . 7
67 5. Address Book Resources . . . . . . . . . . . . . . . . . . . . 7
68 5.1. Address Object Resources . . . . . . . . . . . . . . . . . 8
69 5.1.1. Data Type Conversion . . . . . . . . . . . . . . . . . 8
70 5.1.1.1. Additional Precondition for GET . . . . . . . . . 9
71 5.2. Address Book Collections . . . . . . . . . . . . . . . . . 9
72 6. Address Book Feature . . . . . . . . . . . . . . . . . . . . . 10
73 6.1. Address Book Support . . . . . . . . . . . . . . . . . . . 10
74 6.1.1. Example: Using OPTIONS for the Discovery of
75 Support for CardDAV . . . . . . . . . . . . . . . . . 10
76 6.2. Address Book Properties . . . . . . . . . . . . . . . . . 10
77 6.2.1. CARDDAV:addressbook-description Property . . . . . . . 11
78 6.2.2. CARDDAV:supported-address-data Property . . . . . . . 11
79 6.2.3. CARDDAV:max-resource-size Property . . . . . . . . . . 12
80 6.3. Creating Resources . . . . . . . . . . . . . . . . . . . . 13
81 6.3.1. Extended MKCOL Method . . . . . . . . . . . . . . . . 13
82 6.3.1.1. Example - Successful MKCOL request . . . . . . . . 14
83 6.3.2. Creating Address Object Resources . . . . . . . . . . 16
84 6.3.2.1. Additional Preconditions for PUT, COPY and MOVE . 17
85 6.3.2.2. Non-Standard vCard Properties, and Parameters . . 18
86 6.3.2.3. Address Object Resource Entity Tag . . . . . . . . 18
87 7. Address Book Access Control . . . . . . . . . . . . . . . . . 19
88 7.1. Additional Principal Properties . . . . . . . . . . . . . 19
89 7.1.1. CARDDAV:addressbook-home-set Property . . . . . . . . 19
90 7.1.2. CARDDAV:principal-address Property . . . . . . . . . . 20
91 8. Address Book Reports . . . . . . . . . . . . . . . . . . . . . 21
92 8.1. REPORT Method . . . . . . . . . . . . . . . . . . . . . . 21
93 8.2. Ordinary Collections . . . . . . . . . . . . . . . . . . . 21
94 8.3. Searching Text: Collations . . . . . . . . . . . . . . . . 21
95 8.3.1. CARDDAV:supported-collation-set Property . . . . . . . 22
97 8.4. Partial Retrieval . . . . . . . . . . . . . . . . . . . . 23
98 8.5. Non-standard Properties and Parameters . . . . . . . . . . 23
99 8.6. CARDDAV:addressbook-query Report . . . . . . . . . . . . . 24
100 8.6.1. Limiting Results . . . . . . . . . . . . . . . . . . . 25
101 8.6.2. Truncation of Results . . . . . . . . . . . . . . . . 26
102 8.6.3. Example: Partial Retrieval of vCards Matching
103 NICKNAME . . . . . . . . . . . . . . . . . . . . . . . 26
104 8.6.4. Example: Partial Retrieval of vCards Matching a
105 Full Name or Email Address . . . . . . . . . . . . . . 28
106 8.6.5. Example: Truncated Results . . . . . . . . . . . . . . 31
107 8.7. CARDDAV:addressbook-multiget Report . . . . . . . . . . . 32
108 8.7.1. Example: CARDDAV:addressbook-multiget Report . . . . . 34
109 8.7.2. Example: CARDDAV:addressbook-multiget Report . . . . . 35
110 9. Client Guidelines . . . . . . . . . . . . . . . . . . . . . . 36
111 9.1. Restrict the Properties Returned . . . . . . . . . . . . . 36
112 9.2. Avoiding Lost Updates . . . . . . . . . . . . . . . . . . 37
113 9.3. Client Configuration . . . . . . . . . . . . . . . . . . . 37
114 9.4. Finding Other Users' Address Books . . . . . . . . . . . . 37
115 10. XML Element Definitions . . . . . . . . . . . . . . . . . . . 38
116 10.1. CARDDAV:addressbook XML Element . . . . . . . . . . . . . 38
117 10.2. CARDDAV:supported-collation XML Element . . . . . . . . . 38
118 10.3. CARDDAV:addressbook-query XML Element . . . . . . . . . . 39
119 10.4. CARDDAV:address-data XML Element . . . . . . . . . . . . . 39
120 10.4.1. CARDDAV:allprop XML Element . . . . . . . . . . . . . 41
121 10.4.2. CARDDAV:prop XML Element . . . . . . . . . . . . . . . 41
122 10.5. CARDDAV:filter XML Element . . . . . . . . . . . . . . . . 42
123 10.5.1. CARDDAV:prop-filter XML Element . . . . . . . . . . . 43
124 10.5.2. CARDDAV:param-filter XML Element . . . . . . . . . . . 44
125 10.5.3. CARDDAV:is-not-defined XML Element . . . . . . . . . . 45
126 10.5.4. CARDDAV:text-match XML Element . . . . . . . . . . . . 45
127 10.6. CARDDAV:limit XML Element . . . . . . . . . . . . . . . . 46
128 10.6.1. CARDDAV:nresults XML Element . . . . . . . . . . . . . 46
129 10.7. CARDDAV:addressbook-multiget XML Element . . . . . . . . . 47
130 11. Service Discovery via SRV Records . . . . . . . . . . . . . . 47
131 12. Internationalization Considerations . . . . . . . . . . . . . 48
132 13. Security Considerations . . . . . . . . . . . . . . . . . . . 48
133 14. IANA Consideration . . . . . . . . . . . . . . . . . . . . . . 49
134 14.1. Namespace Registration . . . . . . . . . . . . . . . . . . 49
135 15. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 49
136 16. References . . . . . . . . . . . . . . . . . . . . . . . . . . 49
137 16.1. Normative References . . . . . . . . . . . . . . . . . . . 49
138 16.2. Informative References . . . . . . . . . . . . . . . . . . 51
139 Appendix A. Change History (to be removed prior to
140 publication as an RFC) . . . . . . . . . . . . . . . 51
141 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 56
143 1. Introduction and Overview
145 Address books containing contact information are a key component of
146 personal information management tools, such as email, calendaring and
147 scheduling, and instant messaging clients. To date several protocols
148 have been used for remote access to contact data, including
149 Lightweight Directory Access Protocol (LDAP) [RFC4510], Internet
150 Message Support Protocol (IMSP) [IMSP] and Application Configuration
151 Access Protocol (ACAP) [RFC2244], together with SyncML used for
152 synchronization of such data.
154 WebDAV [RFC4918] offers a number of advantages as a framework or
155 basis for address book access and management. Most of these
156 advantages boil down to a significant reduction in design costs,
157 implementation costs, interoperability test costs and deployment
158 costs.
160 The key features of address book support with WebDAV are:
162 1. Ability to use multiple address books with hierarchical layout.
164 2. Ability to control access to individual address books and address
165 entries as per WebDAV ACL [RFC3744].
167 3. Principal collections can be used to enumerate and query other
168 users on the system as per WebDAV ACL [RFC3744].
170 4. Server-side searching of address data, avoiding the need for
171 clients to download an entire address book in order to do a quick
172 address 'expansion' operation.
174 5. Well-defined internationalization support through WebDAV's use of
175 XML.
177 6. Use of vCards [RFC2426] for well defined address schema to
178 enhance client interoperability.
180 7. Many limited clients (e.g. mobile devices) contain an HTTP stack
181 which makes implementing WebDAV much easier than other protocols.
183 The key disadvantages of address book support in WebDAV are:
185 1. Lack of change notification. Many of the alternative protocols
186 also lack this ability. However, an extension for push
187 notifications could easily be developed.
189 vCard is a MIME directory profile aimed at encapsulating personal
190 addressing and contact information about people. The specification
191 of vCard was originally done by the Versit consortium, with a
192 subsequent 3.0 version standardized by the IETF [RFC2426]. vCard is
193 in wide spread use in email clients and mobile devices as a means of
194 encapsulating address information for transport via email, or for
195 import/export and synchronization operations.
197 An update to vCard - vCard v4 - is currently being developed
198 [I-D.ietf-vcarddav-vcardrev]and is compatible with this
199 specification.
201 2. Conventions
203 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
204 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
205 document are to be interpreted as described in [RFC2119].
207 The term "protected" is used in the Conformance field of property
208 definitions as defined in Section 15 of [RFC4918].
210 This document uses XML DTD fragments ([W3C.REC-xml-20081126], Section
211 3.2) as a purely notational convention. WebDAV request and response
212 bodies cannot be validated by a DTD due to the specific extensibility
213 rules defined in Section 17 of [RFC4918] and due to the fact that all
214 XML elements defined by this specification use the XML namespace name
215 "DAV:". In particular:
217 1. element names use the "DAV:" namespace,
219 2. element ordering is irrelevant unless explicitly stated,
221 3. extension elements (elements not already defined as valid child
222 elements) may be added anywhere, except when explicitly stated
223 otherwise,
225 4. extension attributes (attributes not already defined as valid for
226 this element) may be added anywhere, except when explicitly
227 stated otherwise.
229 The namespace "urn:ietf:params:xml:ns:carddav" is reserved for the
230 XML elements defined in this specification, its revisions, and
231 related CardDAV specifications. XML elements defined by individual
232 implementations MUST NOT use the "urn:ietf:params:xml:ns:carddav"
233 namespace, and instead should use a namespace that they control.
235 When XML element types in the namespaces "DAV:" and
236 "urn:ietf:params:xml:ns:carddav" are referenced in this document
237 outside of the context of an XML fragment, the strings "DAV:" and
238 "CARDDAV:" will be prefixed to the element types, respectively.
240 This document inherits, and sometimes extends, DTD productions from
241 Section 14 of [RFC4918].
243 Also note that some CardDAV XML element names are identical to WebDAV
244 XML element names, though their namespace differs. Care must be
245 taken not to confuse the two sets of names.
247 3. Requirements Overview
249 This section lists what functionality is required of a CardDAV
250 server. To advertise support for CardDAV, a server:
252 o MUST support vCard v3 [RFC2426] as a media type for the address
253 object resource format;
255 o MUST support WebDAV Class 3 [RFC4918];
257 o MUST support WebDAV ACL [RFC3744];
259 o MUST support secure transport as defined in [RFC2818] using TLS
260 [RFC5246] and using the certificate validation procedures
261 described in [RFC5280];
263 o MUST support ETags [RFC2616] with additional requirements
264 specified in Section 6.3.2.3 of this document;
266 o MUST support all address book reports defined in Section 8 of this
267 document; and
269 o MUST advertise support on all address book collections and address
270 object resources for the address book reports in the DAV:
271 supported-report-set property, as defined in Versioning Extensions
272 to WebDAV [RFC3253].
274 In addition, a server:
276 o SHOULD support vCard v4 [I-D.ietf-vcarddav-vcardrev] as a media
277 type for the address object resource format;
279 o SHOULD support the extended MKCOL method [RFC5689] to create
280 address book collections as defined in Section 6.3.1 of this
281 document.
283 o SHOULD support the DAV:current-user-principal-URL property as
284 defined in [RFC5397] to give clients a fast way to locate user
285 principals.
287 4. Address Book Data Model
289 As a brief overview, a CardDAV address book is modeled as a WebDAV
290 collection with a well defined structure; each of these address book
291 collections contain a number of resources representing address
292 objects as their direct child resources. Each resource representing
293 an address object is called an "address object resource". Each
294 address object resource and each address book collection can be
295 individually locked and have individual WebDAV properties.
296 Requirements derived from this model are provided in Section 5.1 and
297 Section 5.2.
299 4.1. Address Book Server
301 A CardDAV server is an address-aware engine combined with a WebDAV
302 server. The server may include address data in some parts of its URL
303 namespace, and non-address data in other parts.
305 A WebDAV server can advertise itself as a CardDAV server if it
306 supports the functionality defined in this specification at any point
307 within the root of its repository. That might mean that address data
308 is spread throughout the repository and mixed with non-address data
309 in nearby collections (e.g. address data may be found in /lisa/
310 addressbook/ as well as in /bernard/addressbook/, and non-address
311 data in /lisa/calendars/). Or, it might mean that address data can
312 be found only in certain sections of the repository (e.g.
313 /addressbooks/user/). Address book features are only required in the
314 repository sections that are or contain address objects. So a
315 repository confining address data to the /carddav/ collection would
316 only need to support the CardDAV required features within that
317 collection.
319 The CardDAV server is the canonical location for address data and
320 state information. Clients may submit requests to change data or
321 download data. Clients may store address objects offline and attempt
322 to synchronize at a later time. Address data on the server can
323 change between the time of last synchronization and when attempting
324 an update, as address book collections may be shared and accessible
325 via multiple clients. Entity tags and locking help this work.
327 5. Address Book Resources
328 5.1. Address Object Resources
330 This specification uses vCard as the default format for address or
331 contact information being stored on the server. However, this
332 specification does allow other formats for address data provided that
333 the server advertises support for those additional formats as
334 described below. The requirements in this section pertain to vCard
335 address data, or formats that follow the semantics of vCard data.
337 Address object resources contained in address book collections MUST
338 contain a single vCard component only.
340 vCard components in an address book collection MUST have a UID
341 property value that MUST be unique in the scope of the address book
342 collection in which it is contained.
344 5.1.1. Data Type Conversion
346 Servers might support more than one primary media type for address
347 object resources, for example vCard v3.0 and vCard v4.0. In such
348 cases servers have to accept all media types that they advertise via
349 the CARDDAV:supported-address-data WebDAV property (see
350 Section 6.2.2).
352 However, clients can use standard HTTP content negotiation behavior
353 (the Accept request header defined in Section 14.1 of [RFC2616]) to
354 request that an address object resource's data be returned in a
355 specific media type format. For example, a client only capable of
356 handling vCard v3.0 would only want to have address object resources
357 returned in v3.0 format.
359 Additionally, REPORT requests, defined later in this specification,
360 allow for the return of address object resource data within an XML
361 response body. Again, the client can use content negotiation to
362 request that data be returned in a specific media type by specifying
363 appropriate attributes on the CARDDAV:address-data XML element used
364 in the request body (see Section 10.4).
366 In some cases it might not be possible for a server to convert from
367 one media type to another. When that happens, the server MUST return
368 the CARDDAV:supported-address-data-conversion precondition (see
369 below) in the response body (when the failure to convert applies to
370 the entire response) or use that same precondition code in the DAV:
371 response XML element in the response for the targeted address object
372 resource when one of the REPORTs defined below is used. See
373 Section 8.7.2 for an example of this.
375 5.1.1.1. Additional Precondition for GET
377 This specification creates additional preconditions for the GET
378 method.
380 The new precondition is:
382 (CARDDAV:supported-address-data-conversion): The resource targeted
383 by the GET request can be converted to the media type specified in
384 the Accept request header included with the request;
386 5.2. Address Book Collections
388 Address book collections appear to clients as a WebDAV collection
389 resource, identified by a URL. An address book collection MUST
390 report the DAV:collection and CARDDAV:addressbook XML elements in the
391 value of the DAV:resourcetype property. The element type declaration
392 for CARDDAV:addressbook is:
394
396 An address book collection can be created through provisioning (e.g.,
397 automatically created when a user's account is provisioned), or it
398 can be created with the extended MKCOL method (see Section 6.3.1).
399 This can be used by a user to create additional address books (e.g.,
400 "soccer team members") or for users to share an address book (e.g.,
401 "sales team contacts"). Note however that this document doesn't
402 define what extra address book collections are for. Users must rely
403 on non-standard cues to find out what an address book collection is
404 for, or use the CARDDAV:addressbook-description property defined in
405 Section 6.2.1 to provide such a cue.
407 The following restrictions are applied to the resources within an
408 address book collection:
410 a. Address book collections MUST only contain address object
411 resources and collections that are not address book collections.
412 i.e., the only "top-level" non-collection resources allowed in an
413 address book collection are address object resources. This
414 ensures that address book clients do not have to deal with non-
415 address data in an address book collection, though they do have
416 to distinguish between address object resources and collections
417 when using standard WebDAV techniques to examine the contents of
418 a collection.
420 b. Collections contained in address book collections MUST NOT
421 contain address book collections at any depth. i.e., "nesting" of
422 address book collections within other address book collections at
423 any depth is not allowed. This specification does not define how
424 collections contained in an address book collection are used or
425 how they relate to any address object resources contained in the
426 address book collection.
428 Multiple address book collections MAY be children of the same
429 collection.
431 6. Address Book Feature
433 6.1. Address Book Support
435 A server supporting the features described in this document, MUST
436 include "addressbook" as a field in the DAV response header from an
437 OPTIONS request on any resource that supports any address book
438 properties, reports, or methods. A value of "addressbook" in the DAV
439 response header MUST indicate that the server supports all MUST level
440 requirements and REQUIRED features specified in this document.
442 6.1.1. Example: Using OPTIONS for the Discovery of Support for CardDAV
444 >> Request <<
446 OPTIONS /addressbooks/users/ HTTP/1.1
447 Host: addressbook.example.com
449 >> Response <<
451 HTTP/1.1 200 OK
452 Allow: OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, COPY, MOVE
453 Allow: MKCOL, PROPFIND, PROPPATCH, LOCK, UNLOCK, REPORT, ACL
454 DAV: 1, 2, 3, access-control, addressbook
455 DAV: extended-mkcol
456 Date: Sat, 11 Nov 2006 09:32:12 GMT
457 Content-Length: 0
459 In this example, the OPTIONS response indicates that the server
460 supports CardDAV in this namespace, therefore the '/addressbooks/
461 users/' collection may be used as a parent for address book
462 collections as the extended MKCOL method is available, and as a
463 possible target for REPORT requests for address book reports.
465 6.2. Address Book Properties
466 6.2.1. CARDDAV:addressbook-description Property
468 Name: addressbook-description
470 Namespace: urn:ietf:params:xml:ns:carddav
472 Purpose: Provides a human-readable description of the address book
473 collection.
475 Value: Any text.
477 Protected: SHOULD NOT be protected so that users can specify a
478 description.
480 COPY/MOVE behavior: This property value SHOULD be preserved in COPY
481 and MOVE operations.
483 allprop behavior: SHOULD NOT be returned by a PROPFIND DAV:allprop
484 request.
486 Description: This property contains a description of the address
487 book collection that is suitable for presentation to a user. The
488 xml:lang attribute can be used to add a language tag for the value
489 of this property.
491 Definition:
493
494
496 Example:
498 Adresses de Oliver Daboo
502 6.2.2. CARDDAV:supported-address-data Property
504 Name: supported-address-data
506 Namespace: urn:ietf:params:xml:ns:carddav
508 Purpose: Specifies what media types are allowed for address object
509 resources in an address book collection.
511 Protected: MUST be protected as it indicates the level of support
512 provided by the server.
514 COPY/MOVE behavior: This property value MUST be preserved in COPY
515 and MOVE operations.
517 allprop behavior: SHOULD NOT be returned by a PROPFIND DAV:allprop
518 request.
520 Description: The CARDDAV:supported-address-data property is used to
521 specify the media type supported for the address object resources
522 contained in a given address book collection (e.g., vCard version
523 3.0). Any attempt by the client to store address object resources
524 with a media type not listed in this property MUST result in an
525 error, with the CARDDAV:supported-address-data precondition
526 (Section 6.3.2.1) being violated. In the absence of this property
527 the server MUST only accept data with the media type "text/vcard"
528 and vCard version 3.0, and clients can assume that.
530 Definition:
532
534
535
537
538
540 Example:
542
544
545
547 6.2.3. CARDDAV:max-resource-size Property
549 Name: max-resource-size
551 Namespace: urn:ietf:params:xml:ns:carddav
553 Purpose: Provides a numeric value indicating the maximum size in
554 octets of a resource that the server is willing to accept when an
555 address object resource is stored in an address book collection.
557 Value: Any text representing a numeric value.
559 Protected: MUST be protected as it indicates limits provided by the
560 server.
562 COPY/MOVE behavior: This property value MUST be preserved in COPY
563 and MOVE operations.
565 allprop behavior: SHOULD NOT be returned by a PROPFIND DAV:allprop
566 request.
568 Description: The CARDDAV:max-resource-size is used to specify a
569 numeric value that represents the maximum size in octets that the
570 server is willing to accept when an address object resource is
571 stored in an address book collection. Any attempt to store an
572 address book object resource exceeding this size MUST result in an
573 error, with the CARDDAV:max-resource-size precondition
574 (Section 6.3.2.1) being violated. In the absence of this property
575 the client can assume that the server will allow storing a
576 resource of any reasonable size.
578 Definition:
580
581
583 Example:
585 102400
588 6.3. Creating Resources
590 Address book collections and address object resources may be created
591 by either a CardDAV client or by the CardDAV server. This
592 specification defines restrictions and a data model that both clients
593 and servers MUST adhere to when manipulating such address data.
595 6.3.1. Extended MKCOL Method
597 An HTTP request using the extended MKCOL method [RFC5689] can be used
598 to create a new address book collection resource. A server MAY
599 restrict address book collection creation to particular collections.
601 To create an address book, the client sends an extended MKCOL request
602 to the server and in the body of the request sets the DAV:
603 resourcetype property to the resource type for an address book
604 collection as defined in Section 5.2.
606 Support for creating address books on the server is only RECOMMENDED
607 and not REQUIRED because some address book stores only support one
608 address book per user (or principal), and those are typically pre-
609 created for each account. However, servers and clients are strongly
610 encouraged to support address book creation whenever possible to
611 allow users to create multiple address book collections to help
612 organize their data better.
614 The DAV:displayname property can be used for a human-readable name of
615 the address book. Clients can either specify the value of the DAV:
616 displayname property in the request body of the extended MKCOL
617 request, or alternatively issue a PROPPATCH request to change the
618 DAV:displayname property to the appropriate value immediately after
619 using the extended MKCOL request. When displaying address book
620 collections to users, clients SHOULD check the DAV:displayname
621 property and use that value as the name of the address book. In the
622 event that the DAV:displayname property is not set, the client MAY
623 use the last part of the address book collection URI as the name,
624 however that path segment may be "opaque" and not represent any
625 meaningful human-readable text.
627 6.3.1.1. Example - Successful MKCOL request
629 This example creates an address book collection called /home/lisa/
630 addressbook/ on the server addressbook.example.com with specific
631 values for the properties DAV:resourcetype, DAV:displayname and
632 CARDDAV:addressbook-description.
634 >> Request <<
636 MKCOL /home/lisa/addressbook/ HTTP/1.1
637 Host: addressbook.example.com
638 Content-Type: text/xml; charset="utf-8"
639 Content-Length: xxx
641
642
644
645
646
647
648
649
650 Lisa's Contacts
651 My primary address book.
653
654
655
657 >> Response <<
659 HTTP/1.1 201 Created
660 Cache-Control: no-cache
661 Date: Sat, 11 Nov 2006 09:32:12 GMT
662 Content-Type: application/xml; charset="utf-8"
663 Content-Length: xxxx
665
666
668
669
670
671
672
673
674 HTTP/1.1 200 OK
675
676
678 6.3.2. Creating Address Object Resources
680 Clients populate address book collections with address object
681 resources. The URL for each address object resource is entirely
682 arbitrary, and does not need to bear a specific relationship (but
683 might) to the address object resource's vCard properties or other
684 metadata. New address object resources MUST be created with a PUT
685 request targeted at an unmapped URI. A PUT request targeted at a
686 mapped URI updates an existing address object resource.
688 When servers create new resources, it's not hard for the server to
689 choose a unique URL. It's slightly tougher for clients, because a
690 client might not want to examine all resources in the collection, and
691 might not want to lock the entire collection to ensure that a new one
692 isn't created with a name collision. However, there is an HTTP
693 feature to mitigate this. If the client intends to create a new
694 address resource the client SHOULD use the HTTP header "If-None-
695 Match: *" on the PUT request. The Request-URI on the PUT request
696 MUST include the target collection, where the resource is to be
697 created, plus the name of the resource in the last path segment. The
698 "If-None-Match" header ensures that the client will not inadvertently
699 overwrite an existing resource even, if the last path segment turned
700 out to already be used.
702 >> Request <<
704 PUT /lisa/addressbook/newvcard.vcf HTTP/1.1
705 If-None-Match: *
706 Host: addressbook.example.com
707 Content-Type: text/vcard
708 Content-Length: xxx
710 BEGIN:VCARD
711 VERSION:3.0
712 FN:Cyrus Daboo
713 N:Daboo;Cyrus
714 ADR;TYPE=POSTAL:;2822 Email HQ;Suite 2821;RFCVille;PA;15213;USA
715 EMAIL;TYPE=INTERNET,PREF:cyrus@example.com
716 NICKNAME:me
717 NOTE:Example VCard.
718 ORG:Self Employed
719 TEL;TYPE=WORK,VOICE:412 605 0499
720 TEL;TYPE=FAX:412 605 0705
721 URL:http://www.example.com
722 UID:1234-5678-9000-1
723 END:VCARD
724 >> Response <<
726 HTTP/1.1 201 Created
727 Date: Thu, 02 Sep 2004 16:53:32 GMT
728 Content-Length: 0
729 ETag: "123456789-000-111"
731 The request to change an existing address object resource without
732 overwriting a change made on the server, uses a specific ETag in an
733 "If-Match" header, rather than the "If-None-Match" header.
735 File names for vCards are commonly suffixed by ".vcf", and clients
736 may choose to use the same convention for URLs.
738 6.3.2.1. Additional Preconditions for PUT, COPY and MOVE
740 This specification creates additional Preconditions for PUT, COPY and
741 MOVE methods. These preconditions apply:
743 o When a PUT operation of an address object resource into an address
744 book collection occurs.
746 o When a COPY or MOVE operation of an address object resource into
747 an address book collection occurs.
749 The new preconditions are:
751 (CARDDAV:supported-address-data): The resource submitted in the
752 PUT request, or targeted by a COPY or MOVE request MUST be a
753 supported media type (i.e., vCard) for address object resources;
755 (CARDDAV:valid-address-data): The resource submitted in the PUT
756 request, or targeted by a COPY or MOVE request MUST be valid data
757 for the media type being specified (i.e., MUST contain valid vCard
758 data);
760 (CARDDAV:no-uid-conflict): The resource submitted in the PUT
761 request, or targeted by a COPY or MOVE request MUST NOT specify a
762 vCard UID property value already in use in the targeted address
763 book collection or overwrite an existing address object resource
764 with one that has a different UID property value. Servers SHOULD
765 report the URL of the resource that is already making use of the
766 same UID property value in the DAV:href element;
768
770 (CARDDAV:addressbook-collection-location-ok): In a COPY or MOVE
771 request, when the Request-URI is an address book collection, the
772 URI targeted by the Destination HTTP Request header MUST identify
773 a location where an address book collection can be created;
775 (CARDDAV:max-resource-size): The resource submitted in the PUT
776 request, or targeted by a COPY or MOVE request MUST have a size in
777 octets less than or equal to the value of the CARDDAV:max-
778 resource-size property value (Section 6.2.3) on the address book
779 collection where the resource will be stored;
781 6.3.2.2. Non-Standard vCard Properties, and Parameters
783 vCard provides a "standard mechanism for doing non-standard things".
784 This extension support allows implementers to make use of non-
785 standard vCard properties and parameters whose names are prefixed
786 with the text "X-".
788 Servers MUST support the use of non-standard properties and
789 parameters in address object resources stored via the PUT method.
791 Servers may need to enforce rules for their own "private" properties
792 or parameters, so servers MAY reject any attempt by the client to
793 change those or use values for those outside of any restrictions the
794 server may have. Servers SHOULD ensure that any "private" properties
795 or parameters it uses follow the convention of including a vendor id
796 in the "X-" name, as described in Section 3.8 of [RFC2426], e.g.,
797 "X-ABC-PRIVATE".
799 6.3.2.3. Address Object Resource Entity Tag
801 The DAV:getetag property MUST be defined and set to a strong entity
802 tag on all address object resources.
804 A response to a GET request targeted at an address object resource
805 MUST contain an ETag response header field indicating the current
806 value of the strong entity tag of the address object resource.
808 Servers SHOULD return a strong entity tag (ETag header) in a PUT
809 response when the stored address object resource is equivalent by
810 octet equality to the address object resource submitted in the body
811 of the PUT request. This allows clients to reliably use the returned
812 strong entity tag for data synchronization purposes. For instance,
813 the client can do a PROPFIND request on the stored address object
814 resource and have the DAV:getetag property returned, and compare that
815 value with the strong entity tag it received on the PUT response, and
816 know that if they are equal, then the address object resource on the
817 server has not been changed.
819 In the case where the data stored by a server as a result of a PUT
820 request is not equivalent by octet equality to the submitted address
821 object resource, the behavior of the ETag response header is not
822 specified here, with the exception that a strong entity tag MUST NOT
823 be returned in the response. As a result, clients may need to
824 retrieve the modified address object resource (and ETag) as a basis
825 for further changes, rather than use the address object resource it
826 had sent with the PUT request.
828 7. Address Book Access Control
830 CardDAV servers MUST support and adhere to the requirements of WebDAV
831 ACL [RFC3744]. WebDAV ACL provides a framework for an extensible set
832 of privileges that can be applied to WebDAV collections and ordinary
833 resources.
835 7.1. Additional Principal Properties
837 This section defines additional properties for WebDAV principal
838 resources as defined in [RFC3744].
840 7.1.1. CARDDAV:addressbook-home-set Property
842 Name: addressbook-home-set
844 Namespace: urn:ietf:params:xml:ns:carddav
846 Purpose: Identifies the URL of any WebDAV collections that contain
847 address book collections owned by the associated principal
848 resource.
850 Protected: MAY be protected if the server has fixed locations in
851 which address books are created.
853 COPY/MOVE behavior: This property value MUST be preserved in COPY
854 and MOVE operations.
856 allprop behavior: SHOULD NOT be returned by a PROPFIND DAV:allprop
857 request.
859 Description: The CARDDAV:addressbook-home-set property is meant to
860 allow users to easily find the address book collections owned by
861 the principal. Typically, users will group all the address book
862 collections that they own under a common collection. This
863 property specifies the URL of collections that either are address
864 book collections or ordinary collections that have child or
865 descendant address book collections owned by the principal.
867 Definition:
869
871 Example:
873
875 /bernard/addresses/
876
878 7.1.2. CARDDAV:principal-address Property
880 Name: principal-address
882 Namespace: urn:ietf:params:xml:ns:carddav
884 Purpose: Identifies the URL of an address object resource that
885 corresponds to the user represented by the principal.
887 Protected: MAY be protected if the server provides a fixed location
888 for principal addresses.
890 COPY/MOVE behavior: This property value MUST be preserved in COPY
891 and MOVE operations.
893 allprop behavior: SHOULD NOT be returned by a PROPFIND DAV:allprop
894 request.
896 Description: The CARDDAV:principal-address property is meant to
897 allow users to easily find contact information for users
898 represented by principals on the system. This property specifies
899 the URL of the resource containing the corresponding contact
900 information. The resource could be an address object resource in
901 an address book collection, or it could be a resource in a
902 "regular" collection.
904 Definition:
906
908 Example:
910
912 /system/cyrus.vcf
913
915 8. Address Book Reports
917 This section defines the reports that CardDAV servers MUST support on
918 address book collections and address object resources.
920 CardDAV servers MUST advertise support for these reports on all
921 address book collections and address object resources with the DAV:
922 supported-report-set property defined in Section 3.1.5 of [RFC3253].
923 CardDAV servers MAY also advertise support for these reports on
924 ordinary collections.
926 Some of these reports allow address data (from possibly multiple
927 resources) to be returned.
929 8.1. REPORT Method
931 The REPORT method (defined in Section 3.6 of [RFC3253]) provides an
932 extensible mechanism for obtaining information about a resource.
933 Unlike the PROPFIND method, which returns the value of one or more
934 named properties, the REPORT method can involve more complex
935 processing. REPORT is valuable in cases where the server has access
936 to all of the information needed to perform the complex request (such
937 as a query), and where it would require multiple requests for the
938 client to retrieve the information needed to perform the same
939 request.
941 A server that supports this specification MUST support the DAV:
942 expand-property report (defined in Section 3.8 of [RFC3253]).
944 8.2. Ordinary Collections
946 Servers MAY support the reports defined in this document on ordinary
947 collections (collections that are not address book collections) in
948 addition to address book collections or address object resources. In
949 computing responses to the reports on ordinary collections, servers
950 MUST only consider address object resources contained in address book
951 collections that are targeted by the REPORT based on the value of the
952 Depth request header.
954 8.3. Searching Text: Collations
956 Some of the reports defined in this section do text matches of
957 character strings provided by the client and compared to stored
958 address data. Since vCard data is by default encoded in the UTF-8
959 charset and may include characters outside of the US-ASCII charset
960 range in some property and parameter values, there is a need to
961 ensure that text matching follows well-defined rules.
963 To deal with this, this specification makes use of the IANA Collation
964 Registry defined in [RFC4790] to specify collations that may be used
965 to carry out the text comparison operations with a well-defined rule.
967 Collations supported by the server MUST support "equality" and
968 "substring" match operations as per [RFC4790] Section 4.2, including
969 the "prefix" and "suffix" options for "substring" matching. CardDAV
970 uses these match options for "equals", "contains", "starts-with" and
971 "ends-with" match operations.
973 CardDAV servers are REQUIRED to support the "i;ascii-casemap"
974 [RFC4790] and "i;unicode-casemap" [RFC5051] collations, and MAY
975 support other collations.
977 Servers MUST advertise the set of collations that they support via
978 the CARDDAV:supported-collation-set property defined on any resource
979 that supports reports that use collations.
981 In the absence of a collation explicitly specified by the client, or
982 if the client specifies the "default" collation identifier (as
983 defined in [RFC4790] Section 3.1), the server MUST default to using
984 "i;unicode-casemap" as the collation.
986 Wildcards (as defined in [RFC4790] Section 3.2) MUST NOT be used in
987 the collation identifier.
989 If the client chooses a collation not supported by the server, the
990 server MUST respond with a CARDDAV:supported-collation precondition
991 error response.
993 8.3.1. CARDDAV:supported-collation-set Property
995 Name: supported-collation-set
997 Namespace: urn:ietf:params:xml:ns:carddav
999 Purpose: Identifies the set of collations supported by the server
1000 for text matching operations.
1002 Protected: MUST be protected as it indicates support provided by the
1003 server.
1005 COPY/MOVE behavior: This property value MUST be preserved in COPY
1006 and MOVE operations.
1008 allprop behavior: SHOULD NOT be returned by a PROPFIND DAV:allprop
1009 request.
1011 Description: The CARDDAV:supported-collation-set property contains
1012 two or more CARDDAV:supported-collation elements which specify the
1013 identifiers of the collations supported by the server.
1015 Definition:
1017
1021
1024
1026 Example:
1028
1030 i;ascii-casemap
1031 i;octet
1032 i;unicode-casemap
1033
1035 8.4. Partial Retrieval
1037 Some address book reports defined in this document allow partial
1038 retrieval of address object resources. A CardDAV client can specify
1039 what information to return in the body of an address book REPORT
1040 request.
1042 A CardDAV client can request particular WebDAV property values, all
1043 WebDAV property values, or a list of the names of the resource's
1044 WebDAV properties. A CardDAV client can also request address data to
1045 be returned and whether all vCard properties should be returned or
1046 only particular ones. See CARDDAV:address-data in Section 10.4.
1048 8.5. Non-standard Properties and Parameters
1050 Servers MUST support the use of non-standard vCard property or
1051 parameter names in the CARDDAV:address-data XML element in address
1052 book REPORT requests to allow clients to request that non-standard
1053 properties and parameters be returned in the address data provided in
1054 the response.
1056 Servers MAY support the use of non-standard vCard property or
1057 parameter names in the CARDDAV:prop-filter and CARDDAV:param-filter
1058 XML elements specified in the CARDDAV:filter XML element of address
1059 book REPORT requests.
1061 Servers MUST fail with the CARDDAV:supported-filter precondition if
1062 an address book REPORT request uses a CARDDAV:prop-filter or CARDDAV:
1063 param-filter XML element that makes reference to a non-standard vCard
1064 property or parameter name which the server does not support queries
1065 on.
1067 8.6. CARDDAV:addressbook-query Report
1069 The CARDDAV:addressbook-query REPORT performs a search for all
1070 address object resources that match a specified filter. The response
1071 of this report will contain all the WebDAV properties and address
1072 object resource data specified in the request. In the case of the
1073 CARDDAV:address-data XML element, one can explicitly specify the
1074 vCard properties that should be returned in the address object
1075 resource data that matches the filter.
1077 The format of this report is modeled on the PROPFIND method. The
1078 request and response bodies of the CARDDAV:addressbook-query report
1079 use XML elements that are also used by PROPFIND. In particular the
1080 request can include XML elements to request WebDAV properties to be
1081 returned. When that occurs the response should follow the same
1082 behavior as PROPFIND with respect to the DAV:multistatus response
1083 elements used to return specific WebDAV property results. For
1084 instance, a request to retrieve the value of a WebDAV property which
1085 does not exist is an error and MUST be noted with a response XML
1086 element which contains a 404 (Not Found) status value.
1088 Support for the CARDDAV:addressbook-query REPORT is REQUIRED.
1090 Marshalling:
1092 The request body MUST be a CARDDAV:addressbook-query XML element
1093 as defined in Section 10.3.
1095 The request MUST include a Depth header. The scope of the query
1096 is determined by the value of the Depth header. e.g., to query all
1097 address object resources in an address book collection, the REPORT
1098 would use the address book collection as the request-URI and
1099 specify a Depth of 1 or infinity.
1101 The response body for a successful request MUST be a DAV:
1102 multistatus XML element (i.e., the response uses the same format
1103 as the response for PROPFIND). In the case where there are no
1104 response elements, the returned DAV:multistatus XML element is
1105 empty.
1107 The response body for a successful CARDDAV:addressbook-query
1108 REPORT request MUST contain a DAV:response element for each
1109 address object that matched the search filter. address data is
1110 returned in the CARDDAV:address-data XML element inside the DAV:
1111 propstat XML element.
1113 Preconditions:
1115 (CARDDAV:supported-address-data): The attributes "content-type"
1116 and "version" of the CARDDAV:address-data XML element (see
1117 Section 10.4) specify a media type supported by the server for
1118 address object resources.
1120 (CARDDAV:supported-filter): The CARDDAV:prop-filter (see
1121 Section 10.5.1) and CARDDAV:param-filter (see Section 10.5.2) XML
1122 elements used in the CARDDAV:filter XML element (see Section 10.5)
1123 in the REPORT request only make reference to vCard properties and
1124 parameters for which queries are supported by the server. i.e., if
1125 the CARDDAV:filter element attempts to reference an unsupported
1126 vCard property or parameter, this precondition is violated.
1127 Servers SHOULD report the CARDDAV:prop-filter or CARDDAV:param-
1128 filter for which it does not provide support.
1130
1133 (CARDDAV:supported-collation): Any XML attribute specifying a
1134 collation MUST specify a collation supported by the server as
1135 described in Section 8.3.
1137 Postconditions:
1139 (DAV:number-of-matches-within-limits): The number of matching
1140 address object resources must fall within server-specific,
1141 predefined limits. For example, this condition might be triggered
1142 if a search specification would cause the return of an extremely
1143 large number of responses.
1145 8.6.1. Limiting Results
1147 A client can limit the number of results returned by the server
1148 through use of the CARDDAV:limit element in the request body. This
1149 is useful when clients are only interested in a few matches, or only
1150 have limited space to display results to users and thus don't need
1151 the overhead of receiving more than that. When the results are
1152 truncated by the server, the server MUST follow the rules below for
1153 indicating a result set truncation to the client.
1155 8.6.2. Truncation of Results
1157 A server MAY limit the number of resources in a response, for
1158 example, to limit the amount of work expended in processing a query,
1159 or as the result of an explicit limit set by the client. If the
1160 result set is truncated because of such a limit, the response MUST
1161 use status code 207, return a DAV:multistatus response body, and
1162 indicate a status of 507 (Insufficient Storage) for the request URI.
1163 That DAV:response element SHOULD include a DAV:error element with the
1164 DAV:number-of-matches-within-limits precondition, as defined in
1165 [RFC3744] (Section 9.2).
1167 The server SHOULD also include the partial results in additional DAV:
1168 response elements. If a client requested limit is being applied, the
1169 507 response for the request URI MUST NOT be included in calculating
1170 the limit (e.g., if the client requests that only a single result be
1171 returned, and multiple matches are present, then the DAV:multistatus
1172 response will include one DAV:response for the matching resource and
1173 one DAV:response for the 507 status on the request URI).
1175 8.6.3. Example: Partial Retrieval of vCards Matching NICKNAME
1177 In this example, the client requests the server to search for address
1178 object resources that contain a NICKNAME property whose value equals
1179 some specific text, and to return specific vCard properties for those
1180 vCards found. In addition the DAV:getetag property is also requested
1181 and returned as part of the response.
1183 >> Request <<
1185 REPORT /home/bernard/addressbook/ HTTP/1.1
1186 Host: addressbook.example.com
1187 Depth: 1
1188 Content-Type: text/xml; charset="utf-8"
1189 Content-Length: xxxx
1191
1192
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206 me
1209
1210
1211
1212 >> Response <<
1214 HTTP/1.1 207 Multi-Status
1215 Date: Sat, 11 Nov 2006 09:32:12 GMT
1216 Content-Type: text/xml; charset="utf-8"
1217 Content-Length: xxxx
1219
1220
1222
1223 /home/bernard/addressbook/v102.vcf
1224
1225
1226 "23ba4d-ff11fb"
1227 BEGIN:VCARD
1228 VERSION:3.0
1229 NICKNAME:me
1230 UID:34222-232@example.com
1231 FN:Cyrus Daboo
1232 EMAIL:daboo@example.com
1233 END:VCARD
1234
1235
1236 HTTP/1.1 200 OK
1237
1238
1239
1241 8.6.4. Example: Partial Retrieval of vCards Matching a Full Name or
1242 Email Address
1244 In this example, the client requests the server to search for address
1245 object resources that contain a FN property whose value contains some
1246 specific text or that contain an EMAIL property whose value contains
1247 other text, and to return specific vCard properties for those vCards
1248 found. In addition the DAV:getetag property is also requested and
1249 returned as part of the response.
1251 >> Request <<
1253 REPORT /home/bernard/addressbook/ HTTP/1.1
1254 Host: addressbook.example.com
1255 Depth: 1
1256 Content-Type: text/xml; charset="utf-8"
1257 Content-Length: xxxx
1259
1260
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274 daboo
1277
1278
1279 daboo
1282
1283
1284
1285 >> Response <<
1287 HTTP/1.1 207 Multi-Status
1288 Date: Sat, 11 Nov 2006 09:32:12 GMT
1289 Content-Type: text/xml; charset="utf-8"
1290 Content-Length: xxxx
1292
1293
1295
1296 /home/bernard/addressbook/v102.vcf
1297
1298
1299 "23ba4d-ff11fb"
1300 BEGIN:VCARD
1301 VERSION:3.0
1302 NICKNAME:me
1303 UID:34222-232@example.com
1304 FN:David Boo
1305 EMAIL:daboo@example.com
1306 END:VCARD
1307
1308
1309 HTTP/1.1 200 OK
1310
1311
1312
1313 /home/bernard/addressbook/v104.vcf
1314
1315
1316 "23ba4d-ff11fc"
1317 BEGIN:VCARD
1318 VERSION:3.0
1319 NICKNAME:oliver
1320 UID:34222-23222@example.com
1321 FN:Oliver Daboo
1322 EMAIL:oliver@example.com
1323 END:VCARD
1324
1325
1326 HTTP/1.1 200 OK
1327
1328
1329
1331 8.6.5. Example: Truncated Results
1333 In this example, the client requests the server to search for address
1334 object resources that contain a FN property whose value contains some
1335 specific text, and to return the DAV:getetag property for two results
1336 only. The server response includes a 507 status for the request URI
1337 indicating that there were more than two resources that matched the
1338 query, but that the server truncated the result set as requested by
1339 the client.
1341 >> Request <<
1343 REPORT /home/bernard/addressbook/ HTTP/1.1
1344 Host: addressbook.example.com
1345 Depth: 1
1346 Content-Type: text/xml; charset="utf-8"
1347 Content-Length: xxxx
1349
1350
1352
1353
1354
1355
1356
1357 daboo
1360
1361
1362
1363 2
1364
1365
1366 >> Response <<
1368 HTTP/1.1 207 Multi-Status
1369 Date: Sat, 11 Nov 2006 09:32:12 GMT
1370 Content-Type: text/xml; charset="utf-8"
1371 Content-Length: xxxx
1373
1374
1376
1377 /home/bernard/addressbook/
1378 HTTP/1.1 507 OK
1379
1380
1381 Only two matching records were returned
1382
1383
1384
1385 /home/bernard/addressbook/v102.vcf
1386
1387
1388 "23ba4d-ff11fb"
1389
1390 HTTP/1.1 200 OK
1391
1392
1393
1394 /home/bernard/addressbook/v104.vcf
1395
1396
1397 "23ba4d-ff11fc"
1398
1399 HTTP/1.1 200 OK
1400
1401
1402
1404 8.7. CARDDAV:addressbook-multiget Report
1406 The CARDDAV:addressbook-multiget REPORT is used to retrieve specific
1407 address object resources from within a collection, if the Request-URI
1408 is a collection, or to retrieve a specific address object resource,
1409 if the Request-URI is a address object resource. This report is
1410 similar to the CARDDAV:addressbook-query REPORT (see Section 8.6),
1411 except that it takes a list of DAV:href elements instead of a
1412 CARDDAV:filter element to determine which address object resources to
1413 return.
1415 Support for the addressbook-multiget REPORT is REQUIRED.
1417 Marshalling:
1419 The request body MUST be a CARDDAV:addressbook-multiget XML
1420 element (see Section 10.7), which MUST contain at least one DAV:
1421 href XML element, and one optional CARDDAV:address-data element as
1422 defined in Section 10.4. If DAV:href elements are present, the
1423 scope of the request is the set of resources identified by these
1424 elements, which all need to be members (not necessarily internal
1425 members) of the resource identified by the Request-URI.
1426 Otherwise, the scope is the resource identified by the Request-URI
1427 itself.
1429 The request MUST include a Depth: 0 header, however the actual
1430 scope of the REPORT is determined as described above.
1432 The response body for a successful request MUST be a DAV:
1433 multistatus XML element.
1435 The response body for a successful CARDDAV:addressbook-multiget
1436 REPORT request MUST contain a DAV:response element for each
1437 address object resource referenced by the provided set of DAV:href
1438 elements. Address data is returned in the CARDDAV:address-data
1439 element inside the DAV:prop element.
1441 In the case of an error accessing any of the provided DAV:href
1442 resources, the server MUST return the appropriate error status
1443 code in the DAV:status element of the corresponding DAV:response
1444 element.
1446 Preconditions:
1448 (CARDDAV:supported-address-data): The attributes "content-type"
1449 and "version" of the CARDDAV:address-data XML elements (see
1450 Section 10.4) specify a media type supported by the server for
1451 address object resources.
1453 Postconditions:
1455 None.
1457 8.7.1. Example: CARDDAV:addressbook-multiget Report
1459 In this example, the client requests the server to return specific
1460 vCard properties of the address components referenced by specific
1461 URIs. In addition the DAV:getetag property is also requested and
1462 returned as part of the response. Note that in this example, the
1463 resource at
1464 http://addressbook.example.com/home/bernard/addressbook/vcf1.vcf does
1465 not exist, resulting in an error status response.
1467 >> Request <<
1469 REPORT /home/bernard/addressbook/ HTTP/1.1
1470 Host: addressbook.example.com
1471 Depth: 1
1472 Content-Type: text/xml; charset="utf-8"
1473 Content-Length: xxxx
1475
1476
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488 /home/bernard/addressbook/vcf102.vcf
1489 /home/bernard/addressbook/vcf1.vcf
1490
1491 >> Response <<
1493 HTTP/1.1 207 Multi-Status
1494 Date: Sat, 11 Nov 2006 09:32:12 GMT
1495 Content-Type: text/xml; charset="utf-8"
1496 Content-Length: xxxx
1498
1499
1501
1502 /home/bernard/addressbook/vcf102.vcf
1503
1504
1505 "23ba4d-ff11fb"
1506 BEGIN:VCARD
1507 VERSION:3.0
1508 NICKNAME:me
1509 UID:34222-232@example.com
1510 FN:Cyrus Daboo
1511 EMAIL:daboo@example.com
1512 END:VCARD
1513
1514
1515 HTTP/1.1 200 OK
1516
1517
1518
1519 /home/bernard/addressbook/vcf1.vcf
1520 HTTP/1.1 404 Resource not found
1521
1522
1524 8.7.2. Example: CARDDAV:addressbook-multiget Report
1526 In this example, the client requests the server to return vCard v4.0
1527 data of the address components referenced by specific URIs. In
1528 addition the DAV:getetag property is also requested and returned as
1529 part of the response. Note that in this example, the resource at
1530 http://addressbook.example.com/home/bernard/addressbook/vcf3.vcf
1531 exists but in a media type format that the server is unable to
1532 convert, resulting in an error status response.
1534 >> Request <<
1536 REPORT /home/bernard/addressbook/ HTTP/1.1
1537 Host: addressbook.example.com
1538 Depth: 1
1539 Content-Type: text/xml; charset="utf-8"
1540 Content-Length: xxxx
1542
1543
1545
1546
1547
1548
1549 /home/bernard/addressbook/vcf3.vcf
1550
1552 >> Response <<
1554 HTTP/1.1 207 Multi-Status
1555 Date: Sat, 11 Nov 2006 09:32:12 GMT
1556 Content-Type: text/xml; charset="utf-8"
1557 Content-Length: xxxx
1559
1560
1562
1563 /home/bernard/addressbook/vcf3.vcf
1564 HTTP/1.1 415 Unsupported Media Type
1565
1566 Unable to convert from vCard v3.0
1567 to vCard v4.0
1568
1569
1571 9. Client Guidelines
1573 9.1. Restrict the Properties Returned
1575 Clients may not need all the properties in a vCard object when
1576 presenting information to the user, or looking up specific items for
1577 their email address, for example. Since some property data can be
1578 large (e.g., PHOTO or SOUND with inline content) clients can choose
1579 to ignore those by only requesting the specific items it knows it
1580 will use, through use of the CARDDAV:address-data XML element in the
1581 relevant reports.
1583 However, if a client needs to make a change to a vCard, it can only
1584 change the entire vCard data via a PUT request. There is no way to
1585 incrementally make a change to a set of properties within a vCard
1586 object resource. As a result the client will have to cache the
1587 entire set of properties on a resource that is being changed.
1589 9.2. Avoiding Lost Updates
1591 When resources are accessed by multiple clients, the possibility of
1592 clients overwriting each other's changes exists. To alleviate that,
1593 clients SHOULD use the If-Match request header on PUT requests with
1594 the ETag of the previously retrieved resource data to check whether
1595 the resource was modified since it was previously retrieved. If a
1596 pre-condition failure occurs, clients need to reload the resource and
1597 go through their own merge or conflict resolution process before
1598 writing back the data (again using the If-Match check).
1600 9.3. Client Configuration
1602 When CardDAV clients need to be configured, the key piece of
1603 information that they require is the principal-URL of the user whose
1604 address book information is desired. Servers SHOULD support the DAV:
1605 current-user-principal-URL property as defined in [RFC5397] to give
1606 clients a fast way to locate user principals.
1608 Given support for SRV records (Section 11) and DAV:current-user-
1609 principal-URL [RFC5397], users only need enter a user identifier,
1610 host name and password to configure their client. The client would
1611 take the host name and do an SRV lookup to locate the CardDAV server,
1612 then execute an authenticated PROPFIND on the root / resource looking
1613 for the DAV:current-user-principal-URL property. The value returned
1614 gives the client direct access to the user's principal-URL and from
1615 there all the related CardDAV properties needed to locate address
1616 books.
1618 9.4. Finding Other Users' Address Books
1620 For address book sharing use cases, one might wish to find the
1621 address book belonging to another user. To find other users' address
1622 books on the same server, the DAV:principal-property-search REPORT
1623 [RFC3744] can be used to filter on some properties and return others.
1624 To search for an address book owned by a user named "Laurie", the
1625 REPORT request body would look like this:
1627
1628
1629
1630
1631
1632
1633 Laurie
1634
1635
1636
1638
1639
1640
1642 The server performs a case-sensitive or caseless search for a
1643 matching string subset of "Laurie" within the DAV:displayname
1644 property. Thus, the server might return "Laurie Dusseault", "Laurier
1645 Desruisseaux" or "Wilfrid Laurier" all as matching DAV:displayname
1646 values, and the address books for each of these.
1648 10. XML Element Definitions
1650 10.1. CARDDAV:addressbook XML Element
1652 Name: addressbook
1654 Namespace: urn:ietf:params:xml:ns:carddav
1656 Purpose: Specifies the resource type of an address book collection.
1658 Description: See Section 5.2.
1660 Definition:
1662
1664 10.2. CARDDAV:supported-collation XML Element
1666 Name: supported-collation
1668 Namespace: urn:ietf:params:xml:ns:carddav
1669 Purpose: Identifies a single collation via its collation identifier
1670 as defined by [RFC4790].
1672 Description: The CARDDAV:supported-collation contains the text of a
1673 collation identifier as described in Section 8.3.1.
1675 Definition:
1677
1678
1680 10.3. CARDDAV:addressbook-query XML Element
1682 Name: addressbook-query
1684 Namespace: urn:ietf:params:xml:ns:carddav
1686 Purpose: Defines a report for querying address book data
1688 Description: See Section 8.6.
1690 Definition:
1692
1696 10.4. CARDDAV:address-data XML Element
1698 Name: address-data
1700 Namespace: urn:ietf:params:xml:ns:carddav
1702 Purpose: Specifies one of the following:
1704 1. The parts of an address object resource which should be
1705 returned by a given address book REPORT request, and the media
1706 type and version for the returned data;
1708 2. The content of an address object resource in a response to an
1709 address book REPORT request.
1711 Description: When used in an address book REPORT request, the
1712 CARDDAV:address-data XML element specifies which parts of address
1713 object resources need to be returned in the response. If the
1714 CARDDAV:address-data XML element doesn't contain any CARDDAV:prop
1715 elements, address object resources will be returned in their
1716 entirety. Additionally a media type and version can be specified
1717 to request that the server return the data in that format if
1718 possible.
1720 Finally, when used in an address book REPORT response, the
1721 CARDDAV:address-data XML element specifies the content of a
1722 address object resource. Given that XML parsers normalize the
1723 two-character sequence CRLF (US-ASCII decimal 13 and US-ASCII
1724 decimal 10) to a single LF character (US-ASCII decimal 10), the CR
1725 character (US-ASCII decimal 13) MAY be omitted in address object
1726 resources specified in the CARDDAV:address-data XML element.
1727 Furthermore, address object resources specified in the CARDDAV:
1728 address-data XML element MAY be invalid per their media type
1729 specification if the CARDDAV:address-data XML element part of the
1730 address book REPORT request did not specify required vCard
1731 properties (e.g., UID, etc.) or specified a CARDDAV:prop XML
1732 element with the "novalue" attribute set to "yes".
1734 Note: The CARDDAV:address-data XML element is specified in requests
1735 and responses inside the DAV:prop XML element as if it were a
1736 WebDAV property. However, the CARDDAV:address-data XML element is
1737 not a WebDAV property and as such it is not returned in PROPFIND
1738 responses nor used in PROPPATCH requests.
1740 Note: The address data embedded within the CARDDAV:address-data XML
1741 element MUST follow the standard XML character data encoding
1742 rules, including use of <, >, & etc entity encoding or
1743 the use of a construct. In the later case the
1744 vCard data cannot contain the character sequence "]]>" which is
1745 the end delimiter for the CDATA section.
1747 Definition:
1749
1751 when nested in the DAV:prop XML element in an address book
1752 REPORT request to specify which parts of address object
1753 resources should be returned in the response;
1755
1756
1758 when nested in the DAV:prop XML element in an address book
1759 REPORT response to specify the content of a returned
1760 address object resource.
1762
1764
1765
1767 attributes can be used on each variant of the
1768 CALDAV:address-data XML element.
1770 10.4.1. CARDDAV:allprop XML Element
1772 Name: allprop
1774 Namespace: urn:ietf:params:xml:ns:carddav
1776 Purpose: Specifies that all vCard properties shall be returned.
1778 Description: This element can be used when the client wants all
1779 vCard properties of components returned by a report.
1781 Definition:
1783
1785 NOTE: The CARDDAV:allprop element defined here has the same name as
1786 the DAV:allprop element defined in WebDAV. However, the CARDDAV:
1787 allprop element defined here uses the
1788 "urn:ietf:params:xml:ns:carddav" namespace, as opposed to the "DAV:"
1789 namespace used for the DAV:allprop element defined in WebDAV.
1791 10.4.2. CARDDAV:prop XML Element
1792 Name: prop
1794 Namespace: urn:ietf:params:xml:ns:carddav
1796 Purpose: Defines which vCard properties to return in the response.
1798 Description: The "name" attribute specifies the name of the vCard
1799 property to return (e.g., "NICKNAME"). The "novalue" attribute
1800 can be used by clients to request that the actual value of the
1801 property not be returned (if the "novalue" attribute is set to
1802 "yes"). In that case the server will return just the vCard
1803 property name and any vCard parameters and a trailing ":" without
1804 the subsequent value data.
1806 vCard allows a "group" prefix to appear before a property name in
1807 the vCard data. When the "name" attribute does not specify a
1808 group prefix, it MUST match properties in the vCard data without a
1809 group prefix or with any group prefix. When the "name" attribute
1810 includes a group prefix, it MUST match properties that have
1811 exactly the same group prefix and name. e.g.: a "name" set to
1812 "TEL" will match "TEL", "X-ABC.TEL", "X-ABC-1.TEL" vCard
1813 properties. A "name" set to "X-ABC.TEL" will match an "X-ABC.TEL"
1814 vCard property only, it will not match "TEL" or "X-ABC-1.TEL".
1816 Definition:
1818
1820
1822
1823
1825 NOTE: The CARDDAV:prop element defined here has the same name as the
1826 DAV:prop element defined in WebDAV. However, the CARDDAV:prop
1827 element defined here uses the "urn:ietf:params:xml:ns:carddav"
1828 namespace, as opposed to the "DAV:" namespace used for the DAV:prop
1829 element defined in WebDAV.
1831 10.5. CARDDAV:filter XML Element
1833 Name: filter
1835 Namespace: urn:ietf:params:xml:ns:carddav
1836 Purpose: Determines which matching objects are returned.
1838 Description: The "filter" element specifies the search filter used
1839 to match address objects that should be returned by a report. The
1840 "test" attribute specifies whether any (logical OR) or all
1841 (logical AND) of the prop-filter tests needs to match in order for
1842 the overall filter to match.
1844 Definition:
1846
1848
1849
1853 10.5.1. CARDDAV:prop-filter XML Element
1855 Name: prop-filter
1857 Namespace: urn:ietf:params:xml:ns:carddav
1859 Purpose: Limits the search to specific vCard properties.
1861 Description: The CARDDAV:prop-filter XML element specifies a search
1862 criteria on a specific vCard property (e.g., NICKNAME). An
1863 address object is said to match a CARDDAV:prop-filter if:
1865 * A vCard property of the type specified by the "name" attribute
1866 exists, and the CARDDAV:prop-filter is empty, or it matches any
1867 specified CARDDAV:text-match or CARDDAV:param-filter
1868 conditions. The "test" attribute specifies whether any
1869 (logical OR) or all (logical AND) of the text-filter and param-
1870 filter tests need to match in order for the overall filter to
1871 match.
1873 or:
1875 * A vCard property of the type specified by the "name" attribute
1876 does not exist, and the CARDDAV:is-not-defined element is
1877 specified.
1879 vCard allows a "group" prefix to appear before a property name in
1880 the vCard data. When the "name" attribute does not specify a
1881 group prefix, it MUST match properties in the vCard data without a
1882 group prefix or with any group prefix. When the "name" attribute
1883 includes a group prefix, it MUST match properties that have
1884 exactly the same group prefix and name. e.g.: a "name" set to
1885 "TEL" will match "TEL", "X-ABC.TEL", "X-ABC-1.TEL" vCard
1886 properties. A "name" set to "X-ABC.TEL" will match an "X-ABC.TEL"
1887 vCard property only, it will not match "TEL" or "X-ABC-1.TEL".
1889 Definition:
1891
1894
1896
1901 10.5.2. CARDDAV:param-filter XML Element
1903 Name: param-filter
1905 Namespace: urn:ietf:params:xml:ns:carddav
1907 Purpose: Limits the search to specific parameter values.
1909 Description: The CARDDAV:param-filter XML element specifies a search
1910 criteria on a specific vCard property parameter (e.g., TYPE) in
1911 the scope of a given CARDDAV:prop-filter. A vCard property is
1912 said to match a CARDDAV:param-filter if:
1914 * A parameter of the type specified by the "name" attribute
1915 exists, and the CARDDAV:param-filter is empty, or it matches
1916 the CARDDAV:text-match conditions if specified.
1918 or:
1920 * A parameter of the type specified by the "name" attribute does
1921 not exist, and the CARDDAV:is-not-defined element is specified.
1923 Definition:
1925
1927
1928
1930 10.5.3. CARDDAV:is-not-defined XML Element
1932 Name: is-not-defined
1934 Namespace: urn:ietf:params:xml:ns:carddav
1936 Purpose: Specifies that a match should occur if the enclosing vCard
1937 property or parameter does not exist.
1939 Description: The CARDDAV:is-not-defined XML element specifies that a
1940 match occurs if the enclosing vCard property or parameter value
1941 specified in an address book REPORT request does not exist in the
1942 address data being tested.
1944 Definition:
1946
1948 10.5.4. CARDDAV:text-match XML Element
1950 Name: text-match
1952 Namespace: urn:ietf:params:xml:ns:carddav
1954 Purpose: Specifies a substring match on a vCard property or
1955 parameter value.
1957 Description: The CARDDAV:text-match XML element specifies text used
1958 for a substring match against the vCard property or parameter
1959 value specified in an address book REPORT request.
1961 The "collation" attribute is used to select the collation that the
1962 server MUST use for character string matching. In the absence of
1963 this attribute the server MUST use the "i;unicode-casemap"
1964 collation.
1966 The "negate-condition" attribute is used to indicate that this
1967 test returns a match if the text matches, when the attribute value
1968 is set to "no", or return a match if the text does not match, if
1969 the attribute value is set to "yes". For example, this can be
1970 used to match components with a CATEGORIES property not set to
1971 PERSON.
1973 The "match-type" attribute is used to indicate the type of match
1974 operation to use. Possible choices are:
1976 "equals" - an exact match to the target string
1978 "contains" - a substring match, matching anywhere within the
1979 target string
1981 "starts-with" - a substring match, matching only at the start
1982 of the target string
1984 "ends-with" - a substring match, matching only at the end of
1985 the target string
1987 Definition:
1989
1990
1992
1997 10.6. CARDDAV:limit XML Element
1999 Name: limit
2001 Namespace: urn:ietf:params:xml:ns:carddav
2003 Purpose: Specifies different types of limits that can be applied to
2004 the results returned by the server.
2006 Description: The CARDDAV:limit XML element can be used to specify
2007 different types of limits that the client can request the server
2008 to apply to the results returned by the server. Currently only
2009 the CARDDAV:nresults limit can be used, other types of limit could
2010 be defined in the future.
2012 Definition:
2014
2016 10.6.1. CARDDAV:nresults XML Element
2018 Name: nresults
2020 Namespace: urn:ietf:params:xml:ns:carddav
2021 Purpose: Specifies a limit on the number of results returned by the
2022 server.
2024 Description: The CARDDAV:nresults XML element contains a requested
2025 maximum number of DAV:response elements to be returned in the
2026 response body of a query. The server MAY disregard this limit.
2027 The value of this element is an unsigned integer.
2029 Definition:
2031
2032
2034 10.7. CARDDAV:addressbook-multiget XML Element
2036 Name: addressbook-multiget
2038 Namespace: urn:ietf:params:xml:ns:carddav
2040 Purpose: CardDAV report used to retrieve specific address objects
2041 via their URIs.
2043 Description: See Section 8.7.
2045 Definition:
2047
2052 11. Service Discovery via SRV Records
2054 [RFC2782] defines a DNS-based service discovery protocol that has
2055 been widely adopted as a means of locating particular services within
2056 a local area network and beyond, using SRV RR records.
2058 This specification adds two service types for use with SRV records:
2060 carddav: Identifies a CardDAV server that uses HTTP without TLS
2061 [RFC2818].
2063 carddavs: Identifies a CardDAV server that uses HTTP with TLS
2064 [RFC2818].
2066 Example: non-TLS service record
2068 _carddav._tcp SRV 0 1 80 addressbook.example.com.
2070 Example: TLS service
2072 _carddavs._tcp SRV 0 1 443 addressbook.example.com.
2074 12. Internationalization Considerations
2076 CardDAV allows internationalized strings to be stored and retrieved
2077 for the description of address book collections (see Section 6.2.1).
2079 The CARDDAV:addressbook-query REPORT (Section 8.6) includes a text
2080 searching option controlled by the CARDDAV:text-match element and
2081 details of character handling are covered in the description of that
2082 element (see Section 10.5.4).
2084 13. Security Considerations
2086 HTTP protocol transactions are sent in the clear over the network
2087 unless protection from snooping is negotiated. This can be
2088 accomplished by use of TLS as defined in [RFC2818]. In particular,
2089 if HTTP Basic authentication [RFC2617] is available, the server MUST
2090 allow TLS to be used at the same time, and SHOULD prevent use of
2091 Basic authentication when TLS is not in use. Clients SHOULD use TLS
2092 whenever possible.
2094 With the ACL extension [RFC3744] present, WebDAV allows control over
2095 who can access (read or write) any resource on the WebDAV server. In
2096 addition, WebDAV ACL provides for an "inheritance" mechanism, whereby
2097 resources may inherit access privileges from other resources. Often
2098 the "other" resource is a parent collection of the resource itself.
2099 Servers are able to support address books that are "private"
2100 (accessible only to the "owner"), "shared" (accessible to the owner
2101 and other specified authenticated users), and "public" (accessible to
2102 any authenticated or unauthenticated users). When provisioning
2103 address books of a particular type, servers MUST ensure that the
2104 correct privileges are applied on creation, and in particular private
2105 and shared address books MUST NOT be accessible by unauthenticated
2106 users (to prevent data from being automatically searched or indexed
2107 by web "crawlers").
2109 Clients SHOULD warn users in an appropriate fashion when they copy or
2110 move address data from a private address book to a shared address
2111 book or public address book. Clients SHOULD provide a clear
2112 indication as to which address books are private, shared or public.
2113 Clients SHOULD provide an appropriate warning when changing access
2114 privileges for a private or shared address book with data so as to
2115 allow unauthenticated users access.
2117 This specification currently relies on standard HTTP authentication
2118 mechanisms for identifying users. These comprise Basic and Digest
2119 authentication [RFC2617] as well as TLS [RFC2818] using client-side
2120 certificates.
2122 14. IANA Consideration
2124 This document uses a URN to describe a new XML namespace conforming
2125 to the registry mechanism described in [RFC3688].
2127 14.1. Namespace Registration
2129 Registration request for the carddav namespace:
2131 URI: urn:ietf:params:xml:ns:carddav
2133 Registrant Contact: See the "Author's Address" section of this
2134 document.
2136 XML: None - not applicable for namespace registrations.
2138 15. Acknowledgments
2140 Thanks go to Lisa Dusseault and Bernard Desruisseaux for their work
2141 on CalDAV, on which CardDAV is heavily based. The following
2142 individuals contributed their ideas and support for writing this
2143 specification: Mike Douglass, Stefan Eissing, Helge Hess, Arnaud
2144 Quillaud, Julian Reschke, Elias Sinderson, Greg Stein, Wilfredo
2145 Sanchez, and Simon Vaillancourt.
2147 16. References
2149 16.1. Normative References
2151 [I-D.ietf-vcarddav-vcardrev]
2152 Perreault, S. and P. Resnick, "vCard Format
2153 Specification", draft-ietf-vcarddav-vcardrev-08 (work in
2154 progress), July 2009.
2156 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
2157 Requirement Levels", BCP 14, RFC 2119, March 1997.
2159 [RFC2426] Dawson, F. and T. Howes, "vCard MIME Directory Profile",
2160 RFC 2426, September 1998.
2162 [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
2163 Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
2164 Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.
2166 [RFC2617] Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S.,
2167 Leach, P., Luotonen, A., and L. Stewart, "HTTP
2168 Authentication: Basic and Digest Access Authentication",
2169 RFC 2617, June 1999.
2171 [RFC2782] Gulbrandsen, A., Vixie, P., and L. Esibov, "A DNS RR for
2172 specifying the location of services (DNS SRV)", RFC 2782,
2173 February 2000.
2175 [RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000.
2177 [RFC3253] Clemm, G., Amsden, J., Ellison, T., Kaler, C., and J.
2178 Whitehead, "Versioning Extensions to WebDAV
2179 (Web Distributed Authoring and Versioning)", RFC 3253,
2180 March 2002.
2182 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
2183 January 2004.
2185 [RFC3744] Clemm, G., Reschke, J., Sedlar, E., and J. Whitehead, "Web
2186 Distributed Authoring and Versioning (WebDAV)
2187 Access Control Protocol", RFC 3744, May 2004.
2189 [RFC4790] Newman, C., Duerst, M., and A. Gulbrandsen, "Internet
2190 Application Protocol Collation Registry", RFC 4790,
2191 March 2007.
2193 [RFC4918] Dusseault, L., "HTTP Extensions for Web Distributed
2194 Authoring and Versioning (WebDAV)", RFC 4918, June 2007.
2196 [RFC5051] Crispin, M., "i;unicode-casemap - Simple Unicode Collation
2197 Algorithm", RFC 5051, October 2007.
2199 [RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security
2200 (TLS) Protocol Version 1.2", RFC 5246, August 2008.
2202 [RFC5280] Cooper, D., Santesson, S., Farrell, S., Boeyen, S.,
2203 Housley, R., and W. Polk, "Internet X.509 Public Key
2204 Infrastructure Certificate and Certificate Revocation List
2205 (CRL) Profile", RFC 5280, May 2008.
2207 [RFC5397] Sanchez, W. and C. Daboo, "WebDAV Current Principal
2208 Extension", RFC 5397, December 2008.
2210 [RFC5689] Daboo, C., "Extended MKCOL for Web Distributed Authoring
2211 and Versioning (WebDAV)", RFC 5689, September 2009.
2213 [W3C.REC-xml-20081126]
2214 Paoli, J., Yergeau, F., Bray, T., Sperberg-McQueen, C.,
2215 and E. Maler, "Extensible Markup Language (XML) 1.0 (Fifth
2216 Edition)", World Wide Web Consortium Recommendation REC-
2217 xml-20081126, November 2008,
2218 .
2220 16.2. Informative References
2222 [IMSP] Myers, J., "IMSP - Internet Message Support Protocol",
2223 June 1995.
2225 [RFC2244] Newman, C. and J. Myers, "ACAP -- Application
2226 Configuration Access Protocol", RFC 2244, November 1997.
2228 [RFC4510] Zeilenga, K., "Lightweight Directory Access Protocol
2229 (LDAP): Technical Specification Road Map", RFC 4510,
2230 June 2006.
2232 Appendix A. Change History (to be removed prior to publication as an
2233 RFC)
2235 Changes in -10
2237 1. Updated to MKColExt RFC reference.
2239 2. GenART Review: changed to clients SHOULD support TLS.
2241 3. GenART Review: changed security considerations in relation to
2242 clients indicating which address books are private, shared or
2243 public.
2245 4. IESG Review: re-wrote section on locking to instead describe how
2246 to avoid lost updates using ETags.
2248 5. IESG Review: removed disadvantage describing stateless protocol
2249 nature.
2251 6. IESG Review: clarified that 507 is only returned when truncation
2252 of the results set occurs.
2254 7. IESG Review: added additional text in security considerations
2255 about the handling private, shared and public address books.
2257 8. Fixed typos.
2259 9. Fixed some XML example errors.
2261 Changes in -09
2263 1. AD Review: support for vCard v4 is now a SHOULD.
2265 2. As a result of the above, added a sub-section on content
2266 conversion that defines a new precondition, and added an example
2267 of a conversion failure when doing a multiget.
2269 Changes in -08
2271 1. AD Review: added references to list in section 1.
2273 2. AD Review: added reference to RFC5280 for cert validation
2274 procedures.
2276 3. AD Review: added additional comment in addressbook-description
2277 property relating to use of xml:lang attribute.
2279 4. AD Review: max-resource-size now explicitly stated to be a
2280 decimal integer.
2282 5. AD Review: tweaked text for supported-collation-set to make it
2283 clear two will always be present.
2285 6. AD Review: section title change to "Client Guidelines".
2287 7. AD Review: finding address books section re-worded and reference
2288 added.
2290 8. AD Review: re-worded prop-filter description to better explain
2291 that text-match and param-filter can be specified independently
2292 of each other.
2294 9. AD Review: references added to security considerations.
2296 10. AD Review: changed to RFC4510 reference.
2298 Changes in -07
2299 1. WGLC: changed all alprop behaviors to SHOULD NOT return in
2300 allprop PROPFIND.
2302 2. WGLC: Reworked XML conventions section to come into line with
2303 text in extended MKCOL, and also updated W3C reference.
2305 3. WGLC: Changed a couple of examples to use absolute path DAV:href
2306 values.
2308 4. WGLC: Simplified IANA Considerations section.
2310 5. WGLC: Added new Client Configuration section and removed
2311 reference to principal-match.
2313 6. address-data element in supported-address-data changed to
2314 address-data-type.
2316 7. REPORTs now require Depth to be present and the scope of matching
2317 resources is determined by the value of the Depth header.
2319 8. Removed requirement that DAV:displayname should be unique at each
2320 level.
2322 Changes in -06
2324 1. WGLC: addressbook-home-set changed to SHOULD NOT return in
2325 allprop PROPFIND.
2327 2. WGLC: principal-address description changed to note that the
2328 resource pointed to could be in a regular collection too.
2330 3. Added new section decribing how SRV and current-user-principal
2331 are used to bootstrap client configuration.
2333 4. Removed discussion of using principal-match report.
2335 Changes in -05
2337 1. Removed mailing list discussion note from abstract.
2339 Changes in -04
2341 1. Tweaked limit element text to not imply any formal ordering of
2342 results.
2344 2. Changed prop-filter element to allow zero or more text-match
2345 elements rather than zero or one.
2347 3. Updated to RFC5397 reference.
2349 4. Updated TLS reference to latest version RFC5246.
2351 5. Boiler plate update.
2353 Changes in -03
2355 1. Added limit element to addressbook-query.
2357 2. Specified how a server signals that query results have been
2358 truncated.
2360 3. Minor stylistic changes.
2362 Changes in -02
2364 1. Added text to CARDDAV:prop and CARDDAV:prop-filter elements to
2365 explain how vCard "group" prefix on property names is handled.
2367 Changes in -01
2369 1. Added section on SRV records.
2371 Changes in -00
2373 1. Removed text describing other protocols.
2375 2. Added comment about a new vcard spec being developed.
2377 3. Added SHOULD support for the DAV:current-user-principal-URL
2378 property.
2380 4. Added "anyof"/"allof" test attribute to query XML elements to
2381 support simple or/and combinations of tests.
2383 Changes in pre-04
2385 1. Renamed addressbook-data to address-data for consistency.
2387 2. Fixed address-data element definition.
2389 Changes in pre-03
2391 1. Replaced MKADDRESSBOOK with extended MKCOL.
2393 2. Now require i;uncide-casemap as a supported collation and make it
2394 the default.
2396 3. No longer require i;octet as a supported collation.
2398 4. Allow different types of match operations via the "match-type"
2399 attribute on the "text-match" element.
2401 5. Updated to 4918 reference and removed some text/sections
2402 duplicating 4918.
2404 6. WebDAV Level 3 now required.
2406 7. TLS requirement text tweaked to match latest text approved by
2407 IESG.
2409 8. Added principal-address property to principal resources to allow
2410 a vcard to be associated with a principal.
2412 9. XML definition clean-up.
2414 Changes in pre-02
2416 1. Added commentary on SyncML.
2418 2. Changed 'adbk' to 'addressbook'.
2420 3. Support for MKADDRESSBOOK is now a SHOULD.
2422 4. Updated to RFC4790 reference.
2424 5. Removed synchronization report.
2426 6. Removed BNF conventions section as we have no BNF.
2428 7. Reworded and reformatted several items to match the final CalDAV
2429 spec.
2431 8. Added section on use of nonstandard properties and parameters
2432 (as per CalDAV).
2434 9. Added section of behavior of ETags (as per CalDAV).
2436 10. Generalized the text so that vCard need not be the only format
2437 supported by the server (i.e., allow xml version of vCard etc).
2439 11. Renamed supported-addressbook-data to supported-address-data.
2441 12. Renamed valid-addressbook-data to valid-address-data.
2443 13. Now requires "i;unicasemao" collation.
2445 Changes in pre-01
2447 1. Fixed various incorrect references and typos.
2449 2. Major changes to sync with latest CalDAV spec behaviors.
2451 Author's Address
2453 Cyrus Daboo
2454 Apple Inc.
2455 1 Infinite Loop
2456 Cupertino, CA 95014
2457 USA
2459 Email: cyrus@daboo.name
2460 URI: http://www.apple.com/