Skip to content

WICG/coop-restrict-properties

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cross-Origin isolation with popups

This repository is dedicated to solve the problem of interacting with third party popups in a crossOriginIsolated context.

Currently for a document to be crossOriginIsolated, we need a Cross-Origin-Opener-Policy: same-origin header, and Cross-Origin-Embedder-Policy: require-corp or credentialless header. The COOP value prevents any interaction with cross-origin popups.

This proposal goal is to be able to enable window.crossOriginIsolated for pages that interact with cross-origin popups, both the opener and the openee. This would allow the use of APIs gated behind crossOriginIsolated such as SharedArrayBuffer or the Memory Measurement API to be used more widely. These flows are especially important because they are common. Oauth and payments are typical examples.

Authors:

Arthur Hemery

To Participate

whatwg/html#6364

Table of Contents

Why do we need crossOriginIsolated + popups

Blocked use cases

For pages to get crossOriginIsolated today, we require that COOP: same-origin be set. This effectively prevents any interaction with third-party popups. This is problematic for an important variety of use cases, below are a few real world example:

  • gmail.com wants to do memory measurement to diagnose performance. Some emails contain meet.com iframes which open a meeting when interacted with.
  • zoom.com wants to use sharedArrayBuffers to reduce the copying of media data. It needs to support being opened from third-party apps, via an SDK.
  • perfetto.dev, a trace visualization app, would like to use a more accurate performance.now() to improve performance. They use third-party popups to display traces without having them sent to their server.
  • construct.com, an online game engine needs javascript threading for performance, but uses another domain for renderer game-preview popups.

Underlying Issue

Note: In this explainer, we call document what is rendered by any individual frame. A page contains the top level document, as well as all of its iframe documents, if any. When you open a popup, you get a second page.

Because of Spectre, OS processes are now the only strong security boundary. crossOriginIsolated makes Spectre easier to exploit via powerful APIs, so we need to be able to put crossOriginIsolated pages that in their own process. To be able to honor that, we used the spec concept of BrowsingContext groups.

A BrowsingContext (roughly a frame) belongs to a BrowsingContext group. All documents presented in a BrowsingContext can reach other documents presented in BrowsingContexts in the same BrowsingContext group via javascript. The BrowsingContext group holds a map of origins to Agent Clusters. All same-origin documents in the same BrowsingContext group are in the same Agent Cluster. They have synchronous scripting access to each other. They need to be in the same process.

Putting two documents in BrowsingContexts not belonging to the same BrowsingContext group makes sure they are not in the same Agent Cluster, therefore that they do not need to be in the same process. Cross-Origin-Opener-Policy leverages this mechanism to decide whether or not two pages can be in the same BrowsingContext group. Below are a few illustrations of those principles:


image
The basic case COOP solves. Without COOP, we have to put all the documents in the same process, because the popup and the iframe are of origin b.com. They can synchronously script each other's DOM.


image
A user websites uses an identity provider to give people the possibility to login using Google or Facebook. For that, it opens a popup to the provider, which then navigates to the selected authentication website.


In that case, my-website.com and auth-provider.com communicate via their opener javascript handle to each other. If any of my-website.com, auth-provider.com or auth.google.com sets COOP: same-origin to become crossOriginIsolated, a different BrowsingContext group is used, and the opener is immediately cut. The flow is broken.


image
A website embeds an iframe to delegate payment. When needed, the iframe popups up a new window to process the payment. When done, it closes the window.


Similarly, in that case if either my-website.com or wallet.google.com sets COOP: same-origin, the flow is broken.

Alternative approaches

Let's use the payment example discussed above to see what alternatives approaches could be used.


image
Without COOP, we use a single BrowsingContext group. The iframe and the popup share an Agent Cluster, and they must live in the same process. For browsers that do not support rendering iframes in other processes, everything ends up in the same process.


image
With COOP, we use two different BrowsingContext groups. The main page and the popup cannot share an Agent Cluster. They can live in different processes, but both synchronous and asynchronous communication is given up.


The COOP: restrict-properties proposal

Instead of completely removing scripting capabilities between two pages, we would like to only restrict synchronous access, which is more precisely what requires pages to be in the same process.

image
The basic COOP: restrict-properties idea would be to use a single BrowsingContext group, but to increase the keying of Agent Cluster. We would have multiple same-origin documents not be able to synchronously script each other, despite being able to reach each other's Window object.


Instead of increasing Agent Cluster keying, we introduce a new superset of BrowsingContext group, the COOP group (tentative name). Within this new group, pages have asynchronous access to each other. This gives us the following multi-layer structure.

image In this example, a.com/index and a.com/article have synchronous script access, but can only asynchronously access a.com/login and b.com/oauth. a.com/another-tab has no access to other a.com pages.


Putting pages in a different BrowsingContext group but same COOP BrowsingContext group would be done via a new COOP value, restrict-properties that would only allow access to asynchronous properties. This makes it possible to put the two pages in different processes, and to enable crossOriginIsolated on the first page, as long as it also sets COEP.

To reduce XS-leaks as much as possible, we reduce asynchronous across-BrowsingContext groups to a very limited set of properties: {window.closed and window.postMessage()}. This is based on metrics research that shows that the overwhelming majority of sites only uses these two properties when interacting with cross-origin popups. This prevents almost all WindowProxy XS-Leaks.

Fitting COOP: restrict-properties into current algorithm

The COOP algorithm works by comparing header values and origins to say compute whether or not we should use a new BrowsingContext group. This needs to be opened to an enum return value, containing the following possible outcomes:

  1. Stay in the same BrowsingContext group.
  2. Stay in the same COOP group, but change BrowsingContext group.
  3. Change COOP BrowsingContext group.

Current COOP algorithm returns either 1. or 3. Using COOP: restrict-properties would yield 2., iff:

  • We are navigating between a page setting COOP: unsafe-none from/to a page setting COOP: restrict-properties.
  • We are navigating between two pages setting COOP: restrict-properties, but that have different origins.
  • We have a opened a fresh popup from a page that set COOP: same-origin-allow-popups to a page that sets COOP: restrict-properties.

Extra requirements for common use cases

We want COOP: restrict-properties to be as little intrusive as possible while providing strong guarantees. Imagine the following use case:


image
An authentication provider uses a navigation flow to provide login with many different providers. We do not want one of them setting COOP: restrict-properties limiting the interactions between my-website.com and the provider.


In the above case, the navigation from auth-provider.com to google.auth.com triggers a BrowsingContext group swap, within the same COOP group. We want to make sure that the subsequent navigation from google.auth.com to auth-provider.com reuses the same BrowsingContext group as the initial auth-provider.com page, to reduce the impact of deploying COOP: restrict-properties. We call that the reversibility requirement of COOP: restrict-properties.

To be able to do that, the COOP group needs to hold a map of BrowsingContext groups, that they can reuse. This map is keyed by: {isCrossOriginIsolated, hasCoopRestrictProperties, top-level origin or null}. This makes sure that:

  • A crossOriginIsolated BrowsingContext group is never reused for another origin, nor for a page that does not set COEP.
  • A BrowsingContext group containing pages with COOP: restrict-properties is not reused for another origin.
  • All pages without COOP, within a COOP group, live in the same BrowsingContext group.

Security considerations

Same-origin policy

Our proposal creates an unprecedented possibility: that two same-origin documents can reach one another but not have full access to each other. We audited the spec to produce a list of all places with same-origin checks relying on the assumption of full access. Some points worthy of attention:

  • The location object is quite sensitive and many of its methods/members are same-origin only. It is purposefully excluded from the list of allowed attributes by restrict-properties. We do not think we should allow a normal page to navigate a crossOriginIsolated page.
  • For similar reasons name targeting does not work across pages with COOP: restrict-properties.
  • Javascript navigations are a big NO. They mean executing arbitrary javascript within the target frame. There should be no way to navigate a frame across the COOP: restrict-properties boundary given the restrictions above are put in place.

Cross-origin subframes opening popup

What happens when an iframe in a COOP page opens a popup? The initial empty document created always inherits the origin of the iframe, while we would like COOP to be inherited from the top-level document. This can create dangerous discrepencies where we end up with a crossOriginIsolated initial empty document of an arbitrary origin.

For COOP: same-origin we solved this problem by setting no-opener on any popup opened from an iframe that is cross-origin to its top-level document.

Solutions are discussed in the Cross-origin iframes section.

Window.name leakage

When we navigate to a COOP: restrict-properties page and then to a COOP: unsafe-none page, we need to make sure no state remains from the previous context, to limit XS-Leaks. Window.name can be set by a crossOriginIsolated page and it could expose information to the next site.


image
In that example all the documents with origin A.com can set and target the window.name property. It is in a different context from the B.com's page, so we stash the name when navigating. B.com free to set its own name and use it in its context. When we navigate back to A.com we reuse the stashed name.


Solutions are discussed in the Name leakage section.

Extra notes on COOP: restrict-properties reporting

The COOP infrastructure can be used to report access to cross-origin properties that would not be postMessage nor closed. As for usual COOP reporting, DOM access that become restricted will not be able to be reported, and only cross-origin available properties other than postMessage or closed will be reported.

This is a fundamental limitation, because reporting synchronous DOM access would require a check on every Javascript access that would have unacceptable performance impact.

Stretch - COOP: restrict-properties as a default candidate

Given the properties that we have developed in this explainer, we believe COOP: restrict-properties could, in the future, make a candidate to replace COOP: unsafe-none as a default. Some design decisions were also made to make it as plausible as possible. Some consequences of making it default would be:

  • Most cross-origin properties are inaccessible to and from cross-origin popups, unless you manually set COOP: unsafe-none.
  • Pages would only have to manually set COEP to be crossOriginIsolated.
  • Popups opened from cross-origin iframes would always be no-opener, unless COOP: unsafe-none or COOP: same-origin-allow-popups is specified.

Stakeholder Feedback / Opposition

References & acknowledgements

Many thanks for valuable feedback and advice from: Alex Moshchuk, Anne VK, Artur Janc, Camille Lamy, Charlie Reis, David Dworken.

About

WICG draft for COOP with popups proposal

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 76.4%
  • Bikeshed 23.6%