draft-ietf-oauth-dyn-reg-06.txt   draft-ietf-oauth-dyn-reg-07.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: August 19, 2013 Ping Identity Expires: August 25, 2013 Ping Identity
M. Jones M. Jones
Microsoft Microsoft
M. Machulak M. Machulak
Newcastle University Newcastle University
February 15, 2013 February 21, 2013
OAuth Dynamic Client Registration Protocol OAuth Dynamic Client Registration Protocol
draft-ietf-oauth-dyn-reg-06 draft-ietf-oauth-dyn-reg-07
Abstract Abstract
This specification defines an endpoint and protocol for dynamic This specification defines an endpoint and protocol for dynamic
registration of OAuth Clients at an Authorization Server. registration of OAuth Clients at an Authorization Server.
Status of this Memo Status of this Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
skipping to change at page 1, line 36 skipping to change at page 1, line 36
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 August 19, 2013. This Internet-Draft will expire on August 25, 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
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
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
3. Client Registration Endpoint . . . . . . . . . . . . . . . . . 7 3. Client Registration Endpoint . . . . . . . . . . . . . . . . . 7
3.1. Client Registration Request . . . . . . . . . . . . . . . 8 3.1. Client Registration Request . . . . . . . . . . . . . . . 8
3.2. Client Registration Response . . . . . . . . . . . . . . . 9 3.2. Client Registration Response . . . . . . . . . . . . . . . 9
4. Client Registration Access Endpoint . . . . . . . . . . . . . 9 4. Client Configuration Endpoint . . . . . . . . . . . . . . . . 9
4.1. Forming the Client Registration Access Endpoint URL . . . 9 4.1. Forming the Client Configuration Endpoint URL . . . . . . 9
4.2. Client Read Request . . . . . . . . . . . . . . . . . . . 10 4.2. Client Read Request . . . . . . . . . . . . . . . . . . . 10
4.3. Client Update Request . . . . . . . . . . . . . . . . . . 10 4.3. Client Update Request . . . . . . . . . . . . . . . . . . 10
4.4. Client Delete Request . . . . . . . . . . . . . . . . . . 12 4.4. Client Delete Request . . . . . . . . . . . . . . . . . . 12
5. Responses . . . . . . . . . . . . . . . . . . . . . . . . . . 13 5. Responses . . . . . . . . . . . . . . . . . . . . . . . . . . 13
5.1. Client Information Response . . . . . . . . . . . . . . . 13 5.1. Client Information Response . . . . . . . . . . . . . . . 13
5.2. Client Registration Error Response . . . . . . . . . . . . 15 5.2. Client Registration Error Response . . . . . . . . . . . . 15
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 16 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 16
7. Security Considerations . . . . . . . . . . . . . . . . . . . 16 7. Security Considerations . . . . . . . . . . . . . . . . . . . 16
8. Normative References . . . . . . . . . . . . . . . . . . . . . 17 8. Normative References . . . . . . . . . . . . . . . . . . . . . 17
Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . . 18 Appendix A. Acknowledgments . . . . . . . . . . . . . . . . . . . 18
Appendix B. Document History . . . . . . . . . . . . . . . . . . 18 Appendix B. Document History . . . . . . . . . . . . . . . . . . 18
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 20 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 20
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 clients to obtain authorization from an OAuth authorization OAuth clients to obtain authorization from an OAuth authorization
server without requiring the two parties to interact before hand. server without requiring the two parties to interact beforehand.
Nevertheless, in order for the authorization server to accurately and Nevertheless, in order for the authorization server to accurately and
securely represent to end-users which client is seeking authorization securely represent to end-users which client is seeking authorization
to access the end-user's resources, a method for automatic and unique to access the end-user's resources, a method for automatic and unique
registration of clients is needed. The OAuth2 authorization registration of clients is needed. The OAuth2 authorization
framework does not define how the relationship between the Client and framework does not define how the relationship between the Client and
the Authorization Server is initialized, or how a given client is the Authorization Server is initialized, or how a given client is
assigned a unique Client Identifier. Historically, this has happened assigned a unique Client Identifier. Historically, this has happened
out-of-band from the OAuth protocol. This draft provides a mechanism out-of-band from the OAuth protocol. This draft provides a mechanism
for a client to register itself with the Authorization Server, which for a client to register itself with the Authorization Server, which
can be used to dynamically provision a Client Identifier, and can be used to dynamically provision a Client Identifier, and
skipping to change at page 4, line 5 skipping to change at page 4, line 5
Secret", "Protected Resource", "Resource Owner", "Resource Server", Secret", "Protected Resource", "Resource Owner", "Resource Server",
and "Token Endpoint" defined by OAuth 2.0 [RFC6749]. and "Token Endpoint" defined by OAuth 2.0 [RFC6749].
This specification defines the following additional terms: This specification defines the following additional terms:
o Client Registration Endpoint: The OAuth 2.0 Endpoint through which o Client Registration Endpoint: The OAuth 2.0 Endpoint through which
a Client can request new registration. The means of the Client a Client can request new registration. The means of the Client
obtaining the URL for this endpoint are out of scope for this obtaining the URL for this endpoint are out of scope for this
specification. specification.
o Client Registration Access Endpoint: The OAuth 2.0 Endpoint o Client Configuration Endpoint: The OAuth 2.0 Endpoint through
through which a specific Client can manage its registration which a specific Client can manage its registration information,
information, provided by the Authorization Server to the Client. provided by the Authorization Server to the Client. This URL for
This URL for this endpoint is communicated to the client by the this endpoint is communicated to the client by the Authorization
Authorization Server in the Client Information Response. Server in the Client Information Response.
o Registration Access Token: An OAuth 2.0 Bearer Token issued by the o Registration Access Token: An OAuth 2.0 Bearer Token issued by the
Authorization Server through the Client Registration Endpoint Authorization Server through the Client Registration Endpoint
which is used by the Client to authenticate itself during read, which is used by the Client to authenticate itself during read,
update, and delete operations. This token is associated with a update, and delete operations. This token is associated with a
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
skipping to change at page 5, line 5 skipping to change at page 5, line 5
Code and Implicit grant types. An Authorization Server SHOULD Code and Implicit grant types. An Authorization Server SHOULD
require registration of valid redirect URIs for all clients that require registration of valid redirect URIs for all clients that
use these grant types in order to protect against token and use these grant types in order to protect against token and
credential theft attacks. credential theft attacks.
client_name client_name
RECOMMENDED. Human-readable name of the Client to be presented to RECOMMENDED. Human-readable name of the Client to be presented to
the user. If omitted, the Authorization Server MAY display to the the user. If omitted, the Authorization Server MAY display to the
user the raw "client_id" value instead. user the raw "client_id" value instead.
client_url client_uri
RECOMMENDED. URL of the homepage of the Client. If present, the RECOMMENDED. URL of the homepage of the Client. If present, the
server SHOULD display this URL to the end user in a clickable server SHOULD display this URL to the end user in a clickable
fashion. fashion.
logo_url logo_uri
OPTIONAL. URL that references a logo for the Client. If present, OPTIONAL. URL that references a logo for the Client. If present,
the server SHOULD display this image to the end user during the server SHOULD display this image to the end user during
approval. approval.
contacts contacts
OPTIONAL. Array of email addresses for people responsible for OPTIONAL. Array of email addresses for people responsible for
this Client. The Authorization Server MAY make these addresses this Client. The Authorization Server MAY make these addresses
available to end users for support requests for the Client. An available to end users for support requests for the Client. An
Authorization Server MAY use these email addresses as identifiers Authorization Server MAY use these email addresses as identifiers
for an administrative page for this client. for an administrative page for this client.
tos_url tos_uri
OPTIONAL. URL that points to a human-readable Terms of Service OPTIONAL. URL that points to a human-readable Terms of Service
for the Client. The Authorization Server SHOULD display this URL for the Client. The Authorization Server SHOULD display this URL
to the End-User if it is given. to the End-User if it is given.
token_endpoint_auth_method token_endpoint_auth_method
OPTIONAL. The requested authentication type for the Token OPTIONAL. The requested authentication type for the Token
Endpoint. Valid values are: Endpoint. Valid 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
skipping to change at page 6, line 36 skipping to change at page 6, line 36
* "refresh_token": The Refresh Token Grant described in OAuth2 * "refresh_token": The Refresh Token Grant described in OAuth2
Section 6. Section 6.
Authorization Servers MAY allow for other values as defined in Authorization Servers MAY allow for other values as defined in
grant type extensions to OAuth2. The extension process is grant type extensions to OAuth2. The extension process is
described in OAuth2 Section 2.5, and the value of this parameter described in OAuth2 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
defined in the extension. defined in the extension.
policy_url policy_uri
OPTIONAL. A URL location that the Client provides to the End-User OPTIONAL. A URL location that the Client provides to the End-User
to read about the how the profile data will be used. The to read about the how the profile data will be used. The
Authorization Server SHOULD display this URL to the End-User if it Authorization Server SHOULD display this URL to the End-User if it
is given. is given.
jwk_url jwk_uri
OPTIONAL. URL for the Client's JSON Web Key [JWK] document that OPTIONAL. URL for the Client's JSON Web Key [JWK] document that
is used for signing requests, such as requests to the Token is used for signing requests, such as requests to the Token
Endpoint using the "private_key_jwt" assertion client credential. Endpoint using the "private_key_jwt" assertion client credential.
If the Client registers both "x509_url" and "jwk_url", the keys If the Client registers both "x509_uri" and "jwk_uri", the keys
contained in both formats MUST be the same. contained in both formats MUST be the same.
jwk_encryption_url jwk_encryption_uri
OPTIONAL. URL for the Client's JSON Web Key [JWK] that the server OPTIONAL. URL for the Client's JSON Web Key [JWK] that the server
can use to encrypt responses to the Client. If the Client can use to encrypt responses to the Client. If the Client
registers both "jwk_encryption_url" and "x509_encryption_url", the registers both "jwk_encryption_uri" and "x509_encryption_uri", the
keys contained in both formats MUST be the same. keys contained in both formats MUST be the same.
x509_url x509_uri
OPTIONAL. URL for the Client's PEM encoded X.509 Certificate or OPTIONAL. URL for the Client's PEM encoded X.509 Certificate or
Certificate chain that is used for signing requests, such as Certificate chain that is used for signing requests, such as
requests to the Token Endpoint using the "private_key_jwt" requests to the Token Endpoint using the "private_key_jwt"
assertion client credential. If the Client registers both assertion client credential. If the Client registers both
"x509_url" and "jwk_url", the keys contained in both formats MUST "x509_uri" and "jwk_uri", the keys contained in both formats MUST
be the same. be the same.
x509_encryption_url x509_encryption_uri
OPTIONAL. URL for the Client's PEM encoded X.509 Certificate or OPTIONAL. URL for the Client's PEM encoded X.509 Certificate or
Certificate chain that the server can use to encrypt responses to Certificate chain that the server can use to encrypt responses to
the Client. If the Client registers both "jwk_encryption_url" and the Client. If the Client registers both "jwk_encryption_uri" and
"x509_encryption_url", the keys contained in both formats MUST be "x509_encryption_uri", the keys contained in both formats MUST be
the same. the same.
3. Client Registration Endpoint 3. Client Registration Endpoint
The Client Registration Endpoint is an OAuth 2.0 Endpoint defined in The Client Registration Endpoint is an OAuth 2.0 Endpoint defined in
this document that is designed to allow a Client to register itself this document that is designed to allow a Client to register itself
with the Authorization Server. The Client Registration Endpoint MUST with the Authorization Server. The Client Registration Endpoint MUST
accept HTTP POST messages with request parameters encoded in the accept HTTP POST messages with request parameters encoded in the
entity body using the "application/json" format. The Client entity body using the "application/json" format. The Client
Registration Endpoint MUST be protected by a transport-layer security Registration Endpoint MUST be protected by a transport-layer security
skipping to change at page 7, line 50 skipping to change at page 7, line 50
In order to support open registration and facilitate wider In order to support open registration and facilitate wider
interoperability, the Client Registration Endpoint SHOULD allow interoperability, the Client Registration Endpoint SHOULD allow
initial registration requests with no authentication. These requests initial registration requests with no authentication. These requests
MAY be rate-limited or otherwise limited to prevent a denial-of- MAY be rate-limited or otherwise limited to prevent a denial-of-
service attack on the Client Registration Endpoint. service attack on the Client Registration Endpoint.
In order to facilitate registered clients updating their information, In order to facilitate registered clients updating their information,
the Client Registration Endpoint issues a Request Access Token for the Client Registration Endpoint issues a Request Access Token for
clients to securely identify themselves in future connections to the clients to securely identify themselves in future connections to the
Client Registration Access Endpoint (Section 4). As such, the Client Client Configuration Endpoint (Section 4). As such, the Client
Registration Access Endpoint MUST accept requests with OAuth 2.0 Configuration Endpoint MUST accept requests with OAuth 2.0 Bearer
Bearer Tokens [RFC6750] for these operations, whether or not the Tokens [RFC6750] for these operations, whether or not the initial
initial registration call requires authentication of some form. registration call requires authentication of some form.
The Client Registration Endpoint MUST ignore all parameters it does The Client Registration Endpoint MUST ignore all parameters it does
not understand. not understand.
3.1. Client Registration Request 3.1. Client Registration Request
This operation registers a new Client to the Authorization Server. This operation registers a new Client to the Authorization Server.
The Authorization Server assigns this client a unique Client The Authorization Server assigns this client a unique Client
Identifier, optionally assigns a Client Secret, and associates the Identifier, optionally assigns a Client Secret, and associates the
metadata given in the request with the issued Client Identifier. The metadata given in the request with the issued Client Identifier. The
skipping to change at page 8, line 44 skipping to change at page 8, line 44
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_url":"https://client.example.org/logo.png", "logo_uri":"https://client.example.org/logo.png",
"jwk_url":"https://client.example.org/my_rsa_public_key.jwk" "jwk_uri":"https://client.example.org/my_rsa_public_key.jwk"
} }
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).
Upon an unsuccessful registration, the Authorization Server responds Upon an unsuccessful registration, the Authorization Server responds
with an error as described in Client Registration Error with an error as described in Client Registration Error
(Section 5.2). (Section 5.2).
4. Client Registration Access Endpoint 4. Client Configuration Endpoint
The Client Registration Access Endpoint is an OAuth 2.0 protected The Client Configuration Endpoint is an OAuth 2.0 protected endpoint
endpoint that is provisioned by the server for a specific client to that is provisioned by the server for a specific client to be able to
be able to view and update its registered information. The Client view and update its registered information. The Client MUST include
MUST include its Registration Access Token in all calls to this its Registration Access Token in all calls to this endpoint as an
endpoint as an OAuth 2.0 Bearer Token [RFC6750]. OAuth 2.0 Bearer Token [RFC6750].
Operations on this endpoint are switched through the use of different Operations on this endpoint are switched through the use of different
HTTP methods [RFC2616]. HTTP methods [RFC2616].
4.1. Forming the Client Registration Access Endpoint URL 4.1. Forming the Client Configuration Endpoint URL
The Authorization Server MUST provide the client with the fully The Authorization Server MUST provide the client with the fully
qualified URL in the "registration_access_url" element of the Client qualified URL in the "registration_client_uri" element of the Client
Information Response (Section 5.1). The Authorization Server MUST Information Response (Section 5.1). The Authorization Server MUST
NOT expect the client to construct or discover this URL on its own. NOT expect the client to construct or discover this URL on its own.
The Client MUST use the URL as given by the server and MUST NOT The Client MUST use the URL as given by the server and MUST NOT
construct this URL from component pieces. construct this URL from component pieces.
Depending on deployment characteristics, the Client Registration Depending on deployment characteristics, the Client Configuration
Access Endpoint URL may take any number of forms. It is RECOMMENDED Endpoint URL may take any number of forms. It is RECOMMENDED that
that this endpoint URL be formed through the use of a server- this endpoint URL be formed through the use of a server-constructed
constructed URL string which combines the Client Registration URL string which combines the Client Registration Endpoint's URL and
Endpoint's URL and the issued client_id for this Client, with the the issued client_id for this Client, with the latter as either a
latter as either a path parameter path parameter or a query parameter. For example, a Client with the
(https://server.example.com/register/client_id) or a query parameter Client ID "s6BhdRkqt3" could be given a Client Configuration Endpoint
(https://server.example.com/register/?update=client_id). These URL of "https://server.example.com/register/s6BhdRkqt3" (path
common patterns can help the Server to more easily determine the parameter) or of
client to which the request pertains, which MUST be matched against "https://server.example.com/register?client_id=s6BhdRkqt3" (query
the client to which the Registration Access Token was issued. If parameter). In both of these cases, the client simply follows the
desired, the server MAY simply return the Client Registration URL as given.
Endpoint URL as the Client Registration Access Endpoint URL and
change behavior based on the authentication context provided by the These common patterns can help the Server to more easily determine
the client to which the request pertains, which MUST be matched
against the client to which the Registration Access Token was issued.
If desired, the server MAY simply return the Client Registration
Endpoint URL as the Client Configuration Endpoint URL and change
behavior based on the authentication context provided by the
Registration Access Token. Registration Access Token.
4.2. Client Read Request 4.2. Client Read Request
In order to read the current configuration of the Client on the In order to read the current configuration of the Client on the
Authorization Server, the Client makes an HTTP GET request to the Authorization Server, the Client makes an HTTP GET request to the
Client Registration Access Endpoint, authenticating with its Client Configuration Endpoint, authenticating with its Registration
Registration Access Token. Access Token.
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):
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 return
an HTTP 404 Not Found. [[ Editor's note: If the client doesn't exist, an HTTP 403 Forbidden.
then the Refresh Access Token shouldn't be valid, making this kind of
error a 403 at the auth layer instead. How best to call this If the Client does not have permission to read its record, the server
inconsistency out? ]] 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.
The Client sends an HTTP PUT to the Client Registration Access The Client sends an HTTP PUT to the Client Configuration Endpoint
Endpoint with a content type of "application/json". The HTTP Entity with a content type of "application/json". The HTTP Entity Payload
Payload is a JSON [RFC4627] document consisting of a JSON object and is a JSON [RFC4627] document consisting of a JSON object and all
all parameters as top- level members of that JSON object. parameters as top- level members of that JSON object.
This request MUST include all fields described in Client Metadata This request MUST include all fields described in Client Metadata
(Section 2) as returned to the Client from a previous register, read, (Section 2) as returned to the Client from a previous register, read,
or update operation. The Client MUST NOT include the or update operation. The Client MUST NOT include the
"registration_access_token", "registration_access_url", "expires_at", "registration_access_token", "registration_client_uri", "expires_at",
or "issued_at" fields described in Client Information Response or "issued_at" fields described in Client Information Response
(Section 5.1). (Section 5.1).
Valid values of Client Metadata fields in this request MUST replace, Valid values of Client Metadata fields in this request MUST replace,
not augment, the values previously associated with this Client. not augment, the values previously associated with this Client.
Omitted fields MUST be treated as null or empty values by the server. Omitted fields MUST be treated as null or empty values by the server.
The Client MUST include its client_id field in the request, and it The Client MUST include its client_id field in the request, and it
MUST be the same as its currently-issued Client Identifier. If the MUST be the same as its currently-issued Client Identifier. If the
client includes its client_secret in the request, then it MUST match client includes its client_secret in the request, then it MUST match
the currently-issued client_secret for that Client. The client MUST the currently-issued client_secret for that Client. The client MUST
NOT be allowed to overwrite its existing client_secret with its own NOT be allowed to overwrite its existing client_secret with its own
value. value.
For all metadata fields, the Authorization Server MAY replace any For all metadata fields, the Authorization Server MAY replace any
skipping to change at page 11, line 32 skipping to change at page 11, line 36
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):
PUT /register/s6BhdRkqt3 HTTP/1.1 PUT /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
{ {
"client_id":"s6BhdRkqt3", "client_id":"s6BhdRkqt3",
"client_secret": "cf136dc3c1fc93f31185e5885805d", "client_secret": "cf136dc3c1fc93f31185e5885805d",
"redirect_uri":["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_type": ["authorization_code", "refresh_token"] "grant_type": ["authorization_code", "refresh_token"]
"token_endpoint_auth_method": "client_secret_basic", "token_endpoint_auth_method": "client_secret_basic",
"jwk_url": "https://client.example.org/my_rsa_public_key.jwk" "jwk_uri": "https://client.example.org/my_rsa_public_key.jwk"
"client_name":"My New Example", "client_name":"My New Example",
"logo_url":"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 "applicaiton/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 return
an HTTP 404 Not Found. [[ Editor's note: If the client doesn't exist, an HTTP 403 Forbidden.
then the Refresh Access Token shouldn't be valid, making this kind of
error a 403 at the auth layer instead. How best to call this
inconsistency out? ]]
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 [[ Editor's note: The utility and nature of this function are still
under active discussion. This is a proposed set of functionality under active discussion. This is a proposed set of functionality
that a server MAY choose to implement, else give a 405 response to that a server MAY choose to implement, else give a 405 response to
any client that tries, if it can't support it. ]] 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 Registration Access 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
Host: server.example.com Host: server.example.com
Authorization: Bearer reg-23410913-abewfq.123483 Authorization: Bearer reg-23410913-abewfq.123483
skipping to change at page 12, line 45 skipping to change at page 12, line 47
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 404 Not If there is no such client, the server responds with an HTTP 403
Found. [[ Editor's note: This is an inconsistent state and shouldn't Forbidden.
happen. See discussion about the Registration Access Token validity
above. ]]
If the client is not allowed to delete itself, the server responds If the client is not allowed to delete itself, the server responds
with HTTP 403 Forbidden. with HTTP 403 Forbidden.
If the server does not support the delete method, it responds with an If the server does not support the delete method, it responds with an
HTTP 405 Not Supported. HTTP 405 Not Supported.
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
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
Registration Endpoint or the Client Registration Access Endpoint as Registration Endpoint or the Client Configuration Endpoint as
described in this specification, the Authorization Server sends the described in this specification, the Authorization Server sends the
following response bodies. following response bodies.
5.1. Client Information Response 5.1. Client Information Response
The response contains the following fields: The response contains the Client Identifier as well as the Client
Secret, if the Client is a confidential Client. The response also
, as well as a Client Secret if this client is a confidential client. contains the fully qualified URL to the Client Configuration Endpoint
The response also contains the fully qualified URL to the Client for this specific client that the client may use to obtain and update
Registration Access Endpoint for this specific client that the client information about itself. The response also contains a Registration
may use to obtain and update information about itself. The response Access Token that is to be used by the client to perform subsequent
also contains a Registration Access Token that is to be used by the operations at the Client Configuration Endpoint.
client to perform subsequent operations at the Client Registration
Access Endpoint.
client_id client_id
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.
skipping to change at page 14, line 13 skipping to change at page 14, line 13
details regarding date/times in general and UTC in particular. details regarding date/times in general and UTC in particular.
issued_at issued_at
OPTIONAL. Specifies the timestamp when the Client Identifier was OPTIONAL. Specifies the timestamp when the Client Identifier was
issued. The timestamp value MUST be a positive integer. The issued. The timestamp value MUST be a positive integer. The
value is expressed in the number of seconds since January 1, 1970 value is expressed in the number of seconds since January 1, 1970
00:00:00 GMT. 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 Registration Access Endpoint. actions on the Client Configuration Endpoint.
registration_access_url registration_client_uri
REQUIRED. The fully qualified URL of the Client Registration REQUIRED. The fully qualified URL of the Client Configuration
Access Endpoint for this client. The Client MUST use this URL as Endpoint for this client. The Client MUST use this URL as given
given when communicating with the Client Registration Access when communicating with the Client Configuration Endpoint.
Endpoint. [[ Editor's note: The syntax for this parameter is still
under active discussion. There have been several alternative
proposals to a flat URL here, including a structure based on HAL
for JSON and a structure based on JSON-LD. ]]
Additionally, the Authorization Server MUST return all registered Additionally, the Authorization Server MUST return all registered
metadata (Section 2) about this client, including any fields metadata (Section 2) about this client, including any fields
provisioned by the Authorization Server itself. The Authorization provisioned by the Authorization Server itself. The Authorization
Server MAY reject or replace any of the client's requested metadata Server MAY reject or replace any of the client's requested metadata
values submitted during the registration or update requests and values submitted during the registration or update requests and
substitute them with suitable values. substitute them with suitable values.
The response is an "application/json" document with all parameters as The response is an "application/json" document with all parameters as
top-level members of a JSON object [RFC4627] . top-level members of a JSON object [RFC4627].
Following is a non-normative example response: Following is a non-normative example response:
HTTP/1.1 200 OK HTTP/1.1 200 OK
Content-Type: application/json Content-Type: application/json
Cache-Control: no-store Cache-Control: no-store
Pragma: no-cache
{ {
"registration_access_token": "reg-23410913-abewfq.123483", "registration_access_token": "reg-23410913-abewfq.123483",
"registration_access_url": "registration_client_uri":
"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_type": ["authorization_code", "refresh_token"] "grant_type": ["authorization_code", "refresh_token"]
"token_endpoint_auth_method": "client_secret_basic", "token_endpoint_auth_method": "client_secret_basic",
"logo_url": "https://client.example.org/logo.png", "logo_uri": "https://client.example.org/logo.png",
"jwk_url": "https://client.example.org/my_rsa_public_key.jwk" "jwk_uri": "https://client.example.org/my_rsa_public_key.jwk"
} }
5.2. Client Registration Error Response 5.2. Client Registration Error Response
When an OAuth error condition occurs, such as the client presenting When an OAuth error condition occurs, such as the client presenting
an invalid Registration Access Token, the Authorization Server an invalid Registration Access Token, the Authorization Server
returns an Error Response as defined in Section 5.2 of the OAuth 2.0 returns an Error Response as defined in Section 5.2 of the OAuth 2.0
specification. specification.
When a registration error condition occurs, the Authorization Server When a registration error condition occurs, the Authorization Server
skipping to change at page 16, line 19 skipping to change at page 15, line 44
any requested parameter of a client's metadata. any requested parameter of a client's metadata.
invalid_client_id invalid_client_id
Value of "client_id" is invalid. Value of "client_id" is invalid.
Following is a non-normative example of an error response (with line Following is a non-normative example of an error response (with line
wraps for display purposes only): wraps for display purposes only):
HTTP/1.1 400 Bad Request HTTP/1.1 400 Bad Request
Content-Type: application/json Content-Type: application/json
Cache-Control: no-store Cache-Control: no-store
Pragma: no-cache
{ {
"error":"invalid_redirect_uri", "error":"invalid_redirect_uri",
"error_description":"The redirect URI of http://sketchy.example.com "error_description":"The redirect URI of http://sketchy.example.com
is not allowed for this server." is not allowed for this server."
} }
6. IANA Considerations 6. IANA Considerations
This document makes no requests of IANA. This document makes no requests of IANA.
skipping to change at page 17, line 21 skipping to change at page 16, line 46
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
and have not been trusted by any users at the Authorization Server and have not been trusted by any users at the Authorization Server
before. before.
In a situation where the Authorization Server is supporting open In a situation where the Authorization Server is supporting open
Client registration, it must be extremely careful with any URL Client registration, it must be extremely careful with any URL
provided by the Client that will be displayed to the user (e.g. provided by the Client that will be displayed to the user (e.g.
"logo_url" and "policy_url"). A rogue Client could specify a "logo_uri" and "policy_uri"). A rogue Client could specify a
registration request with a reference to a drive-by download in the registration request with a reference to a drive-by download in the
"policy_url". The Authorization Server should check to see if the "policy_uri". The Authorization Server should check to see if the
"logo_url" and "policy_url" have the same host as the hosts defined "logo_uri" and "policy_uri" have the same host as the hosts defined
in the array of "redirect_uris". in the array of "redirect_uris".
While the Client Secret can expire, the Registration Access Token While the Client Secret can expire, the Registration Access Token
should not expire while a client is still actively registered. If should not expire while a client is still actively registered. If
this token were to expire, a Client could be left in a situation this token were to expire, a Client could be left in a situation
where it has no means of updating itself and must register itself where it has no means of updating itself and must register itself
anew. As the Registration Access Tokens are long-term credentials, anew. As the Registration Access Tokens are long-term credentials,
and since the Registration Access Token is a Bearer token and acts as and since the Registration Access Token is a Bearer token and acts as
the sole authentication for use at the Client Registration Access the sole authentication for use at the Client Configuration Endpoint,
Endpoint, it MUST be protected by the Client as described in OAuth it MUST be protected by the Client as described in OAuth 2.0 Bearer
2.0 Bearer [RFC6750]. [RFC6750].
If a Client is deprovisioned from a server, any outstanding If a Client is deprovisioned from a server, any outstanding
Registration Access Tokens for that client MUST be invalidated at the Registration Access Tokens for that client MUST be invalidated at the
same time. Otherwise, this can lead to an inconsistent state wherein same time. Otherwise, this can lead to an inconsistent state wherein
a Client could make requests to the Client Registration Access a Client could make requests to the Client Configuration Endpoint
Endpoint where the authentication would succeed but the action would where the authentication would succeed but the action would fail
fail because the Client is no longer valid. because the Client is no longer valid.
8. Normative References 8. Normative References
[JWK] Jones, M., "JSON Web Key (JWK)", May 2012. [JWK] Jones, M., "JSON Web Key (JWK)", May 2012.
[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.
skipping to change at page 18, line 45 skipping to change at page 18, line 23
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. 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 ]]
-07
o Changed registration_access_url to registration_client_uri
o Fixed missing text in 5.1
o Added Pragma: no-cache to examples
o Changed "no such client" error to 403
o Renamed Client Registration Access Endpoint to Client
Configuration Endpoint
o Changed all the parameter names containing "_url" to instead use
"_uri"
o Updated example text for forming Client Configuration Endpoint URL
-06 -06
o Removed secret_rotation as a client-initiated action, including o Removed secret_rotation as a client-initiated action, including
removing client secret rotation endpoint and parameters. removing client secret rotation endpoint and parameters.
o Changed _links structure to single value registration_access_url. o Changed _links structure to single value registration_access_url.
o Collapsed create/update/read responses into client info response. o Collapsed create/update/read responses into client info response.
o Changed return code of create action to 201. o Changed return code of create action to 201.
 End of changes. 53 change blocks. 
110 lines changed or deleted 124 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/