1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
|
<pre>
Internet Engineering Task Force (IETF) J. Reschke
Request for Comments: 8187 greenbytes
Obsoletes: <a href="./rfc5987">5987</a> September 2017
Category: Standards Track
ISSN: 2070-1721
<span class="h1">Indicating Character Encoding and Language for HTTP Header Field</span>
<span class="h1">Parameters</span>
Abstract
By default, header field values in Hypertext Transfer Protocol (HTTP)
messages cannot easily carry characters outside the US-ASCII coded
character set. <a href="./rfc2231">RFC 2231</a> defines an encoding mechanism for use in
parameters inside Multipurpose Internet Mail Extensions (MIME) header
field values. This document specifies an encoding suitable for use
in HTTP header fields that is compatible with a simplified profile of
the encoding defined in <a href="./rfc2231">RFC 2231</a>.
This document obsoletes <a href="./rfc5987">RFC 5987</a>.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in <a href="./rfc7841#section-2">Section 2 of RFC 7841</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="https://www.rfc-editor.org/info/rfc8187">https://www.rfc-editor.org/info/rfc8187</a>.
Copyright Notice
Copyright (c) 2017 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="https://trustee.ietf.org/license-info">https://trustee.ietf.org/license-info</a>) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in <a href="#section-4">Section 4</a>.e of
<span class="grey">Reschke Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc8187">RFC 8187</a> Charset/Language Encoding in HTTP September 2017</span>
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
<a href="#section-1">1</a>. Introduction . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-2">2</a>
<a href="#section-2">2</a>. Notational Conventions . . . . . . . . . . . . . . . . . . . <a href="#page-3">3</a>
<a href="#section-3">3</a>. Comparison to <a href="./rfc2231">RFC 2231</a> and Definition of the Encoding . . . . <a href="#page-3">3</a>
<a href="#section-3.1">3.1</a>. Parameter Continuations . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
3.2. Parameter Value Character Encoding and Language
Information . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-3.2.1">3.2.1</a>. Definition . . . . . . . . . . . . . . . . . . . . . <a href="#page-4">4</a>
<a href="#section-3.2.2">3.2.2</a>. Historical Notes . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a>
<a href="#section-3.2.3">3.2.3</a>. Examples . . . . . . . . . . . . . . . . . . . . . . <a href="#page-6">6</a>
<a href="#section-3.3">3.3</a>. Language Specification in Encoded Words . . . . . . . . . <a href="#page-7">7</a>
<a href="#section-4">4</a>. Guidelines for Usage in HTTP Header Field Definitions . . . . <a href="#page-7">7</a>
<a href="#section-4.1">4.1</a>. When to Use the Extension . . . . . . . . . . . . . . . . <a href="#page-8">8</a>
<a href="#section-4.2">4.2</a>. Error Handling . . . . . . . . . . . . . . . . . . . . . <a href="#page-8">8</a>
<a href="#section-5">5</a>. Security Considerations . . . . . . . . . . . . . . . . . . . <a href="#page-9">9</a>
<a href="#section-6">6</a>. IANA Considerations . . . . . . . . . . . . . . . . . . . . . <a href="#page-9">9</a>
<a href="#section-7">7</a>. References . . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-9">9</a>
<a href="#section-7.1">7.1</a>. Normative References . . . . . . . . . . . . . . . . . . <a href="#page-9">9</a>
<a href="#section-7.2">7.2</a>. Informative References . . . . . . . . . . . . . . . . . <a href="#page-10">10</a>
<a href="#appendix-A">Appendix A</a>. Changes from <a href="./rfc5987">RFC 5987</a> . . . . . . . . . . . . . . . <a href="#page-12">12</a>
<a href="#appendix-B">Appendix B</a>. Implementation Report . . . . . . . . . . . . . . . <a href="#page-12">12</a>
Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-13">13</a>
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . <a href="#page-13">13</a>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
Use of characters outside the US-ASCII coded character set
([<a href="./rfc0020" title=""ASCII format for network interchange"">RFC0020</a>]) in HTTP header fields ([<a href="./rfc7230" title=""Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing"">RFC7230</a>]) is non-trivial:
o The HTTP specification discourages use of non-US-ASCII characters
in field values, placing them into the "obs-text" Augmented
Backus-Naur Form (ABNF) production (<a href="./rfc7230#section-3.2">[RFC7230], Section 3.2</a>).
o Furthermore, it stays silent about default character encoding
schemes for field values, so any use of non-US-ASCII characters
would need to be specific to the field definition or would require
some other kind of out-of-band information.
o Finally, some APIs assume a default character encoding scheme in
order to map from the octet sequences (obtained from the HTTP
message) to character sequences: for instance, the XMLHttpRequest
API ([<a href="#ref-XMLHttpRequest">XMLHttpRequest</a>]) uses the Interface Definition Language type
"ByteString", effectively resulting in the ISO-8859-1 character
encoding scheme ([<a href="#ref-ISO-8859-1">ISO-8859-1</a>]) being used.
<span class="grey">Reschke Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc8187">RFC 8187</a> Charset/Language Encoding in HTTP September 2017</span>
On the other hand, <a href="./rfc2231">RFC 2231</a> defines an encoding mechanism for
parameters inside MIME header fields ([<a href="./rfc2231" title=""MIME Parameter Value and Encoded Word Extensions: Character Sets, Languages, and Continuations"">RFC2231</a>]), which, as opposed
to HTTP messages, do need to be sent over non-binary transports.
This document specifies an encoding suitable for use in HTTP header
fields that is compatible with a simplified profile of the encoding
defined in <a href="./rfc2231">RFC 2231</a>. It can be applied to any HTTP header field that
uses the common "parameter" ("name=value") syntax.
This document obsoletes [<a href="./rfc5987" title=""Character Set and Language Encoding for Hypertext Transfer Protocol (HTTP) Header Field Parameters"">RFC5987</a>] and moves it to "Historic" status;
the changes are summarized in <a href="#appendix-A">Appendix A</a>.
Note: In the remainder of this document, <a href="./rfc2231">RFC 2231</a> is only
referenced for the purpose of explaining the choice of features
that were adopted; therefore, they are purely informative.
Note: This encoding does not apply to message payloads transmitted
over HTTP, such as when using the media type "multipart/form-data"
([<a href="./rfc7578" title=""Returning Values from Forms: multipart/ form-data"">RFC7578</a>]).
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Notational Conventions</span>
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in
[<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>].
This specification uses the ABNF notation defined in [<a href="./rfc5234" title=""Augmented BNF for Syntax Specifications: ABNF"">RFC5234</a>]. The
following core rules are included by reference, as defined in
<a href="./rfc5234#appendix-B.1">[RFC5234], Appendix B.1</a>: ALPHA (letters), DIGIT (decimal 0-9), HEXDIG
(hexadecimal 0-9/A-F/a-f), and LWSP (linear whitespace).
This specification uses terminology defined in [<a href="./rfc6365" title=""Terminology Used in Internationalization in the IETF"">RFC6365</a>], namely:
"character encoding scheme" (abbreviated to "character encoding"
below), "charset", and "coded character set".
Note that this differs from <a href="./rfc2231">RFC 2231</a>, which uses the term "character
set" for "character encoding scheme".
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Comparison to <a href="./rfc2231">RFC 2231</a> and Definition of the Encoding</span>
<a href="./rfc2231">RFC 2231</a> defines several extensions to MIME. The sections below
discuss if and how they apply to HTTP header fields.
In short:
o Parameter Continuations aren't needed (<a href="#section-3.1">Section 3.1</a>),
<span class="grey">Reschke Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc8187">RFC 8187</a> Charset/Language Encoding in HTTP September 2017</span>
o Character Encoding and Language Information are useful, therefore
a simple subset is specified (<a href="#section-3.2">Section 3.2</a>), and
o Language Specifications in Encoded Words aren't needed
(<a href="#section-3.3">Section 3.3</a>).
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Parameter Continuations</span>
<a href="./rfc2231#section-3">Section 3 of [RFC2231]</a> defines a mechanism that deals with the length
limitations that apply to MIME headers. These limitations do not
apply to HTTP (<a href="./rfc7231#appendix-A.6">[RFC7231], Appendix A.6</a>).
Thus, parameter continuations are not part of the encoding defined by
this specification.
<span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Parameter Value Character Encoding and Language Information</span>
<a href="./rfc2231#section-4">Section 4 of [RFC2231]</a> specifies how to embed language information
into parameter values and also how to encode non-ASCII characters,
dealing with restrictions both in MIME and HTTP header field
parameters.
However, <a href="./rfc2231">RFC 2231</a> does not specify a mandatory-to-implement character
encoding, making it hard for senders to decide which encoding to use.
Thus, recipients implementing this specification MUST support the
"UTF-8" character encoding [<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>].
Furthermore, <a href="./rfc2231">RFC 2231</a> allows the character encoding information to be
left out. The encoding defined by this specification does not allow
that.
<span class="h4"><a class="selflink" id="section-3.2.1" href="#section-3.2.1">3.2.1</a>. Definition</span>
The presence of extended parameter values is usually indicated by a
parameter name ending in an asterisk character. However, note that
this is just a convention, and that the extended parameter values
need to be explicitly specified in the definition of the header field
using this extension (see <a href="#section-4">Section 4</a>).
The ABNF for extended parameter values is specified below:
<span class="grey">Reschke Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc8187">RFC 8187</a> Charset/Language Encoding in HTTP September 2017</span>
ext-value = charset "'" [ language ] "'" value-chars
; like <a href="./rfc2231">RFC 2231</a>'s <extended-initial-value>
; (see <a href="./rfc2231#section-7">[RFC2231], Section 7</a>)
charset = "UTF-8" / mime-charset
mime-charset = 1*mime-charsetc
mime-charsetc = ALPHA / DIGIT
/ "!" / "#" / "$" / "%" / "&"
/ "+" / "-" / "^" / "_" / "`"
/ "{" / "}" / "~"
; as <mime-charset> in <a href="./rfc2978#section-2.3">Section 2.3 of [RFC2978]</a>
; except that the single quote is not included
; SHOULD be registered in the IANA charset registry
language = <Language-Tag, see <a href="./rfc5646#section-2.1">[RFC5646], Section 2.1</a>>
value-chars = *( pct-encoded / attr-char )
pct-encoded = "%" HEXDIG HEXDIG
; see <a href="./rfc3986#section-2.1">[RFC3986], Section 2.1</a>
attr-char = ALPHA / DIGIT
/ "!" / "#" / "$" / "&" / "+" / "-" / "."
/ "^" / "_" / "`" / "|" / "~"
; token except ( "*" / "'" / "%" )
The value part of an extended parameter (ext-value) is a token that
consists of three parts:
1. the REQUIRED character encoding name (charset),
2. the OPTIONAL language information (language), and
3. a character sequence representing the actual value (value-chars),
separated by single quote characters.
Note that both character encoding names and language tags are
restricted to the US-ASCII coded character set and are matched case-
insensitively (see <a href="./rfc2978#section-2.3">Section 2.3 of [RFC2978]</a> and <a href="./rfc5646#section-2.1.1">Section 2.1.1 of
[RFC5646]</a>).
Inside the value part, characters not contained in attr-char are
encoded into an octet sequence using the specified character
encoding. That octet sequence is then percent-encoded as specified
in <a href="./rfc3986#section-2.1">Section 2.1 of [RFC3986]</a>.
<span class="grey">Reschke Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc8187">RFC 8187</a> Charset/Language Encoding in HTTP September 2017</span>
Producers MUST use the "UTF-8" ([<a href="./rfc3629" title=""UTF-8, a transformation format of ISO 10646"">RFC3629</a>]) character encoding.
Extension character encodings (mime-charset) are reserved for future
use.
Note: Recipients should be prepared to handle encoding errors,
such as malformed or incomplete percent escape sequences, or
non-decodable octet sequences, in a robust manner. This
specification does not mandate any specific behavior; for
instance, the following strategies are all acceptable:
* ignoring the parameter,
* stripping a non-decodable octet sequence, and
* substituting a non-decodable octet sequence by a replacement
character, such as the Unicode character U+FFFD (Replacement
Character).
<span class="h4"><a class="selflink" id="section-3.2.2" href="#section-3.2.2">3.2.2</a>. Historical Notes</span>
The <a href="./rfc7230">RFC 7230</a> token production (<a href="./rfc7230#section-3.2.6">[RFC7230], Section 3.2.6</a>) differs from
the production used in <a href="./rfc2231">RFC 2231</a> (imported from <a href="./rfc2045#section-5.1">Section 5.1 of
[RFC2045]</a>) in that curly braces (i.e., "{" and "}") are excluded.
Thus, these two characters are excluded from the attr-char production
as well.
The <mime-charset> ABNF defined here differs from the one in
<a href="./rfc2978#section-2.3">Section 2.3 of [RFC2978]</a> in that it does not allow the single quote
character (see also RFC Errata ID 1912 [<a href="#ref-Err1912" title=""Erratum ID 1912, RFC 2978"">Err1912</a>]). In practice, no
character encoding names using that character have been registered at
the time of this writing.
For backwards compatibility with <a href="./rfc2231">RFC 2231</a>, the encoding defined by
this specification deviates from common parameter syntax in that the
quoted-string notation is not allowed. Implementations using generic
parser components might not be able to detect the use of quoted-
string notation and thus might accept that format, although invalid,
as well.
[<a id="ref-RFC5987">RFC5987</a>] did require support for ISO-8859-1 ([<a href="#ref-ISO-8859-1">ISO-8859-1</a>]), too; for
compatibility with legacy code, recipients are encouraged to support
this encoding as well.
<span class="h4"><a class="selflink" id="section-3.2.3" href="#section-3.2.3">3.2.3</a>. Examples</span>
Non-extended notation, using "token":
foo: bar; title=Economy
<span class="grey">Reschke Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc8187">RFC 8187</a> Charset/Language Encoding in HTTP September 2017</span>
Non-extended notation, using "quoted-string":
foo: bar; title="US-$ rates"
Extended notation, using the Unicode character U+00A3 ("£", POUND
SIGN):
foo: bar; title*=utf-8'en'%C2%A3%20rates
Note: The Unicode pound sign character U+00A3 was encoded into the
octet sequence C2 A3 using the UTF-8 character encoding, and then
percent-encoded. Also, note that the space character was encoded as
%20, as it is not contained in attr-char.
Extended notation, using the Unicode characters U+00A3 ("£", POUND
SIGN) and U+20AC ("€", EURO SIGN):
foo: bar; title*=UTF-8''%c2%a3%20and%20%e2%82%ac%20rates
Note: The Unicode pound sign character U+00A3 was encoded into the
octet sequence C2 A3 using the UTF-8 character encoding, and then
percent-encoded. Likewise, the Unicode euro sign character U+20AC
was encoded into the octet sequence E2 82 AC, and then percent-
encoded. Also note that HEXDIG allows both lowercase and uppercase
characters, so recipients must understand both, and that the language
information is optional, while the character encoding is not.
<span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>. Language Specification in Encoded Words</span>
<a href="./rfc2231#section-5">Section 5 of [RFC2231]</a> extends the encoding defined in [<a href="./rfc2047" title=""MIME (Multipurpose Internet Mail Extensions) Part Three: Message Header Extensions for Non-ASCII Text"">RFC2047</a>] to
also support language specification in encoded words. <a href="./rfc2616">RFC 2616</a>, the
now-obsolete HTTP/1.1 specification, did refer to <a href="./rfc2047">RFC 2047</a>
(<a href="./rfc2616#section-2.2">[RFC2616], Section 2.2</a>). However, it wasn't clear to which header
field it applied. Consequently, the current revision of the HTTP/1.1
specification has deprecated use of the encoding forms defined in <a href="./rfc2047">RFC</a>
<a href="./rfc2047">2047</a> (see <a href="./rfc7230#section-3.2.4">Section 3.2.4 of [RFC7230]</a>).
Thus, this specification does not include this feature.
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Guidelines for Usage in HTTP Header Field Definitions</span>
Specifications of HTTP header fields that use the extensions defined
in <a href="#section-3.2">Section 3.2</a> ought to clearly state that. A simple way to achieve
this is to normatively reference this specification and to include
the ext-value production into the ABNF for specific header field
parameters.
<span class="grey">Reschke Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc8187">RFC 8187</a> Charset/Language Encoding in HTTP September 2017</span>
For instance:
foo = token ";" LWSP title-param
title-param = "title" LWSP "=" LWSP value
/ "title*" LWSP "=" LWSP ext-value
ext-value = <see <a href="./rfc8187#section-3.2">RFC 8187, Section 3.2</a>>
Note: The Parameter Value Continuation feature defined in
<a href="./rfc2231#section-3">Section 3 of [RFC2231]</a> makes it impossible to have multiple
instances of extended parameters with identical names, as the
processing of continuations would become ambiguous. Thus,
specifications using this extension are advised to disallow this
case for compatibility with <a href="./rfc2231">RFC 2231</a>.
Note: This specification does not automatically assign a new
interpretation to parameter names ending in an asterisk. As
pointed out above, it's up to the specification for the
non-extended parameter to "opt in" to the syntax defined here.
That being said, some existing implementations are known to
automatically switch to using this notation when a parameter name
ends with an asterisk; thus, using parameter names ending in an
asterisk for something else is likely to cause interoperability
problems.
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. When to Use the Extension</span>
<a href="./rfc2277#section-4.2">Section 4.2 of [RFC2277]</a> requires that protocol elements containing
human-readable text be able to carry language information. Thus, the
ext-value production ought to always be used when the parameter value
is of a textual nature and its language is known.
Furthermore, the extension ought to also be used whenever the
parameter value needs to carry characters not present in the US-ASCII
coded character set ([<a href="./rfc0020" title=""ASCII format for network interchange"">RFC0020</a>]); note that it would be unacceptable
to define a new parameter that would be restricted to a subset of the
Unicode character set.
<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. Error Handling</span>
Header field specifications need to define whether multiple instances
of parameters with identical names are allowed and how they should be
processed. This specification suggests that a parameter using the
extended syntax takes precedence. This would allow producers to use
both formats without breaking recipients that do not understand the
extended syntax yet.
<span class="grey">Reschke Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc8187">RFC 8187</a> Charset/Language Encoding in HTTP September 2017</span>
Example:
foo: bar; title="EURO exchange rates";
title*=utf-8''%e2%82%ac%20exchange%20rates
In this case, the sender provides an ASCII version of the title for
legacy recipients, but also includes an internationalized version for
recipients understanding this specification -- the latter obviously
ought to prefer the new syntax over the old one.
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Security Considerations</span>
The format described in this document makes it possible to transport
non-ASCII characters, and thus enables character "spoofing" scenarios
in which a displayed value appears to be something other than it is.
Furthermore, there are known attack scenarios related to decoding
UTF-8.
See <a href="./rfc3629#section-10">Section 10 of [RFC3629]</a> for more information on both topics.
In addition, the extension specified in this document makes it
possible to transport multiple language variants for a single
parameter, and such use might allow spoofing attacks where different
language versions of the same parameter are not equivalent. Whether
this attack is effective as an attack depends on the parameter
specified.
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. IANA Considerations</span>
This document does not require any IANA actions.
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. References</span>
<span class="h3"><a class="selflink" id="section-7.1" href="#section-7.1">7.1</a>. Normative References</span>
[<a id="ref-RFC0020">RFC0020</a>] Cerf, V., "ASCII format for network interchange", STD 80,
<a href="./rfc20">RFC 20</a>, DOI 10.17487/RFC0020, October 1969,
<<a href="https://www.rfc-editor.org/info/rfc20">https://www.rfc-editor.org/info/rfc20</a>>.
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>,
DOI 10.17487/RFC2119, March 1997,
<<a href="https://www.rfc-editor.org/info/rfc2119">https://www.rfc-editor.org/info/rfc2119</a>>.
[<a id="ref-RFC2978">RFC2978</a>] Freed, N. and J. Postel, "IANA Charset Registration
Procedures", <a href="https://www.rfc-editor.org/bcp/bcp19">BCP 19</a>, <a href="./rfc2978">RFC 2978</a>, DOI 10.17487/RFC2978,
October 2000, <<a href="https://www.rfc-editor.org/info/rfc2978">https://www.rfc-editor.org/info/rfc2978</a>>.
<span class="grey">Reschke Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc8187">RFC 8187</a> Charset/Language Encoding in HTTP September 2017</span>
[<a id="ref-RFC3629">RFC3629</a>] Yergeau, F., "UTF-8, a transformation format of ISO
10646", STD 63, <a href="./rfc3629">RFC 3629</a>, DOI 10.17487/RFC3629, November
2003, <<a href="https://www.rfc-editor.org/info/rfc3629">https://www.rfc-editor.org/info/rfc3629</a>>.
[<a id="ref-RFC3986">RFC3986</a>] Berners-Lee, T., Fielding, R., and L. Masinter, "Uniform
Resource Identifier (URI): Generic Syntax", STD 66,
<a href="./rfc3986">RFC 3986</a>, DOI 10.17487/RFC3986, January 2005,
<<a href="https://www.rfc-editor.org/info/rfc3986">https://www.rfc-editor.org/info/rfc3986</a>>.
[<a id="ref-RFC5234">RFC5234</a>] Crocker, D., Ed. and P. Overell, "Augmented BNF for Syntax
Specifications: ABNF", STD 68, <a href="./rfc5234">RFC 5234</a>,
DOI 10.17487/RFC5234, January 2008,
<<a href="https://www.rfc-editor.org/info/rfc5234">https://www.rfc-editor.org/info/rfc5234</a>>.
[<a id="ref-RFC5646">RFC5646</a>] Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying
Languages", <a href="https://www.rfc-editor.org/bcp/bcp47">BCP 47</a>, <a href="./rfc5646">RFC 5646</a>, DOI 10.17487/RFC5646,
September 2009, <<a href="https://www.rfc-editor.org/info/rfc5646">https://www.rfc-editor.org/info/rfc5646</a>>.
[<a id="ref-RFC7230">RFC7230</a>] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer
Protocol (HTTP/1.1): Message Syntax and Routing",
<a href="./rfc7230">RFC 7230</a>, DOI 10.17487/RFC7230, June 2014,
<<a href="https://www.rfc-editor.org/info/rfc7230">https://www.rfc-editor.org/info/rfc7230</a>>.
[<a id="ref-RFC7231">RFC7231</a>] Fielding, R., Ed. and J. Reschke, Ed., "Hypertext Transfer
Protocol (HTTP/1.1): Semantics and Content", <a href="./rfc7231">RFC 7231</a>,
DOI 10.17487/RFC7231, June 2014,
<<a href="https://www.rfc-editor.org/info/rfc7231">https://www.rfc-editor.org/info/rfc7231</a>>.
<span class="h3"><a class="selflink" id="section-7.2" href="#section-7.2">7.2</a>. Informative References</span>
[<a id="ref-Err1912">Err1912</a>] RFC Errata, "Erratum ID 1912, <a href="./rfc2978">RFC 2978</a>",
<<a href="https://www.rfc-editor.org/errata/eid1912">https://www.rfc-editor.org/errata/eid1912</a>>.
[<a id="ref-ISO-8859-1">ISO-8859-1</a>]
International Organization for Standardization,
"Information technology -- 8-bit single-byte coded graphic
character sets -- Part 1: Latin alphabet No. 1", ISO/
IEC 8859-1:1998, 1998.
[<a id="ref-RFC2045">RFC2045</a>] Freed, N. and N. Borenstein, "Multipurpose Internet Mail
Extensions (MIME) Part One: Format of Internet Message
Bodies", <a href="./rfc2045">RFC 2045</a>, DOI 10.17487/RFC2045, November 1996,
<<a href="https://www.rfc-editor.org/info/rfc2045">https://www.rfc-editor.org/info/rfc2045</a>>.
[<a id="ref-RFC2047">RFC2047</a>] Moore, K., "MIME (Multipurpose Internet Mail Extensions)
Part Three: Message Header Extensions for Non-ASCII Text",
<a href="./rfc2047">RFC 2047</a>, DOI 10.17487/RFC2047, November 1996,
<<a href="https://www.rfc-editor.org/info/rfc2047">https://www.rfc-editor.org/info/rfc2047</a>>.
<span class="grey">Reschke Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc8187">RFC 8187</a> Charset/Language Encoding in HTTP September 2017</span>
[<a id="ref-RFC2231">RFC2231</a>] Freed, N. and K. Moore, "MIME Parameter Value and Encoded
Word Extensions: Character Sets, Languages, and
Continuations", <a href="./rfc2231">RFC 2231</a>, DOI 10.17487/RFC2231, November
1997, <<a href="https://www.rfc-editor.org/info/rfc2231">https://www.rfc-editor.org/info/rfc2231</a>>.
[<a id="ref-RFC2277">RFC2277</a>] Alvestrand, H., "IETF Policy on Character Sets and
Languages", <a href="https://www.rfc-editor.org/bcp/bcp18">BCP 18</a>, <a href="./rfc2277">RFC 2277</a>, DOI 10.17487/RFC2277,
January 1998, <<a href="https://www.rfc-editor.org/info/rfc2277">https://www.rfc-editor.org/info/rfc2277</a>>.
[<a id="ref-RFC2616">RFC2616</a>] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
Transfer Protocol -- HTTP/1.1", <a href="./rfc2616">RFC 2616</a>,
DOI 10.17487/RFC2616, June 1999,
<<a href="https://www.rfc-editor.org/info/rfc2616">https://www.rfc-editor.org/info/rfc2616</a>>.
[<a id="ref-RFC5987">RFC5987</a>] Reschke, J., "Character Set and Language Encoding for
Hypertext Transfer Protocol (HTTP) Header Field
Parameters", <a href="./rfc5987">RFC 5987</a>, DOI 10.17487/RFC5987, August 2010,
<<a href="https://www.rfc-editor.org/info/rfc5987">https://www.rfc-editor.org/info/rfc5987</a>>.
[<a id="ref-RFC5988">RFC5988</a>] Nottingham, M., "Web Linking", <a href="./rfc5988">RFC 5988</a>,
DOI 10.17487/RFC5988, October 2010,
<<a href="https://www.rfc-editor.org/info/rfc5988">https://www.rfc-editor.org/info/rfc5988</a>>.
[<a id="ref-RFC6266">RFC6266</a>] Reschke, J., "Use of the Content-Disposition Header Field
in the Hypertext Transfer Protocol (HTTP)", <a href="./rfc6266">RFC 6266</a>,
DOI 10.17487/RFC6266, June 2011,
<<a href="https://www.rfc-editor.org/info/rfc6266">https://www.rfc-editor.org/info/rfc6266</a>>.
[<a id="ref-RFC6365">RFC6365</a>] Hoffman, P. and J. Klensin, "Terminology Used in
Internationalization in the IETF", <a href="https://www.rfc-editor.org/bcp/bcp166">BCP 166</a>, <a href="./rfc6365">RFC 6365</a>,
DOI 10.17487/RFC6365, September 2011,
<<a href="https://www.rfc-editor.org/info/rfc6365">https://www.rfc-editor.org/info/rfc6365</a>>.
[<a id="ref-RFC7578">RFC7578</a>] Masinter, L., "Returning Values from Forms: multipart/
form-data", <a href="./rfc7578">RFC 7578</a>, DOI 10.17487/RFC7578, July 2015,
<<a href="https://www.rfc-editor.org/info/rfc7578">https://www.rfc-editor.org/info/rfc7578</a>>.
[<a id="ref-RFC7616">RFC7616</a>] Shekh-Yusef, R., Ed., Ahrens, D., and S. Bremer, "HTTP
Digest Access Authentication", <a href="./rfc7616">RFC 7616</a>,
DOI 10.17487/RFC7616, September 2015,
<<a href="https://www.rfc-editor.org/info/rfc7616">https://www.rfc-editor.org/info/rfc7616</a>>.
[<a id="ref-RFC8053">RFC8053</a>] Oiwa, Y., Watanabe, H., Takagi, H., Maeda, K., Hayashi,
T., and Y. Ioku, "HTTP Authentication Extensions for
Interactive Clients", <a href="./rfc8053">RFC 8053</a>, DOI 10.17487/RFC8053,
January 2017, <<a href="https://www.rfc-editor.org/info/rfc8053">https://www.rfc-editor.org/info/rfc8053</a>>.
<span class="grey">Reschke Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc8187">RFC 8187</a> Charset/Language Encoding in HTTP September 2017</span>
[<a id="ref-XMLHttpRequest">XMLHttpRequest</a>]
WhatWG, "XMLHttpRequest", <<a href="https://xhr.spec.whatwg.org/">https://xhr.spec.whatwg.org/</a>>.
<span class="h2"><a class="selflink" id="appendix-A" href="#appendix-A">Appendix A</a>. Changes from <a href="./rfc5987">RFC 5987</a></span>
This section summarizes the changes compared to [<a href="./rfc5987" title=""Character Set and Language Encoding for Hypertext Transfer Protocol (HTTP) Header Field Parameters"">RFC5987</a>]:
o The document title was changed to "Indicating Character Encoding
and Language for HTTP Header Field Parameters".
o The introduction was rewritten to better explain the issues around
non-ASCII characters in field values.
o The requirement to support the "ISO-8859-1" encoding was removed.
o This document no longer attempts to redefine a generic "parameter"
ABNF (it turned out that there really isn't a generic definition
of parameters in HTTP; for instance, there are subtle differences
with respect to whitespace handling).
o A note about defects in error handling in current implementations
was removed, as it was no longer accurate.
<span class="h2"><a class="selflink" id="appendix-B" href="#appendix-B">Appendix B</a>. Implementation Report</span>
The encoding defined in this document is currently used in four
different HTTP header fields:
o "Authentication-Control", defined in [<a href="./rfc8053" title=""HTTP Authentication Extensions for Interactive Clients"">RFC8053</a>],
o "Authorization" (as used in HTTP Digest Authentication, defined in
[<a href="./rfc7616" title=""HTTP Digest Access Authentication"">RFC7616</a>]),
o "Content-Disposition", defined in [<a href="./rfc6266" title=""Use of the Content-Disposition Header Field in the Hypertext Transfer Protocol (HTTP)"">RFC6266</a>], and
o "Link", defined in [<a href="./rfc5988" title=""Web Linking"">RFC5988</a>].
As the encoding is a profile/clarification of the one defined in
[<a href="./rfc2231" title=""MIME Parameter Value and Encoded Word Extensions: Character Sets, Languages, and Continuations"">RFC2231</a>] in 1997, many user agents already supported it for use in
"Content-Disposition" when [<a href="./rfc5987" title=""Character Set and Language Encoding for Hypertext Transfer Protocol (HTTP) Header Field Parameters"">RFC5987</a>] was published.
Since the publication of [<a href="./rfc5987" title=""Character Set and Language Encoding for Hypertext Transfer Protocol (HTTP) Header Field Parameters"">RFC5987</a>], three more popular desktop user
agents have added support for this encoding; see
<<a href="http://purl.org/NET/http/content-disposition-tests#encoding-2231-char">http://purl.org/NET/http/content-disposition-tests#encoding-</a>
<a href="http://purl.org/NET/http/content-disposition-tests#encoding-2231-char">2231-char</a>> for details. At this time, the current versions of all
major desktop user agents support it.
<span class="grey">Reschke Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc8187">RFC 8187</a> Charset/Language Encoding in HTTP September 2017</span>
Note that the implementation in Internet Explorer 9 does not support
the ISO-8859-1 character encoding; this document revision
acknowledges that UTF-8 is sufficient for expressing all code points
and removes the requirement to support ISO-8859-1.
The "Link" header field, on the other hand, was more recently
specified in [<a href="./rfc5988" title=""Web Linking"">RFC5988</a>]. At the time of this writing, no user agent
except Firefox supported the "title*" parameter (starting with
release 15).
<a href="./rfc7616#section-3.4">Section 3.4 of [RFC7616]</a> defines the "username*" parameter for use in
HTTP Digest Authentication. At the time of writing, no user agent
implemented this extension.
Acknowledgements
Thanks to Martin Dürst and Frank Ellermann for help figuring out ABNF
details, to Graham Klyne and Alexey Melnikov for general review, to
Chris Newman for pointing out an <a href="./rfc2231">RFC 2231</a> incompatibility, and to
Benjamin Carlyle, Roar Lauritzsen, Eric Lawrence, and James Manger
for implementers feedback.
Furthermore, thanks to the members of the IETF HTTP Working Group for
the feedback specific to this update of <a href="./rfc5987">RFC 5987</a>.
Author's Address
Julian F. Reschke
greenbytes GmbH
Hafenweg 16
Münster, NW 48155
Germany
Email: julian.reschke@greenbytes.de
URI: <a href="http://greenbytes.de/tech/webdav/">http://greenbytes.de/tech/webdav/</a>
Reschke Standards Track [Page 13]
</pre>
|
