Modifier and Type	Class and Description
public static enum	SSLHostConfig.CertificateVerification
public static enum	SSLHostConfig.Type

Modifier and Type	Field and Description
private String	caCertificateFile
private String	caCertificatePath
private String	certificateRevocationListFile
private String	certificateRevocationListPath
private Set<SSLHostConfigCertificate>	certificates
private SSLHostConfig.CertificateVerification	certificateVerification
private int	certificateVerificationDepth
private boolean	certificateVerificationDepthConfigured
private LinkedHashSet<Cipher>	cipherList
private String	ciphers
private SSLHostConfig.Type	configType
protected static final String	DEFAULT_SSL_HOST_NAME
public static final String	DEFAULT_TLS_CIPHERS
private SSLHostConfigCertificate	defaultCertificate
private boolean	disableCompression
private boolean	disableSessionTickets
private String[]	enabledCiphers
private String[]	enabledProtocols
private Set<String>	explicitlyRequestedProtocols
private boolean	honorCipherOrder
private String	hostName
private boolean	insecureRenegotiation
private List<String>	jsseCipherNames
private String	keyManagerAlgorithm
private static final Log	log
private ObjectName	oname
private OpenSSLConf	openSslConf
private transient volatile Long	openSslConfContext
private transient volatile Long	openSslContext
private Set<String>	protocols
private boolean	revocationEnabled
private static final long	serialVersionUID
private int	sessionCacheSize
private int	sessionTimeout
private static final StringManager	sm
protected static final Set<String>	SSL_PROTO_ALL_SET
private String	sslProtocol
private boolean	tls13RenegotiationAvailable
private String	trustManagerClassName
private transient KeyStore	truststore
private String	truststoreAlgorithm
private String	truststoreFile
private String	truststorePassword
private String	truststoreProvider
private String	truststoreType

Access	Constructor and Description
public	SSLHostConfig()

Method Summary

Modifier and Type	Method and Description
public void	addCertificate(SSLHostConfigCertificate certificate)
public static String	adjustRelativePath(String path)
public Set<X509Certificate>	certificatesExpiringBefore(Date date)
public String	getCaCertificateFile()
public String	getCaCertificatePath()
public String	getCertificateRevocationListFile()
public String	getCertificateRevocationListPath()
public Set<SSLHostConfigCertificate>	getCertificates()
public Set<SSLHostConfigCertificate>	getCertificates(boolean createDefaultIfEmpty)
public SSLHostConfig.CertificateVerification	getCertificateVerification()
public String	getCertificateVerificationAsString()
public int	getCertificateVerificationDepth()
public LinkedHashSet<Cipher>	getCipherList()
public String	Returns: An OpenSSL cipher string for the current configuration. getCiphers()
public String	getConfigType()
public boolean	getDisableCompression()
public boolean	getDisableSessionTickets()
public String[]	Returns: The ciphers enabled for this TLS virtual host getEnabledCiphers()
public String[]	Returns: The protocols enabled for this TLS virtual host getEnabledProtocols()
public boolean	getHonorCipherOrder()
public String	Returns: The host name associated with this SSL configuration - always in lower case. getHostName()
public boolean	getInsecureRenegotiation()
public List<String>	Returns: A list of the JSSE cipher names getJsseCipherNames() Obtain the list of JSSE cipher names for the current configuration.
public String	getKeyManagerAlgorithm()
public ObjectName	getObjectName()
public OpenSSLConf	getOpenSslConf()
public Long	getOpenSslConfContext()
public Long	getOpenSslContext()
public Set<String>	getProtocols()
public boolean	getRevocationEnabled()
public int	getSessionCacheSize()
public int	getSessionTimeout()
public String	getSslProtocol()
public String	getTrustManagerClassName()
public KeyStore	getTruststore()
public String	getTruststoreAlgorithm()
public String	getTruststoreFile()
public String	getTruststorePassword()
public String	getTruststoreProvider()
public String	getTruststoreType()
public boolean	isCertificateVerificationDepthConfigured()
pack-priv boolean	isExplicitlyRequestedProtocol(String protocol)
public boolean	isTls13RenegotiationAvailable()
private void	registerDefaultCertificate()
public void	setCaCertificateFile(String caCertificateFile)
public void	setCaCertificatePath(String caCertificatePath)
public void	setCertificateRevocationListFile(String certificateRevocationListFile)
public void	setCertificateRevocationListPath(String certificateRevocationListPath)
public void	setCertificateVerification(String certificateVerification)
public void	setCertificateVerificationAsString(String certificateVerification)
public void	setCertificateVerificationDepth(int certificateVerificationDepth)
public void	setCiphers(String The new cipher configuration in OpenSSL or JSSE format ciphersList) Set the new cipher configuration.
public void	setDisableCompression(boolean disableCompression)
public void	setDisableSessionTickets(boolean disableSessionTickets)
public void	setEnabledCiphers(String[] enabledCiphers)
public void	setEnabledProtocols(String[] enabledProtocols)
public void	setHonorCipherOrder(boolean honorCipherOrder)
public void	setHostName(String hostName)
public void	setInsecureRenegotiation(boolean insecureRenegotiation)
public void	setKeyManagerAlgorithm(String keyManagerAlgorithm)
public void	setObjectName(ObjectName oname)
public void	setOpenSslConf(OpenSSLConf conf)
public void	setOpenSslConfContext(Long openSslConfContext)
public void	setOpenSslContext(Long openSslContext)
pack-priv boolean	Returns: true if the property belongs to the current configuration, and false otherwise setProperty(String the property name name, SSLHostConfig.Type the configuration type configType) Set property which belongs to the specified configuration type.
public void	setProtocols(String input)
public void	setRevocationEnabled(boolean revocationEnabled)
public void	setSessionCacheSize(int sessionCacheSize)
public void	setSessionTimeout(int sessionTimeout)
public void	setSslProtocol(String sslProtocol)
public void	setTls13RenegotiationAvailable(boolean tls13RenegotiationAvailable)
public void	setTrustManagerClassName(String trustManagerClassName)
public void	setTrustStore(KeyStore truststore)
public void	setTruststoreAlgorithm(String truststoreAlgorithm)
public void	setTruststoreFile(String truststoreFile)
public void	setTruststorePassword(String truststorePassword)
public void	setTruststoreProvider(String truststoreProvider)
public void	setTruststoreType(String truststoreType)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

caCertificateFile	back to summary
private String caCertificateFile

caCertificatePath	back to summary
private String caCertificatePath

certificateRevocationListFile	back to summary
private String certificateRevocationListFile

certificateRevocationListPath	back to summary
private String certificateRevocationListPath

certificates	back to summary
private Set<SSLHostConfigCertificate> certificates

certificateVerification	back to summary
private SSLHostConfig.CertificateVerification certificateVerification

certificateVerificationDepth	back to summary
private int certificateVerificationDepth

certificateVerificationDepthConfigured	back to summary
private boolean certificateVerificationDepthConfigured

cipherList	back to summary
private LinkedHashSet<Cipher> cipherList

ciphers	back to summary
private String ciphers

configType	back to summary
private SSLHostConfig.Type configType

DEFAULT_SSL_HOST_NAME	back to summary
protected static final String DEFAULT_SSL_HOST_NAME

DEFAULT_TLS_CIPHERS	back to summary
public static final String DEFAULT_TLS_CIPHERS

defaultCertificate	back to summary
private SSLHostConfigCertificate defaultCertificate

disableCompression	back to summary
private boolean disableCompression

disableSessionTickets	back to summary
private boolean disableSessionTickets

enabledCiphers	back to summary
private String[] enabledCiphers

enabledProtocols	back to summary
private String[] enabledProtocols

explicitlyRequestedProtocols	back to summary
private Set<String> explicitlyRequestedProtocols

honorCipherOrder	back to summary
private boolean honorCipherOrder

hostName	back to summary
private String hostName

insecureRenegotiation	back to summary
private boolean insecureRenegotiation

jsseCipherNames	back to summary
private List<String> jsseCipherNames

keyManagerAlgorithm	back to summary
private String keyManagerAlgorithm

log	back to summary
private static final Log log

oname	back to summary
private ObjectName oname

openSslConf	back to summary
private OpenSSLConf openSslConf

openSslConfContext	back to summary
private transient volatile Long openSslConfContext

openSslContext	back to summary
private transient volatile Long openSslContext

protocols	back to summary
private Set<String> protocols

revocationEnabled	back to summary
private boolean revocationEnabled

serialVersionUID	back to summary
private static final long serialVersionUID

sessionCacheSize	back to summary
private int sessionCacheSize

sessionTimeout	back to summary
private int sessionTimeout

sm	back to summary
private static final StringManager sm

SSL_PROTO_ALL_SET	back to summary
protected static final Set<String> SSL_PROTO_ALL_SET

sslProtocol	back to summary
private String sslProtocol

tls13RenegotiationAvailable	back to summary
private boolean tls13RenegotiationAvailable

trustManagerClassName	back to summary
private String trustManagerClassName

truststore	back to summary
private transient KeyStore truststore

truststoreAlgorithm	back to summary
private String truststoreAlgorithm

truststoreFile	back to summary
private String truststoreFile

truststorePassword	back to summary
private String truststorePassword

truststoreProvider	back to summary
private String truststoreProvider

truststoreType	back to summary
private String truststoreType

Constructor Detail

SSLHostConfig	back to summary
public SSLHostConfig()

Method Detail

addCertificate	back to summary
public void addCertificate(SSLHostConfigCertificate certificate)

adjustRelativePath	back to summary
public static String adjustRelativePath(String path) throws FileNotFoundException

certificatesExpiringBefore	back to summary
public Set<X509Certificate> certificatesExpiringBefore(Date date)

getCaCertificateFile	back to summary
public String getCaCertificateFile()

getCaCertificatePath	back to summary
public String getCaCertificatePath()

getCertificateRevocationListFile	back to summary
public String getCertificateRevocationListFile()

getCertificateRevocationListPath	back to summary
public String getCertificateRevocationListPath()

getCertificates	back to summary
public Set<SSLHostConfigCertificate> getCertificates()

getCertificates	back to summary
public Set<SSLHostConfigCertificate> getCertificates(boolean createDefaultIfEmpty)

getCertificateVerification	back to summary
public SSLHostConfig.CertificateVerification getCertificateVerification()

getCertificateVerificationAsString	back to summary
public String getCertificateVerificationAsString()

getCertificateVerificationDepth	back to summary
public int getCertificateVerificationDepth()

getCipherList	back to summary
public LinkedHashSet<Cipher> getCipherList()

getCiphers	back to summary
public String getCiphers() Returns:String An OpenSSL cipher string for the current configuration.

getConfigType	back to summary
public String getConfigType()

getDisableCompression	back to summary
public boolean getDisableCompression()

getDisableSessionTickets	back to summary
public boolean getDisableSessionTickets()

getEnabledCiphers	back to summary
public String[] getEnabledCiphers() Returns:String[] The ciphers enabled for this TLS virtual host See Also `SSLUtil#getEnabledCiphers()`

getEnabledProtocols	back to summary
public String[] getEnabledProtocols() Returns:String[] The protocols enabled for this TLS virtual host See Also `SSLUtil#getEnabledProtocols()`

getHonorCipherOrder	back to summary
public boolean getHonorCipherOrder()

getHostName	back to summary
public String getHostName() Returns:String The host name associated with this SSL configuration - always in lower case.

getInsecureRenegotiation	back to summary
public boolean getInsecureRenegotiation()

getJsseCipherNames

back to summary

public List<String> getJsseCipherNames()

Obtain the list of JSSE cipher names for the current configuration. Ciphers included in the configuration but not supported by JSSE will be excluded from this list.

Returns:List<String>: A list of the JSSE cipher names

getKeyManagerAlgorithm	back to summary
public String getKeyManagerAlgorithm()

getObjectName	back to summary
public ObjectName getObjectName()

getOpenSslConf	back to summary
public OpenSSLConf getOpenSslConf()

getOpenSslConfContext	back to summary
public Long getOpenSslConfContext()

getOpenSslContext	back to summary
public Long getOpenSslContext()

getProtocols	back to summary
public Set<String> getProtocols()

getRevocationEnabled	back to summary
public boolean getRevocationEnabled()

getSessionCacheSize	back to summary
public int getSessionCacheSize()

getSessionTimeout	back to summary
public int getSessionTimeout()

getSslProtocol	back to summary
public String getSslProtocol()

getTrustManagerClassName	back to summary
public String getTrustManagerClassName()

getTruststore	back to summary
public KeyStore getTruststore() throws IOException

getTruststoreAlgorithm	back to summary
public String getTruststoreAlgorithm()

getTruststoreFile	back to summary
public String getTruststoreFile()

getTruststorePassword	back to summary
public String getTruststorePassword()

getTruststoreProvider	back to summary
public String getTruststoreProvider()

getTruststoreType	back to summary
public String getTruststoreType()

isCertificateVerificationDepthConfigured	back to summary
public boolean isCertificateVerificationDepthConfigured()

isExplicitlyRequestedProtocol	back to summary
pack-priv boolean isExplicitlyRequestedProtocol(String protocol)

isTls13RenegotiationAvailable	back to summary
public boolean isTls13RenegotiationAvailable()

registerDefaultCertificate	back to summary
private void registerDefaultCertificate()

setCaCertificateFile	back to summary
public void setCaCertificateFile(String caCertificateFile)

setCaCertificatePath	back to summary
public void setCaCertificatePath(String caCertificatePath)

setCertificateRevocationListFile	back to summary
public void setCertificateRevocationListFile(String certificateRevocationListFile)

setCertificateRevocationListPath	back to summary
public void setCertificateRevocationListPath(String certificateRevocationListPath)

setCertificateVerification	back to summary
public void setCertificateVerification(String certificateVerification)

setCertificateVerificationAsString	back to summary
public void setCertificateVerificationAsString(String certificateVerification)

setCertificateVerificationDepth	back to summary
public void setCertificateVerificationDepth(int certificateVerificationDepth)

setCiphers

back to summary

public void setCiphers(String ciphersList)

Set the new cipher configuration.

Note

Regardless of the format used to set the configuration, it is always stored in OpenSSL format.

Parameters

ciphersList:String: The new cipher configuration in OpenSSL or JSSE format

setDisableCompression	back to summary
public void setDisableCompression(boolean disableCompression)

setDisableSessionTickets	back to summary
public void setDisableSessionTickets(boolean disableSessionTickets)

setEnabledCiphers	back to summary
public void setEnabledCiphers(String[] enabledCiphers)

setEnabledProtocols	back to summary
public void setEnabledProtocols(String[] enabledProtocols)

setHonorCipherOrder	back to summary
public void setHonorCipherOrder(boolean honorCipherOrder)

setHostName	back to summary
public void setHostName(String hostName)

setInsecureRenegotiation	back to summary
public void setInsecureRenegotiation(boolean insecureRenegotiation)

setKeyManagerAlgorithm	back to summary
public void setKeyManagerAlgorithm(String keyManagerAlgorithm)

setObjectName	back to summary
public void setObjectName(ObjectName oname)

setOpenSslConf	back to summary
public void setOpenSslConf(OpenSSLConf conf)

setOpenSslConfContext	back to summary
public void setOpenSslConfContext(Long openSslConfContext)

setOpenSslContext	back to summary
public void setOpenSslContext(Long openSslContext)

setProperty

back to summary

pack-priv boolean setProperty(String name, SSLHostConfig.Type configType)

Set property which belongs to the specified configuration type.

Parameters

name:String: the property name
configType:SSLHostConfig.Type: the configuration type

Returns:boolean

true if the property belongs to the current configuration, and false otherwise

setProtocols	back to summary
public void setProtocols(String input)

setRevocationEnabled	back to summary
public void setRevocationEnabled(boolean revocationEnabled)

setSessionCacheSize	back to summary
public void setSessionCacheSize(int sessionCacheSize)

setSessionTimeout	back to summary
public void setSessionTimeout(int sessionTimeout)

setSslProtocol	back to summary
public void setSslProtocol(String sslProtocol)

setTls13RenegotiationAvailable	back to summary
public void setTls13RenegotiationAvailable(boolean tls13RenegotiationAvailable)

setTrustManagerClassName	back to summary
public void setTrustManagerClassName(String trustManagerClassName)

setTrustStore	back to summary
public void setTrustStore(KeyStore truststore)

setTruststoreAlgorithm	back to summary
public void setTruststoreAlgorithm(String truststoreAlgorithm)

setTruststoreFile	back to summary
public void setTruststoreFile(String truststoreFile)

setTruststorePassword	back to summary
public void setTruststorePassword(String truststorePassword)

setTruststoreProvider	back to summary
public void setTruststoreProvider(String truststoreProvider)

setTruststoreType	back to summary
public void setTruststoreType(String truststoreType)

org.apache.tomcat.util.net back to summary

public final Enum SSLHostConfig.CertificateVerification

Class Inheritance

extends Enum<SSLHostConfig.CertificateVerification>

java.lang.Object
java.lang.Enum
org.apache.tomcat.util.net.SSLHostConfig.CertificateVerification

Field Summary

Modifier and Type	Field and Description
public static final SSLHostConfig.CertificateVerification	NONE
public static final SSLHostConfig.CertificateVerification	OPTIONAL
private final boolean	optional
public static final SSLHostConfig.CertificateVerification	OPTIONAL_NO_CA
public static final SSLHostConfig.CertificateVerification	REQUIRED

Constructor Summary

Access	Constructor and Description
private	CertificateVerification(boolean optional)

Method Summary

Modifier and Type	Method and Description
public static SSLHostConfig.CertificateVerification	fromString(String value)
public boolean	isOptional()
public static SSLHostConfig.CertificateVerification	valueOf(String name)
public static SSLHostConfig.CertificateVerification[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

NONE	back to summary
public static final SSLHostConfig.CertificateVerification NONE

OPTIONAL	back to summary
public static final SSLHostConfig.CertificateVerification OPTIONAL

optional	back to summary
private final boolean optional

OPTIONAL_NO_CA	back to summary
public static final SSLHostConfig.CertificateVerification OPTIONAL_NO_CA

REQUIRED	back to summary
public static final SSLHostConfig.CertificateVerification REQUIRED

Constructor Detail

CertificateVerification	back to summary
private CertificateVerification(boolean optional)

Method Detail

fromString	back to summary
public static SSLHostConfig.CertificateVerification fromString(String value)

isOptional	back to summary
public boolean isOptional()

valueOf	back to summary
public static SSLHostConfig.CertificateVerification valueOf(String name)

values	back to summary
public static SSLHostConfig.CertificateVerification[] values()

public Class SSLHostConfig

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum SSLHostConfig.CertificateVerification

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum SSLHostConfig.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
public static final SSLHostConfig.Type	JSSE
public static final SSLHostConfig.Type	OPENSSL

Modifier and Type	Method and Description
public static SSLHostConfig.Type	valueOf(String name)
public static SSLHostConfig.Type[]	values()