| Internet-Draft | OAuth 2.0 Client Intermediary Metadata | February 2021 |
| Parecki | Expires 26 August 2021 | [Page] |
This specification defines a mechanism for including information about additional parties involved in an OAuth transaction by adding a new section to the OAuth 2.0 Dynamic Client Registration request, as well as requires that authorization servers surface this information to users during an OAuth transaction.¶
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 26 August 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. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.¶
In some applications of OAuth, there may be multiple legal entities which have access
to or process data retrieved by an OAuth client. In the traditional OAuth model,
a client_id represents only a single application, and so the OAuth consent screen
lists just one third party: the OAuth client.¶
In this situation, in order to comply with various local laws and regulations, the user needs to be informed by the authorization server of the list of entities that will have access to their data after authorizing the client.¶
The existing Dynamic Client Registration ([RFC7591]) specification lacks a mechanism for communicating a list of additional parties that may have access to the user's data.¶
This specification extends [RFC7591] and [RFC7592] to define a mechanism for including information about the additional parties involved in an OAuth transaction by including information about the additional intermediaries into the Dynamic Client Registration request. This specification also defines requirements of the OAuth authorization server to present this information about the additional parties in the OAuth consent screen during an OAuth transaction.¶
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 [RFC2119].¶
Unless otherwise noted, all the protocol parameter names and values are case sensitive.¶
In addition to the terms defined in referenced specifications, this document uses the following terms:¶
Registered client intermediaries have a set of metadata values associated with the client identifier of the client that represents them in the OAuth transaction, such as a user-visible name, logo, and URL.¶
Like the OAuth client metadata defined in [RFC7591] and [RFC7592], these metadata values are used in the following ways:¶
These values are used by the authorization server when displaying the OAuth consent screen to the end user, to inform them of all the additional parties that will be handling the user's data upon approval.¶
The following metadata fields are defined by this specification. The implementation and use of the fields is OPTIONAL unless stated otherwise. All data member types (strings, arrays, numbers) are defined in terms of their JSON ([RFC7159]) representations.¶
Some fields are expected to be displayed in the OAuth consent UI and are designated accordingly.¶
name¶
REQUIRED. A human-readable name of intermediary party. Authorization servers MUST display this field to the end user on the OAuth consent screen.¶
description¶
OPTIONAL. A human-readable description of the intermediary. This is not intended to be displayed in the OAuth consent screen.¶
uri¶
A URL string of a web page providing information about the intermediary. If present, the authorization server SHOULD display this URL to the end user in a clickable fashion. It is RECOMMENDED that clients always send this field. The value of this field MUST point to a valid web page.¶
logo_uri¶
A URL string that references a logo for this intermediary. If present, the authorization server SHOULD display this image to the end user in the OAuth consent screen. The value of this field MUST be a valid image file.¶
contacts¶
Array of strings representing ways to contact people responsible for this intermediary, typically email addresses or phone numbers. The authorization server MAY display these to the end user in the OAuth consent screen. See Section 6 of [RFC7591] for information on Privacy Considerations.¶
The client registration endpoint is described in Section 3 of [RFC7591].¶
Since this specification provides a mechanism for a client to assert information about additional parties other than itself, the registration endpoint MUST be protected by an OAuth 2.0 access token obtained by the client. The method by which the initial access token is obtained by the client or developer is out of scope of this specification, but is likely to be obtained using the client credentials grant or manual out-of-band registration.¶
This specification extends the client registration request defined in [RFC7591].¶
This operation registers a combination of client and one or more intermediaries with an authorization server. The authorization server assigns a unique client identifier (and optionally a client secret) that represents the combination of all the entities described in the registration request.¶
To register, the client or developer sends an HTTP POST as described in Section 3.1 of [RFC7591], with an additional property named "intermediaries" with a JSON array of objects of each intermediary's registration information. The properties of the object are described above in Section 4.¶
For example, the client could send the following registration request to the client registration endpoint using its OAuth 2.0 access token it has previously obtained using the client credentials grant.¶
The following is a non-normative example request:¶
POST /register HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: server.example.com
Authorization: Bearer 8IGFGXKXZBV5LL38Y3X1
{
"client_name": "User-Recognizable App Name",
"redirect_uris": [
"https://client.example.org/callback"
],
"client_uri": "https://example.net/",
"logo_uri": "https://example.net/logo.png",
"contacts": [
"support@example.net"
],
"intermediaries": [
{
"name": "Partner App Name",
"description": "An application that may also receive
this user's data when the user authorizes the client",
"uri": "https://partner.example/",
"logo_uri": "https://partner.example/logo.png",
"contacts": [
"support@partner.example"
]
}
]
}
¶
This specification extends the client information response defined in [RFC7591] and [RFC7592].¶
Upon a successful registration request, the authorization server returns a client identifier for the combination of the client and any intermediaries specified in the request.¶
In addition to the response fields defined in Section 3.2 of [RFC7591] and Section 3 of [RFC7592], the response MUST also contain all registered metadata about the intermediaries. The authorization server MAY reject or replace any of the requested metadata values submitted during the registration and substitute them with suitable values.¶
The following is a non-normative example response of a successful registration:¶
HTTP/1.1 201 Created
Content-Type: application/json
Cache-Control: no-store
Pragma: no-cache
{
"client_id": "V8tvEkZWhDAdxSaKGUJZ",
"client_secret": "SpsuwZIxnp8bBEhp5sk1EKiIKTZ4X4DKU",
"grant_types": ["authorization_code", "refresh_token"],
"token_endpoint_auth_method": "client_secret_basic",
"registration_client_uri": "https://server.example.com/client/tmzaAMkyWlH3",
"registration_access_token": "MphaAqDaZT86C93ENWRZcf3dfU2dW6POASo8dFXa",
"client_name": "User-Recognizable App Name",
"client_uri": "https://example.net/",
"redirect_uris": [
"https://client.example.org/callback"
],
"contacts": [
"support@example.net"
],
"intermediaries": [
{
"name": "Partner App Name",
"description": "An application that may also receive
this user's data when the user authorizes the client",
"uri": "https://partner.example/",
"logo_uri": "https://partner.example/logo.png",
"contacts": [
"support@partner.example"
]
}
]
}
¶
The registration_client_uri and registration_access_token properties are required in order to support updating and deleting this client as described in [RFC7592].¶
This specification extends the client read request defined in [RFC7592] to include the additional metadata properties in the response that describe the intermediaries. No additional behavior is prescribed by this specification.¶
This specification extends the client update request defined in [RFC7592] to be able to update the additional metadata properties that describe the intermediaries.¶
The additional properties are provided in the update request in the same format as in the initial registration request.¶
Since these values were asserted by the client in the initial registration, there is no need to prescribe any additional security model around the ability to update them, even though these represent additional parties.¶
No new behavior is prescribed for delete requests beyond that defined in [RFC7592].¶
As this extends [RFC7591], all security considerations from that draft apply here as well.¶
Specifically, if the authorization server supports open client registration without any authentication, it must be extremely careful with any URLs received in the registration request such as logo_uri, tos_uri, and uri, as these values may be displayed to end users. [RFC7591] recommends requiring that these URIs have a matching host and scheme as the defined redirect_uris, and that they are resolvable URIs. See section 5 of [RFC7591] for more details.¶
The author would like to thank Ryan Christiansen and Preston McFarland for their initial contributions of the concepts behind this specification. The author would also like to thank Don Cardinal, Ryan Christiansen and Preston McFarland for their reviews of this specification, as well as Anil Mahalaha and other members of the Financial Data Exchange working group. Additionally the work of the OAuth Working Group on the referenced and related specifications that this specification builds upon is much appreciated.¶