OAuth 2.0 Protected Resource Metadata

Abstract

概要

This specification defines a metadata format that an OAuth 2.0 client or authorization server can use to obtain the information needed to interact with an OAuth 2.0 protected resource.

本仕様は、OAuth 2.0 クライアントまたは認可サーバーが OAuth 2.0 保護リソースとやり取りするために必要な情報を取得するのに使えるメタデータ形式を定義する。

1.Introduction

1.はじめに

This specification defines a metadata format enabling OAuth 2.0 clients and authorization servers to obtain information needed to interact with an OAuth 2.0 protected resource. The structure and content of this specification are intentionally as parallel as possible to (1) "OAuth 2.0 Dynamic Client Registration Protocol" [RFC7591], which enables a client to provide metadata about itself to an OAuth 2.0 authorization server and (2) "OAuth 2.0 Authorization Server Metadata" [RFC8414], which enables a client to obtain metadata about an OAuth 2.0 authorization server.

本仕様は、OAuth 2.0 クライアントおよび認可サーバーが OAuth 2.0 保護リソースとやり取りするために必要な情報を取得できるようにするメタデータ形式を定義する。本仕様の構成と内容は、意図的に次の 2 つと可能な限り並行するようにしている。(1) クライアントが自身に関するメタデータを OAuth 2.0 認可サーバーに提供できるようにする「OAuth 2.0 Dynamic Client Registration Protocol」[RFC7591]、および (2) クライアントが OAuth 2.0 認可サーバーに関するメタデータを取得できるようにする「OAuth 2.0 Authorization Server Metadata」[RFC8414] である。

The means by which the client obtains the location of the protected resource is out of scope for this document. In some cases, the location may be manually configured into the client; for example, an email client could provide an interface for a user to enter the URL of their JSON Meta Application Protocol (JMAP) server [RFC8620]. In other cases, it may be dynamically discovered; for example, a user could enter their email address into an email client, the client could perform WebFinger discovery [RFC7033] (in a manner related to the description in Section 2 of [OpenID.Discovery]) to find the resource server, and the client could then fetch the resource server metadata to find the authorization server to use to obtain authorization to access the user's email.

クライアントが保護リソースの場所を取得する手段は本文書の範囲外である。場合によっては、その場所がクライアントに手動で設定されることがある。たとえば、電子メールクライアントが、ユーザーが自分の JSON Meta Application Protocol (JMAP) サーバー [RFC8620] の URL を入力するインターフェースを提供することが考えられる。別の場合には、動的に発見されることがある。たとえば、ユーザーが電子メールクライアントに自分の電子メールアドレスを入力し、クライアントが WebFinger による発見 [RFC7033] を ([OpenID.Discovery] の 2 節の記述に関連する方法で) 実行してリソースサーバーを見つけ、その後クライアントがリソースサーバーのメタデータを取得して、ユーザーの電子メールへのアクセス認可を得るために使う認可サーバーを見つける、という流れである。

The metadata for a protected resource is retrieved from a well-known location as a JSON [RFC8259] document, which declares information about its capabilities and, optionally, its relationships with other services. This process is described in Section 3.

保護リソースのメタデータは、well-known な場所から JSON [RFC8259] 文書として取得される。この文書は、その能力に関する情報と、任意で他のサービスとの関係を宣言する。この手順は 3 節で説明する。

This metadata can be communicated either in a self-asserted fashion 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 protected resource. This is analogous to the role that the software statement plays in OAuth Dynamic Client Registration [RFC7591].

このメタデータは、自己主張 (self-asserted) の形で伝えることも、JSON Web Token (JWT) [JWT] 内のクレームとして表現された署名付きメタデータ値の集合として伝えることもできる。JWT の場合、発行者が保護リソースに関するデータの正当性を保証する。これは、OAuth Dynamic Client Registration [RFC7591] においてソフトウェアステートメントが果たす役割に類似している。

Each protected resource publishing metadata about itself makes its own metadata document available at a well-known location deterministically derived from the protected resource's URL, even when the resource server implements multiple protected resources. This prevents attackers from publishing metadata that supposedly describes the protected resource but that is not actually authoritative for the protected resource, as described in Section 7.3.

自身に関するメタデータを公開する各保護リソースは、リソースサーバーが複数の保護リソースを実装している場合であっても、保護リソースの URL から決定論的に導出される well-known な場所で自身のメタデータ文書を利用可能にする。これにより、7.3 節で説明するように、攻撃者が保護リソースを記述していると称しながら実際にはその保護リソースに対して権威を持たないメタデータを公開することを防ぐ。

Section 2 defines metadata parameters that a protected resource can publish, which includes things like which scopes are supported, how a client can present an access token, and more. These values, such as the jwks_uri (see Section 2), may be used with other specifications; for example, the public keys published in the jwks_uri can be used to verify the signed resource responses, as described in [FAPI.MessageSigning].

2 節では、保護リソースが公開できるメタデータパラメーターを定義する。これには、どのスコープがサポートされているか、クライアントがどのようにアクセストークンを提示できるか、などが含まれる。jwks_uri (2 節参照) のようなこれらの値は他の仕様とともに使われることがある。たとえば、jwks_uri で公開された公開鍵は、[FAPI.MessageSigning] で説明されているように、署名付きリソースレスポンスの検証に使える。

Section 5 describes the use of WWW-Authenticate by protected resources to dynamically inform clients of the URL of their protected resource metadata. This use of WWW-Authenticate can indicate that the protected resource metadata may have changed.

5 節では、保護リソースが WWW-Authenticate を使ってクライアントに自身の保護リソースメタデータの URL を動的に知らせる方法を説明する。この WWW-Authenticate の利用は、保護リソースメタデータが変更された可能性があることを示すこともできる。

1.1.Requirements Notation and Conventions

1.1.要件表記と規約

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.

本文書中のキーワード "MUST"、"MUST NOT"、"REQUIRED"、"SHALL"、"SHALL NOT"、"SHOULD"、"SHOULD NOT"、"RECOMMENDED"、"NOT RECOMMENDED"、"MAY"、および "OPTIONAL" は、ここに示すようにすべて大文字で現れる場合に限り、BCP 14 [RFC2119] [RFC8174] の記述に従って解釈される。

All applications of JSON Web Signature (JWS) data structures [JWS] and JSON Web Encryption (JWE) data structures [JWE] as discussed in this specification utilize the JWS Compact Serialization or the JWE Compact Serialization; the JWS JSON Serialization and the JWE JSON Serialization are not used. Choosing a single serialization is intended to facilitate interoperability.

本仕様で論じる JSON Web Signature (JWS) データ構造 [JWS] および JSON Web Encryption (JWE) データ構造 [JWE] のすべての適用では、JWS Compact Serialization または JWE Compact Serialization を利用する。JWS JSON Serialization および JWE JSON Serialization は使用しない。単一のシリアライゼーションを選ぶのは、相互運用性を促進するためである。

1.2.Terminology

1.2.用語

This specification uses the terms "access token", "authorization code", "authorization server", "client", "client authentication", "client identifier", "protected resource", and "resource server" defined by OAuth 2.0 [RFC6749], and the terms "Claim Name" and "JSON Web Token (JWT)" defined by "JSON Web Token (JWT)" [JWT].

本仕様は、OAuth 2.0 [RFC6749] で定義される「アクセストークン」「認可コード」「認可サーバー」「クライアント」「クライアント認証」「クライアント識別子」「保護リソース」「リソースサーバー」の各用語と、「JSON Web Token (JWT)」[JWT] で定義される「Claim Name」および「JSON Web Token (JWT)」の用語を使用する。

This specification defines the following term:

本仕様は次の用語を定義する。

Resource Identifier: The protected resource's resource identifier, which is a URL that uses the https scheme and has no fragment component. As specified in Section 2 of [RFC8707], it also SHOULD NOT include a query component, but it is recognized that there are cases that make a query component a useful and necessary part of a resource identifier. Protected resource metadata is published at a .well- known location [RFC8615] derived from this resource identifier, as described in Section 3.

リソース識別子 (Resource Identifier): 保護リソースのリソース識別子であり、https スキームを使用しフラグメント構成要素を持たない URL である。[RFC8707] の 2 節で規定されているとおり、クエリ構成要素も含めるべきではない (SHOULD NOT) が、クエリ構成要素がリソース識別子の有用かつ必要な一部となる場合があることは認識されている。保護リソースメタデータは、3 節で説明するように、このリソース識別子から導出される .well-known の場所 [RFC8615] で公開される。

2.Protected Resource Metadata

2.保護リソースメタデータ

Protected resources can have metadata describing their configuration. The following protected resource metadata parameters are used by this specification and are registered in the "OAuth Protected Resource Metadata" registry established in Section 8.1:

保護リソースは、その構成を記述するメタデータを持つことができる。次の保護リソースメタデータパラメーターが本仕様で使用され、8.1 節で設立する「OAuth Protected Resource Metadata」レジストリに登録される。

resource REQUIRED. The protected resource's resource identifier, as defined in Section 1.2.

resource REQUIRED。1.2 節で定義される、保護リソースのリソース識別子。

authorization_servers OPTIONAL. JSON array containing a list of OAuth authorization server issuer identifiers, as defined in [RFC8414], for authorization servers that can be used with this protected resource. Protected resources MAY choose not to advertise some supported authorization servers even when this parameter is used. In some use cases, the set of authorization servers will not be enumerable, in which case this metadata parameter would not be used.

authorization_servers OPTIONAL。この保護リソースとともに使用できる認可サーバーについて、[RFC8414] で定義される OAuth 認可サーバー発行者識別子のリストを含む JSON 配列。保護リソースは、このパラメーターを使用する場合でも、サポートする認可サーバーの一部を公表しないことを選んでもよい (MAY)。ユースケースによっては認可サーバーの集合が列挙可能でないことがあり、その場合このメタデータパラメーターは使用されない。

jwks_uri OPTIONAL. URL of the protected resource's JSON Web Key (JWK) Set [JWK] document. This contains public keys belonging to the protected resource, such as signing key(s) that the resource server uses to sign resource responses. This URL MUST use the https scheme. When both signing and encryption keys are made available, a use (public key use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage.

jwks_uri OPTIONAL。保護リソースの JSON Web Key (JWK) Set [JWK] 文書の URL。これには、リソースサーバーがリソースレスポンスに署名するために使う署名鍵など、保護リソースに属する公開鍵が含まれる。この URL は https スキームを使用しなければならない (MUST)。署名鍵と暗号化鍵の両方が提供される場合、参照される JWK Set 内のすべての鍵について、各鍵の用途を示すための use (public key use) パラメーター値が必須である (REQUIRED)。

scopes_supported RECOMMENDED. JSON array containing a list of scope values, as defined in OAuth 2.0 [RFC6749], that are used in authorization requests to request access to this protected resource. Protected resources MAY choose not to advertise some scope values supported even when this parameter is used.

scopes_supported RECOMMENDED。この保護リソースへのアクセスを要求する認可リクエストで使用される、OAuth 2.0 [RFC6749] で定義されるスコープ値のリストを含む JSON 配列。保護リソースは、このパラメーターを使用する場合でも、サポートするスコープ値の一部を公表しないことを選んでもよい (MAY)。

bearer_methods_supported OPTIONAL. JSON array containing a list of the supported methods of sending an OAuth 2.0 bearer token [RFC6750] to the protected resource. Defined values are ["header", "body", "query"], corresponding to Sections 2.1, 2.2, and 2.3 of [RFC6750]. The empty array [] can be used to indicate that no bearer methods are supported. If this entry is omitted, no default bearer methods supported are implied, nor does its absence indicate that they are not supported.

bearer_methods_supported OPTIONAL。OAuth 2.0 ベアラートークン [RFC6750] を保護リソースへ送信する方法のうちサポートされるもののリストを含む JSON 配列。定義されている値は ["header", "body", "query"] であり、それぞれ [RFC6750] の 2.1 節、2.2 節、2.3 節に対応する。空配列 [] を使って、ベアラー方式を一切サポートしないことを示すことができる。この項目が省略された場合、既定でサポートされるベアラー方式が暗黙に示されることはなく、また、その不在がサポートされないことを示すわけでもない。

resource_signing_alg_values_supported OPTIONAL. JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the protected resource for signing resource responses, for instance, as described in [FAPI.MessageSigning]. No default algorithms are implied if this entry is omitted. The value none MUST NOT be used.

resource_signing_alg_values_supported OPTIONAL。たとえば [FAPI.MessageSigning] で説明されているような、リソースレスポンスへの署名のために保護リソースがサポートする JWS [JWS] 署名アルゴリズム (alg 値) [JWA] のリストを含む JSON 配列。この項目が省略された場合、既定のアルゴリズムが暗黙に示されることはない。値 none を使用してはならない (MUST NOT)。

resource_name Human-readable name of the protected resource intended for display to the end user. It is RECOMMENDED that protected resource metadata include this field. The value of this field MAY be internationalized, as described in Section 2.1.

resource_name エンドユーザーへの表示を意図した、人間が読める保護リソースの名前。保護リソースメタデータにこのフィールドを含めることが推奨される (RECOMMENDED)。このフィールドの値は、2.1 節で説明するように国際化してもよい (MAY)。

resource_documentation OPTIONAL. URL of a page containing human-readable information that developers might want or need to know when using the protected resource. The value of this field MAY be internationalized, as described in Section 2.1.

resource_documentation OPTIONAL。保護リソースを使用する際に開発者が知りたい、または知る必要がある、人間が読める情報を含むページの URL。このフィールドの値は、2.1 節で説明するように国際化してもよい (MAY)。

resource_policy_uri OPTIONAL. URL of a page containing human-readable information about the protected resource's requirements on how the client can use the data provided by the protected resource. The value of this field MAY be internationalized, as described in Section 2.1.

resource_policy_uri OPTIONAL。保護リソースが提供するデータをクライアントがどのように使用できるかに関する保護リソースの要件について、人間が読める情報を含むページの URL。このフィールドの値は、2.1 節で説明するように国際化してもよい (MAY)。

resource_tos_uri OPTIONAL. URL of a page containing human-readable information about the protected resource's terms of service. The value of this field MAY be internationalized, as described in Section 2.1.

resource_tos_uri OPTIONAL。保護リソースの利用規約について、人間が読める情報を含むページの URL。このフィールドの値は、2.1 節で説明するように国際化してもよい (MAY)。

tls_client_certificate_bound_access_tokens OPTIONAL. Boolean value indicating protected resource support for mutual-TLS client certificate-bound access tokens [RFC8705]. If omitted, the default value is false.

tls_client_certificate_bound_access_tokens OPTIONAL。相互 TLS クライアント証明書バウンドアクセストークン [RFC8705] の保護リソースによるサポートを示す真偽値。省略された場合、既定値は false である。

authorization_details_types_supported OPTIONAL. JSON array containing a list of the authorization details type values supported by the resource server when the authorization_details request parameter [RFC9396] is used.

authorization_details_types_supported OPTIONAL。authorization_details リクエストパラメーター [RFC9396] が使用される場合にリソースサーバーがサポートする authorization details の type 値のリストを含む JSON 配列。

dpop_signing_alg_values_supported OPTIONAL. JSON array containing a list of the JWS alg values (from the "JSON Web Signature and Encryption Algorithms" registry [IANA.JOSE]) supported by the resource server for validating Demonstrating Proof of Possession (DPoP) proof JWTs [RFC9449].

dpop_signing_alg_values_supported OPTIONAL。Demonstrating Proof of Possession (DPoP) プルーフ JWT [RFC9449] を検証するためにリソースサーバーがサポートする JWS alg 値 (「JSON Web Signature and Encryption Algorithms」レジストリ [IANA.JOSE] に由来) のリストを含む JSON 配列。

dpop_bound_access_tokens_required OPTIONAL. Boolean value specifying whether the protected resource always requires the use of DPoP-bound access tokens [RFC9449]. If omitted, the default value is false.

dpop_bound_access_tokens_required OPTIONAL。保護リソースが常に DPoP バウンドアクセストークン [RFC9449] の使用を要求するかどうかを指定する真偽値。省略された場合、既定値は false である。

Additional protected resource metadata parameters MAY also be used.

追加の保護リソースメタデータパラメーターを使用してもよい (MAY)。

2.1.Human-Readable Resource Metadata

2.1.人間が読めるリソースメタデータ

Human-readable resource metadata values and resource metadata values that reference human-readable content MAY be represented in multiple languages and scripts. For example, the values of fields such as resource_name, resource_documentation, resource_tos_uri, and resource_policy_uri might have multiple locale-specific metadata values to facilitate use in different locations.

人間が読めるリソースメタデータ値、および人間が読めるコンテンツを参照するリソースメタデータ値は、複数の言語および文字体系で表現してもよい (MAY)。たとえば、resource_name、resource_documentation、resource_tos_uri、resource_policy_uri などのフィールドの値は、異なる地域での使用を容易にするため、複数のロケール固有のメタデータ値を持つことがある。

To specify the languages and scripts, language tags [BCP47] are added to resource metadata parameter names, delimited by a # character. Since member names as discussed in JSON [RFC8259] are case sensitive, it is RECOMMENDED that language tag values used in Claim Names be spelled using the character case with which they are registered in the "Language Subtag Registry" [IANA.Language]. In particular, normally, language names are spelled with lowercase characters, region names are spelled with uppercase characters, and languages are spelled with mixed-case characters. However, since language tag values are case insensitive per [BCP47], implementations SHOULD interpret the language tag values supplied in a case-insensitive manner. Per the recommendations in [BCP47], language tag values used in metadata parameter names should only be as specific as is necessary. For instance, using fr might be sufficient in many contexts, rather than fr-CA or fr-FR.

言語と文字体系を指定するために、言語タグ [BCP47] を # 文字で区切ってリソースメタデータパラメーター名に追加する。JSON [RFC8259] で論じられるメンバー名は大文字小文字を区別するため、Claim Name で使用する言語タグ値は「Language Subtag Registry」[IANA.Language] に登録されている大文字小文字どおりに綴ることが推奨される (RECOMMENDED)。特に、通常、言語名は小文字で、地域名は大文字で、用字 (script) 名は大文字小文字混在で綴られる。ただし、[BCP47] により言語タグ値は大文字小文字を区別しないため、実装は提供された言語タグ値を大文字小文字を区別せずに解釈すべきである (SHOULD)。[BCP47] の推奨に従い、メタデータパラメーター名で使用する言語タグ値は必要な範囲でのみ具体的であるべきである。たとえば、多くの文脈では fr-CA や fr-FR ではなく fr を使えば十分であろう。

If any human-readable field is sent without a language tag, parties using it MUST NOT make any assumptions about the language, character set, or script of the string value, and the string value MUST be used as is wherever it is presented in a user interface. To facilitate interoperability, it is RECOMMENDED that each kind of human-readable metadata provided include an instance of its metadata parameter without any language tags in addition to any language-specific parameters, and it is RECOMMENDED that any human-readable fields sent without language tags contain values suitable for display on a wide variety of systems.

人間が読めるフィールドが言語タグなしで送られた場合、それを使用する当事者は文字列値の言語、文字集合、文字体系について一切の仮定をしてはならず (MUST NOT)、その文字列値はユーザーインターフェースに提示されるあらゆる場所でそのまま使用しなければならない (MUST)。相互運用性を促進するため、提供される人間が読めるメタデータの各種類について、言語固有のパラメーターに加えて言語タグを持たないメタデータパラメーターのインスタンスを含めることが推奨され (RECOMMENDED)、言語タグなしで送られる人間が読めるフィールドには、幅広いシステムでの表示に適した値を含めることが推奨される (RECOMMENDED)。

2.2.Signed Protected Resource Metadata

2.2.署名付き保護リソースメタデータ

In addition to JSON elements, metadata values MAY also be provided as a signed_metadata value, which is a JSON Web Token (JWT) [JWT] that asserts metadata values about the protected resource as a bundle. A set of metadata parameters that can be used in signed metadata as claims are defined in Section 2. The signed metadata MUST be digitally signed or MACed (protected with a Message Authentication Code) using a JSON Web Signature (JWS) [JWS] and MUST contain an iss (issuer) claim denoting the party attesting to the claims in the signed metadata. Consumers of the metadata MAY ignore the signed metadata if they do not support this feature. If the consumer of the metadata supports signed metadata, metadata values conveyed in the signed metadata MUST take precedence over the corresponding values conveyed using plain JSON elements.

JSON 要素に加えて、メタデータ値は signed_metadata 値として提供してもよい (MAY)。これは、保護リソースに関するメタデータ値を一束にして主張する JSON Web Token (JWT) [JWT] である。署名付きメタデータ内でクレームとして使用できるメタデータパラメーターの集合は 2 節で定義する。署名付きメタデータは JSON Web Signature (JWS) [JWS] を使用してデジタル署名または MAC (メッセージ認証コードによる保護) されなければならず (MUST)、署名付きメタデータ内のクレームを証明する当事者を示す iss (issuer) クレームを含まなければならない (MUST)。メタデータの利用者は、この機能をサポートしない場合、署名付きメタデータを無視してもよい (MAY)。メタデータの利用者が署名付きメタデータをサポートする場合、署名付きメタデータで伝えられるメタデータ値は、プレーンな JSON 要素で伝えられる対応する値より優先されなければならない (MUST)。

Signed metadata is included in the protected resource metadata JSON object using this OPTIONAL metadata parameter:

署名付きメタデータは、次の OPTIONAL なメタデータパラメーターを使って保護リソースメタデータ JSON オブジェクトに含められる。

signed_metadata A JWT containing metadata parameters about the protected resource as claims. This is a string value consisting of the entire signed JWT. A signed_metadata parameter SHOULD NOT appear as a claim in the JWT; it is RECOMMENDED to reject any metadata in which this occurs.

signed_metadata 保護リソースに関するメタデータパラメーターをクレームとして含む JWT。これは、署名付き JWT 全体からなる文字列値である。signed_metadata パラメーターはその JWT 内のクレームとして現れるべきではなく (SHOULD NOT)、これが発生したメタデータは拒否することが推奨される (RECOMMENDED)。

3.Obtaining Protected Resource Metadata

3.保護リソースメタデータの取得

Protected resources supporting metadata MUST make a JSON document containing metadata as specified in Section 2 available at a URL formed by inserting a well-known URI string into the protected resource's resource identifier between the host component and the path and/or query components, if any. By default, the well-known URI string used is /.well-known/oauth-protected-resource. The syntax and semantics of .well-known are defined in [RFC8615]. The well-known URI path suffix used MUST be registered in the "Well-Known URIs" registry [IANA.well-known]. Examples of this construction can be found in Section 3.1.

メタデータをサポートする保護リソースは、2 節で規定するメタデータを含む JSON 文書を、保護リソースのリソース識別子のホスト構成要素とパスおよび/またはクエリ構成要素 (存在する場合) の間に well-known URI 文字列を挿入して形成される URL で利用可能にしなければならない (MUST)。既定で使用する well-known URI 文字列は /.well-known/oauth-protected-resource である。.well-known の構文と意味論は [RFC8615] で定義される。使用する well-known URI パスサフィックスは「Well-Known URIs」レジストリ [IANA.well-known] に登録されていなければならない (MUST)。この構成の例は 3.1 節にある。

The term "application", as used below (and as used in [RFC8414]), encompasses all the components used to accomplish the task for the use case. That can include OAuth clients, authorization servers, protected resources, and non-OAuth components, inclusive of the code running in each of them. Applications are built to solve particular problems and may utilize many components and services.

以下で ([RFC8414] でも同様に) 使用される「アプリケーション」という用語は、そのユースケースのタスクを達成するために使用されるすべての構成要素を包含する。これには、OAuth クライアント、認可サーバー、保護リソース、および OAuth 以外の構成要素が、それぞれで動作するコードも含めて含まれ得る。アプリケーションは特定の問題を解決するために構築され、多くの構成要素やサービスを利用することがある。

Different applications utilizing OAuth protected resources in application-specific ways MAY define and register different well- known URI path suffixes for publishing protected resource metadata used by those applications. For instance, if the Example application uses an OAuth protected resource in an Example-specific way and there are Example-specific metadata values that it needs to publish, then it might register and use the example-protected-resource URI path suffix and publish the metadata document at the URL formed by inserting /.well-known/example-protected-resource between the host and path and/or query components of the protected resource's resource identifier. Alternatively, many such applications will use the default well-known URI string /.well-known/oauth-protected-resource, which is the right choice for general-purpose OAuth protected resources, and not register an application-specific one.

OAuth 保護リソースをアプリケーション固有の方法で利用する異なるアプリケーションは、それらのアプリケーションで使用される保護リソースメタデータを公開するために、異なる well-known URI パスサフィックスを定義して登録してもよい (MAY)。たとえば、Example アプリケーションが OAuth 保護リソースを Example 固有の方法で使用し、公開する必要のある Example 固有のメタデータ値がある場合、example-protected-resource URI パスサフィックスを登録して使用し、保護リソースのリソース識別子のホストとパスおよび/またはクエリ構成要素の間に /.well-known/example-protected-resource を挿入して形成される URL でメタデータ文書を公開することが考えられる。あるいは、そのようなアプリケーションの多くは、汎用の OAuth 保護リソースにとって正しい選択である既定の well-known URI 文字列 /.well-known/oauth-protected-resource を使用し、アプリケーション固有のものを登録しないだろう。

An OAuth 2.0 application using this specification MUST specify what well-known URI suffix it will use for this purpose. The same protected resource MAY choose to publish its metadata at multiple well-known locations derived from its resource identifier -- for example, publishing metadata at both /.well-known/example-protected- resource and /.well-known/oauth-protected-resource.

本仕様を使用する OAuth 2.0 アプリケーションは、この目的でどの well-known URI サフィックスを使用するかを規定しなければならない (MUST)。同一の保護リソースが、そのリソース識別子から導出される複数の well-known な場所でメタデータを公開することを選んでもよい (MAY)。たとえば、/.well-known/example-protected-resource と /.well-known/oauth-protected-resource の両方でメタデータを公開することである。

3.1.Protected Resource Metadata Request

3.1.保護リソースメタデータリクエスト

The consumer of the metadata would make the following request when the resource identifier is https://resource.example.com and the well- known URI path suffix is oauth-protected-resource to obtain the metadata, since the resource identifier contains no path component:

リソース識別子が https://resource.example.com で、well-known URI パスサフィックスが oauth-protected-resource の場合、リソース識別子にパス構成要素が含まれないため、メタデータの利用者はメタデータを取得するために次のリクエストを行う。

If the resource identifier value contains a path or query component, any terminating slash (/) following the host component MUST be removed before inserting /.well-known/ and the well-known URI path suffix between the host component and the path and/or query components. The consumer of the metadata would make the following request when the resource identifier is https://resource.example.com/ resource1 and the well-known URI path suffix is oauth-protected- resource to obtain the metadata, since the resource identifier contains a path component:

リソース識別子の値にパスまたはクエリ構成要素が含まれる場合、ホスト構成要素とパスおよび/またはクエリ構成要素の間に /.well-known/ と well-known URI パスサフィックスを挿入する前に、ホスト構成要素に続く末尾のスラッシュ (/) を取り除かなければならない (MUST)。リソース識別子が https://resource.example.com/resource1 で、well-known URI パスサフィックスが oauth-protected-resource の場合、リソース識別子にパス構成要素が含まれるため、メタデータの利用者はメタデータを取得するために次のリクエストを行う。

Using path components enables supporting multiple resources per host. This is required in some multi-tenant hosting configurations. This use of .well-known is for supporting multiple resources per host; unlike its use in [RFC8615], it does not provide general information about the host.

パス構成要素を使用することで、ホストごとに複数のリソースをサポートできる。これは一部のマルチテナントホスティング構成で必要となる。この .well-known の使用はホストごとに複数のリソースをサポートするためのものであり、[RFC8615] での使用とは異なり、ホストに関する一般的な情報を提供するものではない。

3.2.Protected Resource Metadata Response

3.2.保護リソースメタデータレスポンス

The response is a set of metadata parameters about the protected resource's configuration. A successful response MUST use the 200 OK HTTP status code and return a JSON object using the application/json content type that contains a set of metadata parameters as its members that are a subset of the metadata parameters defined in Section 2. Additional metadata parameters MAY be defined and used; any metadata parameters that are not understood MUST be ignored.

レスポンスは、保護リソースの構成に関するメタデータパラメーターの集合である。成功レスポンスは 200 OK HTTP ステータスコードを使用し、2 節で定義されるメタデータパラメーターの部分集合であるメタデータパラメーターの集合をメンバーとして含む JSON オブジェクトを application/json コンテンツタイプで返さなければならない (MUST)。追加のメタデータパラメーターを定義して使用してもよく (MAY)、理解できないメタデータパラメーターは無視しなければならない (MUST)。

Parameters with multiple values are represented as JSON arrays. Parameters with zero values MUST be omitted from the response.

複数の値を持つパラメーターは JSON 配列として表現される。値を持たないパラメーターはレスポンスから省略しなければならない (MUST)。

An error response uses the applicable HTTP status code value.

エラーレスポンスは、該当する HTTP ステータスコード値を使用する。

The following is a non-normative example response:

以下は非規範的なレスポンス例である。

3.3.Protected Resource Metadata Validation

3.3.保護リソースメタデータの検証

The resource value returned MUST be identical to the protected resource's resource identifier value into which the well-known URI path suffix was inserted to create the URL used to retrieve the metadata. If these values are not identical, the data contained in the response MUST NOT be used.

返された resource の値は、メタデータの取得に使用した URL を作るために well-known URI パスサフィックスを挿入した保護リソースのリソース識別子の値と同一でなければならない (MUST)。これらの値が同一でない場合、レスポンスに含まれるデータを使用してはならない (MUST NOT)。

If the protected resource metadata was retrieved from a URL returned by the protected resource via the WWW-Authenticate resource_metadata parameter, then the resource value returned MUST be identical to the URL that the client used to make the request to the resource server. If these values are not identical, the data contained in the response MUST NOT be used.

保護リソースメタデータが、保護リソースから WWW-Authenticate の resource_metadata パラメーターで返された URL から取得された場合、返された resource の値は、クライアントがリソースサーバーへのリクエストに使用した URL と同一でなければならない (MUST)。これらの値が同一でない場合、レスポンスに含まれるデータを使用してはならない (MUST NOT)。

These validation actions can thwart impersonation attacks, as described in Section 7.3.

これらの検証動作は、7.3 節で説明するなりすまし攻撃を阻止できる。

The recipient MUST validate that any signed metadata was signed by a key belonging to the issuer and that the signature is valid. If the signature does not validate or the issuer is not trusted, the recipient SHOULD treat this as an error condition.

受信者は、署名付きメタデータが発行者に属する鍵で署名されていること、および署名が有効であることを検証しなければならない (MUST)。署名が検証できない、または発行者が信頼されない場合、受信者はこれをエラー状態として扱うべきである (SHOULD)。

4.Authorization Server Metadata

4.認可サーバーメタデータ

To support use cases in which the set of legitimate protected resources to use with the authorization server is enumerable, this specification defines the authorization server metadata parameter protected_resources, which enables the authorization server to explicitly list the protected resources. Note that if the set of legitimate authorization servers to use with a protected resource is also enumerable, lists in the authorization server metadata and protected resource metadata should be cross-checked against one another for consistency when these lists are used by the application profile.

認可サーバーとともに使用する正当な保護リソースの集合が列挙可能なユースケースをサポートするため、本仕様は認可サーバーメタデータパラメーター protected_resources を定義する。これにより認可サーバーは保護リソースを明示的に列挙できる。なお、保護リソースとともに使用する正当な認可サーバーの集合も列挙可能である場合、これらのリストがアプリケーションプロファイルで使用されるときには、認可サーバーメタデータと保護リソースメタデータのリストを相互に突き合わせて整合性を確認すべきである。

The following authorization server metadata parameter is defined by this specification and is registered in the "OAuth Authorization Server Metadata" registry established in "OAuth 2.0 Authorization Server Metadata" [RFC8414].

次の認可サーバーメタデータパラメーターが本仕様で定義され、「OAuth 2.0 Authorization Server Metadata」[RFC8414] で設立された「OAuth Authorization Server Metadata」レジストリに登録される。

protected_resources OPTIONAL. JSON array containing a list of resource identifiers for OAuth protected resources that can be used with this authorization server. Authorization servers MAY choose not to advertise some supported protected resources even when this parameter is used. In some use cases, the set of protected resources will not be enumerable, in which case this metadata parameter will not be present.

protected_resources OPTIONAL。この認可サーバーとともに使用できる OAuth 保護リソースのリソース識別子のリストを含む JSON 配列。認可サーバーは、このパラメーターを使用する場合でも、サポートする保護リソースの一部を公表しないことを選んでもよい (MAY)。ユースケースによっては保護リソースの集合が列挙可能でないことがあり、その場合このメタデータパラメーターは存在しない。

5.Use of WWW-Authenticate for Protected Resource Metadata

5.保護リソースメタデータのための WWW-Authenticate の使用

A protected resource MAY use the WWW-Authenticate HTTP response header field, as discussed in [RFC9110], to return a URL to its protected resource metadata to the client. The client can then retrieve protected resource metadata as described in Section 3. The client might then, for instance, determine what authorization server to use for the resource based on protected resource metadata retrieved.

保護リソースは、[RFC9110] で論じられる WWW-Authenticate HTTP レスポンスヘッダーフィールドを使用して、自身の保護リソースメタデータの URL をクライアントに返してもよい (MAY)。クライアントはその後、3 節で説明するように保護リソースメタデータを取得できる。クライアントはその後、たとえば、取得した保護リソースメタデータに基づいて、そのリソースにどの認可サーバーを使用するかを決定することが考えられる。

A typical end-to-end flow doing so is as follows. Note that while this example uses the OAuth 2.0 authorization code flow, a similar sequence could also be implemented with any other OAuth flow.

これを行う典型的なエンドツーエンドのフローは次のとおりである。なお、この例は OAuth 2.0 認可コードフローを使用しているが、同様のシーケンスは他のどの OAuth フローでも実装できる。

1. The client makes a request to a protected resource without presenting an access token.

1. クライアントが、アクセストークンを提示せずに保護リソースへリクエストを行う。

2. The resource server responds with a WWW-Authenticate header including the URL of the protected resource metadata.

2. リソースサーバーが、保護リソースメタデータの URL を含む WWW-Authenticate ヘッダー付きで応答する。

3. The client fetches the protected resource metadata from this URL.

3. クライアントがこの URL から保護リソースメタデータを取得する。

4. The resource server responds with the protected resource metadata according to Section 3.2.

4. リソースサーバーが、3.2 節に従って保護リソースメタデータを応答する。

5. The client validates the protected resource metadata, as described in Section 3.3, and builds the authorization server metadata URL from an issuer identifier in the resource metadata according to [RFC8414].

5. クライアントが、3.3 節に記述されたとおりに保護リソースメタデータを検証し、リソースメタデータ内の発行者識別子から [RFC8414] に従って認可サーバーメタデータの URL を構築する。

6. The client makes a request to fetch the authorization server metadata.

6. クライアントが認可サーバーメタデータを取得するリクエストを行う。

7. The authorization server responds with the authorization server metadata document according to [RFC8414].

7. 認可サーバーが、[RFC8414] に従って認可サーバーメタデータ文書を応答する。

8. The client directs the user agent to the authorization server to begin the authorization flow.

8. クライアントが、認可フローを開始するためにユーザーエージェントを認可サーバーへ誘導する。

9. The authorization exchange is completed and the authorization server returns an access token to the client.

9. 認可のやり取りが完了し、認可サーバーがクライアントにアクセストークンを返す。

10. The client repeats the resource request from step 1, presenting the newly obtained access token.

10. クライアントが、新たに取得したアクセストークンを提示して、ステップ 1 のリソースリクエストを繰り返す。

11. The resource server returns the requested protected resource.

11. リソースサーバーが要求された保護リソースを返す。

5.1.WWW-Authenticate Response

5.1.WWW-Authenticate レスポンス

This specification introduces a new parameter in the WWW-Authenticate HTTP response header field to indicate the protected resource metadata URL:

本仕様は、保護リソースメタデータ URL を示すための新しいパラメーターを WWW-Authenticate HTTP レスポンスヘッダーフィールドに導入する。

resource_metadata: The URL of the protected resource metadata.

resource_metadata: 保護リソースメタデータの URL。

The response below is an example of a WWW-Authenticate header that includes the resource identifier.

以下のレスポンスは、リソース識別子を含む WWW-Authenticate ヘッダーの例である。

The HTTP status code in the example response above is defined by [RFC6750].

上記のレスポンス例の HTTP ステータスコードは [RFC6750] で定義されている。

This parameter MAY also be used in WWW-Authenticate responses using authorization schemes other than "Bearer" [RFC6750], such as the DPoP scheme defined by [RFC9449].

このパラメーターは、[RFC9449] で定義される DPoP スキームなど、"Bearer" [RFC6750] 以外の認証スキームを使用する WWW-Authenticate レスポンスでも使用してもよい (MAY)。

The resource_metadata parameter MAY be combined with other parameters defined in other extensions, such as the max_age parameter defined by [RFC9470].

resource_metadata パラメーターは、[RFC9470] で定義される max_age パラメーターなど、他の拡張で定義される他のパラメーターと組み合わせてもよい (MAY)。

5.2.Changes to Resource Metadata

5.2.リソースメタデータの変更

At any point, for any reason determined by the resource server, the protected resource MAY respond with a new WWW-Authenticate challenge that includes a value for the protected resource metadata URL to indicate that its metadata may have changed. If the client receives such a WWW-Authenticate response, it SHOULD retrieve the updated protected resource metadata and use the new metadata values obtained, after validating them as described in Section 3.3. Among other things, this enables a resource server to change which authorization servers it uses without any other coordination with clients.

任意の時点で、リソースサーバーが決定する任意の理由により、保護リソースは、そのメタデータが変更された可能性があることを示すために、保護リソースメタデータ URL の値を含む新しい WWW-Authenticate チャレンジで応答してもよい (MAY)。クライアントがそのような WWW-Authenticate レスポンスを受け取った場合、更新された保護リソースメタデータを取得し、3.3 節で説明するように検証したうえで、取得した新しいメタデータ値を使用すべきである (SHOULD)。とりわけ、これによりリソースサーバーは、クライアントとの他の調整なしに、使用する認可サーバーを変更できる。

5.3.Client Identifier and Client Authentication

5.3.クライアント識別子とクライアント認証

The way in which the client identifier is established at the authorization server is out of scope for this specification.

認可サーバーにおいてクライアント識別子がどのように確立されるかは、本仕様の範囲外である。

This specification is intended to be deployed in scenarios where the client has no prior knowledge about the resource server and where the resource server might or might not have prior knowledge about the client.

本仕様は、クライアントがリソースサーバーについて事前の知識を持たず、リソースサーバーがクライアントについて事前の知識を持っているかもしれないし持っていないかもしれないシナリオでの展開を意図している。

There are some existing methods by which an unrecognized client can make use of an authorization server, such as using Dynamic Client Registration [RFC7591] to register the client prior to initiating the authorization flow. Future OAuth extensions might define alternatives, such as using URLs to identify clients.

認可フローを開始する前に Dynamic Client Registration [RFC7591] を使用してクライアントを登録するなど、認識されていないクライアントが認可サーバーを利用できる既存の方法がいくつかある。将来の OAuth 拡張では、URL を使用してクライアントを識別するなどの代替手段が定義されるかもしれない。

5.4.Compatibility with Other Authentication Methods

5.4.他の認証方式との互換性

Resource servers MAY return other WWW-Authenticate headers indicating various authentication schemes. This allows the resource server to support clients that may or may not implement this specification and allows clients to choose their preferred authentication scheme.

リソースサーバーは、さまざまな認証スキームを示す他の WWW-Authenticate ヘッダーを返してもよい (MAY)。これにより、リソースサーバーは本仕様を実装しているかもしれないし実装していないかもしれないクライアントをサポートでき、クライアントは好みの認証スキームを選択できる。

6.String Operations

6.文字列操作

Processing some OAuth 2.0 messages requires comparing values in the messages to known values. For example, the member names in the metadata response might be compared to specific member names such as resource. Comparing Unicode strings [UNICODE], however, has significant security implications.

一部の OAuth 2.0 メッセージの処理では、メッセージ内の値を既知の値と比較する必要がある。たとえば、メタデータレスポンス内のメンバー名を resource などの特定のメンバー名と比較することがある。しかし、Unicode 文字列 [UNICODE] の比較には重大なセキュリティ上の含意がある。

Therefore, comparisons between JSON strings and other Unicode strings MUST be performed as specified below:

したがって、JSON 文字列と他の Unicode 文字列との比較は、以下に規定するとおりに実行しなければならない (MUST)。

1. Remove any JSON-applied escaping to produce an array of Unicode code points.

1. JSON によるエスケープをすべて取り除き、Unicode コードポイントの配列を生成する。

2. Unicode Normalization [USA15] MUST NOT be applied at any point to either the JSON string or the string it is to be compared against.

2. Unicode 正規化 [USA15] を、JSON 文字列にも比較対象の文字列にも、いかなる時点でも適用してはならない (MUST NOT)。

3. Comparisons between the two strings MUST be performed as a Unicode code-point-to-code-point equality comparison.

3. 2 つの文字列の比較は、Unicode のコードポイント対コードポイントの等価比較として実行しなければならない (MUST)。

Note that this is the same equality comparison procedure as that described in Section 8.3 of [RFC8259].

なお、これは [RFC8259] の 8.3 節で説明されている等価比較手順と同じである。

7.Security Considerations

7.セキュリティに関する考慮事項

7.1.TLS Requirements

7.1.TLS 要件

Implementations MUST support TLS. They MUST follow the guidance in [BCP195], which provides recommendations and requirements for improving the security of deployed services that use TLS.

実装は TLS をサポートしなければならない (MUST)。実装は [BCP195] のガイダンスに従わなければならない (MUST)。[BCP195] は、TLS を使用する展開済みサービスのセキュリティを改善するための推奨事項と要件を提供する。

The use of TLS at the protected resource metadata URLs protects against information disclosure and tampering.

保護リソースメタデータ URL での TLS の使用は、情報漏洩と改ざんから保護する。

7.2.Scopes

7.2.スコープ

The scopes_supported parameter is the list of scopes the resource server is willing to disclose that it supports. It is not meant to indicate that an OAuth client should request all scopes in the list. The client SHOULD still follow OAuth best practices and request tokens with as limited a scope as possible for the given operation, as described in Section 2.3 of "Best Current Practice for OAuth 2.0 Security" [RFC9700].

scopes_supported パラメーターは、リソースサーバーがサポートすることを開示してもよいと考えるスコープのリストである。これは、OAuth クライアントがリスト内のすべてのスコープを要求すべきであることを示すものではない。クライアントは引き続き OAuth のベストプラクティスに従い、「Best Current Practice for OAuth 2.0 Security」[RFC9700] の 2.3 節で説明されているように、当該操作に対して可能な限り限定されたスコープでトークンを要求すべきである (SHOULD)。

7.3.Impersonation Attacks

7.3.なりすまし攻撃

TLS certificate checking MUST be performed by the client as described in [RFC9525] when making a protected resource metadata request. Checking that the server certificate is valid for the resource identifier URL prevents adversary-in-the-middle and DNS-based attacks. These attacks could cause a client to be tricked into using an attacker's resource server, which would enable impersonation of the legitimate protected resource. If an attacker can accomplish this, they can access the resources that the affected client has access to, using the protected resource that they are impersonating.

保護リソースメタデータリクエストを行う際、クライアントは [RFC9525] で説明されているとおりに TLS 証明書の検査を実行しなければならない (MUST)。サーバー証明書がリソース識別子 URL に対して有効であることを検査することで、中間者 (adversary-in-the-middle) 攻撃および DNS ベースの攻撃を防ぐ。これらの攻撃は、クライアントを騙して攻撃者のリソースサーバーを使用させることがあり、それにより正当な保護リソースのなりすましが可能になる。攻撃者がこれを達成できれば、なりすましている保護リソースを使って、影響を受けたクライアントがアクセスできるリソースにアクセスできる。

An attacker may also attempt to impersonate a protected resource by publishing a metadata document that contains a resource metadata parameter using the resource identifier URL of the protected resource being impersonated but that contains information of the attacker's choosing. This would enable it to impersonate that protected resource, if accepted by the client. To prevent this, the client MUST ensure that the resource identifier URL it is using as the prefix for the metadata request exactly matches the value of the resource metadata parameter in the protected resource metadata document received by the client, as described in Section 3.3.

攻撃者はまた、なりすまし対象の保護リソースのリソース識別子 URL を使用した resource メタデータパラメーターを含みつつ、攻撃者の選んだ情報を含むメタデータ文書を公開することで、保護リソースになりすまそうとするかもしれない。クライアントがこれを受け入れれば、攻撃者はその保護リソースになりすますことができる。これを防ぐため、クライアントは、3.3 節で説明するように、メタデータリクエストのプレフィックスとして使用しているリソース識別子 URL が、クライアントが受け取った保護リソースメタデータ文書内の resource メタデータパラメーターの値と正確に一致することを確実にしなければならない (MUST)。

7.4.Audience-Restricted Access Tokens

7.4.オーディエンス制限付きアクセストークン

If a client expects to interact with multiple resource servers, the client SHOULD request audience-restricted access tokens using [RFC8707], and the authorization server SHOULD support audience- restricted access tokens.

クライアントが複数のリソースサーバーとやり取りすることを想定する場合、クライアントは [RFC8707] を使用してオーディエンス制限付きアクセストークンを要求すべきであり (SHOULD)、認可サーバーはオーディエンス制限付きアクセストークンをサポートすべきである (SHOULD)。

Without audience-restricted access tokens, a malicious resource server (RS1) may be able to use the WWW-Authenticate header to get a client to request an access token with a scope used by a legitimate resource server (RS2), and after the client sends a request to RS1, then RS1 could reuse the access token at RS2.

オーディエンス制限付きアクセストークンがなければ、悪意のあるリソースサーバー (RS1) は WWW-Authenticate ヘッダーを使用して、正当なリソースサーバー (RS2) が使用するスコープでアクセストークンを要求するようクライアントに仕向けることができ、クライアントが RS1 にリクエストを送った後、RS1 はそのアクセストークンを RS2 で再利用できる。

While this attack is not explicitly enabled by this specification and is possible in a plain OAuth 2.0 deployment, it is made somewhat more likely by the use of dynamically configured clients. As such, the use of audience-restricted access tokens and Resource Indicators [RFC8707] is RECOMMENDED when using the features in this specification.

この攻撃は本仕様によって明示的に可能になるものではなく、通常の OAuth 2.0 展開でも可能であるが、動的に構成されるクライアントの使用によりいくらか起こりやすくなる。そのため、本仕様の機能を使用する際には、オーディエンス制限付きアクセストークンおよびリソースインジケーター [RFC8707] の使用が推奨される (RECOMMENDED)。

7.5.Publishing Metadata in a Standard Format

7.5.標準形式でのメタデータの公開

Publishing information about the protected resource in a standard format makes it easier for both legitimate clients and attackers to use the protected resource. Whether a protected resource publishes its metadata in an ad hoc manner or in the standard format defined by this specification, the same defenses against attacks that might be mounted that use this information should be applied.

保護リソースに関する情報を標準形式で公開することは、正当なクライアントと攻撃者の双方にとって保護リソースを使いやすくする。保護リソースがメタデータをアドホックな方法で公開するか本仕様で定義される標準形式で公開するかにかかわらず、この情報を利用して仕掛けられ得る攻撃に対しては同じ防御を適用すべきである。

7.6.Authorization Servers

7.6.認可サーバー

To support use cases in which the set of legitimate authorization servers to use with the protected resource is enumerable, this specification defines the authorization_servers metadata parameter, which enables explicitly listing them. Note that if the set of legitimate protected resources to use with an authorization server is also enumerable, lists in the protected resource metadata and authorization server metadata should be cross-checked against one another for consistency when these lists are used by the application profile.

保護リソースとともに使用する正当な認可サーバーの集合が列挙可能なユースケースをサポートするため、本仕様は authorization_servers メタデータパラメーターを定義する。これによりそれらを明示的に列挙できる。なお、認可サーバーとともに使用する正当な保護リソースの集合も列挙可能である場合、これらのリストがアプリケーションプロファイルで使用されるときには、保護リソースメタデータと認可サーバーメタデータのリストを相互に突き合わせて整合性を確認すべきである。

Secure determination of appropriate authorization servers to use with a protected resource for all use cases is out of scope for this specification. This specification assumes that the client has a means of determining appropriate authorization servers to use with a protected resource and that the client is using the correct metadata for each protected resource. Implementers need to be aware that if an inappropriate authorization server is used by the client, an attacker may be able to act as an adversary-in-the-middle proxy to a valid authorization server without it being detected by the authorization server or the client.

すべてのユースケースについて、保護リソースとともに使用する適切な認可サーバーを安全に決定することは、本仕様の範囲外である。本仕様は、クライアントが保護リソースとともに使用する適切な認可サーバーを決定する手段を持ち、クライアントが各保護リソースについて正しいメタデータを使用していることを前提とする。実装者は、クライアントが不適切な認可サーバーを使用した場合、攻撃者が認可サーバーにもクライアントにも検出されることなく、正当な認可サーバーへの中間者プロキシとして振る舞える可能性があることを認識しておく必要がある。

The ways to determine the appropriate authorization servers to use with a protected resource are, in general, application dependent. For instance, some protected resources are used with a fixed authorization server or a set of authorization servers, the locations of which may be known via out-of-band mechanisms. Alternatively, as described in this specification, the locations of the authorization servers could be published by the protected resource as metadata values. In other cases, the set of authorization servers that can be used with a protected resource can be dynamically changed by administrative actions or by changes to the set of authorization servers adhering to a trust framework. Many other means of determining appropriate associations between protected resources and authorization servers are also possible.

保護リソースとともに使用する適切な認可サーバーを決定する方法は、一般にアプリケーション依存である。たとえば、一部の保護リソースは固定の認可サーバーまたは認可サーバーの集合とともに使用され、その場所は帯域外の仕組みによって知られていることがある。あるいは、本仕様で説明するように、認可サーバーの場所を保護リソースがメタデータ値として公開することもできる。別の場合には、保護リソースとともに使用できる認可サーバーの集合が、管理上の操作や、トラストフレームワークに従う認可サーバーの集合の変更によって動的に変わることがある。保護リソースと認可サーバーの間の適切な関連付けを決定する他の多くの手段も可能である。

7.7.Server-Side Request Forgery (SSRF)

7.7.サーバーサイドリクエストフォージェリ (SSRF)

The OAuth client is expected to fetch the authorization server metadata based on the value of the issuer in the resource server metadata. Since this specification enables clients to interoperate with RSs and ASes it has no prior knowledge of, this opens a risk for Server-Side Request Forgery (SSRF) attacks by malicious users or malicious resource servers. Clients SHOULD take appropriate precautions against SSRF attacks, such as blocking requests to internal IP address ranges. Further recommendations can be found in the Open Worldwide Application Security Project (OWASP) SSRF Prevention Cheat Sheet [OWASP.SSRF].

OAuth クライアントは、リソースサーバーメタデータ内の発行者の値に基づいて認可サーバーメタデータを取得することが想定されている。本仕様はクライアントが事前の知識を持たない RS および AS との相互運用を可能にするため、悪意のあるユーザーや悪意のあるリソースサーバーによるサーバーサイドリクエストフォージェリ (SSRF) 攻撃のリスクが生じる。クライアントは、内部 IP アドレス範囲へのリクエストをブロックするなど、SSRF 攻撃に対する適切な予防策を講じるべきである (SHOULD)。さらなる推奨事項は Open Worldwide Application Security Project (OWASP) の SSRF Prevention Cheat Sheet [OWASP.SSRF] にある。

7.8.Phishing

7.8.フィッシング

This specification may be deployed in a scenario where the desired HTTP resource is identified by a user-selected URL. If this resource is malicious or compromised, it could mislead the user into revealing their account credentials or authorizing unwanted access to OAuth- controlled capabilities. This risk is reduced, but not eliminated, by following best practices for OAuth user interfaces, such as providing clear notice to the user, displaying the authorization server's domain name, supporting origin-bound phishing-resistant authenticators, supporting the use of password managers, and applying heuristic checks such as domain reputation.

本仕様は、目的の HTTP リソースがユーザーの選択した URL で識別されるシナリオで展開されることがある。このリソースが悪意のあるものか侵害されている場合、ユーザーを誤導してアカウントの認証情報を明かさせたり、OAuth で制御される機能への望まないアクセスを認可させたりする可能性がある。このリスクは、ユーザーへの明確な通知の提供、認可サーバーのドメイン名の表示、オリジンにバインドされたフィッシング耐性のある認証器のサポート、パスワードマネージャーの使用のサポート、ドメイン評価などのヒューリスティックな検査の適用といった OAuth ユーザーインターフェースのベストプラクティスに従うことで低減されるが、排除されるわけではない。

7.9.Differences Between Unsigned and Signed Metadata

7.9.署名なしメタデータと署名付きメタデータの違い

Unsigned metadata is integrity protected by the use of TLS at the site where it is hosted. This means that its security is dependent upon the Internet Public Key Infrastructure using X.509 (PKIX), as described in [RFC9525]. Signed metadata is additionally integrity protected by the JWS signature applied by the issuer, which is not dependent upon the Internet PKI.

署名なしメタデータは、それがホストされているサイトでの TLS の使用により完全性が保護される。これは、そのセキュリティが [RFC9525] で説明されている X.509 を使用するインターネット公開鍵基盤 (PKIX) に依存することを意味する。署名付きメタデータは、さらに発行者が適用した JWS 署名によって完全性が保護され、これはインターネット PKI に依存しない。

When using unsigned metadata, the party issuing the metadata is the protected resource itself, which is represented by the resource value in the metadata, whereas when using signed metadata, the party issuing the metadata is represented by the iss (issuer) claim in the signed metadata. When using signed metadata, applications can make trust decisions based on the issuer that performed the signing -- information that is not available when using unsigned metadata. How these trust decisions are made is out of scope for this specification.

署名なしメタデータを使用する場合、メタデータを発行する当事者は保護リソース自身であり、メタデータ内の resource の値で表される。一方、署名付きメタデータを使用する場合、メタデータを発行する当事者は署名付きメタデータ内の iss (issuer) クレームで表される。署名付きメタデータを使用する場合、アプリケーションは署名を行った発行者に基づいて信頼の判断を下すことができる。これは署名なしメタデータを使用する場合には得られない情報である。これらの信頼の判断をどのように行うかは、本仕様の範囲外である。

7.10.Metadata Caching

7.10.メタデータのキャッシュ

Protected resource metadata is retrieved using an HTTP GET request, as specified in Section 3.1. Normal HTTP caching behaviors apply, meaning that the GET request may retrieve a cached copy of the content, rather than the latest copy. Implementations should utilize HTTP caching directives such as Cache-Control with max-age, as defined in [RFC9111], to enable caching of retrieved metadata for appropriate time periods.

保護リソースメタデータは、3.1 節で規定するように HTTP GET リクエストを使用して取得される。通常の HTTP キャッシュ動作が適用されるため、GET リクエストは最新のコピーではなくキャッシュされたコピーを取得することがある。実装は、[RFC9111] で定義される max-age 付きの Cache-Control などの HTTP キャッシュディレクティブを利用し、取得したメタデータを適切な期間キャッシュできるようにすべきである。

8.IANA Considerations

8.IANA に関する考慮事項

Values are registered via Specification Required [RFC8126]. Registration requests should be sent to <oauth-ext-review@ietf.org> to initiate a two-week review period. However, to allow for the allocation of values prior to publication of the final version of a specification, the designated experts may approve registration once they are satisfied that the specification will be completed and published. However, if the specification is not completed and published in a timely manner, as determined by the designated experts, the designated experts may request that IANA withdraw the registration.

値は Specification Required [RFC8126] により登録される。登録要求は <oauth-ext-review@ietf.org> に送り、2 週間のレビュー期間を開始すべきである。ただし、仕様の最終版の公開前に値を割り当てられるようにするため、指名された専門家は、その仕様が完成して公開されると確信できれば登録を承認してもよい。ただし、指名された専門家の判断により仕様が適時に完成・公開されない場合、指名された専門家は IANA に登録の取り下げを要求してもよい。

Registration requests sent to the mailing list for review should use an appropriate subject (e.g., "Request to register OAuth Protected Resource Metadata: example").

レビューのためにメーリングリストに送る登録要求は、適切な件名 (例: "Request to register OAuth Protected Resource Metadata: example") を使用すべきである。

Within the review period, the designated experts will either approve or deny the registration request, communicating this decision to the review list and IANA. Denials should include an explanation and, if applicable, suggestions as to how to make the request successful. If the designated experts are not responsive, the registration requesters should contact IANA to escalate the process.

レビュー期間内に、指名された専門家は登録要求を承認または却下し、その決定をレビューリストと IANA に伝える。却下には説明と、該当する場合は要求を成功させる方法についての提案を含めるべきである。指名された専門家が応答しない場合、登録要求者は IANA に連絡して手続きをエスカレーションすべきである。

Designated experts should apply the following criteria when reviewing proposed registrations: They must be unique -- that is, they should not duplicate existing functionality; they are likely generally applicable, as opposed to being used for a single application; and they are clear and fit the purpose of the registry.

指名された専門家は、提案された登録をレビューする際に次の基準を適用すべきである。それらは一意でなければならない、すなわち既存の機能と重複すべきではない。それらは単一のアプリケーションで使用されるのではなく、一般に適用可能である可能性が高い。そして、それらは明確であり、レジストリの目的に適合する。

IANA must only accept registry updates from the designated experts and should direct all requests for registration to the review mailing list.

IANA は指名された専門家からのレジストリ更新のみを受け付けなければならず、登録のすべての要求をレビューメーリングリストに誘導すべきである。

In order to enable broadly informed review of registration decisions, there should be multiple designated experts to represent the perspectives of different applications using this specification. In cases where registration may be perceived as a conflict of interest for a particular expert, that expert should defer to the judgment of the other experts.

登録の決定について広く情報に基づいたレビューを可能にするため、本仕様を使用する異なるアプリケーションの観点を代表する複数の指名された専門家がいるべきである。ある専門家にとって登録が利益相反と見なされ得る場合、その専門家は他の専門家の判断に委ねるべきである。

The mailing list is used to enable public review of registration requests, which enables both designated experts and other interested parties to provide feedback on proposed registrations. Designated experts may allocate values prior to publication of the final specification. This allows authors to receive guidance from the designated experts early, so any identified issues can be fixed before the final specification is published.

メーリングリストは登録要求の公開レビューを可能にするために使用され、指名された専門家と他の関心を持つ当事者の双方が、提案された登録についてフィードバックを提供できるようにする。指名された専門家は最終仕様の公開前に値を割り当ててもよい。これにより著者は指名された専門家から早期にガイダンスを受けることができ、特定された問題を最終仕様の公開前に修正できる。

8.1.OAuth Protected Resource Metadata Registry

8.1.OAuth Protected Resource Metadata レジストリ

This specification establishes the "OAuth Protected Resource Metadata" registry for OAuth 2.0 protected resource metadata names. The registry records the protected resource metadata parameter and a reference to the specification that defines it.

本仕様は、OAuth 2.0 保護リソースメタデータ名のための「OAuth Protected Resource Metadata」レジストリを設立する。このレジストリは、保護リソースメタデータパラメーターと、それを定義する仕様への参照を記録する。

8.1.1.Registration Template

8.1.1.登録テンプレート

Metadata Name: The name requested (e.g., "resource"). This name is case sensitive. Names may not match other registered names in a case- insensitive manner unless the designated experts state that there is a compelling reason to allow an exception.

Metadata Name: 要求する名前 (例: "resource")。この名前は大文字小文字を区別する。指名された専門家が例外を認めるやむを得ない理由があると述べない限り、名前は他の登録済みの名前と大文字小文字を区別しない形で一致してはならない。

Metadata Description: Brief description of the metadata (e.g., "Resource identifier URL").

Metadata Description: メタデータの簡潔な説明 (例: "Resource identifier URL")。

Change Controller: For IETF Stream RFCs, list "IETF". For others, give the name of the responsible party. Other details (e.g., postal address, email address, home page URI) may also be included.

Change Controller: IETF Stream の RFC については "IETF" と記載する。それ以外については、責任を負う当事者の名前を記載する。その他の詳細 (例: 郵便住所、電子メールアドレス、ホームページ URI) を含めてもよい。

Specification Document(s): Reference to the document or documents that specify the parameter, preferably including URIs that can be used to retrieve copies of the documents. An indication of the relevant sections may also be included but is not required.

Specification Document(s): パラメーターを規定する文書への参照。文書のコピーを取得するのに使える URI を含めることが望ましい。関連する節の指示を含めてもよいが、必須ではない。

8.1.2.Initial Registry Contents

8.1.2.初期レジストリ内容

Metadata Name: resource Metadata Description: Protected resource's resource identifier URL Change Controller: IETF Specification Document(s): Section 2 of RFC 9728

Metadata Name: resource Metadata Description: 保護リソースのリソース識別子 URL Change Controller: IETF Specification Document(s): RFC 9728 の 2 節

Metadata Name: authorization_servers Metadata Description: JSON array containing a list of OAuth authorization server issuer identifiers Change Controller: IETF Specification Document(s): Section 2 of RFC 9728

Metadata Name: authorization_servers Metadata Description: OAuth 認可サーバー発行者識別子のリストを含む JSON 配列 Change Controller: IETF Specification Document(s): RFC 9728 の 2 節

Metadata Name: jwks_uri Metadata Description: URL of the protected resource's JWK Set document Change Controller: IETF Specification Document(s): Section 2 of RFC 9728

Metadata Name: jwks_uri Metadata Description: 保護リソースの JWK Set 文書の URL Change Controller: IETF Specification Document(s): RFC 9728 の 2 節

Metadata Name: scopes_supported Metadata Description: JSON array containing a list of the OAuth 2.0 scope values that are used in authorization requests to request access to this protected resource Change Controller: IETF Specification Document(s): Section 2 of RFC 9728

Metadata Name: scopes_supported Metadata Description: この保護リソースへのアクセスを要求する認可リクエストで使用される OAuth 2.0 スコープ値のリストを含む JSON 配列 Change Controller: IETF Specification Document(s): RFC 9728 の 2 節

Metadata Name: bearer_methods_supported Metadata Description: JSON array containing a list of the OAuth 2.0 bearer token presentation methods that this protected resource supports Change Controller: IETF Specification Document(s): Section 2 of RFC 9728

Metadata Name: bearer_methods_supported Metadata Description: この保護リソースがサポートする OAuth 2.0 ベアラートークン提示方法のリストを含む JSON 配列 Change Controller: IETF Specification Document(s): RFC 9728 の 2 節

Metadata Name: resource_signing_alg_values_supported Metadata Description: JSON array containing a list of the JWS signing algorithms (alg values) supported by the protected resource for signed content Change Controller: IETF Specification Document(s): Section 2 of RFC 9728

Metadata Name: resource_signing_alg_values_supported Metadata Description: 署名付きコンテンツのために保護リソースがサポートする JWS 署名アルゴリズム (alg 値) のリストを含む JSON 配列 Change Controller: IETF Specification Document(s): RFC 9728 の 2 節

Metadata Name: resource_name Metadata Description: Human-readable name of the protected resource Change Controller: IETF Specification Document(s): Section 2 of RFC 9728

Metadata Name: resource_name Metadata Description: 人間が読める保護リソースの名前 Change Controller: IETF Specification Document(s): RFC 9728 の 2 節

Metadata Name: resource_documentation Metadata Description: URL of a page containing human-readable information that developers might want or need to know when using the protected resource Change Controller: IETF Specification Document(s): Section 2 of RFC 9728

Metadata Name: resource_documentation Metadata Description: 保護リソースを使用する際に開発者が知りたい、または知る必要がある、人間が読める情報を含むページの URL Change Controller: IETF Specification Document(s): RFC 9728 の 2 節

Metadata Name: resource_policy_uri Metadata Description: URL of a page containing human-readable information about the protected resource's requirements on how the client can use the data provided by the protected resource Change Controller: IETF Specification Document(s): Section 2 of RFC 9728

Metadata Name: resource_policy_uri Metadata Description: 保護リソースが提供するデータをクライアントがどのように使用できるかに関する保護リソースの要件について、人間が読める情報を含むページの URL Change Controller: IETF Specification Document(s): RFC 9728 の 2 節

Metadata Name: resource_tos_uri Metadata Description: URL of a page containing human-readable information about the protected resource's terms of service Change Controller: IETF Specification Document(s): Section 2 of RFC 9728

Metadata Name: resource_tos_uri Metadata Description: 保護リソースの利用規約について、人間が読める情報を含むページの URL Change Controller: IETF Specification Document(s): RFC 9728 の 2 節

Metadata Name: tls_client_certificate_bound_access_tokens Metadata Description: Boolean value indicating protected resource support for mutual-TLS client certificate-bound access tokens Change Controller: IETF Specification Document(s): Section 2 of RFC 9728

Metadata Name: tls_client_certificate_bound_access_tokens Metadata Description: 相互 TLS クライアント証明書バウンドアクセストークンの保護リソースによるサポートを示す真偽値 Change Controller: IETF Specification Document(s): RFC 9728 の 2 節

Metadata Name: authorization_details_types_supported Metadata Description: JSON array containing a list of the authorization details type values supported by the resource server when the authorization_details request parameter is used Change Controller: IETF Specification Document(s): Section 2 of RFC 9728

Metadata Name: authorization_details_types_supported Metadata Description: authorization_details リクエストパラメーターが使用される場合にリソースサーバーがサポートする authorization details の type 値のリストを含む JSON 配列 Change Controller: IETF Specification Document(s): RFC 9728 の 2 節

Metadata Name: dpop_signing_alg_values_supported Metadata Description: JSON array containing a list of the JWS alg values supported by the resource server for validating DPoP proof JWTs Change Controller: IETF Specification Document(s): Section 2 of RFC 9728

Metadata Name: dpop_signing_alg_values_supported Metadata Description: DPoP プルーフ JWT を検証するためにリソースサーバーがサポートする JWS alg 値のリストを含む JSON 配列 Change Controller: IETF Specification Document(s): RFC 9728 の 2 節

Metadata Name: dpop_bound_access_tokens_required Metadata Description: Boolean value specifying whether the protected resource always requires the use of DPoP-bound access tokens Change Controller: IETF Specification Document(s): Section 2 of RFC 9728

Metadata Name: dpop_bound_access_tokens_required Metadata Description: 保護リソースが常に DPoP バウンドアクセストークンの使用を要求するかどうかを指定する真偽値 Change Controller: IETF Specification Document(s): RFC 9728 の 2 節

Metadata Name: signed_metadata Metadata Description: Signed JWT containing metadata parameters about the protected resource as claims Change Controller: IETF Specification Document(s): Section 2.2 of RFC 9728

Metadata Name: signed_metadata Metadata Description: 保護リソースに関するメタデータパラメーターをクレームとして含む署名付き JWT Change Controller: IETF Specification Document(s): RFC 9728 の 2.2 節

8.2.OAuth Authorization Server Metadata Registry

8.2.OAuth Authorization Server Metadata レジストリ

IANA has registered the following authorization server metadata parameter in the "OAuth Authorization Server Metadata" registry established in "OAuth 2.0 Authorization Server Metadata" [RFC8414].

IANA は、「OAuth 2.0 Authorization Server Metadata」[RFC8414] で設立された「OAuth Authorization Server Metadata」レジストリに、次の認可サーバーメタデータパラメーターを登録した。

8.2.1.Registry Contents

8.2.1.レジストリ内容

Metadata Name: protected_resources Metadata Description: JSON array containing a list of resource identifiers for OAuth protected resources Change Controller: IETF Specification Document(s): Section 4 of RFC 9728

Metadata Name: protected_resources Metadata Description: OAuth 保護リソースのリソース識別子のリストを含む JSON 配列 Change Controller: IETF Specification Document(s): RFC 9728 の 4 節

8.3.Well-Known URIs Registry

8.3.Well-Known URIs レジストリ

This specification registers the well-known URI defined in Section 3 in the "Well-Known URIs" registry [IANA.well-known].

本仕様は、3 節で定義する well-known URI を「Well-Known URIs」レジストリ [IANA.well-known] に登録する。

8.3.1.Registry Contents

8.3.1.レジストリ内容

URI Suffix: oauth-protected-resource Reference: Section 3 of RFC 9728 Status: permanent Change Controller: IETF Related Information: (none)

URI Suffix: oauth-protected-resource Reference: RFC 9728 の 3 節 Status: permanent Change Controller: IETF Related Information: (none)

9.References

9.参考資料

9.1.Normative References

9.1.引用規格

Sheffer, Y., Saint-Andre, P., and T. Fossati, "Recommendations for Secure Use of Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS)", BCP 195, RFC 9325, DOI 10.17487/RFC9325, November 2022, <https://www.rfc-editor.org/info/rfc9325>.

Sheffer, Y., Saint-Andre, P., and T. Fossati, "Recommendations for Secure Use of Transport Layer Security (TLS) and Datagram Transport Layer Security (DTLS)", BCP 195, RFC 9325, DOI 10.17487/RFC9325, November 2022, <https://www.rfc-editor.org/info/rfc9325>.

Phillips, A., Ed. and M. Davis, Ed., "Matching of Language Tags", BCP 47, RFC 4647, DOI 10.17487/RFC4647, September 2006, <https://www.rfc-editor.org/info/rfc4647>.

Phillips, A., Ed. and M. Davis, Ed., "Matching of Language Tags", BCP 47, RFC 4647, DOI 10.17487/RFC4647, September 2006, <https://www.rfc-editor.org/info/rfc4647>.

Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, September 2009, <https://www.rfc-editor.org/info/rfc5646>.

Phillips, A., Ed. and M. Davis, Ed., "Tags for Identifying Languages", BCP 47, RFC 5646, DOI 10.17487/RFC5646, September 2009, <https://www.rfc-editor.org/info/rfc5646>.

9.2.Informative References

9.2.参考文献

Acknowledgements

謝辞

The authors of this specification would like to thank the attendees of the IETF 115 OAuth and HTTP API Working Group meetings and the attendees of subsequent OAuth Working Group meetings for their input on this specification. We would also like to thank Amanda Baber, Mike Bishop, Ralph Bragg, Brian Campbell, Deb Cooley, Gabriel Corona, Roman Danyliw, Vladimir Dzhuvinov, George Fletcher, Arnt Gulbrandsen, Pieter Kasselman, Murray Kucherawy, David Mandelberg, Tony Nadalin, Francesca Palombini, John Scudder, Rifaat Shekh-Yusef, Filip Skokan, Orie Steele, Atul Tulshibagwale, Éric Vyncke, Paul Wouters, and Bo Wu for their contributions to the specification.

本仕様の著者は、IETF 115 の OAuth および HTTP API ワーキンググループ会合の参加者、ならびにその後の OAuth ワーキンググループ会合の参加者に、本仕様への意見について感謝する。また、Amanda Baber、Mike Bishop、Ralph Bragg、Brian Campbell、Deb Cooley、Gabriel Corona、Roman Danyliw、Vladimir Dzhuvinov、George Fletcher、Arnt Gulbrandsen、Pieter Kasselman、Murray Kucherawy、David Mandelberg、Tony Nadalin、Francesca Palombini、John Scudder、Rifaat Shekh-Yusef、Filip Skokan、Orie Steele、Atul Tulshibagwale、Éric Vyncke、Paul Wouters、Bo Wu の各氏の本仕様への貢献に感謝する。