draft-ietf-oauth-dyn-reg-09.txt   draft-ietf-oauth-dyn-reg-10.txt 
OAuth Working Group J. Richer, Ed. OAuth Working Group J. Richer, Ed.
Internet-Draft The MITRE Corporation Internet-Draft The MITRE Corporation
Intended status: Standards Track J. Bradley Intended status: Standards Track J. Bradley
Expires: September 30, 2013 Ping Identity Expires: November 06, 2013 Ping Identity
M.B. Jones M.B. Jones
Microsoft Microsoft
M. Machulak M. Machulak
Newcastle University Newcastle University
March 29, 2013 May 05, 2013
OAuth 2.0 Dynamic Client Registration Protocol OAuth 2.0 Dynamic Client Registration Protocol
draft-ietf-oauth-dyn-reg-09 draft-ietf-oauth-dyn-reg-10
Abstract Abstract
This specification defines an endpoint and protocol for dynamic This specification defines an endpoint and protocol for dynamic
registration of OAuth 2.0 Clients at an Authorization Server and registration of OAuth 2.0 Clients at an Authorization Server and
methods for the dynamically registered client to manage its methods for the dynamically registered client to manage its
registration. registration.
Status of This Memo Status of This Memo
skipping to change at page 1, line 38 skipping to change at page 1, line 38
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on September 30, 2013. This Internet-Draft will expire on November 06, 2013.
Copyright Notice Copyright Notice
Copyright (c) 2013 IETF Trust and the persons identified as the Copyright (c) 2013 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
skipping to change at page 2, line 16 skipping to change at page 2, line 16
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Notational Conventions . . . . . . . . . . . . . . . . . 3 1.1. Notational Conventions . . . . . . . . . . . . . . . . . 3
1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.2. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
2. Client Metadata . . . . . . . . . . . . . . . . . . . . . . . 4 2. Client Metadata . . . . . . . . . . . . . . . . . . . . . . . 4
2.1. Relationship Between Grant Types and Response Types . . . 7 2.1. Relationship Between Grant Types and Response Types . . . 7
2.2. Human Readable Client Metadata . . . . . . . . . . . . . 7 2.2. Human Readable Client Metadata . . . . . . . . . . . . . 8
3. Client Registration Endpoint . . . . . . . . . . . . . . . . 9 3. Client Registration Endpoint . . . . . . . . . . . . . . . . 9
3.1. Client Registration Request . . . . . . . . . . . . . . . 9 3.1. Client Registration Request . . . . . . . . . . . . . . . 10
3.2. Client Registration Response . . . . . . . . . . . . . . 10 3.2. Client Registration Response . . . . . . . . . . . . . . 11
4. Client Configuration Endpoint . . . . . . . . . . . . . . . . 10 4. Client Configuration Endpoint . . . . . . . . . . . . . . . . 11
4.1. Forming the Client Configuration Endpoint URL . . . . . . 11 4.1. Forming the Client Configuration Endpoint URL . . . . . . 12
4.2. Client Read Request . . . . . . . . . . . . . . . . . . . 11 4.2. Client Read Request . . . . . . . . . . . . . . . . . . . 12
4.3. Client Update Request . . . . . . . . . . . . . . . . . . 12 4.3. Client Update Request . . . . . . . . . . . . . . . . . . 13
4.4. Client Delete Request . . . . . . . . . . . . . . . . . . 14 4.4. Client Delete Request . . . . . . . . . . . . . . . . . . 14
5. Responses . . . . . . . . . . . . . . . . . . . . . . . . . . 15 5. Responses . . . . . . . . . . . . . . . . . . . . . . . . . . 15
5.1. Client Information Response . . . . . . . . . . . . . . . 15 5.1. Client Information Response . . . . . . . . . . . . . . . 15
5.2. Client Registration Error Response . . . . . . . . . . . 16 5.2. Client Registration Error Response . . . . . . . . . . . 17
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 17 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 18
7. Security Considerations . . . . . . . . . . . . . . . . . . . 17 7. Security Considerations . . . . . . . . . . . . . . . . . . . 18
8. Normative References . . . . . . . . . . . . . . . . . . . . 19 8. Normative References . . . . . . . . . . . . . . . . . . . . 20
Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . 20 Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . 21
Appendix B. Document History . . . . . . . . . . . . . . . . . . 20 Appendix B. Document History . . . . . . . . . . . . . . . . . . 21
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 23 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 24
1. Introduction 1. Introduction
In some use-case scenarios, it is desirable or necessary to allow In some use-case scenarios, it is desirable or necessary to allow
OAuth 2.0 clients to obtain authorization from an OAuth 2.0 OAuth 2.0 clients to obtain authorization from an OAuth 2.0
authorization server without requiring the two parties to interact authorization server without requiring the two parties to interact
beforehand. Nevertheless, in order for the authorization server to beforehand. Nevertheless, in order for the authorization server to
accurately and securely represent to end-users which client is accurately and securely represent to end-users which client is
seeking authorization to access the end-user's resources, a method seeking authorization to access the end-user's resources, a method
for automatic and unique registration of clients is needed. The for automatic and unique registration of clients is needed. The
skipping to change at page 4, line 13 skipping to change at page 4, line 13
particular Client. particular Client.
2. Client Metadata 2. Client Metadata
Clients generally have an array of metadata associated with their Clients generally have an array of metadata associated with their
unique Client Identifier at the Authorization Server. These can unique Client Identifier at the Authorization Server. These can
range from human-facing display strings, such as a client name, to range from human-facing display strings, such as a client name, to
items that impact the security of the protocol, such as the list of items that impact the security of the protocol, such as the list of
valid redirect URIs. valid redirect URIs.
Extensions and profiles of this specification MAY expand this list, The client metadata values serve two parallel purposes in the overall
but MUST at least accept all parameters on this list. The OAuth 2.0 Dynamic Client Registration protocol:
Authorization Server MUST ignore any additional parameters sent by
the Client that it does not understand.
[[ Editor's note: normative language in the table below is meant to o the Client requesting its desired values for each parameter to the
apply to the *client* when sending the request. The paragraph above Authorization Server in a register (Section 3.1) or update
is meant to say that the server must at least accept all parameters (Section 4.3) request, and
and not fail with an error at an unknown parameter, especially if
it's in the list below. Also, extensions need to explicitly call out o the Authorization Server informing the Client of the current
if they're not going to do something with one of these basic values of each parameter that the Client has been registered to
parameters instead of just ignoring their existence. This is meant use through a client information response (Section 5.1).
to be the *minimum set* of parameters for interoperability. ]]
An Authorization Server MAY override any value that a Client requests
during the registration process (including any omitted values) and
replace the requested value with a default at the server's
discretion. The Authorization Server SHOULD provide documentation
for any fields that it requires to be filled in by the client or to
have particular values or formats.
Extensions and profiles of this specification MAY expand this list,
but Authorization Servers MUST accept or ignore all parameters on
this list. The Authorization Server MUST ignore any additional
parameters sent by the Client that it does not understand.
redirect_uris redirect_uris
RECOMMENDED. Array of redirect URIs for use in the Authorization Array of redirect URIs for use in redirect-based flows such as the
Code and Implicit grant types. An Authorization Server SHOULD Authorization Code and Implicit grant types. It is RECOMMENDED
require registration of valid redirect URIs for all clients that that clients using these flows register this parameter, and an
use these grant types in order to protect against token and Authorization Server SHOULD require registration of valid redirect
credential theft attacks. URIs for all clients that use these grant types in order to
protect against token and credential theft attacks.
client_name client_name
RECOMMENDED. Human-readable name of the Client to be presented to Human-readable name of the Client to be presented to the user. If
the user. If omitted, the Authorization Server MAY display to the omitted, the Authorization Server MAY display the raw "client_id"
user the raw "client_id" value instead. The value of this field value to the user instead. It is RECOMMENDED that clients always
MAY be internationalized as described in Human Readable Client send this field. The value of this field MAY be internationalized
Metadata (Section 2.2). as described in Human Readable Client Metadata (Section 2.2).
client_uri client_uri
RECOMMENDED. URL of the homepage of the Client. If present, the URL of the homepage of the Client. If present, the server SHOULD
server SHOULD display this URL to the end user in a clickable display this URL to the end user in a clickable fashion. It is
fashion. The value of this field MAY be internationalized as RECOMMENDED that clients always send this field. The value of
described in Human Readable Client Metadata (Section 2.2). this field MAY be internationalized as described in Human Readable
Client Metadata (Section 2.2).
logo_uri logo_uri
OPTIONAL. URL that references a logo for the Client. If present, URL that references a logo for the Client. If present, the server
the server SHOULD display this image to the end user during SHOULD display this image to the end user during approval. The
approval.The value of this field MAY be internationalized as value of this field MAY be internationalized as described in Human
described in Human Readable Client Metadata (Section 2.2). Readable Client Metadata (Section 2.2).
contacts contacts
OPTIONAL. Array of email addresses for people responsible for Array of email addresses for people responsible for this Client.
this Client. The Authorization Server MAY make these addresses The Authorization Server MAY make these addresses available to end
available to end users for support requests for the Client. An users for support requests for the Client. An Authorization
Authorization Server MAY use these email addresses as identifiers Server MAY use these email addresses as identifiers for an
for an administrative page for this client. administrative page for this client.
tos_uri tos_uri
OPTIONAL. URL that points to a human-readable Terms of Service URL that points to a human-readable Terms of Service for the
for the Client. The Authorization Server SHOULD display this URL Client. The Authorization Server SHOULD display this URL to the
to the End-User if it is given. The value of this field MAY be End-User if it is given. The value of this field MAY be
internationalized as described in Human Readable Client Metadata internationalized as described in Human Readable Client Metadata
(Section 2.2). (Section 2.2).
token_endpoint_auth_method token_endpoint_auth_method
OPTIONAL. The requested authentication type for the Token The requested authentication type for the Token Endpoint. Valid
Endpoint. Valid values are: values are:
* "none": this is a public client as defined in OAuth 2.0 and * "none": this is a public client as defined in OAuth 2.0 and
does not have a client secret does not have a client secret
* "client_secret_post": the client uses the HTTP POST parameters * "client_secret_post": the client uses the HTTP POST parameters
defined in OAuth 2.0 section 2.3.1 defined in OAuth 2.0 section 2.3.1
* "client_secret_basic": the client uses HTTP Basic defined in * "client_secret_basic": the client uses HTTP Basic defined in
OAuth 2.0 section 2.3.1 OAuth 2.0 section 2.3.1
* "client_secret_jwt": the client uses the JWT Assertion profile * "client_secret_jwt": the client uses the JWT Assertion
with a symmetric secret issued by the server [OAuth.JWT] profile with a symmetric signature using the
"client_secret" issued by the server
* "private_key_jwt": the client uses the JWT Assertion profile * "private_key_jwt": the client uses the JWT Assertion
with its own private key [OAuth.JWT] profile with its own private key, usually with its
public key location indicated by the "jwks_uri" field
Other authentication methods may be defined by extension. If Other authentication methods may be defined by extension. If
unspecified or omitted, the default is "client_secret_basic", unspecified or omitted, the default is "client_secret_basic",
denoting HTTP Basic Authentication Scheme as specified in denoting HTTP Basic Authentication Scheme as specified in
Section 2.3.1 of OAuth 2.0. Section 2.3.1 of OAuth 2.0. Other authentication methods MAY be
supported by using an absolute URI as the value of this parameter.
scope scope
OPTIONAL. Space separated list of scope values (as described in Space separated list of scope values (as described in OAuth 2.0
OAuth 2.0 Section 3.3 [RFC6749]) that the client is declaring that Section 3.3 [RFC6749]) that the client can use when requesting
it may use when requesting access tokens. If omitted, an access tokens. The semantics of values in this list is service
Authorization Server MAY register a Client with a default set of specific. If omitted, an Authorization Server MAY register a
scopes. Client with a default set of scopes.
grant_types grant_types
OPTIONAL. Array of OAuth 2.0 grant types that the Client may use. Array of OAuth 2.0 grant types that the Client may use. These
These grant types are defined as follows: grant types are defined as follows:
* "authorization_code": The Authorization Code Grant described in * "authorization_code": The Authorization Code Grant described in
OAuth 2.0 Section 4.1. OAuth 2.0 Section 4.1
* "implicit": The Implicit Grant described in OAuth 2.0 * "implicit": The Implicit Grant described in OAuth 2.0
Section 4.2. Section 4.2
* "password": The Resource Owner Password Credentials Grant * "password": The Resource Owner Password Credentials Grant
described in OAuth 2.0 Section 4.3 described in OAuth 2.0 Section 4.3
* "client_credentials": The Client Credentials Grant described in * "client_credentials": The Client Credentials Grant described in
OAuth 2.0 Section 4.4 OAuth 2.0 Section 4.4
* "refresh_token": The Refresh Token Grant described in OAuth 2.0 * "refresh_token": The Refresh Token Grant described in OAuth 2.0
Section 6. Section 6.
skipping to change at page 6, line 35 skipping to change at page 7, line 4
Bearer grant type defined in OAuth SAML 2 Bearer Token Profiles Bearer grant type defined in OAuth SAML 2 Bearer Token Profiles
[OAuth.SAML2]. [OAuth.SAML2].
Authorization Servers MAY allow for other values as defined in Authorization Servers MAY allow for other values as defined in
grant type extensions to OAuth 2.0. The extension process is grant type extensions to OAuth 2.0. The extension process is
described in OAuth 2.0 Section 2.5, and the value of this described in OAuth 2.0 Section 2.5, and the value of this
parameter MUST be the same as the value of the "grant_type" parameter MUST be the same as the value of the "grant_type"
parameter passed to the Token Endpoint defined in the extension. parameter passed to the Token Endpoint defined in the extension.
response_types response_types
OPTIONAL. Array of the OAuth 2.0 response types that the Client Array of the OAuth 2.0 response types that the Client may use.
may use. These response types are defined as follows: These response types are defined as follows:
* "code": The Authorization Code response described in OAuth 2.0 * "code": The Authorization Code response described in OAuth 2.0
Section 4.1. Section 4.1
* "token": The Implicit response described in OAuth 2.0 * "token": The Implicit response described in OAuth 2.0
Section 4.2 Section 4.2
Authorization Servers MAY allow for other values as defined in Authorization Servers MAY allow for other values as defined in
response type extensions to OAuth 2.0. The extension process is response type extensions to OAuth 2.0. The extension process is
described in OAuth 2.0 Section 2.5, and the value of this described in OAuth 2.0 Section 2.5, and the value of this
parameter MUST be the same as the value of the "response_type" parameter MUST be the same as the value of the "response_type"
parameter passed to the Authorization Endpoint defined in the parameter passed to the Authorization Endpoint defined in the
extension. extension.
policy_uri policy_uri
OPTIONAL. A URL location that the Client provides to the End-User A URL location that the Client provides to the End-User to read
to read about the how the profile data will be used. The about the how the profile data will be used. The Authorization
Authorization Server SHOULD display this URL to the End-User if it Server SHOULD display this URL to the End-User if it is given.
is given. The value of this field MAY be internationalized as The value of this field MAY be internationalized as described in
described in Human Readable Client Metadata (Section 2.2). Human Readable Client Metadata (Section 2.2).
jwks_uri jwks_uri
OPTIONAL. URL for the Client's JSON Web Key Set [JWK] document URL for the Client's JSON Web Key Set [JWK] document that is used
that is used for signing requests, such as requests to the Token for signing requests, such as requests to the Token Endpoint using
Endpoint using the "private_key_jwt" assertion client credential. the "private_key_jwt" assertion client credential. The keys MAY
The keys MAY also be used for higher level protocols that require also be used for higher level protocols that require signing or
signing or encryption. encryption.
2.1. Relationship Between Grant Types and Response Types 2.1. Relationship Between Grant Types and Response Types
The "grant_types" and "response_types" values described above are The "grant_types" and "response_types" values described above are
partially orthogonal, as they refer to arguments passed to different partially orthogonal, as they refer to arguments passed to different
endpoints in the OAuth protocol. However, they are related in that endpoints in the OAuth protocol. However, they are related in that
the "grant_types" available to a client influence the the "grant_types" available to a client influence the
"response_types" that the client is allowed to use, and vice versa. "response_types" that the client is allowed to use, and vice versa.
For instance, a "grant_types" value that includes For instance, a "grant_types" value that includes
"authorization_code" implies a "response_types" value that includes "authorization_code" implies a "response_types" value that includes
skipping to change at page 10, line 14 skipping to change at page 10, line 32
request includes any parameters described in Client Metadata request includes any parameters described in Client Metadata
(Section 2) that the client wishes to specify for itself during the (Section 2) that the client wishes to specify for itself during the
registration. The Authorization Server MAY provision default values registration. The Authorization Server MAY provision default values
for any items omitted in the Client Metadata. for any items omitted in the Client Metadata.
The Client sends an HTTP POST to the Client Registration Endpoint The Client sends an HTTP POST to the Client Registration Endpoint
with a content type of "application/json". The HTTP Entity Payload with a content type of "application/json". The HTTP Entity Payload
is a JSON [RFC4627] document consisting of a JSON object and all is a JSON [RFC4627] document consisting of a JSON object and all
parameters as top-level members of that JSON object. parameters as top-level members of that JSON object.
For example, a client could send the following registration request For example, a client could send the following open registration
to the Client Registration Endpoint: request to the Client Registration Endpoint:
Following is a non-normative example request (with line wraps for Following is a non-normative example request (with line wraps for
display purposes only): display purposes only):
POST /register HTTP/1.1 POST /register HTTP/1.1
Content-Type: application/json Content-Type: application/json
Accept: application/json Accept: application/json
Host: server.example.com Host: server.example.com
{ {
"redirect_uris":["https://client.example.org/callback", "redirect_uris":["https://client.example.org/callback",
"https://client.example.org/callback2"] "https://client.example.org/callback2"]
"client_name":"My Example Client", "client_name":"My Example Client",
"token_endpoint_auth_method":"client_secret_basic", "token_endpoint_auth_method":"client_secret_basic",
"scope":"read write dolphin", "scope":"read write dolphin",
"logo_uri":"https://client.example.org/logo.png", "logo_uri":"https://client.example.org/logo.png",
"jwk_uri":"https://client.example.org/my_rsa_public_key.jwk" "jwks_uri":"https://client.example.org/my_public_keys.jwks"
}
Alternatively, if the client has been provisioned with an initial
authorization credential, it could send the following registration
request to the Client Registration Endpoint:
Following is a non-normative example request (with line wraps for
display purposes only):
POST /register HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: Bearer ey23f2.adfj230.af32-developer321
Host: server.example.com
{
"redirect_uris":["https://client.example.org/callback",
"https://client.example.org/callback2"]
"client_name":"My Example Client",
"token_endpoint_auth_method":"client_secret_basic",
"scope":"read write dolphin",
"logo_uri":"https://client.example.org/logo.png",
"jwks_uri":"https://client.example.org/my_public_keys.jwks"
} }
3.2. Client Registration Response 3.2. Client Registration Response
Upon successful registration, the Authorization Server generates a Upon successful registration, the Authorization Server generates a
new Client Identifier for the client. This Client Identifier MUST be new Client Identifier for the client. This Client Identifier MUST be
unique at the server and MUST NOT be in use by any other client. The unique at the server and MUST NOT be in use by any other client. The
server responds with an HTTP 201 Created code and a body of type server responds with an HTTP 201 Created code and a body of type
"application/json" with content described in Client Information "application/json" with content described in Client Information
Response (Section 5.1). Response (Section 5.1).
skipping to change at page 12, line 15 skipping to change at page 13, line 7
GET /register/s6BhdRkqt3 HTTP/1.1 GET /register/s6BhdRkqt3 HTTP/1.1
Accept: application/json Accept: application/json
Host: server.example.com Host: server.example.com
Authorization: Bearer reg-23410913-abewfq.123483 Authorization: Bearer reg-23410913-abewfq.123483
Upon successful read of the information for a currently active Upon successful read of the information for a currently active
Client, the Authorization Server responds with an HTTP 200 OK with Client, the Authorization Server responds with an HTTP 200 OK with
content type of "application/json" and a payload as described in content type of "application/json" and a payload as described in
Client Information Response (Section 5.1). Client Information Response (Section 5.1).
If the client does not exist on this server, the server MUST return If the client does not exist on this server, the server MUST respond
an HTTP 403 Forbidden. with HTTP 401 Unauthorized and the Registration Access Token used to
make this request SHOULD be immediately revoked.
If the Client does not have permission to read its record, the server If the Client does not have permission to read its record, the server
MUST return an HTTP 403 Forbidden. MUST return an HTTP 403 Forbidden.
4.3. Client Update Request 4.3. Client Update Request
This operation updates a previously-registered client with new This operation updates a previously-registered client with new
metadata at the Authorization Server. This request is authenticated metadata at the Authorization Server. This request is authenticated
by the Registration Access Token issued to the client. by the Registration Access Token issued to the client.
skipping to change at page 13, line 29 skipping to change at page 14, line 21
Authorization: Bearer reg-23410913-abewfq.123483 Authorization: Bearer reg-23410913-abewfq.123483
{ {
"client_id":"s6BhdRkqt3", "client_id":"s6BhdRkqt3",
"client_secret": "cf136dc3c1fc93f31185e5885805d", "client_secret": "cf136dc3c1fc93f31185e5885805d",
"redirect_uris":["https://client.example.org/callback", "redirect_uris":["https://client.example.org/callback",
"https://client.example.org/alt"], "https://client.example.org/alt"],
"scope": "read write dolphin", "scope": "read write dolphin",
"grant_types": ["authorization_code", "refresh_token"] "grant_types": ["authorization_code", "refresh_token"]
"token_endpoint_auth_method": "client_secret_basic", "token_endpoint_auth_method": "client_secret_basic",
"jwk_uri": "https://client.example.org/my_rsa_public_key.jwk" "jwks_uri": "https://client.example.org/my_public_keys.jwks"
"client_name":"My New Example", "client_name":"My New Example",
"logo_uri":"https://client.example.org/newlogo.png" "logo_uri":"https://client.example.org/newlogo.png"
} }
Upon successful update, the Authorization Server responds with an Upon successful update, the Authorization Server responds with an
HTTP 200 OK Message with content type "application/json" and a HTTP 200 OK Message with content type "application/json" and a
payload as described in Client Information Response (Section 5.1). payload as described in Client Information Response (Section 5.1).
The Authorization Server MAY include a new Client Secret and/or The Authorization Server MAY include a new Client Secret and/or
Registration Access Token in its response. If so, the Client MUST Registration Access Token in its response. If so, the Client MUST
immediately discard its previous Client Secret and/or Registration immediately discard its previous Client Secret and/or Registration
Access Token. Access Token.
If the Client does not exist on this server, the server MUST return If the client does not exist on this server, the server MUST respond
an HTTP 403 Forbidden. with HTTP 401 Unauthorized, and the Registration Access Token used to
make this request SHOULD be immediately revoked.
If the Client is not allowed to update its records, the server MUST If the Client is not allowed to update its records, the server MUST
respond with HTTP 403 Forbidden. respond with HTTP 403 Forbidden.
If the Client attempts to set an invalid metadata field and the If the Client attempts to set an invalid metadata field and the
Authorization Server does not set a default value, the Authorization Authorization Server does not set a default value, the Authorization
Server responds with an error as described in Client Registration Server responds with an error as described in Client Registration
Error Response (Section 5.2). Error Response (Section 5.2).
4.4. Client Delete Request 4.4. Client Delete Request
[[ Editor's note: The utility and nature of this function are still
under active discussion. This is a proposed set of functionality
that a server MAY choose to implement, else give a 405 response to
any client that tries, if it can't support it. ]]
In order to deprovision itself on the Authorization Server, the In order to deprovision itself on the Authorization Server, the
Client makes an HTTP DELETE request to the Client Configuration Client makes an HTTP DELETE request to the Client Configuration
Endpoint. This request is authenticated by the Registration Access Endpoint. This request is authenticated by the Registration Access
Token issued to the client. Token issued to the client.
Following is a non-normative example request (with line wraps for Following is a non-normative example request (with line wraps for
display purposes only): display purposes only):
DELETE /register/s6BhdRkqt3 HTTP/1.1 DELETE /register/s6BhdRkqt3 HTTP/1.1
Accept: application/json Accept: application/json
skipping to change at page 14, line 36 skipping to change at page 15, line 24
client_secret, and registration_access_token for this client, thereby client_secret, and registration_access_token for this client, thereby
preventing the client_id from being used at either the Authorization preventing the client_id from being used at either the Authorization
Endpoint or Token Endpoint of the Authorization Server. The Endpoint or Token Endpoint of the Authorization Server. The
Authorization Server SHOULD immediately invalidate all existing Authorization Server SHOULD immediately invalidate all existing
authorization grants and currently-active tokens associated with this authorization grants and currently-active tokens associated with this
Client. Client.
If a Client has been successfully deprovisioned, the Authorization If a Client has been successfully deprovisioned, the Authorization
Server responds with an HTTP 204 No Content message. Server responds with an HTTP 204 No Content message.
If there is no such client, the server responds with an HTTP 403 If the server does not support the delete method, the server MUST
Forbidden. respond with an HTTP 405 Not Supported.
If the client is not allowed to delete itself, the server responds If the client does not exist on this server, the server MUST respond
with HTTP 403 Forbidden. with HTTP 401 Unauthorized and the Registration Access Token used to
make this request SHOULD be immediately revoked.
If the server does not support the delete method, it responds with an If the client is not allowed to delete itself, the server MUST
HTTP 405 Not Supported. respond with HTTP 403 Forbidden.
Following is a non-normative example response: Following is a non-normative example response:
HTTP/1.1 204 No Content HTTP/1.1 204 No Content
Cache-Control: no-store Cache-Control: no-store
Pragma: no-cache Pragma: no-cache
5. Responses 5. Responses
In response to certain requests from the Client to either the Client In response to certain requests from the Client to either the Client
skipping to change at page 15, line 39 skipping to change at page 16, line 23
REQUIRED. The unique Client identifier, MUST NOT be currently REQUIRED. The unique Client identifier, MUST NOT be currently
valid for any other registered Client. valid for any other registered Client.
client_secret client_secret
OPTIONAL. The Client secret. If issued, this MUST be unique for OPTIONAL. The Client secret. If issued, this MUST be unique for
each "client_id". This value is used by confidential clients to each "client_id". This value is used by confidential clients to
authenticate to the Token Endpoint as described in OAuth 2.0 authenticate to the Token Endpoint as described in OAuth 2.0
Section 2.3.1. Section 2.3.1.
expires_at expires_at
REQUIRED if "client_secret" is issued. The number of seconds from REQUIRED if "client_secret" is issued. Time at which the
1970-01-01T0:0:0Z as measured in UTC that the "client_secret" will "client_secret" will expire or 0 if it will not expire. The time
expire or "0" if it does not expire. See RFC 3339 [RFC3339] for is represented as the number of seconds from 1970-01-01T0:0:0Z as
details regarding date/times in general and UTC in particular. measured in UTC until the date/time.
issued_at issued_at
OPTIONAL. Specifies the timestamp when the Client Identifier was OPTIONAL. Time at which the Client Identifier was issued. The
issued. The timestamp value MUST be a positive integer. The time is represented as the number of seconds from
value is expressed in the number of seconds since January 1, 1970 1970-01-01T0:0:0Z as measured in UTC until the date/time.
00:00:00 GMT.
registration_access_token registration_access_token
REQUIRED. The Access token to be used by the client to perform REQUIRED. The Access token to be used by the client to perform
actions on the Client Configuration Endpoint. actions on the Client Configuration Endpoint.
registration_client_uri registration_client_uri
REQUIRED. The fully qualified URL of the Client Configuration REQUIRED. The fully qualified URL of the Client Configuration
Endpoint for this client. The Client MUST use this URL as given Endpoint for this client. The Client MUST use this URL as given
when communicating with the Client Configuration Endpoint. when communicating with the Client Configuration Endpoint.
skipping to change at page 16, line 42 skipping to change at page 17, line 25
"https://server.example.com/register/s6BhdRkqt3", "https://server.example.com/register/s6BhdRkqt3",
"client_id":"s6BhdRkqt3", "client_id":"s6BhdRkqt3",
"client_secret": "cf136dc3c1fc93f31185e5885805d", "client_secret": "cf136dc3c1fc93f31185e5885805d",
"expires_at":2893276800 "expires_at":2893276800
"redirect_uris":["https://client.example.org/callback", "redirect_uris":["https://client.example.org/callback",
"https://client.example.org/callback2"] "https://client.example.org/callback2"]
"scope": "read write dolphin", "scope": "read write dolphin",
"grant_types": ["authorization_code", "refresh_token"] "grant_types": ["authorization_code", "refresh_token"]
"token_endpoint_auth_method": "client_secret_basic", "token_endpoint_auth_method": "client_secret_basic",
"logo_uri": "https://client.example.org/logo.png", "logo_uri": "https://client.example.org/logo.png",
"jwk_uri": "https://client.example.org/my_rsa_public_key.jwk" "jwks_uri": "https://client.example.org/my_public_keys.jwks"
} }
5.2. Client Registration Error Response 5.2. Client Registration Error Response
When an OAuth 2.0 error condition occurs, such as the client When an OAuth 2.0 error condition occurs, such as the client
presenting an invalid Registration Access Token, the Authorization presenting an invalid Registration Access Token, the Authorization
Server returns an Error Response as defined in Section 5.2 of the Server returns an Error Response as defined in Section 5.2 of the
OAuth 2.0 specification. OAuth 2.0 specification.
When a registration error condition occurs, the Authorization Server When a registration error condition occurs, the Authorization Server
skipping to change at page 18, line 19 skipping to change at page 18, line 49
TLS 1.0 [RFC2246] and MAY support additional transport-layer TLS 1.0 [RFC2246] and MAY support additional transport-layer
mechanisms meeting its security requirements. When using TLS, the mechanisms meeting its security requirements. When using TLS, the
Client MUST perform a TLS/SSL server certificate check, per RFC 6125 Client MUST perform a TLS/SSL server certificate check, per RFC 6125
[RFC6125]. [RFC6125].
As this endpoint is an OAuth 2.0 Protected Resource, requests to the As this endpoint is an OAuth 2.0 Protected Resource, requests to the
Registration Endpoint SHOULD have some rate limiting on failures to Registration Endpoint SHOULD have some rate limiting on failures to
prevent the Registration Access Token from being disclosed though prevent the Registration Access Token from being disclosed though
repeated access attempts. repeated access attempts.
For clients that use redirect-based grant types such as Authorization
Code and Implicit, Authorization Servers SHOULD require clients to
pre-register their "redirect_uris". Requiring Clients to do so can
help mitigate attacks where rogue actors inject and impersonate a
validly registered client and intercept its authorization code or
tokens through an invalid redirect URI.
The authorization server MUST treat all client metadata as self- The authorization server MUST treat all client metadata as self-
asserted. A rogue Client might use the name and logo for the asserted. A rogue Client might use the name and logo for the
legitimate Client, which it is trying to impersonate. An legitimate Client, which it is trying to impersonate. An
Authorization Server needs to take steps to mitigate this phishing Authorization Server needs to take steps to mitigate this phishing
risk, since the logo could confuse users into thinking they're risk, since the logo could confuse users into thinking they're
logging in to the legitimate Client. For instance, an Authorization logging in to the legitimate Client. For instance, an Authorization
Server could warn if the domain/site of the logo doesn't match the Server could warn if the domain/site of the logo doesn't match the
domain/site of redirect URIs. An Authorization Server can also domain/site of redirect URIs. An Authorization Server can also
present warning messages to end users about untrusted Clients in all present warning messages to end users about untrusted Clients in all
cases, especially if such clients have been dynamically registered cases, especially if such clients have been dynamically registered
skipping to change at page 19, line 18 skipping to change at page 20, line 11
a Client could make requests to the Client Configuration Endpoint a Client could make requests to the Client Configuration Endpoint
where the authentication would succeed but the action would fail where the authentication would succeed but the action would fail
because the Client is no longer valid. because the Client is no longer valid.
8. Normative References 8. Normative References
[IANA.Language] [IANA.Language]
Internet Assigned Numbers Authority (IANA), "Language Internet Assigned Numbers Authority (IANA), "Language
Subtag Registry", 2005. Subtag Registry", 2005.
[JWK] Jones, M.B., "JSON Web Key (JWK)", May 2012. [JWK] Jones, M.B., "JSON Web Key (JWK)", draft-ietf-jose-json-
web-key (work in progress), April 2013.
[OAuth.JWT] [OAuth.JWT]
Jones, M.B., Campbell, B., and C. Mortimore, "JSON Web Jones, M.B., Campbell, B., and C. Mortimore, "JSON Web
Token (JWT) Bearer Token Profiles for OAuth 2.0", draft- Token (JWT) Bearer Token Profiles for OAuth 2.0", draft-
ietf-oauth-jwt-bearer (work in progress), December 2012. ietf-oauth-jwt-bearer (work in progress), March 2013.
[OAuth.SAML2] [OAuth.SAML2]
Campbell, B. and C. Mortimore, "SAML 2.0 Bearer Assertion Campbell, B., Mortimore, C., and M.B. Jones, "SAML 2.0
Profiles for OAuth 2.0", draft-ietf-oauth-saml2-bearer Bearer Assertion Profiles for OAuth 2.0", draft-ietf-
(work in progress), November 2012. oauth-saml2-bearer (work in progress), March 2013.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997. Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC2246] Dierks, T. and C. Allen, "The TLS Protocol Version 1.0", [RFC2246] Dierks, T. and C. Allen, "The TLS Protocol Version 1.0",
RFC 2246, January 1999. RFC 2246, January 1999.
[RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H., [RFC2616] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999. Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999.
[RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the
Internet: Timestamps", RFC 3339, July 2002.
[RFC4627] Crockford, D., "The application/json Media Type for [RFC4627] Crockford, D., "The application/json Media Type for
JavaScript Object Notation (JSON)", RFC 4627, July 2006. JavaScript Object Notation (JSON)", RFC 4627, July 2006.
[RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security [RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security
(TLS) Protocol Version 1.2", RFC 5246, August 2008. (TLS) Protocol Version 1.2", RFC 5246, August 2008.
[RFC5646] Phillips, A. and M. Davis, "Tags for Identifying [RFC5646] Phillips, A. and M. Davis, "Tags for Identifying
Languages", BCP 47, RFC 5646, September 2009. Languages", BCP 47, RFC 5646, September 2009.
[RFC6125] Saint-Andre, P. and J. Hodges, "Representation and [RFC6125] Saint-Andre, P. and J. Hodges, "Representation and
skipping to change at page 20, line 25 skipping to change at page 21, line 16
Framework: Bearer Token Usage", RFC 6750, October 2012. Framework: Bearer Token Usage", RFC 6750, October 2012.
Appendix A. Acknowledgments Appendix A. Acknowledgments
The authors thank the OAuth Working Group, the User-Managed Access The authors thank the OAuth Working Group, the User-Managed Access
Working Group, and the OpenID Connect Working Group participants for Working Group, and the OpenID Connect Working Group participants for
their input to this document. In particular, the following their input to this document. In particular, the following
individuals have been instrumental in their review and contribution individuals have been instrumental in their review and contribution
to various versions of this document: Amanda Anganes, Tim Bray, to various versions of this document: Amanda Anganes, Tim Bray,
Domenico Catalano, George Fletcher, Torsten Lodderstedt, Eve Maler, Domenico Catalano, George Fletcher, Torsten Lodderstedt, Eve Maler,
Thomas Hardjono, Nat Sakimura, and Christian Scholz. Nov Matake, Thomas Hardjono, Nat Sakimura, and Christian Scholz.
Appendix B. Document History Appendix B. Document History
[[ to be removed by the RFC editor before publication as an RFC ]] [[ to be removed by the RFC editor before publication as an RFC ]]
-10
o Added language to point out that scope values are service-specific
o Clarified normative language around client metadata
o Added extensibility to token_endpoint_auth_method using absolute
URIs
o Added security consideration about registering redirect URIs
o Changed erroneous 403 responses to 401's with notes about token
handling
o Added example for initial registration credential
-09 -09
o Added method of internationalization for Client Metadata values o Added method of internationalization for Client Metadata values
o Fixed SAML reference o Fixed SAML reference
-08 -08
o Collapsed jwk_uri, jwk_encryption_uri, x509_uri, and o Collapsed jwk_uri, jwk_encryption_uri, x509_uri, and
x509_encryption_uri into a single jwks_uri parameter x509_encryption_uri into a single jwks_uri parameter
 End of changes. 46 change blocks. 
122 lines changed or deleted 176 lines changed or added

This html diff was produced by rfcdiff 1.41. The latest version is available from http://tools.ietf.org/tools/rfcdiff/