DCR VS DCRM with WSO2 Identity server

What is DCR (Dynamic Client Registration)

Dynamic Client registration is a protocol which allows OAuth clients to register applications in an authorization server. Before this mechanism which is introduced from the spec [1] the client registration happened manually. With this implementation the client registration could be done in two ways.

 - A client can be registered dynamically with the authorization server itself
 - A programmer can register a client programmatically.

Following is the protocol flow of DCR


1. A client sends a registration request with as follows. This should be a post request.
2. Server sends information response with 201 created.


Request :

POST https://localhost:9443/api/identity/oauth2/dcr/v1.0/register HTTP/1.1
Authorization: Basic YWRtaW46YWRtaW4=
Content-Type: application/json
Content-Length: 114
Host:localhost:9443
{
  "redirect_uris": [
    "http://localhost"
  ],
  "client_name": "client_test",
  "grant_types": [
    "password"
  ]
}


Response :

HTTP/1.1 201 Created
Content-Length: 163
Content-Type: application/json
Connection: Close
{
   "client_id": "3701c489-3e03-4f2b-a125-ee3f8d25a501",
   "client_secret": "4bff3ec0-a5ab-4252-8768-126633278333",
   "redirect_uris": ["http://localhost"],
   "client_name": "client_test"
}

What is DCRM (Dynamic Client Registration Management)

The main finctionalities introduced form this specification [2] are :

  1. Current registration state of a client (Client Read Request)
  2. Update request to an already registered client (Client Update Request)
  3. Delete request to unregister a client (Client Delete Request)
This specification is an extension of DCR specification. Following is the protocol flow of DCRM. 




Client Read Request

Following is a sample client read request and response using WSO2 identity server.

 Request :

Get https://localhost:9443/api/identity/oauth2/dcr/v1.0/register
/3701c489-3e03-4f2b-a125-ee3f8d25a501 HTTP/1.1
Host:localhost:9443

 Response:
HTTP/1.1 200 OK
Content-Length: 163
Content-Type: application/json
Connection: Close
{
   "client_id": "3701c489-3e03-4f2b-a125-ee3f8d25a501",
   "client_secret": "4bff3ec0-a5ab-4252-8768-126633278333",
   "redirect_uris": ["http://localhost"],
   "client_name": "name_1"

}

This request is made from concatenating a client identifier ti the DCR register EP. This client identifier is the client key of the application.


Client Update Request

This is used to update an already registerd client application. This update request is a HTTP put request. 
Few considerations are there when doing the DCRM update request.
  1. This request MUST include all client metadata field which is obtained from previos read / registration request.
  2. The fields which are not specified in the request should be filled with  null values
  3. The 'client_id' in the should be included in the request and it  MUST be the same as its currently issued client identifier. 
  4. The 'client_secret' value can be included in the request, but the value should be matched with the currency issued 'client_secret'. 
  5. The 'client_secret' of the request can not override the existing one of the application.
Following is a sample request and response using WSO2 identity server.

Request :

PUT https://localhost:9443/api/identity/oauth2/dcr/v1.0/register/
3701c489-3e03-4f2b-a125-ee3f8d25a501 HTTP/1.1
Content-Type: application/json
Content-Length: 115
Host: localhost:9443
{
  "redirect_uris": [
    "http://localhost/123"
  ],
  "client_name": "name_1",
  "grant_types": [
    "password"
  ]
}
Response :


HTTP/1.1 200 OK
Content-Length: 164
Content-Type: application/json
Connection: Close
{
   "client_id": "3701c489-3e03-4f2b-a125-ee3f8d25a501",
   "client_secret": "4bff3ec0-a5ab-4252-8768-126633278333",
   "redirect_uris": ["http://localhost"],
   "client_name": "name_1"
}


Client Delete Request

By doing HTTP DELETE request the client can delete itself from the authorization server. 
A delete request will invalidate all 'client_id' ,'client_secret' and 'registration_access_token' of the client.

 Following is a sample request and response using WSO2 identity server.

Request :

DELETE https://localhost:9443/api/identity/oauth2/dcr/v1.0/register/
3701c489-3e03-4f2b-a125-ee3f8d25a501 HTTP/1.1
Content-Type: application/json
Content-Length: 0
Host: localhost:9443

Response :

HTTP/1.1 204 No Content
Connection: Close

[1] https://tools.ietf.org/html/rfc7591
[2] https://tools.ietf.org/html/rfc7592


Comments

Post a Comment

Popular posts from this blog

Applying CORS Filter to wso2 Identity Server

When we are invoking an endpoint in oauth2 war from a javascript of a web app which is located in a different domain than identity server domain we are getting "No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'http://XXXXXXX is therefore not allowed access." The issue is occurring as the script on your page is running from a specifc domain and would try to request the resource via an XmlHttpRequest or XDomainRequst from a different domain as this is a cross -origin request. In order to get rid of this we need to enable this by sending below header using a custom filter.  Access-Control-Allow-Origin: http: //example.com   (Here  http://example.com is the domain name of where page with that script is hosted) Invoking UserInfo endpoint of wso2 Identity Server from JavaScript We have two possible solutions to apply the CORS header.  1. Customizing OpenIDConnectUserEndpoint.java as below and replacing the oau...
Read more

Secure Wso2 ESB REST APIs using Kerberos

Image
When a consumer attempts to consume a REST API, if the API is secured using some authentication protocol (e.g Basic , Kerberos, NTLM) the consumer has to prove his authentication to the API by sending credentials or relevant token through authorization headers. By default ESB REST APIs does not include any security and from this blog post I will speak about how to make the APIs secured using kerberos. I have used main 3 components ;  Active Directory as the KDC , ESB server as the resource server and a C#.net client to invoke the rest APIs in ESB server. The design of the implementation is as below. The Design of the Kerberos Communication 1. Client tries to invoke the ESB proxy 2. The server responds with 401 unauthorized 3. Client requests a kerberos service ticket from active directory 4. If user is identified by the KDC (AD) it will send the SGT to the client 5. Client wraps the SPENEGO token in the request HTTP header and resend to ESB 6. ESB sees the HTTP head...
Read more