HMAC Auth Configuration

You are browsing documentation for an outdated plugin version.

Configuration

This plugin is partially compatible with DB-less mode.

Consumers and Credentials can be created with declarative configuration.

Admin API endpoints that do POST, PUT, PATCH or DELETE on Credentials will not work on DB-less mode.

Compatible protocols

The HMAC Auth plugin is compatible with the following protocols:

grpc, grpcs, http, https, ws, wss

Parameters

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

• name or plugin

  string required

  The name of the plugin, in this case hmac-auth.

  • If using the Kong Admin API, Konnect API, declarative configuration, or decK files, the field is name.
  • If using the KongPlugin object in Kubernetes, the field is plugin.

• instance_name

  string

  An optional custom name to identify an instance of the plugin, for example hmac-auth_my-service.

  The instance name shows up in Kong Manager and in Konnect, so it's useful when running the same plugin in multiple contexts, for example, on multiple services. You can also use it to access a specific plugin instance via the Kong Admin API.

  An instance name must be unique within the following context:

  • Within a workspace for Kong Gateway Enterprise
  • Within a control plane or control plane group for Konnect
  • Globally for Kong Gateway (OSS)

• service.name or service.id

  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/{serviceName|Id}/plugins.

• route.name or route.id

  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/{routeName|Id}/plugins.

• enabled

  boolean default: true

  Whether this plugin will be applied.

• config

  record required
  • hide_credentials

    boolean required default: false

    An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin strips the credential from the request (i.e. the Authorization header) before proxying it.

  • clock_skew

    number default: 300

    Clock Skew in seconds to prevent replay attacks.

  • anonymous

    string

    An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure 4xx. Please note that this value must refer to the Consumer id or username attribute, and not its custom_id.

  • validate_request_body

    boolean required default: false

    A boolean value telling the plugin to enable body validation.

  • enforce_headers

    array of type string

    A list of headers that the client should at least use for HTTP signature creation.

  • algorithms

    array of type string default: hmac-sha1, hmac-sha256, hmac-sha384, hmac-sha512 Must be one of: hmac-sha1, hmac-sha256, hmac-sha384, hmac-sha512

    A list of HMAC digest algorithms that the user wants to support. Allowed values are hmac-sha1, hmac-sha256, hmac-sha384, and hmac-sha512