-
Notifications
You must be signed in to change notification settings - Fork 179
Move own CA transport layer mtls guidance to security docs #3932
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
Open
shainaraskas
wants to merge
25
commits into
main
Choose a base branch
from
self-tls-considerations
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+123
−37
Open
Changes from 7 commits
Commits
Show all changes
25 commits
Select commit
Hold shift + click to select a range
4ef3fbb
dave-content
shainaraskas 3f5b433
add new considerations page, warnings to relevant procedures
shainaraskas c401bfa
too many brackets
shainaraskas c60da3e
Merge branch 'main' into self-tls-considerations
shainaraskas b94310e
polish
shainaraskas e43a868
Merge branch 'self-tls-considerations' of github.com:elastic/docs-con…
shainaraskas 60e11e0
polish 2
shainaraskas 74894f3
Update deploy-manage/security/self-tls-considerations.md
shainaraskas 141c98d
dave feedback
shainaraskas 59aaf4d
Merge branch 'self-tls-considerations' of github.com:elastic/docs-con…
shainaraskas d6ecddf
basic security tutorial now mostly works for private/3P CA case
shainaraskas fa7d774
Update deploy-manage/security/set-up-basic-security.md
shainaraskas b40ea3b
relocate note and reorder steps
shainaraskas d2ff6e6
Merge branch 'self-tls-considerations' of github.com:elastic/docs-con…
shainaraskas 462feef
Update deploy-manage/security/set-up-basic-security.md
shainaraskas 316536c
more edits
shainaraskas 89ec319
Merge branch 'self-tls-considerations' of github.com:elastic/docs-con…
shainaraskas 404c1db
use external instead of private/3p
shainaraskas b683d4e
additional feedback
shainaraskas 0566b5e
wajiha feedback
shainaraskas 2468cc7
wajiha feedback
shainaraskas 555c0f3
wajiha feedback ++
shainaraskas 580e632
define ca
shainaraskas 9cd7ad3
restore stuff removed in bad edit
shainaraskas df3fe49
edu david feedback
shainaraskas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| :::{warning} | ||
| Transport connections between {{es}} nodes are security-critical and you must protect them carefully. Malicious actors who can observe or interfere with node-to-node transport traffic can read or modify cluster data. A malicious actor who can establish a transport connection might be able to invoke system-internal APIs, including APIs that read or modify cluster data. | ||
shainaraskas marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| If you choose to issue node transport certificates using third-party tools, then carefully review [](/deploy-manage/security/self-tls-considerations.md) to ensure that the certificates that you provide meet the security requirements for transport connections. | ||
| ::: | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| --- | ||
| navigation_title: Considerations | ||
| applies_to: | ||
| deployment: | ||
| self: | ||
| eck: | ||
| products: | ||
| - id: elasticsearch | ||
| navigation_title: External CA considerations | ||
| --- | ||
|
|
||
| # Considerations for using an external CA for transport layer security | ||
shainaraskas marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| By default, {{es}} uses mutual TLS (mTLS) to secure node-to-node transport connections. With mTLS, data is encrypted in transit and both nodes must present valid certificates when connecting. Each node requires that certificates be issued by a trusted certificate authority, ensuring that only authorized nodes can connect. Configure trusted certificate authorities using settings in the [`xpack.security.transport.ssl.*`](elasticsearch://reference/elasticsearch/configuration-reference/security-settings.md#transport-tls-ssl-settings) namespace, such as `xpack.security.transport.ssl.certificate_authorities` and `xpack.security.transport.ssl.truststore.path`. | ||
shainaraskas marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
shainaraskas marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ::::{warning} | ||
| Transport connections between {{es}} nodes are security-critical and you must protect them carefully. Malicious actors who can observe or interfere with node-to-node transport traffic can read or modify cluster data. A malicious actor who can establish a transport connection might be able to invoke system-internal APIs, including APIs that read or modify cluster data. | ||
| :::: | ||
|
|
||
| ## External CA mTLS transport certificate requirements | ||
|
|
||
| Obtain your transport certificates from a certificate authority that only issues certificates to {{es}} nodes permitted to connect to your cluster. Do not use a public certificate authority or an organization-wide private certificate authority, because these issue certificates to entities beyond your authorized cluster nodes. Use a dedicated private certificate authority for each {{es}} cluster. | ||
|
|
||
| Certificates used for mTLS must either have no Extended Key Usage extension, or include both `clientAuth` and `serverAuth` values in the extension. Public certificate authorities typically omit the `clientAuth` value in the Extended Key Usage extension, making them unsuitable for mTLS. | ||
|
|
||
| ### Transport certificates vs. HTTP certificates | ||
|
|
||
| Transport certificates have different security requirements than [HTTP certificates](/deploy-manage/security/secure-cluster-communications.md#encrypt-http-communication). HTTP connections don't typically use mTLS because HTTP has its own authentication mechanisms. Because of this, HTTP certificates usually don't need to include the `clientAuth` value in their Extended Key Usage extension. HTTP certificates can come from public or organization-wide certificate authorities, while transport certificates should use a cluster-specific private CA. In most cases, you should not use the same certificate for both HTTP and transport connections. | ||
|
|
||
| ## Turning off mTLS for transport connections [turn-off-mtls] | ||
|
|
||
| If your environment has some other way to prevent unauthorized node-to-node connections, you can disable mTLS by setting `xpack.security.transport.ssl.client_authentication: none`. You can still use non-mutual TLS for encryption by setting `xpack.security.transport.ssl.enabled: true`. With non-mutual TLS, transport certificates don't require the `clientAuth` value in the Extended Key Usage extension. | ||
shainaraskas marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ::::{warning} | ||
| Turning off mTLS by setting `xpack.security.transport.ssl.client_authentication` to `optional` or `none` allows anyone with network access to establish transport connections. Malicious actors can use these connections to invoke system-internal APIs that may read or modify cluster data. Use mTLS to | ||
| protect your node-to-node transport connections unless you are absolutely certain that unauthorized network access to these nodes cannot occur. | ||
| :::: | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.