Internet-Draft | Assisted Token | March 2021 |
Ideskog & Spencer | Expires 10 September 2021 | [Page] |
This document extends the OAuth 2.0 framework to include an additional authorization flow for single page applications called the assisted token flow. It enables OAuth clients written in scripting languages, like JavaScript, to request user authorization using a simplified method compared to other flows. Communication does not rely on redirection of the user agent, but instead leverages HTML's iframe element, child windows, and the postMessage interface. This communication is done using an additional endpoint, the assisted token endpoint.¶
To contribute to this draft, please feel free to create a pull request from the original source available at https://github.com/curityio/rfc or email the authors.¶
This note is to be removed before publishing as an RFC.¶
This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶
Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/.¶
Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress."¶
This Internet-Draft will expire on 10 September 2021.¶
Copyright (c) 2021 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document.¶
The OAuth 2.0 protocol flow for Single-page Applications (SPA) defined in this memo, often referred to as the assisted token flow, provides clients written in scripting languages, like JavaScript, with a simplified integration (compared to the implicit or authorization code flow) and ensures that end users are not redirected away from the current page in order to obtain authorization from the resource owner. The communication between the client and the authorization server takes place within an HTML iframe element or child window that is only displayed when interactive user interaction is required; this is the case when authentication and/or authorization are necessary. To communicate the result from this iframe or child window to the client application, HTML's postMessage interface is used instead of the redirection endpoint defined in Section 3.1.2 of [RFC6749]. This difference is important for many SPAs which take time to reload and may not be able to recreate the same state prior to the user being redirected to the authorization server.¶
Another goal of the assisted token flow is to simplify integration of the client with the authorization server. Though [RFC6749] resulted in a much simpler integration for client applications compared to its predecessor, [RFC5849], developers still struggle with the many inputs required to perform the various OAuth flows. For this reason, the assisted token flow introduces a new endpoint called the assisted token endpoint rather than extending and reusing the token endpoint defined in Section 3.2 of [RFC6749]. As a result, client developers do not need to specify a response_type parameter in the authorization request. This coupled with the use of HTML's postMessage interface for communication between the client and the authorization server means that the redirect_uri and state parameters are also unnecessary. Consequently, client developers only need to provide a client_id, create a dynamic iframe or open a child window, and handle the postMessage that is fired by the authorization server in order to implement OAuth.¶
This interaction is shown in Figure 1.¶
The assisted token flow illustrated in Figure 1 includes the following steps:¶
If the resource owner has not authenticated or has not authorized the client, then interaction between the resource owner and the authorization server is required to obtain these. In such a case, the HTML in step (C) of Figure 1 will include an error indicating that user involvement is required. This will be handled by the client in step (D) and login and/or consent will commence. This process is illustrated in Figure 2.¶
The flow shown in Figure 2 includes the following steps:¶
visible
iframe or pops open a child window after
receiving an indication from the authorization server that user interaction is required. As in
the previous flow, the src attribute value of this iframe or the input to the open method of
the user agents's window object is the URL of the authorization server's assisted token
endpoint.¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
All other terms used in this document are as defined in [RFC6749]. Unless otherwise noted, all the protocol parameter names and values are case sensitive.¶
The means through which the client obtains the location of the assisted token endpoint is either by using the authorization server's metadata as set forth in Section 6, the service documentation, or some other method that is beyond the scope of this specification.¶
The endpoint URI MAY include an application/x-www-form-urlencoded
formatted (per
Appendix B of [RFC6749]) query component (see Section 3.4 of [RFC3986]), which
MUST be
retained when adding additional query parameters. The endpoint URI MUST NOT include a fragment
component.¶
Since requests to the assisted token endpoint result in the transmission of clear-text credentials (in the HTTP request and response), the authorization server MUST require the use of TLS as described in Section 1.6 of [RFC6749] when sending requests to the assisted token endpoint.¶
The client MUST use the HTTP GET
method when making access token requests to this endpoint.¶
Parameters sent without a value MAY be treated as if they were omitted from the request. The authorization server MUST ignore unrecognized request parameters. Request and response parameters MUST NOT be included more than once.¶
After completing its interaction with the resource owner, the authorization server will fire an event
using the HTML postMessage interface. This message MUST NOT be posted to all origins, denoted by
*
. Instead, the authorization server MUST post this message only to the client's allowed origin(s)
previously established with the authorization server during the client registration process.¶
Like the authorization and token endpoints, the assisted token endpoint allows the client to
specify the scope of the access request using the scope
request parameter. In turn, the
authorization server uses the scope
response parameter to inform the client of the scope of
the access token issued. Unlike the typical behavior of those endpoints, however, access tokens
issued by the authorization server using the assisted token endpoint MUST use the client's
pre-configured scope or the authorization server's pre-defined default if none have been configured
for the client.¶
If the client did not include a scope
request parameter or if the issued access token scope is
different from the one requested by the client, the authorization server MUST include the
scope
response parameter to inform the client of the actual scope granted. Even when the scope of the
issued access token is the same as the one requested by the client, the authorization server
SHOULD
include the scope
response parameter.¶
The format, constraints, and grammar of the scope parameter value is as defined in Section 3.3 of [RFC6749].¶
The authorization server SHOULD NOT return an error if a scope has not been pre-configured for the client; only if the authorization server does not have a pre-defined default scope.¶
The assisted token endpoint MAY support CORS as defined in [W3C.WD-cors-20120403].¶
The assisted token request is an HTTP GET request constructed by the client with the following parameters provided on the query string:¶
X-Frame-Options
(as defined in [RFC7034]). See
Section 8.1 for details.¶
OPTIONAL. Space delimited, case sensitive list of [ASCII] string values that can be used to determine the login state of the resource owner at the authorization server. The defined values are:¶
Other values may be provided in this list; the authorization server MUST ignore them without producing an error if it cannot understand them.¶
The response from the assisted token endpoint is an HTML document that executes a script which invokes the HTML postMessage interface to send a message to either the parent window (in the case shown in Figure 1) or the opener. The origin that this event is posted to is that of the client. The contents of this message is a JSON object with the following fields:¶
This JSON object MAY contain additional fields. If the client does not understand or recognize such additional fields, it MUST ignore them.¶
As with a successful response, an error is returned to the client using an the HTML postMessage interface. Such an error is returned whenever the resource owner denies the access request or whenever the request fails for reasons other than the origin of the client being disallowed to frame the assisted token endpoint. The error message includes a JSON object with the following fields:¶
REQUIRED. A single [ASCII] error code from the following:¶
Values for the error
parameter MUST NOT include characters outside the set %x20-21 /
%x23-5B / %x5D-7E.¶
error_description
parameter MUST NOT include characters outside the set
%x20-21 / %x23-5B / %x5D-7E.¶
error_uri
parameter MUST conform to the URI-reference syntax and thus
MUST NOT
include characters outside the set %x21 / %x23-5B / %x5D-7E.¶
The authorization server MAY allow dynamic clients to request the use of the assisted token flow when
registering. Such a client may indicate that it will interact with the authorization server using the
assisted token flow by including the string element
urn:ietf:params:oauth:grant-type:assisted_token
in the array associated with the
grant_types
metadata field sent to the client registration endpoint (as defined in
Section 3 of [RFC7591]). If the authorization server allows the client to register with this grant
type, the grant_types
included in the response MUST include the value
urn:ietf:params:oauth:grant-type:assisted_token
. The inclusion of this value in the
grant_types
field is done despite the fact that the client will not use this grant type at the token endpoint but
rather the assisted token endpoint (see Section 3).¶
If dynamic clients are allowed to register themselves with the authorization server, then additional verification of the origins include in the request MUST be performed in some manner. The way in which this is accomplished by the authorization server is not defined by this specification. Because this additional verification is required and because clients using the assisted token flow are typically ephemeral in nature, it is NOT RECOMMENDED that the authorization server support dynamic client registration of the urn:ietf:params:oauth:grant-type:assisted_token
grant type.¶
The following client metadata field is defined by this specification. It MAY be included in a registration request, as set forth in Section 2 of [RFC7591].¶
This specification registers the following values in the IANA "OAuth URI" registry [IANA.OAuth.Parameters] established by [RFC6755].¶
This specification registers the following values in the IANA "OAuth Parameter" registry [IANA.OAuth.Parameters] established by [RFC6749].¶
This specification registers the following values in the IANA "OAuth 2.0 Authorization Server Metadata" registry [IANA.OAuth.Parameters] established by [RFC8414].¶
In addition to all the security considerations discussed in [RFC6819], the following security considerations SHOULD be taken into account.¶
Due to the use of an iframe to host the assisted token endpoint, the authorization server MUST take precautions to ensure that only trusted origins are allowed to frame it. The authorization server MUST prevent any origin from framing the assisted token endpoint except ones deemed trustworthy. This attestation may come byway of explicit administrative action or automated techniques available to the authorization server. Additional care is REQUIRED if dynamic client registration is supported or clients may be registered in a self-service manner.¶
One such mechanism that MAY be deployed is Content Security Policy [CSP-2]. This
protocol SHOULD be used on the assisted token endpoint (and, if applicable, other endpoints used to
authenticated the user in a specific deployment) to prevent framing from unauthorized origins. Using
CSP allows the authorization server to specify multiple origins in a single response header field
and to constrain these using flexible patterns (see [CSP-2] for details). This
standard provides a robust mechanism for protecting against click-jacking by using policies
that restrict the origin of frames (using frame-ancestors
) together with those that restrict the sources of scripts allowed to execute on an HTML page (by using
script-src
). A non-normative example of such a policy is shown in the following listing:¶
Because some user agents do not support [CSP-2], this technique SHOULD be combined with
others. In particular, the authorization server SHOULD return an X-Frame-Options
response header
on the assisted token endpoint (and, if applicable, other endpoints used to authenticate the user and authorize the client
in a specific deployment). As defined in [RFC7034], this header will cause user
agents that support it (but not CSP) to block framing from any origin that is not
specified in this header's value. Because this header's value can only include one origin, the
framer is RECOMMENDED to use the for_origin
parameter (as specified in
Section 4.1) with its own origin as the value.¶
Some user agents do not support [RFC7034] nor [CSP-2]. Therefore, the authorization server SHOULD include a frame-busting script like that shown in Figure 7 of [FRAME-BUSTING]. Such a script would use JavaScript to break out of any unauthorized origin that is framing the assisted token endpoint. The authorization server MAY simply break out of all frames in case [RFC7034] and [CSP-2] are unsupported by the user agent, though this would render the assisted token flow non-functional. The choice of whether or not this drastic countermeasure should be employed depends on the user agents being targeted in a certain deployment.¶
When the authorization server and client are provided by separate parties, it is important that the resource owner is able to distinguish the two. One safe way of doing so is by examination of the user agent's address bar by the resource owner where the validity of the certificate and location can be verified. In such situations, whenever user interaction is required, the client MUST open the assisted token endpoint in a new browser window rather than a hidden iframe. The authorization server MUST take measures deemed appropriate in a deployment to ensure that the client has not framed the user's manual interaction; however, the necessity for interactive user authentication and/or consent SHOULD be possible for the client to determine in a hidden iframe.¶
[WebAuthn] MAY be used to ensure that the user is authenticated to the authorization server in a safe manner. This protocol offers authentication processes that are resistant to man-in-the-middle attacks. The API defined by this standard can be used to verify that user authentication is performed at the expected origin. This is superior to manual verification of the origin in the address bar of the browser by the resource owner. It also provides a mechanism to restrict the client framing the assisted token endpoint to be in the same origin. When it is not, the use of [WebAuthn] will force the client to use a separate window for user authentication.¶
Because the client applications that use the assisted token flow are written in scripting languages like JavaScript and are hosted in Web pages, users may keep such applications open in their user agents for a prolonged period of time. During such period, the token issued to the client may expire or be revoked. To ensure that such expired tokens left remnant in the user agent are benign, a Handle Token SHOULD always be issued by the assisted token endpoint. This ensures that no identity data is exposed (even when the token is not yet expired) and that a revoked token does not increase risks.¶
As admitted in Section 8 of [RFC6454], preventing exfiltration of cookies, tokens, and other such credentials in web browsers has historically proven difficult to implement. Instead, the same-origin policy has emerged as the cornerstone of security for such user agents. Using this security model, it is not possible to prevent access to a token issued to a client if that client includes nefarious scripts from untrustworthy sources that have access to the Document Object Model (DOM) where the token is stored. For this reason, the authorization server MUST warn client application developers who interact with the assisted token endpoint not to use untrusted scripts in their applications. This warning SHOULD at least be conveyed through the documentation but MAY also be provided through other mechanisms.¶
Most client applications that use the assisted token flow will maintain the access token issued by the authorization server in a persisted state; this will commonly be an HTTP cookie or local storage. This is necessary, for instance, to create a pleasing user experience when a user navigates away from the application in their web browser and then returns. To ensure that the token is stored safely, the authorization server MAY provide application developers with guidance in the accompanying documentation on how to safely persist tokens. The authorization server MAY also provide script libraries that perform this action according to best common practices. The authorization server MAY also store the token in an HTTP cookie in its own DNS domain (rather than that of the client) using the assisted token endpoint's path. In some cases, this would elevate any storage requirements from the client application developer. Besides simplifying the programming model for developers, this technique allows the authorization server to check the validity of the token and determine if the token has expired or if the associated grant has been revoked in subsequent requests to the assisted token endpoint; this will be possible because the requests might include the token in the HTTP Cookie request header. In such cases, the authorization server can take the appropriate action, such as authenticating the user anew or request consent, before issuing a new token. If the token is stored by the application, however, this kind of verification cannot be performed by the authorization server without an explicit request to validate a stored token.¶
In some deployments, the assisted token endpoint may be served from a distinct domain from that of the client. In such cases, the client will be a third-party domain, and the resource owner's user agent may prevent the authorization server from storing any third-party cookies. If the authorization server requires state to be persisted when performing the assisted token flow, it SHOULD provide a privacy-preserving mechanism to store and retrieve its state even when the assisted token endpoint is hosted on a distinct domain from that of the client. The technical details of how to accomplish this are implementation specific, and are beyond the scope of this specification. If the authorization server does not support clients that are hosted from a third-party domain, it MUST indicate this to the client through some mechanism (e.g., its associated documentation).¶
The following individuals contributed ideas, feedback, and wording to this specification:¶
Mark Dobrinic, Karl McGuinness, Renato Athaydes, Daniel Lindau, Louis Jannett¶
[[ to be removed by the RFC editor before publication as an RFC ]]¶
This section is to be removed before publishing as an RFC.¶
-05¶
-04¶
-03¶
-02¶
-01¶
-00¶