Basic config examples for HMAC Auth

Make the following request:

curl -X POST http://localhost:8001/services/{serviceName|Id}/plugins \
    --data "name=hmac-auth"  \
    --data "config.hide_credentials=false"

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

Make the following request, substituting your own access token, region, control plane ID, and service ID:

curl -X POST \
https://{us|eu}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/services/{serviceId}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer TOKEN" \
    --data '{"name":"hmac-auth","config":{"hide_credentials":false}}'

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

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: hmac-auth-example
plugin: hmac-auth
config:
  hide_credentials: false
" | kubectl apply -f -

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

kubectl annotate service SERVICE_NAME konghq.com/plugins=hmac-auth-example

Replace SERVICE_NAME with the name of the service that this plugin configuration will target. You can see your available ingresses by running kubectl get service.

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.

As this is an auth plugin, you need to create a credential for the plugin. Create a secret with the following command:

kubectl create secret generic alex-hmac-auth \
  --from-literal=kongCredType=hmac-auth \
  --from-literal=username=alex \
  --from-literal=secret=secret123

Finally, create a consumer that will use this credential:

echo "apiVersion: configuration.konghq.com/v1
kind: KongConsumer
metadata:
  name: alex
  annotations:
    kubernetes.io/ingress.class: kong
username: alex
credentials:
- alex-hmac-auth
" | kubectl apply -f -

You can now authenticate as alex when making your request. See the documentation for more information.

Add this section to your declarative configuration file:

plugins:
- name: hmac-auth
  service: SERVICE_NAME|ID
  config:
    hide_credentials: false

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

Make the following request:

curl -X POST http://localhost:8001/routes/{routeName|Id}/plugins \
    --data "name=hmac-auth"  \
    --data "config.hide_credentials=false"

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

Make the following request, substituting your own access token, region, control plane ID, and route ID:

curl -X POST \
https://{us|eu}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/routes/{routeId}/plugins \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer TOKEN" \
    --data '{"name":"hmac-auth","config":{"hide_credentials":false}}'

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

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: hmac-auth-example
plugin: hmac-auth
config:
  hide_credentials: false
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the ingress as follows:

kubectl annotate ingress INGRESS_NAME konghq.com/plugins=hmac-auth-example

Replace INGRESS_NAME with the name of the ingress that this plugin configuration will target. You can see your available ingresses by running kubectl get ingress.

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.

As this is an auth plugin, you need to create a credential for the plugin. Create a secret with the following command:

kubectl create secret generic alex-hmac-auth \
  --from-literal=kongCredType=hmac-auth \
  --from-literal=username=alex \
  --from-literal=secret=secret123

Finally, create a consumer that will use this credential:

echo "apiVersion: configuration.konghq.com/v1
kind: KongConsumer
metadata:
  name: alex
  annotations:
    kubernetes.io/ingress.class: kong
username: alex
credentials:
- alex-hmac-auth
" | kubectl apply -f -

You can now authenticate as alex when making your request. See the documentation for more information.

Add this section to your declarative configuration file:

plugins:
- name: hmac-auth
  route: ROUTE_NAME|ID
  config:
    hide_credentials: false

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

Make the following request:

curl -X POST http://localhost:8001/plugins/ \
    --data "name=hmac-auth"  \
    --data "config.hide_credentials=false"

Make the following request, substituting your own access token, region, and control plane ID:

curl -X POST \
https://{us|eu}.api.konghq.com/v2/control-planes/{controlPlaneId}/core-entities/plugins/ \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer TOKEN" \
    --data '{"name":"hmac-auth","config":{"hide_credentials":false}}'

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

Create a KongClusterPlugin resource and label it as global:

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

As this is an auth plugin, you need to create a credential for the plugin. Create a secret with the following command:

kubectl create secret generic alex-hmac-auth \
  --from-literal=kongCredType=hmac-auth \
  --from-literal=username=alex \
  --from-literal=secret=secret123

Finally, create a consumer that will use this credential:

echo "apiVersion: configuration.konghq.com/v1
kind: KongConsumer
metadata:
  name: alex
  annotations:
    kubernetes.io/ingress.class: kong
username: alex
credentials:
- alex-hmac-auth
" | kubectl apply -f -

You can now authenticate as alex when making your request. See the documentation for more information.

Add a plugins entry in the declarative configuration file:

plugins:
- name: hmac-auth
  config:
    hide_credentials: false