ancestorOrigins: add tests and update Location IDL

annevk · annevk · commit f0d3e4c4388e · 2017-05-16T18:43:01.000+02:00
See whatwg/html#1918 for the HTML Standard discussion and whatwg/html#2480 for the HTML Standard change.
diff --git a/html/browsers/history/the-location-interface/location-ancestororigins-involved.window.js b/html/browsers/history/the-location-interface/location-ancestororigins-involved.window.js
@@ -0,0 +1,167 @@
+// META: script=/common/get-host-info.sub.js
+
+const embedPath = new URL("resources/ancestororigins-embed.py", location.href).pathname,
+      info = get_host_info(),
+      localOrigin = info.HTTP_ORIGIN,
+      localEmbed = localOrigin + embedPath,
+      remoteOrigin = info.HTTP_REMOTE_ORIGIN,
+      remoteEmbed = remoteOrigin + embedPath,
+      remoteOrigin2 = info.HTTP_REMOTE_ORIGIN_WITH_DIFFERENT_PORT
+      remoteEmbed2 = remoteOrigin2 + embedPath
+let id = 0
+
+async_test(t => {
+  const iframe = document.createElement("iframe"),
+        localId = ++id
+  iframe.sandbox = "allow-scripts"
+  iframe.src = localEmbed + "?iframe=|" + remoteEmbed + "?id=" + localId
+  document.body.appendChild(iframe)
+  t.add_cleanup(() => iframe.remove())
+
+
+  self.addEventListener("message", t.step_func(e => {
+    if(e.data.id === localId) {
+      assert_array_equals(e.data.output, ["null", localOrigin])
+      t.done()
+    }
+  }))
+}, "Ensure sandboxed iframes show up as null")
+
+// The following code ends up generating multiple tests each with multiple nested <iframe>s. The
+// variables in the array below seed various scenarios, described by "desc". The capital letters
+// describe the <iframe>s in play. When the same letter is used at different nesting levels that
+// means it is same-origin. Some defaulting is used to avoid too much duplication.
+;[
+  {
+    outerPolicy: true,
+    desc: "A uses no-referrer -> B -> A",
+    results: [remoteOrigin, "null"]
+  },
+  {
+    outerPolicy: true,
+    innerEmbed: remoteEmbed2,
+    desc: "A uses no-referrer -> B -> C",
+    results: [remoteOrigin, "null"]
+  },
+  {
+    innerPolicy: true,
+    desc: "A -> B uses no-referrer -> A",
+    results: ["null", localOrigin]
+  },
+  {
+    innerPolicy: true,
+    innerEmbed: remoteEmbed2,
+    desc: "A -> B uses no-referrer -> C",
+    results: ["null", localOrigin]
+  },
+  {
+    innerPolicy: true,
+    outerEmbed: localEmbed,
+    innerEmbed: remoteEmbed,
+    desc: "A -> A uses no-referrer -> C",
+    results: ["null", "null"],
+    intermediateResults: [localOrigin]
+  },
+  {
+    innerPolicy: true,
+    outerEmbed: localEmbed,
+    desc: "A -> A uses no-referrer -> A",
+    results: ["null", "null"],
+    intermediateResults: [localOrigin]
+  }
+].forEach(val => {
+  async_test(t => {
+    if(!val.intermediateResults) {
+      val.intermediateResults = [val.results[1]]
+    }
+    if(!val.outerEmbed) {
+      val.outerEmbed = remoteEmbed
+    }
+    if(!val.innerEmbed) {
+      val.innerEmbed = localEmbed
+    }
+
+    const iframe = document.createElement("iframe"),
+          innerId = ++id,
+          innermostId = ++id
+    if(val.outerPolicy) {
+      iframe.referrerPolicy = "no-referrer"
+    }
+    let innerPolicy = ""
+    if(val.innerPolicy) {
+      innerPolicy = "no-referrer"
+    }
+    iframe.src = val.outerEmbed + "?id=" + innerId + "&iframe=" + innerPolicy + "|" + val.innerEmbed + "?id=" + innermostId
+    document.body.appendChild(iframe)
+    t.add_cleanup(() => iframe.remove())
+
+    let almostDone = false
+    function localDone () {
+      if(almostDone) {
+        t.done()
+      }
+      almostDone = true
+    }
+
+    self.addEventListener("message", t.step_func(e => {
+      if(e.data.id === innerId) {
+        assert_array_equals(e.data.output, val.intermediateResults)
+        localDone()
+      }
+      else if(e.data.id === innermostId) {
+        assert_array_equals(e.data.output, val.results)
+        localDone()
+      }
+    }))
+  }, val.desc)
+})
+
+;[
+  {
+    desc: "A -> B -> B uses no-referrer -> A",
+    innerinnerEmbed: localEmbed
+  },
+  {
+    desc: "A -> B -> B uses no-referrer -> B",
+    innerinnerEmbed: remoteEmbed
+  },
+  {
+    desc: "A -> B -> B uses no-referrer -> C",
+    innerinnerEmbed: remoteEmbed2
+  }
+].forEach(val => {
+  async_test(t => {
+    const iframe = document.createElement("iframe"),
+          localId = ++id
+    iframe.src = remoteEmbed + "?iframe=|" + remoteEmbed + "?iframe=no-referrer%257C" + val.innerinnerEmbed + "?id=" + localId
+    document.body.appendChild(iframe)
+    t.add_cleanup(() => iframe.remove())
+
+    self.addEventListener("message", t.step_func(e => {
+      if(e.data.id === localId) {
+        assert_array_equals(e.data.output, ["null", "null", localOrigin])
+        t.done()
+      }
+    }))
+  }, val.desc)
+})
+
+async_test(t => {
+  const iframe = document.createElement("iframe"),
+        localId = ++id
+  document.body.appendChild(iframe)
+  t.add_cleanup(() => iframe.remove())
+
+  const a = document.createElement("a")
+  a.rel = "noreferrer"
+  a.href = localEmbed + "?id=" + localId
+  iframe.contentDocument.body.appendChild(a)
+  a.click()
+
+  self.addEventListener("message", t.step_func(e => {
+    if(e.data.id === localId) {
+      assert_array_equals(e.data.output, ["null"])
+      t.done()
+    }
+  }))
+}, "rel=noreferrer should redact")
diff --git a/html/browsers/history/the-location-interface/location-ancestororigins.window.js b/html/browsers/history/the-location-interface/location-ancestororigins.window.js
@@ -0,0 +1,43 @@
+test(() => {
+  assert_equals(location.ancestorOrigins.length, 0)
+}, "location.ancestorOrigins basic check")
+
+async_test(t => {
+  const frame = document.createElement("iframe"),
+        rp = document.createElement("meta")
+  frame.onload = t.step_func_done(() => {
+    const ancestorOrigins = frame.contentWindow.location.ancestorOrigins
+    assert_equals(ancestorOrigins[0], self.origin)
+    assert_equals(ancestorOrigins.length, 1)
+
+    rp.name = "referrer"
+    rp.content = "no-referrer"
+    document.head.appendChild(rp)
+    assert_equals(self[0].location.ancestorOrigins, ancestorOrigins)
+    assert_equals(ancestorOrigins[0], self.origin)
+    assert_equals(ancestorOrigins.length, 1)
+    rp.remove()
+
+    frame.referrerPolicy = "no-referrer"
+    assert_equals(self[0].location.ancestorOrigins, ancestorOrigins)
+    assert_equals(ancestorOrigins[0], self.origin)
+    assert_equals(ancestorOrigins.length, 1)
+
+    frame.remove()
+  })
+  frame.src = "/common/blank.html"
+  document.body.appendChild(frame)
+}, "location.ancestorOrigins cannot be masked by a dynamic referrer policy")
+
+async_test(t => {
+  const frame = document.createElement("iframe")
+  frame.onload = t.step_func_done(() => {
+    const ancestorOrigins = frame.contentWindow.location.ancestorOrigins
+    assert_equals(ancestorOrigins[0], "null")
+    assert_equals(ancestorOrigins.length, 1)
+    frame.remove()
+  })
+  frame.src = "/common/blank.html"
+  frame.referrerPolicy = "no-referrer"
+  document.body.appendChild(frame)
+}, "location.ancestorOrigins can be masked by a predetermined referrer policy")
diff --git a/html/browsers/history/the-location-interface/resources/ancestororigins-embed.py b/html/browsers/history/the-location-interface/resources/ancestororigins-embed.py
@@ -0,0 +1,22 @@
+def main(request, response):
+    body = ""
+
+    if "iframe" in request.GET:
+        frame = request.GET.first("iframe").split("|")
+        frameReferrer = frame[0]
+        frameURL = frame[1]
+        if frameReferrer != "":
+            frameReferrer = " referrerpolicy=" + frameReferrer
+
+        body = ("<iframe src=\"%s\"%s></iframe>" % (frameURL, frameReferrer)) + "\n"
+
+    if "id" in request.GET:
+        body = body + """<script>
+let output = [...self.location.ancestorOrigins]
+top.postMessage({ id: %s, output }, "*")
+</script>
+""" % request.GET.first("id")
+
+    if body == "":
+        return "Please specify either or both the 'iframe' and 'id' GET parameters."
+    return body
diff --git a/interfaces/html.idl b/interfaces/html.idl
@@ -1433,22 +1433,29 @@ interface History {
   void replaceState(any data, DOMString title, optional DOMString? url = null);
 };
 
-[Unforgeable] interface Location {
-  stringifier attribute USVString href;
-  readonly attribute USVString origin;
-           attribute USVString protocol;
-           attribute USVString host;
-           attribute USVString hostname;
-           attribute USVString port;
-           attribute USVString pathname;
-           attribute USVString search;
-           attribute USVString hash;
-
-  void assign(USVString url);
-  void replace(USVString url);
-  void reload();
-
-  [SameObject] readonly attribute USVString[] ancestorOrigins;
+[Exposed=(Window,Worker)]
+interface DOMStringList {
+  readonly attribute unsigned long length;
+  getter DOMString? item(unsigned long index);
+  boolean contains(DOMString string);
+};
+
+interface Location {
+  [Unforgeable] stringifier attribute USVString href;
+  [Unforgeable] readonly attribute USVString origin;
+  [Unforgeable] attribute USVString protocol;
+  [Unforgeable] attribute USVString host;
+  [Unforgeable] attribute USVString hostname;
+  [Unforgeable] attribute USVString port;
+  [Unforgeable] attribute USVString pathname;
+  [Unforgeable] attribute USVString search;
+  [Unforgeable] attribute USVString hash;
+
+  [Unforgeable] void assign(USVString url);
+  [Unforgeable] void replace(USVString url);
+  [Unforgeable] void reload();
+
+  [Unforgeable, SameObject] readonly attribute DOMStringList ancestorOrigins;
 };
 
 [Constructor(DOMString type, optional PopStateEventInit eventInitDict)]
