draft-ietf-oauth-dyn-reg-02.txt   draft-ietf-oauth-dyn-reg-03.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: May 31, 2013 Ping Identity Expires: June 14, 2013 Ping Identity
M. Jones M. Jones
Microsoft Microsoft
M. Machulak M. Machulak
Newcastle University Newcastle University
November 27, 2012 December 11, 2012
OAuth Dynamic Client Registration Protocol OAuth Dynamic Client Registration Protocol
draft-ietf-oauth-dyn-reg-02 draft-ietf-oauth-dyn-reg-03
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 Authorizaiton 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.
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 May 31, 2013. This Internet-Draft will expire on June 14, 2013.
Copyright Notice Copyright Notice
Copyright (c) 2012 IETF Trust and the persons identified as the Copyright (c) 2012 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 25 skipping to change at page 2, line 25
1.3.2. The authorization server must collect metadata 1.3.2. The authorization server must collect metadata
about a client for later user interaction . . . . . . 4 about a client for later user interaction . . . . . . 4
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 . . . . . . . . . . . . . . . . . 7 3. Client Registration Endpoint . . . . . . . . . . . . . . . . . 8
3.1. Client Registration Request . . . . . . . . . . . . . . . 9 3.1. Client Registration Request . . . . . . . . . . . . . . . 9
3.2. Client Registration Response . . . . . . . . . . . . . . . 10 3.2. Client Registration Response . . . . . . . . . . . . . . . 11
3.3. Client Update Request . . . . . . . . . . . . . . . . . . 11 3.3. Client Update Request . . . . . . . . . . . . . . . . . . 12
3.4. Client Update Response . . . . . . . . . . . . . . . . . . 12 3.4. Client Update Response . . . . . . . . . . . . . . . . . . 13
3.5. Rotate Secret Request . . . . . . . . . . . . . . . . . . 12 3.5. Rotate Secret Request . . . . . . . . . . . . . . . . . . 14
3.6. Rotate Secret Response . . . . . . . . . . . . . . . . . . 13 3.6. Rotate Secret Response . . . . . . . . . . . . . . . . . . 14
3.7. Client Registration Error Response . . . . . . . . . . . . 14 3.7. Client Registration Error Response . . . . . . . . . . . . 15
4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 15 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 16
5. Security Considerations . . . . . . . . . . . . . . . . . . . 15 5. Security Considerations . . . . . . . . . . . . . . . . . . . 16
6. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 16 6. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 18
7. Document History . . . . . . . . . . . . . . . . . . . . . . . 16 7. Document History . . . . . . . . . . . . . . . . . . . . . . . 18
8. Normative References . . . . . . . . . . . . . . . . . . . . . 17 8. Normative References . . . . . . . . . . . . . . . . . . . . . 18
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 18 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 the two parties having previously interacted. server without requiring the two parties to interact before hand.
Nevertheless, in order for the authorization server to accurately Nevertheless, in order for the authorization server to accurately and
represent to end-users which client is seeking authorization to securely represent to end-users which client is seeking authorization
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
optionally a Client Secret. optionally a Client Secret.
As part of the registration process, this specification also defines As part of the registration process, this specification also defines
skipping to change at page 3, line 43 skipping to change at page 3, line 43
Unless otherwise noted, all the protocol parameter names and values Unless otherwise noted, all the protocol parameter names and values
are case sensitive. are case sensitive.
1.2. Terminology 1.2. Terminology
This specification uses the terms "Access Token", "Refresh Token", This specification uses the terms "Access Token", "Refresh Token",
"Authorization Code", "Authorization Grant", "Authorization Server", "Authorization Code", "Authorization Grant", "Authorization Server",
"Authorization Endpoint", "Client", "Client Identifier", "Client "Authorization Endpoint", "Client", "Client Identifier", "Client
Secret", "Protected Resource", "Resource Owner", "Resource Server", Secret", "Protected Resource", "Resource Owner", "Resource Server",
and "Token Endpoint" defined by OAuth 2.0 [RFC6750]. 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 and manage the metadata a Client can request new registration and manage the metadata
associated with it. associated with it.
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 update which is used by the Client to authenticate itself during update
skipping to change at page 5, line 27 skipping to change at page 5, line 27
range from human-facing display strings, such as a client name, to range from human-facing display strings, such as a client name, to
items that impact the security of the protocol, such as the list of items that impact the security of the protocol, such as the list of
valid redirect URIs. valid redirect URIs.
Extensions and profiles of this specification MAY expand this list, Extensions and profiles of this specification MAY expand this list,
but MUST at least accept all parameters on this list. The but MUST at least accept all parameters on this list. The
Authorization Server MUST ignore any additional parameters sent by Authorization Server MUST ignore any additional parameters sent by
the Client that it does not understand. the Client that it does not understand.
redirect_uris redirect_uris
REQUIRED A space-delimited list of redirect URIs. RECOMMENDED. A space-delimited list of redirect URIs for use in
the Authorization Code and Implicit grant types. An Authorization
Server SHOULD require registration of valid redirect URIs for all
clients to protect against token and 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. the user. If omitted, the Authorization Server MAY display to the
user the raw client_id value instead.
client_url client_url
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. server SHOULD display this URL to the end user in a clickable
fashion.
logo_url logo_url
OPTIONAL. URL that references a logo for the Client application. OPTIONAL. URL that references a logo for the Client application.
If present, the server SHOULD display this image to the end user If present, the server SHOULD display this image to the end user
during approval. during approval.
contacts contacts
OPTIONAL. Space delimited list of email addresses for people OPTIONAL. Space delimited list of email addresses for people
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
skipping to change at page 6, line 14 skipping to change at page 6, line 15
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_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 does * "none": this is a public client as defined in OAuth 2.0 and
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 semetric 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" HTTP
Basic Authentication Scheme as specified in Section 2.3.1 of OAuth Basic Authentication Scheme as specified in Section 2.3.1 of OAuth
2.0 [RFC6749]. 2.0 [RFC6749].
scope
OPTIONAL. Space separated list of scopes that the client is
allowed to request tokens for. If omitted, an Authorization
Server MAY register a Client with a default set of allowed scopes.
grant_type
OPTIONAL. Space separated list of grant types that a client may
use. These grant types are defined as follows:
* "authorization_code": The Authorization Code Grant described in
OAuth2 Section 4.1.
* "implicit": The Implicit Grant described in OAuth2 Section 4.2.
* "password": The Resource Owner Password Credentials Grant
described in OAuth2 Section 4.3
* "client_credentials": The Client Credentials Grant described in
OAuth2 Section 4.4
* "refresh_token": The Refresh Token Grant described in OAuth2
Section 6.
Authorization Servers MAY allow for other values as defined in
grant type extensions to OAuth2. The extension process is
described in OAuth2 Section 2.5, and the value of this parameter
MUST be the same as the value of the grant_type parameter defined
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 Token Endpoint Requests. If
jwk_encryption_url is not provided, the key at jwk_url is also jwk_encryption_url is not provided, the key at jwk_url is also
skipping to change at page 8, line 5 skipping to change at page 8, line 35
layer security mechanism when sending requests to the Registration layer security mechanism when sending requests to the Registration
Endpoint. The server MUST support TLS 1.2 RFC 5246 [RFC5246] and/or Endpoint. The server MUST support TLS 1.2 RFC 5246 [RFC5246] and/or
TLS 1.0 [RFC2246] and MAY support additional transport-layer TLS 1.0 [RFC2246] and MAY support additional transport-layer
mechanisms meeting its security requirements. When using TLS, the mechanisms meeting its security requirements. When using TLS, the
Client MUST perform a TLS/SSL server certificate check, per RFC 6125 Client MUST perform a TLS/SSL server certificate check, per RFC 6125
[RFC6125]. [RFC6125].
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 a o "client_register": request that the Authorization Server generate
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": issue a new Registration Access Token and, if
applicable, a Client Secret for a Client applicable, a Client Secret for a Client
In order to facilitate registered clients updating their information, The Client Registration Endpoint MAY accept an initial authorization
the Client Registration Endpoint issues a request_access_token for credential in the form of an OAuth 2.0 [RFC6749] access token in
clients to securely identify themselves in future connections. As order to limit registration to only previously authorized parties.
such, the Endpoint MUST accept requests with OAuth 2.0 Bearer Tokens The method by which this access token is obtained by the registrant
[RFC6750] for these operations. 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
client_register requests with no further authentication. These initial "client_register" requests with no authentication. These
requests MAY be rate-limited to prevent a denial-of-service attack on requests MAY be rate-limited or otherwise limited to prevent a
the Client Registration Endpoint. denial-of-service attack on the Client Registration Endpoint.
In addition, the Client Registration Endpoint MAY accept an initial In order to facilitate registered clients updating their information,
authorization credential in the form of an OAuth 2.0 [RFC6749] access the Client Registration Endpoint issues a Request Access Token for
token in order to limit registration to only previously authorized clients to securely identify themselves in future connections. As
parties. The method by which this access token is obtained by the such, the Endpoint MUST accept requests with OAuth 2.0 Bearer Tokens
registrant is generally out-of-band and is out of scope of this [RFC6750] for these operations, whether or not the initial
specification. "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 REQUIRED. Values are "client_register" (for new operation
registrations), "rotate_secret" to request rotation of the REQUIRED. Values are:
"client_secret", and "client_update" (for updating parameters of
an existing "client_id").
access_token OPTIONAL. An OAuth2 Bearer token used to access the * "client_register": Register a new client, receive a Client
Client Registration Endpoint, as defined in OAuth2 Bearer. This 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
OPTIONAL. An OAuth2 Bearer token used to access the Client
Registration Endpoint, as defined in OAuth2 Bearer. This
parameter MUST NOT be sent if the Access Token is sent in the HTTP parameter MUST NOT be sent if the Access Token is sent in the HTTP
Authorization header as described in Section 7.1 of OAuth 2.0 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
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
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). parameters described in Client Metadata (Section 2). The
Authorization Server MAY provision default values for any items
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. Used to restrict new client registration. This
parameter MUST NOT be sent if the Access Token is sent in the HTTP parameter MUST NOT be sent if the Access Token is sent in the HTTP
Authorization header as described in Section 7.1 of OAuth 2.0 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].
redirect_uris REQUIRED 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_method OPTIONAL
policy_url OPTIONAL policy_url OPTIONAL
scope 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_max_age OPTIONAL
default_acr 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
&scope=read%20write%20dolphin
&logo_url=https://client.example.org/logo.png &logo_url=https://client.example.org/logo.png
&token_endpoint_auth_type=client_secret_basic
&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, optionally, a Client returns the newly-created Client Identifier and, if applicable, a
Secret. The response also contains a Registration Access Token that Client Secret, along with all registered metadata (Section 2) about
is to be used by the client to perform subsequent operations at this this client, including any fields provisioned by the Authorization
endpoint, such as client_update and rotate_secret. These items are Server itself. The Authorization Server MAY reject or replace any of
returned as a JSON document with the following fields as top-level the client's requested field values and substitute them with suitable
members of the root JSON object. values. If this happens, the Authorization Server MUST include these
fields in the response to the client.
The response also contains a Registration Access Token that is to be
used by the client to perform subsequent operations at this endpoint,
such as "client_update" and "rotate_secret".
All of the response items are returned as a JSON document 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 11, line 7 skipping to change at page 12, line 6
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": "client_secret": "cf136dc3c1fc93f31185e5885805d",
"cf136dc3c1fd9153029bb9c6cc9ecead918bad9887fce6c93f31185e5885805d", "scope": "read write dolphin",
"registration_access_token": "reg-23410913-abewfq.123483", "grant_type": "authorization_code refresh_token",
"expires_at":2893276800 "token_endpoint_auth_method": "client_secret_basic client_secret_post",
} "logo_url": "https://client.example.org/logo.png",
"jwk_url": "https://client.example.org/my_rsa_public_key.jwk",
"registration_access_token": "reg-23410913-abewfq.123483",
"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). The values of Client Metadata fields in this request (Section 2). If included in the request, valid values of Client
MUST replace (not augment) the values previously associated with this Metadata fields in this request MUST replace, not augment, the values
Client. Empty values in Client Metadata MUST be taken as a request previously associated with this Client. Empty values in Client
to clear any existing value of that field. Metadata MUST be taken as a request to clear any existing value of
that field. Omitted values in the Client Metadata MUST remain
unchanged by the Authorization Server. The Authorization Server MAY
replace any invalid values with suitable values.
operation operation
REQUIRED, MUST have the value "client_update" REQUIRED, MUST have the value "client_update"
access_token access_token
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 client_update issued during the "client_register" step, or previous
or rotate_secret calls. "client_update" or "rotate_secret" calls.
redirect_uris REQUIRED 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_method 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_max_age OPTIONAL
default_acr OPTIONAL default_acr OPTIONAL
For example, a client could send the following registration request For example, a client could send the following request to the Client
to the Client Registration Endpoint: Registration Endpoint to update the client registration in the above
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
operation=client_update operation=client_update
&redirect_uris=https://client.example.org/callback &redirect_uri=https://client.example.org/callback
%20https://client.example.org/callback2 %20https://client.example.org/alt
&client_name=My%20Example%20 &client_name=My%20New%20Example%20
&logo_url=https://client.example.org/logo.png &logo_url=https://client.example.org/newlogo.png
&token_endpoint_auth_type=client_secret_basic
&jwk_url=https://client.example.org/my_rsa_public_key.jwk
3.4. Client Update Response 3.4. Client Update Response
Upon successful update, the Client Registration Endpoint returns a Upon successful update, the Client Registration Endpoint returns the
JSON document with the following fields as top-level members of the Client ID, along with all current registered metadata (Section 2)
root JSON object. about this client, including any fields provisioned by the
Authorization Server itself. The Authorization Server MAY reject or
replace any of the client's requested field values and substitute
them suitable values. If this happens, the Authorization Server MUST
include these fields in the response to the client.
The Authorization Server MUST NOT include the Client Secret or
Request Access Token in this response.
These fields are returned as top-level 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",
}
[[ Editor's note: should this return the entire client data object, {
for confirmation and review, including any fields that may have been "client_id": "s6BhdRkqt3",
asserted by the AS? ]] "client_name": "My New Example",
"redirect_uri":
"https://client.example.org/callback https://client.example.org/alt"
"scope": "read write dolphin",
"grant_type": "authorization_code refresh_token",
"token_endpoint_auth_method": "client_secret_basic client_secret_post",
"logo_url": "https://client.example.org/newlogo.png",
"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 REQUIRED. MUST have the value rotate_secret operation
REQUIRED. MUST have the value rotate_secret
access_token REQUIRED. The Registration Access Token that was access_token
issued during the client_register step, or previous client_update REQUIRED, unless presented in the Authorization Header as in
or rotate_secret calls. This parameter MUST NOT be sent if the OAuth2 Bearer [RFC6750]. The Registration Access Token that was
Access Token is sent in the HTTP Authorization header as described issued during the "client_register" step, or previous
in Section 7.1 of OAuth 2.0 [RFC6749]. Access Tokens sent in the "client_update" or "rotate_secret" calls.
authorization header must be OAuth 2.0 Bearer Tokens [RFC6750].
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
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 with the following fields as top-level
members of the root JSON object. members of the root JSON object. This response MUST NOT 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 14, line 13 skipping to change at page 15, line 37
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": "client_secret": "7fce6c93f31185e5885805d",
"cf136dc3c1fd9153029bb9c6cc9ecead918bad9887fce6c93f31185e5885805d", "registration_access_token": "reg-02348913-oieqer.983421",
"registration_access_token": "this.is.a.access.token.value.ffx83",
"expires_at":2893276800 "expires_at":2893276800
} }
The Authorization Server SHOULD discard and invalidate the Request The Authorization Server SHOULD discard and invalidate the Request
Access Token and the Client Secret associated with this Client after Access Token and the Client Secret associated with this Client after
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
skipping to change at page 15, line 7 skipping to change at page 16, line 25
This specification defines the following error codes: This specification defines the following error codes:
invalid_operation invalid_operation
The value of "operation" is invalid or not supported. The value of "operation" is invalid or not supported.
invalid_redirect_uri invalid_redirect_uri
The value of one or more "redirect_uris" is invalid. The value of one or more "redirect_uris" is invalid.
invalid_client_metadata invalid_client_metadata
The value of one of the client metadata (Section 2) fields is The value of one of the client metadata (Section 2) fields is
invalid. invalid and the server has rejected this request. Note that an
Authorization server MAY choose to substitute a valid value for
any requested parameter of a client's metadata.
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
{ {
"error":"invalid_operation", "error":"invalid_operation",
"error_description":"The value of the operation parameter must "error_description":"The value of the operation parameter must
be one of client_register, rotate_secret or client_update." be one of client_register, rotate_secret or client_update."
} }
4. IANA Considerations 4. IANA Considerations
This document makes no requests of IANA. This document makes no requests of IANA.
5. Security Considerations 5. Security Considerations
[[ Editor's note: Following are some security considerations taken [[ Editor's note: Following are some security considerations taken
whole from the UMA and OpenID Connect source drafts. ]] from the UMA and OpenID Connect source drafts. These need to be
massaged into a properly generic set of considerations. ]]
Since requests to the Client Registration Endpoint result in the Since requests to the Client Registration Endpoint result in the
transmission of clear-text credentials (in the HTTP request and transmission of clear-text credentials (in the HTTP request and
response), the server MUST require the use of a transport-layer response), the server MUST require the use of a transport-layer
security mechanism when sending requests to the Registration security mechanism when sending requests to the Registration
Endpoint. The server MUST support TLS 1.2 RFC 5246 [RFC5246] and/or Endpoint. The server MUST support TLS 1.2 RFC 5246 [RFC5246] and/or
TLS 1.0 [RFC2246] and MAY support additional transport-layer TLS 1.0 [RFC2246] and MAY support additional transport-layer
mechanisms meeting its security requirements. When using TLS, the mechanisms meeting its security requirements. When using TLS, the
Client MUST perform a TLS/SSL server certificate check, per RFC 6125 Client MUST perform a TLS/SSL server certificate check, per RFC 6125
[RFC6125]. [RFC6125].
skipping to change at page 16, line 5 skipping to change at page 17, line 26
prevent the Registration Access Token from being disclosed though prevent the Registration Access Token from being disclosed though
repeated access attempts. repeated access attempts.
The authorization server MUST treat all client metadata as self- The authorization server MUST treat all client metadata as self-
asserted. A rogue Client might use the name and logo for the asserted. A rogue Client might use the name and logo for the
legitimate Client, which it is trying to impersonate. An legitimate Client, which it is trying to impersonate. An
Authorization Server needs to take steps to mitigate this phishing Authorization Server needs to take steps to mitigate this phishing
risk, since the logo could confuse users into thinking they're risk, since the logo could confuse users into thinking they're
logging in to the legitimate Client. For instance, an Authorization logging in to the legitimate Client. For instance, an Authorization
Server could warn if the domain/site of the logo doesn't match the Server could warn if the domain/site of the logo doesn't match the
domain/site of redirect URIs. An Authorization Server can also make domain/site of redirect URIs. An Authorization Server can also
warnings against untrusted Clients in all cases, especially if present warning messages to end users about untrusted Clients in all
they're dynamically registered, have not been trusted by any users at cases, especially if such clients have been dynamically registered
the Authorization Server before. and have not been trusted by any users at the Authorization Server
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_url" and "policy_url"). 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_url". The Authorization Server should check to see if the
"logo_url" and "policy_url" have the same host as the hosts defined "logo_url" and "policy_url" have the same host as the hosts defined
in the array of "redirect_uris". in the array of "redirect_uris".
 End of changes. 50 change blocks. 
125 lines changed or deleted 203 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/