source: draft-ietf-httpbis-content-disp/latest/draft-ietf-httpbis-content-disp.xml @ 1183

Last change on this file since 1183 was 1183, checked in by julian.reschke@…, 9 years ago

clarify 'last path segment'

  • Property svn:eol-style set to native
  • Property svn:executable set to *
File size: 39.2 KB
Line 
1<?xml version="1.0" encoding="utf-8"?>
2<?xml-stylesheet type='text/xsl' href='../../draft-ietf-httpbis/myxml2rfc.xslt' ?>
3<?rfc toc="yes"?>
4<?rfc symrefs="yes"?>
5<?rfc sortrefs="yes"?>
6<?rfc compact="yes"?>
7<?rfc comments="yes"?>
8<?rfc inline="yes"?>
9<?rfc subcompact="no"?>
10<?rfc rfcedstyle="yes"?>
11<?rfc-ext allow-markup-in-artwork="yes" ?>
12<?rfc-ext include-references-in-index="yes" ?>
13
14<!DOCTYPE rfc [
15  <!ENTITY MAY "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>MAY</bcp14>">
16  <!ENTITY MUST "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>MUST</bcp14>">
17  <!ENTITY MUST-NOT "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>MUST NOT</bcp14>">
18  <!ENTITY OPTIONAL "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>OPTIONAL</bcp14>">
19  <!ENTITY RECOMMENDED "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>RECOMMENDED</bcp14>">
20  <!ENTITY REQUIRED "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>REQUIRED</bcp14>">
21  <!ENTITY SHALL "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>SHALL</bcp14>">
22  <!ENTITY SHALL-NOT "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>SHALL NOT</bcp14>">
23  <!ENTITY SHOULD "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>SHOULD</bcp14>">
24  <!ENTITY SHOULD-NOT "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>SHOULD NOT</bcp14>">
25]>
26
27<rfc xmlns:x="http://purl.org/net/xml2rfc/ext" xmlns:ed="http://greenbytes.de/2002/rfcedit" ipr="trust200902" docName="draft-ietf-httpbis-content-disp-latest" category="std" x:maturity-level="proposed" xml:lang="en" updates="2616">
28        <front>
29  <title abbrev="Content-Disposition in HTTP">Use of the Content-Disposition&#160;Header&#160;Field
30  in the Hypertext&#160;Transfer&#160;Protocol&#160;(HTTP)</title>
31  <author initials="J. F." surname="Reschke" fullname="Julian F. Reschke">
32    <organization abbrev="greenbytes">greenbytes GmbH</organization>
33    <address>
34      <postal>
35        <street>Hafenweg 16</street>
36        <city>Muenster</city><region>NW</region><code>48155</code>
37        <country>Germany</country>
38      </postal>
39      <email>julian.reschke@greenbytes.de</email>       
40      <uri>http://greenbytes.de/tech/webdav/</uri>     
41    </address>
42  </author>
43
44  <date month="March" year="2011"/>
45  <workgroup>HTTPbis Working Group</workgroup>
46 
47  <abstract>
48    <t>
49      RFC 2616 defines the Content-Disposition response header field,
50      but points out that it is not part of the HTTP/1.1 Standard.
51      This specification takes over the definition and registration of
52      Content-Disposition, as used in HTTP, and clarifies internationalization
53      aspects.
54    </t>
55  </abstract>
56 
57  <note title="Editorial Note (To be removed by RFC Editor before publication)">
58    <t>
59      This specification is expected to replace the definition of Content-Disposition
60      in the HTTP/1.1 specification, as currently revised by the IETF HTTPbis
61      working group. See also <eref target="http://trac.tools.ietf.org/wg/httpbis/trac/ticket/123"/>.
62    </t>
63    <t>
64      Discussion of this draft should take place on the HTTPBIS working group
65      mailing list (ietf-http-wg@w3.org). The current issues list is
66      at <eref target="http://trac.tools.ietf.org/wg/httpbis/trac/query?component=content-disp"/>
67      and related documents (including fancy diffs) can be found at
68      <eref target="http://tools.ietf.org/wg/httpbis/"/>.
69    </t>
70    <t>
71      The changes in this draft are summarized in <xref target="changes.since.07"/>.
72    </t>
73  </note>
74  </front>
75
76  <middle>
77
78<section title="Introduction" anchor="introduction">
79<t>
80  RFC 2616 defines the Content-Disposition response header field in <xref target="RFC2616" x:fmt="of" x:sec="19.5.1"/>,
81  but points out that it is not part of the HTTP/1.1 Standard (<xref target="RFC2616" x:fmt="sec" x:sec="15.5"/>):
82</t>
83<x:blockquote cite="http://tools.ietf.org/html/rfc2616#section-15.5">
84  <t>
85    Content-Disposition is not part of the HTTP standard, but since it is
86    widely implemented, we are documenting its use and risks for implementers.
87  </t>
88</x:blockquote>
89<t>
90  This specification takes over the definition and registration of
91  Content-Disposition, as used in HTTP.
92  Based on interoperability testing with existing User Agents,
93  it fully defines a profile of the
94  features defined in the Multipurpose Internet Mail Extensions (MIME) variant (<xref target="RFC2183"/>) of the
95  header field, and also clarifies internationalization
96  aspects.
97</t>
98<x:note>
99  <t>
100    <x:h>Note:</x:h> this document does not apply to Content-Disposition
101    header fields appearing in payload bodies transmitted over HTTP, such as
102    when using the media type "multipart/form-data" (<xref target="RFC2388"/>).
103  </t>
104</x:note>
105</section> 
106
107<section title="Notational Conventions" anchor="notational.conventions">
108<t>
109  The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
110  "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document
111  are to be interpreted as described in <xref target="RFC2119"/>.
112</t>
113<t>
114  This specification uses the augmented BNF notation defined in
115  <xref target="RFC2616" x:fmt="of" x:sec="2.1"/>, including its rules for
116  implied linear whitespace (LWS).
117</t>
118</section>
119
120<section title="Conformance and Error Handling" anchor="conformance.and.error.handling">
121<t>
122  This specification defines conformance criteria for both senders (usually,
123  HTTP origin servers) and recipients (usually, HTTP user agents) of the
124  Content-Disposition header field. An implementation is considered conformant if
125  it complies with all of the requirements associated with its role.
126</t>
127<t>
128  This specification also defines certain forms of the header field-value to be
129  invalid, using both ABNF and prose requirements, but it does not define
130  special handling of these invalid field-values.
131</t>
132<t>
133  Senders &MUST-NOT; generate Content-Disposition header fields that are
134  invalid.
135</t>
136<t>
137  Recipients &MAY; take steps to recover a usable field-value
138  from an invalid header field, but &SHOULD-NOT; reject the message outright,
139  unless this is explicitly desirable behaviour (e.g., the implementation is a
140  validator). As such, the default handling of invalid fields is to ignore them.
141</t>
142</section>
143
144<section title="Header Field Definition" anchor="header.field.definition">
145  <iref item="Header Fields" subitem="Content-Disposition" primary="true" x:for-anchor=""/>
146  <iref item="Content-Disposition header field" primary="true" x:for-anchor=""/>
147<t>
148  The Content-Disposition response header field is used to convey additional
149  information about how to process the response payload, and also can be used
150  to attach additional metadata, such as the filename to use when saving the
151  response payload locally.
152</t>
153
154<section title="Grammar">
155<figure><artwork type="abnf2616">
156  content-disposition = "Content-Disposition" ":"
157                         disposition-type *( ";" disposition-parm )
158
159  disposition-type    = "inline" | "attachment" | disp-ext-type
160                      ; case-insensitive
161  disp-ext-type       = token
162
163  disposition-parm    = filename-parm | disp-ext-parm
164
165  filename-parm       = "filename" "=" value
166                      | "filename*" "=" ext-value
167 
168  disp-ext-parm       = token "=" value
169                      | ext-token "=" ext-value
170  ext-token           = &lt;the characters in token, followed by "*"&gt;
171</artwork></figure>
172
173<figure>
174<preamble>Defined in <xref target="RFC2616"/>:</preamble>
175<artwork type="abnf2616">
176  token         = &lt;token, defined in <xref target="RFC2616" x:fmt="," x:sec="2.2"/>&gt;
177  quoted-string = &lt;quoted-string, defined in <xref target="RFC2616" x:fmt="," x:sec="2.2"/>&gt;
178  value         = &lt;value, defined in <xref target="RFC2616" x:fmt="," x:sec="3.6"/>&gt;
179                ; token | quoted-string
180             
181</artwork></figure>
182<figure>
183<preamble>Defined in <xref target="RFC5987"/>:</preamble>
184<artwork type="abnf2616">
185  ext-value   = &lt;ext-value, defined in <xref target="RFC5987" x:sec="3.2"/>&gt;
186</artwork></figure>
187<t>
188  Header field values with multiple instances of the same parameter name are
189  invalid.
190</t>
191<t>
192  Note that due to the rules for implied linear whitespace
193  (<xref target="RFC2616" x:fmt="of" x:sec="2.1"/>), &OPTIONAL; whitespace can
194  appear between words (token or quoted-string) and separator characters.
195</t>
196<t>
197  Furthermore note that the format used for ext-value allows specifying a
198  natural language; this is of limited use for filenames and is likely to be
199  ignored by recipients.
200</t>
201</section>
202
203<section title="Disposition Type" anchor="disposition.type">
204<t>
205  If the disposition type matches "attachment" (case-insensitively), this
206  indicates that the recipient should prompt the user to save the response
207  locally, rather than process it normally (as per its media type).
208</t>
209<t>
210  On the other hand, if it matches "inline" (case-insensitively), this implies
211  default processing. Therefore, the disposition type "inline" is only useful
212  when it is augmented with additional parameters, such as the filename (see
213  below).
214</t>
215<t>
216  Unknown or unhandled disposition types &SHOULD; be handled by recipients the
217  same way as "attachment" (see also <xref target="RFC2183" x:fmt="," x:sec="2.8"/>).
218</t>
219</section>
220
221<section title="Disposition Parameter: 'Filename'" anchor="disposition.parameter.filename">
222<t>
223  The parameters "filename" and "filename*", to be matched case-insensitively,
224  provide information on how to construct a filename for storing the message
225  payload.
226</t>
227<t>
228  Depending on the disposition type, this information might be used right away
229  (in the "save as..." interaction caused for the "attachment" disposition type),
230  or later on (for instance, when the user decides to save the contents of the
231  current page being displayed).
232</t>
233<t>
234  The parameters "filename" and "filename*" differ only in that "filename*" uses
235  the encoding defined in <xref target="RFC5987"/>, allowing the use
236  of characters not present in the ISO-8859-1 character set (<xref target="ISO-8859-1"/>).
237</t>
238<t>
239  Many user agent implementations predating this specification
240  do not understand the "filename*" parameter. Therefore, when both "filename"
241  and "filename*" are present in a single header field value, recipients
242  &SHOULD; pick "filename*" and ignore "filename". This way, senders
243  can avoid special-casing specific user agents by sending both the
244  more expressive "filename*" parameter, and the "filename" parameter
245  as fallback for legacy recipients (see <xref target="examples"/> for
246  an example).
247</t>
248<t>
249  It is essential that recipients treat the specified filename as advisory
250  only, thus be very careful in extracting the desired information.
251  In particular:
252  <list style="symbols">
253    <x:lt><t>
254      When the value contains path separator characters ("\" or "/"),
255      recipients &SHOULD; ignore all but the last path segment (the actual
256      filename). This prevents
257      unintentional overwriting of well-known file system locations (such as
258      "/etc/passwd").
259    </t></x:lt>
260    <x:lt><t>
261      Many platforms do not use Internet Media Types (<xref target="RFC2046"/>)
262      to hold type information in the file system, but rely on filename
263      extensions instead. Trusting the server-provided file extension could
264      introduce a privilege escalation when the saved file is later opened
265      (consider ".exe"). Thus, recipients &SHOULD; ensure that a file extension
266      is used that is safe, optimally matching the media type of the received
267      payload.
268    </t></x:lt>
269    <x:lt><t>
270      Recipients &SHOULD; strip or replace character sequences that are
271      known to cause confusion both in user interfaces and in filenames, such as
272      control characters and leading and trailing whitespace.
273    </t></x:lt>
274    <x:lt><t>
275      Other aspects recipients need to be aware of are names that have a
276      special meaning in the file system or in shell commands, such as "." and "..",
277      "~", "|", and also device names. Recipients &SHOULD; ignore or substitute
278      names like these.
279    </t></x:lt>
280  </list>
281</t>
282<x:note>
283  <t>
284    <x:h>Note:</x:h> Many user agents do not properly handle the escape
285    character "\" when using the quoted-string form. Furthermore, some user agents
286    erroneously try to perform unescaping of "percent" escapes (see
287    <xref target="alternatives.percent"/>), and thus might misinterpret
288    filenames containing the percent character followed by two hex digits.
289  </t>
290</x:note>
291</section>
292
293<section title="Disposition Parameter: Extensions" anchor="disposition.parameter.extensions">
294<t>
295  To enable future extensions, recipients &SHOULD; ignore unrecognized
296  parameters (see also <xref target="RFC2183" x:fmt="," x:sec="2.8"/>).
297</t>
298</section>
299
300<section title="Extensibility" anchor="extensibility">
301<t>
302  Note that <xref target="RFC2183" x:fmt="of" x:sec="9"/> defines IANA registries both
303  for disposition types and disposition parameters. This registry is
304  shared by different protocols using Content-Disposition, such as MIME and HTTP.
305  Therefore, not all registered values may make sense in the context of HTTP.
306</t>
307</section>
308
309</section> 
310
311<section title="Examples" anchor="examples">
312
313<figure>
314<preamble>
315Direct UA to show "save as" dialog, with a filename of "example.html": 
316</preamble>
317<artwork type="example">
318Content-Disposition: Attachment; filename=example.html
319</artwork></figure>
320<figure>
321<preamble>
322Direct UA to behave as if the Content-Disposition header field wasn't present,
323but to remember the filename "an example.html" for a subsequent save operation:
324</preamble>
325<artwork type="example" x:indent-with="  ">
326Content-Disposition: INLINE; FILENAME= "an example.html"
327</artwork>
328<postamble>
329  Note: this uses the quoted-string form so that the space character
330  can be included.
331</postamble>
332</figure>
333<figure>
334<preamble>
335Direct UA to show "save as" dialog, with a filename containing the Unicode character  U+20AC (EURO SIGN):
336</preamble>
337<artwork type="example" x:indent-with="  ">
338Content-Disposition: attachment;
339                     filename*= UTF-8''<x:highlight>%e2%82%ac</x:highlight>%20rates
340</artwork>
341<postamble>
342  Here, the encoding defined in <xref target="RFC5987"/> is also used to encode the
343  non-ISO-8859-1 character.
344</postamble>
345</figure>
346<figure>
347<preamble>
348Same as above, but adding the "filename" parameter for compatibility with
349user agents not implementing RFC 5987:
350</preamble>
351<artwork type="example" x:indent-with="  ">
352Content-Disposition: attachment;
353                     filename="EURO rates";
354                     filename*=utf-8''<x:highlight>%e2%82%ac</x:highlight>%20rates
355</artwork>
356<postamble>
357  Note: those user agents that do not support the RFC 5987 encoding ignore
358  "filename*" when it occurs after "filename".
359</postamble>
360</figure>
361
362</section>
363
364<section title="Internationalization Considerations" anchor="i18n">
365<t>
366  The "filename*" parameter (<xref target="disposition.parameter.filename"/>),
367  using the encoding defined in <xref target="RFC5987"/>, allows the
368  server to transmit characters outside the ISO-8859-1 character set,
369  and also to optionally specify the language in use.
370</t>
371<t>
372  Future parameters might also require internationalization, in which case
373  the same encoding can be used.
374</t>
375</section>
376
377<section title="Security Considerations" anchor="security.considerations">
378<t>
379  Using server-supplied information for constructing local filenames introduces
380  many risks. These are summarized in <xref target="disposition.parameter.filename"/>.
381</t>
382<t>
383  Furthermore, implementers also ought to be aware of the Security
384  Considerations applying to HTTP (see <xref target="RFC2616" x:fmt="of" x:sec="15"/>), and also the parameter encoding defined in <xref target="RFC5987"/>
385  (see <xref target="RFC5987" x:fmt="sec" x:sec="5"/>).
386</t>
387</section> 
388
389<section title="IANA Considerations" anchor="iana.considerations">
390
391<section title="Registry for Disposition Values and Parameter" anchor="registry">
392<t>
393  This specification does not introduce any changes to the registration
394  procedures for disposition values and parameters that are defined in
395  <xref target="RFC2183" x:fmt="of" x:sec="9"/>.
396</t>
397</section>
398
399<section title="Header Field Registration" anchor="header.field.registration"> 
400<t>
401  This document updates the definition of the Content-Disposition HTTP header field
402  in the permanent HTTP header field registry (see <xref target="RFC3864"/>).
403</t>
404<t>
405<list style="hanging">
406  <t hangText="Header field name:">Content-Disposition</t>
407  <t hangText="Applicable protocol:">http</t>
408  <t hangText="Status:">standard</t>
409  <t hangText="Author/Change controller:">IETF</t>
410  <t hangText="Specification document:">this specification (<xref target="header.field.definition"/>)</t>
411</list>
412</t>
413</section>
414
415</section> 
416
417<section title="Acknowledgements">
418<t>
419  Thanks to Adam Barth, Rolf Eike Beer, Bjoern Hoehrmann, Alfred Hoenes, Roar Lauritzsen,
420  Henrik Nordstrom, and Mark Nottingham for their valuable feedback.
421</t>
422</section> 
423
424  </middle>
425  <back>
426 
427<references title="Normative References">
428 
429  <reference anchor="RFC2119">
430    <front>
431      <title abbrev="RFC Key Words">Key words for use in RFCs to Indicate Requirement Levels</title>
432      <author initials="S." surname="Bradner" fullname="Scott Bradner">
433        <organization>Harvard University</organization>
434        <address><email>sob@harvard.edu</email></address>
435      </author>
436      <date month="March" year="1997"/>
437      <area>General</area>
438      <keyword>keyword</keyword>
439    </front>
440    <seriesInfo name="BCP" value="14"/>
441    <seriesInfo name="RFC" value="2119"/>
442  </reference>
443
444  <reference anchor="RFC2616">
445    <front>
446      <title>Hypertext Transfer Protocol -- HTTP/1.1</title>
447      <author initials="R." surname="Fielding" fullname="R. Fielding">
448        <organization>University of California, Irvine</organization>
449        <address><email>fielding@ics.uci.edu</email></address>
450      </author>
451      <author initials="J." surname="Gettys" fullname="J. Gettys">
452        <organization>W3C</organization>
453        <address><email>jg@w3.org</email></address>
454      </author>
455      <author initials="J." surname="Mogul" fullname="J. Mogul">
456        <organization>Compaq Computer Corporation</organization>
457        <address><email>mogul@wrl.dec.com</email></address>
458      </author>
459      <author initials="H." surname="Frystyk" fullname="H. Frystyk">
460        <organization>MIT Laboratory for Computer Science</organization>
461        <address><email>frystyk@w3.org</email></address>
462      </author>
463      <author initials="L." surname="Masinter" fullname="L. Masinter">
464        <organization>Xerox Corporation</organization>
465        <address><email>masinter@parc.xerox.com</email></address>
466      </author>
467      <author initials="P." surname="Leach" fullname="P. Leach">
468        <organization>Microsoft Corporation</organization>
469        <address><email>paulle@microsoft.com</email></address>
470      </author>
471      <author initials="T." surname="Berners-Lee" fullname="T. Berners-Lee">
472        <organization>W3C</organization>
473        <address><email>timbl@w3.org</email></address>
474      </author>
475      <date month="June" year="1999"/>
476    </front>
477    <seriesInfo name="RFC" value="2616"/>
478  </reference>
479
480  <reference anchor="RFC5987">
481        <front>
482      <title>Character Set and Language Encoding for Hypertext Transfer Protocol (HTTP) Header Field Parameters</title>
483      <author initials="J. F." surname="Reschke" fullname="Julian F. Reschke">
484        <organization abbrev="greenbytes">greenbytes GmbH</organization>
485        <address>
486          <postal>
487            <street>Hafenweg 16</street>
488            <city>Muenster</city><region>NW</region><code>48155</code>
489            <country>Germany</country>
490          </postal>
491          <email>julian.reschke@greenbytes.de</email>   
492          <uri>http://greenbytes.de/tech/webdav/</uri> 
493        </address>
494      </author>
495      <date month="August" year="2010"/>
496    </front>
497    <seriesInfo name="RFC" value="5987"/>
498  </reference>
499
500  <reference anchor="ISO-8859-1">
501    <front>
502      <title>Information technology -- 8-bit single-byte coded graphic character sets -- Part 1: Latin alphabet No. 1</title>
503      <author>
504        <organization>International Organization for Standardization</organization>
505      </author>
506      <date year="1998"/>
507    </front>
508    <seriesInfo name="ISO/IEC" value="8859-1:1998"/>
509  </reference>
510
511</references>
512 
513<references title="Informative References">
514
515  <reference anchor="RFC2046">
516    <front>
517      <title abbrev="Media Types">Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types</title>
518      <author initials="N." surname="Freed" fullname="Ned Freed">
519        <organization>Innosoft International, Inc.</organization>
520        <address><email>ned@innosoft.com</email></address>
521      </author>
522      <author initials="N." surname="Borenstein" fullname="Nathaniel S. Borenstein">
523        <organization>First Virtual Holdings</organization>
524        <address><email>nsb@nsb.fv.com</email></address>
525      </author>
526      <date month="November" year="1996"/>
527    </front>
528    <seriesInfo name="RFC" value="2046"/>
529  </reference>
530
531  <reference anchor="RFC2047">
532    <front>
533      <title abbrev="Message Header Extensions">MIME (Multipurpose Internet Mail Extensions) Part Three: Message Header Extensions for Non-ASCII Text</title>
534      <author initials="K." surname="Moore" fullname="Keith Moore">
535        <organization>University of Tennessee</organization>
536        <address><email>moore@cs.utk.edu</email></address>
537      </author>
538      <date month="November" year="1996"/>
539    </front>
540    <seriesInfo name="RFC" value="2047"/>
541  </reference>
542
543  <reference anchor="RFC2183">
544    <front>
545      <title abbrev="Content-Disposition">Communicating Presentation Information in Internet Messages: The Content-Disposition Header Field</title>
546      <author initials="R." surname="Troost" fullname="Rens Troost">
547        <organization>New Century Systems</organization>
548        <address><email>rens@century.com</email></address>
549      </author>
550      <author initials="S." surname="Dorner" fullname="Steve Dorner">
551        <organization>QUALCOMM Incorporated</organization>
552        <address><email>sdorner@qualcomm.com</email></address>
553      </author>
554      <author initials="K." surname="Moore" fullname="Keith Moore">
555        <organization>Department of Computer Science</organization>
556        <address><email>moore@cs.utk.edu</email></address>
557      </author>
558      <date year="1997" month="August"/>
559    </front>
560    <seriesInfo name="RFC" value="2183"/>
561  </reference>
562
563  <reference anchor="RFC2231">
564    <front>
565      <title abbrev="MIME Value and Encoded Word Extensions">MIME Parameter Value and Encoded Word Extensions: Character Sets, Languages, and Continuations</title>
566      <author initials="N." surname="Freed" fullname="Ned Freed">
567        <organization abbrev="Innosoft">Innosoft International, Inc.</organization>
568        <address><email>ned.freed@innosoft.com</email></address>
569      </author>
570      <author initials="K." surname="Moore" fullname="Keith Moore">
571        <organization>University of Tennessee</organization>
572        <address><email>moore@cs.utk.edu</email></address>
573      </author>
574      <date year="1997" month="November"/>
575    </front>
576    <seriesInfo name="RFC" value="2231"/>
577  </reference>
578
579  <reference anchor="RFC2388">
580    <front>
581      <title abbrev="multipart/form-data">Returning Values from Forms: multipart/form-data</title>
582      <author initials="L." surname="Masinter" fullname="Larry Masinter">
583        <organization>Xerox Palo Alto Research Center</organization>
584        <address>
585          <email>masinter@parc.xerox.com</email>
586        </address>
587      </author>
588      <date year="1998" month="August"/>
589    </front>
590    <seriesInfo name="RFC" value="2388"/>
591  </reference>
592<!--
593  <reference anchor="RFC3629">
594    <front>
595      <title>UTF-8, a transformation format of ISO 10646</title>
596      <author initials="F." surname="Yergeau" fullname="F. Yergeau">
597        <organization>Alis Technologies</organization>
598        <address><email>fyergeau@alis.com</email></address>
599      </author>
600      <date month="November" year="2003"/>
601    </front>
602    <seriesInfo name="STD" value="63"/>
603    <seriesInfo name="RFC" value="3629"/>
604  </reference>-->
605
606  <reference anchor="RFC3864">
607    <front>
608      <title>Registration Procedures for Message Header Fields</title>
609      <author initials="G." surname="Klyne" fullname="G. Klyne">
610        <organization>Nine by Nine</organization>
611        <address><email>GK-IETF@ninebynine.org</email></address>
612      </author>
613      <author initials="M." surname="Nottingham" fullname="M. Nottingham">
614        <organization>BEA Systems</organization>
615        <address><email>mnot@pobox.com</email></address>
616      </author>
617      <author initials="J." surname="Mogul" fullname="J. Mogul">
618        <organization>HP Labs</organization>
619        <address><email>JeffMogul@acm.org</email></address>
620      </author>
621      <date year="2004" month="September"/>
622    </front>
623    <seriesInfo name="BCP" value="90"/>
624    <seriesInfo name="RFC" value="3864"/>
625  </reference>
626
627  <reference anchor="RFC3986">
628   <front>
629    <title abbrev="URI Generic Syntax">Uniform Resource Identifier (URI): Generic Syntax</title>
630    <author initials="T." surname="Berners-Lee" fullname="Tim Berners-Lee">
631      <organization abbrev="W3C/MIT">World Wide Web Consortium</organization>
632      <address>
633         <email>timbl@w3.org</email>
634         <uri>http://www.w3.org/People/Berners-Lee/</uri>
635      </address>
636    </author>
637    <author initials="R." surname="Fielding" fullname="Roy T. Fielding">
638      <organization abbrev="Day Software">Day Software</organization>
639      <address>
640        <email>fielding@gbiv.com</email>
641        <uri>http://roy.gbiv.com/</uri>
642      </address>
643    </author>
644    <author initials="L." surname="Masinter" fullname="Larry Masinter">
645      <organization abbrev="Adobe Systems">Adobe Systems Incorporated</organization>
646      <address>
647        <email>LMM@acm.org</email>
648        <uri>http://larry.masinter.net/</uri>
649      </address>
650    </author>
651    <date month="January" year="2005"/>
652   </front>
653   <seriesInfo name="STD" value="66"/>
654   <seriesInfo name="RFC" value="3986"/>
655  </reference>
656
657</references>
658
659<section title="Changes from the RFC 2616 Definition" anchor="changes.from.rfc2616">
660<t>
661  Compared to <xref target="RFC2616" x:fmt="of" x:sec="19.5.1"/>, the following
662  normative changes reflecting actual implementations have been made:
663<list style="symbols">
664  <t>
665    According to RFC 2616, the disposition type "attachment" only applies to
666    content of type "application/octet-stream". This restriction has been
667    removed, because recipients in practice do not check the content type, and
668    it also discourages properly declaring the media type.
669  </t>
670  <t>
671    RFC 2616 only allows "quoted-string" for the filename parameter. This
672    would be an exceptional parameter syntax, and also doesn't reflect actual
673    use.
674  </t>
675  <t>
676    The definition for the disposition type "inline" (<xref target="RFC2183" x:fmt="," x:sec="2.1"/>)
677    has been re-added with a suggestion for its processing.
678  </t>
679  <t>
680    This specification requires support for the extended parameter encoding
681    defined in <xref target="RFC5987"/>.
682  </t>
683</list>
684</t>
685</section>
686
687<section title="Differences compared to RFC 2183" anchor="diffs.compared.to.rfc2183">
688<t>
689  <xref target="RFC2183" x:fmt="of" x:sec="2"/> defines several additional
690  disposition parameters: "creation-date", "modification-date",
691  "quoted-date-time", and "size". The majority of user agents does not implement
692  these, thus they have been omitted from this specification.
693</t>
694</section>
695
696<section title="Alternative Approaches to Internationalization" anchor="alternatives">
697<t>
698  By default, HTTP header field parameters cannot carry characters outside
699  the ISO-8859-1 (<xref target="ISO-8859-1"/>) character encoding (see
700  <xref target="RFC2616" x:fmt="," x:sec="2.2"/>). For the "filename"
701  parameter, this of course is an unacceptable restriction.
702</t>
703<t>
704  Unfortunately, user agent implementers have not managed to come up with
705  an interoperable approach, although the IETF Standards Track specifies
706  exactly one solution (<xref target="RFC2231"/>, clarified and profiled for
707  HTTP in <xref target="RFC5987"/>).
708</t>
709<t>
710  For completeness, the sections below describe the various approaches that
711  have been tried, and explains how they are inferior to the RFC 5987
712  encoding used in this specification.
713</t>
714
715<section title="RFC 2047 Encoding" anchor="alternatives.rfc2047">
716<t>
717  RFC 2047 defines an encoding mechanism for
718  header fields, but this encoding is not supposed to be used for
719  header field parameters - see <xref target="RFC2047" x:fmt="of" x:sec="5"/>: 
720</t>
721<x:blockquote cite="http://tools.ietf.org/html/rfc2047#section-5">
722  <t>
723    An 'encoded-word' MUST NOT appear within a 'quoted-string'.
724  </t>
725  <t>
726    ...
727  </t>
728  <t>
729    An 'encoded-word' MUST NOT be used in parameter of a MIME Content-Type or Content-Disposition field, or in any structured field body except within a 'comment' or 'phrase'.
730  </t>
731</x:blockquote>
732<t>
733  In practice, some user agents implement the encoding, some do not
734  (exposing the encoded string to the user), and some get confused by it.
735</t>
736</section>
737
738<section title="Percent Encoding" anchor="alternatives.percent">
739<t>
740  Some user agents accept percent encoded (<xref target="RFC3986" x:fmt="," x:sec="2.1"/>)
741  sequences of characters. The character encoding being used for decoding
742  depends on various factors, including the encoding of the referring page,
743  the user agent's locale, its configuration, and also the actual value of
744  the parameter.
745</t>
746<t>
747  In practice, this is hard to use because those user agents that do not
748  support it will display the escaped character sequence to the user. For those
749  user agents that do implement this it is difficult to predict what character
750  encoding they actually expect.
751</t>
752</section>
753
754<section title="Encoding Sniffing" anchor="alternatives.sniff">
755<t>
756  Some user agents inspect the value (which defaults to ISO-8859-1 for the
757  quoted-string form) and switch to UTF-8 when it seems to be more likely to be
758  the correct interpretation.
759</t>
760<t>
761  As with the approaches above, this is not interoperable and furthermore
762  risks misinterpreting the actual value.
763</t>
764</section>
765
766<section title="Implementations (to be removed by RFC Editor before publication)" anchor="alternatives.implementations">
767<t>
768  Unfortunately, as of March 2011, neither the encoding defined in RFCs 2231
769  and 5987, nor any of the alternate approaches discussed above was
770  implemented interoperably. Thus, this specification recommends the approach
771  defined in RFC 5987, which at least has the advantage of actually being
772  specified properly.
773</t>
774<t>
775  The table below shows the implementation support for the various approaches:
776</t>
777<texttable align="left">
778  <ttcol>User Agent</ttcol>
779  <ttcol>RFC 2231/5987</ttcol>
780  <ttcol>RFC 2047</ttcol>
781  <ttcol>Percent Encoding</ttcol>
782  <ttcol>Encoding Sniffing</ttcol>
783 
784  <c>Chrome</c>
785  <c>yes</c>
786  <c>yes</c>
787  <c>yes</c>
788  <c>yes</c>
789
790  <c>Firefox</c>
791  <c>yes (*)</c>
792  <c>yes</c>
793  <c>no</c>
794  <c>yes</c>
795
796  <c>Internet Explorer</c>
797  <c>yes (**)</c>
798  <c>no</c>
799  <c>yes</c>
800  <c>no</c>
801
802  <c>Konqueror</c>
803  <c>yes</c>
804  <c>no</c>
805  <c>no</c>
806  <c>no</c>
807
808  <c>Opera</c>
809  <c>yes</c>
810  <c>no</c>
811  <c>no</c>
812  <c>no</c>
813
814  <c>Safari</c>
815  <c>no</c>
816  <c>no</c>
817  <c>no</c>
818  <c>yes</c>
819</texttable>
820
821<t>
822  (*) Does not implement the fallback behavior to "filename" described in
823  <xref target="disposition.parameter.filename"/>; a fix is planned for Firefox 5.
824</t>
825<t>
826  (**) Starting with IE9RC, but only implements UTF-8.
827</t>
828
829</section>
830
831</section>
832
833<section title="Advice on Generating Content-Disposition Header Fields" anchor="advice.generating">
834<t>
835  To successfully interoperate with existing and future user agents, senders of
836  the Content-Disposition header field are advised to:
837</t>
838<t>
839  <list style="symbols">
840    <t>Include a "filename" parameter when US-ASCII is sufficiently
841    expressive.</t>
842    <t>Use the 'token' form of the filename parameter only when it does not
843    contain disallowed characters (e.g., spaces); in such cases, the
844    quoted-string form should be used.</t>
845    <t>Avoid including the percent character followed by two hexadecimal
846    characters (e.g., %A9) in the filename parameter, since some existing
847    implementations consider it to be an escape character, while others will
848    pass it through unchanged.</t>
849    <t>Avoid including the "\" character in the quoted-string form of the
850    filename parameter, as escaping is not implemented by some user agents,
851    and can be considered as an illegal path character.</t>
852    <t>Avoid using non-ASCII characters in the filename parameter. Although
853    most existing implementations will decode them as ISO-8859-1, some
854    will apply heuristics to detect UTF-8, and thus might fail on certain names.</t>
855    <t>Include a "filename*" parameter where the desired filename cannot be
856    expressed faithfully using the "filename" form. Note that legacy user
857    agents will not process this, and will fall back to using the "filename"
858    parameter's content.
859    </t>
860    <t>When a "filename*" parameter is sent, to also generate a "filename"
861    parameter as a fallback for user agents that do not support the "filename*"
862    form, if possible. This can be done by substituting characters with
863    US-ASCII sequences (e.g., Unicode character point U+00E4 (LATIN SMALL
864    LETTER A WITH DIARESIS) by "ae"). Note that this may not be possible in
865    some locales.
866    </t>
867    <t>When a "filename" parameter is included as a fallback (as per above),
868    "filename" should occur first, due to parsing problems in some existing
869    implementations.
870    <cref anchor="fallbackbug" source="jre">
871    Firefox is known to pick the wrong parameter; a bug fix is scheduled for
872    Firefox 5.</cref>
873    </t>
874    <t>Use UTF-8 as the encoding of the "filename*" parameter, when present,
875    because at least one existing implementation only implements that encoding.</t>
876  </list>
877</t>
878<t>
879  Note that this advice is based upon UA behaviour at the time of writing, and
880  might be superseded.
881  <eref target="http://purl.org/NET/http/content-disposition-tests"/> provides
882  an overview of current levels of support in various implementations.
883</t>
884</section>
885
886<section title="Change Log (to be removed by RFC Editor before publication)" anchor="change.log">
887<t>
888  Note: the issues names in the change log entries for draft-reschke-rfc2183-in-http
889  refer to <eref target="http://greenbytes.de/tech/webdav/draft-reschke-rfc2183-in-http-issues.html"/>.
890</t>
891
892<section title="Since draft-reschke-rfc2183-in-http-00">
893<t> 
894  Adjust terminology ("header" -&gt; "header field").
895  Update rfc2231-in-http reference.
896</t>
897</section>
898
899<section title="Since draft-reschke-rfc2183-in-http-01">
900<t> 
901  Update rfc2231-in-http reference. Actually define the "filename"
902  parameter. Add internationalization considerations.
903  Add examples using the RFC 5987 encoding.
904  Add overview over other approaches, plus a table reporting
905  implementation status.
906  Add and resolve issue "nodep2183".
907  Add issues "asciivsiso",
908  "deplboth", "quoted", and "registry".
909</t>
910</section>
911
912<section title="Since draft-reschke-rfc2183-in-http-02">
913<t>
914  Add and close issue "docfallback".
915  Close issues "asciivsiso", "deplboth", "quoted", and
916  "registry".
917</t>
918</section>
919
920<section title="Since draft-reschke-rfc2183-in-http-03">
921<t>
922  Updated to be a Working Draft of the IETF HTTPbis Working Group.
923</t>
924</section>
925
926<section title="Since draft-ietf-httpbis-content-disp-00" anchor="changes.since.00">
927<t>
928  Closed issues:
929  <list style="symbols">
930    <t>
931      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/242"/>:
932      "handling of unknown disposition types"
933    </t>
934  </list>
935</t>
936<t>
937  Slightly updated the notes about the proposed fallback behavior.
938</t>
939</section>
940
941<section title="Since draft-ietf-httpbis-content-disp-01" anchor="changes.since.01">
942<t>
943  Various editorial improvements.
944</t>
945</section>
946
947<section title="Since draft-ietf-httpbis-content-disp-02" anchor="changes.since.02">
948<t>
949  Closed issues:
950  <list style="symbols">
951    <t>
952      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/244"/>:
953      "state that repeating parameters are invalid"
954    </t>
955    <t>
956      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/245"/>:
957      "warn about %xx in filenames being misinterpreted"
958    </t>
959    <t>
960      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/246"/>:
961      "mention control chars when talking about postprecessing the filename parameter"
962    </t>
963  </list>
964</t>
965<t>
966  Update <xref target="alternatives.implementations"/>; Opera 10.63 RC
967  implements the recommended fallback behavior.
968</t>
969</section>
970
971<section title="Since draft-ietf-httpbis-content-disp-03" anchor="changes.since.03">
972<t>
973  Closed issues:
974  <list style="symbols">
975    <t>
976      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/252"/>:
977      "'modification-date' *is* implemented in Konq 4.5"
978    </t>
979    <t>
980      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/253"/>:
981      "clarify what LWS means for the Content-Disp grammar"
982    </t>
983    <t>
984      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/258"/>:
985      "Avoid passive voice in message requirements"
986    </t>
987    <t>
988      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/263"/>:
989      "text about historical percent-decoding unclear"
990    </t>
991    <t>
992      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/264"/>:
993      "add explanation of language tagging"
994    </t>
995    <t>
996      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/265"/>:
997      "Clarify that C-D spec does not apply to multipart upload"
998    </t>
999  </list>
1000</t>
1001</section>
1002
1003<section title="Since draft-ietf-httpbis-content-disp-04" anchor="changes.since.04">
1004<t>
1005  Updated implementation information (Chrome 9 implements RFC 5987, IE 9 RC implements
1006  it for UTF-8 only).
1007</t>
1008<t>
1009  Clarify who requirements are on, add a section discussing conformance
1010  and handling of invalid field values in general.
1011</t>
1012<t>
1013  Closed issues:
1014  <list style="symbols">
1015     <t>
1016      <eref target="http://trac.tools.ietf.org/wg/httpbis/trac/ticket/243"/>:
1017      "avoid stating ISO-8859-1 default for header param" (the default
1018      is still mentioned, but it was clarified what it applies to).
1019    </t>
1020   <t>
1021      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/272"/>:
1022      "Path Separator Characters"
1023    </t>
1024  </list>
1025</t>
1026</section>
1027
1028<section title="Since draft-ietf-httpbis-content-disp-05" anchor="changes.since.05">
1029<t>
1030  Editorial changes:
1031  Fixed two typos where the new Conformance section said "Content-Location" instead
1032  of "Content-Disposition". Cleaned up terminology ("user agent", "recipient",
1033  "sender", "message body", ...). Stated what the escape character for quoted-string
1034  is. Explained a use case for "inline" disposition type. Updated implementation
1035  notes with respect to the fallback behavior.
1036</t>
1037<t>
1038  Added appendix "Advice on Generating Content-Disposition Header Fields".
1039</t>
1040</section>
1041
1042<section title="Since draft-ietf-httpbis-content-disp-06" anchor="changes.since.06">
1043<t>
1044  Closed issues:
1045  <list style="symbols">
1046     <t>
1047      <eref target="http://trac.tools.ietf.org/wg/httpbis/trac/ticket/278"/>:
1048      "conformance language"
1049    </t>
1050  </list>
1051</t>
1052</section>
1053
1054<section title="Since draft-ietf-httpbis-content-disp-07" anchor="changes.since.07">
1055<t>
1056  Clarify that by "last path segment" we mean the actual filename.
1057</t>
1058</section>
1059
1060</section>
1061
1062
1063  </back>
1064
1065</rfc>
Note: See TracBrowser for help on using the repository browser.