Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[release-v0.38] fix: Documentation references of client_auth in flow http client. #5886

Merged
merged 1 commit into from
Nov 29, 2023
Merged

[release-v0.38] fix: Documentation references of client_auth in flow http client. #5886

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/sources/flow/reference/config-blocks/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Name | Type | Description | Default | Required
`key_file` | `string` | Path to the server TLS key on disk. | `""` | conditionally
`client_ca_pem` | `string` | PEM data of the client CA to validate requests against. | `""` | no
`client_ca_file` | `string` | Path to the client CA file on disk to validate requests against. | `""` | no
`client_auth` | `string` | Client authentication to use. | `"NoClientCert"` | no
`client_auth_type` | `string` | Client authentication to use. | `"NoClientCert"` | no
`cipher_suites` | `list(string)` | Set of cipher suites to use. | `[]` | no
`curve_preferences` | `list(string)` | Set of elliptic curves to use in a handshake. | `[]` | no
`min_version` | `string` | Oldest TLS version to accept from clients. | `""` | no
Expand All @@ -97,12 +97,12 @@ configured at a time:
* `key_pem` and `key_file`
* `client_ca_pem` and `client_ca_file`

The `client_auth` argument determines whether to validate client certificates.
The `client_auth_type` argument determines whether to validate client certificates.
The default value, `NoClientCert`, indicates that the client certificate is not
validated. The `client_ca_pem` and `client_ca_file` arguments may only
be configured when `client_auth` is not `NoClientCert`.
be configured when `client_auth_type` is not `NoClientCert`.

The following values are accepted for `client_auth`:
The following values are accepted for `client_auth_type`:

* `NoClientCert`: client certificates are neither requested nor validated.
* `RequestClientCert`: requests clients to send an optional certificate. Certificates provided by clients are not validated.
Expand All @@ -111,7 +111,7 @@ The following values are accepted for `client_auth`:
* `RequireAndVerifyClientCert`: requires clients to send a valid certificate.

The `client_ca_pem` or `client_ca_file` arguments may be used to perform client
certificate validation. These arguments may only be provided when `client_auth`
certificate validation. These arguments may only be provided when `client_auth_type`
is not set to `NoClientCert`.

The `cipher_suites` argument determines what cipher suites to use. If not
Expand Down