Skip to content

Kerberos Grant

Kerberos is a security protocol that has support built into various operating systems and open-source distributions (e.g.,  Ubuntu, Windows, RedHat, Open Solaris, etc). Additionally, a majority of browsers support some Kerberos functions as well. As WSO2 Identity Server (WSO2 IS) uses the OAuth 2.0 protocol, the Kerberos-OAuth2 grant type allows organizations to exchange a Kerberos ticket for an OAuth 2.0 token. This allows organizations to re-use their existing Kerberos infrastructure and adopt OAuth 2.0.

Kerberos-OAuth2 grant flow

The following section describes the flow involved in exchanging a Kerberos ticket for an OAuth2 token.
oauth-kerberos-diagram

  1. The Kerberos client requests the Kerberos Service Ticket from the Kerberos Key Distribution Center (KDC) to invoke the service.
    The Kerberos Key Distribution Center can be any Kerberos Server.
  2. The Kerberos Key Distribution Center sends a response with the Kerberos Service Ticket.
    If the client and the requested service is valid, the Key Distribution Center (KDC) sends a Kerberos ticket encrypted with the service owners private key. The API handles the exchanging of the Ticket Granting Ticket (TGT), Service Granting Ticket (SGT), and all other low level Kerberos details.
  3. The Kerberos client requests the OAuth2 token. For more information on how to generate the kerberos token, see step 6 below.

    The message format of the OAuth2 token request should be as follows:

    You can use one of the following two cURL commands to request for the OAuth2 token.

    curl -v -X POST -H "Authorization: Basic <base64 encoded client id:client secret value>" -k -d "grant_type=kerberos&kerberos_realm=<kerberos realm>&kerberos_token=<kerberos token>" -H "Content-Type:application/x-www-form-urlencoded" https://localhost:9443/oauth2/token
    curl -u <client id>:<client secret> -k -d "grant_type=kerberos&kerberos_realm=<kerberos realm>&kerberos_token=<kerberos token>" -H "Content-Type:application/x-www-form-urlencoded" https://localhost:9443/oauth2/token

    Response

    POST /oauth2/token HTTP/1.1
    Host: idp.example.com:9443
    Content-Type: application/x-www-form-urlencoded
    Authorization: Basic MW91TDJmTzZTeGxmRDJMRHcxMjVjVG8wdlFrYTp1VUV0bTg5dFk2UVp1WlVtcVpmTDkyQkRGZUFh
    grant_type=kerberos&kerberos_realm=example.com&kerberos_token=YII1…

  4. The Kerberos client receives the OAuth2 token.

  5. The Kerberos Grant validates the received token with the provided Identity Provider (IDP) credentials and if it is a valid token, it issues an OAuth2 token to the client.

    Example

        {  
           "access_token":"636ce45f-c7f6-3a95-907f-d1f8aca28403",
           "refresh_token":"831271d9-16ba-3bad-af18-b9f6592a8677",
           "scope":"my_scope",
           "token_type":"Bearer",
           "expires_in":521
        }

Configuring Kerberos Grant with the Identity Server

Follow the instructions below to configure Kerberos Grant with WSO2 IS:

  1. Download the kerberos grant.jar file.
  2. Copy the JAR into the <IS_HOME>/repository/components/lib directory.
  3. To enable the Kerberos grant, add the following entry to the deployment.toml file in the <IS_HOME>/repository/conf/ folder.

    [oauth.grant_type.kerberos_grant]
    enable = true
  4. Configure OAuth2 with IWA as an allowed grant type.

    1. Sign in to the WSO2 IS Management Console.
      https://<Server-Host>:9443/carbon
    2. Navigate to the Main menu, click Add under the Service Providers menu.
    3. Add a new Service Provider and configure OAuth2 for your client application with kerberos as an allowed grant type.

      Click for instructions to configure OAuth2

      To enable OAuth support for your client application, you must first register your application. Follow the instructions below to add a new OAuth2 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. Select the kerberos grant type as an allowed grant type. register-new-oauth-app
      3. Click Add. The following information is added to your service provider. oauth-sp-clientid-clientsecret
        • 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.
        • Actions -
          • Edit: Click to edit the OAuth/OpenID Connect Configurations
          • Revoke: Click to revoke (deactivate) the OAuth application. This action revokes all tokens issued for this application. In order to activate the application, you have to regenerate the consumer secret.
          • Regenerate Secret: Click to regenerate the secret key of the OAuth application.
          • Delete: Click to delete the OAuth/OpenID Connect Configurations.
  5. Configure the Service Principal Name ( SPNName) and Service Principal Password ( SPNPassword) .

    1. Navigate to the Main menu, click Add under the Identity Providers menu.

    2. Add a new Identity Provider (IDP). Enter the basic information as follows.

      Note

      The IDP name should be the name of the realm as specified in the token request in step 3. Based on this example, it should be example.com .

      add-new-idp

    3. Expand the Federated Authenticators tab, and then the IWA Kerberos Configuration tab. Enter the required details as follows.

      configure-kerberos

      6. Generate the kerberos token.

    4. Git clone the KerbClientProject .

      git clone https://github.com/erandacr/KerbClientProject
    5. Run KerbClient.cs using an IDE.
      You can run it using Visual Studio by downloading and installing the following required libraries and programs.

      Tip

      Tip: Note that you can also use any other IDE to run this project.

    6. Configure the following parameters in the project according to your setup.

      // Service Name goes here
      static string serviceName = "HTTP/apimserver.example.com@EXAMPLE.COM";
      // Token endpoint URL
      static string URI = "https://idp.example.com:9443/oauth2/token";
      // Client ID
      static string username = "1ouL2fO6SxlfD2LDw125cTo0vQka";
      // Client Secret
      static string password = "uUEtm89tY6QZuZUmqZfL92BDFeAa";
      // Kerberos realm name
      static string realm_Name = "example.com";
    7. Run the project by selecting the Start without Debugging option on the Visual Studio editor.

    This project generates a Kerberos ticket and a kerberos token is generated using the ticket. The generated token can be used to get the OAuth token.

  6. Invoke the token endpoint using the message format discussed in step 3.

Top