Vault Authentication plugin

Add authentication to a Service or Route with an access token and secret token. Credential tokens are stored securely via Vault. Credential lifecyles can be managed through the Kong Admin API, or independently via Vault.

Configuration Reference

This plugin is compatible with DB-less mode.

In DB-less mode, you configure Kong Gateway declaratively. Therefore, the Admin API is mostly read-only. The only tasks it can perform are all related to handling the declarative config, including:

Setting a target's health status in the load balancer
Validating configurations against schemas
Uploading the declarative configuration using the /config endpoint

Example plugin configuration

Enable on a service

Enable on a route

Enable globally

The following examples provide some typical configurations for enabling the vault-auth plugin on a service.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/services/SERVICE_NAME|SERVICE_ID/plugins \
    --data "name=vault-auth"  \
    --data "config.vault.id=<UUID>"

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: vault-auth-example
config: 
  vault:
    id: <UUID>
plugin: vault-auth

Next, apply the KongPlugin resource to a service by annotating the service as follows:

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

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: vault-auth
  service: SERVICE_NAME|SERVICE_ID
  config: 
    vault:
      id: <UUID>

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

The following examples provide some typical configurations for enabling the vault-auth plugin on a route.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/routes/ROUTE_NAME|ROUTE_ID/plugins \
  --data "name=vault-auth"  \
    --data "config.vault.id=<UUID>"

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

First, create a KongPlugin resource:

apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: vault-auth-example
config: 
  vault:
    id: <UUID>
plugin: vault-auth

Then, apply it to an ingress (route or routes) by annotating the ingress as follows:

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

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: vault-auth
  route: ROUTE_NAME
  config: 
    vault:
      id: <UUID>

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

A plugin which is not associated to any service, route, or consumer is considered global, and will be run on every request. Read the Plugin Reference and the Plugin Precedence sections for more information.

The following examples provide some typical configurations for enabling the vault-auth plugin globally.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/plugins/ \
  --data "name=vault-auth"  \
    --data "config.vault.id=<UUID>"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-vault-auth>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: \"true\"
config: 
  vault:
    id: <UUID>
plugin: vault-auth

Add a plugins entry in the declarative configuration file:

plugins:
- name: vault-auth
  config: 
    vault:
      id: <UUID>

Parameters

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

Form Parameter	Description
`name` required Type: string	The name of the plugin, in this case `vault-auth`.
`service.name` or `service.id` Type: string	The name or ID of the service the plugin targets. Set one of these parameters if adding the plugin to a service through the top-level `/plugins` endpoint. Not required if using `/services/SERVICE_NAME\|SERVICE_ID/plugins`.
`route.name` or `route.id` Type: string	The name or ID of the route the plugin targets. Set one of these parameters if adding the plugin to a route through the top-level `/plugins` endpoint. Not required if using `/routes/ROUTE_NAME\|ROUTE_ID/plugins`.
`enabled` Type: boolean Default value: `true`	Whether this plugin will be applied.
`config.access_token_name` required Type: array of string elements Default value: `access_token`	Describes an array of comma-separated parameter names where the plugin looks for an access token. The client must send the access token in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].
`config.vault.id` required Type: foreign UUID	A reference to an existing `vault` object within the database. `vault` entities define the connection and authentication parameters used to connect to a Vault HTTP(S) API.
`config.secret_token_name` required Type: array of string elements Default value: `secret_token`	Describes an array of comma-separated parameter names where the plugin looks for a secret token. The client must send the secret in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].
`config.tokens_in_body` required Type: boolean Default value: `false`	If enabled, the plugin will read the request body (if said request has one and its MIME type is supported) and try to find the key in it. Supported MIME types are `application/www-form-urlencoded`, `application/json`, and `multipart/form-data`.
`config.hide_credentials` required Type: boolean Default value: `false`	An optional boolean value telling the plugin to show or hide the credential from the upstream service. If `true`, the plugin will strip the credential from the request (i.e. the header or querystring containing the key) before proxying it.
`config.anonymous` optional Type: string	An optional string (consumer uuid) value to use as an “anonymous” consumer if authentication fails. If empty (default), the request will fail with an authentication failure `4xx`. Note: This value must refer to the Consumer `id` attribute that is internal to Kong Gateway, and not its `custom_id`.
`config.run_on_preflight` required Type: boolean Default value: `true`	A boolean value that indicates whether the plugin should run (and try to authenticate) on `OPTIONS` preflight requests. If set to `false`, then `OPTIONS` requests will always be allowed.

Usage

In order to use the plugin, you first need to create a Consumer to associate one or more credentials to. The Consumer represents a developer using the upstream service. Additionally, a Vault object must be created to represent the connection Kong will use to communicate with a Vault server, where access and secret tokens will be stored.

Create a Consumer

You need to associate a credential to an existing Consumer object. To create a Consumer, you can execute the following request:

curl -X POST http://kong:8001/consumers/ \
  --data "username=<USERNAME>" \
  --data "custom_id=<CUSTOM_ID>"

Response:

HTTP/1.1 201 Created

{
    "username":"<USERNAME>",
    "custom_id": "<CUSTOM_ID>",
    "created_at": 1472604384000,
    "id": "7f853474-7b70-439d-ad59-2481a0a9a904"
}

parameter	default	description
`username` semi-optional		The username of the Consumer. Either this field or `custom_id` must be specified.
`custom_id` semi-optional		A custom identifier used to map the Consumer to another database. Either this field or `username` must be specified.

A Consumer can have many credentials.

If you are also using the ACL plugin and allowed lists with this service, you must add the new consumer to an allowed group. See ACL: Associating Consumers for details.

Create a Vault

Vault Auth plugin only works with HashiCorp Vault KV Secrets Engine - Version 1.

A Vault object represents the connection between Kong and a Vault server. It defines the connection and authentication information used to communicate with the Vault API. This allows different instances of the vault-auth plugin to communicate with different Vault servers, providing a flexible deployment and consumption model.

Vault objects require setting a vault_token attribute. This attribute is referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.

Vault objects can be created via the following HTTP request:

curl -X POST http://localhost:8001/vault-auth \
  --header 'Content-Type: multipart/form-data' \
  --form name=kong-auth \
  --form mount=kong-auth \
  --form protocol=http \
  --form host=127.0.0.1 \
  --form port=8200 \
  --form vault_token=<token>

HTTP/1.1 201 Created

{
  "host": "127.0.0.1",
  "created_at": 1605288799,
  "vault_token": "<token>",
  "mount": "kong-auth",
  "protocol": "http",
  "name": "kong-auth",
  "port": 8200,
  "updated_at": 1605288799,
  "id": "c22198a3-cf54-428b-bed2-59c1f3760823"
}

This assumes a Vault server is accessible via 127.0.0.1:8200, and that a version 1 KV secrets engine has been enabled at kong-auth. Vault KV secrets engine documentation is available via the Vault documentation.

Create an Access/Secret Token Pair

vault-auth credentials are defined as a pair of tokens: an access token that identifies the owner of the credential, and a secret token that is used to authenticate ownership of the access token.

Token pairs can be managed either via the Kong Admin API, or independently via direct access with Vault. Token pairs must be associated with an existing Kong Consumer. Creating a token pair with the Kong Admin API can be done via the following request:

curl -X POST http://kong:8001/vault-auth/{vault}/credentials/{consumer}

Response:

HTTP/1.1 201 Created

{
    "data": {
        "access_token": "v3cOV1jWglS0PFOrTcdr85bs1GP0e2yM",
        "consumer": {
            "id": "64063284-e3b5-48e7-9bca-802251c32138"
        },
        "created_at": 1550538920,
        "secret_token": "11XYyybbu3Ty0Qt4ImIshPGQ0WsvjLzl",
        "ttl": null
    }
}

When the access_token or secret_token values are not provided, token values will be automatically generated via a cryptographically-secure random number generator (CSPRNG).

Integrating Vault objects with Vault-Auth plugins

Vault objects are treated as foreign references in plugin configs, creating a seamless lifecycle relationship between Vault instances and plugins with which they’re associated. vault-auth plugins require an association with a Vault object, which can be defined with the following HTTP request during plugin creation:

curl -X POST http://kong:8001/plugins \
  --data name=vault-auth \
  --data config.vault.id=<uuid>

Response:

HTTP/1.1 201 Created

{
  "created_at": 1550539002,
  "config": {
    "tokens_in_body": false,
    "secret_token_name": "secret_token",
    "run_on_preflight": true,
    "vault": {
      "id": "d3da058d-0acb-49c2-b7fe-72b3e9fd4b0a"
    },
    "anonymous": null,
    "hide_credentials": false,
    "access_token_name": "access_token"
  },
  "id": "b4d0cbb7-bff2-4599-ba19-67c705c15b9a",
  "service": null,
  "enabled": true,
  "run_on": "first",
  "consumer": null,
  "route": null,
  "name": "vault-auth"
}

Where <uuid> is the id of an existing Vault object.

Using Vault credentials

Simply make a request with the access_token and secret_token as querystring parameters:

curl http://kong:8000/{proxy path}?access_token=<access token>&secret_token=<secret token>

Or in a header:

curl http://kong:8000/{proxy path} \
  -H 'access_token: <access_token>' \
  -H 'secret_token: <secret_token>'

Deleting an Access/Secret Token Pair

Existing Vault credentials can be removed from the Vault server via the following API:

curl -X DELETE http://kong:8001/vault-auth/{vault}/credentials/token/{access token}

Response:

HTTP/1.1 204 No Content

Token TTL

When reading a token from Vault, Kong will search the responding KV value for the presence of a ttl field. When this is present, Kong will respect the advisory value of the ttlfield and store the value of the credential in cache for only as long as the ttl field defines. This allows tokens created directly in Vault, outside of the Kong Admin API, to be periodically refreshed by Kong.

Extra-Kong Token Pairs

Kong can read access/token secret pairs that have been created directly in Vault, outside of the Kong Admin API. Currently vault-auth supports creating and reading credentials based on the Vault v1 KV engine. Create Vault KV secret values must contain the following fields:

{
  access_token: <string>
  secret_token: <string>
  created_at: <integer>
  updated_at: <integer>
  ttl: <integer> (optional)
  consumer: {
    id: <uuid>
  }
}

Additional fields within the secret are ignored. The key must be the access_token value; this is the identifier by which Kong queries the Vault API to fetch the credential data. See the Vault documentation for further information on the KV v1 secrets engine.

vault-auth token pairs can be created with the Vault HTTP API or the vault write command:

vault write kong-auth/foo - <<EOF
{
  "access_token": "foo",
  "secret_token": "supersecretvalue",
  "consumer": {
    "id": "ce67c25e-2168-4a09-81e5-e06187a2384f"
  },
  "ttl": 86400
}
EOF

Changelog

Kong Gateway 2.8.1.3

The endpoints of Vault Auth plugin have been moved from /vaults to /vault-auth, with vaults_use_new_style_api=on set in kong.conf.

Kong Gateway 2.8.x

The vaults.vault_token form field is now marked as referenceable, which means it can be securely stored as a secret in a vault. References must follow a specific format.
Fixed plugin versions in the documentation. Previously, the plugin versions were labelled as 2.7.x, 2.1.x, 1.5.x, 1.3-x, 0.36-x, and 0.35-x. They are now updated to align with the plugin’s actual versions, 0.3.0, 0.2.2, 0.2.1, 0.2.0, 0.1.2, and 0.1.0 respectively.

Kong Gateway 2.7.x

Starting with Kong Gateway 2.7.0.0, if keyring encryption is enabled and you are using Vault, the vaults.vault_token and vault_credentials.secret_token fields will be encrypted.

About this Plugin
Plugin Version	3.0.x
Made by	Kong Inc.
Categories	Authentication
DB-less compatible?	Yes
Konnect Cloud compatible?	No