source: draft-ietf-httpbis/latest/p5-range.xml @ 2121

Last change on this file since 2121 was 2121, checked in by fielding@…, 10 years ago

(editorial) shorten reason phrase for 416 to Range Not Satisfiable

  • Property svn:eol-style set to native
  • Property svn:mime-type set to text/xml
File size: 58.5 KB
Line 
1<?xml version="1.0" encoding="utf-8"?>
2<?xml-stylesheet type='text/xsl' href='../myxml2rfc.xslt'?>
3<!DOCTYPE rfc [
4  <!ENTITY MAY "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>MAY</bcp14>">
5  <!ENTITY MUST "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>MUST</bcp14>">
6  <!ENTITY MUST-NOT "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>MUST NOT</bcp14>">
7  <!ENTITY OPTIONAL "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>OPTIONAL</bcp14>">
8  <!ENTITY RECOMMENDED "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>RECOMMENDED</bcp14>">
9  <!ENTITY REQUIRED "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>REQUIRED</bcp14>">
10  <!ENTITY SHALL "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>SHALL</bcp14>">
11  <!ENTITY SHALL-NOT "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>SHALL NOT</bcp14>">
12  <!ENTITY SHOULD "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>SHOULD</bcp14>">
13  <!ENTITY SHOULD-NOT "<bcp14 xmlns='http://purl.org/net/xml2rfc/ext'>SHOULD NOT</bcp14>">
14  <!ENTITY ID-VERSION "latest">
15  <!ENTITY ID-MONTH "January">
16  <!ENTITY ID-YEAR "2013">
17  <!ENTITY Note "<x:h xmlns:x='http://purl.org/net/xml2rfc/ext'>Note:</x:h>">
18  <!ENTITY architecture               "<xref target='Part1' x:rel='#architecture' xmlns:x='http://purl.org/net/xml2rfc/ext'/>">
19  <!ENTITY conformance                "<xref target='Part1' x:rel='#conformance' xmlns:x='http://purl.org/net/xml2rfc/ext'/>">
20  <!ENTITY notation                   "<xref target='Part1' x:rel='#notation' xmlns:x='http://purl.org/net/xml2rfc/ext'/>">
21  <!ENTITY abnf-extension             "<xref target='Part1' x:rel='#abnf.extension' xmlns:x='http://purl.org/net/xml2rfc/ext'/>">
22  <!ENTITY acks                       "<xref target='Part1' x:rel='#acks' xmlns:x='http://purl.org/net/xml2rfc/ext'/>">
23  <!ENTITY whitespace                 "<xref target='Part1' x:rel='#whitespace' xmlns:x='http://purl.org/net/xml2rfc/ext'/>">
24  <!ENTITY field-components           "<xref target='Part1' x:rel='#field.components' xmlns:x='http://purl.org/net/xml2rfc/ext'/>">
25  <!ENTITY http-date                  "<xref target='Part2' x:rel='#http.date' xmlns:x='http://purl.org/net/xml2rfc/ext'/>">
26  <!ENTITY messaging                  "<xref target='Part1' xmlns:x='http://purl.org/net/xml2rfc/ext'/>">
27  <!ENTITY semantics                  "<xref target='Part2' xmlns:x='http://purl.org/net/xml2rfc/ext'/>">
28  <!ENTITY entity-tags                "<xref target='Part4' x:rel='#header.etag' xmlns:x='http://purl.org/net/xml2rfc/ext'/>">
29  <!ENTITY weak-and-strong-validators "<xref target='Part4' x:rel='#weak.and.strong.validators' xmlns:x='http://purl.org/net/xml2rfc/ext'/>">
30  <!ENTITY lastmod-comparison         "<xref target='Part4' x:rel='#lastmod.comparison' xmlns:x='http://purl.org/net/xml2rfc/ext'/>">
31  <!ENTITY p6-heuristic               "<xref target='Part6' x:rel='#heuristic.freshness' xmlns:x='http://purl.org/net/xml2rfc/ext'/>">
32]>
33<?rfc toc="yes" ?>
34<?rfc symrefs="yes" ?>
35<?rfc sortrefs="yes" ?>
36<?rfc compact="yes"?>
37<?rfc subcompact="no" ?>
38<?rfc linkmailto="no" ?>
39<?rfc editing="no" ?>
40<?rfc comments="yes"?>
41<?rfc inline="yes"?>
42<?rfc rfcedstyle="yes"?>
43<?rfc-ext allow-markup-in-artwork="yes" ?>
44<?rfc-ext include-references-in-index="yes" ?>
45<rfc obsoletes="2616" category="std" x:maturity-level="proposed"
46     ipr="pre5378Trust200902" docName="draft-ietf-httpbis-p5-range-&ID-VERSION;"
47     xmlns:x='http://purl.org/net/xml2rfc/ext'>
48<x:link rel="prev" basename="p4-conditional"/>
49<x:link rel="next" basename="p6-cache"/>
50<x:feedback template="mailto:ietf-http-wg@w3.org?subject={docname},%20%22{section}%22&amp;body=&lt;{ref}&gt;:"/>
51<front>
52
53  <title abbrev="HTTP/1.1 Range Requests">Hypertext Transfer Protocol (HTTP/1.1): Range Requests</title>
54
55  <author initials="R." surname="Fielding" fullname="Roy T. Fielding" role="editor">
56    <organization abbrev="Adobe">Adobe Systems Incorporated</organization>
57    <address>
58      <postal>
59        <street>345 Park Ave</street>
60        <city>San Jose</city>
61        <region>CA</region>
62        <code>95110</code>
63        <country>USA</country>
64      </postal>
65      <email>fielding@gbiv.com</email>
66      <uri>http://roy.gbiv.com/</uri>
67    </address>
68  </author>
69
70  <author initials="Y." surname="Lafon" fullname="Yves Lafon" role="editor">
71    <organization abbrev="W3C">World Wide Web Consortium</organization>
72    <address>
73      <postal>
74        <street>W3C / ERCIM</street>
75        <street>2004, rte des Lucioles</street>
76        <city>Sophia-Antipolis</city>
77        <region>AM</region>
78        <code>06902</code>
79        <country>France</country>
80      </postal>
81      <email>ylafon@w3.org</email>
82      <uri>http://www.raubacapeu.net/people/yves/</uri>
83    </address>
84  </author>
85
86  <author initials="J. F." surname="Reschke" fullname="Julian F. Reschke" role="editor">
87    <organization abbrev="greenbytes">greenbytes GmbH</organization>
88    <address>
89      <postal>
90        <street>Hafenweg 16</street>
91        <city>Muenster</city><region>NW</region><code>48155</code>
92        <country>Germany</country>
93      </postal>
94      <email>julian.reschke@greenbytes.de</email>
95      <uri>http://greenbytes.de/tech/webdav/</uri>
96    </address>
97  </author>
98
99  <date month="&ID-MONTH;" year="&ID-YEAR;"/>
100  <workgroup>HTTPbis Working Group</workgroup>
101
102<abstract>
103<t>
104   The Hypertext Transfer Protocol (HTTP) is an application-level protocol for
105   distributed, collaborative, hypertext information systems. This document
106   defines range requests and the rules for constructing and combining
107   responses to those requests.
108</t>
109</abstract>
110
111<note title="Editorial Note (To be removed by RFC Editor)">
112  <t>
113    Discussion of this draft takes place on the HTTPBIS working group
114    mailing list (ietf-http-wg@w3.org), which is archived at
115    <eref target="http://lists.w3.org/Archives/Public/ietf-http-wg/"/>.
116  </t>
117  <t>
118    The current issues list is at
119    <eref target="http://tools.ietf.org/wg/httpbis/trac/report/3"/> and related
120    documents (including fancy diffs) can be found at
121    <eref target="http://tools.ietf.org/wg/httpbis/"/>.
122  </t>
123  <t>
124    The changes in this draft are summarized in <xref target="changes.since.21"/>.
125  </t>
126</note>
127</front>
128<middle>
129<section title="Introduction" anchor="introduction">
130<t>
131   HTTP clients often encounter interrupted data transfers as a result
132   of canceled requests or dropped connections.  When a client has stored
133   a partial representation, it is desirable to request the remainder
134   of that representation in a subsequent request rather than transfer
135   the entire representation.
136   There are also a number of Web applications that benefit from being
137   able to request only a subset of a larger representation, such as a
138   single page of a very large document or only part of an image to be
139   rendered by a device with limited local storage.
140</t>
141<t>
142   This document defines HTTP/1.1 range requests,
143   partial responses, and the multipart/byteranges media type.
144   The protocol for range requests is an &OPTIONAL; feature of HTTP,
145   designed so resources or recipients that do not implement this feature
146   can respond as if it is a normal GET request without impacting
147   interoperability.  Partial responses are indicated by a distinct status
148   code to not be mistaken for full responses by intermediate caches
149   that might not implement the feature.
150</t>
151<t>
152   Although the HTTP range request mechanism is designed to allow for
153   extensible range types, this specification only defines requests for
154   byte ranges.
155</t>
156
157<section title="Conformance and Error Handling" anchor="conformance">
158<t>
159   The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
160   "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
161   document are to be interpreted as described in <xref target="RFC2119"/>.
162</t>
163<t>
164   Conformance criteria and considerations regarding error handling
165   are defined in &conformance;.
166</t>
167</section>
168
169<section title="Syntax Notation" anchor="notation">
170<t>
171   This specification uses the Augmented Backus-Naur Form (ABNF) notation
172   of <xref target="RFC5234"/> with the list rule extension defined in
173   &notation;. <xref target="imported.abnf"/> describes rules imported from
174   other documents. <xref target="collected.abnf"/> shows the collected ABNF
175   with the list rule expanded.
176</t>
177</section>
178
179</section>
180
181
182<section title="Range Units" anchor="range.units">
183  <x:anchor-alias value="bytes-unit"/>
184  <x:anchor-alias value="other-range-unit"/>
185  <x:anchor-alias value="range-unit"/>
186<t>
187   HTTP/1.1 allows a client to request that only part (a range) of the
188   representation be included within the response. HTTP/1.1 uses range
189   units in the <x:ref>Range</x:ref> (<xref target="header.range"/>) and
190   <x:ref>Content-Range</x:ref> (<xref target="header.content-range"/>)
191   header fields. A representation can be broken down into subranges according
192   to various structural units.
193</t>
194<figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="range-unit"/><iref primary="true" item="Grammar" subitem="bytes-unit"/><iref primary="true" item="Grammar" subitem="other-range-unit"/>
195  <x:ref>range-unit</x:ref>       = <x:ref>bytes-unit</x:ref> / <x:ref>other-range-unit</x:ref>
196  <x:ref>bytes-unit</x:ref>       = "bytes"
197  <x:ref>other-range-unit</x:ref> = <x:ref>token</x:ref>
198</artwork></figure>
199<t>
200  HTTP/1.1 has been designed to allow implementations of applications
201  that do not depend on knowledge of ranges. The only range unit defined
202  by HTTP/1.1 is "bytes". Additional specifiers can be defined as described
203  in <xref target="range.specifier.registry"/>.
204</t>
205<t>
206  If a range unit is not understood in a request, a server &MUST; ignore
207  the whole <x:ref>Range</x:ref> header field (<xref target="header.range"/>).
208  If a range unit is not understood in a response, an intermediary
209  &SHOULD; pass the response to the client; a client &MUST; fail.
210</t>
211
212<section title="Range Specifier Registry" anchor="range.specifier.registry">
213<t>
214   The HTTP Range Specifier Registry defines the name space for the range
215   specifier names.
216</t>
217<t>
218   Registrations &MUST; include the following fields:
219   <list style="symbols">
220     <t>Name</t>
221     <t>Description</t>
222     <t>Pointer to specification text</t>
223   </list>
224</t>
225<t>
226  Values to be added to this name space require IETF Review
227  (see <xref target="RFC5226" x:fmt="," x:sec="4.1"/>).
228</t>
229<t>
230   The registry itself is maintained at
231   <eref target="http://www.iana.org/assignments/http-range-specifiers"/>.
232</t>
233</section>
234
235</section>
236
237<section title="Status Code Definitions" anchor="status.code.definitions">
238<section title="206 Partial Content" anchor="status.206">
239  <iref primary="true" item="206 Partial Content (status code)" x:for-anchor=""/>
240  <x:anchor-alias value="206"/>
241  <x:anchor-alias value="206 (Partial Content)"/>
242<t>
243   The <x:dfn>206 (Partial Content)</x:dfn> status code indicates that the
244   server has fulfilled the partial GET request for the resource.
245   The request &MUST; have included a <x:ref>Range</x:ref> header field
246   (<xref target="header.range"/>) indicating the desired range, and &MAY; have
247   included an <x:ref>If-Range</x:ref> header field
248   (<xref target="header.if-range"/>) to make the request conditional.
249</t>
250<t>
251   When a 206 response is generated, the sender &MUST; generate the following
252   header fields:
253  <list style="symbols">
254    <t>
255        Either a <x:ref>Content-Range</x:ref> header field
256        (<xref target="header.content-range"/>) indicating
257        the range included with this response, or a multipart/byteranges
258        <x:ref>Content-Type</x:ref> including Content-Range fields for each
259        part. If a <x:ref>Content-Length</x:ref> header field is present in the
260        response, its value &MUST; match the actual number of octets
261        transmitted in the message body.
262    </t>
263    <t>
264        Date
265    </t>
266    <t>
267        <x:ref>Cache-Control</x:ref>, <x:ref>ETag</x:ref>,
268        <x:ref>Expires</x:ref>, <x:ref>Content-Location</x:ref> and/or
269        <x:ref>Vary</x:ref>, if the header field would have been sent in a
270        <x:ref>200 (OK)</x:ref> response to the same request
271    </t>
272  </list>
273</t>
274<t>
275   If a 206 is generated in response to a request with an <x:ref>If-Range</x:ref>
276   header field, the sender &SHOULD-NOT; generate other representation header
277   fields beyond those described above.
278   Otherwise, the sender &MUST; generate all of the same representation header
279   fields that would have been sent in a <x:ref>200 (OK)</x:ref> response
280   to the same request.
281</t>
282<t>
283   Caches &MAY; use a heuristic (see &p6-heuristic;) to determine
284   freshness for 206 responses.
285</t>
286</section>
287
288<section title="416 Range Not Satisfiable" anchor="status.416">
289  <iref primary="true" item="416 Range Not Satisfiable (status code)" x:for-anchor=""/>
290  <x:anchor-alias value="416 (Range Not Satisfiable)"/>
291<t>
292   The <x:dfn>416 (Range Not Satisfiable)</x:dfn> status code
293   indicates that none of the ranges-specifier values in the request's
294   <x:ref>Range</x:ref> header field (<xref target="header.range"/>)
295   overlap the current
296   extent of the selected resource and the request did not include an
297   <x:ref>If-Range</x:ref> header field (<xref target="header.if-range"/>).
298   (For byte-ranges, this means that the first-byte-pos of all of the
299   byte-range-spec values were greater than the current length of the selected
300   representation.)
301</t>
302<t>
303   When this status code is sent in response to a byte-range request, the
304   sender &SHOULD; generate a <x:ref>Content-Range</x:ref> header field
305   specifying the current length of the selected representation
306   (see <xref target="header.content-range"/>).
307</t>
308<figure>
309<preamble>For example:</preamble>
310<artwork type="message/http; msgtype=&#34;response&#34;" x:indent-with="  ">
311HTTP/1.1 416 Range Not Satisfiable
312Date: Mon, 20 Jan 2012 15:41:54 GMT
313Content-Range: bytes */47022
314Content-Type: image/gif
315</artwork></figure>
316<x:note>
317  <t>
318    &Note; Clients cannot depend on servers to send a <x:ref>416 (Requested
319    Range Not Satisfiable)</x:ref> response instead of a <x:ref>200 (OK)</x:ref>
320    response for an unsatisfiable <x:ref>Range</x:ref> header field, since not
321    all servers implement this header field.
322  </t>
323</x:note>
324</section>
325</section>
326
327<section title="Responses to a Range Request">
328<section title="Response to a Single and Multiple Ranges Request">
329<t>
330   When an HTTP message includes the content of a single range (for
331   example, a response to a request for a single range, or to a request
332   for a set of ranges that overlap without any holes), this content is
333   transmitted with a <x:ref>Content-Range</x:ref> header field, and a
334   <x:ref>Content-Length</x:ref> header field showing the number of bytes
335   actually transferred. For example,
336</t>
337<figure><artwork type="message/http; msgtype=&#34;response&#34;" x:indent-with="  ">
338HTTP/1.1 206 Partial Content
339Date: Wed, 15 Nov 1995 06:25:24 GMT
340Last-Modified: Wed, 15 Nov 1995 04:58:08 GMT
341Content-Range: bytes 21010-47021/47022
342Content-Length: 26012
343Content-Type: image/gif
344</artwork></figure>
345<t>
346   When an HTTP message includes the content of multiple ranges (for
347   example, a response to a request for multiple non-overlapping
348   ranges), these are transmitted as a multipart message. The multipart
349   media type used for this purpose is "multipart/byteranges" as defined
350   in <xref target="internet.media.type.multipart.byteranges"/>.
351</t>
352<t>
353   A server &MAY; combine requested ranges when those ranges are overlapping
354   (see <xref target="overlapping.ranges"/>).
355</t>
356<t>
357   A response to a request for a single range &MUST-NOT; be sent using the
358   multipart/byteranges media type.  A response to a request for
359   multiple ranges, whose result is a single range, &MAY; be sent as a
360   multipart/byteranges media type with one part. A client that cannot
361   decode a multipart/byteranges message &MUST-NOT; ask for multiple
362   ranges in a single request.
363</t>
364<t>
365   When a client asks for multiple ranges in one request, the
366   server &SHOULD; send them in the order that they appeared in the
367   request.
368</t>
369</section>
370
371<section title="Combining Ranges" anchor="combining.byte.ranges">
372<t>
373   A response might transfer only a subrange of a representation if the
374   connection closed prematurely or if the request used one or more Range
375   specifications.  After several such transfers, a client might have
376   received several ranges of the same representation.  These ranges can only
377   be safely combined if they all have in common the same strong validator,
378   where "strong validator" is defined to be either an entity-tag that is
379   not marked as weak (&entity-tags;) or, if no entity-tag is provided, a
380   <x:ref>Last-Modified</x:ref> value that is strong in the sense defined by
381   &lastmod-comparison;.
382</t>
383<t>
384   When a client receives an incomplete <x:ref>200 (OK)</x:ref> response or a
385   <x:ref>206 (Partial Content)</x:ref> response, and already has one or more
386   partial responses for the same method and effective request URI that have
387   the same strong validator as present in the new response,
388   the recipient &MAY; combine some or all of those responses into a set of
389   continuous ranges. A client &MUST-NOT; combine responses that differ in the
390   strong validator or that do not have a strong validator.
391</t>
392<t>
393   If the new response is an incomplete <x:ref>200 (OK)</x:ref> response, then
394   the header fields of that new response are used for any combined response
395   and replace those of the matching stored responses.
396</t>
397<t>
398   If the new response is a <x:ref>206 (Partial Content)</x:ref> response and
399   at least one of the matching stored responses is a <x:ref>200 (OK)</x:ref>,
400   then the combined response header fields consist of the most recent 200
401   response's header fields. If all of the matching stored responses are 206
402   responses, then the stored response with the most recent header fields is
403   used as the source of header fields for the combined response, except that
404   the client &MUST; use other header fields provided in the new response,
405   aside from <x:ref>Content-Range</x:ref>, to replace all instances of the
406   corresponding header fields in the stored response.
407</t>
408<t>
409   The combined response message body consists of the union of partial
410   content ranges in the new response and each of the selected responses.
411   If the union consists of the entire range of the representation, then the
412   client &MUST; record the combined response as if it were a complete
413   <x:ref>200 (OK)</x:ref> response, including a <x:ref>Content-Length</x:ref>
414   header field that reflects the complete length.
415   Otherwise, the client &MUST; record the set of continuous ranges as one of
416   the following:
417   an incomplete <x:ref>200 (OK)</x:ref> response if the combined response is
418   a prefix of the representation,
419   a single <x:ref>206 (Partial Content)</x:ref> response containing a
420   multipart/byteranges body, or
421   multiple <x:ref>206 (Partial Content)</x:ref> responses, each with one
422   continuous range that is indicated by a <x:ref>Content-Range</x:ref> header
423   field.
424</t>
425</section>
426</section>
427
428<section title="Header Field Definitions" anchor="header.field.definitions">
429<t>
430   This section defines the syntax and semantics of HTTP/1.1 header fields
431   related to range requests and partial responses.
432</t>
433
434<section title="Accept-Ranges" anchor="header.accept-ranges">
435  <iref primary="true" item="Accept-Ranges header field" x:for-anchor=""/>
436  <x:anchor-alias value="Accept-Ranges"/>
437  <x:anchor-alias value="acceptable-ranges"/>
438<t>
439   The "Accept-Ranges" header field allows a resource to indicate
440   its acceptance of range requests.
441</t>
442<figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="Accept-Ranges"/><iref primary="true" item="Grammar" subitem="acceptable-ranges"/>
443  <x:ref>Accept-Ranges</x:ref>     = <x:ref>acceptable-ranges</x:ref>
444  <x:ref>acceptable-ranges</x:ref> = 1#<x:ref>range-unit</x:ref> / "none"
445</artwork></figure>
446<t>
447   Origin servers that accept byte-range requests &MAY; send
448</t>
449<figure><artwork type="example">
450  Accept-Ranges: bytes
451</artwork></figure>
452<t>
453   but are not required to do so. Clients &MAY; generate range
454   requests without having received this header field for the resource
455   involved. Range units are defined in <xref target="range.units"/>.
456</t>
457<t>
458   Servers that do not accept any kind of range request for a
459   resource &MAY; send
460</t>
461<figure><artwork type="example">
462  Accept-Ranges: none
463</artwork></figure>
464<t>
465   to advise the client not to attempt a range request.
466</t>
467</section>
468
469<section title="Content-Range" anchor="header.content-range">
470  <iref primary="true" item="Content-Range header field" x:for-anchor=""/>
471  <x:anchor-alias value="byte-content-range-spec"/>
472  <x:anchor-alias value="byte-range-resp-spec"/>
473  <x:anchor-alias value="Content-Range"/>
474  <x:anchor-alias value="instance-length"/>
475  <x:anchor-alias value="other-content-range-spec"/>
476  <x:anchor-alias value="other-range-resp-spec"/>
477<t>
478   The "Content-Range" header field is sent with a partial representation to
479   specify where in the full representation the payload body is intended to be
480   applied.
481</t>
482<t>  
483   Range units are defined in <xref target="range.units"/>.
484</t>
485<figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="Content-Range"/><iref primary="true" item="Grammar" subitem="byte-content-range-spec"/><iref primary="true" item="Grammar" subitem="byte-range-resp-spec"/><iref primary="true" item="Grammar" subitem="instance-length"/>
486  <x:ref>Content-Range</x:ref>           = <x:ref>byte-content-range-spec</x:ref>
487                          / <x:ref>other-content-range-spec</x:ref>
488                         
489  <x:ref>byte-content-range-spec</x:ref> = <x:ref>bytes-unit</x:ref> <x:ref>SP</x:ref>
490                            <x:ref>byte-range-resp-spec</x:ref> "/"
491                            ( <x:ref>instance-length</x:ref> / "*" )
492 
493  <x:ref>byte-range-resp-spec</x:ref>    = (<x:ref>first-byte-pos</x:ref> "-" <x:ref>last-byte-pos</x:ref>)
494                          / "*"
495                         
496  <x:ref>instance-length</x:ref>         = 1*<x:ref>DIGIT</x:ref>
497 
498  <x:ref>other-content-range-spec</x:ref> = <x:ref>other-range-unit</x:ref> <x:ref>SP</x:ref>
499                             <x:ref>other-range-resp-spec</x:ref>
500  <x:ref>other-range-resp-spec</x:ref>    = *<x:ref>CHAR</x:ref>
501</artwork></figure>
502<t>
503   The header field &SHOULD; indicate the total length of the full representation,
504   unless this length is unknown or difficult to determine. The asterisk
505   "*" character means that the instance-length is unknown at the time
506   when the response was generated.
507</t>
508<t>
509   Unlike byte-ranges-specifier values (see <xref target="byte.ranges"/>), a byte-range-resp-spec
510   &MUST; only specify one range, and &MUST; contain
511   absolute byte positions for both the first and last byte of the
512   range.
513</t>
514<t>
515   A byte-content-range-spec with a byte-range-resp-spec whose last-byte-pos
516   value is less than its first-byte-pos value, or whose
517   instance-length value is less than or equal to its last-byte-pos
518   value, is invalid. The recipient of an invalid byte-content-range-spec
519   &MUST; ignore it and any content transferred along with it.
520</t>
521<t>
522   In the case of a byte range request: a server sending a response with
523   status code <x:ref>416 (Range Not Satisfiable)</x:ref> &SHOULD; send a
524   Content-Range field with a byte-range-resp-spec of "*".
525   The instance-length specifies the current length of the selected resource.
526   A server &MUST-NOT; generate a a Content-Range field with a
527   byte-range-resp-spec of "*" in a <x:ref>206 (Partial Content)</x:ref>
528   response.
529</t>
530<t>
531  The "Content-Range" header field has no meaning for status codes that do not
532  explicitly describe its semantic. Currently, only status codes
533  <x:ref>206 (Partial Content)</x:ref> and <x:ref>416 (Range Not Satisfiable)</x:ref> describe
534  the meaning of this header field.
535</t>
536<t>
537   Examples of byte-content-range-spec values, assuming that the representation
538   contains a total of 1234 bytes:
539   <list style="symbols">
540      <t>
541        The first 500 bytes:
542<figure><artwork type="example" x:indent-with="   ">
543  bytes 0-499/1234
544</artwork></figure>
545      </t>   
546      <t>
547        The second 500 bytes:
548<figure><artwork type="example" x:indent-with="   ">
549  bytes 500-999/1234
550</artwork></figure>
551      </t>   
552      <t>
553        All except for the first 500 bytes:
554<figure><artwork type="example" x:indent-with="   ">
555  bytes 500-1233/1234
556</artwork></figure>
557      </t>   
558      <t>
559        The last 500 bytes:
560<figure><artwork type="example" x:indent-with="   ">
561  bytes 734-1233/1234
562</artwork></figure>
563      </t>   
564   </list>
565</t>
566<t>
567   If the server ignores a byte-range-spec (for example if it is
568   syntactically invalid, or if it might be seen as a denial-of-service
569   attack), the server &SHOULD; treat the request as if the invalid <x:ref>Range</x:ref>
570   header field did not exist. (Normally, this means send a <x:ref>200 (OK)</x:ref>
571   response containing the full representation).
572</t>
573</section>
574
575<section title="If-Range" anchor="header.if-range">
576  <iref primary="true" item="If-Range header field" x:for-anchor=""/>
577  <x:anchor-alias value="If-Range"/>
578<t>
579   If a client has a partial copy of a representation and wishes
580   to have an up-to-date copy of the entire representation, it could use the
581   <x:ref>Range</x:ref> header field with a conditional GET (using
582   either or both of <x:ref>If-Unmodified-Since</x:ref> and
583   <x:ref>If-Match</x:ref>.) However, if the condition fails because the
584   representation has been modified, the client would then have to make a
585   second request to obtain the entire current representation.
586</t>
587<t>
588   The "If-Range" header field allows a client to "short-circuit" the second
589   request. Informally, its meaning is "if the representation is unchanged, send
590   me the part(s) that I am missing; otherwise, send me the entire new
591   representation".
592</t>
593<figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="If-Range"/>
594  <x:ref>If-Range</x:ref> = <x:ref>entity-tag</x:ref> / <x:ref>HTTP-date</x:ref>
595</artwork></figure>
596<t>
597   Clients &MUST-NOT; use an entity-tag marked as weak in an If-Range
598   field value and &MUST-NOT; use a <x:ref>Last-Modified</x:ref> date in an
599   If-Range field value unless it has no entity-tag for the representation and
600   the Last-Modified date it does have for the representation is strong
601   in the sense defined by &lastmod-comparison;.
602</t>
603<t>
604   A server that evaluates a conditional range request that is applicable
605   to one of its representations &MUST; evaluate the condition as false if
606   the entity-tag used as a validator is marked as weak or, when an HTTP-date
607   is used as the validator, if the date value is not strong in the sense
608   defined by &lastmod-comparison;. (A server can distinguish between a
609   valid HTTP-date and any form of entity-tag by examining the first
610   two characters.)
611</t>
612<t>
613   The If-Range header field &SHOULD; only be sent by clients together with
614   a Range header field.  The If-Range header field &MUST; be ignored if it
615   is received in a request that does not include a Range header field.
616   The If-Range header field &MUST; be ignored by a server that does not
617   support the sub-range operation.
618</t>
619<t>
620   If the validator given in the If-Range header field matches the current
621   validator for the selected representation of the target resource, then
622   the server &SHOULD; send the specified sub-range of the representation
623   using a <x:ref>206 (Partial Content)</x:ref> response. If the validator does not match,
624   then the server &SHOULD; send the entire representation using a <x:ref>200 (OK)</x:ref>
625   response.
626</t>
627</section>
628
629<section title="Range" anchor="header.range">
630  <iref primary="true" item="Range header field" x:for-anchor=""/>
631
632<section title="Byte Ranges" anchor="byte.ranges">
633<t>
634   Since all HTTP representations are transferred as sequences
635   of bytes, the concept of a byte range is meaningful for any HTTP
636   representation. (However, not all clients and servers need to support byte-range
637   operations.)
638</t>
639<t>
640   Byte range specifications in HTTP apply to the sequence of bytes in
641   the representation data (not necessarily the same as the message body).
642</t>
643<t anchor="rule.ranges-specifier">
644  <x:anchor-alias value="byte-range-set"/>
645  <x:anchor-alias value="byte-range-spec"/>
646  <x:anchor-alias value="byte-ranges-specifier"/>
647  <x:anchor-alias value="first-byte-pos"/>
648  <x:anchor-alias value="last-byte-pos"/>
649  <x:anchor-alias value="ranges-specifier"/>
650  <x:anchor-alias value="suffix-byte-range-spec"/>
651  <x:anchor-alias value="suffix-length"/>
652   A byte range operation &MAY; specify a single range of bytes, or a set
653   of ranges within a single representation.
654</t>
655<figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="ranges-specifier"/><iref primary="true" item="Grammar" subitem="byte-ranges-specifier"/><iref primary="true" item="Grammar" subitem="byte-range-set"/><iref primary="true" item="Grammar" subitem="byte-range-spec"/><iref primary="true" item="Grammar" subitem="first-byte-pos"/><iref primary="true" item="Grammar" subitem="last-byte-pos"/>
656  <x:ref>byte-ranges-specifier</x:ref> = <x:ref>bytes-unit</x:ref> "=" <x:ref>byte-range-set</x:ref>
657  <x:ref>byte-range-set</x:ref>  = 1#( <x:ref>byte-range-spec</x:ref> / <x:ref>suffix-byte-range-spec</x:ref> )
658  <x:ref>byte-range-spec</x:ref> = <x:ref>first-byte-pos</x:ref> "-" [ <x:ref>last-byte-pos</x:ref> ]
659  <x:ref>first-byte-pos</x:ref>  = 1*<x:ref>DIGIT</x:ref>
660  <x:ref>last-byte-pos</x:ref>   = 1*<x:ref>DIGIT</x:ref>
661</artwork></figure>
662<t>
663   The first-byte-pos value in a byte-range-spec gives the byte-offset
664   of the first byte in a range. The last-byte-pos value gives the
665   byte-offset of the last byte in the range; that is, the byte
666   positions specified are inclusive. Byte offsets start at zero.
667</t>
668<t>
669   If the last-byte-pos value is present, it &MUST; be greater than or
670   equal to the first-byte-pos in that byte-range-spec, or the byte-range-spec
671   is syntactically invalid. The recipient of a byte-range-set
672   that includes one or more syntactically invalid byte-range-spec
673   values &MUST; ignore the header field that includes that byte-range-set.
674</t>
675<t>
676   If the last-byte-pos value is absent, or if the value is greater than
677   or equal to the current length of the representation data, last-byte-pos is
678   taken to be equal to one less than the current length of the representation
679   in bytes.
680</t>
681<t>
682   By its choice of last-byte-pos, a client can limit the number of
683   bytes retrieved without knowing the size of the representation.
684</t>
685<figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="suffix-byte-range-spec"/><iref primary="true" item="Grammar" subitem="suffix-length"/>
686  <x:ref>suffix-byte-range-spec</x:ref> = "-" <x:ref>suffix-length</x:ref>
687  <x:ref>suffix-length</x:ref> = 1*<x:ref>DIGIT</x:ref>
688</artwork></figure>
689<t>
690   A suffix-byte-range-spec is used to specify the suffix of the
691   representation data, of a length given by the suffix-length value. (That is,
692   this form specifies the last N bytes of a representation.) If the
693   representation is shorter than the specified suffix-length, the entire
694   representation is used.
695</t>
696<t>
697   If a syntactically valid byte-range-set includes at least one byte-range-spec
698   whose first-byte-pos is less than the current length of
699   the representation, or at least one suffix-byte-range-spec with a non-zero
700   suffix-length, then the byte-range-set is satisfiable.
701   Otherwise, the byte-range-set is unsatisfiable. If the byte-range-set
702   is unsatisfiable, the server &SHOULD; send a response with a
703   <x:ref>416 (Range Not Satisfiable)</x:ref> status code. Otherwise, the server
704   &SHOULD; send a response with a <x:ref>206 (Partial Content)</x:ref> status code
705   containing the satisfiable ranges of the representation.
706</t>
707<t>
708   In the byte range syntax, <x:ref>first-byte-pos</x:ref>,
709   <x:ref>last-byte-pos</x:ref>, and <x:ref>suffix-length</x:ref> are
710   expressed as decimal number of octets.  Since there is no predefined limit
711   to the length of an HTTP payload, recipients &SHOULD; anticipate
712   potentially large decimal numerals and prevent parsing errors due to integer
713   conversion overflows.
714</t>
715<t>
716   Examples of byte-ranges-specifier values (assuming a representation of
717   length 10000):
718  <list style="symbols">
719     <t>The first 500 bytes (byte offsets 0-499, inclusive):
720<figure><artwork type="example" x:indent-with="   ">
721  bytes=0-499
722</artwork></figure>
723    </t>
724     <t>The second 500 bytes (byte offsets 500-999, inclusive):
725<figure><artwork type="example" x:indent-with="   ">
726  bytes=500-999
727</artwork></figure>
728    </t>
729     <t>The final 500 bytes (byte offsets 9500-9999, inclusive):
730<figure><artwork type="example" x:indent-with="   ">
731  bytes=-500
732</artwork></figure>
733    Or:
734<figure><artwork type="example" x:indent-with="   ">
735  bytes=9500-
736</artwork></figure>
737    </t>
738     <t>The first and last bytes only (bytes 0 and 9999):
739<figure><artwork type="example" x:indent-with="   ">
740  bytes=0-0,-1
741</artwork></figure>
742     </t>
743     <t>Several legal but not canonical specifications of the second 500
744        bytes (byte offsets 500-999, inclusive):
745<figure><artwork type="example" x:indent-with="   ">
746  bytes=500-600,601-999
747  bytes=500-700,601-999
748</artwork></figure>
749     </t>
750  </list>
751</t>
752</section>
753
754<section title="Range Retrieval Requests" anchor="range.retrieval.requests">
755  <x:anchor-alias value="Range"/>
756  <x:anchor-alias value="other-ranges-specifier"/>
757  <x:anchor-alias value="other-range-set"/>
758<t>
759   The "Range" header field defines the GET method (conditional or
760   not) to request one or more sub-ranges of the response representation data, instead
761   of the entire representation data.
762</t>
763<figure><artwork type="abnf2616"><iref primary="true" item="Grammar" subitem="Range"/>
764  <x:ref>Range</x:ref> = <x:ref>byte-ranges-specifier</x:ref> / <x:ref>other-ranges-specifier</x:ref>
765  <x:ref>other-ranges-specifier</x:ref> = <x:ref>other-range-unit</x:ref> "=" <x:ref>other-range-set</x:ref>
766  <x:ref>other-range-set</x:ref> = 1*<x:ref>CHAR</x:ref>
767</artwork></figure>
768<t>
769   A server &MAY; ignore the Range header field. However, origin
770   servers and intermediate caches ought to support byte ranges when
771   possible, since Range supports efficient recovery from partially
772   failed transfers, and supports efficient partial retrieval of large
773   representations.
774</t>
775<t>
776   If the server supports the Range header field and the specified range or
777   ranges are appropriate for the representation:
778  <list style="symbols">
779     <t>The presence of a Range header field in an unconditional GET modifies
780        what is sent if the GET is otherwise successful. In other
781        words, the response carries a status code of <x:ref>206 (Partial Content)</x:ref>
782        instead of <x:ref>200 (OK)</x:ref>.</t>
783
784     <t>The presence of a Range header field in a conditional GET (a request
785        using one or both of <x:ref>If-Modified-Since</x:ref> and
786        <x:ref>If-None-Match</x:ref>, or one or both of
787        <x:ref>If-Unmodified-Since</x:ref> and <x:ref>If-Match</x:ref>) modifies
788        what is sent if the GET is otherwise successful and the
789        condition is true. It does not affect the <x:ref>304 (Not Modified)</x:ref>
790        response sent if the conditional is false.</t>
791  </list>
792</t>
793<t>
794   In some cases, it might be more appropriate to use the If-Range
795   header field (see <xref target="header.if-range"/>) in addition to the Range
796   header field.
797</t>
798<t>
799   If a proxy that supports ranges receives a Range request, forwards
800   the request to an inbound server, and receives an entire representation in
801   reply, it &MAY; only send the requested range to its client.
802</t>
803</section>
804</section>
805</section>
806
807<section title="IANA Considerations" anchor="IANA.considerations">
808
809<section title="Status Code Registration" anchor="status.code.registration">
810<t>
811   The HTTP Status Code Registry located at <eref target="http://www.iana.org/assignments/http-status-codes"/>
812   shall be updated with the registrations below:
813</t>
814<?BEGININC p5-range.iana-status-codes ?>
815<!--AUTOGENERATED FROM extract-status-code-defs.xslt, do not edit manually-->
816<texttable align="left" suppress-title="true" anchor="iana.status.code.registration.table">
817   <ttcol>Value</ttcol>
818   <ttcol>Description</ttcol>
819   <ttcol>Reference</ttcol>
820   <c>206</c>
821   <c>Partial Content</c>
822   <c>
823      <xref target="status.206"/>
824   </c>
825   <c>416</c>
826   <c>Range Not Satisfiable</c>
827   <c>
828      <xref target="status.416"/>
829   </c>
830</texttable>
831<!--(END)-->
832<?ENDINC p5-range.iana-status-codes ?>
833</section>
834
835<section title="Header Field Registration" anchor="header.field.registration">
836<t>
837   The Message Header Field Registry located at <eref target="http://www.iana.org/assignments/message-headers/message-header-index.html"/> shall be updated
838   with the permanent registrations below (see <xref target="BCP90"/>):
839</t>
840<?BEGININC p5-range.iana-headers ?>
841<!--AUTOGENERATED FROM extract-header-defs.xslt, do not edit manually-->
842<texttable align="left" suppress-title="true" anchor="iana.header.registration.table">
843   <ttcol>Header Field Name</ttcol>
844   <ttcol>Protocol</ttcol>
845   <ttcol>Status</ttcol>
846   <ttcol>Reference</ttcol>
847
848   <c>Accept-Ranges</c>
849   <c>http</c>
850   <c>standard</c>
851   <c>
852      <xref target="header.accept-ranges"/>
853   </c>
854   <c>Content-Range</c>
855   <c>http</c>
856   <c>standard</c>
857   <c>
858      <xref target="header.content-range"/>
859   </c>
860   <c>If-Range</c>
861   <c>http</c>
862   <c>standard</c>
863   <c>
864      <xref target="header.if-range"/>
865   </c>
866   <c>Range</c>
867   <c>http</c>
868   <c>standard</c>
869   <c>
870      <xref target="header.range"/>
871   </c>
872</texttable>
873<!--(END)-->
874<?ENDINC p5-range.iana-headers ?>
875<t>
876   The change controller is: "IETF (iesg@ietf.org) - Internet Engineering Task Force".
877</t>
878</section>
879
880<section title="Range Specifier Registration" anchor="range.specifier.registration">
881<t>
882  The registration procedure for HTTP Range Specifiers is defined by
883  <xref target="range.specifier.registry"/> of this document.
884</t>
885<t>
886   The HTTP Range Specifier Registry shall be created at <eref target="http://www.iana.org/assignments/http-range-specifiers"/>
887   and be populated with the registrations below:
888</t>
889<texttable align="left" suppress-title="true" anchor="iana.range.specifiers.table">
890   <ttcol>Range Specifier Name</ttcol>
891   <ttcol>Description</ttcol>
892   <ttcol>Reference</ttcol>
893
894   <c>bytes</c>
895   <c>a range of octets</c>
896   <c><xref target="range.units"/></c>
897
898   <c>none</c>
899   <c>reserved as keyword, indicating no ranges are supported</c>
900   <c><xref target="header.accept-ranges"/></c>
901</texttable>
902<t>
903   The change controller is: "IETF (iesg@ietf.org) - Internet Engineering Task Force".
904</t>
905</section>
906</section>
907
908<section title="Security Considerations" anchor="security.considerations">
909<t>
910   This section is meant to inform developers, information providers, and
911   users of known security concerns specific to the HTTP/1.1 range
912   request mechanisms. More general security considerations are addressed
913   in HTTP messaging &messaging; and semantics &semantics;.
914</t>
915
916<section title="Overlapping Ranges" anchor="overlapping.ranges">
917<t>
918   Range requests containing overlapping ranges can lead to a situation
919   where the server is sending far more data than the size of the complete
920   resource representation.
921</t>
922</section>
923</section>
924
925<section title="Acknowledgments" anchor="acks">
926<t>
927  See &acks;.
928</t>
929</section>
930</middle>
931<back>
932
933<references title="Normative References">
934
935<reference anchor="Part1">
936  <front>
937    <title>Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing</title>
938    <author initials="R." surname="Fielding" fullname="Roy T. Fielding" role="editor">
939      <organization abbrev="Adobe">Adobe Systems Incorporated</organization>
940      <address><email>fielding@gbiv.com</email></address>
941    </author>
942    <author initials="J. F." surname="Reschke" fullname="Julian F. Reschke" role="editor">
943      <organization abbrev="greenbytes">greenbytes GmbH</organization>
944      <address><email>julian.reschke@greenbytes.de</email></address>
945    </author>
946    <date month="&ID-MONTH;" year="&ID-YEAR;"/>
947  </front>
948  <seriesInfo name="Internet-Draft" value="draft-ietf-httpbis-p1-messaging-&ID-VERSION;"/>
949  <x:source href="p1-messaging.xml" basename="p1-messaging">
950    <x:defines>Content-Length</x:defines>
951  </x:source>
952</reference>
953
954<reference anchor="Part2">
955  <front>
956    <title>Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content</title>
957    <author initials="R." surname="Fielding" fullname="Roy T. Fielding" role="editor">
958      <organization abbrev="Adobe">Adobe Systems Incorporated</organization>
959      <address><email>fielding@gbiv.com</email></address>
960    </author>
961    <author initials="J. F." surname="Reschke" fullname="Julian F. Reschke" role="editor">
962      <organization abbrev="greenbytes">greenbytes GmbH</organization>
963      <address><email>julian.reschke@greenbytes.de</email></address>
964    </author>
965    <date month="&ID-MONTH;" year="&ID-YEAR;"/>
966  </front>
967  <seriesInfo name="Internet-Draft" value="draft-ietf-httpbis-p2-semantics-&ID-VERSION;"/>
968  <x:source href="p2-semantics.xml" basename="p2-semantics">
969    <x:defines>200 (OK)</x:defines>
970    <x:defines>410 (Gone)</x:defines>
971    <x:defines>Content-Location</x:defines>
972    <x:defines>Content-Type</x:defines>
973    <x:defines>Location</x:defines>
974    <x:defines>Vary</x:defines>
975  </x:source>
976</reference>
977
978<reference anchor="Part4">
979  <front>
980    <title>Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests</title>
981    <author initials="R." surname="Fielding" fullname="Roy T. Fielding" role="editor">
982      <organization abbrev="Adobe">Adobe Systems Incorporated</organization>
983      <address><email>fielding@gbiv.com</email></address>
984    </author>
985    <author initials="J. F." surname="Reschke" fullname="Julian F. Reschke" role="editor">
986      <organization abbrev="greenbytes">greenbytes GmbH</organization>
987      <address><email>julian.reschke@greenbytes.de</email></address>
988    </author>
989    <date month="&ID-MONTH;" year="&ID-YEAR;"/>
990  </front>
991  <seriesInfo name="Internet-Draft" value="draft-ietf-httpbis-p4-conditional-&ID-VERSION;"/>
992  <x:source href="p4-conditional.xml" basename="p4-conditional">
993    <x:defines>304 (Not Modified)</x:defines>
994    <x:defines>ETag</x:defines>
995    <x:defines>If-Match</x:defines>
996    <x:defines>If-Modified-Since</x:defines>
997    <x:defines>If-None-Match</x:defines>
998    <x:defines>If-Unmodified-Since</x:defines>
999    <x:defines>Last-Modified</x:defines>
1000  </x:source>
1001</reference>
1002
1003<reference anchor="Part6">
1004  <front>
1005    <title>Hypertext Transfer Protocol (HTTP/1.1): Caching</title>
1006    <author initials="R." surname="Fielding" fullname="Roy T. Fielding" role="editor">
1007      <organization abbrev="Adobe">Adobe Systems Incorporated</organization>
1008      <address><email>fielding@gbiv.com</email></address>
1009    </author>
1010    <author initials="M." surname="Nottingham" fullname="Mark Nottingham" role="editor">
1011      <organization>Akamai</organization>
1012      <address><email>mnot@mnot.net</email></address>
1013    </author>
1014    <author initials="J. F." surname="Reschke" fullname="Julian F. Reschke" role="editor">
1015      <organization abbrev="greenbytes">greenbytes GmbH</organization>
1016      <address><email>julian.reschke@greenbytes.de</email></address>
1017    </author>
1018    <date month="&ID-MONTH;" year="&ID-YEAR;"/>
1019  </front>
1020  <seriesInfo name="Internet-Draft" value="draft-ietf-httpbis-p6-cache-&ID-VERSION;"/>
1021  <x:source href="p6-cache.xml" basename="p6-cache">
1022    <x:defines>Cache-Control</x:defines>
1023    <x:defines>Expires</x:defines>
1024  </x:source>
1025</reference>
1026
1027<reference anchor="RFC2046">
1028  <front>
1029    <title abbrev="Media Types">Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types</title>
1030    <author initials="N." surname="Freed" fullname="Ned Freed">
1031      <organization>Innosoft International, Inc.</organization>
1032      <address><email>ned@innosoft.com</email></address>
1033    </author>
1034    <author initials="N." surname="Borenstein" fullname="Nathaniel S. Borenstein">
1035      <organization>First Virtual Holdings</organization>
1036      <address><email>nsb@nsb.fv.com</email></address>
1037    </author>
1038    <date month="November" year="1996"/>
1039  </front>
1040  <seriesInfo name="RFC" value="2046"/>
1041</reference>
1042
1043<reference anchor="RFC2119">
1044  <front>
1045    <title>Key words for use in RFCs to Indicate Requirement Levels</title>
1046    <author initials="S." surname="Bradner" fullname="Scott Bradner">
1047      <organization>Harvard University</organization>
1048      <address><email>sob@harvard.edu</email></address>
1049    </author>
1050    <date month="March" year="1997"/>
1051  </front>
1052  <seriesInfo name="BCP" value="14"/>
1053  <seriesInfo name="RFC" value="2119"/>
1054</reference>
1055
1056<reference anchor="RFC5234">
1057  <front>
1058    <title abbrev="ABNF for Syntax Specifications">Augmented BNF for Syntax Specifications: ABNF</title>
1059    <author initials="D." surname="Crocker" fullname="Dave Crocker" role="editor">
1060      <organization>Brandenburg InternetWorking</organization>
1061      <address>
1062        <email>dcrocker@bbiw.net</email>
1063      </address> 
1064    </author>
1065    <author initials="P." surname="Overell" fullname="Paul Overell">
1066      <organization>THUS plc.</organization>
1067      <address>
1068        <email>paul.overell@thus.net</email>
1069      </address>
1070    </author>
1071    <date month="January" year="2008"/>
1072  </front>
1073  <seriesInfo name="STD" value="68"/>
1074  <seriesInfo name="RFC" value="5234"/>
1075</reference>
1076
1077</references>
1078
1079<references title="Informative References">
1080
1081<reference anchor="RFC2616">
1082  <front>
1083    <title>Hypertext Transfer Protocol -- HTTP/1.1</title>
1084    <author initials="R." surname="Fielding" fullname="R. Fielding">
1085      <organization>University of California, Irvine</organization>
1086      <address><email>fielding@ics.uci.edu</email></address>
1087    </author>
1088    <author initials="J." surname="Gettys" fullname="J. Gettys">
1089      <organization>W3C</organization>
1090      <address><email>jg@w3.org</email></address>
1091    </author>
1092    <author initials="J." surname="Mogul" fullname="J. Mogul">
1093      <organization>Compaq Computer Corporation</organization>
1094      <address><email>mogul@wrl.dec.com</email></address>
1095    </author>
1096    <author initials="H." surname="Frystyk" fullname="H. Frystyk">
1097      <organization>MIT Laboratory for Computer Science</organization>
1098      <address><email>frystyk@w3.org</email></address>
1099    </author>
1100    <author initials="L." surname="Masinter" fullname="L. Masinter">
1101      <organization>Xerox Corporation</organization>
1102      <address><email>masinter@parc.xerox.com</email></address>
1103    </author>
1104    <author initials="P." surname="Leach" fullname="P. Leach">
1105      <organization>Microsoft Corporation</organization>
1106      <address><email>paulle@microsoft.com</email></address>
1107    </author>
1108    <author initials="T." surname="Berners-Lee" fullname="T. Berners-Lee">
1109      <organization>W3C</organization>
1110      <address><email>timbl@w3.org</email></address>
1111    </author>
1112    <date month="June" year="1999"/>
1113  </front>
1114  <seriesInfo name="RFC" value="2616"/>
1115</reference>
1116
1117<reference anchor='BCP90'>
1118  <front>
1119    <title>Registration Procedures for Message Header Fields</title>
1120    <author initials='G.' surname='Klyne' fullname='G. Klyne'>
1121      <organization>Nine by Nine</organization>
1122      <address><email>GK-IETF@ninebynine.org</email></address>
1123    </author>
1124    <author initials='M.' surname='Nottingham' fullname='M. Nottingham'>
1125      <organization>BEA Systems</organization>
1126      <address><email>mnot@pobox.com</email></address>
1127    </author>
1128    <author initials='J.' surname='Mogul' fullname='J. Mogul'>
1129      <organization>HP Labs</organization>
1130      <address><email>JeffMogul@acm.org</email></address>
1131    </author>
1132    <date year='2004' month='September' />
1133  </front>
1134  <seriesInfo name='BCP' value='90' />
1135  <seriesInfo name='RFC' value='3864' />
1136</reference>
1137
1138<reference anchor="BCP13">
1139  <front>
1140    <title>Media Type Specifications and Registration Procedures</title>
1141    <author initials="N." surname="Freed" fullname="N. Freed">
1142      <organization>Sun Microsystems</organization>
1143      <address>
1144        <email>ned.freed@mrochek.com</email>
1145      </address>
1146    </author>
1147    <author initials="J." surname="Klensin" fullname="J. Klensin">
1148      <address>
1149        <email>klensin+ietf@jck.com</email>
1150      </address>
1151    </author>
1152    <date year="2005" month="December"/>
1153  </front>
1154  <seriesInfo name="BCP" value="13"/>
1155  <seriesInfo name="RFC" value="4288"/>
1156</reference>
1157
1158<reference anchor='RFC5226'>
1159  <front>
1160    <title>Guidelines for Writing an IANA Considerations Section in RFCs</title>
1161    <author initials='T.' surname='Narten' fullname='T. Narten'>
1162      <organization>IBM</organization>
1163      <address><email>narten@us.ibm.com</email></address>
1164    </author>
1165    <author initials='H.' surname='Alvestrand' fullname='H. Alvestrand'>
1166      <organization>Google</organization>
1167      <address><email>Harald@Alvestrand.no</email></address>
1168    </author>
1169    <date year='2008' month='May' />
1170  </front>
1171  <seriesInfo name='BCP' value='26' />
1172  <seriesInfo name='RFC' value='5226' />
1173</reference>
1174
1175</references>
1176
1177<section title="Internet Media Type multipart/byteranges" anchor="internet.media.type.multipart.byteranges">
1178<iref item="Media Type" subitem="multipart/byteranges" primary="true"/>
1179<iref item="multipart/byteranges Media Type" primary="true"/>
1180<t>
1181   When an HTTP <x:ref>206 (Partial Content)</x:ref> response message includes the
1182   content of multiple ranges (a response to a request for multiple
1183   non-overlapping ranges), these are transmitted as a multipart
1184   message body (<xref target="RFC2046" x:fmt="," x:sec="5.1"/>). The media type for this purpose is called
1185   "multipart/byteranges".  The following is to be registered with IANA <xref target="BCP13"/>.
1186</t>
1187<t>
1188   The multipart/byteranges media type includes one or more parts, each
1189   with its own <x:ref>Content-Type</x:ref> and <x:ref>Content-Range</x:ref>
1190   fields. The required boundary parameter specifies the boundary string used
1191   to separate each body-part.
1192</t>
1193<t>
1194  <list style="hanging" x:indent="12em">
1195    <t hangText="Type name:">
1196      multipart
1197    </t>
1198    <t hangText="Subtype name:">
1199      byteranges
1200    </t>
1201    <t hangText="Required parameters:">
1202      boundary
1203    </t>
1204    <t hangText="Optional parameters:">
1205      none
1206    </t>
1207    <t hangText="Encoding considerations:">
1208      only "7bit", "8bit", or "binary" are permitted
1209    </t>
1210    <t hangText="Security considerations:">
1211      none
1212    </t>
1213    <t hangText="Interoperability considerations:">
1214      none
1215    </t>
1216    <t hangText="Published specification:">
1217      This specification (see <xref target="internet.media.type.multipart.byteranges"/>).
1218    </t>
1219    <t hangText="Applications that use this media type:">
1220      HTTP components supporting multiple ranges in a single request.
1221    </t>
1222    <t hangText="Additional information:">
1223      <list style="hanging">
1224        <t hangText="Magic number(s):">none</t>
1225        <t hangText="File extension(s):">none</t>
1226        <t hangText="Macintosh file type code(s):">none</t>
1227      </list>
1228    </t>
1229    <t hangText="Person and email address to contact for further information:">
1230      See Authors Section.
1231    </t>
1232    <t hangText="Intended usage:">
1233      COMMON
1234    </t>
1235    <t hangText="Restrictions on usage:">
1236      none
1237    </t>
1238    <t hangText="Author/Change controller:">
1239      IESG
1240    </t>
1241  </list>
1242</t>
1243<x:note>
1244  <t>
1245    &Note; Despite the name "multipart/byteranges" is not limited to the byte ranges only.
1246  </t>
1247</x:note>
1248<figure><preamble>
1249   For example:
1250</preamble><artwork type="example">
1251  HTTP/1.1 206 Partial Content
1252  Date: Wed, 15 Nov 1995 06:25:24 GMT
1253  Last-Modified: Wed, 15 Nov 1995 04:58:08 GMT
1254  Content-type: multipart/byteranges; boundary=THIS_STRING_SEPARATES
1255 
1256  --THIS_STRING_SEPARATES
1257  Content-type: application/pdf
1258  Content-range: bytes 500-999/8000
1259 
1260  ...the first range...
1261  --THIS_STRING_SEPARATES
1262  Content-type: application/pdf
1263  Content-range: bytes 7000-7999/8000
1264 
1265  ...the second range
1266  --THIS_STRING_SEPARATES--
1267</artwork></figure>
1268<figure><preamble>
1269   Another example, using the "exampleunit" range unit:
1270</preamble>
1271<artwork type="example">
1272  HTTP/1.1 206 Partial Content
1273  Date: Tue, 14 Nov 1995 06:25:24 GMT
1274  Last-Modified: Tue, 14 July 04:58:08 GMT
1275  Content-type: multipart/byteranges; boundary=THIS_STRING_SEPARATES
1276 
1277  --THIS_STRING_SEPARATES
1278  Content-type: video/example
1279  Content-range: exampleunit 1.2-4.3/25
1280 
1281  ...the first range...
1282  --THIS_STRING_SEPARATES
1283  Content-type: video/example
1284  Content-range: exampleunit 11.2-14.3/25
1285 
1286  ...the second range
1287  --THIS_STRING_SEPARATES--
1288</artwork>
1289</figure>
1290<t>
1291  Notes:
1292  <list style="numbers">
1293      <t>Additional CRLFs &MAY; precede the first boundary string in the body.</t>
1294
1295      <t>Although <xref target="RFC2046"/> permits the boundary string to be
1296         quoted, some existing implementations handle a quoted boundary
1297         string incorrectly.</t>
1298
1299      <t>A number of clients and servers were coded to an early draft
1300         of the byteranges specification to use a media type of
1301         multipart/x-byteranges<iref item="multipart/x-byteranges Media Type"/><iref item="Media Type" subitem="multipart/x-byteranges"/>, which is almost, but not quite
1302         compatible with the version documented in HTTP/1.1.</t>
1303  </list>
1304</t>
1305</section>
1306
1307<section title="Changes from RFC 2616" anchor="changes.from.rfc.2616">
1308
1309<t>
1310  A weak validator cannot be used in a <x:ref>206</x:ref> response.
1311  (<xref target="status.206"/>)
1312</t>
1313<t>
1314  The Content-Range header field only has meaning when the status code
1315  explicitly defines its use.
1316  (<xref target="header.content-range" />)
1317</t>
1318<t>
1319  Servers are given more leeway in how they respond to a range request,
1320  in order to mitigate abuse by malicious (or just greedy) clients.
1321</t>
1322<t>
1323  multipart/byteranges can consist of a single part.
1324  (<xref target="internet.media.type.multipart.byteranges"/>)
1325</t>
1326<t>
1327  This specification introduces a Range Specifier Registry.
1328  (<xref target="range.specifier.registry"/>)
1329</t>
1330</section>
1331
1332<section title="Imported ABNF" anchor="imported.abnf">
1333  <x:anchor-alias value="ALPHA"/>
1334  <x:anchor-alias value="CHAR"/>
1335  <x:anchor-alias value="CR"/>
1336  <x:anchor-alias value="DIGIT"/>
1337  <x:anchor-alias value="LF"/>
1338  <x:anchor-alias value="OCTET"/>
1339  <x:anchor-alias value="SP"/>
1340  <x:anchor-alias value="VCHAR"/>
1341  <x:anchor-alias value="token"/>
1342  <x:anchor-alias value="OWS"/>
1343  <x:anchor-alias value="HTTP-date"/>
1344  <x:anchor-alias value="entity-tag"/>
1345<t>
1346  The following core rules are included by
1347  reference, as defined in <xref target="RFC5234" x:fmt="of" x:sec="B.1"/>:
1348  ALPHA (letters), CR (carriage return), CRLF (CR LF), CTL (controls),
1349  DIGIT (decimal 0-9), DQUOTE (double quote),
1350  HEXDIG (hexadecimal 0-9/A-F/a-f), LF (line feed),
1351  OCTET (any 8-bit sequence of data), SP (space), and
1352  VCHAR (any visible US-ASCII character).
1353</t>
1354<t>
1355  Note that all rules derived from <x:ref>token</x:ref> are to
1356  be compared case-insensitively, like <x:ref>range-unit</x:ref> and
1357  <x:ref>acceptable-ranges</x:ref>.
1358</t>
1359<t>
1360  The rules below are defined in <xref target="Part1"/>:
1361</t>
1362<figure><artwork type="abnf2616">
1363  <x:ref>OWS</x:ref>        = &lt;OWS, defined in &whitespace;&gt;
1364  <x:ref>token</x:ref>      = &lt;token, defined in &field-components;&gt;
1365</artwork></figure>
1366<t>
1367  The rules below are defined in other parts:
1368</t>
1369<figure><artwork type="abnf2616">
1370  <x:ref>HTTP-date</x:ref>  = &lt;HTTP-date, defined in &http-date;&gt;
1371  <x:ref>entity-tag</x:ref> = &lt;entity-tag, defined in &entity-tags;&gt;
1372</artwork></figure>
1373</section>
1374
1375<?BEGININC p5-range.abnf-appendix ?>
1376<section xmlns:x="http://purl.org/net/xml2rfc/ext" title="Collected ABNF" anchor="collected.abnf">
1377<figure>
1378<artwork type="abnf" name="p5-range.parsed-abnf">
1379<x:ref>Accept-Ranges</x:ref> = acceptable-ranges
1380
1381<x:ref>Content-Range</x:ref> = byte-content-range-spec / other-content-range-spec
1382
1383<x:ref>HTTP-date</x:ref> = &lt;HTTP-date, defined in [Part2], Section 7.1.1.1&gt;
1384
1385<x:ref>If-Range</x:ref> = entity-tag / HTTP-date
1386
1387<x:ref>OWS</x:ref> = &lt;OWS, defined in [Part1], Section 3.2.3&gt;
1388
1389<x:ref>Range</x:ref> = byte-ranges-specifier / other-ranges-specifier
1390
1391<x:ref>acceptable-ranges</x:ref> = ( *( "," OWS ) range-unit *( OWS "," [ OWS
1392 range-unit ] ) ) / "none"
1393
1394<x:ref>byte-content-range-spec</x:ref> = bytes-unit SP byte-range-resp-spec "/" (
1395 instance-length / "*" )
1396<x:ref>byte-range-resp-spec</x:ref> = ( first-byte-pos "-" last-byte-pos ) / "*"
1397<x:ref>byte-range-set</x:ref> = *( "," OWS ) ( byte-range-spec /
1398 suffix-byte-range-spec ) *( OWS "," [ OWS ( byte-range-spec /
1399 suffix-byte-range-spec ) ] )
1400<x:ref>byte-range-spec</x:ref> = first-byte-pos "-" [ last-byte-pos ]
1401<x:ref>byte-ranges-specifier</x:ref> = bytes-unit "=" byte-range-set
1402<x:ref>bytes-unit</x:ref> = "bytes"
1403
1404<x:ref>entity-tag</x:ref> = &lt;entity-tag, defined in [Part4], Section 2.3&gt;
1405
1406<x:ref>first-byte-pos</x:ref> = 1*DIGIT
1407
1408<x:ref>instance-length</x:ref> = 1*DIGIT
1409
1410<x:ref>last-byte-pos</x:ref> = 1*DIGIT
1411
1412<x:ref>other-content-range-spec</x:ref> = other-range-unit SP other-range-resp-spec
1413<x:ref>other-range-resp-spec</x:ref> = *CHAR
1414<x:ref>other-range-set</x:ref> = 1*CHAR
1415<x:ref>other-range-unit</x:ref> = token
1416<x:ref>other-ranges-specifier</x:ref> = other-range-unit "=" other-range-set
1417
1418<x:ref>range-unit</x:ref> = bytes-unit / other-range-unit
1419
1420<x:ref>suffix-byte-range-spec</x:ref> = "-" suffix-length
1421<x:ref>suffix-length</x:ref> = 1*DIGIT
1422
1423<x:ref>token</x:ref> = &lt;token, defined in [Part1], Section 3.2.6&gt;
1424</artwork>
1425</figure>
1426</section>
1427<?ENDINC p5-range.abnf-appendix ?>
1428
1429
1430<section title="Change Log (to be removed by RFC Editor before publication)" anchor="change.log">
1431<t>
1432  Changes up to the first Working Group Last Call draft are summarized
1433  in <eref target="http://tools.ietf.org/html/draft-ietf-httpbis-p5-range-19#appendix-D"/>.
1434</t>
1435
1436<section title="Since draft-ietf-httpbis-p5-range-19" anchor="changes.since.19">
1437<t>
1438  Closed issues:
1439  <list style="symbols">
1440    <t>
1441      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/358"/>:
1442      "ABNF list expansion code problem"
1443    </t>
1444    <t>
1445      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/361"/>:
1446      "ABNF requirements for recipients"
1447    </t>
1448    <t>
1449      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/367"/>:
1450      "reserve 'none' as byte range unit"
1451    </t>
1452    <t>
1453      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/368"/>:
1454      "note introduction of new IANA registries as normative changes"
1455    </t>
1456    <t>
1457      <eref target="http://tools.ietf.org/wg/httpbis/trac/ticket/369"/>:
1458      "range units vs leading zeroes vs size"
1459    </t>
1460  </list>
1461</t>
1462</section>
1463
1464<section title="Since draft-ietf-httpbis-p5-range-20" anchor="changes.since.20">
1465<t>
1466  <list style="symbols">
1467    <t>
1468      Conformance criteria and considerations regarding error handling are
1469      now defined in Part 1.
1470    </t>
1471  </list>
1472</t>
1473</section>
1474
1475<section title="Since draft-ietf-httpbis-p5-range-21" anchor="changes.since.21">
1476<t>
1477  None yet.
1478</t>
1479</section>
1480
1481</section>
1482
1483</back>
1484</rfc>
Note: See TracBrowser for help on using the repository browser.