RFC 8414: OAuth 2.0 Authorization Server Metadata | RFC Editor

Skip to content Primary navigationThe RFC SeriesFor AuthorsAbout UsHomeRFC 8414 View as: Plain Text, Compact HTML Info RFC 8414: OAuth 2.0 Authorization Server MetadataJSONJWTWebFingerJune 2018. M. Jones, N. Sakimura, J. BradleyProposed StandardSubscribe30 subscribed Add to Set Added to 2 Sets Read aloud Internet Engineering Task Force (IETF) M. Jones Request for Comments: 8414 Microsoft Category: Standards Track N. Sakimura ISSN: 2070-1721 NRI J. Bradley Yubico June 2018 OAuth 2.0 Authorization Server Metadata Abstract This specification defines a metadata format that an OAuth 2.0 client can use to obtain the information needed to interact with an OAuth 2.0 authorization server, including its endpoint locations and authorization server capabilities. Status of This Memo This is an Internet Standards Track document. This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 7841. Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at https://www.rfc-editor.org/info/rfc8414. Copyright Notice Copyright (c) 2018 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. Jones, et al. Standards Track [Page 1] RFC 8414 OAuth 2.0 Authorization Server Metadata June 2018 Table of Contents 1. Introduction ....................................................2 1.1. Requirements Notation and Conventions ......................3 1.2. Terminology ................................................3 2. Authorization Server Metadata ...................................4 2.1. Signed Authorization Server Metadata .......................8 3. Obtaining Authorization Server Metadata .........................8 3.1. Authorization Server Metadata Request ......................9 3.2. Authorization Server Metadata Response ....................10 3.3. Authorization Server Metadata Validation ..................11 4. String Operations ..............................................11 5. Compatibility Notes ............................................11 6. Security Considerations ........................................12 6.1. TLS Requirements ..........................................12 6.2. Impersonation Attacks .....................................12 6.3. Publishing Metadata in a Standard Format ..................13 6.4. Protected Resources .......................................13 7. IANA Considerations ............................................14 7.1. OAuth Authorization Server Metadata Registry ..............14 7.1.1. Registration Template ..............................15 7.1.2. Initial Registry Contents ..........................16 7.2. Updated Registration Instructions .........................19 7.3. Well-Known URI Registry ...................................19 7.3.1. Registry Contents ..................................19 8. References .....................................................20 8.1. Normative References ......................................20 8.2. Informative References ....................................22 Acknowledgements ..................................................23 Authors' Addresses ................................................23 1. Introduction This specification generalizes the metadata format defined by "OpenID Connect Discovery 1.0" [OpenID.Discovery] in a way that is compatible with OpenID Connect Discovery while being applicable to a wider set of OAuth 2.0 use cases. This is intentionally parallel to the way that "OAuth 2.0 Dynamic Client Registration Protocol" [RFC7591] generalized the dynamic client registration mechanisms defined by "OpenID Connect Dynamic Client Registration 1.0" [OpenID.Registration] in a way that is compatible with it. The metadata for an authorization server is retrieved from a well- known location as a JSON [RFC8259] document, which declares its endpoint locations and authorization server capabilities. This process is described in Section 3. Jones, et al. Standards Track [Page 2] RFC 8414 OAuth 2.0 Authorization Server Metadata June 2018 This metadata can be communicated either in a self-asserted fashion by the server origin via HTTPS or as a set of signed metadata values represented as claims in a JSON Web Token (JWT) [JWT]. In the JWT case, the issuer is vouching for the validity of the data about the authorization server. This is analogous to the role that the Software Statement plays in OAuth Dynamic Client Registration [RFC7591]. The means by which the client chooses an authorization server is out of scope. In some cases, its issuer identifier may be manually configured into the client. In other cases, it may be dynamically discovered, for instance, through the use of WebFinger [RFC7033], as described in Section 2 of "OpenID Connect Discovery 1.0" [OpenID.Discovery]. 1.1. Requirements Notation and Conventions 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 uses of JSON Web Signature (JWS) [JWS] and JSON Web Encryption (JWE) [JWE] data