com.cloudhopper.smpp.ssl

Class SslConfiguration

java.lang.Object

com.cloudhopper.smpp.ssl.SslConfiguration

public class SslConfiguration
extends Object

Configuration for SSL.

Author:

garth

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_KEYMANAGERFACTORY_ALGORITHM
static String	DEFAULT_TRUSTMANAGERFACTORY_ALGORITHM

Constructor Summary

Constructors

Constructor and Description
SslConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
void	addExcludeCipherSuites(String... cipher)
void	addExcludeProtocols(String... protocol)
String	getCertAlias()
String	getCrlPath()
String[]	getExcludeCipherSuites()
String[]	getExcludeProtocols()
String[]	getIncludeCipherSuites()
String[]	getIncludeProtocols()
String	getKeyManagerFactoryAlgorithm()
String	getKeyManagerPassword()
String	getKeyStorePassword()
String	getKeyStorePath()
String	getKeyStoreProvider()
String	getKeyStoreType()
int	getMaxCertPathLength()
boolean	getNeedClientAuth()
String	getOcspResponderURL()
String	getProtocol()
String	getProvider()
String	getSecureRandomAlgorithm()
int	getSslSessionCacheSize() Get SSL session cache size.
int	getSslSessionTimeout() Get SSL session timeout.
String	getTrustManagerFactoryAlgorithm()
String	getTrustStorePassword()
String	getTrustStorePath()
String	getTrustStoreProvider()
String	getTrustStoreType()
boolean	getWantClientAuth()
boolean	isAllowRenegotiate()
boolean	isEnableCRLDP()
boolean	isEnableOCSP()
boolean	isSessionCachingEnabled()
boolean	isTrustAll()
boolean	isValidateCerts()
boolean	isValidatePeerCerts()
void	setAllowRenegotiate(boolean allowRenegotiate) Set if SSL re-negotiation is allowed.
void	setCertAlias(String certAlias)
void	setCrlPath(String crlPath)
void	setEnableCRLDP(boolean enableCRLDP) Enables CRL Distribution Points Support
void	setEnableOCSP(boolean enableOCSP) Enables On-Line Certificate Status Protocol support
void	setExcludeCipherSuites(String... cipherSuites)
void	setExcludeProtocols(String... protocols)
void	setIncludeCipherSuites(String... cipherSuites)
void	setIncludeProtocols(String... protocols)
void	setKeyManagerFactoryAlgorithm(String algorithm)
void	setKeyManagerPassword(String password)
void	setKeyStorePassword(String password)
void	setKeyStorePath(String keyStorePath)
void	setKeyStoreProvider(String keyStoreProvider)
void	setKeyStoreType(String keyStoreType)
void	setMaxCertPathLength(int maxCertPathLength)
void	setNeedClientAuth(boolean needClientAuth)
void	setOcspResponderURL(String ocspResponderURL) Set the location of the OCSP Responder.
void	setProtocol(String protocol)
void	setProvider(String provider)
void	setSecureRandomAlgorithm(String algorithm)
void	setSessionCachingEnabled(boolean enableSessionCaching) Set the flag to enable SSL Session caching.
void	setSslSessionCacheSize(int sslSessionCacheSize) Set SSL session cache size.
void	setSslSessionTimeout(int sslSessionTimeout) Set SSL session timeout.
void	setTrustAll(boolean trustAll)
void	setTrustManagerFactoryAlgorithm(String algorithm)
void	setTrustStorePassword(String password)
void	setTrustStorePath(String trustStorePath)
void	setTrustStoreProvider(String trustStoreProvider)
void	setTrustStoreType(String trustStoreType)
void	setValidateCerts(boolean validateCerts)
void	setValidatePeerCerts(boolean validatePeerCerts)
void	setWantClientAuth(boolean wantClientAuth)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_KEYMANAGERFACTORY_ALGORITHM

public static final String DEFAULT_KEYMANAGERFACTORY_ALGORITHM

DEFAULT_TRUSTMANAGERFACTORY_ALGORITHM

public static final String DEFAULT_TRUSTMANAGERFACTORY_ALGORITHM

Constructor Detail

SslConfiguration

public SslConfiguration()

Method Detail

getExcludeProtocols

public String[] getExcludeProtocols()

Returns:

The array of protocol names to exclude from SSLEngine.setEnabledProtocols(String[])

setExcludeProtocols

public void setExcludeProtocols(String... protocols)

Parameters:

protocols - The array of protocol names to exclude from SSLEngine.setEnabledProtocols(String[])

addExcludeProtocols

public void addExcludeProtocols(String... protocol)

Parameters:

protocol - Protocol names to add to SSLEngine.setEnabledProtocols(String[])

getIncludeProtocols

public String[] getIncludeProtocols()

Returns:

The array of protocol names to include in SSLEngine.setEnabledProtocols(String[])

setIncludeProtocols

public void setIncludeProtocols(String... protocols)

Parameters:

protocols - The array of protocol names to include in SSLEngine.setEnabledProtocols(String[])

getExcludeCipherSuites

public String[] getExcludeCipherSuites()

Returns:

The array of cipher suite names to exclude from SSLEngine.setEnabledCipherSuites(String[])

setExcludeCipherSuites

public void setExcludeCipherSuites(String... cipherSuites)

Parameters:

cipherSuites - The array of cipher suite names to exclude from SSLEngine.setEnabledCipherSuites(String[])

addExcludeCipherSuites

public void addExcludeCipherSuites(String... cipher)

Parameters:

cipher - Cipher names to add to SSLEngine.setEnabledCipherSuites(String[])

getIncludeCipherSuites

public String[] getIncludeCipherSuites()

Returns:

The array of cipher suite names to include in SSLEngine.setEnabledCipherSuites(String[])

setIncludeCipherSuites

public void setIncludeCipherSuites(String... cipherSuites)

Parameters:

cipherSuites - The array of cipher suite names to include in SSLEngine.setEnabledCipherSuites(String[])

getKeyStorePath

public String getKeyStorePath()

Returns:

The file or URL of the SSL Key store.

setKeyStorePath

public void setKeyStorePath(String keyStorePath)

Parameters:

keyStorePath - The file or URL of the SSL Key store.

getKeyStoreProvider

public String getKeyStoreProvider()

Returns:

The provider of the key store

setKeyStoreProvider

public void setKeyStoreProvider(String keyStoreProvider)

Parameters:

keyStoreProvider - The provider of the key store

getKeyStoreType

public String getKeyStoreType()

Returns:

The type of the key store (default "JKS")

setKeyStoreType

public void setKeyStoreType(String keyStoreType)

Parameters:

keyStoreType - The type of the key store (default "JKS")

getCertAlias

public String getCertAlias()

Returns:

Alias of SSL certificate for the connector

setCertAlias

public void setCertAlias(String certAlias)

Parameters:

certAlias - Alias of SSL certificate for the connector

getTrustStorePath

public String getTrustStorePath()

Returns:

The file name or URL of the trust store location

setTrustStorePath

public void setTrustStorePath(String trustStorePath)

Parameters:

trustStorePath - The file name or URL of the trust store location

getTrustStoreProvider

public String getTrustStoreProvider()

Returns:

The provider of the trust store

setTrustStoreProvider

public void setTrustStoreProvider(String trustStoreProvider)

Parameters:

trustStoreProvider - The provider of the trust store

getTrustStoreType

public String getTrustStoreType()

Returns:

The type of the trust store (default "JKS")

setTrustStoreType

public void setTrustStoreType(String trustStoreType)

Parameters:

trustStoreType - The type of the trust store (default "JKS")

getNeedClientAuth

public boolean getNeedClientAuth()

Returns:

True if SSL needs client authentication.

See Also:

SSLEngine.getNeedClientAuth()

setNeedClientAuth

public void setNeedClientAuth(boolean needClientAuth)

Parameters:

needClientAuth - True if SSL needs client authentication.

getWantClientAuth

public boolean getWantClientAuth()

Returns:

True if SSL wants client authentication.

See Also:

SSLEngine.getWantClientAuth()

setWantClientAuth

public void setWantClientAuth(boolean wantClientAuth)

Parameters:

wantClientAuth - True if SSL wants client authentication.

isValidateCerts

public boolean isValidateCerts()

Returns:

true if SSL certificate has to be validated

setValidateCerts

public void setValidateCerts(boolean validateCerts)

Parameters:

validateCerts - true if SSL certificates have to be validated

isValidatePeerCerts

public boolean isValidatePeerCerts()

Returns:

true if SSL certificates of the peer have to be validated

setValidatePeerCerts

public void setValidatePeerCerts(boolean validatePeerCerts)

Parameters:

validatePeerCerts - true if SSL certificates of the peer have to be validated

isAllowRenegotiate

public boolean isAllowRenegotiate()

Returns:

True if SSL re-negotiation is allowed (default false)

setAllowRenegotiate

public void setAllowRenegotiate(boolean allowRenegotiate)

Set if SSL re-negotiation is allowed. CVE-2009-3555 discovered a vulnerability in SSL/TLS with re-negotiation. If your JVM does not have CVE-2009-3555 fixed, then re-negotiation should not be allowed. CVE-2009-3555 was fixed in Sun java 1.6 with a ban of renegotiates in u19 and with RFC5746 in u22.

Parameters:

allowRenegotiate - true if re-negotiation is allowed (default false)

setKeyStorePassword

public void setKeyStorePassword(String password)

Parameters:

password - The password for the key store

getKeyStorePassword

public String getKeyStorePassword()

Returns:

The password for the key store

setKeyManagerPassword

public void setKeyManagerPassword(String password)

Parameters:

password - The password (if any) for the specific key within the key store

getKeyManagerPassword

public String getKeyManagerPassword()

Returns:

The password (if any) for the specific key within the key store

setTrustStorePassword

public void setTrustStorePassword(String password)

Parameters:

password - The password for the trust store

getTrustStorePassword

public String getTrustStorePassword()

Returns:

The password for the trust store

getProvider

public String getProvider()

Returns:

The SSL provider name, which if set is passed to SSLContext.getInstance(String, String)

setProvider

public void setProvider(String provider)

Parameters:

provider - The SSL provider name, which if set is passed to SSLContext.getInstance(String, String)

getProtocol

public String getProtocol()

Returns:

The SSL protocol (default "TLS") passed to SSLContext.getInstance(String, String)

setProtocol

public void setProtocol(String protocol)

Parameters:

protocol - The SSL protocol (default "TLS") passed to SSLContext.getInstance(String, String)

getSecureRandomAlgorithm

public String getSecureRandomAlgorithm()

Returns:

The algorithm name, which if set is passed to SecureRandom.getInstance(String) to obtain the SecureRandom instance passed to SSLContext.init(javax.net.ssl.KeyManager[], javax.net.ssl.TrustManager[], SecureRandom)

setSecureRandomAlgorithm

public void setSecureRandomAlgorithm(String algorithm)

Parameters:

algorithm - The algorithm name, which if set is passed to SecureRandom.getInstance(String) to obtain the SecureRandom instance passed to SSLContext.init(javax.net.ssl.KeyManager[], javax.net.ssl.TrustManager[], SecureRandom)

getKeyManagerFactoryAlgorithm

public String getKeyManagerFactoryAlgorithm()

Returns:

The algorithm name (default "SunX509") used by the KeyManagerFactory

setKeyManagerFactoryAlgorithm

public void setKeyManagerFactoryAlgorithm(String algorithm)

Parameters:

algorithm - The algorithm name (default "SunX509") used by the KeyManagerFactory

getTrustManagerFactoryAlgorithm

public String getTrustManagerFactoryAlgorithm()

Returns:

The algorithm name (default "SunX509") used by the TrustManagerFactory

isTrustAll

public boolean isTrustAll()

Returns:

True if all certificates should be trusted if there is no KeyStore or TrustStore

setTrustAll

public void setTrustAll(boolean trustAll)

Parameters:

trustAll - True if all certificates should be trusted if there is no KeyStore or TrustStore

setTrustManagerFactoryAlgorithm

public void setTrustManagerFactoryAlgorithm(String algorithm)

Parameters:

algorithm - The algorithm name (default "SunX509") used by the TrustManagerFactory Use the string "TrustAll" to install a trust manager that trusts all.

getCrlPath

public String getCrlPath()

Returns:

Path to file that contains Certificate Revocation List

setCrlPath

public void setCrlPath(String crlPath)

Parameters:

crlPath - Path to file that contains Certificate Revocation List

getMaxCertPathLength

public int getMaxCertPathLength()

Returns:

Maximum number of intermediate certificates in the certification path (-1 for unlimited)

setMaxCertPathLength

public void setMaxCertPathLength(int maxCertPathLength)

Parameters:

maxCertPathLength - maximum number of intermediate certificates in the certification path (-1 for unlimited)

isEnableCRLDP

public boolean isEnableCRLDP()

Returns:

true if CRL Distribution Points support is enabled

setEnableCRLDP

public void setEnableCRLDP(boolean enableCRLDP)

Enables CRL Distribution Points Support

Parameters:

enableCRLDP - true - turn on, false - turns off

isEnableOCSP

public boolean isEnableOCSP()

Returns:

true if On-Line Certificate Status Protocol support is enabled

setEnableOCSP

public void setEnableOCSP(boolean enableOCSP)

Enables On-Line Certificate Status Protocol support

Parameters:

enableOCSP - true - turn on, false - turn off

getOcspResponderURL

public String getOcspResponderURL()

Returns:

Location of the OCSP Responder

setOcspResponderURL

public void setOcspResponderURL(String ocspResponderURL)

Set the location of the OCSP Responder.

Parameters:

ocspResponderURL - location of the OCSP Responder

isSessionCachingEnabled

public boolean isSessionCachingEnabled()

Returns:

true if SSL Session caching is enabled

setSessionCachingEnabled

public void setSessionCachingEnabled(boolean enableSessionCaching)

Set the flag to enable SSL Session caching.

Parameters:

enableSessionCaching - the value of the flag

getSslSessionCacheSize

public int getSslSessionCacheSize()

Get SSL session cache size.

Returns:

SSL session cache size

setSslSessionCacheSize

public void setSslSessionCacheSize(int sslSessionCacheSize)

Set SSL session cache size.

Parameters:

sslSessionCacheSize - SSL session cache size to set

getSslSessionTimeout

public int getSslSessionTimeout()

Get SSL session timeout.

Returns:

SSL session timeout

setSslSessionTimeout

public void setSslSessionTimeout(int sslSessionTimeout)

Set SSL session timeout.

Parameters:

sslSessionTimeout - SSL session timeout to set