HTTP Working Group | S. Ludin |
Internet-Draft | Akamai Technologies |
Intended status: Standards Track | M. Nottingham |
Expires: February 17, 2019 | Fastly |
N. Sullivan | |
Cloudflare | |
August 16, 2018 |
This specification defines the CDN-Loop request header field for HTTP.¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
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”.¶
This Internet-Draft will expire on February 17, 2019.¶
Copyright (c) 2018 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.¶
In modern deployments of HTTP servers, it is common to interpose Content Delivery Networks (CDNs) to improve end-user perceived latency, reduce operational costs, and improve scalability and reliability of services.¶
Often, more than one CDN is in use by any one server; this happens for a variety of reasons, such as cost savings, arranging for failover should one CDN have issues, or to directly compare their services.¶
As a result, it is not unknown for CDNs to be configured in a “loop” accidentally; because routing is achieved through a combination of DNS and forwarding rules, and site configurations are sometimes complex and managed by several parties.¶
When this happens, it is difficult to debug. Additionally, it sometimes isn’t accidental; loops between multiple CDNs be used as an attack vector (e.g., see [loop-attack]), especially if one CDN unintentionally strips the loop detection headers of another.¶
HTTP defines the Via header field in [RFC7230], Section 5.7.1 for “tracking message forwards, avoiding request loops, and identifying the protocol capabilities of senders along the request/response chain.”¶
In theory, Via could be used to identify these loops. However, in practice it is not used in this fashion, because some HTTP servers use Via for other purposes – in particular, some implementations disable some HTTP/1.1 features when the Via header is present.¶
This specification defines the CDN-Loop request header field for HTTP, to address this shortcoming.¶
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
This specification uses the Augmented Backus-Naur Form (ABNF) notation of [RFC5234] with a list extension, defined in Section 7 of [RFC7230], that allows for compact definition of comma-separated lists using a ‘#’ operator (similar to how the ‘*’ operator indicates repetition). Additionally, it uses the OWS rule from [RFC7230] and the parameter rule from [RFC7231].¶
The CDN-Loop request header field is intended to help a Content Delivery Network identify when an incoming request has already passed through that CDN’s servers, to prevent loops.¶
CDN-Loop = #cdn-id cdn-id = token *( OWS ";" OWS parameter )
Conforming Content Delivery Networks SHOULD add a value to this header field to all requests they generate or forward (creating the header if necessary).¶
The token identifies the CDN as a whole. Chosen token values SHOULD be unique enough that a collision with other CDNs is unlikely. Optionally, the token can have semicolon-separated key/value parameters, to accommodate additional information for the CDN’s use.¶
As with all HTTP headers defined using the “#” rule, the CDN-Loop header can be added to by comma-separating values, or by creating a new header field with the desired value.¶
For example:¶
CDN-Loop: FooCDN, barcdn; host="foo123.bar.cdn" CDN-Loop: baz-cdn; abc="123"; def="456", anotherCDN
Note that the token syntax does not allow whitespace, DQUOTE or any of the characters “(),/:;<=>?@[]{}”. See [RFC7230], Section 3.2.6. Likewise, note the rules for when parameter values need to be quoted in [RFC7231], Section 3.1.1.¶
To be effective, intermediaries – including Content Delivery Networks – MUST NOT remove this header field, or allow it to be removed (e.g., through configuration) and servers (including intermediaries) SHOULD NOT use it for other purposes.¶
The CDN-Loop header field can be generated by any client, and therefore its contents cannot be trusted. CDNs who modify their behaviour based upon its contents should assure that this does not become an attack vector (e.g., for Denial-of-Service).¶
It is possible to sign the contents of the header (either by putting the signature directly into the field’s content, or using another header field), but such use is not defined (or required) by this specification.¶
This document registers the “CDN-Loop” header field in the Permanent Message Header Field Names registry.¶