idnits 2.17.1 draft-reschke-webdav-allprop-include-07.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** It looks like you're using RFC 3978 boilerplate. You should update this to the boilerplate described in the IETF Trust License Policy document (see https://trustee.ietf.org/license-info), which is required now. -- Found old boilerplate from RFC 3978, Section 5.1 on line 15. -- Found old boilerplate from RFC 3978, Section 5.5 on line 519. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 496. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 503. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 509. ** This document has an original RFC 3978 Section 5.4 Copyright Line, instead of the newer IETF Trust Copyright according to RFC 4748. ** This document has an original RFC 3978 Section 5.5 Disclaimer, instead of the newer disclaimer which includes the IETF Trust according to RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == No 'Intended status' indicated for this document; assuming Proposed Standard Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack a Security Considerations section. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 360 has weird spacing: '... to the draft...' -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (November 22, 2005) is 6730 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) ** Obsolete normative reference: RFC 2518 (Obsoleted by RFC 4918) Summary: 5 errors (**), 0 flaws (~~), 3 warnings (==), 7 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 WEBDAV Working Group J. Reschke, Ed. 3 Internet-Draft S. Eissing 4 Expires: May 26, 2006 greenbytes 5 November 22, 2005 7 Including additional properties in WebDAV PROPFIND/allprop requests 8 draft-reschke-webdav-allprop-include-07 10 Status of this Memo 12 By submitting this Internet-Draft, each author represents that any 13 applicable patent or other IPR claims of which he or she is aware 14 have been or will be disclosed, and any of which he or she becomes 15 aware will be disclosed, in accordance with Section 6 of BCP 79. 17 Internet-Drafts are working documents of the Internet Engineering 18 Task Force (IETF), its areas, and its working groups. Note that 19 other groups may also distribute working documents as Internet- 20 Drafts. 22 Internet-Drafts are draft documents valid for a maximum of six months 23 and may be updated, replaced, or obsoleted by other documents at any 24 time. It is inappropriate to use Internet-Drafts as reference 25 material or to cite them other than as "work in progress." 27 The list of current Internet-Drafts can be accessed at 28 http://www.ietf.org/ietf/1id-abstracts.txt. 30 The list of Internet-Draft Shadow Directories can be accessed at 31 http://www.ietf.org/shadow.html. 33 This Internet-Draft will expire on May 26, 2006. 35 Copyright Notice 37 Copyright (C) The Internet Society (2005). 39 Abstract 41 Recent specifications extending the Web Distributed Authoring 42 Protocol (WebDAV) restrict the set of properties returned 43 automatically upon a PROPFIND/allprop request. This specification 44 defines a method to add specific properties to the set of properties 45 returned upon PROPFIND/allprop. 47 Editorial Note (to be removed by RFC Editor before publication) 48 Distribution of this document is unlimited. Please send comments to 49 the WebDAV working group at , which may 50 be joined by sending a message with subject "subscribe" to 51 . Discussions of the WEBDAV 52 working group are archived at 53 . 55 XML and HTML versions of this draft are available from . 58 Table of Contents 60 1. Notational Conventions . . . . . . . . . . . . . . . . . . . . 3 61 2. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 62 3. Extensions to PROPFIND/allprop . . . . . . . . . . . . . . . . 3 63 3.1 Example for PROPFIND/allprop/include with extended 64 server . . . . . . . . . . . . . . . . . . . . . . . . . . 4 65 3.2 Example for PROPFIND/allprop/include with non-extended 66 server . . . . . . . . . . . . . . . . . . . . . . . . . . 6 67 4. Changes to WebDAV DTD . . . . . . . . . . . . . . . . . . . . 7 68 5. Compatibility Considerations . . . . . . . . . . . . . . . . . 8 69 6. Internationalization Considerations . . . . . . . . . . . . . 8 70 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 71 8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 8 72 8.1 Normative References . . . . . . . . . . . . . . . . . . . 8 73 8.2 Informative References . . . . . . . . . . . . . . . . . . 8 74 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . 9 75 A. Alternate syntax proposal from interim WebDAV working 76 group meeting . . . . . . . . . . . . . . . . . . . . . . . . 9 77 A.1 PROPFIND/prop extension to include dead properties . . . . 9 78 A.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . 10 79 A.3 Analysis . . . . . . . . . . . . . . . . . . . . . . . . . 11 80 B. Change Log (to be removed by RFC Editor before publication) . 11 81 B.1 Since 'draft-reschke-webdav-allprop-include-00' . . . . . 11 82 B.2 Since 'draft-reschke-webdav-allprop-include-01' . . . . . 12 83 B.3 Since 'draft-reschke-webdav-allprop-include-02' . . . . . 12 84 B.4 Since 'draft-reschke-webdav-allprop-include-03' . . . . . 12 85 B.5 Since 'draft-reschke-webdav-allprop-include-04' . . . . . 12 86 B.6 Since 'draft-reschke-webdav-allprop-include-05' . . . . . 12 87 B.7 Since 'draft-reschke-webdav-allprop-include-06' . . . . . 12 88 C. Open issues (to be removed by RFC Editor prior to 89 publication) . . . . . . . . . . . . . . . . . . . . . . . . . 12 90 C.1 edit . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 91 Intellectual Property and Copyright Statements . . . . . . . . 13 93 1. Notational Conventions 95 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 96 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 97 document are to be interpreted as described in [RFC2119]. 99 2. Introduction 101 Recent specifications extending the "Web Distributed Authoring 102 Protocol" (WebDAV, [RFC2518]) like "Versioning Extensions to WebDAV" 103 [RFC3253] and "WebDAV Access Control Protocol" [RFC3744] restrict the 104 set of properties returned automatically upon a PROPFIND/allprop 105 request in order to avoid the expensive computation of properties 106 that the client in many cases isn't interested in. 108 However, this change from the behaviour defined in WebDAV can lead to 109 situations where clients need to perform two requests to retrieve all 110 properties they are interested in (one using PROPFIND/allprop, then 111 PROPFIND/prop enumerating the new properties that weren't reported 112 upon the first request). This specification defines a backward- 113 compatible extension to add specific properties to the set of 114 properties returned upon PROPFIND/allprop, thus saving at least one 115 PROPFIND request. 117 This document defines an extension element that could ultimately 118 become part of the core WebDAV protocol. Being just an individual 119 submission, it currently defines it in the proprietary namespace 121 http://sapportals.com/xmlns/cm/webdav 123 instead of the "DAV:" namespace. It uses a prefix of "in:" for 124 referring to elements in this namespace. However, WebDAV server and 125 clients are free to use any prefix, provided that there is a 126 namespace declaration that binds the prefix to the URI of the same 127 namespace. 129 3. Extensions to PROPFIND/allprop 131 The "allprop" version of PROPFIND is extended to take an optional in: 132 include element. When present, it contains a set of property names 133 that shall be reported in addition to those properties that the 134 server usually would return upon PROPFIND/allprop. 136 3.1 Example for PROPFIND/allprop/include with extended server 138 >>Request 140 PROPFIND /container/front.html HTTP/1.1 141 Host: www.example.org 142 Depth: 1 143 Content-Type: text/xml; charset="utf-8" 144 Content-Length: xxxx 146 147 149 150 151 152 153 154 156 >>Response 157 HTTP/1.1 207 Multi-Status 158 Content-Type: text/xml; charset="utf-8" 159 Content-Length: xxxx 161 162 163 164 http://www.example.org/container/front.html 165 166 167 168 Box type B 169 170 1997-12-01T18:27:21-08:00 171 Example HTML resource 172 4525 173 text/html 174 zzyzx 175 Monday, 12-Jan-98 09:25:56 GMT 177 178 179 180 181 182 183 184 185 186 187 188 189 http://www.example.org/vsn/container/front.html-1 191 192 193 HTTP/1.1 200 OK 194 195 196 197 198 199 HTTP/1.1 404 NOT FOUND 200 201 202 204 In this example, the server has recognized the extension element in: 206 include and included the properties DAV:checked-in and DAV:checked- 207 out (as defined in [RFC3253]). 209 3.2 Example for PROPFIND/allprop/include with non-extended server 211 >>Request 213 PROPFIND /container/front.html HTTP/1.1 214 Host: www.example.org 215 Depth: 1 216 Content-Type: text/xml; charset="utf-8" 217 Content-Length: xxxx 219 220 222 223 224 225 226 227 228 >>Response 230 HTTP/1.1 207 Multi-Status 231 Content-Type: text/xml; charset="utf-8" 232 Content-Length: xxxx 234 235 236 237 http://www.example.org/container/front.html 238 239 240 241 Box type B 242 243 1997-12-01T18:27:21-08:00 244 Example HTML resource 245 4525 246 text/html 247 zzyzx 248 Monday, 12-Jan-98 09:25:56 GMT 250 251 252 253 254 255 256 257 258 259 260 261 262 HTTP/1.1 200 OK 263 264 265 267 In this case the in:include element was simply ignored. The client 268 can detect this situation by checking for the presence of the 269 requested properties and will have to issue an additional PROPFIND/ 270 prop request (to retrieve the missing properties). 272 4. Changes to WebDAV DTD 274 275 276 Note that the WebDAV DTD is informal only and cannot be used to 277 validate request or response bodies (due to the inability to properly 278 work with XML namespaces). 280 5. Compatibility Considerations 282 This specification introduces a new child element for the DAV: 283 propfind element, defined in Section 4. Old servers will ignore this 284 element (see [RFC2518], chapter 14). Clients can detect this 285 situation as outlined in Section 3.2. 287 Clients not aware of this specification will not be affected at all, 288 because they will never use the new in:include element in PROPFIND 289 requests. 291 6. Internationalization Considerations 293 This proposal builds on [RFC2518], and inherits its 294 internationalizability. 296 7. IANA Considerations 298 This proposal does not introduce any new IANA considerations, since 299 it does not specify any new namespaces (in the general sense), but 300 merely uses existing ones. 302 8. References 304 8.1 Normative References 306 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 307 Requirement Levels", BCP 14, RFC 2119, March 1997. 309 [RFC2518] Goland, Y., Whitehead, E., Faizi, A., Carter, S., and D. 310 Jensen, "HTTP Extensions for Distributed Authoring -- 311 WEBDAV", RFC 2518, February 1999. 313 [RFC3253] Clemm, G., Amsden, J., Ellison, T., Kaler, C., and J. 314 Whitehead, "Versioning Extensions to WebDAV", RFC 3253, 315 March 2002. 317 8.2 Informative References 319 [RFC3744] Clemm, G., Reschke, J., Sedlar, E., and J. Whitehead, "Web 320 Distributed Authoring and Versioning (WebDAV) Access 321 Control Protocol", RFC 3744, May 2004. 323 [draft-ietf-webdav-rfc2518bis] 324 Dusseault, L. and J. Crawford, "HTTP Extensions for 325 Distributed Authoring - WebDAV RFC2518 bis", 326 draft-ietf-webdav-rfc2518bis-08 (work in progress), 327 November 2005, . 330 Authors' Addresses 332 Julian F. Reschke (editor) 333 greenbytes GmbH 334 Hafenweg 16 335 Muenster, NW 48155 336 Germany 338 Phone: +49 251 2807760 339 Fax: +49 251 2807761 340 Email: julian.reschke@greenbytes.de 341 URI: http://greenbytes.de/tech/webdav/ 343 Stefan Eissing 344 greenbytes GmbH 345 Hafenweg 16 346 Muenster, NW 48155 347 Germany 349 Phone: +49 251 2807760 350 Fax: +49 251 2807761 351 Email: stefan.eissing@greenbytes.de 352 URI: http://greenbytes.de/tech/webdav/ 354 Appendix A. Alternate syntax proposal from interim WebDAV working group 355 meeting 357 This section briefly describes an alternate approach to the problem 358 covered by this draft. It was discussed during the interim WebDAV 359 working group meeting in January 2003 and was supported by all 360 meeting attendees. It was also added to the draft for the revision 361 of [RFC2518], [draft-ietf-webdav-rfc2518bis]. 363 A.1 PROPFIND/prop extension to include dead properties 365 Additional PROPFIND marshalling: 367 368 369 The DAV:dead-props element can be added to PROPFIND requests that 370 retrieve named properties using DAV:prop. When present, the server 371 MUST include all dead properties defined on the resource. 373 A.2 Example 375 This example shows the alternate syntax applied to the example from 376 Section 3.1. 378 >>Request 380 PROPFIND /container/front.html HTTP/1.1 381 Host: www.example.org 382 Depth: 1 383 Content-Type: text/xml; charset="utf-8" 384 Content-Length: xxxx 386 387 388 389 390 391 392 393 394 >>Response 396 HTTP/1.1 207 Multi-Status 397 Content-Type: text/xml; charset="utf-8" 398 Content-Length: xxxx 400 401 402 403 http://www.example.org/container/front.html 404 405 406 407 Box type B 408 409 410 http://www.example.org/vsn/container/front.html-1 412 413 414 HTTP/1.1 200 OK 415 416 417 418 419 420 HTTP/1.1 404 NOT FOUND 421 422 423 425 A.3 Analysis 427 At first glance, this extension seems to have equivalent semantics. 428 On closer inspection, it doesn't provide the client any means to 429 actually find out whether the remote server understood the extension 430 (it can't distinguish between "server does not now about "dead- 431 props", and "there are no dead properties on the resource"). 433 Appendix B. Change Log (to be removed by RFC Editor before publication) 435 B.1 Since 'draft-reschke-webdav-allprop-include-00' 437 Moved element out of "DAV:" namespace. 438 Updated reference to deltaV (now RFC3253). 439 Changed examples to explicitly use utf-8 encoding for HTTP content 440 type and XML encoding. 442 Updated WebDAV ACL reference to draft 07. 443 Made sure figures fit in 72 columns. 444 Split references into "Normative" and "Informative". 446 B.2 Since 'draft-reschke-webdav-allprop-include-01' 448 Updated WebDAV ACL reference to draft 09. 450 B.3 Since 'draft-reschke-webdav-allprop-include-02' 452 Fixed XML errors in examples (wrong closing href tags). 453 Replaced domain names in examples according to RFC2606: "www.foo.bar" 454 by "www.example.org". 455 Shortened checked-in URI to fit into 72 characters in example. 457 B.4 Since 'draft-reschke-webdav-allprop-include-03' 459 Added short description of alternate syntax discussed during interim 460 WebDAV WG meeting (January 2003). 462 B.5 Since 'draft-reschke-webdav-allprop-include-04' 464 DTD fix for dead-props variant. Remove superfluous IP and copyright 465 sections. Added reference to RFC2518bis. Updated reference to ACL 466 draft. 468 B.6 Since 'draft-reschke-webdav-allprop-include-05' 470 Updated various references. Update abstract. 472 B.7 Since 'draft-reschke-webdav-allprop-include-06' 474 Updated RFC2518bis reference. Author's address updated. Added 475 analysis of shortcomings of the RFC2518bis approach. 477 Appendix C. Open issues (to be removed by RFC Editor prior to 478 publication) 480 C.1 edit 482 Type: edit 484 julian.reschke@greenbytes.de (2005-01-01): Umbrella issue for 485 editorial fixes/enhancements. 487 Intellectual Property Statement 489 The IETF takes no position regarding the validity or scope of any 490 Intellectual Property Rights or other rights that might be claimed to 491 pertain to the implementation or use of the technology described in 492 this document or the extent to which any license under such rights 493 might or might not be available; nor does it represent that it has 494 made any independent effort to identify any such rights. Information 495 on the procedures with respect to rights in RFC documents can be 496 found in BCP 78 and BCP 79. 498 Copies of IPR disclosures made to the IETF Secretariat and any 499 assurances of licenses to be made available, or the result of an 500 attempt made to obtain a general license or permission for the use of 501 such proprietary rights by implementers or users of this 502 specification can be obtained from the IETF on-line IPR repository at 503 http://www.ietf.org/ipr. 505 The IETF invites any interested party to bring to its attention any 506 copyrights, patents or patent applications, or other proprietary 507 rights that may cover technology that may be required to implement 508 this standard. Please address the information to the IETF at 509 ietf-ipr@ietf.org. 511 Disclaimer of Validity 513 This document and the information contained herein are provided on an 514 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS 515 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET 516 ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, 517 INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE 518 INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 519 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 521 Copyright Statement 523 Copyright (C) The Internet Society (2005). This document is subject 524 to the rights, licenses and restrictions contained in BCP 78, and 525 except as set forth therein, the authors retain all their rights. 527 Acknowledgment 529 Funding for the RFC Editor function is currently provided by the 530 Internet Society.