diff --git a/index.html b/index.html index 03fe3df..e30bc77 100644 --- a/index.html +++ b/index.html @@ -1,1069 +1,263 @@ + Referrer Policy - + + - + + + + + -
-

-

Referrer Policy

-

Editor’s Draft,

+

+

Referrer Policy

+

Editor’s Draft,

This version:
https://w3c.github.io/webappsec-referrer-policy/ -
Latest version: +
Latest published version:
http://www.w3.org/TR/referrer-policy/
Version History:
https://github.com/w3c/webappsec-referrer-policy/commits/master/index.src.html @@ -1071,6 +265,7 @@

public-webappsec@w3.org with subject line “[REFERRER] … message topic …” (archives)
Issue Tracking:
GitHub +
Inline In Spec
Editors:
(Google Inc.)
(Google Inc.) @@ -1086,41 +281,23 @@

Status of this document

-

This is a public copy of the editors’ draft. - It is provided for discussion only and may change at any moment. - Its publication here does not imply endorsement of its contents by W3C. - Don’t cite this document other than as work in progress.

-

Changes to this document may be tracked at https://github.com/w3c/webappsec.

-

The (archived) public mailing list public-webappsec@w3.org (see instructions) - is preferred for discussion of this specification. - When sending e-mail, - please put the text “REFERRER” in the subject, - preferably like this: - “[REFERRER] …summary of comment…

-

This document was produced by the Web Application Security Working Group.

-

This document was produced by a group operating under - the 5 February 2004 W3C Patent Policy. - W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; - that page also includes instructions for disclosing a patent. - An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.

-

This document is governed by the 1 September 2015 W3C Process Document.

-

Table of Contents

-
- -
+ +

1. Introduction

@@ -1227,35 +404,35 @@

2. Key Concepts and Terminology

-
referrer policy +
referrer policy
- A referrer policy modifies the algorithm used to populate the Referer header when fetching subresources, + A referrer policy modifies the algorithm used to populate the Referer header when fetching subresources, prefetching, or performing navigations. This document defines the various - behaviors for each referrer policy. -

Every environment settings object has an algorithm for obtaining a referrer policy, which is used by default for all requests with that environment settings object as their request + behaviors for each referrer policy. +

Every environment settings object has an algorithm for obtaining a referrer policy, which is used by default for all requests with that environment settings object as their request client.

-
same-origin request +
same-origin request
A Request request is a same-origin request if request’s origin and the origin of request’s url are the same. -
cross-origin request -
A Request is a cross-origin request if it is not same-origin. +
cross-origin request +
A Request is a cross-origin request if it is not same-origin.

3. Referrer Policies

-

Each possible referrer policy, besides the empty string, is explained +

Each possible referrer policy, besides the empty string, is explained below. A detailed algorithm for evaluating their effect is given in the §5 Integration with Fetch and §7 Algorithms sections.

Note: The referrer policy for an environment settings object provides a default baseline policy for requests when that environment settings object is used as a request client. This policy may be tightened for specific requests via mechanisms like the noreferrer link type.

-

3.1. "no-referrer"

-

The simplest policy is "no-referrer", which specifies +

3.1. "no-referrer"

+

The simplest policy is "no-referrer", which specifies that no referrer information is to be sent along with requests made from a particular request client to any origin. The header will be omitted entirely.

-
If a document at https://example.com/page.html sets a policy of "no-referrer", then navigations to https://example.com/ (or any other URL) would send no Referer header.
-

3.2. "no-referrer-when-downgrade"

-

The "no-referrer-when-downgrade" policy sends a full URL +

If a document at https://example.com/page.html sets a policy of "no-referrer", then navigations to https://example.com/ (or any other URL) would send no Referer header.
+

3.2. "no-referrer-when-downgrade"

+

The "no-referrer-when-downgrade" policy sends a full URL along with requests from a TLS-protected environment settings object to a a priori authenticated URL, and requests from request clients which are not TLS-protected to any origin.

Requests from TLS-protected request clients to non-a @@ -1263,36 +440,36 @@

Referer HTTP header will not be sent.

- If a document at https://example.com/page.html sets a policy of "no-referrer-when-downgrade", then navigations to https://not.example.com/ would send a Referer HTTP header with a value of https://example.com/page.html, as neither resource’s origin is an + If a document at https://example.com/page.html sets a policy of "no-referrer-when-downgrade", then navigations to https://not.example.com/ would send a Referer HTTP header with a value of https://example.com/page.html, as neither resource’s origin is an non-a priori authenticated URL.

Navigations from that same page to http://not.example.com/ would send no Referer header.

This is a user agent’s default behavior, if no policy is otherwise specified.

-

3.3. "same-origin"

-

The "same-origin" policy specifies that a +

3.3. "same-origin"

+

The "same-origin" policy specifies that a full URL, stripped for use as a referrer, is sent as - referrer information when making same-origin requests from a particular request client.

-

Cross-origin requests, on the other hand, will contain no + referrer information when making same-origin requests from a particular request client.

+

Cross-origin requests, on the other hand, will contain no referrer information. A Referer HTTP header will not be sent.

- If a document at https://example.com/page.html sets a policy of "same-origin", then navigations to https://example.com/not-page.html would send a Referer header with a value of https://example.com/page.html. + If a document at https://example.com/page.html sets a policy of "same-origin", then navigations to https://example.com/not-page.html would send a Referer header with a value of https://example.com/page.html.

Navigations from that same page to https://not.example.com/ would send no Referer header.

-

3.4. "origin"

-

The "origin" policy specifies that only the ASCII serialization of the origin of the request client is sent as referrer information - when making both same-origin requests and cross-origin requests from a particular request client.

+

3.4. "origin"

+

The "origin" policy specifies that only the ASCII serialization of the origin of the request client is sent as referrer information + when making both same-origin requests and cross-origin requests from a particular request client.

Note: The serialization of an origin looks like https://example.com. To ensure that a valid URL is sent in the `Referer` header, user agents will append a U+002F SOLIDUS ("/") character to the origin (e.g. https://example.com/).

-

Note: The "origin" policy causes the origin of HTTPS +

Note: The "origin" policy causes the origin of HTTPS referrers to be sent over the network as part of unencrypted HTTP requests. - The "strict-origin" policy addresses this concern.

-
If a document at https://example.com/page.html sets a policy of "origin", then navigations to any origin would send a Referer header with a value + The "strict-origin" policy addresses this concern.

+
If a document at https://example.com/page.html sets a policy of "origin", then navigations to any origin would send a Referer header with a value of https://example.com/, even to URLs that are not a priori authenticated URLs.
-

3.5. "strict-origin"

-

The "strict-origin" policy sends the ASCII serialization of the origin of the request client when making requests:

+

3.5. "strict-origin"

+

The "strict-origin" policy sends the ASCII serialization of the origin of the request client when making requests:

Note: The policy’s name doesn’t lie; it is unsafe. This policy will leak origins and paths from TLS-protected resources to insecure origins. Carefully consider the impact of setting such a policy for potentially sensitive documents.

3.9. The empty string

-

The empty string "" corresponds to no referrer policy, causing a - fallback to a referrer policy defined elsewhere, or in the case where - no such higher-level policy is available, defaulting to "no-referrer-when-downgrade". This defaulting happens in +

The empty string "" corresponds to no referrer policy, causing a + fallback to a referrer policy defined elsewhere, or in the case where + no such higher-level policy is available, defaulting to "no-referrer-when-downgrade". This defaulting happens in the §7.3 Determine request’s Referrer algorithm.

-
Given a HTML a element without any declared referrerpolicy attribute, its referrer policy is "". Thus, navigation requests initiated +
Given a HTML a element without any declared referrerpolicy attribute, its referrer policy is "". Thus, navigation requests initiated by clicking on that a element will be sent with the referrer policy of the a element’s node - document. If that Document has "" as its referrer policy, the §7.3 Determine request’s Referrer algorithm will treat "" the same as "no-referrer-when-downgrade".
+ document. If that Document has "" as its referrer policy, the §7.3 Determine request’s Referrer algorithm will treat "" the same as "no-referrer-when-downgrade".

4. Referrer Policy Delivery

-

A request’s referrer policy is delivered in one of five ways:

+

A request’s referrer policy is delivered in one of five ways:

4.1. Delivery via Referrer-Policy header

-

The Referrer-Policy HTTP +

The Referrer-Policy HTTP header specifies the referrer policy that the user agent applies when determining what referrer information should be included with requests - made, and with browsing contexts created from the context of the protected resource. + made, and with browsing contexts created from the context of the protected resource. The syntax for the name and value of the header are described by the following ABNF grammar:

-
"Referrer-Policy:" 1#policy-token
+
"Referrer-Policy:" 1#policy-token
 
-
policy-token   = "no-referrer" / "no-referrer-when-downgrade" / "strict-origin" / "strict-origin-when-cross-origin" / "same-origin" / "origin" / "origin-when-cross-origin" / "unsafe-url"
+
policy-token   = "no-referrer" / "no-referrer-when-downgrade" / "strict-origin" / "strict-origin-when-cross-origin" / "same-origin" / "origin" / "origin-when-cross-origin" / "unsafe-url"
 

Note: The header name does not share the HTTP Referer header’s misspelling.

§5 Integration with Fetch and §6 Integration with HTML describe @@ -1398,7 +575,7 @@

4.2. Delivery via meta

This section is not normative.

-

The HTML Standard defines the referrer keyword for the meta element, which allows setting the referrer +

The HTML Standard defines the referrer keyword for the meta element, which allows setting the referrer policy via markup.

@@ -1407,15 +584,16 @@

4.4. Nested browsing contexts

This section is not normative.

The HTML Standard and Fetch Standard define how nested browsing contexts that are not created from responses, such as iframe elements with - their srcdoc attribute set, or created from a blob URL, inherit - their referrer policy from the creator browsing context or blob URL.

+ their srcdoc attribute set, or created from a blob URL, inherit + their referrer policy from the creator browsing context or blob URL.

@@ -1432,7 +610,7 @@

6. Integration with HTML

This section is not normative.

-

The HTML Standard determines the referrer policy of any response +

The HTML Standard determines the referrer policy of any response received during navigation or while running a worker, and uses the result to set the resulting Document or WorkerGlobalScope's referrer policy. This is later used by the corresponding environment @@ -1447,8 +625,8 @@

7. Algorithms

-

7.1. Parse a referrer policy from a Referrer-Policy header

-

Given a Response response, the following steps return a referrer policy according to response’s `Referrer-Policy` header:

+

7.1. Parse a referrer policy from a Referrer-Policy header

+

Given a Response response, the following steps return a referrer policy according to response’s `Referrer-Policy` header:

  1. Let policy-tokens be the result of parsing `Referrer-Policy` in response’s header list. @@ -1459,7 +637,7 @@

    7.2. Set request’s referrer policy on redirect

    Given a request request and a response actualResponse, - this algorithm updates request’s associated referrer policy according to the Referrer-Policy header (if any) in actualResponse.

    + this algorithm updates request’s associated referrer policy according to the Referrer-Policy header (if any) in actualResponse.

    1. Let policy be the result of executing §7.1 Parse a referrer policy from a Referrer-Policy header on actualResponse.
    2. If policy is not the empty string, then set request’s @@ -1467,52 +645,49 @@

      7.3. Determine request’s Referrer

      Given a Request request, we can determine the correct - referrer information to send by examining the referrer policy associated with it, as detailed in the following steps, which return + referrer information to send by examining the referrer policy associated with it, as detailed in the following steps, which return either no referrer or a URL:

      -

      Note: If Fetch is performing a navigation in response to a link of type noreferrer, then request’s referrer will be no referrer, and Fetch won’t call - into this algorithm.

        -
      1. Let policy be request’s associated referrer policy. -
      2. Let environment be request’s client. +
      3. Let policy be request’s associated referrer policy. +
      4. Let environment be request’s client.
      5. - If request’s referrer is a URL, then let referrerSource be request’s referrer. Otherwise: -
          -
        1. - If environment’s global object is a Window object: -
            -
          1. Let document be the Document object of the active document of the browsing context of environment’s responsible browsing context. -
          -
        2. - Otherwise, environment’s global object is a WorkerGlobalScope: -
            -
          1. Let source be the API referrer source specified by the incumbent settings object. -
          2. If source is a URL, let referrerSource be source, otherwise let document be source. -
          -
        3. - If document is set, execute the following steps: + Switch on request’s referrer: +
          +
          "client" +
            -
          1. If document’s origin is an opaque - origin (because, for example, it has been sandboxed - into a unique origin), return no referrer and - abort these steps. -
          2. While document corresponds to an iframe srcdoc Document, - let document be that Document’s browsing context’s browsing context container’s Document. -
          3. Let referrerSource be document’s URL. +
          4. + If environment’s global + object is a Window object, then +
              +
            1. Let document be the active document of environment’s responsible browsing context. +
            2. If document’s origin is an opaque origin, + return no referrer. +
            3. While document is an iframe srcdoc document, let document be document’s browsing context’s browsing context + container’s node document. +
            4. Let referrerSource be document’s URL. +
            +
          5. Otherwise, let referrerSource be environment’s creation + URL.
          -
        +
        a URL +
        Let referrerSource be request’s referrer. +

+

Note: If request’s referrer is + "no-referrer", Fetch will not call into this algorithm.

  • Let referrerURL be the result of stripping referrerSource for use as a referrer.
  • Let referrerOrigin be the result of stripping referrerSource for use as a - referrer, with the origin-only flag set to true. + referrer, with the origin-only flag set to true.
  • Execute the statements corresponding to the value of policy:
    -
    "no-referrer" +
    "no-referrer"
    Return no referrer -
    "origin" +
    "origin"
    Return referrerOrigin -
    "unsafe-url" +
    "unsafe-url"
    Return referrerURL. -
    "strict-origin" +
    "strict-origin"
    1. @@ -1524,10 +699,10 @@

    2. Return referrerOrigin.
    -
    "strict-origin-when-cross-origin" +
    "strict-origin-when-cross-origin"
      -
    1. If request is a same-origin request, then +
    2. If request is a same-origin request, then return referrerURL.
    3. If environment is not null: @@ -1541,22 +716,21 @@

    4. Return referrerOrigin.
    -
    "same-origin" +
    "same-origin"
      -
    1. If request is a same-origin request, then +
    2. If request is a same-origin request, then return referrerURL.
    3. Otherwise, return no referrer.
    -
    "origin-when-cross-origin" +
    "origin-when-cross-origin"
      -
    1. If request is a cross-origin request, then +
    2. If request is a cross-origin request, then return referrerOrigin.
    3. Otherwise, return referrerURL.
    -
    "no-referrer-when-downgrade" -
    the empty string +
    "no-referrer-when-downgrade"
    1. @@ -1569,12 +743,14 @@

      Return referrerURL.

    +

    Note: Fetch will ensure request’s referrer policy is not the + empty string before calling this algorithm.

    7.4. Strip url for use as a referrer

    Certain portions of URLs MUST not be included when sending a URL as the value of a `Referer` header: a URLs fragment, username, and password components should be stripped from the URL before it’s sent out. This - algorithm accepts a origin-only flag, which defaults + algorithm accepts a origin-only flag, which defaults to false. If set to true, the algorithm will additionally remove the URL’s path and query components, leaving only the scheme, host, and port.

    @@ -1586,7 +762,7 @@

  • Set url’s password to null.
  • Set url’s fragment to null.
  • - If the origin-only flag is true, + If the origin-only flag is true, then:
    1. Set url’s path to null. @@ -1595,27 +771,27 @@

    2. Return url.

    7.5. Determine token’s Policy

    -

    Given a string token (for example, the value of a Referrer-Policy header), this algorithm will return the referrer policy it refers to:

    +

    Given a string token (for example, the value of a Referrer-Policy header), this algorithm will return the referrer policy it refers to:

    1. If token is an ASCII case-insensitive match for the - strings "never" or "no-referrer", return "no-referrer". + strings "never" or "no-referrer", return "no-referrer".
    2. If token is ASCII case-insensitive match for the string "default" or "no-referrer-when-downgrade", - return "no-referrer-when-downgrade". + return "no-referrer-when-downgrade".
    3. If token is an ASCII case-insensitive match for the - string "origin", return "origin". + string "origin", return "origin".
    4. If token is an ASCII case-insensitive match for the - string "strict-origin", return "strict-origin". + string "strict-origin", return "strict-origin".
    5. If token is an ASCII case-insensitive match for the - string "strict-origin-when-cross-origin", return "strict-origin-when-cross-origin". + string "strict-origin-when-cross-origin", return "strict-origin-when-cross-origin".
    6. If token is an ASCII case-insensitive match for the - string "same-origin", return "same-origin". + string "same-origin", return "same-origin".
    7. If token is ASCII case-insensitive match for the string - "origin-when-cross-origin", return "origin-when-cross-origin". + "origin-when-cross-origin", return "origin-when-cross-origin".
    8. If token is ASCII case-insensitive match for the strings "always" or "unsafe-url", - return "unsafe-url". -
    9. If token is empty, return "no-referrer". + return "unsafe-url". +
    10. If token is empty, return "no-referrer".
    11. Return the empty string.

    Note: Authors are encouraged to avoid the legacy keywords never, default, and always. The @@ -1628,22 +804,22 @@

    referrer policy on a page.

    + active referrer policy on a page.

    9. Security Considerations

    9.1. Information Leakage

    -

    The referrer policies "origin", "origin-when-cross-origin" and "unsafe-url" might leak the origin and the URL of +

    The referrer policies "origin", "origin-when-cross-origin" and "unsafe-url" might leak the origin and the URL of a secure site respectively via insecure transport.

    Those two policies are included in the spec nevertheless to lower the friction of sites adopting secure transport.

    Authors wanting to ensure that they do not leak any more information than - the default policy should instead use the policy states "same-origin", "strict-origin", "strict-origin-when-cross-origin" or "no-referrer".

    + the default policy should instead use the policy states "same-origin", "strict-origin", "strict-origin-when-cross-origin" or "no-referrer".

    9.2. Downgrade to less strict policies

    -

    The spec does not forbid downgrading to less strict policies, e.g., from "no-referrer" to "unsafe-url".

    +

    The spec does not forbid downgrading to less strict policies, e.g., from "no-referrer" to "unsafe-url".

    On the one hand, it is not clear which policy is more strict for all possible - pairs of policies: While "no-referrer-when-downgrade" will - not leak any information over insecure transport, and "origin" will, the latter reveals less information + pairs of policies: While "no-referrer-when-downgrade" will + not leak any information over insecure transport, and "origin" will, the latter reveals less information across cross-origin navigations.

    On the other hand, allowing for setting less strict policies enables authors to define safe fallbacks as described in §10.1 Unknown Policy Values.

    @@ -1656,9 +832,9 @@

    Suppose older user agents don’t understand - the "unsafe-url" policy. A site can specify - an "origin" policy followed by an "unsafe-url" policy: older user agents will ignore the - unknown "unsafe-url" value and use "origin", while newer user agents will use "unsafe-url" because it is the last to be processed.
    + the "unsafe-url" policy. A site can specify + an "origin" policy followed by an "unsafe-url" policy: older user agents will ignore the + unknown "unsafe-url" value and use "origin", while newer user agents will use "unsafe-url" because it is the last to be processed.

  • 11. Acknowledgements

    @@ -1668,22 +844,22 @@

    Conformance

    Document conventions

    Conformance requirements are expressed with a combination of - descriptive assertions and RFC 2119 terminology. The key words "MUST", - "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", - "RECOMMENDED", "MAY", and "OPTIONAL" in the normative parts of this + descriptive assertions and RFC 2119 terminology. The key words “MUST”, + “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, + “RECOMMENDED”, “MAY”, and “OPTIONAL” in the normative parts of this document are to be interpreted as described in RFC 2119. However, for readability, these words do not appear in all uppercase letters in this specification.

    All of the text of this specification is normative except sections explicitly marked as non-normative, examples, and notes. [RFC2119]

    -

    Examples in this specification are introduced with the words "for example" +

    Examples in this specification are introduced with the words “for example” or are set apart from the normative text with class="example", like this:

    This is an example of an informative example.

    -

    Informative notes begin with the word "Note" and are set apart from the +

    Informative notes begin with the word “Note” and are set apart from the normative text with class="note", like this:

    Note, this is an informative note.

    Conformant Algorithms

    @@ -1696,9 +872,10 @@

    -

    Index

    -

    Terms defined by this specification

    -