HMAC Auth

Overview Examples Configuration reference Changelog API reference

Configuration

configobject

Hide Child Parameters

algorithmsarray[string]

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

Allowed values:hmac-sha1hmac-sha256hmac-sha384hmac-sha512

Default:hmac-sha1, hmac-sha256, hmac-sha384, hmac-sha512

anonymousstring

An optional string (Consumer UUID or username) value to use as an “anonymous” consumer if authentication fails.

clock_skewnumber

Clock skew in seconds to prevent replay attacks.

Default:300

>= 0

enforce_headersarray[string]

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

Default:[]

hide_credentialsboolean

An optional boolean value telling the plugin to show or hide the credential from the upstream service.

Default:false

realmstring

When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.

validate_request_bodyboolean

A boolean value telling the plugin to enable body validation.

Default:false

protocolsarray[string]

A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support tcp and tls.

Allowed values:grpcgrpcshttphttpswswss

Default:grpc, grpcs, http, https, ws, wss

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

HMAC Auth

Configuration

Did this doc help?

Help us make these docs great!

Still need help