org.mule.runtime.api.tls

Interface TlsContextFactory

public interface TlsContextFactory

A factory for TLS contexts. A TLS context is configured with a key store and a trust store. The key store stores the private and public keys of the current host. The trust store stores the certificates of the other hosts that are trusted.

This factory provides methods for creating client and server socket factories that will be already configured according to the current context.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
static TlsContextFactoryBuilder	builder() Provides a builder to create custom TlsContextFactory objects or obtain the default one.
SSLServerSocketFactory	createServerSocketFactory() Allows the creation of a SSLServerSocketFactory that restricts the available protocols and cipher suites in the sockets that are created according to the enabled ones (see getEnabledProtocols() and getEnabledCipherSuites()).
SSLSocketFactory	createSocketFactory() Allows the creation of a SSLSocketFactory that restricts the available protocols and cipher suites in the sockets that are created according to the enabled ones (see getEnabledProtocols() and getEnabledCipherSuites()).
SSLContext	createSslContext() Allows the creation of an SSLContext with the configured keystore and trust store.
String[]	getEnabledCipherSuites() The list of ciphers that must be used to restrict the creation of the SSL Sockets
String[]	getEnabledProtocols() The list of enabled protocols that must be used to restrict the creation of the SSL Sockets
TlsContextKeyStoreConfiguration	getKeyStoreConfiguration()
TlsContextTrustStoreConfiguration	getTrustStoreConfiguration()
boolean	isKeyStoreConfigured()
boolean	isTrustStoreConfigured()

Method Detail

builder

static TlsContextFactoryBuilder builder()

Provides a builder to create custom TlsContextFactory objects or obtain the default one.

Returns:

a new TlsContextFactoryBuilder

createSslContext

SSLContext createSslContext()
                     throws KeyManagementException,
                            NoSuchAlgorithmException

Allows the creation of an SSLContext with the configured keystore and trust store. You must use getEnabledProtocols() and getEnabledCipherSuites() to further configure your TLS environment. The resulting SSLContext should not be used to create SSLSocketFactory or SSLServerSocketFactory directly, use createSocketFactory() and createServerSocketFactory() instead, otherwise protocols and ciphers will not be enforced.

Returns:

a new SSL Context

Throws:

KeyManagementException

NoSuchAlgorithmException

createSocketFactory

SSLSocketFactory createSocketFactory()
                              throws KeyManagementException,
                                     NoSuchAlgorithmException

Allows the creation of a SSLSocketFactory that restricts the available protocols and cipher suites in the sockets that are created according to the enabled ones (see getEnabledProtocols() and getEnabledCipherSuites()).

Returns:

a new SSLSocketFactory

Throws:

KeyManagementException

NoSuchAlgorithmException

createServerSocketFactory

SSLServerSocketFactory createServerSocketFactory()
                                          throws KeyManagementException,
                                                 NoSuchAlgorithmException

Allows the creation of a SSLServerSocketFactory that restricts the available protocols and cipher suites in the sockets that are created according to the enabled ones (see getEnabledProtocols() and getEnabledCipherSuites()).

Returns:

a new SSLServerSocketFactory

Throws:

KeyManagementException

NoSuchAlgorithmException

getEnabledCipherSuites

String[] getEnabledCipherSuites()

The list of ciphers that must be used to restrict the creation of the SSL Sockets

Returns:

ths list of enabled cipher suites

getEnabledProtocols

String[] getEnabledProtocols()

The list of enabled protocols that must be used to restrict the creation of the SSL Sockets

Returns:

the list of enabled protocols

isKeyStoreConfigured

boolean isKeyStoreConfigured()

Returns:

true if the keystore was configured, false otherwise

isTrustStoreConfigured

boolean isTrustStoreConfigured()

Returns:

true if the trust store was configured, false otherwise

getKeyStoreConfiguration

TlsContextKeyStoreConfiguration getKeyStoreConfiguration()

Returns:

An object with the configuration of the key store.

getTrustStoreConfiguration

TlsContextTrustStoreConfiguration getTrustStoreConfiguration()

Returns:

An object with the configuration of the trust store.