Network Working Group R. Fielding, Editor
Internet Draft Day Software
<draft-ietf-httpbis-p6-cache-latest> J. Gettys
Obsoletes: 2616 (if approved) One Laptop per Child
Intended status: Standards Track J. Mogul
Expires: June 2009 HP
H. Frystyk
Microsoft
L. Masinter
Adobe Systems
P. Leach
Microsoft
T. Berners-Lee
W3C/MIT
Y. Lafon, Editor
W3C
J. F. Reschke, Editor
greenbytes
December 11, 2008

HTTP/1.1, part 6: Caching
draft-ietf-httpbis-p6-cache-latest

Status of this Memo

By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware have been or will be disclosed, and any of which he or she becomes aware will be disclosed, in accordance with Section 6 of BCP 79.

Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts.

Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as “work in progress”.

The list of current Internet-Drafts can be accessed at <http://www.ietf.org/ietf/1id-abstracts.txt>.

The list of Internet-Draft Shadow Directories can be accessed at <http://www.ietf.org/shadow.html>.

This Internet-Draft will expire in June 2009.

Abstract

The Hypertext Transfer Protocol (HTTP) is an application-level protocol for distributed, collaborative, hypermedia information systems. This document is Part 6 of the seven-part specification that defines the protocol referred to as "HTTP/1.1" and, taken together, obsoletes RFC 2616. Part 6 defines requirements on HTTP caches and the associated header fields that control cache behavior or indicate cacheable response messages.

Editorial Note (To be removed by RFC Editor)

Discussion of this draft should take place on the HTTPBIS working group mailing list (ietf-http-wg@w3.org). The current issues list is at <http://tools.ietf.org/wg/httpbis/trac/report/11> and related documents (including fancy diffs) can be found at <http://tools.ietf.org/wg/httpbis/>.

The changes in this draft are summarized in Appendix B.6.


Table of Contents

1. Introduction

HTTP is typically used for distributed information systems, where performance can be improved by the use of response caches. This document defines aspects of HTTP/1.1 related to caching and reusing response messages.

1.1 Purpose

An HTTP cache is a local store of response messages and the subsystem that controls its message storage, retrieval, and deletion. A cache stores cacheable responses in order to reduce the response time and network bandwidth consumption on future, equivalent requests. Any client or server may include a cache, though a cache cannot be used by a server that is acting as a tunnel.

Caching would be useless if it did not significantly improve performance. The goal of caching in HTTP/1.1 is to reuse a prior response message to satisfy a current request. In some cases, a stored response can be reused without the need for a network request, reducing latency and network round-trips; a "freshness" mechanism is used for this purpose (see Section 3.3). Even when a new request is required, it is often possible to reuse all or parts of the payload of a prior response to satisfy the request, thereby reducing network bandwidth usage; a "validation" mechanism is used for this purpose (see Section 3.4).

1.2 Terminology

This specification uses a number of terms to refer to the roles played by participants in, and objects of, HTTP caching.

cacheable

A response is cacheable if a cache is allowed to store a copy of the response message for use in answering subsequent requests. Even when a response is cacheable, there may be additional constraints on whether a cache can use the cached copy to satisfy a particular request.

explicit expiration time

The time at which the origin server intends that an entity should no longer be returned by a cache without further validation.

heuristic expiration time

An expiration time assigned by a cache when no explicit expiration time is available.

age

The age of a response is the time since it was sent by, or successfully validated with, the origin server.

first-hand

A response is first-hand if the freshness model is not in use; i.e., its age is 0.

freshness lifetime

The length of time between the generation of a response and its expiration time.

fresh

A response is fresh if its age has not yet exceeded its freshness lifetime.

stale

A response is stale if its age has passed its freshness lifetime.

validator

A protocol element (e.g., an entity tag or a Last-Modified time) that is used to find out whether a stored response is an equivalent copy of an entity.

shared cache

A cache that is accessible to more than one user. A non-shared cache is dedicated to a single user.

1.3 Requirements

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].

An implementation is not compliant if it fails to satisfy one or more of the MUST or REQUIRED level requirements for the protocols it implements. An implementation that satisfies all the MUST or REQUIRED level and all the SHOULD level requirements for its protocols is said to be "unconditionally compliant"; one that satisfies all the MUST level requirements but not all the SHOULD level requirements for its protocols is said to be "conditionally compliant."

2. Notational Conventions and Generic Grammar

This specification uses the ABNF syntax defined in Section 1.2.1 of [Part1] and the core rules defined in Section 1.2.2 of [Part1]: [abnf.dep: ABNF syntax and basic rules will be adopted from RFC 5234, see <http://ietf.org/wg/httpbis/trac/ticket/36>.]

  DIGIT         = <DIGIT, defined in [Part1], Section 1.2.2>
  DQUOTE        = <DQUOTE, defined in [Part1], Section 1.2.2>
  SP            = <SP, defined in [Part1], Section 1.2.2>
  quoted-string = <quoted-string, defined in [Part1], Section 1.2.2>
  token         = <token, defined in [Part1], Section 1.2.2>

The ABNF rules below are defined in other parts:

  field-name    = <field-name, defined in [Part1], Section 4.2>
  HTTP-date     = <HTTP-date, defined in [Part1], Section 3.2.1>
  port          = <port, defined in [Part1], Section 2.1>
  pseudonym     = <pseudonym, defined in [Part1], Section 8.9> 
  uri-host      = <uri-host, defined in [Part1], Section 2.1>

3. Cache Operation

3.1 Response Cacheability

A cache MAY store a response to any request, provided that:

Note that in normal operation, most caches will not store a response that has neither a cache validator nor an explicitly expiration time, as such responses are not usually useful to store. However, caches are not prohibited from storing such responses.

3.1.1 Storing Incomplete Responses

A cache that receives an incomplete response (for example, with fewer bytes of data than specified in a Content-Length header) MAY store the response. However, the cache MUST treat this as a partial response [Part5]. Partial responses MAY be combined as described in Section 4 of [Part5]; the result might be a full response or might still be partial. A cache MUST NOT return a partial response to a client without explicitly marking it as such using the 206 (Partial Content) status code.

A cache that does not support the Range and Content-Range headers MUST NOT store incomplete or partial responses.

3.2 Constructing Responses from Caches

For a given request, a non-shared cache MAY return a stored response, provided that:

[rfc.comment.2: ISSUE: This doesn't specify whether the request method is part of the cache key.]

A shared cache MAY return a stored response, provided that:

All responses satisfied from cache MUST include an appropriate Age header field (Section 4.1).

All request methods other than GET and HEAD MUST be written through the cache to the origin server. Note that such requests might invalidate already stored responses; see Section 3.5.

Caches SHOULD use the most recent response (as determined by the Date header) when more than one applicable response is stored. They MAY also send a request with "Cache-Control: max-age=0" or "Cache-Control: no-cache" to disambiguate which response to use.

In the process of determining whether a stored response is fresh or not, a cache MAY validate that response (see Section 3.4).

[rfc.comment.3: TODO: end-to-end and hop-by-hop headers, non-modifiable headers removed; re-spec in p1]

3.3 Freshness Model

HTTP caching works best when caches can entirely avoid making requests to the origin server. When a response is "fresh" in the cache, it can be used to satisfy subsequent requests without contacting the origin server. This is also referred to as "expiration."

Expiration applies only to responses taken from a cache and not to first-hand responses. It cannot be used to force a user agent to refresh its display or reload a resource; its semantics apply only to caches. See Section 5 for an explanation of the difference between caches and history mechanisms.

The primary mechanism for avoiding requests is for an origin server to provide an explicit expiration time in the future, using either the Expires header Section 4.3 or the max-age response cache directive Section 4.2.2. Generally, origin servers will assign future explicit expiration times to responses in the belief that the entity is not likely to change in a semantically significant way before the expiration time is reached. This normally preserves cache correctness, as long as the server's expiration times are carefully chosen.

If an origin server wishes to force a cache to validate every request, it MAY assign an explicit expiration time in the past. This means that the response is always stale, so that caches should validate it before using it for subsequent requests.

Since origin servers do not always provide explicit expiration times, HTTP caches may assign heuristic expiration times when they are not specified, employing algorithms that use other header values (such as the Last-Modified time) to estimate a plausible expiration time. The HTTP/1.1 specification does not provide specific algorithms, but does impose worst-case constraints on their results.

The calculation to determine if a response has expired is:

   response_is_fresh = (freshness_lifetime > current_age)

The freshness_lifetime is defined in Section 3.3.1; the current_age is defined in Section 3.3.2.

Additionally, clients may need to influence freshness calculation. They can do this using several request cache directives, with the effect of either increasing or loosening constraints on freshness. See Section 4.2.1.

[rfc.comment.4: ISSUE: there are not requirements directly applying to cache-request-directives and freshness.]

3.3.1 Calculating Freshness Lifetime

A cache can calculate the freshness lifetime (denoted as freshness_lifetime) of a response by using the first match of:

Note that this calculation is not vulnerable to clock skew, since all of the information comes from the origin server.

3.3.1.1 Using Heuristic Freshness

If no explicit expiration time is present in a stored response that has a status code of 200, 203, 206, 300, 301 or 410, a heuristic expiration time MAY be calculated. Heuristics MUST NOT be used for other response status codes.

When a heuristic is used to calculate freshness lifetime, the cache SHOULD attach a Warning header with a 113 warn-code to the response if its current_age is more than 24 hours and such a warning is not already present.

Also, if the response has a Last-Modified header Section 6.6 of [Part4], the heuristic expiration value SHOULD be no more than some fraction of the interval since that time. A typical setting of this fraction might be 10%.

[rfc.comment.5: REVIEW: took away HTTP/1.0 query string heuristic uncacheability.]

3.3.2 Calculating Age

HTTP/1.1 uses the Age response-header to convey the estimated age of the response message when obtained from a cache. The Age field value is the cache's estimate of the amount of time since the response was generated or validated by the origin server. In essence, the Age value is the sum of the time that the response has been resident in each of the caches along the path from the origin server, plus the amount of time it has been in transit along network paths.

When a response is generated from a stored response, the cache MUST include a single Age header field in the response with a value equal to the stored response's current_age, calculated using the algorithm described in this section.

The term "age_value" denotes the value of the Age header, in a form appropriate for arithmetic operations.

HTTP/1.1 requires origin servers to send a Date header, if possible, with every response, giving the time at which the response was generated (see Section 8.3 of [Part1]). The term "date_value" denotes the value of the Date header, in a form appropriate for arithmetic operations.

The term "now" means "the current value of the clock at the host performing the calculation." Hosts that use HTTP, but especially hosts running origin servers and caches, SHOULD use NTP [RFC1305] or some similar protocol to synchronize their clocks to a globally accurate time standard.

A response's age can be calculated in two entirely independent ways:

  1. now minus date_value, if the local clock is reasonably well synchronized to the origin server's clock. If the result is negative, the result is replaced by zero.
  2. age_value, if all of the caches along the response path implement HTTP/1.1.

These are combined as

    corrected_received_age = max(now - date_value, age_value)

When an Age value is received, it MUST be interpreted relative to the time the request was initiated, not the time that the response was received.

   corrected_initial_age = corrected_received_age
                         + (now - request_time)

where "request_time" is the time (according to the local clock) when the request that elicited this response was sent.

The current_age of a stored response can then be calculated by adding the amount of time (in seconds) since the stored response was last validated by the origin server to the corrected_initial_age.

In summary:

   /*
    * age_value
    *      is the value of Age: header received by the cache with
    *              this response.
    * date_value
    *      is the value of the origin server's Date: header
    * request_time
    *      is the (local) time when the cache made the request
    *              that resulted in this stored response
    * response_time
    *      is the (local) time when the cache received the
    *              response
    * now
    *      is the current (local) time
    */

   apparent_age = max(0, response_time - date_value);
   corrected_received_age = max(apparent_age, age_value);
   response_delay = response_time - request_time;
   corrected_initial_age = corrected_received_age + response_delay;
   resident_time = now - response_time;
   current_age   = corrected_initial_age + resident_time;

3.3.3 Serving Stale Responses

A "stale" response is one that either has explicit expiry information, or is allowed to have heuristic expiry calculated, but is not fresh according to the calculations in Section 3.3.

Caches MUST NOT return a stale response if it is prohibited by an explicit in-protocol directive (e.g., by a "no-store" or "no-cache" cache directive, a "must-revalidate" cache-response-directive, or an applicable "s-maxage" or "proxy-revalidate" cache-response-directive; see Section 4.2.2).

Caches MAY return a stale response if disconnected or explicitly allowed (e.g., the max-stale request directive; see Section 4.2.1).

Otherwise, caches SHOULD NOT return stale responses.

Stale responses SHOULD have a Warning header with the 110 warn-code (see 4.6).

If a cache receives a first-hand response (either an entire response, or a 304 (Not Modified) response) that it would normally forward to the requesting client, and the received response is no longer fresh, the cache SHOULD forward it to the requesting client without adding a new Warning (but without removing any existing Warning headers). A cache SHOULD NOT attempt to validate a response simply because that response became stale in transit.

3.4 Validation Model

When a cache has a stale response that it would like to use, it SHOULD first check with the origin server (or possibly an intermediate cache with a fresh response) to see if it is still usable. This is called "validating" or "revalidating" the stored response.

HTTP's conditional request mechanism, defined in [Part4], is used to avoid retransmitting the response payload when the stored response is valid. When a stored response includes one or more "cache validators," such as the field values of an ETag or Last-Modified header field, then a validating GET request SHOULD be made conditional to those field values. The server checks the conditional request's validator against the current state of the requested resource and, if they match, the server responds with a 304 (Not Modified) status code to indicate that the stored response can be refreshed and reused without retransmitting the response payload. If the validator does not match the current state of the requested resource, then the server returns a full response, including payload, so that the request can be satisfied and the stored response supplanted without the need for an additional network round-trip.

See Section 3.7 regarding combining cached headers with those in a 304 response.

If a cache receives a 5xx response while attempting to validate a response, it MAY either forward this response to the requesting client, or act as if the server failed to respond. In the latter case, it MAY return a previously received response unless the stored response includes the "must-revalidate" cache directive (see Section 4.2.2).

3.5 Request Methods that Invalidate

Because unsafe methods Section 7.1.1 of [Part2] have the potential for changing state on the origin server, intervening caches have the opportunity to use them to keep their contents up-to-date.

The following HTTP methods MUST cause a cache to invalidate the Request-URI as well as the Location and Content-Location headers (if present):

An invalidation based on the URI in a Location or Content-Location header MUST NOT be performed if the host part of that URI differs from the host part in the Request-URI. This helps prevent denial of service attacks.

[rfc.comment.6: TODO: "host part" needs to be specified better.]

A cache that passes through requests for methods it does not understand SHOULD invalidate the Request-URI.

Here, "invalidate" means that the cache will either remove all stored responses related to the Request-URI, or will mark these as "invalid" and in need of a mandatory validation before they can be returned in response to a subsequent request.

Note that this does not guarantee that all appropriate responses are invalidated. For example, the request that caused the change at the origin server might not have gone through the cache where a response is stored.

[rfc.comment.7: TODO: specify that only successful (2xx, 3xx?) responses invalidate.]

3.6 Caching Negotiated Responses

Use of server-driven content negotiation (Section 4.1 of [Part3]), as indicated by the presence of a Vary header field Section 4.5 in a response, alters the conditions and procedure by which a cache can use the response for subsequent requests.

When the cache receives a subsequent request which may be satisfied by a stored responses that include a Vary header field, it MUST NOT use it to satisfy the request unless all of the selecting request-headers present in the new request match the corresponding stored request-headers from the original request.

The selecting request-headers from two requests are defined to match if and only if the selecting request-headers in the first request can be transformed to the selecting request-headers in the second request by adding or removing linear white space [rfc.comment.8: [ref]] at places where this is allowed by the corresponding ABNF, and/or combining multiple message-header fields with the same field name following the rules about message headers in Section 4.2 of [Part1].

A Vary header field-value of "*" always fails to match, and subsequent requests on that resource can only be properly interpreted by the origin server.

If the selecting request header fields for the stored response do not match the selecting request header fields of the new request, then the cache MUST NOT use the stored response to satisfy the request unless it first relays the new request to the origin server in a conditional request and the server responds with 304 (Not Modified), including an entity tag or Content-Location that indicates the entity to be used.

If one or more applicable stored response has an entity tag, the forwarded request SHOULD be conditional and include all of these entity tags in an If-None-Match header field. This conveys to the server the set of entities currently stored by the cache, so that if any one of these entities matches the requested entity, the server can use the ETag header field in its 304 (Not Modified) response to tell the cache which stored response is appropriate. If the entity-tag of the new response matches that of an existing stored resopnse, the new response SHOULD be used to update its header fields, and the result MUST be returned to the client.

If any of the existing stored responses contains only partial content for the associated entity, its entity-tag SHOULD NOT be included in the If-None-Match header field unless the request is for a range that would be fully satisfied by that stored response.

If a cache receives a successful response whose Content-Location field matches that of an existing stored response for the same Request-URI, whose entity-tag differs from that of the existing stored response, and whose Date is more recent than that of the existing response, the existing response SHOULD NOT be returned in response to future requests and SHOULD be deleted from the cache.

[rfc.comment.9: TODO: this still needs work.]

3.7 Combining Responses

When a cache receives a 304 (Not Modified) response or a 206 (Partial Content) response, it needs to update the stored response with the new one, so that the updated response can be sent to the client.

If the status code is 304 (Not Modified), the cache SHOULD use the stored entity-body as the updated entity-body. If the status code is 206 (Partial Content) and the ETag or Last-Modified headers match exactly, the cache MAY combine the stored entity-body in the stored response with the updated entity-body received in the response and use the result as the updated entity-body (see Section 4 of [Part5]).

The stored response headers are used for the updated response, except that

A cache MUST also replace stored headers with corresponding headers received in the incoming response, except for Warning headers as described immediately above. If a header field-name in the incoming response matches more than one header in the stored response, all such old headers MUST be replaced. it MAY store the combined entity-body.

[rfc.comment.10: ISSUE: discuss how to handle HEAD updates]

4. Header Field Definitions

This section defines the syntax and semantics of HTTP/1.1 header fields related to caching.

For entity-header fields, both sender and recipient refer to either the client or the server, depending on who sends and who receives the entity.

4.1 Age

The Age response-header field conveys the sender's estimate of the amount of time since the response (or its validation) was generated at the origin server. Age values are calculated as specified in Section 3.3.2.

  Age = "Age" ":" age-value
  age-value = delta-seconds

Age field-values are non-negative decimal integers, representing time in seconds.

  delta-seconds  = 1*DIGIT

If a cache receives a value larger than the largest positive integer it can represent, or if any of its age calculations overflows, it MUST transmit an Age header with a field-value of 2147483648 (231). Caches SHOULD use an arithmetic type of at least 31 bits of range.

The presence of an Age header field in a response implies that a response is not first-hand. However, the converse is not true, since HTTP/1.0 caches may not implement the Age header field.

4.2 Cache-Control

The Cache-Control general-header field is used to specify directives that MUST be obeyed by all caches along the request/response chain. The directives specify behavior intended to prevent caches from adversely interfering with the request or response. Cache directives are unidirectional in that the presence of a directive in a request does not imply that the same directive is to be given in the response.

Note that HTTP/1.0 caches might not implement Cache-Control and might only implement Pragma: no-cache (see Section 4.4).

Cache directives MUST be passed through by a proxy or gateway application, regardless of their significance to that application, since the directives might be applicable to all recipients along the request/response chain. It is not possible to target a directive to a specific cache.

  Cache-Control   = "Cache-Control" ":" 1#cache-directive

  cache-directive = cache-request-directive
     / cache-response-directive

  cache-extension = token [ "=" ( token / quoted-string ) ]

4.2.1 Request Cache-Control Directives

  cache-request-directive =
       "no-cache"
     / "no-store"
     / "max-age" "=" delta-seconds
     / "max-stale" [ "=" delta-seconds ]
     / "min-fresh" "=" delta-seconds
     / "no-transform"
     / "only-if-cached"
     / cache-extension

no-cache

The no-cache request directive indicates that a stored response MUST NOT be used to satisfy the request without successful validation on the origin server.

no-store

The no-store request directive indicates that a cache MUST NOT store any part of either this request or any response to it. This directive applies to both non-shared and shared caches. "MUST NOT store" in this context means that the cache MUST NOT intentionally store the information in non-volatile storage, and MUST make a best-effort attempt to remove the information from volatile storage as promptly as possible after forwarding it.
This directive is NOT a reliable or sufficient mechanism for ensuring privacy. In particular, malicious or compromised caches might not recognize or obey this directive, and communications networks may be vulnerable to eavesdropping.

max-age

The max-age request directive indicates that the client is willing to accept a response whose age is no greater than the specified time in seconds. Unless max-stale directive is also included, the client is not willing to accept a stale response.

max-stale

The max-stale request directive indicates that the client is willing to accept a response that has exceeded its expiration time. If max-stale is assigned a value, then the client is willing to accept a response that has exceeded its expiration time by no more than the specified number of seconds. If no value is assigned to max-stale, then the client is willing to accept a stale response of any age.

min-fresh

The min-fresh request directive indicates that the client is willing to accept a response whose freshness lifetime is no less than its current age plus the specified time in seconds. That is, the client wants a response that will still be fresh for at least the specified number of seconds.

no-transform

The no-transform request directive indicates that an intermediate cache or proxy MUST NOT change the Content-Encoding, Content-Range or Content-Type request headers, nor the request entity-body.

only-if-cached

The only-if-cached request directive indicates that the client only wishes to return a stored response. If it receives this directive, a cache SHOULD either respond using a stored response that is consistent with the other constraints of the request, or respond with a 504 (Gateway Timeout) status. If a group of caches is being operated as a unified system with good internal connectivity, such a request MAY be forwarded within that group of caches.

4.2.2 Response Cache-Control Directives

  cache-response-directive =
       "public"
     / "private" [ "=" DQUOTE 1#field-name DQUOTE ]
     / "no-cache" [ "=" DQUOTE 1#field-name DQUOTE ]
     / "no-store"
     / "no-transform"
     / "must-revalidate"
     / "proxy-revalidate"
     / "max-age" "=" delta-seconds
     / "s-maxage" "=" delta-seconds
     / cache-extension

public

The public response directive indicates that the response MAY be cached, even if it would normally be non-cacheable or cacheable only within a non-shared cache. (See also Authorization, Section 3.1 of [Part7], for additional details.)

private

The private response directive indicates that the response message is intended for a single user and MUST NOT be stored by a shared cache. A private (non-shared) cache MAY store the response.
If the private response directive specifies one or more field-names, this requirement is limited to the field-values associated with the listed response headers. That is, the specified field-names(s) MUST NOT be stored by a shared cache, whereas the remainder of the response message MAY be.
Note: This usage of the word private only controls where the response may be stored, and cannot ensure the privacy of the message content.

no-cache

The no-cache response directive indicates that a response MUST NOT be used to satisfy a subsequent request without successful validation on the origin server. This allows an origin server to prevent caching even by caches that have been configured to return stale responses.
If the no-cache response directive specifies one or more field-names, this requirement is limited to the field-values assosicated with the listed response headers. That is, the specified field-name(s) MUST NOT be sent in the response to a subsequent request without successful validation on the origin server. This allows an origin server to prevent the re-use of certain header fields in a response, while still allowing caching of the rest of the response.
Note: Most HTTP/1.0 caches will not recognize or obey this directive.

no-store

The no-store response directive indicates that a cache MUST NOT store any part of either the immediate request or response. This directive applies to both non-shared and shared caches. "MUST NOT store" in this context means that the cache MUST NOT intentionally store the information in non-volatile storage, and MUST make a best-effort attempt to remove the information from volatile storage as promptly as possible after forwarding it.
This directive is NOT a reliable or sufficient mechanism for ensuring privacy. In particular, malicious or compromised caches might not recognize or obey this directive, and communications networks may be vulnerable to eavesdropping.

must-revalidate

The must-revalidate response directive indicates that validation is required before the response is used by a cache to satisfy any request.
When the present, caches MUST NOT use a stored after it becomes stale to respond to a subsequent request without first validating it with the origin server.
The must-revalidate directive is necessary to support reliable operation for certain protocol features. In all circumstances an HTTP/1.1 cache MUST obey the must-revalidate directive; in particular, if the cache cannot reach the origin server for any reason, it MUST generate a 504 (Gateway Timeout) response.
Servers SHOULD send the must-revalidate directive if and only if failure to validate a request on the entity could result in incorrect operation, such as a silently unexecuted financial transaction.

proxy-revalidate

The proxy-revalidate response directive has the same meaning as the must-revalidate response directive, except that it does not apply to non-shared caches.

max-age

The max-age response directive indicates that response is to be considered stale after its age is greater than the specified number of seconds.

s-maxage

The s-maxage response directive indicates that, in shared caches, the maximum age specified by this directive overrides the maximum age specified by either the max-age directive or the Expires header. The s-maxage directive also implies the semantics of the proxy-revalidate response directive.

no-transform

The no-transform response directive indicates that an intermediate cache or proxy MUST NOT change the Content-Encoding, Content-Range or Content-Type response headers, nor the response entity-body.

4.2.3 Cache Control Extensions

The Cache-Control header field can be extended through the use of one or more cache-extension tokens, each with an optional value. Informational extensions (those which do not require a change in cache behavior) MAY be added without changing the semantics of other directives. Behavioral extensions are designed to work by acting as modifiers to the existing base of cache directives. Both the new directive and the standard directive are supplied, such that applications which do not understand the new directive will default to the behavior specified by the standard directive, and those that understand the new directive will recognize it as modifying the requirements associated with the standard directive. In this way, extensions to the cache-control directives can be made without requiring changes to the base protocol.

This extension mechanism depends on an HTTP cache obeying all of the cache-control directives defined for its native HTTP-version, obeying certain extensions, and ignoring all directives that it does not understand.

For example, consider a hypothetical new response directive called "community" which acts as a modifier to the private directive. We define this new directive to mean that, in addition to any non-shared cache, any cache which is shared only by members of the community named within its value may cache the response. An origin server wishing to allow the UCI community to use an otherwise private response in their shared cache(s) could do so by including

    Cache-Control: private, community="UCI"

A cache seeing this header field will act correctly even if the cache does not understand the community cache-extension, since it will also see and understand the private directive and thus default to the safe behavior.

Unrecognized cache directives MUST be ignored; it is assumed that any cache directive likely to be unrecognized by an HTTP/1.1 cache will be combined with standard directives (or the response's default cacheability) such that the cache behavior will remain minimally correct even if the cache does not understand the extension(s).

4.3 Expires

The Expires entity-header field gives the date/time after which the response is considered stale. See Section 3.3 for further discussion of the expiration model.

The presence of an Expires field does not imply that the original resource will change or cease to exist at, before, or after that time.

The field-value is an absolute date and time as defined by HTTP-date in Section 3.2.1 of [Part1]; it MUST be sent in rfc1123-date format.

  Expires = "Expires" ":" HTTP-date

For example

   Expires: Thu, 01 Dec 1994 16:00:00 GMT

Note: if a response includes a Cache-Control field with the max-age directive (see Section 4.2.2), that directive overrides the Expires field.

HTTP/1.1 servers SHOULD NOT send Expires dates more than one year in the future.

HTTP/1.1 clients and caches MUST treat other invalid date formats, especially including the value "0", as in the past (i.e., "already expired").

4.4 Pragma

The Pragma general-header field is used to include implementation-specific directives that might apply to any recipient along the request/response chain. All pragma directives specify optional behavior from the viewpoint of the protocol; however, some systems MAY require that behavior be consistent with the directives.

  Pragma            = "Pragma" ":" 1#pragma-directive
  pragma-directive  = "no-cache" / extension-pragma
  extension-pragma  = token [ "=" ( token / quoted-string ) ]

When the no-cache directive is present in a request message, an application SHOULD forward the request toward the origin server even if it has a cached copy of what is being requested. This pragma directive has the same semantics as the no-cache response directive (see Section 4.2.2) and is defined here for backward compatibility with HTTP/1.0. Clients SHOULD include both header fields when a no-cache request is sent to a server not known to be HTTP/1.1 compliant. HTTP/1.1 caches SHOULD treat "Pragma: no-cache" as if the client had sent "Cache-Control: no-cache".

Note: because the meaning of "Pragma: no-cache" as a response-header field is not actually specified, it does not provide a reliable replacement for "Cache-Control: no-cache" in a response.

This mechanism is deprecated; no new Pragma directives will be defined in HTTP.

4.5 Vary

The Vary response-header field's value indicates the set of request-header fields that fully determines, while the response is fresh, whether a cache is permitted to use the response to reply to a subsequent request without validation. For uncacheable or stale responses, the Vary field value advises the user agent about the criteria that were used to select the representation. A Vary field value of "*" implies that a cache cannot determine from the request headers of a subsequent request whether this response is the appropriate representation. See Section 3.6 for use of the Vary header field by caches.

  Vary  = "Vary" ":" ( "*" / 1#field-name )

The set of header fields named by the Vary field value is known as the "selecting" request-headers.

Servers SHOULD include a Vary header field with any cacheable response that is subject to server-driven negotiation. Doing so allows a cache to properly interpret future requests on that resource and informs the user agent about the presence of negotiation on that resource. A server MAY include a Vary header field with a non-cacheable response that is subject to server-driven negotiation, since this might provide the user agent with useful information about the dimensions over which the response varies at the time of the response.

A Vary field value of "*" signals that unspecified parameters not limited to the request-headers (e.g., the network address of the client), play a role in the selection of the response representation. The "*" value MUST NOT be generated by a proxy server; it may only be generated by an origin server.

The field-names given are not limited to the set of standard request-header fields defined by this specification. Field names are case-insensitive.

4.6 Warning

The Warning general-header field is used to carry additional information about the status or transformation of a message which might not be reflected in the message. This information is typically used to warn about possible incorrectness introduced by caching operations or transformations applied to the entity body of the message.

Warnings can be used for other purposes, both cache-related and otherwise. The use of a warning, rather than an error status code, distinguish these responses from true failures.

Warning headers can in general be applied to any message, however some warn-codes are specific to caches and can only be applied to response messages.

  Warning    = "Warning" ":" 1#warning-value
  
  warning-value = warn-code SP warn-agent SP warn-text
                                        [SP warn-date]
  
  warn-code  = 3DIGIT
  warn-agent = ( uri-host [ ":" port ] ) / pseudonym
                  ; the name or pseudonym of the server adding
                  ; the Warning header, for use in debugging
  warn-text  = quoted-string
  warn-date  = DQUOTE HTTP-date DQUOTE

Multiple warnings MAY be attached to a response (either by the origin server or by a cache), including multiple warnings with the same code number. For example, a server might provide the same warning with texts in both English and Basque.

When this occurs, the user agent SHOULD inform the user of as many of them as possible, in the order that they appear in the response. If it is not possible to inform the user of all of the warnings, the user agent SHOULD follow these heuristics:

Systems that generate multiple Warning headers SHOULD order them with this user agent behavior in mind. New Warning headers SHOULD be added after any existing Warning headers.

Warnings are assigned three digit warn-codes. The first digit indicates whether the Warning is required to be deleted from a stored response after validation:

The warn-text SHOULD be in a natural language and character set that is most likely to be intelligible to the human user receiving the response. This decision can be based on any available knowledge, such as the location of the cache or user, the Accept-Language field in a request, the Content-Language field in a response, etc. The default language is English and the default character set is ISO-8859-1 ([ISO-8859-1]).

If a character set other than ISO-8859-1 is used, it MUST be encoded in the warn-text using the method described in [RFC2047].

If an implementation sends a message with one or more Warning headers to a receiver whose version is HTTP/1.0 or lower, then the sender MUST include in each warning-value a warn-date that matches the Date header in the message.

If an implementation receives a message with a warning-value that includes a warn-date, and that warn-date is different from the Date value in the response, then that warning-value MUST be deleted from the message before storing, forwarding, or using it. (preventing the consequences of naive caching of Warning header fields.) If all of the warning-values are deleted for this reason, the Warning header MUST be deleted as well.

The following warn-codes are defined by this specification, each with a recommended warn-text in English, and a description of its meaning.

110 Response is stale

SHOULD be included whenever the returned response is stale.

111 Revalidation failed

SHOULD be included if a cache returns a stale response because an attempt to validate the response failed, due to an inability to reach the server.

112 Disconnected operation

SHOULD be included if the cache is intentionally disconnected from the rest of the network for a period of time.

113 Heuristic expiration

SHOULD be included if the cache heuristically chose a freshness lifetime greater than 24 hours and the response's age is greater than 24 hours.

199 Miscellaneous warning

The warning text MAY include arbitrary information to be presented to a human user, or logged. A system receiving this warning MUST NOT take any automated action, besides presenting the warning to the user.

214 Transformation applied

MUST be added by an intermediate cache or proxy if it applies any transformation changing the content-coding (as specified in the Content-Encoding header) or media-type (as specified in the Content-Type header) of the response, or the entity-body of the response, unless this Warning code already appears in the response.

299 Miscellaneous persistent warning

The warning text MAY include arbitrary information to be presented to a human user, or logged. A system receiving this warning MUST NOT take any automated action.

5. History Lists

User agents often have history mechanisms, such as "Back" buttons and history lists, which can be used to redisplay an entity retrieved earlier in a session.

History mechanisms and caches are different. In particular history mechanisms SHOULD NOT try to show a correct view of the current state of a resource. Rather, a history mechanism is meant to show exactly what the user saw at the time when the resource was retrieved.

By default, an expiration time does not apply to history mechanisms. If the entity is still in storage, a history mechanism SHOULD display it even if the entity has expired, unless the user has specifically configured the agent to refresh expired history documents.

This is not to be construed to prohibit the history mechanism from telling the user that a view might be stale.

Note: if history list mechanisms unnecessarily prevent users from viewing stale resources, this will tend to force service authors to avoid using HTTP expiration controls and cache controls when they would otherwise like to. Service authors may consider it important that users not be presented with error messages or warning messages when they use navigation controls (such as BACK) to view previously fetched resources. Even though sometimes such resources ought not be cached, or ought to expire quickly, user interface considerations may force service authors to resort to other means of preventing caching (e.g. "once-only" URLs) in order not to suffer the effects of improperly functioning history mechanisms.

6. IANA Considerations

6.1 Message Header Registration

The Message Header Registry located at <http://www.iana.org/assignments/message-headers/message-header-index.html> should be updated with the permanent registrations below (see [RFC3864]):

Header Field Name Protocol Status Reference
Age http standard Section 4.1
Cache-Control http standard Section 4.2
Expires http standard Section 4.3
Pragma http standard Section 4.4
Vary http standard Section 4.5
Warning http standard Section 4.6

The change controller is: "IETF (iesg@ietf.org) - Internet Engineering Task Force".

7. Security Considerations

Caches expose additional potential vulnerabilities, since the contents of the cache represent an attractive target for malicious exploitation. Because cache contents persist after an HTTP request is complete, an attack on the cache can reveal information long after a user believes that the information has been removed from the network. Therefore, cache contents should be protected as sensitive information.

8. Acknowledgments

Much of the content and presentation of the caching design is due to suggestions and comments from individuals including: Shel Kaphan, Paul Leach, Koen Holtman, David Morris, and Larry Masinter.

9. References

9.1 Normative References

[ISO-8859-1] 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.
[Part1] Fielding, R., Ed., Gettys, J., Mogul, J., Frystyk, H., Masinter, L., Leach, P., Berners-Lee, T., Lafon, Y., Ed., and J. F. Reschke, Ed., “HTTP/1.1, part 1: URIs, Connections, and Message Parsing”, Internet-Draft draft-ietf-httpbis-p1-messaging-latest (work in progress), December 2008.
[Part2] Fielding, R., Ed., Gettys, J., Mogul, J., Frystyk, H., Masinter, L., Leach, P., Berners-Lee, T., Lafon, Y., Ed., and J. F. Reschke, Ed., “HTTP/1.1, part 2: Message Semantics”, Internet-Draft draft-ietf-httpbis-p2-semantics-latest (work in progress), December 2008.
[Part3] Fielding, R., Ed., Gettys, J., Mogul, J., Frystyk, H., Masinter, L., Leach, P., Berners-Lee, T., Lafon, Y., Ed., and J. F. Reschke, Ed., “HTTP/1.1, part 3: Message Payload and Content Negotiation”, Internet-Draft draft-ietf-httpbis-p3-payload-latest (work in progress), December 2008.
[Part4] Fielding, R., Ed., Gettys, J., Mogul, J., Frystyk, H., Masinter, L., Leach, P., Berners-Lee, T., Lafon, Y., Ed., and J. F. Reschke, Ed., “HTTP/1.1, part 4: Conditional Requests”, Internet-Draft draft-ietf-httpbis-p4-conditional-latest (work in progress), December 2008.
[Part5] Fielding, R., Ed., Gettys, J., Mogul, J., Frystyk, H., Masinter, L., Leach, P., Berners-Lee, T., Lafon, Y., Ed., and J. F. Reschke, Ed., “HTTP/1.1, part 5: Range Requests and Partial Responses”, Internet-Draft draft-ietf-httpbis-p5-range-latest (work in progress), December 2008.
[Part7] Fielding, R., Ed., Gettys, J., Mogul, J., Frystyk, H., Masinter, L., Leach, P., Berners-Lee, T., Lafon, Y., Ed., and J. F. Reschke, Ed., “HTTP/1.1, part 7: Authentication”, Internet-Draft draft-ietf-httpbis-p7-auth-latest (work in progress), December 2008.
[RFC2047] Moore, K., “MIME (Multipurpose Internet Mail Extensions) Part Three: Message Header Extensions for Non-ASCII Text”, RFC 2047, November 1996.
[RFC2119] Bradner, S., “Key words for use in RFCs to Indicate Requirement Levels”, BCP 14, RFC 2119, March 1997.

9.2 Informative References

[RFC1305] Mills, D., “Network Time Protocol (Version 3) Specification, Implementation”, RFC 1305, March 1992.
[RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., Masinter, L., Leach, P., and T. Berners-Lee, “Hypertext Transfer Protocol -- HTTP/1.1”, RFC 2616, June 1999.
[RFC3864] Klyne, G., Nottingham, M., and J. Mogul, “Registration Procedures for Message Header Fields”, BCP 90, RFC 3864, September 2004.

Authors' Addresses

Roy T. Fielding (editor) Day Software23 Corporate Plaza DR, Suite 280Newport Beach, CA 92660USAPhone: +1-949-706-5300Fax: +1-949-706-5305EMail: URI: http://roy.gbiv.com/
Jim GettysOne Laptop per Child21 Oak Knoll RoadCarlisle, MA 01741USAEMail: URI: http://www.laptop.org/
Jeffrey C. MogulHewlett-Packard CompanyHP Labs, Large Scale Systems Group1501 Page Mill Road, MS 1177Palo Alto, CA 94304USAEMail:
Henrik Frystyk NielsenMicrosoft Corporation1 Microsoft WayRedmond, WA 98052USAEMail:
Larry MasinterAdobe Systems, Incorporated345 Park AveSan Jose, CA 95110USAEMail: URI: http://larry.masinter.net/
Paul J. LeachMicrosoft Corporation1 Microsoft WayRedmond, WA 98052EMail:
Tim Berners-LeeWorld Wide Web ConsortiumMIT Computer Science and Artificial Intelligence LaboratoryThe Stata Center, Building 3232 Vassar StreetCambridge, MA 02139USAEMail: URI: http://www.w3.org/People/Berners-Lee/
Yves Lafon (editor) World Wide Web ConsortiumW3C / ERCIM2004, rte des LuciolesSophia-Antipolis, AM 06902FranceEMail: URI: http://www.raubacapeu.net/people/yves/
Julian F. Reschke (editor) greenbytes GmbHHafenweg 16Muenster, NW 48155GermanyPhone: +49 251 2807760Fax: +49 251 2807761EMail: URI: http://greenbytes.de/tech/webdav/

A. Compatibility with Previous Versions

A.1 Changes from RFC 2068

A case was missed in the Cache-Control model of HTTP/1.1; s-maxage was introduced to add this missing case. (Sections 3.1, 4.2.

Transfer-coding and message lengths all interact in ways that required fixing exactly when chunked encoding is used (to allow for transfer encoding that may not be self delimiting); it was important to straighten out exactly how message lengths are computed. (see also [Part1], [Part3] and [Part5])

Proxies should be able to add Content-Length when appropriate.

Range request responses would become very verbose if all meta-data were always returned; by allowing the server to only send needed headers in a 206 response, this problem can be avoided. (Section 3.7)

The Cache-Control: max-age directive was not properly defined for responses.

Warnings could be cached incorrectly, or not updated appropriately. 3.3, 3.7, 4.2, and 4.6) Warning also needed to be a general header, as PUT or other methods may have need for it in requests.

A.2 Changes from RFC 2616

Clarify denial of service attack avoidance requirement. (Section 3.5)

B. Change Log (to be removed by RFC Editor before publication)

B.1 Since RFC2616

Extracted relevant partitions from [RFC2616].

B.2 Since draft-ietf-httpbis-p6-cache-00

Closed issues:

Other changes:

B.3 Since draft-ietf-httpbis-p6-cache-01

Closed issues:

Other changes:

B.4 Since draft-ietf-httpbis-p6-cache-02

Ongoing work on IANA Message Header Registration (<http://www3.tools.ietf.org/wg/httpbis/trac/ticket/40>):

B.5 Since draft-ietf-httpbis-p6-cache-03

Closed issues:

B.6 Since draft-ietf-httpbis-p6-cache-04

B.7 Since draft-ietf-httpbis-p6-cache-05

This is a total rewrite.

Full Copyright Statement

This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights.

This document and the information contained herein are provided on an “AS IS” basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Intellectual Property

The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79.

Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at <http://www.ietf.org/ipr>.

The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org.

Index

A C E F G H I M N O P R S V W