forked from w3c-fedid/FedCM
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit 66c633e
authored
Create devcontainer.json
<pre class='metadata'>
Title: Federated Credential Management API
Shortname: fedcm
Level: 1
Status: w3c/ED
Group: fedid
TR: http://www.w3.org/TR/fedcm/
ED: https://w3c-fedid.github.io/FedCM/
Prepare for TR: true
Repository: w3c-fedid/FedCM
Editor: Nicolás Peña Moreno, w3cid 103755, Google Inc. https://google.com, [email protected]
Former Editor: Sam Goto, w3cid 50308, Google Inc. https://google.com, [email protected]
Markup Shorthands: markdown yes, biblio yes
Default Biblio Display: inline
Text Macro: FALSE <code>false</code>
Text Macro: TRUE <code>true</code>
Text Macro: RP Relying Party
Text Macro: IDP Identity Provider
Abstract: A Web Platform API that allows users to login to websites with their federated accounts in a privacy-preserving manner.
Test Suite: https://github.com/web-platform-tests/wpt/tree/master/fedcm
</pre>
<pre class=anchors>
spec: ecma262; urlPrefix: https://tc39.github.io/ecma262/
type: dfn
text: internal method; url: sec-ordinary-object-internal-methods-and-internal-slots
spec: credential-management-1; urlPrefix: https://w3c.github.io/webappsec-credential-management/
type: dfn
text: same-origin with its ancestors; url: same-origin-with-its-ancestors
type: dfn
text: requires user mediation; url: origin-requires-user-mediation
spec: webdriver; urlPrefix: https://w3c.github.io/webdriver/
type: dfn
text: endpoint node; url: dfn-endpoint-node
text: extension capability; url: dfn-extension-capability
text: getting a property; url: dfn-getting-properties
text: matching capabilities; url: dfn-matching-capabilities
text: no such alert; url: dfn-no-such-alert
text: error code; url: dfn-error-code
text: validating capabilities; url: dfn-validate-capabilities
spec: webappsec-fetch-metadata; urlPrefix: https://w3c.github.io/webappsec-fetch-metadata/
type: dfn
text: Directly User-Initiated Requests; url: directly-user-initiated
spec: login-status; urlPrefix: https://w3c-fedid.github.io/login-status
type: dfn
text: logged-in; url: logged-in
text: logged-out; url: logged-out
text: unknown; url: unknown
text: get the login status; url: get-the-login-status
text: set the login status; url: set-the-login-status
</pre>
<pre class=link-defaults>
spec:infra; type:dfn; text:list
spec:infra; type:dfn; text:user agent
spec:html; type:dfn; for:environment settings object; text:global object
spec:html; type:dfn; for:html-origin-def; text:origin
spec:webidl; type:dfn; text:resolve
spec:webdriver2; type:dfn; text:error
spec:webdriver2; type:dfn; text:remote end steps
spec:fetch; type:dfn; for:/; text:response
spec:css-color-5; type:type; text:<color>
spec:html; type:dfn; text:allowed to use
</pre>
<style>
dl.domintro dt {
font-family: Menlo, Consolas, "DejaVu Sans Mono", Monaco, monospace;
padding-top: 0.5em;
padding-bottom: 1em;
}
dl.domintro dt a {
color: inherit; border-bottom-style: none;
}
dl.domintro dt code {
font-size: inherit;
}
.idp-normative-text {
background-color: rgba(165, 42, 42, 0.3);
margin: 16px 0px;
padding: 8px;
border-left: 8px solid brown;
}
/* temporary fixes to the typogram diagrams
to support dark mode properly */
script + svg :is(polygon, line, rect):not(.grid) {
stroke: currentcolor;
}
script + svg :is(polygon, text) {
fill: currentcolor;
}
</style>
<script src="https://w3c-fedid.github.io/FedCM/static/underscore-min.js"></script>
<script src="https://w3c-fedid.github.io/FedCM/static/raphael.min.js"></script>
<script src="https://w3c-fedid.github.io/FedCM/static/webfont.js"></script>
<script src="https://w3c-fedid.github.io/FedCM/static/typogram.js"></script>
<!-- ============================================================ -->
# Introduction # {#introduction}
<!-- ============================================================ -->
*This section is non-normative.*
As the web has evolved there have been ongoing privacy-oriented changes
(e.g [Safari](https://webkit.org/blog/10218/full-third-party-cookie-blocking-and-more/),
[Firefox](https://blog.mozilla.org/blog/2019/09/03/todays-firefox-blocks-third-party-tracking-cookies-and-cryptomining-by-default/),
[Chrome](https://blog.google/products/chrome/privacy-sustainability-and-the-importance-of-and/))
and changes to the underlying privacy principles (e.g. [[PRIVACY-MODEL]]).
With this evolution, fundamental assumptions of the web
platform are being redefined or removed. Access to cookies in a third-party
context are one of those assumptions. While overall good for the
web, the third-party cookie deprecation removes a fundamental building block
used by certain designs of federated identity.
The Federated Credential Management API aims to bridge the gap for the
federated identity designs which relied on third-party cookies.
The API provides the primitives needed to support federated identity when/where
it depends on third-party cookies, from sign-in to sign-out and revocation.
In order to provide the federated identity primitives without the use of
third-party cookies the API places the [=user agent=] as a mediator between a
<dfn><abbr title="Relying Party">RP</abbr></dfn> (website that requests user information for
federated sign in) and an <dfn><abbr title="Identity Provider">IDP</abbr></dfn> (website that provides
user information for federated sign in). This mediation requires user
permission before allowing the [=RPs=] and [=IDPs=] to know about their
connection to the user.
The specification leans heavily on changes in the [=user agent=] and [=IDP=]
and minimally on the [=RP=]. The FedCM API provides a way to fetch tokens.
<div class=example>
Example showing how a website allowing for a single logged in account
could be implemented.
```html
<html>
<head>
<title>Welcome to my Website</title>
</head>
<body>
<button onclick="login()">Login with idp.example</button>
<script>
let nonce;
async function login() {
try {
// Assume there is a method returning a random number. Store the value in a variable which can
// later be used to check against the value in the token returned.
nonce = random();
// Prompt the user to select an account from the IDP to use for
// federated login within the RP. If resolved successfully, the Promise
// returns an IdentityCredential object from which the |token| can be
// extracted. This is an opaque string passed from the IDP to the RP.
let token = await navigator.credentials.get({
identity: {
providers: [{
configURL: "https://idp.example/manifest.json",
clientId: "123",
nonce: nonce,
}]
}
});
} catch(e) {
// The FedCM call was not successful.
}
}
</script>
</body>
</html>
```
</div>
At a high level, the Federated Credential Management API works by the
intermediation of cooperating [=IDP=]s and [=RP=]s.
The [[#idp-api]] defines a set of HTTP APIs that [=IDP=]s expose as well as the entry points in the
[[#browser-api]] that they can use.
<script type="text/typogram">
+-----------+ +-----------+ +-----------+
| | | | | |
| Relying | | User | | Identity |
| Party | | Agent | | Provider |
| | | | | |
| | | Federated | | |
| | +----------->*-+ Credential| +------------->*-+ Well-Known|
| | | | Management| | | |
| | | | API | +------------->*-+ Config |
| | | | | | | |
| | | | | +------------->*-+ Accounts |
| | | | | | | |
| | | | | +------------->*-+ Assertion |
| | | | | | | |
| | | | | | | |
| +-------+ | | | +-------+ | | | |
| | JS +-+---+ | + HTTP +-+-----+ | |
| +-------+ | | +-------+ | | |
| | | | | |
| | | | | |
+-----------+ +-----------+ +-----------+
</script>
<div class="issue" heading="extension">
An extension spec may add a client metadata endpoint between accounts and assertion:
<script type="text/typogram">
| | | | | +------------->*-+ Accounts |
| | | | | | | |
| | | | | +------------->*-+ Client |
| | | | | | | Metadata |
| | | | | | | |
| | | | | +------------->*-+ Assertion |
| | | | | | | |
</script>
</div>
The user agent intermediates in a manner that makes it impractical for the
API to be used for tracking purposes, while preserving the functionality of
identity federation.
<script type="text/typogram">
Relying User Identity
Party Agent Provider
| | |
| "navigator.credentials.get({ " | "(1) The RP invokes the API." |
| " identity: { " | |
| " providers: [{ " | |
| " configURL: 'config.json'," | |
| " clientId: clientId, " | |
| " nonce: nonce, " | |
| " }] " | |
| " } " | |
| "}) " | |
| | |
|---------------------------------->| |
| | |
| | |
| "(2) From the configURL, the " | "GET /.well-known/web-identity" |
| "browser makes two requests " |-------------------------------->|
| "in parallel. " | |
| | "GET /config.json" |
| |-------------------------------->|
| | |
| "(3) The IdP responds with a " | |
| "well-known file and a " | |
| "config file. " | |
| | |
| | |
| | |
| "The well-known file " | "Well-Known file" |
| "contains a list of valid " |<--------------------------------| "{"
| "config URLs. " | | "provider_urls: [ ... ]"
| | | "}"
| | |
| "The config file contains " | "Config file" |
| "information about the IdP. " |<--------------------------------| "{"
| | | "id_assertion_endpoint: ...,"
| | | "accounts_endpoint: /accounts,"
| | | "client_metadata_endpoint: ...,"
| | | "branding: ...,"
| | | "}"
| | |
| "(4) The browser proceeds to " | "GET /accounts" |
| "fetch the list of accounts " | "Cookie: name=value" |
| "that the user is logged in " |-------------------------------->|
| "to. " |<--------------------------------| "{"
| | | "accounts: [ ... ]"
| | | "}"
| | |
| | |
| +-------------+ "(5) With all of this, the " |
| | | "browser asks for the user's " |
| | | "permission to sign-in to the " |
| "account chooser" | | "RP with the IdP's account. " |
| | | |
| | | |
| +------------>| |
| | |
| | |
| | |
| "(6) Once the user selects an " | "POST /assertion" |
| "account and permission, the " | "client_id, cookies, account" |
| "browser fetches the token. " |-------------------------------->|
| |<--------------------------------| "{"
| | | "token: ...,"
| | | "}"
| | |
| "{ token }" | "(7) Which is then ultimately " |
|<----------------------------------| "used to resolve the promise. " |
| | |
| | |
-+- -+- -+-
</script>
<div class="issue" heading="extension">
The following could be added to an extension spec:
<script type="text/typogram">
| | |
| "(4.5) The browser then " | "GET /client_metadata" |
| "fetches metadata about the " | "client_id" |
| "Relying Party. " |-------------------------------->|
| |<--------------------------------| "{"
| | | "terms_of_service_url: ...,"
| | | "privacy_policy_url: ...,"
| | | "}"
| | |
</script>
</div>
<!-- ============================================================ -->
# The Browser API # {#browser-api}
<!-- ============================================================ -->
The Browser API exposes APIs to [=RP=]s and [=IDP=]s to call and intermediates
the exchange of the user's identity.
The Sign-up/Sign-in API is used by the [=RP=]s to ask the browser
to intermediate the relationship with the [=IDP=] and the
provisioning of a token.
NOTE: The [=RP=] makes no delineation between Sign-up and Sign-in, but
rather calls the same API indistinguishably.
If all goes well, the Relying Party receives back an {{IdentityCredential}}
which contains a token it can use to authenticate the user.
<div class=example>
```js
const credential = await navigator.credentials.get({
identity: {
providers: [{
configURL: "https://idp.example/manifest.json",
clientId: "123",
}]
}
});
```
</div>
When fetches are sent with cookies, unpartitioned
[SameSite](https://httpwg.org/http-extensions/draft-ietf-httpbis-rfc6265bis.html#name-the-samesite-attribute-2)=None
cookies are included. It doesn't introduce security issues on the API even when third-party cookies are otherwise
disabled because the [=RP=] cannot inspect the results from the fetches on its own (i.e., the browser mediates what
the [=RP=] can receive).
<!-- ============================================================ -->
## The connected accounts set ## {#browser-connected-accounts-set}
<!-- ============================================================ -->
Each [=user agent=] has a global <dfn>connected accounts set</dfn>, an initially empty
[=ordered set=]. Its [=list/items=] are triples of the form (|rp|, |idp|, |account|) where |rp| is
the [=/origin=] of the [=RP=], |idp| is the [=/origin=] of the [=IDP=], and |account| is a string representing
an account identifier. It represents the set of triples such that the user has used FedCM to login to
the |rp| via the |idp| |account|.
Issue: the [=connected accounts set=] should be double keyed in the [=RP=] (i.e., it should include
both the requester and the embedder, or in other words the iframe and the top-level). Otherwise the
top-level's state could be used and modified by the embedder, which introduces leaks and unwanted
cross-origin communication.
If a user clears browsing data for an |origin| (cookies, localStorage, etc.), the user agent MUST
[=list/remove=] all triples with an [=/origin=] matching the |origin| from <a>connected accounts set</a>.
<div algorithm>
To <dfn>compute the connected account key</dfn> given an {{IdentityProviderConfig}} |provider|, an
{{IdentityProviderAccount}} |account|, and a |globalObject|, run the following steps. It returns a
triple of the form (rp, idp, account).
1. Let |configUrl| be the result of running [=parse url=] with |provider|'s
{{IdentityProviderConfig/configURL}} and |globalObject|.
1. Let |idpOrigin| be the [=url/origin=] corresponding to |configUrl|.
1. Let |rpOrigin| be |globalObject|'s [=associated Document=]'s [=Document/origin=].
1. Let |accountId| be |account|'s {{IdentityProviderAccount/id}}.
1. Return (|rpOrigin|, |idpOrigin|, |accountId|).
</div>
<div algorithm>
When asked whether an {{IdentityProviderAccount}} |account| is
<dfn>eligible for auto reauthentication</dfn> given an {{IdentityProviderConfig}} |provider| and a
|globalObject|, run the following steps. This returns a boolean.
1. If |account| [=map/contains=] {{IdentityProviderAccount/approved_clients}} and
|account|'s {{IdentityProviderAccount/approved_clients}} does not [=list/contain=]
|provider|'s {{IdentityProviderConfig/clientId}}, return false.
1. Let |triple| be the result of running [=compute the connected account key=] given |provider|,
|account|, and |globalObject|.
1. Return whether [=connected accounts set=] [=list/contains=] |triple|.
</div>
<div algorithm="compute the connection status">
When asked to <dfn>compute the connection status</dfn> given an {{IdentityProviderAccount}}
|account|, an {{IdentityProviderConfig}} |provider| and a |globalObject|, run the following steps.
This returns <dfn for="compute the connection status">connected</dfn> or
<dfn for="compute the connection status">disconnected</dfn>.
1. If |account| [=map/contains=] {{IdentityProviderAccount/approved_clients}}:
1. If |account|'s {{IdentityProviderAccount/approved_clients}} [=list/contains=]|provider|'s
{{IdentityProviderConfig/clientId}}, return [=compute the connection status/connected=].
1. Return [=compute the connection status/disconnected=].
1. Let |triple| be the result of running [=compute the connected account key=] given |provider|,
|account|, and |globalObject|.
1. If [=connected accounts set=] [=list/contains=] |triple|, return
[=compute the connection status/connected=].
1. Return [=compute the connection status/disconnected=].
</div>
<div algorithm>
To <dfn>create a connection between the RP and the IdP account</dfn> given an
{{IdentityProviderConfig}} |provider|, an {{IdentityProviderAccount}} |account|, and a
|globalObject| (the [=RP=]'s), run the following steps:
1. Let |configUrl| be the result of running [=parse url=] with |provider|'s
{{IdentityProviderConfig/configURL}} and |globalObject|.
1. Let |idpOrigin| be the [=url/origin=] corresponding to |configUrl|.
1. Let |rpOrigin| be |globalObject|'s [=associated Document=]'s [=Document/origin=].
1. Let |accountId| be |account|'s {{IdentityProviderAccount/id}}.
1. Let |triple| be (|rpOrigin|, |idpOrigin|, |accountId|).
1. [=set/Append=] |triple| to [=connected accounts set=].
</div>
<div algorithm>
To <dfn>remove a connection</dfn>: given |accountId|, |rpOrigin|, and |idpOrigin|, run the
following steps. It returns whether the |accountId| connection was successfully removed.
1. Let |triple| be (|rpOrigin|, |idpOrigin|, |accountId|).
1. If [=connected accounts set=] [=list/contains=] |triple|:
1. [=list/Remove=] |triple| from the [=connected accounts set=].
1. Return true.
1. Return false.
</div>
<div algorithm>
To <dfn>remove all connections</dfn>: given |rpOrigin| and |idpOrigin|, run the following steps:
1. For every (|rp|, |idp|, <var ignore="">accountId</var>) |triple| in the
[=connected accounts set=]:
1. If |rp| equals |rpOrigin| and |idp| equals |idpOrigin|, [=list/remove=] |triple| from the
[=connected accounts set=].
</div>
<!-- ============================================================ -->
## The IdentityCredential Interface ## {#browser-api-identity-credential-interface}
<!-- ============================================================ -->
This specification introduces a new type of {{Credential}}, called an {{IdentityCredential}}:
<pre class="idl">
dictionary IdentityCredentialDisconnectOptions : IdentityProviderConfig {
required USVString accountHint;
};
[Exposed=Window, SecureContext]
interface IdentityCredential : Credential {
static Promise<undefined> disconnect(IdentityCredentialDisconnectOptions options);
readonly attribute USVString? token;
readonly attribute boolean isAutoSelected;
readonly attribute USVString configURL;
};
</pre>
<dl>
: <b>{{Credential/id}}</b>
:: The {{Credential/id}}'s attribute getter returns the empty string.
: <b>{{IdentityCredential/token}}</b>
:: The {{IdentityCredential/token}}'s attribute getter returns the value it is set to.
It represents the minted {{IdentityAssertionResponse/token}} provided by the [=IDP=].
: <b>{{IdentityCredential/isAutoSelected}}</b>
:: {{IdentityCredential/isAutoSelected}}'s attribute getter returns the value it is
set to. It represents whether the user's identity credential was automatically selected when
going through the UI flow which resulted in this {{IdentityCredential}}.
: <b>{{IdentityCredential/configURL}}</b>
:: The {{IdentityCredential/configURL}}'s attribute getter returns the value it is set to.
It represents the config URL corresponding to the [=IDP=] which issued this credential.
: <b>{{Credential/[[type]]}}</b>
:: The {{IdentityCredential}}'s {{Credential/[[type]]}}'s value is "<b>identity</b>".
: <b>{{Credential/[[discovery]]}}</b>
:: The {{IdentityCredential}}'s {{Credential/[[discovery]]}}'s value is
{{Credential/[[discovery]]/remote}}.
</dl>
The main entrypoint in this specification is through the entrypoints exposed
by the [[CM]] API.
<!-- ============================================================ -->
### The disconnect method ### {#browser-api-identity-credential-disconnect}
<!-- ============================================================ -->
<div algorithm="identity-credential-disconnect">
When the static {{IdentityCredential/disconnect}} method is invoked, given an
{{IdentityCredentialDisconnectOptions}} |options|, perform the following steps:
1. Let |globalObject| be the [=current global object=].
1. Let |document| be |globalObject|'s [=associated Document=].
1. If |document| is not [=allowed to use=] the [=identity-credentials-get=]
[=policy-controlled feature=], throw a "{{NotAllowedError}}" {{DOMException}}.
1. Let |promise| be a new {{Promise}}.
1. [=In parallel=], [=attempt to disconnect=] given |options|, |promise|, and |globalObject|.
1. Return |promise|.
</div>
<div algorithm>
When asked to <dfn>attempt to disconnect</dfn> given an {{IdentityCredentialDisconnectOptions}}
|options|, a {{Promise}} |promise|, and a |globalObject|, perform the following steps:
1. Assert: these steps are running [=in parallel=].
1. Let |configUrl| be the result of running [=parse url=] with |options|'s
{{IdentityProviderConfig/configURL}} and |globalObject|.
1. If |configUrl| is failure, [=reject=] |promise| with an "{{InvalidStateError}}"
{{DOMException}}.
1. Run a [[!CSP]] check with a [[CSP#directive-connect-src|connect-src]] directive on the URL
passed as |configUrl|. If it fails, [=reject=] |promise| with a "{{NetworkError}}"
{{DOMException}}.
1. If there is another pending {{IdentityCredential/disconnect}} call for this |globalObject|
(e.g., it has not yet thrown an exception or its associated {{Promise}} has not yet been
resolved), [=reject=] |promise| with a "{{NetworkError}}" {{DOMException}}.
1. If |configUrl| is not a [=potentially trustworthy origin=], [=reject=] |promise| with a
"{{NetworkError}}" {{DOMException}}.
1. If the user has disabled the FedCM API on the |globalObject|, [=reject=] |promise| with a
"{{NetworkError}}" {{DOMException}}.
1. If there does not exist an account |account| such that [=connected accounts set=]
[=list/contains=] the result of [=compute the connected account key=] given |account|,
|options|, and |globalObject|, then [=reject=] |promise| with a "{{NetworkError}}"
{{DOMException}}. This check can be performed by iterating over the
[=connected accounts set=] or by keeping a separate data structure to make this lookup fast.
1. Let |config| be the result of running [=fetch the config file=] with
|provider| and |globalObject|.
1. If |config| is failure, [=reject=] |promise| with a "{{NetworkError}}" {{DOMException}}.
1. Let |disconnectUrl| be the result of [=computing the manifest URL=] given |provider|,
|config|.{{IdentityProviderAPIConfig/disconnect_endpoint}}, and |globalObject|.
1. If |disconnectUrl| is failure, [=reject=] |promise| with a "{{NetworkError}}"
{{DOMException}}.
1. [=Send a disconnect request=] with |disconnectUrl|, |options|, and |globalObject|, and let
|result| be the result.
1. Let |idpOrigin| be the [=url/origin=] corresponding to |configUrl|.
1. Let |rpOrigin| be |globalObject|'s [=associated Document=]'s [=Document/origin=].
1. If |result| is failure:
1. [=Remove all connections=] given |rpOrigin| and |idpOrigin|.
1. [=Reject=] |promise| with a "{{NetworkError}}" {{DOMException}}.
1. Return.
1. Let |accountId| be |result| (note that it is not failure).
1. [=Remove a connection=] using |accountId|, |rpOrigin|, and |idpOrigin|, and let
|wasAccountRemoved| be the result.
1. If |wasAccountRemoved| is false, [=remove all connections=] given |rpOrigin| and |idpOrigin|.
1. [=Resolve=] |promise|.
</div>
<!-- ============================================================ -->
#### Disconnect request #### {#disconnect-request}
<!-- ============================================================ -->
The [=send a disconnect request=] algorithm sends a request to disconnect an account that has
previously been used for federated login in the [=RP=].
<div algorithm>
When asked to <dfn>send a disconnect request</dfn>, given a <a spec=url for=/>URL</a>
|disconnectUrl|, and {{IdentityCredentialDisconnectOptions}} |options|, and a |globalObject|,
perform the following steps. This returns an {{USVString}} or failure.
1. Let |requestBody| be the result of running [=urlencoded serializer=] with a list containing:
1. ("client_id", |options|'s {{IdentityProviderConfig/clientId}})
1. ("account_hint", |options|'s {{IdentityCredentialDisconnectOptions/accountHint}})
1. Let |request| be a new <a spec=fetch for=/>request</a> as follows:
: [=request/url=]
:: |disconnectUrl|
: [=request/method=]
:: "POST"
: [=request/body=]
:: the [=UTF-8 encode=] of |requestBody|
: [=request/redirect mode=]
:: "error"
: [=request/client=]
:: null
: [=request/window=]
:: "no-window"
: [=request/service-workers mode=]
:: "none"
: [=request/destination=]
:: "webidentity"
: [=request/origin=]
:: |globalObject|'s [=associated document=]'s [=Document/origin=]
: [=request/header list=]
:: a [=list=] containing a single [=header=] with [=header/name=] set to `Accept` and
[=header/value=] set to `application/x-www-form-urlencoded`
: [=request/credentials mode=]
:: "include"
: [=request/mode=]
:: "cors"
1. Let |accountId| be null.
1. [=Fetch request=] with |request| and |globalObject|, and with
<var ignore>processResponseConsumeBody</var> set to the following steps given a
<a spec=fetch for=/>response</a> |response| and |responseBody|:
1. Let |json| be the result of [=extract the JSON fetch response=] from |response| and
|responseBody|.
1. [=converted to an IDL value|Convert=] |json| to a {{DisconnectedAccount}}, |account|.
1. If one of the previous two steps threw an exception, set |accountId| to failure
and return.
1. Set |accountId| to |account|'s {{DisconnectedAccount/account_id}}.
1. Wait for |accountId| to be set.
1. Return |accountId|.
</div>
<xmp class="idl">
dictionary DisconnectedAccount {
required USVString account_id;
};
</xmp>
<!-- ============================================================ -->
### The CredentialRequestOptions ### {#browser-api-credential-request-options}
<!-- ============================================================ -->
This section defines the dictionaries passed into the JavaScript call:
<div class=example>
```js
const credential = await navigator.credentials.get({
identity: { // IdentityCredentialRequestOptions
providers: [{ // sequence<IdentityCredentialRequestOptions>
configURL: "https://idp.example/manifest.json", // IdentityProviderConfig.configURL
clientId: "123", // IdentityProviderConfig.clientId
nonce: "nonce" // IdentityProviderConfig.nonce
}]
}
});
```
</div>
This specification introduces an extension to the {{CredentialRequestOptions}} object:
<pre class="idl">
partial dictionary CredentialRequestOptions {
IdentityCredentialRequestOptions identity;
};
</pre>
The {{IdentityCredentialRequestOptions}} contains a list of
{{IdentityProviderConfig}}s that the [=RP=] supports and has
pre-registered with (i.e. the [=IDP=] has given the [=RP=] a `clientId`).
The {{IdentityCredentialRequestOptions}} also contains an
{{IdentityCredentialRequestOptionsContext}}, which the user agent can use to
provide a more meaningful dialog to users, and an
{{IdentityCredentialRequestOptionsMode}}, which the user agent can use to
specify different behaviors or dialog types.
<xmp class=idl>
enum IdentityCredentialRequestOptionsContext {
"signin",
"signup",
"use",
"continue"
};
enum IdentityCredentialRequestOptionsMode {
"active",
"passive"
};
dictionary IdentityCredentialRequestOptions {
required sequence<IdentityProviderRequestOptions> providers;
IdentityCredentialRequestOptionsContext context = "signin";
IdentityCredentialRequestOptionsMode mode = "passive";
};
</xmp>
Each {{IdentityProviderConfig}} represents an [=IDP=] that
the [=RP=] supports (e.g. that it has a pre-registration agreement with).
<xmp class=idl>
dictionary IdentityProviderConfig {
required USVString configURL;
required USVString clientId;
};
dictionary IdentityProviderRequestOptions : IdentityProviderConfig {
USVString nonce;
DOMString loginHint;
DOMString domainHint;
sequence<USVString> fields;
any params;
};
</xmp>
<dl>
: <b>{{IdentityProviderConfig/configURL}}</b>
:: The URL of the configuration file for the identity provider.
: <b>{{IdentityProviderConfig/clientId}}</b>
:: The {{id_assertion_endpoint_request/client_id}} provided to the [=RP=] out of band by the [=IDP=]
: <b>{{IdentityProviderRequestOptions/nonce}}</b>
:: A random number of the choice of the [=RP=]. It is generally used to associate a client
session with a {{IdentityAssertionResponse/token}} and to mitigate replay attacks.
Therefore, this value should have sufficient entropy such that it would be hard to guess.
: <b>{{IdentityProviderRequestOptions/loginHint}}</b>
:: A string representing the login hint corresponding to an account which the RP wants the user
agent to show to the user. If provided, the user agent will not show accounts which do not
match this login hint value. It generally matches some attribute from the desired
{{IdentityProviderAccount}}.
: <b>{{IdentityProviderRequestOptions/domainHint}}</b>
:: A string representing the domain hint corresponding to a domain which the [=RP=] is
interested in, or "any" if the [=RP=] wants any account associated with at least one domain
hint. If provided, the user agent will not show accounts which do not match the domain hint
value.
</dl>
<!-- ============================================================ -->
### The <code>\[[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors)</code> internal method ### {#browser-api-rp-sign-in}
<!-- ============================================================ -->
The {{Credential/[[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors)}}
algorithm runs in parallel inside [[credential-management#algorithm-request]] to request
credentials and returns an {{IdentityCredential}} or an error.
This [=internal method=] accepts three arguments:
<dl dfn-type="argument" dfn-for="IdentityCredential/[[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors)">
: <dfn>origin</dfn>
:: This argument is the [=relevant settings object=]'s
[=environment settings object/origin=], as determined by the
calling {{CredentialsContainer/get()}} implementation, i.e.,
{{CredentialsContainer}}'s <a abstract-op>Request a `Credential`</a>
abstract operation.
: <dfn>options</dfn>
:: This argument is a {{CredentialRequestOptions}} object whose
{{CredentialRequestOptions/identity}} member [=map/exists=].
: <dfn>sameOriginWithAncestors</dfn>
:: This argument is a Boolean value which is [TRUE] if and only if the
caller's [=environment settings object=] is
[=same-origin with its ancestors=]. It is [FALSE] if caller is cross-origin.
Note: Invocation of this [=internal method=] indicates that it was allowed by
[=permissions policy=], which is evaluated at the [[!CREDENTIAL-MANAGEMENT-1]] level.
See [[#permissions-policy-integration]]. As such,
<var ignore=''>sameOriginWithAncestors</var> is unused.
</dl>
The <var ignore="">options</var>.{{CredentialRequestOptions/signal}} is used as an abort signal for the
requests.
<div algorithm="[[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors)">
When the {{IdentityCredential}}'s
<dfn for="IdentityCredential" method>\[[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors)</dfn>
algorithm is invoked, the user agent MUST execute the following steps. This returns an
{{IdentityCredential}} (or throws an error to the caller).
1. Assert: These steps are running [=in parallel=].
1. If
|options|["{{CredentialRequestOptions/identity}}"]["{{IdentityCredentialRequestOptions/providers}}"]
is [=list/empty=], [=queue a global task=] on the [=DOM manipulation task source=] given
|globalObject| to throw a new "{{NetworkError}}" {{DOMException}}.
Note: The |globalObject| is not currently passed onto the
{{Credential/[[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors)}}
algorithm. See <a href="https://github.com/w3c/webappsec-credential-management/issues/210">issue</a>.
1. Let |providerList| be |options|["{{CredentialRequestOptions/identity}}"]["{{IdentityCredentialRequestOptions/providers}}"].
1. Let |credential| be the result of running [=create an IdentityCredential=] with |providerList|,
|options|, and |globalObject|.
Note: The |globalObject| is not currently passed onto the
{{Credential/[[DiscoverFromExternalSource]](origin, options, sameOriginWithAncestors)}}
algorithm. See <a href="https://github.com/w3c/webappsec-credential-management/issues/210">issue</a>.
1. If |credential| is a pair:
1. Let |throwImmediately| be the value of the second element of the pair.
1. The user agent SHOULD wait a random amount of time
before the next step if all of the following conditions hold:
* |throwImmediately| is false
* The <dfn>promise rejection delay</dfn> was not disabled by
[=setdelayenabled|user agent automation=]
* The user agent has not implemented another way to prevent
exposing to the RP whether the user has an account logged
in to the RP
Note: The intention here is as follows. If the the promise was resolved immediately,
then an RP could infer that no dialog was shown because the promise was
resolved quickly, after just the network delay. A shown dialog implies
that the user is logged in to one or more accounts of the IDP. To prevent
this information leakage, especially without user confirmation, this delay is specified.
However, UAs may have different UI approaches here and prevent it in a different way.
1. [=Queue a global task=] on the [=DOM manipulation task source=]
to throw a new "{{NetworkError}}" {{DOMException}}.
1. Otherwise, return |credential|.
</div>
<!-- ============================================================ -->
### Create an IdentityCredential ### {#create-identity-credential}
<!-- ============================================================ -->
The <a>create an IdentityCredential</a> algorithm invokes the various FedCM fetches, shows the user
agent UI, and creates the {{IdentityCredential}} that is then returned to the [=RP=].
<div algorithm="create an IdentityCredential">
To <dfn>create an IdentityCredential</dfn> given a [=sequence=] of {{IdentityProviderRequestOptions}}
|providerList|, a {{CredentialRequestOptions}} |options|, and a
|globalObject|, run the following steps. This returns an {{IdentityCredential}}
or a pair (failure, bool), where the bool indicates whether to skip delaying
the exception thrown.
1. Assert: These steps are running [=in parallel=].
1. Let |mode| be |options|'s {{IdentityCredentialRequestOptions/mode}}.
1. If |mode| is {{IdentityCredentialRequestOptionsMode/active}}:
1. If |providerList|'s [=list/size=] is not equal to 1, return (failure, true).
1. Assert: |globalObject| is a {{Window}}.
1. If |globalObject| does not have [=transient activation=], return (failure, true).
1. Otherwise, if there is a pending request where {{IdentityCredentialRequestOptionsMode}} is
{{IdentityCredentialRequestOptionsMode/passive}} on |globalObject|'s [=Window/navigable=]'s
[=navigable/top-level traversable=] or on any of its descendants, reject the pending
request with a "{{NetworkError}}" {{DOMException}}.
1. The user agent MAY wait an arbitrary amount of time before continuing with the next steps.
The user agent MAY also return (failure, false) at this point or after some arbitrary wait.
The user agent MAY also set |providerList| to a subset of itself after some arbitrary wait.
<div class="note">
NOTE: For example, the user agent could do any of the following:
* Show an identity provider selector and only proceed once
the user confirms their desire to use an identity provider.
* Provide a button in the URL bar and wait for user input
before continuing.
* Use previous user behavior to determine not to show any
UI to the user and silently reject the request.
</div>
1. Let |mediation| be |options|'s {{CredentialRequestOptions/mediation}}.
1. Let |providerMap| be a new [=map=].
1. For each |provider| in |providerList|:
Note: The fetches performed in these steps to populate |providerMap| can be performed at the
same time, e.g., the second [=IDP=]'s fetches can be started before the first ones finish,
since these are indepedent.
1. Let |providerOrigin| be the [=/origin=] of |provider|'s {{IdentityProviderConfig/configURL}}.
1. If |providerMap| [=map/contains=] |providerOrigin|, return (failure, true).
1. Let |loginStatus| be the result of [=get the login status=] with |providerOrigin|.
1. If |loginStatus| is [=unknown=], a user agent MAY set it to [=logged-out=].
1. If |loginStatus| is [=logged-out=]:
1. If |mode| is {{IdentityCredentialRequestOptionsMode/active}}:
1. Let |result| be the result of running
[=fetch the config file and show an IDP login dialog=] with
|provider| and |globalObject|.
1. If |result| is failure, return (failure, true).
1. Otherwise, set |providerMap|[|providerOrigin|] to "logged-out" and [=continue=].
1. Let |requiresUserMediation| be |providerOrigin|'s [=requires user mediation=].
1. If |requiresUserMediation| is true and |mediation| is
"{{CredentialMediationRequirement/silent}}", [=continue=].
1. Let |config| be the result of running [=fetch the config file=] with
|provider| and |globalObject|.
1. If |config| is failure, [=continue=].
1. <dfn>Fetch accounts step</dfn>: Let |accountsList| be the result of
[=fetch the accounts=] with |config|, |provider|, and |globalObject|.
1. If |accountsList| is failure, or the size of |accountsList| is 0:
1. [=Set the login status=] of |providerOrigin| to [=logged-out=].
A user agent may decide to skip this step if no credentials were
sent to server.
Note: For example, if the fetch failed due to a DNS error, no
credentials were sent and therefore the [=IDP=] did not learn
the user's identity. In this situation, we do not know whether
the user is signed in or not and so we may not want to reset
the status.
1. If |loginStatus| is [=logged-in=], set |providerMap|[|providerOrigin|] to "mismatch"
and [=continue=].
1. Assert: |accountsList| is not failure and the size of |accountsList| is not 0.
1. [=Set the login status=] for |providerOrigin| to [=logged-in=].
1. For each |acc| in |accountsList|:
1. If |acc|["{{IdentityProviderAccount/picture}}"] is present, [=fetch the account picture=]
with |acc| and |globalObject|. If the [=user agent=] displays this picture to
the user at any point, it MUST reuse the result of this fetch instead of redownloading
the picture.
Note: We require downloading the pictures here before we potentially filter the account
list so that the identity provider cannot determine what hints were provided
based on which fetches occurred.
1. If |provider|'s {{IdentityProviderRequestOptions/loginHint}} is not empty:
1. For every |account| in |accountList|, remove |account| from |accountList| if |account|'s
{{IdentityProviderAccount/login_hints}} does not [=list/contain=] |provider|'s
{{IdentityProviderRequestOptions/loginHint}}.
1. If |accountList| is now empty, set |providerMap|[|providerOrigin|] to "mismatch" and
continue.
1. If |provider|'s {{IdentityProviderRequestOptions/domainHint}} is not empty:
1. For every |account| in |accountList|:
1. If {{IdentityProviderRequestOptions/domainHint}} is "any":
1. If |account|'s {{IdentityProviderAccount/domain_hints}} is empty, remove
|account| from |accountList|.
1. Otherwise, remove |account| from |accountList| if |account|'s
{{IdentityProviderAccount/domain_hints}} does not [=list/contain=] |provider|'s
{{IdentityProviderRequestOptions/domainHint}}.
1. If |accountList| is now empty, set |providerMap|[|providerOrigin|] to "mismatch" and
continue.
1. If |config|.{{IdentityProviderAPIConfig/account_label}} is present:
1. For every |account| in |accountList|, remove |account| from |accountList| if |account|'s
{{IdentityProviderAccount/label_hints}} does not [=list/contain=]
|config|.{{IdentityProviderAPIConfig/account_label}}.
1. If |accountList| is now empty, set |providerMap|[|providerOrigin|] to "mismatch" and
continue.
1. Set |providerMap|[|providerOrigin|] to |accountsList|.
1. If |providerMap| [=map/is empty=], return (failure, false).
1. Let |registeredAccount| and |numRegisteredAccounts| be null and 0, respectively.
1. Let |selectedAccount| be null.
1. For each (|providerOrigin|, |value|) in |providerMap|:
1. If |value| is not a [=list=] |accountsList|, [=continue=].
1. For each |acc| in |accountsList|:
1. If |acc| is [=eligible for auto reauthentication=] given the relevant |provider|, and
|globalObject|, set |registeredAccount| to |acc|, increase |numRegisteredAccounts| by 1,
and set |requiresUserMediation| be |providerOrigin|'s [=requires user mediation=].
1. If |mediation| is not "{{CredentialMediationRequirement/required}}", |requiresUserMediation|
is false, |numRegisteredAccounts| is equal to 1, and |providerMap|'s [=map/values=] do not
[=map/contain=] "mismatch":
1. Set |selectedAccount| to |registeredAccount| and |permission| to true. When doing this, the user
agent MAY show some UI to the user indicating that they are being
<dfn>auto-reauthenticated</dfn>.
1. Set |isAutoSelected| to true.
1. Otherwise, if |mediation| is "{{CredentialMediationRequirement/silent}}" and |providerMap|'s
[=map/values=] do not [=map/contain=] "mismatch", return (failure, true).
1. Let |permission|, |permissionRequested|, and |isAutoSelected| be set to false.
1. Let |allAccounts| be an empty [=list=].
1. Build UI by adding the following for each (|providerOrigin|, |value|) in |providerMap|:
1. If |value| is "logged-out", the user agent adds one of the following:
* Nothing: no UI is shown regarding this [=IDP=].
* Prompt to continue with this [=IDP=]. If the user continues, the user
agent SHOULD set the login status to [=unknown=]. This MAY include an
* Return (failure, false).
* Prompt the user whether to continue. If the user continues, the user
agent SHOULD set |loginStatus| to [=unknown=]. This MAY include an
affordance to [=show an IDP login dialog=].
* If the user triggers this affordance:
1. Let |result| be the result of running
[=fetch the config file and show an IDP login dialog=]
with the relevant |provider| and |globalObject|.
1. If |result| is failure, return (failure, true).
1. Otherwise, if |value| is "mismatch", add contents indicating this |providerOrigin|
to the user. The contents SHOULD provide an affordance for the user to trigger
the [=show an IDP login dialog=] algorithm with the relevant |config| and |provider|;
this dialog is the <dfn>confirm IDP login dialog</dfn>.
Note: This situation happens when the browser expects the user
to be signed in, but the accounts fetch indicated that the user
is signed out.
Note: This dialog ensures that silent tracking of the user is
impossible by always showing UI of some kind when credentials
were sent to the server.
* If the [=show an IDP login dialog=] algorithm was triggered:
1. Let |result| be the result of that algorithm.
1. If |result| is failure, return (failure, true). The user
agent MAY show a dialog to the user before or after
returning failure indicating this failure.
1. Otherwise, go back to the [=fetch accounts step=] to get an updated
value of |providerMap| for this [=IDP=].
1. Otherwise, |value| is a [=list=] of accounts. [=list/Extend=] |allAccounts| with |value|.
1. Also include a UI affordance to close the dialog. If the user closes this dialog, return (failure,
true).
1. <dfn for="create identity credential">Show accounts</dfn> step: if |allAccounts| is not [=list/empty=], also add UI to present the account options to the user.
If the user selects an account, perform the following steps:
1. Set |selectedAccount| to the chosen {{IdentityProviderAccount}}.
1. Close the dialog.
1. If the [=user agent=] created any dialogs requesting user choice or permission in the previous
steps, wait until they are closed.
1. If |permission| is false, then return (failure, true).
1. Assert: |selectedAccount| is not null.
1. Let |credential| be the result of running the [=fetch an identity assertion=] algorithm with
|selectedAccount|'s {{IdentityProviderAccount/id}}, |permissionRequested|, |isAutoSelected|,
|provider|, |config|, and |globalObject|.
1. Return |credential|.
</div>
<div class="issue" heading="extension">
An extension may use the following instead of the [=create identity credential/show accounts=] step, where
|permissionRequested| is sometimes set:
1. If |allAccounts| is not [=list/empty=], also add UI to present the account options to the user as follows:
1. If |allAccounts|'s size is 1 and <var ignore="">providerMap</var>'s [=map/values=] do not [=map/contain=]
"mismatch":
1. Set |selectedAccount| to |allAccounts|[0].
1. If [=compute the connection status=] of |selectedAccount|, the relevant |provider|,
and |globalObject| returns [=compute the connection status/connected=], show a
dialog to request user permission to sign in via |selectedAccount|, and set the
result in |permission|. The user agent MAY use |options|'s
{{IdentityCredentialRequestOptions/context}} and |options|'s
{{IdentityCredentialRequestOptions/mode}} to customize the dialog.
1. Otherwise, set |permission| to the result of running [=request permission to sign-up=]
algorithm with |selectedAccount|, the relevant |config|, the relevant |provider|,
and |globalObject|. Also set |permissionRequested| to true if the user agent
[=supports showing a permission prompt=].
1. Otherwise:
1. Show UI to allow the user to select an account chooser displaying the options from
<var ignore="">accountsList</var>.
1. If the user selects an account, perform the following steps:
1. Set |selectedAccount| to the chosen {{IdentityProviderAccount}}.
1. If [=compute the connection status=] of |selectedAccount|, the relevant |provider|,
and |globalObject| is [=compute the connection status/connected=], set |permission|
to true.
1. Otherwise, if |provider|.{{IdentityProviderRequestOptions/fields}} is [=list/empty=],
[=create a connection between the RP and the IdP account=] with |provider|, |account|,
and |globalObject|, and set |permission| to true.
Note: The connection would normally be created in the [=request permission to sign-up=]
algorithm, but we do not want to show an extra dialog in this case.
1. Otherwise:
1. Set |permission| to the result of running the [=request permission to sign-up=]
algorithm with |selectedAccount|, the relevant |config|, the relevant |provider|,
and |globalObject|.
1. Set |permissionRequested| to true.
</div>
<!-- ============================================================ -->
### Fetch the config file ### {#fetch-config-file}
<!-- ============================================================ -->
The <a>fetch the config file</a> algorithm fetches both the [=well-known file=] and the config file from
the [=IDP=], checks that the config file is mentioned in the [=well-known file=], and returns the config.
<div algorithm>
To <dfn>fetch the config file</dfn> given an {{IdentityProviderRequestOptions}} |provider| and
|globalObject|, run the following steps. This returns an {{IdentityProviderAPIConfig}}
or failure.
1. Let |configUrl| be the result of running [=parse url=] with |provider|'s
{{IdentityProviderConfig/configURL}} and |globalObject|.
1. If |configUrl| is failure, return failure.
1. Run a [[!CSP]] check with a [[CSP#directive-connect-src|connect-src]] directive on the URL
passed as |configUrl|. If it fails, return failure.
1. If |configUrl| is not a [=potentially trustworthy URL=], return failure.
1. Let |rootUrl| be a new [=/URL=].
1. Set |rootUrl|'s [=url/scheme=] to |configUrl|'s [=url/scheme=].
1. Set |rootUrl|'s [=url/host=] to |configUrl|'s [=url/host=]'s [=host/registrable domain=].
1. Set |rootUrl|'s [=url/path=] to the <a>list</a> «".well-known", "web-identity"».
1. Let |config|, |wellKnown|, |accounts_url|, and |login_url| be null.
1. Let |skipWellKnown| be false.
1. Let |rpOrigin| be |globalObject|'s [=associated Document=]'s [=Document/origin=].
1. If |rpOrigin| is not an [=opaque origin=], and |rootUrl|'s [=url/host=] is equal
to |rpOrigin|'s [=host/registrable domain=], and |rootUrl|'s [=url/scheme=] is
equal to |rpOrigin|'s [=origin/scheme=], set |skipWellKnown| to true.
Note: Because domain cookies are valid across an entire site, there is no privacy
benefit from doing the well-known check if the RP and IDP are in the same site.
1. Otherwise:
1. Let |wellKnownRequest| be a new [=/request=] as follows:
: [=request/URL=]
:: |rootUrl|
: [=request/client=]
:: null
: [=request/window=]
:: "no-window"
: [=request/service-workers mode=]
:: "none"
: [=request/destination=]
:: "webidentity"
: [=request/origin=]
:: a unique [=opaque origin=]
: [=request/header list=]
:: a [=list=] containing a single [=header=] with [=header/name=] set to `Accept` and
[=header/value=] set to `application/json`
: [=request/referrer policy=]
:: "no-referrer"
: [=request/credentials mode=]
:: "omit"
: [=request/mode=]
:: "no-cors"
Issue: The spec is yet to be updated so that all <a spec=fetch for=/>requests</a> are created
with [=request/mode=] set to "user-agent-no-cors". See the relevant
[pull request](https://github.com/whatwg/fetch/pull/1533) for details.
1. [=Fetch request=] with |wellKnownRequest| and |globalObject|, and with <var ignore>processResponseConsumeBody</var>
set to the following steps, given a <a spec=fetch for=/>response</a> |response| and |responseBody|:
1. Let |json| be the result of [=extract the JSON fetch response=] from |response| and
|responseBody|.
1. Set |wellKnown| to the result of [=converted to an IDL value|converting=] |json|
to an {{IdentityProviderWellKnown}}.
1. If one of the previous two steps threw an exception, or if the
[=list/size=] of |wellKnown|["{{IdentityProviderWellKnown/provider_urls}}"] is
greater than 1, set |wellKnown| to failure.
Issue: [relax](https://github.com/fedidcg/FedCM/issues/333) the size of the
provider_urls array.
1. Let |configRequest| be a new <a spec=fetch for=/>request</a> as follows:
: [=request/url=]
:: |configUrl|
: [=request/redirect mode=]
:: "error"
: [=request/client=]
:: null
: [=request/window=]
:: "no-window"
: [=request/service-workers mode=]
:: "none"
: [=request/destination=]
:: "webidentity"
: [=request/origin=]
:: a unique [=opaque origin=]
: [=request/header list=]
:: a [=list=] containing a single [=header=] with [=header/name=] set to `Accept` and
[=header/value=] set to `application/json`
: [=request/referrer policy=]
:: "no-referrer"
: [=request/credentials mode=]
:: "omit"
: [=request/mode=]
:: "no-cors"
Issue: The spec is yet to be updated so that all <a spec=fetch for=/>requests</a> are created
with [=request/mode=] set to "user-agent-no-cors". See the relevant
[pull request](https://github.com/whatwg/fetch/pull/1533) for details.
1. [=Fetch request=] with |configRequest| and |globalObject|, and with <var ignore>processResponseConsumeBody</var>
set to the following steps given a <a spec=fetch for=/>response</a> |response| and |responseBody|:
1. Let |json| be the result of [=extract the JSON fetch response=] from |response| and
|responseBody|.
1. [=converted to an IDL value|Convert=] |json| to an {{IdentityProviderAPIConfig}} stored
in |config|.
1. If one of the previous two steps threw an exception, set |config| to failure.
1. Set |login_url| to the result of [=computing the manifest URL=] with |provider|,
|config|.{{IdentityProviderAPIConfig/login_url}}, and |globalObject|.
1. Set |accounts_url| to the result of [=computing the manifest URL=] with |provider|,
|config|.{{IdentityProviderAPIConfig/accounts_endpoint}}, and |globalObject|.
1. If |login_url| or |accounts_url| is failure, set |config| to failure.
1. Wait for |config| to be set.
1. If |config| is failure, return failure.
1. If |skipWellKnown| is true, return |config|.
1. Wait for |wellKnown| to be set.
1. If |wellKnown| is failure, return failure.
1. If |wellKnown|.{{IdentityProviderWellKnown/accounts_endpoint}} and
|wellKnown|.{{IdentityProviderWellKnown/login_url}} are set:
1. Let |well_known_accounts_url| be the result of [=computing the manifest URL=] with
|provider|, |wellKnown|.{{IdentityProviderWellKnown/accounts_endpoint}},
and |globalObject|.
1. Let |well_known_login_url| be the result of [=computing the manifest URL=] with |provider|,
|wellKnown|.{{IdentityProviderWellKnown/login_url}}, and |globalObject|.
1. If |well_known_accounts_url| is not [=url/equal=] to |accounts_url|, return failure.
1. If |well_known_login_url| is not [=url/equal=] to |login_url|, return failure.
1. Otherwise:
1. Let |allowed_config_url| be the result of [=computing the manifest URL=] with |provider|,
|wellKnown|.{{IdentityProviderWellKnown/provider_urls}}[0], and |globalObject|.
1. If |allowed_config_url| is not [=url/equal=] to |configUrl|, return failure.
1. Return |config|.
</div>
NOTE: a two-tier file system is used in order to prevent the [=IDP=] from easily determining the [=RP=]
that a user is visiting by encoding the information in the config file path. This issue is solved by
requiring a [=well-known file=] to be on the root of the [=IDP=]. The config file itself can be anywhere, but
it will not be used if the user agent does not find it in the [=well-known file=]. This allows the [=IDP=]
to keep their actual config files on an arbitary path while allowing the user agent to prevent config file
path manipulation to fingerprint (for instance, by including the RP in the path). See
[[#manifest-fingerprinting]].
<xmp class="idl">
dictionary IdentityProviderWellKnown {
sequence<USVString> provider_urls;
USVString accounts_endpoint;
USVString login_url;
};
dictionary IdentityProviderIcon {
required USVString url;
unsigned long size;
};
dictionary IdentityProviderBranding {
USVString background_color;
USVString color;
sequence<IdentityProviderIcon> icons;
USVString name;
};
dictionary IdentityProviderAPIConfig {
required USVString accounts_endpoint;
required USVString client_metadata_endpoint;
required USVString id_assertion_endpoint;
required USVString login_url;
USVString disconnect_endpoint;
IdentityProviderBranding branding;
USVString account_label;
};
</xmp>
<!-- ============================================================ -->
### Fetch the accounts ### {#fetch-accounts}
<!-- ============================================================ -->
The <a>fetch the accounts</a> algorithm fetches the […1 parent 2b9b7e7 commit 66c633eCopy full SHA for 66c633e
File tree
Expand file treeCollapse file tree
1 file changed
+3347
-0
lines changedFilter options
- .devcontainer
Expand file treeCollapse file tree
1 file changed
+3347
-0
lines changed
0 commit comments