Kong Upstream JWT

This plugin will add a signed JWT into the HTTP Header JWT of proxied requests through the Kong gateway. The purpose of this, is to provide means of Authentication, Authorization and Non-Repudiation to API providers (APIs for which Kong is a gateway).

API Providers need a means of cryptographically validating that requests they receive were proxied by Kong and not tampered with during transmission from Kong -> API Provider. This token accomplishes both as follows:

1. Authentication & Authorization - Provided by means of JWT signature validation. The API Provider will validate the signature on the JWT token (which is generating using Kong’s RSA x509 private key), using Kong’s public key. This public key can be maintained in a keystore, or sent with the token - provided API providers validate the signature chain against their truststore.

2. Non-Repudiation - SHA256 is used to hash the body of the HTTP request body, and the resulting digest is included in the payloadhash element of the JWT body. API Providers will take the SHA256 hash of the HTTP Request Body, and compare the digest to that found in the JWT. If they are identical, the request remained intact during transmission.

Installation

Recommended:

$ luarocks install kong-upstream-jwt

Other:

$ git clone https://github.com/Optum/kong-upstream-jwt.git /path/to/kong/plugins/kong-upstream-jwt
$ cd /path/to/kong/plugins/kong-upstream-jwt
$ luarocks make *.rockspec

Configuration

The plugin requires that Kong’s private key be accessible in order to sign the JWT. We also include the x509 cert in the x5c JWT Header for use by API providers to validate the JWT. We access these via Kong’s overriding environment variables KONG_SSL_CERT_KEY for the private key as well as KONG_SSL_CERT_DER for the public key. The first contains the path to your .key file, the second specifies the path to your public key in DER format .cer file.

If not already set, these can be done so as follows:

$ export KONG_SSL_CERT_KEY="/path/to/kong/ssl/privatekey.key"
$ export KONG_SSL_CERT_DER="/path/to/kong/ssl/kongpublickey.cer"

One last step is to make the environment variables accessible by a nginx worker. To do this, simply add these line to your nginx.conf

env KONG_SSL_CERT_KEY;
env KONG_SSL_CERT_DER;

Maintainers

jeremyjpj0916
rsbrisci

Feel free to open issues, or refer to our Contribution Guidelines if you have any questions.

Configuration Reference

This plugin is compatible with DB-less mode.

Example plugin configuration

curl -X POST http://localhost:8001/services/SERVICE_NAME|SERVICE_ID/plugins \
    --data "name=kong-upstream-jwt" 

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: kong-upstream-jwt-example
config:
  EXAMPLE_PARAMETER: EXAMPLE_VALUE
plugin: kong-upstream-jwt

apiVersion: v1
kind: Service
metadata:
  name: SERVICE_NAME|SERVICE_ID
  labels:
    app: SERVICE_NAME|SERVICE_ID
  annotations:
    konghq.com/plugins: kong-upstream-jwt-example
spec:
  ports:
  - port: 80
    targetPort: 80
    protocol: TCP
    name: SERVICE_NAME|SERVICE_ID
  selector:
    app: SERVICE_NAME|SERVICE_ID

plugins:
- name: kong-upstream-jwt
  service: SERVICE_NAME|SERVICE_ID
  config:
    EXAMPLE_PARAMETER: EXAMPLE_VALUE

curl -X POST http://localhost:8001/routes/ROUTE_NAME|ROUTE_ID/plugins \
  --data "name=kong-upstream-jwt" 

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: kong-upstream-jwt-example
config:
  EXAMPLE_PARAMETER: EXAMPLE_VALUE
plugin: kong-upstream-jwt

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: ROUTE_NAME|ROUTE_ID
  annotations:
    kubernetes.io/ingress.class: kong
    konghq.com/plugins: kong-upstream-jwt-example
spec:
  rules:
  - host: examplehostname.com
    http:
      paths:
      - path: /bar
        backend:
          service:
            name: echo
            port:
              number: 80

plugins:
- name: kong-upstream-jwt
  route: ROUTE_NAME
  config:
    EXAMPLE_PARAMETER: EXAMPLE_VALUE

curl -X POST http://localhost:8001/plugins/ \
  --data "name=kong-upstream-jwt" 

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-kong-upstream-jwt>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
config:
  <optional_parameter>: <value>
plugin: kong-upstream-jwt

plugins:
- name: kong-upstream-jwt
  config:
    EXAMPLE_PARAMETER: EXAMPLE_VALUE

Parameters

Here's a list of all the parameters which can be used in this plugin's configuration: