org.apache.pulsar.common.util.keystoretls

Class KeyStoreSSLContext

java.lang.Object

org.apache.pulsar.common.util.keystoretls.KeyStoreSSLContext

public class KeyStoreSSLContext
extends Object

KeyStoreSSLContext that mainly wrap a SSLContext to provide SSL context for both webservice and netty.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyStoreSSLContext.Mode Connection Mode for TLS.

Field Summary

Fields

Modifier and Type	Field and Description
static Provider	BC_PROVIDER
static String	DEFAULT_KEYSTORE_TYPE
static String	DEFAULT_SSL_ENABLED_PROTOCOLS
static String	DEFAULT_SSL_KEYMANGER_ALGORITHM
static String	DEFAULT_SSL_PROTOCOL
static String	DEFAULT_SSL_TRUSTMANAGER_ALGORITHM

Constructor Summary

Constructors

Constructor and Description
KeyStoreSSLContext(KeyStoreSSLContext.Mode mode, String sslProviderString, String keyStoreTypeString, String keyStorePath, String keyStorePassword, boolean allowInsecureConnection, String trustStoreTypeString, String trustStorePath, String trustStorePassword, boolean requireTrustedClientCertOnConnect, Set<String> ciphers, Set<String> protocols)

Method Summary

Modifier and Type	Method and Description
static KeyStoreSSLContext	createClientKeyStoreSslContext(String sslProviderString, String keyStoreTypeString, String keyStorePath, String keyStorePassword, boolean allowInsecureConnection, String trustStoreTypeString, String trustStorePath, String trustStorePassword, Set<String> ciphers, Set<String> protocols)
static SSLContext	createClientSslContext(String sslProviderString, String keyStoreTypeString, String keyStorePath, String keyStorePassword, boolean allowInsecureConnection, String trustStoreTypeString, String trustStorePath, String trustStorePassword, Set<String> ciphers, Set<String> protocol)
static SSLContext	createClientSslContext(String keyStoreTypeString, String keyStorePath, String keyStorePassword, String trustStoreTypeString, String trustStorePath, String trustStorePassword)
static KeyStoreSSLContext	createServerKeyStoreSslContext(String sslProviderString, String keyStoreTypeString, String keyStorePath, String keyStorePassword, boolean allowInsecureConnection, String trustStoreTypeString, String trustStorePath, String trustStorePassword, boolean requireTrustedClientCertOnConnect, Set<String> ciphers, Set<String> protocols)
static SSLContext	createServerSslContext(String sslProviderString, String keyStoreTypeString, String keyStorePath, String keyStorePassword, boolean allowInsecureConnection, String trustStoreTypeString, String trustStorePath, String trustStorePassword, boolean requireTrustedClientCertOnConnect)
SSLContext	createSSLContext()
static org.eclipse.jetty.util.ssl.SslContextFactory	createSslContextFactory(String sslProviderString, String keyStoreTypeString, String keyStore, String keyStorePassword, boolean allowInsecureConnection, String trustStoreTypeString, String trustStore, String trustStorePassword, boolean requireTrustedClientCertOnConnect, long certRefreshInSec)
SSLEngine	createSSLEngine()
SSLEngine	createSSLEngine(String peerHost, int peerPort)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_KEYSTORE_TYPE

public static final String DEFAULT_KEYSTORE_TYPE

See Also:

Constant Field Values

DEFAULT_SSL_PROTOCOL

public static final String DEFAULT_SSL_PROTOCOL

See Also:

Constant Field Values

DEFAULT_SSL_ENABLED_PROTOCOLS

public static final String DEFAULT_SSL_ENABLED_PROTOCOLS

See Also:

Constant Field Values

DEFAULT_SSL_KEYMANGER_ALGORITHM

public static final String DEFAULT_SSL_KEYMANGER_ALGORITHM

DEFAULT_SSL_TRUSTMANAGER_ALGORITHM

public static final String DEFAULT_SSL_TRUSTMANAGER_ALGORITHM

BC_PROVIDER

public static final Provider BC_PROVIDER

Constructor Detail

KeyStoreSSLContext

public KeyStoreSSLContext(KeyStoreSSLContext.Mode mode,
                          String sslProviderString,
                          String keyStoreTypeString,
                          String keyStorePath,
                          String keyStorePassword,
                          boolean allowInsecureConnection,
                          String trustStoreTypeString,
                          String trustStorePath,
                          String trustStorePassword,
                          boolean requireTrustedClientCertOnConnect,
                          Set<String> ciphers,
                          Set<String> protocols)

Method Detail

createSSLContext

public SSLContext createSSLContext()
                            throws GeneralSecurityException,
                                   IOException

Throws:

GeneralSecurityException

IOException

createSSLEngine

public SSLEngine createSSLEngine()

createSSLEngine

public SSLEngine createSSLEngine(String peerHost,
                                 int peerPort)

createClientKeyStoreSslContext

public static KeyStoreSSLContext createClientKeyStoreSslContext(String sslProviderString,
                                                                String keyStoreTypeString,
                                                                String keyStorePath,
                                                                String keyStorePassword,
                                                                boolean allowInsecureConnection,
                                                                String trustStoreTypeString,
                                                                String trustStorePath,
                                                                String trustStorePassword,
                                                                Set<String> ciphers,
                                                                Set<String> protocols)
                                                         throws GeneralSecurityException,
                                                                SSLException,
                                                                FileNotFoundException,
                                                                IOException

Throws:

GeneralSecurityException

SSLException

FileNotFoundException

IOException

createServerKeyStoreSslContext

public static KeyStoreSSLContext createServerKeyStoreSslContext(String sslProviderString,
                                                                String keyStoreTypeString,
                                                                String keyStorePath,
                                                                String keyStorePassword,
                                                                boolean allowInsecureConnection,
                                                                String trustStoreTypeString,
                                                                String trustStorePath,
                                                                String trustStorePassword,
                                                                boolean requireTrustedClientCertOnConnect,
                                                                Set<String> ciphers,
                                                                Set<String> protocols)
                                                         throws GeneralSecurityException,
                                                                SSLException,
                                                                FileNotFoundException,
                                                                IOException

Throws:

GeneralSecurityException

SSLException

FileNotFoundException

IOException

createServerSslContext

public static SSLContext createServerSslContext(String sslProviderString,
                                                String keyStoreTypeString,
                                                String keyStorePath,
                                                String keyStorePassword,
                                                boolean allowInsecureConnection,
                                                String trustStoreTypeString,
                                                String trustStorePath,
                                                String trustStorePassword,
                                                boolean requireTrustedClientCertOnConnect)
                                         throws GeneralSecurityException,
                                                SSLException,
                                                FileNotFoundException,
                                                IOException

Throws:

GeneralSecurityException

SSLException

FileNotFoundException

IOException

createClientSslContext

public static SSLContext createClientSslContext(String sslProviderString,
                                                String keyStoreTypeString,
                                                String keyStorePath,
                                                String keyStorePassword,
                                                boolean allowInsecureConnection,
                                                String trustStoreTypeString,
                                                String trustStorePath,
                                                String trustStorePassword,
                                                Set<String> ciphers,
                                                Set<String> protocol)
                                         throws GeneralSecurityException,
                                                SSLException,
                                                FileNotFoundException,
                                                IOException

Throws:

GeneralSecurityException

SSLException

FileNotFoundException

IOException

createClientSslContext

public static SSLContext createClientSslContext(String keyStoreTypeString,
                                                String keyStorePath,
                                                String keyStorePassword,
                                                String trustStoreTypeString,
                                                String trustStorePath,
                                                String trustStorePassword)
                                         throws GeneralSecurityException,
                                                SSLException,
                                                FileNotFoundException,
                                                IOException

Throws:

GeneralSecurityException

SSLException

FileNotFoundException

IOException

createSslContextFactory

public static org.eclipse.jetty.util.ssl.SslContextFactory createSslContextFactory(String sslProviderString,
                                                                                   String keyStoreTypeString,
                                                                                   String keyStore,
                                                                                   String keyStorePassword,
                                                                                   boolean allowInsecureConnection,
                                                                                   String trustStoreTypeString,
                                                                                   String trustStore,
                                                                                   String trustStorePassword,
                                                                                   boolean requireTrustedClientCertOnConnect,
                                                                                   long certRefreshInSec)
                                                                            throws GeneralSecurityException,
                                                                                   SSLException,
                                                                                   FileNotFoundException,
                                                                                   IOException

Throws:

GeneralSecurityException

SSLException

FileNotFoundException

IOException