redis.clients.jedis

Class SslOptions

java.lang.Object

redis.clients.jedis.SslOptions

public class SslOptions
extends java.lang.Object

TLS/SSL configuration for connections to Redis.

Recommended entry point for enabling TLS.

Verification modes

Controlled via SslVerifyMode:

• SslVerifyMode.FULL (default) - verifies the certificate chain against the truststore and verifies that the server hostname matches the certificate (HTTPS endpoint identification). Recommended for production.
• SslVerifyMode.CA - verifies the certificate chain against the truststore but skips hostname verification. Useful when connecting via IP or a name not listed in the certificate's SAN/CN.
• SslVerifyMode.INSECURE - disables all certificate and hostname verification. Do NOT use in production.

Truststore and keystore

If no truststore is configured, the default JVM truststore (cacerts) is used. Custom truststores can be provided .

Examples

Default (uses JVM truststore, full verification):

 SslOptions sslOptions = SslOptions.defaults();
 

Custom truststore:

 SslOptions sslOptions = SslOptions.builder()
     .truststore(new File("/path/to/truststore.p12"), "changeit".toCharArray())
     .build();
 

Mutual TLS (client certificate):

 SslOptions sslOptions = SslOptions.builder()
     .keystore(new File("/path/to/keystore.p12"), "changeit".toCharArray())
     .truststore(new File("/path/to/truststore.p12"), "changeit".toCharArray())
     .build();
 

Use with a client:

 JedisClientConfig config = DefaultJedisClientConfig.builder()
     .sslOptions(sslOptions)
     .build();

 RedisClient client = RedisClient.builder()
     .hostAndPort("redis.example.com", 6379)
     .clientConfig(config)
     .build();
 

Author:

Mark Paluch

See Also:

SslVerifyMode, JedisClientConfig.getSslOptions()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SslOptions.Builder Builder for SslOptions.
static interface	SslOptions.Resource Supplier for a InputStream representing a resource.

Method Summary

Modifier and Type	Method and Description
static void	assertFile(java.lang.String keyword, java.io.File file) Assert that file exists.
static SslOptions.Builder	builder() Returns a new SslOptions.Builder to construct SslOptions.
javax.net.ssl.SSLContext	createSslContext() A SSLContext object that is configured with values from this SslOptions object.
static SslOptions	defaults() Returns SslOptions with default settings: JVM truststore, TLS protocol and full certificate and hostname verification (SslVerifyMode.FULL).
javax.net.ssl.SSLParameters	getSslParameters() createSslContext() must be called before this.
SslVerifyMode	getSslVerifyMode() Configured ssl verify mode.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SslOptions.Builder builder()

Returns a new SslOptions.Builder to construct SslOptions.

Returns:

a new SslOptions.Builder to construct SslOptions.

defaults

public static SslOptions defaults()

Returns SslOptions with default settings: JVM truststore, TLS protocol and full certificate and hostname verification (SslVerifyMode.FULL). Equivalent to SslOptions.builder().build().

Returns:

a new SslOptions instance with default settings.

createSslContext

public javax.net.ssl.SSLContext createSslContext()
                                          throws java.io.IOException,
                                                 java.security.GeneralSecurityException

A SSLContext object that is configured with values from this SslOptions object.

Returns:

SSLContext

Throws:

java.io.IOException - thrown when loading the keystore or the truststore fails.

java.security.GeneralSecurityException - thrown when loading the keystore or the truststore fails.

getSslParameters

public javax.net.ssl.SSLParameters getSslParameters()

createSslContext() must be called before this.

Returns:

SSLParameters

getSslVerifyMode

public SslVerifyMode getSslVerifyMode()

Configured ssl verify mode.

Returns:

SslVerifyMode

assertFile

public static void assertFile(java.lang.String keyword,
                              java.io.File file)

Assert that file exists.

Parameters:

keyword - file recognizer

file -

Throws:

java.lang.IllegalArgumentException - if the file doesn't exist