Skip to content

Commit

Permalink
Adjust docs based on PR review feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
tkan145 committed Oct 2, 2024
1 parent e85a9ce commit c7f735b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions doc/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -406,10 +406,10 @@ If this parameter has `1` as its value, it is possible to include an additional

**Default:** `optional_no_ca`
**Values:**
- `off`: Don't request client certificates and don't do client certificate verification.
- `off`: Do not request client certificates or perform client certificate verification.
- `optional_no_ca`: Requests the client certificate, but does not fail the request when the client certificate is not signed by a trusted CA certificate.

Enables verification of client certificates. The client certificates can be verified with TLS Client Certificate Validation policy
Enables verification of client certificates. You can verify client certificates TLS Client Certificate Validation policy.

### `all_proxy`, `ALL_PROXY`

Expand Down
4 changes: 2 additions & 2 deletions gateway/src/apicast/policy/tls_validation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ For example you can add to the whitelist just leaf client certificates without t

For this policy to work, APIcast need to be setup to listen for TLS connection.

By default, client certificates are requested during the TLS handshake, however, APIcast will not verify the certificate or terminate the request unless a TLS Validation Policy is in the chain. In most cases, the client not presenting a client certificate will not affect a service that does not have TLS Validation policy configured. The only exception is when the service is used by a browser or front-end application, which will cause the browser to always prompt the end user to select a client certificate to send if they have ANY client certificates configured when browsing the service.
By default, during the TLS handshake, APIcast requests client certificates, but will not verify the certificate or terminate the request unless a TLS Validation Policy is in the chain. In most cases, the client not presenting a client certificate will not affect a service that does not have TLS Validation policy configured. The only exception is when a browser or front-end application uses the service. In this case, the browser will always prompt the user to choose a client certificate to send if they have any client certificates set up while accessing the service.

To work around this, the environment variable `APICAST_HTTPS_VERIFY_CLIENT` can be set to `off` to instruct APIcast to request a client certificate ONLY when the policy is in the chain.
To work around this, set the environment variable `APICAST_HTTPS_VERIFY_CLIENT` to `off`. This instructs APIcast to request a client certificate only when the policy is in the chain.

NOTE: This policy is not compatible with `APICAST_PATH_ROUTING` or `APICAST_PATH_ROUTING_ONLY` when `APICAST_HTTPS_VERIFY_CLIENT` is set to `off`.

Expand Down

0 comments on commit c7f735b

Please sign in to comment.