Skip to content

gravitee-io/gravitee-policy-mtls

Repository files navigation

mTLS policy

Gravitee.io License Releases CircleCI

Phase

onRequest onResponse

X

Description

You can use the mtls policy to verify a client certificate exists as part of the request.

This policy does not ensure that certificates are valid, since it is done directly by the server.

Compatibility with APIM

Plugin version

APIM version

1.x

4.5 to latest

Errors

You can use the response template feature to override the default response provided by the policy. These templates must be defined at the API level (see the API Console Response Templates option in the API Entrypoints > Response Templates menu).

The error keys sent by this policy are as follows:

Key Parameters

CLIENT_CERTIFICATE_MISSING

-

CLIENT_CERTIFICATE_INVALID

-

SSL_SESSION_REQUIRED

-