Datakit: Sign JWT with Principal ID - Plugin

Sign JWT with Principal IDv3.16+

Sign an outgoing JWT in a request header using the authenticated Principal’s ID as the subject. This example assumes a Consumer is already authenticated before Datakit runs. This example contains the following nodes:

The node GET_PRINCIPAL retrieves the currently authenticated Principal object.
The node BUILD_CLAIMS uses jq to extract the Principal’s id and build a sub claim.
The node SIGN_JWT signs a new JWT using an HMAC secret stored in Vault.
The node BUILD_HEADER injects the signed token into an X-Consumer-JWT request header sent to the upstream service.

Prerequisites

You have configured a Consumer and an authentication plugin (for example, Key Auth or JWT).
You have configured a Vault secret for the HMAC signing key.

Set up the plugin

Add this section to your kong.yaml configuration file:

decK

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: datakit
    config:
      resources:
        vault:
          jwt_hmac_key: "{vault://env/JWT_HMAC_SECRET}"
      nodes:
      - name: GET_PRINCIPAL
        type: property
        property: kong.client.principal
      - name: BUILD_CLAIMS
        type: jq
        input: GET_PRINCIPAL
        jq: |
          {
            "sub": .id
          }
      - name: SIGN_JWT
        type: jwt_sign
        algorithm: HS256
        expires_in: 300
        static_claims:
          iss: kong
        inputs:
          claims: BUILD_CLAIMS
          key: vault.jwt_hmac_key
      - name: BUILD_HEADER
        type: jq
        input: SIGN_JWT.token
        jq: |
          {
            "X-Consumer-JWT": .
          }
        output: service_request.headers

Make the following request:

curl -i -X POST http://localhost:8001/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "datakit",
      "config": {
        "resources": {
          "vault": {
            "jwt_hmac_key": "{vault://env/JWT_HMAC_SECRET}"
          }
        },
        "nodes": [
          {
            "name": "GET_PRINCIPAL",
            "type": "property",
            "property": "kong.client.principal"
          },
          {
            "name": "BUILD_CLAIMS",
            "type": "jq",
            "input": "GET_PRINCIPAL",
            "jq": "{\n  \"sub\": .id\n}\n"
          },
          {
            "name": "SIGN_JWT",
            "type": "jwt_sign",
            "algorithm": "HS256",
            "expires_in": 300,
            "static_claims": {
              "iss": "kong"
            },
            "inputs": {
              "claims": "BUILD_CLAIMS",
              "key": "vault.jwt_hmac_key"
            }
          },
          {
            "name": "BUILD_HEADER",
            "type": "jq",
            "input": "SIGN_JWT.token",
            "jq": "{\n  \"X-Consumer-JWT\": .\n}\n",
            "output": "service_request.headers"
          }
        ]
      }
    }
    '

Copied!

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "datakit",
      "config": {
        "resources": {
          "vault": {
            "jwt_hmac_key": "{vault://env/JWT_HMAC_SECRET}"
          }
        },
        "nodes": [
          {
            "name": "GET_PRINCIPAL",
            "type": "property",
            "property": "kong.client.principal"
          },
          {
            "name": "BUILD_CLAIMS",
            "type": "jq",
            "input": "GET_PRINCIPAL",
            "jq": "{\n  \"sub\": .id\n}\n"
          },
          {
            "name": "SIGN_JWT",
            "type": "jwt_sign",
            "algorithm": "HS256",
            "expires_in": 300,
            "static_claims": {
              "iss": "kong"
            },
            "inputs": {
              "claims": "BUILD_CLAIMS",
              "key": "vault.jwt_hmac_key"
            }
          },
          {
            "name": "BUILD_HEADER",
            "type": "jq",
            "input": "SIGN_JWT.token",
            "jq": "{\n  \"X-Consumer-JWT\": .\n}\n",
            "output": "service_request.headers"
          }
        ]
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.

See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: datakit
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: 'true'
config:
  resources:
    vault:
      jwt_hmac_key: '{vault://env/JWT_HMAC_SECRET}'
  nodes:
  - name: GET_PRINCIPAL
    type: property
    property: kong.client.principal
  - name: BUILD_CLAIMS
    type: jq
    input: GET_PRINCIPAL
    jq: |
      {
        'sub': .id
      }
  - name: SIGN_JWT
    type: jwt_sign
    algorithm: HS256
    expires_in: 300
    static_claims:
      iss: kong
    inputs:
      claims: BUILD_CLAIMS
      key: vault.jwt_hmac_key
  - name: BUILD_HEADER
    type: jq
    input: SIGN_JWT.token
    jq: |
      {
        'X-Consumer-JWT': .
      }
    output: service_request.headers
plugin: datakit
" | kubectl apply -f -

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_datakit" "my_datakit" {
  enabled = true

  config = {

    resources = {

      vault = {
        jwt_hmac_key = "{vault://env/JWT_HMAC_SECRET}"
      }
    }
    nodes = [
      {
        name = "GET_PRINCIPAL"
        type = "property"
        property = "kong.client.principal"
      }, 

      {
        name = "BUILD_CLAIMS"
        type = "jq"
        input = "GET_PRINCIPAL"
        jq = <<EOF
{
  "sub": .id
}
EOF
      }, 

      {
        name = "SIGN_JWT"
        type = "jwt_sign"
        algorithm = "HS256"
        expires_in = 300

        static_claims = {
          iss = "kong"
        }

        inputs = {
          claims = "BUILD_CLAIMS"
          key = "vault.jwt_hmac_key"
        }
      }, 

      {
        name = "BUILD_HEADER"
        type = "jq"
        input = "SIGN_JWT.token"
        jq = <<EOF
{
  "X-Consumer-JWT": .
}
EOF
        output = "service_request.headers"
      }    ]
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
}

Copied!

Add this section to your kong.yaml configuration file:

decK

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: datakit
    service: serviceName|Id
    config:
      resources:
        vault:
          jwt_hmac_key: "{vault://env/JWT_HMAC_SECRET}"
      nodes:
      - name: GET_PRINCIPAL
        type: property
        property: kong.client.principal
      - name: BUILD_CLAIMS
        type: jq
        input: GET_PRINCIPAL
        jq: |
          {
            "sub": .id
          }
      - name: SIGN_JWT
        type: jwt_sign
        algorithm: HS256
        expires_in: 300
        static_claims:
          iss: kong
        inputs:
          claims: BUILD_CLAIMS
          key: vault.jwt_hmac_key
      - name: BUILD_HEADER
        type: jq
        input: SIGN_JWT.token
        jq: |
          {
            "X-Consumer-JWT": .
          }
        output: service_request.headers

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/services/{serviceName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "datakit",
      "config": {
        "resources": {
          "vault": {
            "jwt_hmac_key": "{vault://env/JWT_HMAC_SECRET}"
          }
        },
        "nodes": [
          {
            "name": "GET_PRINCIPAL",
            "type": "property",
            "property": "kong.client.principal"
          },
          {
            "name": "BUILD_CLAIMS",
            "type": "jq",
            "input": "GET_PRINCIPAL",
            "jq": "{\n  \"sub\": .id\n}\n"
          },
          {
            "name": "SIGN_JWT",
            "type": "jwt_sign",
            "algorithm": "HS256",
            "expires_in": 300,
            "static_claims": {
              "iss": "kong"
            },
            "inputs": {
              "claims": "BUILD_CLAIMS",
              "key": "vault.jwt_hmac_key"
            }
          },
          {
            "name": "BUILD_HEADER",
            "type": "jq",
            "input": "SIGN_JWT.token",
            "jq": "{\n  \"X-Consumer-JWT\": .\n}\n",
            "output": "service_request.headers"
          }
        ]
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

serviceName|Id: The id or name of the service the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "datakit",
      "config": {
        "resources": {
          "vault": {
            "jwt_hmac_key": "{vault://env/JWT_HMAC_SECRET}"
          }
        },
        "nodes": [
          {
            "name": "GET_PRINCIPAL",
            "type": "property",
            "property": "kong.client.principal"
          },
          {
            "name": "BUILD_CLAIMS",
            "type": "jq",
            "input": "GET_PRINCIPAL",
            "jq": "{\n  \"sub\": .id\n}\n"
          },
          {
            "name": "SIGN_JWT",
            "type": "jwt_sign",
            "algorithm": "HS256",
            "expires_in": 300,
            "static_claims": {
              "iss": "kong"
            },
            "inputs": {
              "claims": "BUILD_CLAIMS",
              "key": "vault.jwt_hmac_key"
            }
          },
          {
            "name": "BUILD_HEADER",
            "type": "jq",
            "input": "SIGN_JWT.token",
            "jq": "{\n  \"X-Consumer-JWT\": .\n}\n",
            "output": "service_request.headers"
          }
        ]
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.
serviceId: The id of the service the plugin configuration will target.

See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: datakit
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  resources:
    vault:
      jwt_hmac_key: '{vault://env/JWT_HMAC_SECRET}'
  nodes:
  - name: GET_PRINCIPAL
    type: property
    property: kong.client.principal
  - name: BUILD_CLAIMS
    type: jq
    input: GET_PRINCIPAL
    jq: |
      {
        'sub': .id
      }
  - name: SIGN_JWT
    type: jwt_sign
    algorithm: HS256
    expires_in: 300
    static_claims:
      iss: kong
    inputs:
      claims: BUILD_CLAIMS
      key: vault.jwt_hmac_key
  - name: BUILD_HEADER
    type: jq
    input: SIGN_JWT.token
    jq: |
      {
        'X-Consumer-JWT': .
      }
    output: service_request.headers
plugin: datakit
" | kubectl apply -f -

Copied!

Next, apply the KongPlugin resource by annotating the service resource:

kubectl annotate -n kong service SERVICE_NAME konghq.com/plugins=datakit

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_datakit" "my_datakit" {
  enabled = true

  config = {

    resources = {

      vault = {
        jwt_hmac_key = "{vault://env/JWT_HMAC_SECRET}"
      }
    }
    nodes = [
      {
        name = "GET_PRINCIPAL"
        type = "property"
        property = "kong.client.principal"
      }, 

      {
        name = "BUILD_CLAIMS"
        type = "jq"
        input = "GET_PRINCIPAL"
        jq = <<EOF
{
  "sub": .id
}
EOF
      }, 

      {
        name = "SIGN_JWT"
        type = "jwt_sign"
        algorithm = "HS256"
        expires_in = 300

        static_claims = {
          iss = "kong"
        }

        inputs = {
          claims = "BUILD_CLAIMS"
          key = "vault.jwt_hmac_key"
        }
      }, 

      {
        name = "BUILD_HEADER"
        type = "jq"
        input = "SIGN_JWT.token"
        jq = <<EOF
{
  "X-Consumer-JWT": .
}
EOF
        output = "service_request.headers"
      }    ]
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  service = {
    id = konnect_gateway_service.my_service.id
  }
}

Copied!

Add this section to your kong.yaml configuration file:

decK

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: datakit
    route: routeName|Id
    config:
      resources:
        vault:
          jwt_hmac_key: "{vault://env/JWT_HMAC_SECRET}"
      nodes:
      - name: GET_PRINCIPAL
        type: property
        property: kong.client.principal
      - name: BUILD_CLAIMS
        type: jq
        input: GET_PRINCIPAL
        jq: |
          {
            "sub": .id
          }
      - name: SIGN_JWT
        type: jwt_sign
        algorithm: HS256
        expires_in: 300
        static_claims:
          iss: kong
        inputs:
          claims: BUILD_CLAIMS
          key: vault.jwt_hmac_key
      - name: BUILD_HEADER
        type: jq
        input: SIGN_JWT.token
        jq: |
          {
            "X-Consumer-JWT": .
          }
        output: service_request.headers

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/routes/{routeName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "datakit",
      "config": {
        "resources": {
          "vault": {
            "jwt_hmac_key": "{vault://env/JWT_HMAC_SECRET}"
          }
        },
        "nodes": [
          {
            "name": "GET_PRINCIPAL",
            "type": "property",
            "property": "kong.client.principal"
          },
          {
            "name": "BUILD_CLAIMS",
            "type": "jq",
            "input": "GET_PRINCIPAL",
            "jq": "{\n  \"sub\": .id\n}\n"
          },
          {
            "name": "SIGN_JWT",
            "type": "jwt_sign",
            "algorithm": "HS256",
            "expires_in": 300,
            "static_claims": {
              "iss": "kong"
            },
            "inputs": {
              "claims": "BUILD_CLAIMS",
              "key": "vault.jwt_hmac_key"
            }
          },
          {
            "name": "BUILD_HEADER",
            "type": "jq",
            "input": "SIGN_JWT.token",
            "jq": "{\n  \"X-Consumer-JWT\": .\n}\n",
            "output": "service_request.headers"
          }
        ]
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

routeName|Id: The id or name of the route the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "datakit",
      "config": {
        "resources": {
          "vault": {
            "jwt_hmac_key": "{vault://env/JWT_HMAC_SECRET}"
          }
        },
        "nodes": [
          {
            "name": "GET_PRINCIPAL",
            "type": "property",
            "property": "kong.client.principal"
          },
          {
            "name": "BUILD_CLAIMS",
            "type": "jq",
            "input": "GET_PRINCIPAL",
            "jq": "{\n  \"sub\": .id\n}\n"
          },
          {
            "name": "SIGN_JWT",
            "type": "jwt_sign",
            "algorithm": "HS256",
            "expires_in": 300,
            "static_claims": {
              "iss": "kong"
            },
            "inputs": {
              "claims": "BUILD_CLAIMS",
              "key": "vault.jwt_hmac_key"
            }
          },
          {
            "name": "BUILD_HEADER",
            "type": "jq",
            "input": "SIGN_JWT.token",
            "jq": "{\n  \"X-Consumer-JWT\": .\n}\n",
            "output": "service_request.headers"
          }
        ]
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.
routeId: The id of the route the plugin configuration will target.

See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: datakit
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  resources:
    vault:
      jwt_hmac_key: '{vault://env/JWT_HMAC_SECRET}'
  nodes:
  - name: GET_PRINCIPAL
    type: property
    property: kong.client.principal
  - name: BUILD_CLAIMS
    type: jq
    input: GET_PRINCIPAL
    jq: |
      {
        'sub': .id
      }
  - name: SIGN_JWT
    type: jwt_sign
    algorithm: HS256
    expires_in: 300
    static_claims:
      iss: kong
    inputs:
      claims: BUILD_CLAIMS
      key: vault.jwt_hmac_key
  - name: BUILD_HEADER
    type: jq
    input: SIGN_JWT.token
    jq: |
      {
        'X-Consumer-JWT': .
      }
    output: service_request.headers
plugin: datakit
" | kubectl apply -f -

Copied!

Next, apply the KongPlugin resource by annotating the httproute or ingress resource:

kubectl annotate -n kong httproute  konghq.com/plugins=datakit

Copied!

kubectl annotate -n kong ingress  konghq.com/plugins=datakit

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_datakit" "my_datakit" {
  enabled = true

  config = {

    resources = {

      vault = {
        jwt_hmac_key = "{vault://env/JWT_HMAC_SECRET}"
      }
    }
    nodes = [
      {
        name = "GET_PRINCIPAL"
        type = "property"
        property = "kong.client.principal"
      }, 

      {
        name = "BUILD_CLAIMS"
        type = "jq"
        input = "GET_PRINCIPAL"
        jq = <<EOF
{
  "sub": .id
}
EOF
      }, 

      {
        name = "SIGN_JWT"
        type = "jwt_sign"
        algorithm = "HS256"
        expires_in = 300

        static_claims = {
          iss = "kong"
        }

        inputs = {
          claims = "BUILD_CLAIMS"
          key = "vault.jwt_hmac_key"
        }
      }, 

      {
        name = "BUILD_HEADER"
        type = "jq"
        input = "SIGN_JWT.token"
        jq = <<EOF
{
  "X-Consumer-JWT": .
}
EOF
        output = "service_request.headers"
      }    ]
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  route = {
    id = konnect_gateway_route.my_route.id
  }
}

Copied!

Add this section to your kong.yaml configuration file:

decK

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: datakit
    consumer: consumerName|Id
    config:
      resources:
        vault:
          jwt_hmac_key: "{vault://env/JWT_HMAC_SECRET}"
      nodes:
      - name: GET_PRINCIPAL
        type: property
        property: kong.client.principal
      - name: BUILD_CLAIMS
        type: jq
        input: GET_PRINCIPAL
        jq: |
          {
            "sub": .id
          }
      - name: SIGN_JWT
        type: jwt_sign
        algorithm: HS256
        expires_in: 300
        static_claims:
          iss: kong
        inputs:
          claims: BUILD_CLAIMS
          key: vault.jwt_hmac_key
      - name: BUILD_HEADER
        type: jq
        input: SIGN_JWT.token
        jq: |
          {
            "X-Consumer-JWT": .
          }
        output: service_request.headers

Make sure to replace the following placeholders with your own values:

consumerName|Id: The id or name of the consumer the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/consumers/{consumerName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "datakit",
      "config": {
        "resources": {
          "vault": {
            "jwt_hmac_key": "{vault://env/JWT_HMAC_SECRET}"
          }
        },
        "nodes": [
          {
            "name": "GET_PRINCIPAL",
            "type": "property",
            "property": "kong.client.principal"
          },
          {
            "name": "BUILD_CLAIMS",
            "type": "jq",
            "input": "GET_PRINCIPAL",
            "jq": "{\n  \"sub\": .id\n}\n"
          },
          {
            "name": "SIGN_JWT",
            "type": "jwt_sign",
            "algorithm": "HS256",
            "expires_in": 300,
            "static_claims": {
              "iss": "kong"
            },
            "inputs": {
              "claims": "BUILD_CLAIMS",
              "key": "vault.jwt_hmac_key"
            }
          },
          {
            "name": "BUILD_HEADER",
            "type": "jq",
            "input": "SIGN_JWT.token",
            "jq": "{\n  \"X-Consumer-JWT\": .\n}\n",
            "output": "service_request.headers"
          }
        ]
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

consumerName|Id: The id or name of the consumer the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumers/{consumerId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "datakit",
      "config": {
        "resources": {
          "vault": {
            "jwt_hmac_key": "{vault://env/JWT_HMAC_SECRET}"
          }
        },
        "nodes": [
          {
            "name": "GET_PRINCIPAL",
            "type": "property",
            "property": "kong.client.principal"
          },
          {
            "name": "BUILD_CLAIMS",
            "type": "jq",
            "input": "GET_PRINCIPAL",
            "jq": "{\n  \"sub\": .id\n}\n"
          },
          {
            "name": "SIGN_JWT",
            "type": "jwt_sign",
            "algorithm": "HS256",
            "expires_in": 300,
            "static_claims": {
              "iss": "kong"
            },
            "inputs": {
              "claims": "BUILD_CLAIMS",
              "key": "vault.jwt_hmac_key"
            }
          },
          {
            "name": "BUILD_HEADER",
            "type": "jq",
            "input": "SIGN_JWT.token",
            "jq": "{\n  \"X-Consumer-JWT\": .\n}\n",
            "output": "service_request.headers"
          }
        ]
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.
consumerId: The id of the consumer the plugin configuration will target.

See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: datakit
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  resources:
    vault:
      jwt_hmac_key: '{vault://env/JWT_HMAC_SECRET}'
  nodes:
  - name: GET_PRINCIPAL
    type: property
    property: kong.client.principal
  - name: BUILD_CLAIMS
    type: jq
    input: GET_PRINCIPAL
    jq: |
      {
        'sub': .id
      }
  - name: SIGN_JWT
    type: jwt_sign
    algorithm: HS256
    expires_in: 300
    static_claims:
      iss: kong
    inputs:
      claims: BUILD_CLAIMS
      key: vault.jwt_hmac_key
  - name: BUILD_HEADER
    type: jq
    input: SIGN_JWT.token
    jq: |
      {
        'X-Consumer-JWT': .
      }
    output: service_request.headers
plugin: datakit
" | kubectl apply -f -

Copied!

Next, apply the KongPlugin resource by annotating the KongConsumer resource:

kubectl annotate -n kong kongconsumer CONSUMER_NAME konghq.com/plugins=datakit

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_datakit" "my_datakit" {
  enabled = true

  config = {

    resources = {

      vault = {
        jwt_hmac_key = "{vault://env/JWT_HMAC_SECRET}"
      }
    }
    nodes = [
      {
        name = "GET_PRINCIPAL"
        type = "property"
        property = "kong.client.principal"
      }, 

      {
        name = "BUILD_CLAIMS"
        type = "jq"
        input = "GET_PRINCIPAL"
        jq = <<EOF
{
  "sub": .id
}
EOF
      }, 

      {
        name = "SIGN_JWT"
        type = "jwt_sign"
        algorithm = "HS256"
        expires_in = 300

        static_claims = {
          iss = "kong"
        }

        inputs = {
          claims = "BUILD_CLAIMS"
          key = "vault.jwt_hmac_key"
        }
      }, 

      {
        name = "BUILD_HEADER"
        type = "jq"
        input = "SIGN_JWT.token"
        jq = <<EOF
{
  "X-Consumer-JWT": .
}
EOF
        output = "service_request.headers"
      }    ]
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  consumer = {
    id = konnect_gateway_consumer.my_consumer.id
  }
}

Copied!

Add this section to your kong.yaml configuration file:

decK

kong.yaml

Copied!

_format_version: "3.0"
plugins:
  - name: datakit
    consumer_group: consumerGroupName|Id
    config:
      resources:
        vault:
          jwt_hmac_key: "{vault://env/JWT_HMAC_SECRET}"
      nodes:
      - name: GET_PRINCIPAL
        type: property
        property: kong.client.principal
      - name: BUILD_CLAIMS
        type: jq
        input: GET_PRINCIPAL
        jq: |
          {
            "sub": .id
          }
      - name: SIGN_JWT
        type: jwt_sign
        algorithm: HS256
        expires_in: 300
        static_claims:
          iss: kong
        inputs:
          claims: BUILD_CLAIMS
          key: vault.jwt_hmac_key
      - name: BUILD_HEADER
        type: jq
        input: SIGN_JWT.token
        jq: |
          {
            "X-Consumer-JWT": .
          }
        output: service_request.headers

Make sure to replace the following placeholders with your own values:

consumerGroupName|Id: The id or name of the consumer group the plugin configuration will target.

Make the following request:

curl -i -X POST http://localhost:8001/consumer_groups/{consumerGroupName|Id}/plugins/ \
    --header "Accept: application/json" \
    --header "Content-Type: application/json" \
    --data '
    {
      "name": "datakit",
      "config": {
        "resources": {
          "vault": {
            "jwt_hmac_key": "{vault://env/JWT_HMAC_SECRET}"
          }
        },
        "nodes": [
          {
            "name": "GET_PRINCIPAL",
            "type": "property",
            "property": "kong.client.principal"
          },
          {
            "name": "BUILD_CLAIMS",
            "type": "jq",
            "input": "GET_PRINCIPAL",
            "jq": "{\n  \"sub\": .id\n}\n"
          },
          {
            "name": "SIGN_JWT",
            "type": "jwt_sign",
            "algorithm": "HS256",
            "expires_in": 300,
            "static_claims": {
              "iss": "kong"
            },
            "inputs": {
              "claims": "BUILD_CLAIMS",
              "key": "vault.jwt_hmac_key"
            }
          },
          {
            "name": "BUILD_HEADER",
            "type": "jq",
            "input": "SIGN_JWT.token",
            "jq": "{\n  \"X-Consumer-JWT\": .\n}\n",
            "output": "service_request.headers"
          }
        ]
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

consumerGroupName|Id: The id or name of the consumer group the plugin configuration will target.

Make the following request:

curl -X POST https://{region}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/consumer_groups/{consumerGroupId}/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "name": "datakit",
      "config": {
        "resources": {
          "vault": {
            "jwt_hmac_key": "{vault://env/JWT_HMAC_SECRET}"
          }
        },
        "nodes": [
          {
            "name": "GET_PRINCIPAL",
            "type": "property",
            "property": "kong.client.principal"
          },
          {
            "name": "BUILD_CLAIMS",
            "type": "jq",
            "input": "GET_PRINCIPAL",
            "jq": "{\n  \"sub\": .id\n}\n"
          },
          {
            "name": "SIGN_JWT",
            "type": "jwt_sign",
            "algorithm": "HS256",
            "expires_in": 300,
            "static_claims": {
              "iss": "kong"
            },
            "inputs": {
              "claims": "BUILD_CLAIMS",
              "key": "vault.jwt_hmac_key"
            }
          },
          {
            "name": "BUILD_HEADER",
            "type": "jq",
            "input": "SIGN_JWT.token",
            "jq": "{\n  \"X-Consumer-JWT\": .\n}\n",
            "output": "service_request.headers"
          }
        ]
      }
    }
    '

Copied!

Make sure to replace the following placeholders with your own values:

region: Geographic region where your Kong Konnect is hosted and operates.
KONNECT_TOKEN: Your Personal Access Token (PAT) associated with your Konnect account.
controlPlaneId: The id of the control plane.
consumerGroupId: The id of the consumer group the plugin configuration will target.

See the Konnect Control Planes Config API reference to learn about region-specific URLs and personal access tokens.

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: datakit
  namespace: kong
  annotations:
    kubernetes.io/ingress.class: kong
config:
  resources:
    vault:
      jwt_hmac_key: '{vault://env/JWT_HMAC_SECRET}'
  nodes:
  - name: GET_PRINCIPAL
    type: property
    property: kong.client.principal
  - name: BUILD_CLAIMS
    type: jq
    input: GET_PRINCIPAL
    jq: |
      {
        'sub': .id
      }
  - name: SIGN_JWT
    type: jwt_sign
    algorithm: HS256
    expires_in: 300
    static_claims:
      iss: kong
    inputs:
      claims: BUILD_CLAIMS
      key: vault.jwt_hmac_key
  - name: BUILD_HEADER
    type: jq
    input: SIGN_JWT.token
    jq: |
      {
        'X-Consumer-JWT': .
      }
    output: service_request.headers
plugin: datakit
" | kubectl apply -f -

Copied!

Next, apply the KongPlugin resource by annotating the KongConsumerGroup resource:

kubectl annotate -n kong kongconsumergroup CONSUMERGROUP_NAME konghq.com/plugins=datakit

Copied!

Prerequisite: Configure your Personal Access Token

terraform {
  required_providers {
    konnect = {
      source  = "kong/konnect"
    }
  }
}

provider "konnect" {
  personal_access_token = "$KONNECT_TOKEN"
  server_url            = "https://us.api.konghq.com/"
}

Copied!

Add the following to your Terraform configuration to create a Konnect Gateway Plugin:

resource "konnect_gateway_plugin_datakit" "my_datakit" {
  enabled = true

  config = {

    resources = {

      vault = {
        jwt_hmac_key = "{vault://env/JWT_HMAC_SECRET}"
      }
    }
    nodes = [
      {
        name = "GET_PRINCIPAL"
        type = "property"
        property = "kong.client.principal"
      }, 

      {
        name = "BUILD_CLAIMS"
        type = "jq"
        input = "GET_PRINCIPAL"
        jq = <<EOF
{
  "sub": .id
}
EOF
      }, 

      {
        name = "SIGN_JWT"
        type = "jwt_sign"
        algorithm = "HS256"
        expires_in = 300

        static_claims = {
          iss = "kong"
        }

        inputs = {
          claims = "BUILD_CLAIMS"
          key = "vault.jwt_hmac_key"
        }
      }, 

      {
        name = "BUILD_HEADER"
        type = "jq"
        input = "SIGN_JWT.token"
        jq = <<EOF
{
  "X-Consumer-JWT": .
}
EOF
        output = "service_request.headers"
      }    ]
  }

  control_plane_id = konnect_gateway_control_plane.my_konnect_cp.id
  consumer_group = {
    id = konnect_gateway_consumer_group.my_consumer_group.id
  }
}

Copied!

Datakit

Sign JWT with Principal IDv3.16+

Prerequisites

Set up the plugin

Help us make these docs great!

Still need help?