Skip to content

Commit

Permalink
Clarify settings in default SSL/TLS (elastic#41779)
Browse files Browse the repository at this point in the history
The settings listed under the "Default values for TLS/SSL settings"
heading are not actual settings, rather they are common suffixes that
are used for settings that exist in a variety of contexts.

This commit changes the way they are presented to reduce this
confusion.
  • Loading branch information
tvernum authored May 6, 2019
1 parent 0bba210 commit 486742f
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions docs/reference/settings/security-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -1484,10 +1484,15 @@ through the list of URLs will continue until a successful connection is made.
[[ssl-tls-settings]]
==== Default values for TLS/SSL settings
In general, the values below represent the default values for the various TLS
settings. For more information, see
settings.
The prefixes for these settings are based on the context in which they are
used (e.g. `xpack.security.authc.realms.ldap.corp_ldap.ssl.verification_mode`
or `xpack.security.transport.ssl.supported_protocols`).

For more information, see
{stack-ov}/encrypting-communications.html[Encrypting communications].

`ssl.supported_protocols`::
`*.ssl.supported_protocols`::
Supported protocols with versions. Valid protocols: `SSLv2Hello`,
`SSLv3`, `TLSv1`, `TLSv1.1`, `TLSv1.2`, `TLSv1.3`. Defaults to `TLSv1.3,TLSv1.2,TLSv1.1` if
the JVM supports TLSv1.3, otherwise `TLSv1.2,TLSv1.1`.
Expand All @@ -1497,15 +1502,15 @@ NOTE: If `xpack.security.fips_mode.enabled` is `true`, you cannot use `SSLv2Hell
or `SSLv3`. See <<fips-140-compliance>>.
--

`ssl.client_authentication`::
`*.ssl.client_authentication`::
Controls the server's behavior in regard to requesting a certificate
from client connections. Valid values are `required`, `optional`, and `none`.
`required` forces a client to present a certificate, while `optional`
requests a client certificate but the client is not required to present one.
Defaults to `required`, except for HTTP, which defaults to `none`. See
<<http-tls-ssl-settings>>.

`ssl.verification_mode`::
`*.ssl.verification_mode`::
Controls the verification of certificates. Valid values are:
- `full`, which verifies that the provided certificate is signed by a trusted
authority (CA) and also verifies that the server's hostname (or IP
Expand All @@ -1520,7 +1525,7 @@ Controls the verification of certificates. Valid values are:
+
The default value is `full`.

`ssl.cipher_suites`::
`*.ssl.cipher_suites`::
Supported cipher suites can be found in Oracle's http://docs.oracle.com/javase/8/docs/technotes/guides/security/SunProviders.html[
Java Cryptography Architecture documentation]. Defaults to `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256`,
`TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256`, `TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA`, `TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA`,
Expand Down

0 comments on commit 486742f

Please sign in to comment.