com.hivemq.spi.services.configuration.entity

Class Tls

java.lang.Object

com.hivemq.spi.services.configuration.entity.Tls

@Immutable
public class Tls
extends Object

The TLS configuration

Since:

3.0

Author:

Dominik Obermaier, Christoph Schäbel

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tls.ClientAuthMode The X509 client certificate authentication mode.

Constructor Summary

Constructors

Constructor and Description
Tls(String keystorePath, String keystorePassword, String keystoreType, String privateKeyPassword, String truststorePath, String truststorePassword, String truststoreType, int handshakeTimeout, Tls.ClientAuthMode clientAuthMode, List<String> protocols, List<String> cipherSuites) Creates a new TLS configuration
Tls(String keystorePath, String keystorePassword, String keystoreType, String privateKeyPassword, String truststorePath, String truststorePassword, String truststoreType, int handshakeTimeout, Tls.ClientAuthMode clientAuthMode, List<String> protocols, List<String> cipherSuites, Long concurrentHandshakeLimit, boolean nativeSSl, boolean ocspStaplingEnabled, String ocspOverrideUrl, int ocspCacheInterval) Creates a new TLS configuration

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
List<String>	getCipherSuites()
Tls.ClientAuthMode	getClientAuthMode()
Long	getConcurrentHandshakeLimit()
int	getHandshakeTimeout()
String	getKeystorePassword()
String	getKeystorePath()
String	getKeystoreType()
int	getOcspCacheInterval()
String	getOcspOverrideUrl() ocspOverrideUrl = URL to OCSP responder.
String	getPrivateKeyPassword()
List<String>	getProtocols()
String	getTruststorePassword()
String	getTruststorePath()
String	getTruststoreType()
int	hashCode()
boolean	isNativeSsl()
boolean	isOcspStaplingEnabled()

Methods inherited from class java.lang.Object

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

Constructor Detail

Tls

public Tls(@NotNull
   String keystorePath,
   @NotNull
   String keystorePassword,
   @NotNull
   String keystoreType,
   @NotNull
   String privateKeyPassword,
   @Nullable
   String truststorePath,
   @Nullable
   String truststorePassword,
   @Nullable
   String truststoreType,
   int handshakeTimeout,
   @NotNull
   Tls.ClientAuthMode clientAuthMode,
   @NotNull
   List<String> protocols,
   @NotNull
   List<String> cipherSuites,
   @Nullable
   Long concurrentHandshakeLimit,
   boolean nativeSSl,
   boolean ocspStaplingEnabled,
   @Nullable
   String ocspOverrideUrl,
   int ocspCacheInterval)

Creates a new TLS configuration

Parameters:

keystorePath - the path to the keystore

keystorePassword - the password for the keystore

keystoreType - the keystore type. When in doubt, use JKS

privateKeyPassword - the password to the private key

truststorePath - the path to the truststore

truststorePassword - the password for the truststore

truststoreType - the truststore type. When in doubt, use JKS

handshakeTimeout - the TLS handshake timeout

clientAuthMode - the client authentication mode

protocols - the supported protocols. null means that all enabled protocols by the JVM are enabled

cipherSuites - the supported cipher suites. null means that all enabled cipher suites by the JVM are enabled

concurrentHandshakeLimit - the maximum number of concurrent TLS handshakes that HiveMQ allows at any time

nativeSSl - use the native SSL implementation

ocspStaplingEnabled - enable OCSP stapling

ocspOverrideUrl - overrides the URL of the OCSP-Responder contained in the server certificate. Can also be set if there is no OCSP URL information in the server certificate

ocspCacheInterval - interval in seconds to cache the OCSP response cyclically

Since:

3.3

Tls

public Tls(@NotNull
   String keystorePath,
   @NotNull
   String keystorePassword,
   @NotNull
   String keystoreType,
   String privateKeyPassword,
   @Nullable
   String truststorePath,
   @Nullable
   String truststorePassword,
   @Nullable
   String truststoreType,
   int handshakeTimeout,
   @NotNull
   Tls.ClientAuthMode clientAuthMode,
   @Nullable
   List<String> protocols,
   @NotNull
   List<String> cipherSuites)

Creates a new TLS configuration

Parameters:

keystorePath - the path to the keystore

keystorePassword - the password for the keystore

keystoreType - the keystore type. When in doubt, use JKS

privateKeyPassword - the password to the private key

truststorePath - the path to the truststore

truststorePassword - the password for the truststore

truststoreType - the truststore type. When in doubt, use JKS

handshakeTimeout - the TLS handshake timeout

clientAuthMode - the client authentication mode

protocols - the supported protocols. null means that all enabled protocols by the JVM are enabled

cipherSuites - the supported cipher suites. null means that all enabled cipher suites by the JVM are enabled

Method Detail

getKeystorePath

public String getKeystorePath()

Returns:

the keystore path

getKeystorePassword

public String getKeystorePassword()

Returns:

the keystore password

getKeystoreType

public String getKeystoreType()

Returns:

the keystore type

getPrivateKeyPassword

public String getPrivateKeyPassword()

Returns:

the password of the private key

getTruststorePath

@Nullable
public String getTruststorePath()

Returns:

the truststore path

getTruststorePassword

@Nullable
public String getTruststorePassword()

Returns:

the truststore password

getTruststoreType

@Nullable
public String getTruststoreType()

Returns:

the truststore type

getHandshakeTimeout

public int getHandshakeTimeout()

Returns:

the TLS handshake timeout

getClientAuthMode

public Tls.ClientAuthMode getClientAuthMode()

Returns:

the client authentication mode

getProtocols

public List<String> getProtocols()

Returns:

the enabled TLS protocols

getCipherSuites

public List<String> getCipherSuites()

Returns:

the enabled cipher suites

getConcurrentHandshakeLimit

@Nullable
public Long getConcurrentHandshakeLimit()

Returns:

the concurrentHandshakeLimit or null if none is set

isNativeSsl

public boolean isNativeSsl()

Returns:

is native SSL used for this listener

isOcspStaplingEnabled

public boolean isOcspStaplingEnabled()

Returns:

is OCSP stapling used for this listener

getOcspOverrideUrl

public String getOcspOverrideUrl()

ocspOverrideUrl = URL to OCSP responder.

Returns:

the ocspOverrideUrl

getOcspCacheInterval

public int getOcspCacheInterval()

Returns:

the cache interval for OCSP caching

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object