draft-ietf-oauth-dyn-reg-03.txt   draft-ietf-oauth-dyn-reg-04.txt 
Network Working Group J. Richer, Ed. Network 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: June 14, 2013 Ping Identity Expires: July 11, 2013 Ping Identity
M. Jones M. Jones
Microsoft Microsoft
M. Machulak M. Machulak
Newcastle University Newcastle University
December 11, 2012 January 7, 2013
OAuth Dynamic Client Registration Protocol OAuth Dynamic Client Registration Protocol
draft-ietf-oauth-dyn-reg-03 draft-ietf-oauth-dyn-reg-04
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 June 14, 2013. This Internet-Draft will expire on July 11, 2013.
Copyright Notice Copyright Notice
Copyright (c) 2012 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
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
skipping to change at page 2, line 27 skipping to change at page 2, line 27
1.3.3. The authorization server should have the option of 1.3.3. The authorization server should have the option of
strongly authenticating the client and its metadata . 4 strongly authenticating the client and its metadata . 4
1.3.4. Dynamic client registration must be possible from 1.3.4. Dynamic client registration must be possible from
both web-server applications and applications with both web-server applications and applications with
other capabilities and limitations, such as native other capabilities and limitations, such as native
applications . . . . . . . . . . . . . . . . . . . . . 4 applications . . . . . . . . . . . . . . . . . . . . . 4
1.3.5. Transaction integrity must be ensured . . . . . . . . 5 1.3.5. Transaction integrity must be ensured . . . . . . . . 5
2. Client Metadata . . . . . . . . . . . . . . . . . . . . . . . 5 2. Client Metadata . . . . . . . . . . . . . . . . . . . . . . . 5
3. Client Registration Endpoint . . . . . . . . . . . . . . . . . 8 3. Client Registration Endpoint . . . . . . . . . . . . . . . . . 8
3.1. Client Registration Request . . . . . . . . . . . . . . . 9 3.1. Client Registration Request . . . . . . . . . . . . . . . 9
3.2. Client Registration Response . . . . . . . . . . . . . . . 11 3.2. Client Registration Response . . . . . . . . . . . . . . . 10
3.3. Client Update Request . . . . . . . . . . . . . . . . . . 12 3.3. Client Update Request . . . . . . . . . . . . . . . . . . 11
3.4. Client Update Response . . . . . . . . . . . . . . . . . . 13 3.4. Client Update Response . . . . . . . . . . . . . . . . . . 13
3.5. Rotate Secret Request . . . . . . . . . . . . . . . . . . 14 3.5. Rotate Secret Request . . . . . . . . . . . . . . . . . . 13
3.6. Rotate Secret Response . . . . . . . . . . . . . . . . . . 14 3.6. Rotate Secret Response . . . . . . . . . . . . . . . . . . 14
3.7. Client Registration Error Response . . . . . . . . . . . . 15 3.7. Client Registration Error Response . . . . . . . . . . . . 15
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 16 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 16
5. Security Considerations . . . . . . . . . . . . . . . . . . . 16 5. Security Considerations . . . . . . . . . . . . . . . . . . . 16
6. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 18 6. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 17
7. Document History . . . . . . . . . . . . . . . . . . . . . . . 18 7. Document History . . . . . . . . . . . . . . . . . . . . . . . 17
8. Normative References . . . . . . . . . . . . . . . . . . . . . 18 8. Normative References . . . . . . . . . . . . . . . . . . . . . 18
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 20 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 19
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 before hand.
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
skipping to change at page 6, line 11 skipping to change at page 6, line 11
responsible for this client. The Authorization Server MAY may responsible for this client. The Authorization Server MAY may
these addresses available to end users for support queries. An these addresses available to end users for support queries. 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_url
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_type
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
* "client_secret_post": the client uses the HTTP POST parameters * "client_secret_post": the client uses the HTTP POST parameters
defined in OAuth2.0 section 2.3.1 defined in OAuth2.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 profile
with a symmetric secret issued by the server with a symmetric secret issued by the server
* "private_key_jwt": the client uses the JWT Assertion profile * "private_key_jwt": the client uses the JWT Assertion profile
with its own private key with its own private key
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" HTTP unspecified or omitted, the default is "client_secret_basic",
Basic Authentication Scheme as specified in Section 2.3.1 of OAuth denoting HTTP Basic Authentication Scheme as specified in Section
2.0 [RFC6749]. 2.3.1 of OAuth 2.0.
scope scope
OPTIONAL. Space separated list of scopes that the client is OPTIONAL. Space separated list of scopes that the client will be
allowed to request tokens for. If omitted, an Authorization allowed to request tokens for. If omitted, an Authorization
Server MAY register a Client with a default set of allowed scopes. Server MAY register a Client with a default set of allowed scopes.
grant_type grant_type
OPTIONAL. Space separated list of grant types that a client may OPTIONAL. Space separated list of grant types that a client may
use. These grant types are defined as follows: use. These grant types are defined as follows:
* "authorization_code": The Authorization Code Grant described in * "authorization_code": The Authorization Code Grant described in
OAuth2 Section 4.1. OAuth2 Section 4.1.
skipping to change at page 7, line 25 skipping to change at page 7, line 25
in the extension. in the extension.
policy_url policy_url
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_url
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 Token Endpoint Requests. If is used for signing requests, such as requests to the Token
jwk_encryption_url is not provided, the key at jwk_url is also Endpoint using the "private_key_jwt" assertion client credential.
used as the key to encrypt responses to the Client. If the Client If the Client registers both "x509_url" and "jwk_url", the keys
registers both "x509_url" and "jwk_url", the keys contained in contained in both formats MUST be the same.
both formats MUST be the same.
jwk_encryption_url jwk_encryption_url
OPTIONAL. URL for the Client's JSON Web Key [JWK] that is used to OPTIONAL. URL for the Client's JSON Web Key [JWK] that the server
encrypt any responses to the Client. If the Client registers both can use to encrypt responses to the Client. If the Client
"jwk_encryption_url" and "x509_encryption_url", the keys contained registers both "jwk_encryption_url" and "x509_encryption_url", the
in both formats MUST be the same. keys contained in both formats MUST be the same.
x509_url x509_url
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 Token Endpoint Certificate chain that is used for signing requests, such as
Requests. If "x509_encryption_url" is not provided, "x509_url" it requests to the Token Endpoint using the "private_key_jwt"
is also used to encrypt responses to the Client. If the Client assertion client credential. If the Client registers both
registers both "x509_url" and "jwk_url", the keys contained in "x509_url" and "jwk_url", the keys contained in both formats MUST
both formats MUST be the same. be the same.
x509_encryption_url x509_encryption_url
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 to encrypt the ID Token and User Certificate chain that the server can use to encrypt responses to
Info Endpoint Responses to the Client. If the Client registers the Client. If the Client registers both "jwk_encryption_url" and
both "jwk_encryption_url" and "x509_encryption_url", the keys "x509_encryption_url", the keys contained in both formats SHOULD
contained in both formats SHOULD be the same. be the same.
default_max_age
OPTIONAL. Maximum age of a session in integer seconds. Specifies
that the End-User must be actively authenticated if any present
authentication is older than the specified number of seconds by
default.
default_acr
OPTIONAL. Default Authentication Context class Reference. String
that specifies the default authentication context value that the
Authorization server must use for processing requests from this
client.
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/x-www-form-urlencoded" format. entity body using the "application/x-www-form-urlencoded" format.
The Client Registration Endpoint MUST be protected by a transport- The Client Registration Endpoint MUST be protected by a transport-
layer security mechanism when sending requests to the Registration layer security mechanism, and the server MUST support TLS 1.2 RFC
Endpoint. The server MUST support TLS 1.2 RFC 5246 [RFC5246] and/or 5246 [RFC5246] and/or TLS 1.0 [RFC2246] and MAY support additional
TLS 1.0 [RFC2246] and MAY support additional transport-layer transport-layer mechanisms meeting its security requirements. When
mechanisms meeting its security requirements. When using TLS, the using TLS, the Client MUST perform a TLS/SSL server certificate
Client MUST perform a TLS/SSL server certificate check, per RFC 6125 check, per RFC 6125 [RFC6125].
[RFC6125].
The Endpoint defines three operations that a client can take on it, The Endpoint defines three operations that a client can take on it,
switched by the "operation" parameter: switched by the "operation" parameter:
o "client_register": request that the Authorization Server generate o "client_register": request that the Authorization Server generate
a new Client Identifier (and optionally a Client Secret) and a new Client Identifier (and optionally a Client Secret) and
associate it with the set of presented metadata (Section 2) associate it with the set of presented metadata (Section 2)
o "client_update": update the metadata (Section 2) associated with a o "client_update": update the metadata (Section 2) associated with a
Client Identifier Client Identifier
o "rotate_secret": issue a new Registration Access Token and, if o "rotate_secret": requst a new Registration Access Token and, if
applicable, a Client Secret for a Client applicable, a Client Secret for a Client
The Client Registration Endpoint MAY accept an initial authorization The Client Registration Endpoint MAY accept an initial authorization
credential in the form of an OAuth 2.0 [RFC6749] access token in credential in the form of an OAuth 2.0 [RFC6749] access token in
order to limit registration to only previously authorized parties. order to limit registration to only previously authorized parties.
The method by which this access token is obtained by the registrant The method by which this access token is obtained by the registrant
is generally out-of-band and is out of scope of this specification. is generally out-of-band and is out of scope of this specification.
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
skipping to change at page 9, line 20 skipping to change at page 9, line 6
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. As clients to securely identify themselves in future connections. As
such, the Endpoint MUST accept requests with OAuth 2.0 Bearer Tokens such, the Endpoint MUST accept requests with OAuth 2.0 Bearer Tokens
[RFC6750] for these operations, whether or not the initial [RFC6750] for these operations, whether or not the initial
"client_register" call requires authentication of some form. "client_register" call requires authentication of some form.
These two aspects, operation selection and client authentication, are These two aspects, operation selection and client authentication, are
represented by two parameters common to all operations: represented by two parameters common to all operations:
operation operation
REQUIRED. Values are: REQUIRED. Valid values are "client_register", "rotate_secret",
and "client_update", as described above.
* "client_register": Register a new client, receive a Client
Identifier, and associate metadata with it.
* "rotate_secret": Request rotation of the Registration Access
Token and, if applicable, the Client Secret
* "client_update": Update the metadata associated with a given
Client Identifier.
access_token access_token
OPTIONAL. An OAuth2 Bearer token used to access the Client OPTIONAL. An OAuth2 Bearer token used to access the Client
Registration Endpoint, as defined in OAuth2 Bearer. This Registration Endpoint, as defined in OAuth2 Bearer [RFC6750].
parameter MUST NOT be sent if the Access Token is sent in the HTTP This parameter MUST NOT be sent if the Access Token is sent in the
Authorization header as described in Section 7.1 of OAuth 2.0 HTTP Authorization header as described in Section 7.1 of OAuth 2.0
[RFC6749]. Access Tokens sent in the authorization header must be [RFC6749]. Access Tokens sent in the authorization header must be
OAuth 2.0 Bearer Tokens [RFC6750]. OAuth 2.0 Bearer Tokens [RFC6750].
Each operation takes a different parameter set, and all operations Each operation takes a different parameter set, and all operations
are described below. are described below.
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
skipping to change at page 10, line 11 skipping to change at page 9, line 37
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
request includes the two parameters described above as well as any request includes the two parameters described above as well as any
parameters described in Client Metadata (Section 2). The parameters described in Client Metadata (Section 2). The
Authorization Server MAY provision default values for any items Authorization Server MAY provision default values for any items
omitted in the Client Metadata. omitted in the Client Metadata.
operation operation
REQUIRED. MUST have the value "client_register" REQUIRED. MUST have the value "client_register"
access_token access_token
OPTIONAL. Used to restrict new client registration. This OPTIONAL. OAuth2 Access token used to restrict new client
parameter MUST NOT be sent if the Access Token is sent in the HTTP registration. This parameter MUST NOT be sent if the Access Token
Authorization header as described in Section 7.1 of OAuth 2.0 is sent in the HTTP Authorization header as described in Section
[RFC6749]. Access Tokens sent in the authorization header must be 7.1 of OAuth 2.0 [RFC6749]. Access Tokens sent in the
OAuth 2.0 Bearer Tokens [RFC6750]. authorization header must be OAuth 2.0 Bearer Tokens [RFC6750].
redirect_uris RECOMMENDED redirect_uris RECOMMENDED
client_name RECOMMENDED client_name RECOMMENDED
client_url RECOMMENDED client_url RECOMMENDED
logo_url OPTIONAL logo_url OPTIONAL
contacts OPTIONAL contacts OPTIONAL
tos_url OPTIONAL tos_url OPTIONAL
token_endpoint_auth_method OPTIONAL token_endpoint_auth_type OPTIONAL
policy_url OPTIONAL policy_url OPTIONAL
scope OPTIONAL scope OPTIONAL
grant_type OPTIONAL grant_type OPTIONAL
jwk_url OPTIONAL jwk_url OPTIONAL
jwk_encryption_url OPTIONAL jwk_encryption_url OPTIONAL
x509_url OPTIONAL x509_url OPTIONAL
x509_encryption_url OPTIONAL x509_encryption_url OPTIONAL
default_max_age OPTIONAL
default_acr OPTIONAL
For example, a client could send the following registration request For example, a client could send the following registration request
to the Client Registration Endpoint: 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
Accept: application/x-www-form-urlencoded Accept: application/x-www-form-urlencoded
Host: server.example.com Host: server.example.com
operation=client_register operation=client_register
&redirect_uris=https://client.example.org/callback &redirect_uris=https://client.example.org/callback
%20https://client.example.org/callback2 %20https://client.example.org/callback2
&client_name=My%20Example%20Client &client_name=My%20Example%20Client
&token_endpoint_auth_method=client_secret_basic%20client_secret_post &token_endpoint_auth_type=client_secret_basic%20client_secret_post
&scope=read%20write%20dolphin &scope=read%20write%20dolphin
&logo_url=https://client.example.org/logo.png &logo_url=https://client.example.org/logo.png
&jwk_url=https://client.example.org/my_rsa_public_key.jwk &jwk_url=https://client.example.org/my_rsa_public_key.jwk
3.2. Client Registration Response 3.2. Client Registration Response
Upon successful registration, the Client Registration Endpoint Upon successful registration, the Client Registration Endpoint
returns the newly-created Client Identifier and, if applicable, a returns the newly-created Client Identifier and, if applicable, a
Client Secret, along with all registered metadata (Section 2) about Client Secret, along with all registered metadata (Section 2) about
this client, including any fields provisioned by the Authorization this client, including any fields provisioned by the Authorization
Server itself. The Authorization Server MAY reject or replace any of Server itself. The Authorization Server MAY reject or replace any of
the client's requested field values and substitute them with suitable the client's requested field values and substitute them with suitable
values. If this happens, the Authorization Server MUST include these values. If this happens, the Authorization Server MUST include these
fields in the response to the client. fields in the response to the client.
The response also contains a Registration Access Token that is to be The response also contains a Registration Access Token that is to be
used by the client to perform subsequent operations at this endpoint, used by the client to perform subsequent operations at this endpoint,
such as "client_update" and "rotate_secret". such as "client_update" and "rotate_secret".
All of the response items are returned as a JSON document with the All of the response items are returned as a JSON document [RFC4627]
following fields as top-level members of the root JSON object. with the following fields as top-level members of the root JSON
object.
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. This MUST be unique for each OPTIONAL. The Client secret. This MUST be unique for each
"client_id". This value is used by confidential clients to "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 12, line 6 skipping to change at page 11, line 32
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.
expires_at expires_at
OPTIONAL. The number of seconds from 1970-01-01T0:0:0Z as OPTIONAL. The number of seconds from 1970-01-01T0:0:0Z as
measured in UTC that the "client_secret" will expire or "0" if measured in UTC that the "client_secret" will expire or "0" if
they do not expire. See RFC 3339 [RFC3339] for details regarding they do not expire. See RFC 3339 [RFC3339] for details regarding
date/times in general and UTC in particular. date/times in general and UTC in particular.
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
{ {
"client_id":"s6BhdRkqt3", "client_id":"s6BhdRkqt3",
"client_secret": "cf136dc3c1fc93f31185e5885805d", "client_secret": "cf136dc3c1fc93f31185e5885805d",
"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 client_secret_post", "token_endpoint_auth_type": "client_secret_basic client_secret_post",
"logo_url": "https://client.example.org/logo.png", "logo_url": "https://client.example.org/logo.png",
"jwk_url": "https://client.example.org/my_rsa_public_key.jwk", "jwk_url": "https://client.example.org/my_rsa_public_key.jwk",
"registration_access_token": "reg-23410913-abewfq.123483", "registration_access_token": "reg-23410913-abewfq.123483",
"expires_at":2893276800 "expires_at":2893276800
} }
3.3. Client Update Request 3.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 MUST be protected metadata at the Authorization Server. This request MUST be protected
by the Registration Authorization Token associated with the Client. by the Registration Authorization Token associated with the Client.
This request MAY include any fields described in Client Metadata This request MAY include any fields described in Client Metadata
(Section 2). If included in the request, valid values of Client (Section 2). If included in the request, valid values of Client
Metadata fields in this request MUST replace, not augment, the values Metadata fields in this request MUST replace, not augment, the values
previously associated with this Client. Empty values in Client previously associated with this Client. Empty values in Client
Metadata MUST be taken as a request to clear any existing value of Metadata MUST be taken as a request to clear any existing value of
that field. Omitted values in the Client Metadata MUST remain that field. Omitted values in the Client Metadata MUST remain
unchanged by the Authorization Server. The Authorization Server MAY unchanged by the Authorization Server. The Authorization Server MAY
replace any invalid values with suitable values. replace any invalid values with suitable values.
operation operation
skipping to change at page 13, line 4 skipping to change at page 12, line 27
REQUIRED, unless presented in the Authorization Header as in REQUIRED, unless presented in the Authorization Header as in
OAuth2 Bearer [RFC6750]. The Registration Access Token that was OAuth2 Bearer [RFC6750]. The Registration Access Token that was
issued during the "client_register" step, or previous issued during the "client_register" step, or previous
"client_update" or "rotate_secret" calls. "client_update" or "rotate_secret" calls.
redirect_uris RECOMMENDED redirect_uris RECOMMENDED
client_name RECOMMENDED client_name RECOMMENDED
client_url RECOMMENDED client_url RECOMMENDED
logo_url OPTIONAL logo_url OPTIONAL
contacts OPTIONAL contacts OPTIONAL
tos_url OPTIONAL tos_url OPTIONAL
token_endpoint_auth_method OPTIONAL token_endpoint_auth_type OPTIONAL
policy_url OPTIONAL policy_url OPTIONAL
jwk_url OPTIONAL jwk_url OPTIONAL
jwk_encryption_url OPTIONAL jwk_encryption_url OPTIONAL
x509_url OPTIONAL x509_url OPTIONAL
x509_encryption_url OPTIONAL x509_encryption_url OPTIONAL
default_max_age OPTIONAL
default_acr OPTIONAL
For example, a client could send the following request to the Client For example, a client could send the following request to the Client
Registration Endpoint to update the client registration in the above Registration Endpoint to update the client registration in the above
example: example:
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
Accept: application/x-www-form-urlencoded Accept: application/x-www-form-urlencoded
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 13, line 42 skipping to change at page 13, line 18
Client ID, along with all current registered metadata (Section 2) Client ID, along with all current registered metadata (Section 2)
about this client, including any fields provisioned by the about this client, including any fields provisioned by the
Authorization Server itself. The Authorization Server MAY reject or Authorization Server itself. The Authorization Server MAY reject or
replace any of the client's requested field values and substitute replace any of the client's requested field values and substitute
them suitable values. If this happens, the Authorization Server MUST them suitable values. If this happens, the Authorization Server MUST
include these fields in the response to the client. include these fields in the response to the client.
The Authorization Server MUST NOT include the Client Secret or The Authorization Server MUST NOT include the Client Secret or
Request Access Token in this response. Request Access Token in this response.
These fields are returned as top-level members of the root JSON These fields are returned in a JSON Document [RFC4627] as top-level
object. members of the root JSON object.
client_id client_id
REQUIRED. The unique Client identifier, MUST equal the value of REQUIRED. The unique Client identifier, MUST equal the value of
the client_id returned in the original client_register request. the client_id returned in the original client_register request.
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
{ {
"client_id": "s6BhdRkqt3", "client_id": "s6BhdRkqt3",
"client_name": "My New Example", "client_name": "My New Example",
"redirect_uri": "redirect_uri":
"https://client.example.org/callback https://client.example.org/alt" "https://client.example.org/callback 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 client_secret_post", "token_endpoint_auth_type": "client_secret_basic client_secret_post",
"logo_url": "https://client.example.org/newlogo.png", "logo_url": "https://client.example.org/newlogo.png",
"jwk_url": "https://client.example.org/my_rsa_public_key.jwk", "jwk_url": "https://client.example.org/my_rsa_public_key.jwk",
} }
3.5. Rotate Secret Request 3.5. Rotate Secret Request
This operation allows the client to rotate its current Registration This operation allows the client to rotate its current Registration
Access Token as well as its Client Secret, if it has one. Access Token as well as its Client Secret, if it has one.
operation operation
REQUIRED. MUST have the value rotate_secret REQUIRED. MUST have the value rotate_secret
access_token access_token
skipping to change at page 14, line 49 skipping to change at page 14, line 24
Accept: application/x-www-form-urlencoded Accept: application/x-www-form-urlencoded
Host: server.example.com Host: server.example.com
Authorization: Bearer reg-23410913-abewfq.123483 Authorization: Bearer reg-23410913-abewfq.123483
operation=rotate_secret operation=rotate_secret
3.6. Rotate Secret Response 3.6. Rotate Secret Response
Upon successful rotation of the Registration Access Token, and Upon successful rotation of the Registration Access Token, and
optionally the Client Secret, the Client Registration Endpoint optionally the Client Secret, the Client Registration Endpoint
returns a JSON document with the following fields as top-level returns a JSON document [RFC4627] with the following fields as top-
members of the root JSON object. This response MUST NOT include any level members of the root JSON object. This response MUST NOT
other client metadata. include any other client metadata.
client_id client_id
REQUIRED. The unique Client identifier, MUST match the client_id REQUIRED. The unique Client identifier, MUST match the client_id
issued in the original client_register request. issued in the original client_register request.
client_secret client_secret
REQUIRED if the server initially issued this Client a Client REQUIRED if the server initially issued this Client a Client
Secret, otherwise the server MUST NOT return a value. The value Secret, otherwise the server MUST NOT return a value. The value
MUST be unique for each "client_id". MUST be unique for each "client_id".
skipping to change at page 16, line 5 skipping to change at page 15, line 29
successful completion of this request. successful completion of this request.
3.7. Client Registration Error Response 3.7. Client Registration Error Response
When an OAuth error condition occurs, the Client Registration When an OAuth error condition occurs, the Client Registration
Endpoint returns an Error Response as defined in Section 5.2 of the Endpoint 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 Client Registration When a registration error condition occurs, the Client Registration
Endpoint returns a HTTP 400 status code including a JSON object Endpoint returns a HTTP 400 status code including a JSON object
describing the error in the response body. [RFC4627] describing the error in the response body.
The JSON object contains two members: The JSON object contains two members:
error error
The error code, a single ASCII string. The error code, a single ASCII string.
error_description error_description
The additional text description of the error for debugging. The additional text description of the error for debugging.
This specification defines the following error codes: This specification defines the following error codes:
skipping to change at page 18, line 19 skipping to change at page 17, line 41
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: Torsten Lodderstedt, Eve Maler, to various versions of this document: Torsten Lodderstedt, Eve Maler,
Thomas Hardjono, Christian Scholz, Nat Sakimura, George Fletcher, Thomas Hardjono, Christian Scholz, Nat Sakimura, George Fletcher,
Amanda Anganes, and Domenico Catalano. Amanda Anganes, and Domenico Catalano.
7. Document History 7. Document History
[[ to be removed by RFC editor before publication as an RFC ]] [[ to be removed by RFC editor before publication as an RFC ]]
- 04
o removed default_acr, too undefined in the general OAuth2 case
o removed default_max_auth_age, since there's no mechanism for
supplying a non-default max_auth_age in OAuth2
o clarified signing and encryption URLs
o changed token_endpoint_auth_method to token_endpoint_auth_type to
match OIDC
- 03
o added scope and grant_type claims
o fixed various typos and changed wording for better clarity
o endpoint now returns the full set of client information
o operations on client_update allow for three actions on metadata:
leave existing value, clear existing value, replace existing value
with new value
- 02 - 02
o Reorganized contributors and references o Reorganized contributors and references
o Moved OAuth references to RFC o Moved OAuth references to RFC
o Reorganized model/protocol sections for clarity o Reorganized model/protocol sections for clarity
o Changed terminology to "client register" instead of "client o Changed terminology to "client register" instead of "client
associate" associate"
skipping to change at page 18, line 48 skipping to change at page 18, line 48
o Changed to form-paramter inputs to endpoint o Changed to form-paramter inputs to endpoint
o Removed pull-based registration o Removed pull-based registration
- 00 - 00
o Imported original UMA draft specification o Imported original UMA draft specification
8. Normative References 8. Normative References
[JWA] Jones, M., "JSON Web Algorithms", May 2012.
[JWE] Jones, M., Rescorla, E., and J. Hildebrand, "JSON Web
Encryption (JWE)", May 2012.
[JWK] Jones, M., "JSON Web Key (JWK)", May 2012. [JWK] Jones, M., "JSON Web Key (JWK)", May 2012.
[JWS] Jones, M., Bradley, J., and N. Sakimura, "JSON Web
Signature", May 2012.
[JWT] Jones, M., Bradley, J., and N. Sakimura, "JSON Web Token",
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.
[RFC2617] Franks, J., Hallam-Baker, P., Hostetler, J., Lawrence, S.,
Leach, P., Luotonen, A., and L. Stewart, "HTTP
Authentication: Basic and Digest Access Authentication",
RFC 2617, June 1999.
[RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the [RFC3339] Klyne, G., Ed. and C. Newman, "Date and Time on the
Internet: Timestamps", RFC 3339, July 2002. 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.
[RFC5785] Nottingham, M. and E. Hammer-Lahav, "Defining Well-Known
Uniform Resource Identifiers (URIs)", RFC 5785,
April 2010.
[RFC6125] Saint-Andre, P. and J. Hodges, "Representation and [RFC6125] Saint-Andre, P. and J. Hodges, "Representation and
Verification of Domain-Based Application Service Identity Verification of Domain-Based Application Service Identity
within Internet Public Key Infrastructure Using X.509 within Internet Public Key Infrastructure Using X.509
(PKIX) Certificates in the Context of Transport Layer (PKIX) Certificates in the Context of Transport Layer
Security (TLS)", RFC 6125, March 2011. Security (TLS)", RFC 6125, March 2011.
[RFC6749] Hardt, D., "The OAuth 2.0 Authorization Framework", [RFC6749] Hardt, D., "The OAuth 2.0 Authorization Framework",
RFC 6749, October 2012. RFC 6749, October 2012.
[RFC6750] Jones, M. and D. Hardt, "The OAuth 2.0 Authorization [RFC6750] Jones, M. and D. Hardt, "The OAuth 2.0 Authorization
 End of changes. 40 change blocks. 
134 lines changed or deleted 113 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/