Basic Client Profile with Playground

To obtain and configure the Playground sample, follow the steps below.

1. You can check out the repository of the OAuth 2.0 sample from GitHub. Follow the instructions here to checkout the folder. We refer <SAMPLE_HOME> as the modules/samples folder inside the folder where the product-is repository is checked out.

   https://github.com/wso2/product-is/tree/v5.1.0/modules/samples/oauth2/playground2

2. In your command line, navigate to <SAMPLE_HOME>/oauth2/playground2 in the folder you checked out and build the sample using the following command. You must have Apache Maven installed to do this (see Installation Prerequisites for the appropriate version to use).

   mvn clean install

3. After successfully building the sample, a .war file named playground2 can be found inside the <SAMPLE_HOME>/oauth2/playground2/target folder. Deploy this sample web app on a web container. To do this, use the Apache Tomcat server.

   Since this sample is written based on Servlet 3.0 it needs to be deployed on Tomcat 7.x.

   Use the following steps to deploy the web app in the web container:

   1. Stop the Apache Tomcat server if it is already running.
   2. Copy the playground2.war file to the <TOMCAT_HOME>/webapps folder.
   3. Start the Apache Tomcat server.

4. Make sure to update param-value the following parameter in the WEB-INF/web.xml file with the server url of the Identity Server if required.

   <init-param>
        <description>serverUrl</description>
        <param-name>serverUrl</param-name>
        <param-value>https://localhost:9443/services/</param-value>
   </init-param>

   Note that localhost is the server that hosts WSO2 Identity Server and 9443 is the default SSL port of it.

5. Update param-value of below parameters with credentials of an admin user if required.

   <init-param>
        <description>userName</description>
        <param-name>userName</param-name>
        <param-value>admin</param-value>
   </init-param>
   <init-param>
        <description>password</description>
        <param-name>password</param-name>
        <param-value>admin</param-value>
   </init-param>

6. Restart Apache Tomcat and access http://localhost:8080/playground2/ (assuming Tomcat is running on HTTP port 8080). You are directed to the landing page of the sample application. Click on Import Photos and the following page appears.
   

This application is used to request access tokens using the four OAuth2 grant types. 

To enable OAuth support for your client application, you must first register your application by providing an application name. For code and implicit grant types, you have to provide a callback URL. Follow the instructions below to add a new application.

1. Expand the OAuth/OpenID Connect Configuration and click Configure.
2. Fill in the form that appears. For the Allowed Grant Types you can disable the ones you do not require or wish to block.
   
3. Click Add. The following information is added for your service provider.
   
   
   • OAuth Client Key - This is the client key of the service provider, which will be checked for authentication by the Identity Server before providing the access token.
   • OAuth Client Secret - This is the client secret of the service provider, which will be checked for authentication by the Identity Server before providing the access token. Click the Show button to view the exact value of this.

   Tip: The OAuth client key and client secret are stored in plain text. To encrypt the client secret, access token and refresh token, do the following:

   Open the identity.xml file found in the <IS_HOME>/repository/conf/identity directory and change the <TokenPersistenceProcessor> property as follows:

   <TokenPersistenceProcessor>org.wso2.carbon.identity.oauth.tokenprocessor.EncryptionDecryptionPersistenceProcessor</TokenPersistenceProcessor>

When filling out the New Application form, the following should be taken into consideration.

• Selecting OAuth Version as 1.0a removes all the configurable Allowed Grant Types. This is because this version of OAuth does not support grant types.
• The Callback Url is the exact location in the service provider's application where an access token would be sent. This is a required field and important to configure as it is imperative that the service provider receives the access token. This is necessary for security purposes to ensure that the token is not compromised.
• The following are the grant types that are used to get the access token.
  • Code - Entering the user name and password required at the service provider will result in a code being generated. This code can be used to obtain the access token.
  • Implicit - This is similar to the code grant type, but instead of generating a code, this directly provides the access token.
  • Password - This authenticates the user using the password provided and the access token is provided.
  • Client Credential - This is the grant type for the client key and client secret. If these two items are provided correctly by the service provider, the access token is sent.
  • Refresh Token - This will enable the user to obtain an access token by using the refresh token once the originally provided access token is used up.
  • SAML - This uses SAML as the grant type to obtain the access token.
  • IWA-NTLM - This is similar to the password grant type, but it is specific to Microsoft Windows users.