com.cloudhopper.smpp.ssl

Class SslContextFactory

java.lang.Object

com.cloudhopper.smpp.ssl.SslContextFactory

public class SslContextFactory
extends Object

Factory for SSLContext. This is used to create an SSLContext that is used by SMPP clients and servers that are configured to use SSL. This class is modeled after the netty SecureChatSslContextFactory example, the jetty SslContextFactory utility, and the contribution of bbanko to cloudhopper-smpp.

Author:

garth, bbanko, Jetty7

Constructor Summary

Constructors

Constructor and Description
SslContextFactory()
SslContextFactory(SslConfiguration sslConfig)

Method Summary

Methods

Modifier and Type	Method and Description
void	checkKeyStore() Check KeyStore Configuration.
protected KeyManager[]	getKeyManagers(KeyStore keyStore)
protected KeyStore	getKeyStore(InputStream storeStream, String storePath, String storeType, String storeProvider, String storePassword) Loads keystore using an input stream or a file path in the same order of precedence.
SSLContext	getSslContext() Get the underlying SSLContext.
protected TrustManager[]	getTrustManagers(KeyStore trustStore, Collection<? extends CRL> crls)
protected Collection<? extends CRL>	loadCRL(String crlPath) Loads certificate revocation list (CRL) from a file.
protected KeyStore	loadKeyStore() Override this method to provide alternate way to load a keystore.
protected KeyStore	loadTrustStore() Override this method to provide alternate way to load a truststore.
SSLEngine	newSslEngine() Get an SSLEngine from this context.
SSLEngine	newSslEngine(String host, int port) Get an SSLEngine from this context.
SSLServerSocket	newSslServerSocket(String host, int port, int backlog)
SSLSocket	newSslSocket() Get an SSLSocket from this context.
String[]	selectCipherSuites(String[] enabledCipherSuites, String[] supportedCipherSuites) Select cipher suites to be used by the connector based on configured inclusion and exclusion lists as well as enabled and supported cipher suite lists.
String[]	selectProtocols(String[] enabledProtocols, String[] supportedProtocols) Select cipher suites to be used by the connector based on configured inclusion and exclusion lists as well as enabled and supported cipher suite lists.

Methods inherited from class java.lang.Object

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

Constructor Detail

SslContextFactory

public SslContextFactory()
                  throws Exception

Throws:

Exception

SslContextFactory

public SslContextFactory(SslConfiguration sslConfig)
                  throws Exception

Throws:

Exception

Method Detail

getSslContext

public SSLContext getSslContext()

Get the underlying SSLContext.

loadKeyStore

protected KeyStore loadKeyStore()
                         throws Exception

Override this method to provide alternate way to load a keystore.

Returns:

the key store instance

Throws:

Exception

loadTrustStore

protected KeyStore loadTrustStore()
                           throws Exception

Override this method to provide alternate way to load a truststore.

Returns:

the key store instance

Throws:

Exception

loadCRL

protected Collection<? extends CRL> loadCRL(String crlPath)
                                     throws Exception

Loads certificate revocation list (CRL) from a file. Required for integrations to be able to override the mechanism used to load CRL in order to provide their own implementation.

Parameters:

crlPath - path of certificate revocation list file

Returns:

Collection of CRL's

Throws:

Exception

getKeyStore

protected KeyStore getKeyStore(InputStream storeStream,
                   String storePath,
                   String storeType,
                   String storeProvider,
                   String storePassword)
                        throws Exception

Loads keystore using an input stream or a file path in the same order of precedence. Required for integrations to be able to override the mechanism used to load a keystore in order to provide their own implementation.

Parameters:

storeStream - keystore input stream

storePath - path of keystore file

storeType - keystore type

storeProvider - keystore provider

storePassword - keystore password

Returns:

created keystore

Throws:

Exception - if the keystore cannot be obtained

getKeyManagers

protected KeyManager[] getKeyManagers(KeyStore keyStore)
                               throws Exception

Throws:

Exception

getTrustManagers

protected TrustManager[] getTrustManagers(KeyStore trustStore,
                              Collection<? extends CRL> crls)
                                   throws Exception

Throws:

Exception

checkKeyStore

public void checkKeyStore()

Check KeyStore Configuration. Ensures that if keystore has been configured but there's no truststore, that keystore is used as truststore.

Throws:

IllegalStateException - if SslContextFactory configuration can't be used.

selectProtocols

public String[] selectProtocols(String[] enabledProtocols,
                       String[] supportedProtocols)

Select cipher suites to be used by the connector based on configured inclusion and exclusion lists as well as enabled and supported cipher suite lists.

Parameters:

enabledCipherSuites - Array of enabled cipher suites

supportedCipherSuites - Array of supported cipher suites

Returns:

Array of cipher suites to enable

selectCipherSuites

public String[] selectCipherSuites(String[] enabledCipherSuites,
                          String[] supportedCipherSuites)

Select cipher suites to be used by the connector based on configured inclusion and exclusion lists as well as enabled and supported cipher suite lists.

Parameters:

enabledCipherSuites - Array of enabled cipher suites

supportedCipherSuites - Array of supported cipher suites

Returns:

Array of cipher suites to enable

newSslServerSocket

public SSLServerSocket newSslServerSocket(String host,
                                 int port,
                                 int backlog)
                                   throws IOException

Throws:

IOException

newSslSocket

public SSLSocket newSslSocket()
                       throws IOException

Get an SSLSocket from this context. SSLContext.getSocketFactory()

Throws:

IOException

newSslEngine

public SSLEngine newSslEngine(String host,
                     int port)

Get an SSLEngine from this context. Use this method to hint instead of the no-op for an internal session reuse strategy. Also, some cipher suites require remote hostname information. SSLContext.createSSLEngine(String,int)

Parameters:

host - The non-authoritative name of the host

port - The non-authoritative port

newSslEngine

public SSLEngine newSslEngine()

Get an SSLEngine from this context. SSLContext.createSSLEngine()