README.md

Keycloak Kubernetes Client Authenticator

The Keycloak Kubernetes Client Authenticator is a keycloak client authenticator which allows to use kubernetes service account token as client assertation as described in RFC 7523, Section 2.2. Using JWTs for Client Authentication. These tokens are created and refreshed through the kubernetes ServiceAccount token volume projection.

Using token as client assertation allows to get rid of static credentials like client_id and client_secret to get token from keycloak.

Configuring a client for use

1. Create a new client with your desired client id and set the description to system:serviceaccount:<k8s-namespace>:<serviceAccountName>@<kubernetes-issuer-name>:
2. Select the Kubernetes Service Account Client Authenticator under Credentials
3. Provide public key to verify the token signature:
   1. Import a JSON Web Key Set (JWKS):
   2. Define URL to the JWKS. The default location is under https://<kubernetes-api-server>/openid/v1/jwks:

How to get a token using the kubernetes service account token

The following yaml shows a pod definition that gets a service account token injected into the file /var/tokens/keycloak-token:

apiVersion: v1
kind: Pod
metadata:
    name: keycloak-test
spec:
    serviceAccountName: keycloak-test
    containers:
        - name: busybox
          image: busybox:latest
          tty: true
          stdin: true
          volumeMounts:
              # Mount the projected volume `token` under /var/tokens
              - mountPath: /var/tokens
                name: token
    volumes:
        # Create a projected volume that contains one file `keycloak-token`. This file contains the jwt token with the
        # defined audience `http://localhost:8080/realms/master` and is refreshed every two hours.
        - name: token
          projected:
              sources:
                  - serviceAccountToken:
                        path: keycloak-token
                        audience: "http://localhost:8080/realms/master"
                        expirationSeconds: 7200

This curl request shows how to get a client_credential-token using the injected token form the pod above.

export KEYCLOAK_REALM_URL=http://localhost:8080/realms/master
export TOKEN=$(cat /var/tokens/keycloak-token)

curl -X POST --location "${KEYCLOAK_REALM_URL}/protocol/openid-connect/token" \
  -H "Authorization: Bearer ${TOKEN}" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d 'grant_type=client_credentials&client_assertion_type=urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer'

License

The Keycloak Kubernetes Client Authenticator is released under the Apache 2.0 license. See LICENSE