OpenID Connect with Okta

    For information about configuring OIDC using Okta as an Identity provider in conjunction with the Application Registration plugin, see .

    1. If the client does not have a session cookie, it initiates sign in with Kong.
    2. Kong responds to the client with an authorization cookie and a location to redirect (with Okta as the header).
    3. the client redirects to Okta so the user can sign in.
    4. Okta responds with an authorization code and a location to redirect (with Kong as the header).

    At this point, the client has successfully signed in and has an authorization code (from Okta) and an authorization cookie (from Kong).

    Access flow

    OIDC access flow

    1. The client redirects to Kong and automatically sends the authorization code (from Okta) and an authorization cookie (from Kong).
    2. Kong verifies the authorization code with Okta.
    3. Okta sends and access token and ID token to Kong.
    4. Kong proxies the client request with the access token from Okta.
    5. Kong receives a service response.
    6. Kong sends the service response to the client, along with a session cookie for future access.

    At this point, the client now has a session with Kong that allows mediated access to the service.

    1. The client sends requests with a session cookie.
    2. Kong matches the session cookie to the associate access token and proxies the request.
    3. Kong gets a response from the service.
    4. Kong sends the response to the client.

    Kong’s session with the client ensures that the client does not need to make constant requests to Okta. The duration of the session can be configured.

    Example of configuring the OIDC plugin with Okta

    Prerequisites

    The steps in the guide offer an example of configuring OIDC with Okta on a specific route. To follow this guide, you need the following:

    • A running version of Kong Gateway.
    • Access to the OpenID Connect plugin.
    • A and route in Kong Gateway whose access you want to protect with Okta. For this guide, assume the route is in the default workspace.
    • If using Kong Gateway locally, you need Internet access.

    • Any network access control to your Kong node must allow traffic to and from Okta, the upstream service, and the client.

      For security reasons, make sure all requests are sent over HTTPS, and make the Kong proxy available with a fully-qualified domain name and . Authorization tokens should also be stored securely.

    1. the application you are using Kong to proxy.
    2. From the left menu, select Applications, then Create App Integration.

    3. Select the application type:

      1. Under Sign-in method, select OIDC - OpenID Connect.
      2. Under Application Type, select Web Application.

    4. Select Next. Configure the application:

      1. Create a unique name for your application.
      2. Under Grant Type, select Authorization Code.

      3. In both the Sign-in redirect URIs and Sign-out redirect URIs fields, enter a location handled by your Route in Kong Gateway.

        For this example, you can enter .

      4. In the Assignments section, for Controlled access, choose your preferred access level for this application. This preferred access level sets the permissions for Okta admins.

      Do not select Allow everyone in your organization to access otherwise the access token won’t be verified against Okta.

      Either select Limit access to selected groups or Skip group assignment for now and assign the users and groups in a later step.

    5. Save your settings to generate connection details.

    6. Add an Authorization Server. From the left sidebar, go to Security > API > Authorization Server and create a server named Kong API Management with an audience and description. Click Save.

      On the page that appears, note the Issuer address. You need this address to configure the Kong OIDC Plugin.

    7. Now add a policy from the Access Policies tab.

      1. Click Add New Access Policy and add a Name and Description
      2. Add a rule
      3. Assign a Rule Name and use the default settings, or adjust to your requirements.
      4. Click Create Rule

    Configure the OIDC plugin in Kong Gateway

    Minimum configuration requirements

    Configure plugin with Kong Manager

    Configure plugin with Admin API

    1. In Kong Manager, from the Workspaces tab, select the workspace where your route is configured.

    2. Click Routes in the left navigation.

    3. On the Routes page, select the route you have configured to protect with Okta and click View.

    4. Scroll to the bottom of the page and click Add Plugin.

    5. Select the OpenID Connect plugin.

    6. On the Authorization tab, configure the following, at a minimum:

      1. For config.scopes required, enter openid, email, profile. This parameter is the scope of what OpenID Connect checks.

      2. For config.scopes claim, enter scp.

    7. Switch to the Advanced tab and fill out config.redirect_uri with https://kong.com/api.

      The redirect_uri should be the URI you specified earlier when configuring your app. This is the redirect_uri of the client defined with client_id (also used as a redirection URI for the authorization code flow).

    8. Click Create to save and apply the plugin to the Route.

    For a list of all available configuration parameters and what they do, see the OIDC plugin reference.

    Configure the OpenID Connect plugin using the following sample values:

    In this example, the configuration contains the following values:

    • : The issuer url from which OpenID Connect configuration can be discovered. Using Okta, specify the domain and server in the path:
      • https://YOUR_OKTA_DOMAIN/oauth2/YOUR_AUTH_SERVER/.well-known/openid-configuration
    • auth_method: A list of authentication methods to use with the plugin, such as passwords, introspection tokens, etc. The majority of cases use authorization_code, and Kong Gateway will accept all methods if no methods are specified.
    • client_id: The client_id of the OpenID Connect client registered in OpenID Connect Provider. Okta provides one to identify itself.
    • client_secret: The client_secret of the OpenID Connect client registered in OpenID Connect Provider. These credentials should never be publicly exposed.
    • config.scopes_required: The scope of what OpenID Connect checks. This is set to openid by default. You must also set email and profile for this example.
    • : This should be set to scp.
    • config.redirect_uri: The redirect_uri of the client defined with client_id (also used as a redirection URI for the authorization code flow).

    For a list of all available configuration parameters and what they do, see the .

    Visiting a URL matched by that route in a browser will now redirect to Okta’s authentication site and return you to the redirect URI after authenticating.

    Test the following conditions to ensure a successful integration of the OIDC plugin with Okta:

    • Unauthorized access to a route is blocked
    • Authorized access is allowed after login/providing first set of credentials
      • Ensure the identity is registered with the IdP
      • Steps for debugging
    • Authorized access is allowed on immediate subsequent attempts
      • Perhaps highlight where the cookie is stored
    • Previously authorized access is no longer allowed after cookie terminates
      • Set a very short TTL on the session to ensure the tester doesn’t need to wait long to get locked out

    Access Restrictions

    The example configuration allows users to authenticate and access the Route even though no Consumer was created for them. Any user with a valid account in the directory will have access to the Route. The OIDC plugin allows this as the simplest authentication option, but you may wish to restrict access further. There are several options for this:

    • Consumer Mapping
    • Pseudo-Consumer Mapping

    Consumer Mapping

    If you need to interact with other Kong plugins using consumer information, you can add configuration that maps account data received from the identity provider to a Kong consumer. For this example, the user’s Okta’s AD account GUID is mapped to a Consumer by setting it as the custom_id on their consumer:

    Now, if a user logs into an Okta account with the GUID e5634b31-d67f-4661-a6fb-b6cb77849bcf, Kong will apply configuration associated with the Consumer Yoda to their requests.

    This also requires that clients login using an account mapped to some Consumer, which might not be desirable (e.g., you apply OpenID Connect to a service, but only use plugins requiring a Consumer on some Routes). To deal with this, you can set the anonymous parameter in your OIDC plugin configuration to the ID of a generic Consumer, which will then be used for all authenticated users that cannot be mapped to some other Consumer. You can alternately set consumer_optional to true to allow similar logins without mapping an anonymous Consumer.

    Pseudo-consumers

    For plugins that typically require consumers, the OIDC plugin can provide a consumer ID based on the value of a claim without mapping to an actual Consumer. Setting credential_claim to a claim in your plugin configuration will extract the value of that claim and use it where Kong would normally use a consumer ID. Note that this may not work with all consumer-related functionality.

    Similarly, setting authenticated_groups_claim will extract that claim’s value and use it as a group for the ACL plugin.