Was this page helpful?
Caution
You're viewing documentation for an unstable version of ScyllaDB Open Source. Switch to the latest stable version.
Communication between all or some nodes can be encrypted. The controlling parameter is server_encryption_options.
Once enabled, all communication between the nodes is transmitted over TLS/SSL. The libraries used by ScyllaDB for OpenSSL are FIPS 140-2 certified.
To build a self-signed certificate chain, see generating a self-signed certificate chain using openssl.
Procedure
Configure the internode_encryption, under /etc/scylla/scylla.yaml.
Available options are:
internode_encryption can be one of the following:
none (default) - No traffic is encrypted.
all - Encrypts all traffic
dc - Encrypts the traffic between the data centers.
rack - Encrypts the traffic between the racks.
transitional - Encrypts all outgoing traffic, but allows non-encrypted incoming. Used for upgrading cluster(s) without downtime.
certificate - A PEM format certificate, either self-signed, or provided by a certificate authority (CA).
keyfile - The corresponding PEM format key for the certificate.
truststore - Optional path to a PEM format certificate store of trusted CAs. If not provided, ScyllaDB will attempt to use the system trust store to authenticate certificates.
certficate_revocation_list - The path to a PEM-encoded certificate revocation list (CRL) - a list of issued certificates that have been revoked before their expiration date.
require_client_auth - Set to True to require client side authorization. False by default.
priority_string - Specifies session’s handshake algorithms and options to use. By default there are none.
For information on priority strings, refer to this guide.
scylla.yaml example:
server_encryption_options:
internode_encryption: <none|rack|dc|all|transitional>
certificate: <path to a PEM-encoded certificate file>
keyfile: <path to a PEM-encoded key for certificate>
truststore: <path to a PEM-encoded trust store> (optional)
certficate_revocation_list: <path to a PEM-encoded CRL file> (optional)
Restart ScyllaDB node to apply the changes.
sudo systemctl restart scylla-server
docker exec -it some-scylla supervisorctl restart scylla
(without restarting some-scylla container)
Once internode_encryption or client_encryption_options is enabled
(by being set to something other than none), the SSL / TLS certificates and key files specified in scylla.yaml
will continue to be monitored and reloaded if modified on disk.
When the files are updated, ScyllaDB reloads them and uses them for subsequent connections.
Upgrading an existing cluster, without TLS enabled, to use secure traffic requires a series of incremental operations:
For each node, add a passive TLS configuration, with internode encryption still off, and restart the node:
ssl_storage_port: 7001
server_encryption_options:
internode_encryption: none
certificate: <path to a PEM-encoded certificate file>
keyfile: <path to a PEM-encoded key for certificate>
truststore: <path to a PEM-encoded trust store> (optional)
certficate_revocation_list: <path to a PEM-encoded CRL file> (optional)
This will enable a passive TLS connector on each node. Outgoing traffic will still be unencrypted.
For each node, change the internode_encryption parameter to transitional and restart. This will cause all outgoing traffic to use encryption.
For each node, change the internode_encryption parameter to all, rack or dc and restart. This will cause outgoing traffic to use encryption depending on destination, and will also enforce incoming traffic use encryption if required by the mode.