Configure OpenID Connect with introspection
Using the OpenID Connect plugin, set up the introspection auth workflow to connect to an identity provider (IdP) to retrieve a token from the IdP’s introspection endpoint, then use the token to access the upstream service.
Prerequisites
Kong Konnect
This is a Konnect tutorial and requires a Konnect personal access token.
-
Create a new personal access token by opening the Konnect PAT page and selecting Generate Token.
-
Export your token to an environment variable:
export KONNECT_TOKEN='YOUR_KONNECT_PAT'
Copied to clipboard! -
Run the quickstart script to automatically provision a Control Plane and Data Plane, and configure your environment:
curl -Ls https://get.konghq.com/quickstart | bash -s -- -k $KONNECT_TOKEN --deck-output
Copied to clipboard!This sets up a Konnect Control Plane named
quickstart
, provisions a local Data Plane, and prints out the following environment variable exports:export DECK_KONNECT_TOKEN=$KONNECT_TOKEN export DECK_KONNECT_CONTROL_PLANE_NAME=quickstart export KONNECT_CONTROL_PLANE_URL=https://us.api.konghq.com export KONNECT_PROXY_URL='http://localhost:8000'
Copied to clipboard!Copy and paste these into your terminal to configure your session.
Enable the OpenID Connect plugin with introspection
Using the Keycloak and Kong Gateway configuration from the prerequisites, set up an instance of the OpenID Connect plugin with introspection authentication. We’re also enabling the password grant so that you can test retrieving the auth token for introspection.
Enable the OpenID Connect plugin on the example-service
Service:
echo '
_format_version: "3.0"
plugins:
- name: openid-connect
service: example-service
config:
issuer: "${{ env "DECK_ISSUER" }}"
client_id:
- "${{ env "DECK_CLIENT_ID" }}"
client_secret:
- "${{ env "DECK_CLIENT_SECRET" }}"
client_auth:
- client_secret_post
auth_methods:
- introspection
- password
bearer_token_param_type:
- header
' | deck gateway apply -
In this example:
-
issuer
,client ID
,client secret
, andclient auth
: Settings that connect the plugin to your IdP (in this case, the sample Keycloak app). -
auth_methods
: Specifies that the plugin should use introspection and the password grant for authentication. -
bearer_token_param_type
: Restricts token lookup to the request headers only.
Note: Setting
config.client_auth
toclient_secret_post
lets you easily test the connection to your IdP, but we recommend using a more secure auth method in production. You can use any of the supported client auth methods.
Retrieve the bearer token using introspection
Check that you can recover the token by requesting the Service with the basic authentication credentials created in the prerequisites:
curl -i -X GET "$KONNECT_PROXY_URL/anything" \
-u alex:doe
curl -i -X GET "http://localhost:8000/anything" \
-u alex:doe
You’ll see an Authorization
header in the response.
Export the value of the header to an environment variable:
export TOKEN='YOUR_BEARER_TOKEN'
Validate the token
Now, validate the setup by accessing the example-route
Route and passing the token you retrieved using introspection:
curl -i -X GET "$KONNECT_PROXY_URL/anything" \
-H "Authorization: $TOKEN"
curl -i -X GET "http://localhost:8000/anything" \
-H "Authorization: $TOKEN"
If Kong Gateway successfully authenticates with Keycloak, you’ll see a 200
response with your bearer token in the Authorization header.
If you make another request using the same credentials, you’ll see that Kong Gateway adds less latency to the request because it has cached the token endpoint call to Keycloak:
X-Kong-Proxy-Latency: 25
Cleanup
Clean up Konnect environment
If you created a new control plane and want to conserve your free trial credits or avoid unnecessary charges, delete the new control plane used in this tutorial.