Skip to content

Commit 3f5b433

Browse files
committed
add new considerations page, warnings to relevant procedures
1 parent 4ef3fbb commit 3f5b433

File tree

8 files changed

+52
-56
lines changed

8 files changed

+52
-56
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
:::{warning}
2+
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.
3+
4+
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.
5+
:::

deploy-manage/security/different-ca.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ products:
1515

1616
If you have to trust a new CA from your organization, or you need to generate a new CA yourself, use this new CA to sign the new node certificates and instruct your nodes to trust the new CA.
1717

18+
:::{include} ./_snippets/own-ca-warning.md
19+
:::
20+
21+
1822
## Generate a new certificate for the transport layer [node-certs-different-transport]
1923

2024
Create a new CA certificate, or get the CA certificate of your organization, and add it to your existing CA truststore. After you finish updating your certificates for all nodes, you can remove the old CA certificate from your truststore (but not before!).

deploy-manage/security/k8s-transport-settings.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,12 @@ spec:
7575

7676
## Issue node transport certificates with third-party tools [k8s-transport-third-party-tools]
7777

78+
:::{warning}
79+
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.
80+
81+
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.
82+
:::
83+
7884
When following the instructions in [Configure a custom Certificate Authority](#k8s-transport-ca) the issuance of certificates is orchestrated by the ECK operator and the operator needs access to the CAs private key. If this is undesirable it is also possible to configure node transport certificates without involving the ECK operator. The following two pre-requisites apply:
7985

8086
1. The tooling used must be able to issue individual certificates for each {{es}} node and dynamically add or remove certificates as the cluster scales up and down.

deploy-manage/security/same-ca.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ You don’t have to restart each node, but doing so forces new TLS connections a
2222

2323
The following steps provide instructions for generating new node certificates and keys for both the transport layer and the HTTP layer. You might only need to replace one of these layer’s certificates depending on which of your certificates are expiring.
2424

25+
:::{include} ./_snippets/own-ca-warning.md
26+
:::
27+
2528
::::{important}
2629
:name: cert-password-updates
2730

deploy-manage/security/secure-cluster-communications.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,36 +57,43 @@ Securing this layer prevents unauthorized nodes from joining your cluster and pr
5757

5858
The way that transport layer security is managed depends on your deployment type:
5959

60-
::::{tab-set}
60+
:::::{tab-set}
6161
:group: deployments
6262

63-
:::{tab-item} ECH and Serverless
63+
::::{tab-item} ECH and Serverless
6464
:sync: ech
6565
{{es}} transport security is fully managed by Elastic, and no configuration is required.
66-
:::
66+
::::
6767

68-
:::{tab-item} ECE
68+
::::{admonition}{tab-item} ECE
6969
:sync: ece
7070
{{es}} transport security is fully managed by {{ece}} platform, and no configuration is required.
71-
:::
71+
::::
7272

73-
:::{tab-item} ECK
73+
::::{tab-item} ECK
7474
:sync: eck
7575

7676
:::{include} ./_snippets/eck-transport.md
7777
:::
7878

79+
:::{include} ./_snippets/own-ca-warning.md
7980
:::
8081

81-
:::{tab-item} Self-managed
82+
::::
83+
84+
::::{tab-item} Self-managed
8285
:sync: self
8386
{{es}} transport security can be [automatically configured](self-auto-setup.md), or manually set up by following the steps in [](set-up-basic-security.md).
8487

8588
For additional TLS configuration options, refer to [](./self-tls.md).
89+
90+
:::{include} ./_snippets/own-ca-warning.md
8691
:::
8792

8893
::::
8994

95+
:::::
96+
9097
### HTTP layer security [encrypt-http-communication]
9198

9299
The HTTP layer includes the service endpoints exposed by both {{es}} and {{kib}}, supporting communications such as REST API requests, browser access to {{kib}}, and {{kib}}’s own traffic to {{es}}. Securing these endpoints helps prevent unauthorized access and protects sensitive data in transit.

deploy-manage/security/self-tls-considerations.md

Lines changed: 11 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -11,65 +11,27 @@ navigation_title: External CA considerations
1111

1212
# Considerations for using an external CA for transport layer security
1313

14-
::::{important}
15-
Transport connections between {{es}} nodes are security-critical. Malicious actors who can observe, interfere with, or establish these connections may be able to read or modify cluster data through system-internal APIs.
16-
::::
17-
18-
## How mutual TLS protects transport connections
19-
20-
By default, {{es}} uses mutual TLS (mTLS) for node-to-node transport connections. This ensures:
21-
22-
- **Encryption**: Data is encrypted in transit for confidentiality and integrity
23-
- **Authentication**: Both nodes must present valid certificates when connecting
24-
- **Authorization**: Certificates must be issued by a trusted certificate authority
25-
26-
Configure trusted certificate authorities using settings like `xpack.security.transport.ssl.certificate_authorities` or `xpack.security.transport.ssl.truststore.path`.
27-
28-
## Certificate authority requirements
14+
By default, {{es}} uses mutual TLS (mTLS) to secure node-to-node transport connections within a cluster. 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`.
2915

3016
::::{warning}
31-
Anyone with a certificate from a trusted CA can establish transport connections to your cluster and potentially access or modify data.
17+
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.
3218
::::
3319

34-
Use a dedicated private certificate authority for each {{es}} cluster. **Do not use**:
35-
36-
- Public certificate authorities
37-
- Organization-wide private certificate authorities
38-
- CAs shared with other applications
39-
40-
These broader CAs issue certificates to entities beyond your authorized {{es}} nodes, creating security risks.
41-
42-
## Certificate requirements
43-
44-
Transport certificates must either:
45-
- Have no Extended Key Usage (EKU) extension, or
46-
- Include both `clientAuth` and `serverAuth` in the EKU extension
47-
48-
Public CAs typically omit `clientAuth`, making their certificates unsuitable for mTLS.
49-
50-
## HTTP versus transport certificates
51-
52-
**Do not use the same certificate for both HTTP and transport connections.** They have different security requirements:
53-
54-
- **Transport certificates** (`xpack.security.transport.ssl.*`): Require mTLS and must include `clientAuth` in the EKU extension
55-
- **HTTP certificates** (`xpack.security.http.ssl.*`): Use HTTP authentication mechanisms and typically don't need `clientAuth`
20+
## External CA mTLS transport certificate requirements
5621

57-
HTTP certificates can often come from public or organization-wide CAs, while transport certificates should always use a cluster-specific private CA.
22+
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. The recommended practice is to use a dedicated private certificate authority for each {{es}} cluster.
5823

59-
## Disabling mutual TLS
24+
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.
6025

61-
If your environment prevents unauthorized node-to-node connections through other means, you can disable mTLS:
26+
### Transport certificates vs. HTTP certificates
6227

63-
```yaml
64-
xpack.security.transport.ssl.client_authentication: none
65-
```
28+
Transport certificates ([`xpack.security.transport.ssl.*`](elasticsearch://reference/elasticsearch/configuration-reference/security-settings.md#transport-tls-ssl-settings) settings) have different security requirements than HTTP certificates ([`xpack.security.http.ssl.*`]((elasticsearch://reference/elasticsearch/configuration-reference/security-settings.md#http-tls-ssl-settings)) settings). HTTP connections don't typically use mTLS because HTTP has its own authentication mechanisms, so 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.
6629

67-
You can still use non-mutual TLS for encryption:
30+
## Turning off mTLS for transport connections
6831

69-
```yaml
70-
xpack.security.transport.ssl.enabled: true
71-
```
32+
If your environment has some other way to prevent unauthorized node-to-node connections, you might prefer not to use mTLS for transport connections. In this case, 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.
7233

7334
::::{warning}
74-
Disabling mTLS allows anyone with network access to establish transport connections. Only do this if you're absolutely certain unauthorized network access cannot occur.
35+
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
36+
protect your node-to-node transport connections unless you are absolutely certain that unauthorized network access to these nodes cannot occur.
7537
::::

deploy-manage/security/set-up-basic-security.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ In this guide, you will learn how to:
2828

2929
Refer to [Transport TLS/SSL settings](elasticsearch://reference/elasticsearch/configuration-reference/security-settings.md#transport-tls-ssl-settings) for the complete list of available settings in {{es}}.
3030

31+
## Considerations for using an external CA
32+
33+
You might choose to use an external CA to generate transport certificates for node-to-node connections.
34+
35+
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.
36+
37+
Carefully review [](/deploy-manage/security/self-tls-considerations.md) to ensure that the certificates that you provide meet the security requirements for transport connections.
38+
3139
## Generate the certificate authority [generate-certificates]
3240

3341
You can add as many nodes as you want in a cluster but they must be able to communicate with each other. The communication between nodes in a cluster is handled by the transport module. To secure your cluster, you must ensure that internode communications are encrypted and verified, which is achieved with mutual TLS.

deploy-manage/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -488,6 +488,7 @@ toc:
488488
children:
489489
- file: security/k8s-https-settings.md
490490
- file: security/k8s-transport-settings.md
491+
- file: security/self-tls-considerations.md
491492
- file: security/network-security.md
492493
children:
493494
- file: security/network-security-policies.md

0 commit comments

Comments
 (0)