Package org.apache.cassandra.config

Class EncryptionOptions.ServerEncryptionOptions

java.lang.Object

org.apache.cassandra.config.EncryptionOptions

org.apache.cassandra.config.EncryptionOptions.ServerEncryptionOptions

Enclosing class:

EncryptionOptions

public static class EncryptionOptions.ServerEncryptionOptions
extends EncryptionOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EncryptionOptions.ServerEncryptionOptions.InternodeEncryption

Nested classes/interfaces inherited from class org.apache.cassandra.config.EncryptionOptions

EncryptionOptions.ConfigKey, EncryptionOptions.ServerEncryptionOptions, EncryptionOptions.TlsEncryptionPolicy

Field Summary

Fields

Modifier and Type	Field	Description
final EncryptionOptions.ServerEncryptionOptions.InternodeEncryption	internode_encryption
final boolean	legacy_ssl_storage_port_enabled
final String	outbound_keystore
final String	outbound_keystore_password

Fields inherited from class org.apache.cassandra.config.EncryptionOptions

accepted_protocols, algorithm, cipher_suites, enabled, isEnabled, isOptional, keystore, keystore_password, optional, protocol, require_client_auth, require_endpoint_verification, ssl_context_factory, sslContextFactoryInstance, store_type, truststore, truststore_password

Constructor Summary

Constructors

Constructor	Description
ServerEncryptionOptions()
ServerEncryptionOptions(EncryptionOptions.ServerEncryptionOptions options)
ServerEncryptionOptions(ParameterizedClass sslContextFactoryClass, String keystore, String keystore_password, String outbound_keystore, String outbound_keystore_password, String truststore, String truststore_password, List<String> cipher_suites, String protocol, List<String> accepted_protocols, String algorithm, String store_type, boolean require_client_auth, boolean require_endpoint_verification, Boolean optional, EncryptionOptions.ServerEncryptionOptions.InternodeEncryption internode_encryption, boolean legacy_ssl_storage_port_enabled)

Method Summary

Modifier and Type	Method	Description
EncryptionOptions	applyConfig()
boolean	equals(Object o)	The method is being mainly used to cache SslContexts therefore, we only consider fields that would make a difference when the TrustStore or KeyStore files are updated
protected void	fillSslContextParams(Map<String,Object> sslContextFactoryParameters)
int	hashCode()	The method is being mainly used to cache SslContexts therefore, we only consider fields that would make a difference when the TrustStore or KeyStore files are updated
boolean	isExplicitlyOptional()	EncryptionOptions.isOptional will be set to true implicitly for internode_encryption values of "dc" and "all".
boolean	shouldEncrypt(InetAddressAndPort endpoint)
EncryptionOptions.ServerEncryptionOptions	withAcceptedProtocols(List<String> accepted_protocols)
EncryptionOptions.ServerEncryptionOptions	withAlgorithm(String algorithm)
EncryptionOptions.ServerEncryptionOptions	withCipherSuites(String... cipher_suites)
EncryptionOptions.ServerEncryptionOptions	withCipherSuites(List<String> cipher_suites)
EncryptionOptions.ServerEncryptionOptions	withInternodeEncryption(EncryptionOptions.ServerEncryptionOptions.InternodeEncryption internode_encryption)
EncryptionOptions.ServerEncryptionOptions	withKeyStore(String keystore)
EncryptionOptions.ServerEncryptionOptions	withKeyStorePassword(String keystore_password)
EncryptionOptions.ServerEncryptionOptions	withLegacySslStoragePort(boolean enable_legacy_ssl_storage_port)
EncryptionOptions.ServerEncryptionOptions	withOptional(boolean optional)
EncryptionOptions.ServerEncryptionOptions	withOutboundKeystore(String outboundKeystore)
EncryptionOptions.ServerEncryptionOptions	withOutboundKeystorePassword(String outboundKeystorePassword)
EncryptionOptions.ServerEncryptionOptions	withProtocol(String protocol)
EncryptionOptions.ServerEncryptionOptions	withRequireClientAuth(boolean require_client_auth)
EncryptionOptions.ServerEncryptionOptions	withRequireEndpointVerification(boolean require_endpoint_verification)
EncryptionOptions.ServerEncryptionOptions	withSslContextFactory(ParameterizedClass sslContextFactoryClass)
EncryptionOptions.ServerEncryptionOptions	withStoreType(String store_type)
EncryptionOptions.ServerEncryptionOptions	withTrustStore(String truststore)
EncryptionOptions.ServerEncryptionOptions	withTrustStorePassword(String truststore_password)

Methods inherited from class org.apache.cassandra.config.EncryptionOptions

acceptedProtocolsArray, cipherSuitesArray, getAcceptedProtocols, getEnabled, getOptional, getProtocol, putSslContextFactoryParameter, setAcceptedProtocols, setEnabled, setOptional, setProtocol, tlsEncryptionPolicy, withEnabled, withOptional

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

internode_encryption

public final EncryptionOptions.ServerEncryptionOptions.InternodeEncryption internode_encryption

legacy_ssl_storage_port_enabled

public final boolean legacy_ssl_storage_port_enabled

outbound_keystore

public final String outbound_keystore

outbound_keystore_password

@Nullable
public final String outbound_keystore_password

Constructor Details

ServerEncryptionOptions

public ServerEncryptionOptions()

ServerEncryptionOptions

public ServerEncryptionOptions(ParameterizedClass sslContextFactoryClass,
 String keystore,
 String keystore_password,
 String outbound_keystore,
 String outbound_keystore_password,
 String truststore,
 String truststore_password,
 List<String> cipher_suites,
 String protocol,
 List<String> accepted_protocols,
 String algorithm,
 String store_type,
 boolean require_client_auth,
 boolean require_endpoint_verification,
 Boolean optional,
 EncryptionOptions.ServerEncryptionOptions.InternodeEncryption internode_encryption,
 boolean legacy_ssl_storage_port_enabled)

ServerEncryptionOptions

public ServerEncryptionOptions(EncryptionOptions.ServerEncryptionOptions options)

Method Details

fillSslContextParams

protected void fillSslContextParams(Map<String,Object> sslContextFactoryParameters)

Overrides:

fillSslContextParams in class EncryptionOptions

applyConfig

public EncryptionOptions applyConfig()

Overrides:

applyConfig in class EncryptionOptions

shouldEncrypt

public boolean shouldEncrypt(InetAddressAndPort endpoint)

isExplicitlyOptional

public boolean isExplicitlyOptional()

EncryptionOptions.isOptional will be set to true implicitly for internode_encryption values of "dc" and "all". This method returns the explicit, raw value of EncryptionOptions.optional as set by the user (if set at all).

equals

public boolean equals(Object o)

The method is being mainly used to cache SslContexts therefore, we only consider fields that would make a difference when the TrustStore or KeyStore files are updated

Overrides:

equals in class EncryptionOptions

hashCode

public int hashCode()

The method is being mainly used to cache SslContexts therefore, we only consider fields that would make a difference when the TrustStore or KeyStore files are updated

Overrides:

hashCode in class EncryptionOptions

withSslContextFactory

public EncryptionOptions.ServerEncryptionOptions withSslContextFactory(ParameterizedClass sslContextFactoryClass)

Overrides:

withSslContextFactory in class EncryptionOptions

withKeyStore

public EncryptionOptions.ServerEncryptionOptions withKeyStore(String keystore)

Overrides:

withKeyStore in class EncryptionOptions

withKeyStorePassword

public EncryptionOptions.ServerEncryptionOptions withKeyStorePassword(String keystore_password)

Overrides:

withKeyStorePassword in class EncryptionOptions

withTrustStore

public EncryptionOptions.ServerEncryptionOptions withTrustStore(String truststore)

Overrides:

withTrustStore in class EncryptionOptions

withTrustStorePassword

public EncryptionOptions.ServerEncryptionOptions withTrustStorePassword(String truststore_password)

Overrides:

withTrustStorePassword in class EncryptionOptions

withCipherSuites

public EncryptionOptions.ServerEncryptionOptions withCipherSuites(List<String> cipher_suites)

Overrides:

withCipherSuites in class EncryptionOptions

withCipherSuites

public EncryptionOptions.ServerEncryptionOptions withCipherSuites(String... cipher_suites)

Overrides:

withCipherSuites in class EncryptionOptions

withProtocol

public EncryptionOptions.ServerEncryptionOptions withProtocol(String protocol)

Overrides:

withProtocol in class EncryptionOptions

withAcceptedProtocols

public EncryptionOptions.ServerEncryptionOptions withAcceptedProtocols(List<String> accepted_protocols)

Overrides:

withAcceptedProtocols in class EncryptionOptions

withAlgorithm

public EncryptionOptions.ServerEncryptionOptions withAlgorithm(String algorithm)

Overrides:

withAlgorithm in class EncryptionOptions

withStoreType

public EncryptionOptions.ServerEncryptionOptions withStoreType(String store_type)

Overrides:

withStoreType in class EncryptionOptions

withRequireClientAuth

public EncryptionOptions.ServerEncryptionOptions withRequireClientAuth(boolean require_client_auth)

Overrides:

withRequireClientAuth in class EncryptionOptions

withRequireEndpointVerification

public EncryptionOptions.ServerEncryptionOptions withRequireEndpointVerification(boolean require_endpoint_verification)

Overrides:

withRequireEndpointVerification in class EncryptionOptions

withOptional

public EncryptionOptions.ServerEncryptionOptions withOptional(boolean optional)

withInternodeEncryption

public EncryptionOptions.ServerEncryptionOptions withInternodeEncryption(EncryptionOptions.ServerEncryptionOptions.InternodeEncryption internode_encryption)

withLegacySslStoragePort

public EncryptionOptions.ServerEncryptionOptions withLegacySslStoragePort(boolean enable_legacy_ssl_storage_port)

withOutboundKeystore

public EncryptionOptions.ServerEncryptionOptions withOutboundKeystore(String outboundKeystore)

withOutboundKeystorePassword

public EncryptionOptions.ServerEncryptionOptions withOutboundKeystorePassword(String outboundKeystorePassword)