Client TLS authentication

Statistics

Every configured client TLS authentication filter has statistics rooted at auth.clientssl.. with the following statistics:

NameTypeDescription
update_successCounterTotal principal update successes
update_failureCounterTotal principal update failures
auth_no_sslCounterTotal connections ignored due to no TLS
auth_ip_white_listCounterTotal connections allowed due to the IP white list
auth_digest_matchCounterTotal connections allowed due to certificate match
auth_digest_no_matchCounterTotal connections denied due to no certificate match
total_principalsGaugeTotal loaded principals

REST API

GET /v1/certs/list/approved

The authentication filter will call this API every refresh interval to fetch the current list of approved certificates/principals. The expected JSON response looks like:

  1. {
  2. "certificates": []
  3. }
  • certificates

    (required, array) list of approved certificates/principals.

Each certificate object is defined as:

  1. {
  2. "fingerprint_sha256": "...",
  3. }
  • fingerprint_sha256

    (required, string) The SHA256 hash of the approved client certificate. Envoy will match this hash to the presented client certificate to determine whether there is a digest match.