-
Notifications
You must be signed in to change notification settings - Fork 25.7k
Add RCS Strong Verification Documentation #137822
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
Changes from 2 commits
5135585
5001d43
bf7ce5e
a06c9ac
c2ecc54
0ba9232
58eb898
6714ac3
b1ca094
c56f2fb
1aaba2b
58b56b0
a2bb187
cf60476
a04d9da
bfb9616
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -76,4 +76,77 @@ To use [proxy mode](docs-content://deploy-manage/remote-clusters/remote-clusters | |||||
| : The number of socket connections to open per remote cluster. The default is `18`. | ||||||
|
|
||||||
| `cluster.remote.<cluster_alias>.server_name` | ||||||
| : An optional hostname string which is sent in the `server_name` field of the TLS Server Name Indication extension if [TLS is enabled](docs-content://deploy-manage/security/secure-cluster-communications.md#encrypt-internode-communication). The TLS transport will fail to open remote connections if this field is not a valid hostname as defined by the TLS SNI specification. | ||||||
| : An optional hostname string which is sent in the `server_name` field of the TLS Server Name Indication extension if [TLS is enabled](docs-content://deploy-manage/security/secure-cluster-communications.md#encrypt-internode-communication). The TLS transport will fail to open remote connections if this field is not a valid hostname as defined by the TLS SNI specification. | ||||||
|
|
||||||
| ## Remote cluster strong verification settings [remote-cluster-signing-settings] | ||||||
| ::::{warning} | ||||||
| This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. | ||||||
| :::: | ||||||
|
|
||||||
| The following settings are used to sign and verify cross-cluster API key requests when using the [API key-based security model](docs-content://deploy-manage/remote-clusters/remote-clusters-api-key.md). These settings enable certificate-based signatures on cross-cluster requests to provide additional security by validating that requests originate from trusted clusters. | ||||||
jfreden marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ### Signature verification settings [remote-cluster-signature-verification] | ||||||
|
|
||||||
| The following global settings are used on the remote cluster to verify signatures from incoming cross-cluster requests. At least one of | ||||||
| `cluster.remote.signing.certificate_authorities` or `cluster.remote.signing.truststore.path` must be configured to enable signature verification. | ||||||
|
|
||||||
| `cluster.remote.signing.certificate_authorities` | ||||||
| : ([Dynamic](docs-content://deploy-manage/stack-settings.md#dynamic-cluster-setting)) List of paths to PEM encoded certificate files that should be trusted when verifying signatures from cross-cluster requests. These certificates are used to establish trust with the signing certificates presented by querying clusters. You cannot use this setting and `cluster.remote.signing.truststore.path` at the same time. | ||||||
|
|
||||||
| `cluster.remote.signing.truststore.path` | ||||||
| : ([Dynamic](docs-content://deploy-manage/stack-settings.md#dynamic-cluster-setting)) The path for the truststore that contains the certificates to trust when verifying signatures. It must be either a Java keystore (jks) or a PKCS#12 file. You cannot use this setting and `cluster.remote.signing.certificate_authorities` at the same time. | ||||||
|
|
||||||
| `cluster.remote.signing.truststore.secure_password` | ||||||
| : ([Secure](docs-content://deploy-manage/security/secure-settings.md)) Password for the truststore specified by `cluster.remote.signing.truststore.path`. | ||||||
jfreden marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| `cluster.remote.signing.truststore.algorithm` | ||||||
| : ([Dynamic](docs-content://deploy-manage/stack-settings.md#dynamic-cluster-setting)) The algorithm for the truststore. Defaults to the default algorithm for the Java KeyManagerFactory. | ||||||
|
||||||
|
|
||||||
| `cluster.remote.signing.truststore.type` | ||||||
| : ([Dynamic](docs-content://deploy-manage/stack-settings.md#dynamic-cluster-setting)) The format of the truststore file. It must be either `jks` or `PKCS12`. If the file name ends in ".p12", ".pfx", or "pkcs12", the default is `PKCS12`. Otherwise, it defaults to `jks`. | ||||||
|
|
||||||
| `cluster.remote.signing.diagnose.trust` | ||||||
| : ([Dynamic](docs-content://deploy-manage/stack-settings.md#dynamic-cluster-setting)) Controls whether to output diagnostic messages for signature verification trust failures. If this is `true` (the default), a message will be printed to the {{es}} log whenever a cross-cluster signature verification is rejected due to a failure to establish trust. This diagnostic message contains information that can be used to determine the cause of the failure and assist with resolving the problem. Set to `false` to disable these messages. | ||||||
|
|
||||||
|
|
||||||
| ### Request signing settings [remote-cluster-request-signing] | ||||||
|
|
||||||
| The following per-cluster settings are used on the local cluster to sign outgoing cross-cluster requests. A private key and certificate | ||||||
|
||||||
| must be configured for each remote cluster that requires signature verification. | ||||||
|
|
||||||
|
|
||||||
| ### PEM encoded files [remote-cluster-signing-pem-files] | ||||||
|
||||||
| ### PEM encoded files [remote-cluster-signing-pem-files] | |
| #### PEM encoded files [remote-cluster-signing-pem-files] |
I think this should be inside Request signing settings. Please ignore otherwise!
jfreden marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
jfreden marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| : ([Dynamic](docs-content://deploy-manage/stack-settings.md#dynamic-cluster-setting)) Specifies the path for the PEM encoded certificate (or certificate chain) that is associated with the signing key. This certificate is sent as part of the signature and must be trusted by the remote cluster's `cluster.remote.signing.certificate_authorities` or `cluster.remote.signing.truststore.path` configuration. This setting can be used only if `cluster.remote.<cluster_alias>.signing.key` is set. | |
| : ([Dynamic](docs-content://deploy-manage/stack-settings.md#dynamic-cluster-setting)) The path for the PEM encoded certificate (or certificate chain) that is associated with the signing key. This certificate is sent as part of the signature and must be trusted by the remote cluster's `cluster.remote.signing.certificate_authorities` or `cluster.remote.signing.truststore.path` configuration. This setting can be used only if `cluster.remote.<cluster_alias>.signing.key` is set. |
jfreden marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ### Java keystore files [remote-cluster-signing-keystore-files] | |
| #### Java keystore files [remote-cluster-signing-keystore-files] |
I think this should be inside Request signing settings. Please ignore otherwise!
Uh oh!
There was an error while loading. Please reload this page.