Skip to content

[DOCS] Fix client_authentication setting default #73743

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.

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

Merged
merged 1 commit into from
Jun 4, 2021

Conversation

tvernum
Copy link
Contributor

@tvernum tvernum commented Jun 4, 2021

The value of *.ssl.client_authentication is required for
everything except xpack.security.http.ssl.client_authentication, for
which is it none.

The doc template for this setting was configured to have a default
value, and allow an override. However, the default was set to none
when it should have been required.

The override for http was correctly set to none (but that didn't
really do anything, since that was the same as the default).

This commit changes the default to required, which matches the code
(see XPackSettings.CLIENT_AUTH_DEFAULT), and leaves the override for
http as none (see XPackSettings.HTTP_CLIENT_AUTH_DEFAULT).

The value of `*.ssl.client_authentication` is `required` for
everything except `xpack.security.http.ssl.client_authentication`, for
which is it `none`.

The doc template for this setting was configured to have a default
value, and allow an override. However, the default was set to `none`
when it should have been `required`.

The override for `http` was correctly set to `none` (but that didn't
really do anything, since that was the same as the default).

This commit changes the default to `required`, which matches the code
(see `XPackSettings.CLIENT_AUTH_DEFAULT`), and leaves the override for
http as `none` (see `XPackSettings.HTTP_CLIENT_AUTH_DEFAULT`).
@tvernum tvernum added >bug >docs General docs changes :Security/TLS SSL/TLS, Certificates v8.0.0 v7.14.0 v7.13.2 labels Jun 4, 2021
@tvernum tvernum requested a review from ywangd June 4, 2021 03:23
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Security Meta label for security team labels Jun 4, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-security (Team:Security)

Copy link
Member

@ywangd ywangd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, good catch!

PS: doc preview

@tvernum tvernum merged commit 7ce9398 into elastic:master Jun 4, 2021
tvernum added a commit to tvernum/elasticsearch that referenced this pull request Jun 4, 2021
The value of `*.ssl.client_authentication` is `required` for
everything except `xpack.security.http.ssl.client_authentication`, for
which is it `none`.

The doc template for this setting was configured to have a default
value, and allow an override. However, the default was set to `none`
when it should have been `required`.

The override for `http` was correctly set to `none` (but that didn't
really do anything, since that was the same as the default).

This commit changes the default to `required`, which matches the code
(see `XPackSettings.CLIENT_AUTH_DEFAULT`), and leaves the override for
http as `none` (see `XPackSettings.HTTP_CLIENT_AUTH_DEFAULT`).

Backport of: elastic#73743
tvernum added a commit that referenced this pull request Jun 4, 2021
The value of `*.ssl.client_authentication` is `required` for
everything except `xpack.security.http.ssl.client_authentication`, for
which is it `none`.

The doc template for this setting was configured to have a default
value, and allow an override. However, the default was set to `none`
when it should have been `required`.

The override for `http` was correctly set to `none` (but that didn't
really do anything, since that was the same as the default).

This commit changes the default to `required`, which matches the code
(see `XPackSettings.CLIENT_AUTH_DEFAULT`), and leaves the override for
http as `none` (see `XPackSettings.HTTP_CLIENT_AUTH_DEFAULT`).

Backport of: #73743
tvernum added a commit to tvernum/elasticsearch that referenced this pull request Jun 4, 2021
The value of `*.ssl.client_authentication` is `required` for
everything except `xpack.security.http.ssl.client_authentication`, for
which is it `none`.

The doc template for this setting was configured to have a default
value, and allow an override. However, the default was set to `none`
when it should have been `required`.

The override for `http` was correctly set to `none` (but that didn't
really do anything, since that was the same as the default).

This commit changes the default to `required`, which matches the code
(see `XPackSettings.CLIENT_AUTH_DEFAULT`), and leaves the override for
http as `none` (see `XPackSettings.HTTP_CLIENT_AUTH_DEFAULT`).

Backport of: elastic#73743
tvernum added a commit that referenced this pull request Jun 4, 2021
The value of `*.ssl.client_authentication` is `required` for
everything except `xpack.security.http.ssl.client_authentication`, for
which is it `none`.

The doc template for this setting was configured to have a default
value, and allow an override. However, the default was set to `none`
when it should have been `required`.

The override for `http` was correctly set to `none` (but that didn't
really do anything, since that was the same as the default).

This commit changes the default to `required`, which matches the code
(see `XPackSettings.CLIENT_AUTH_DEFAULT`), and leaves the override for
http as `none` (see `XPackSettings.HTTP_CLIENT_AUTH_DEFAULT`).

Backport of: #73743
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>bug >docs General docs changes :Security/TLS SSL/TLS, Certificates Team:Docs Meta label for docs team Team:Security Meta label for security team v7.13.2 v7.14.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants