Package org.apache.tomcat.util.net
Class SSLHostConfig
- java.lang.Object
- 
- org.apache.tomcat.util.net.SSLHostConfig
 
- 
- All Implemented Interfaces:
- java.io.Serializable
 
 public class SSLHostConfig extends java.lang.Object implements java.io.SerializableRepresents the TLS configuration for a virtual host.- See Also:
- Serialized Form
 
- 
- 
Nested Class SummaryNested Classes Modifier and Type Class Description static classSSLHostConfig.CertificateVerificationstatic classSSLHostConfig.Type
 - 
Field SummaryFields Modifier and Type Field Description protected static java.lang.StringDEFAULT_SSL_HOST_NAMEstatic java.lang.StringDEFAULT_TLS_CIPHERSprotected static java.util.Set<java.lang.String>SSL_PROTO_ALL_SET
 - 
Constructor SummaryConstructors Constructor Description SSLHostConfig()
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddCertificate(SSLHostConfigCertificate certificate)static java.lang.StringadjustRelativePath(java.lang.String path)java.lang.StringgetCaCertificateFile()java.lang.StringgetCaCertificatePath()java.lang.StringgetCertificateChainFile()java.lang.StringgetCertificateFile()java.lang.StringgetCertificateKeyAlias()java.lang.StringgetCertificateKeyFile()java.lang.StringgetCertificateKeyPassword()java.lang.StringgetCertificateKeystoreFile()java.lang.StringgetCertificateKeystorePassword()java.lang.StringgetCertificateKeystoreProvider()java.lang.StringgetCertificateKeystoreType()java.lang.StringgetCertificateRevocationListFile()java.lang.StringgetCertificateRevocationListPath()java.util.Set<SSLHostConfigCertificate>getCertificates()java.util.Set<SSLHostConfigCertificate>getCertificates(boolean createDefaultIfEmpty)SSLHostConfig.CertificateVerificationgetCertificateVerification()java.lang.StringgetCertificateVerificationAsString()intgetCertificateVerificationDepth()java.util.LinkedHashSet<Cipher>getCipherList()java.lang.StringgetCiphers()java.lang.StringgetConfigType()booleangetDisableCompression()booleangetDisableSessionTickets()java.lang.String[]getEnabledCiphers()java.lang.String[]getEnabledProtocols()booleangetHonorCipherOrder()java.lang.StringgetHostName()booleangetInsecureRenegotiation()java.util.List<java.lang.String>getJsseCipherNames()Obtain the list of JSSE cipher names for the current configuration.java.lang.StringgetKeyManagerAlgorithm()javax.management.ObjectNamegetObjectName()OpenSSLConfgetOpenSslConf()java.lang.LonggetOpenSslConfContext()java.lang.LonggetOpenSslContext()java.util.Set<java.lang.String>getProtocols()booleangetRevocationEnabled()intgetSessionCacheSize()intgetSessionTimeout()java.lang.StringgetSslProtocol()java.lang.StringgetTrustManagerClassName()java.security.KeyStoregetTruststore()java.lang.StringgetTruststoreAlgorithm()java.lang.StringgetTruststoreFile()java.lang.StringgetTruststorePassword()java.lang.StringgetTruststoreProvider()java.lang.StringgetTruststoreType()booleanisCertificateVerificationDepthConfigured()booleanisTls13RenegotiationAvailable()voidsetCaCertificateFile(java.lang.String caCertificateFile)voidsetCaCertificatePath(java.lang.String caCertificatePath)voidsetCertificateChainFile(java.lang.String certificateChainFile)voidsetCertificateFile(java.lang.String certificateFile)voidsetCertificateKeyAlias(java.lang.String certificateKeyAlias)voidsetCertificateKeyFile(java.lang.String certificateKeyFile)voidsetCertificateKeyPassword(java.lang.String certificateKeyPassword)voidsetCertificateKeystoreFile(java.lang.String certificateKeystoreFile)voidsetCertificateKeystorePassword(java.lang.String certificateKeystorePassword)voidsetCertificateKeystoreProvider(java.lang.String certificateKeystoreProvider)voidsetCertificateKeystoreType(java.lang.String certificateKeystoreType)voidsetCertificateRevocationListFile(java.lang.String certificateRevocationListFile)voidsetCertificateRevocationListPath(java.lang.String certificateRevocationListPath)voidsetCertificateVerification(java.lang.String certificateVerification)voidsetCertificateVerificationAsString(java.lang.String certificateVerification)voidsetCertificateVerificationDepth(int certificateVerificationDepth)voidsetCiphers(java.lang.String ciphersList)Set the new cipher configuration.voidsetDisableCompression(boolean disableCompression)voidsetDisableSessionTickets(boolean disableSessionTickets)voidsetEnabledCiphers(java.lang.String[] enabledCiphers)voidsetEnabledProtocols(java.lang.String[] enabledProtocols)voidsetHonorCipherOrder(boolean honorCipherOrder)voidsetHostName(java.lang.String hostName)voidsetInsecureRenegotiation(boolean insecureRenegotiation)voidsetKeyManagerAlgorithm(java.lang.String keyManagerAlgorithm)voidsetObjectName(javax.management.ObjectName oname)voidsetOpenSslConf(OpenSSLConf conf)voidsetOpenSslConfContext(java.lang.Long openSslConfContext)voidsetOpenSslContext(java.lang.Long openSslContext)voidsetProtocols(java.lang.String input)voidsetRevocationEnabled(boolean revocationEnabled)voidsetSessionCacheSize(int sessionCacheSize)voidsetSessionTimeout(int sessionTimeout)voidsetSslProtocol(java.lang.String sslProtocol)voidsetTls13RenegotiationAvailable(boolean tls13RenegotiationAvailable)voidsetTrustManagerClassName(java.lang.String trustManagerClassName)voidsetTrustStore(java.security.KeyStore truststore)voidsetTruststoreAlgorithm(java.lang.String truststoreAlgorithm)voidsetTruststoreFile(java.lang.String truststoreFile)voidsetTruststorePassword(java.lang.String truststorePassword)voidsetTruststoreProvider(java.lang.String truststoreProvider)voidsetTruststoreType(java.lang.String truststoreType)
 
- 
- 
- 
Field Detail- 
DEFAULT_SSL_HOST_NAMEprotected static final java.lang.String DEFAULT_SSL_HOST_NAME - See Also:
- Constant Field Values
 
 - 
SSL_PROTO_ALL_SETprotected static final java.util.Set<java.lang.String> SSL_PROTO_ALL_SET 
 - 
DEFAULT_TLS_CIPHERSpublic static final java.lang.String DEFAULT_TLS_CIPHERS - See Also:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
isTls13RenegotiationAvailablepublic boolean isTls13RenegotiationAvailable() 
 - 
setTls13RenegotiationAvailablepublic void setTls13RenegotiationAvailable(boolean tls13RenegotiationAvailable) 
 - 
getOpenSslConfContextpublic java.lang.Long getOpenSslConfContext() 
 - 
setOpenSslConfContextpublic void setOpenSslConfContext(java.lang.Long openSslConfContext) 
 - 
getOpenSslContextpublic java.lang.Long getOpenSslContext() 
 - 
setOpenSslContextpublic void setOpenSslContext(java.lang.Long openSslContext) 
 - 
getConfigTypepublic java.lang.String getConfigType() 
 - 
getEnabledProtocolspublic java.lang.String[] getEnabledProtocols() - Returns:
- The protocols enabled for this TLS virtual host
- See Also:
- SSLUtil.getEnabledProtocols()
 
 - 
setEnabledProtocolspublic void setEnabledProtocols(java.lang.String[] enabledProtocols) 
 - 
getEnabledCipherspublic java.lang.String[] getEnabledCiphers() - Returns:
- The ciphers enabled for this TLS virtual host
- See Also:
- SSLUtil.getEnabledCiphers()
 
 - 
setEnabledCipherspublic void setEnabledCiphers(java.lang.String[] enabledCiphers) 
 - 
getObjectNamepublic javax.management.ObjectName getObjectName() 
 - 
setObjectNamepublic void setObjectName(javax.management.ObjectName oname) 
 - 
addCertificatepublic void addCertificate(SSLHostConfigCertificate certificate) 
 - 
getOpenSslConfpublic OpenSSLConf getOpenSslConf() 
 - 
setOpenSslConfpublic void setOpenSslConf(OpenSSLConf conf) 
 - 
getCertificatespublic java.util.Set<SSLHostConfigCertificate> getCertificates() 
 - 
getCertificatespublic java.util.Set<SSLHostConfigCertificate> getCertificates(boolean createDefaultIfEmpty) 
 - 
getCertificateKeyPasswordpublic java.lang.String getCertificateKeyPassword() 
 - 
setCertificateKeyPasswordpublic void setCertificateKeyPassword(java.lang.String certificateKeyPassword) 
 - 
setCertificateRevocationListFilepublic void setCertificateRevocationListFile(java.lang.String certificateRevocationListFile) 
 - 
getCertificateRevocationListFilepublic java.lang.String getCertificateRevocationListFile() 
 - 
setCertificateVerificationpublic void setCertificateVerification(java.lang.String certificateVerification) 
 - 
getCertificateVerificationpublic SSLHostConfig.CertificateVerification getCertificateVerification() 
 - 
setCertificateVerificationAsStringpublic void setCertificateVerificationAsString(java.lang.String certificateVerification) 
 - 
getCertificateVerificationAsStringpublic java.lang.String getCertificateVerificationAsString() 
 - 
setCertificateVerificationDepthpublic void setCertificateVerificationDepth(int certificateVerificationDepth) 
 - 
getCertificateVerificationDepthpublic int getCertificateVerificationDepth() 
 - 
isCertificateVerificationDepthConfiguredpublic boolean isCertificateVerificationDepthConfigured() 
 - 
setCipherspublic void setCiphers(java.lang.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- The new cipher configuration in OpenSSL or JSSE format
 
 - 
getCipherspublic java.lang.String getCiphers() - Returns:
- An OpenSSL cipher string for the current configuration.
 
 - 
getCipherListpublic java.util.LinkedHashSet<Cipher> getCipherList() 
 - 
getJsseCipherNamespublic java.util.List<java.lang.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:
- A list of the JSSE cipher names
 
 - 
setHonorCipherOrderpublic void setHonorCipherOrder(boolean honorCipherOrder) 
 - 
getHonorCipherOrderpublic boolean getHonorCipherOrder() 
 - 
setHostNamepublic void setHostName(java.lang.String hostName) 
 - 
getHostNamepublic java.lang.String getHostName() - Returns:
- The host name associated with this SSL configuration - always in lower case.
 
 - 
setProtocolspublic void setProtocols(java.lang.String input) 
 - 
getProtocolspublic java.util.Set<java.lang.String> getProtocols() 
 - 
setSessionCacheSizepublic void setSessionCacheSize(int sessionCacheSize) 
 - 
getSessionCacheSizepublic int getSessionCacheSize() 
 - 
setSessionTimeoutpublic void setSessionTimeout(int sessionTimeout) 
 - 
getSessionTimeoutpublic int getSessionTimeout() 
 - 
getCertificateKeyAliaspublic java.lang.String getCertificateKeyAlias() 
 - 
setCertificateKeyAliaspublic void setCertificateKeyAlias(java.lang.String certificateKeyAlias) 
 - 
getCertificateKeystoreFilepublic java.lang.String getCertificateKeystoreFile() 
 - 
setCertificateKeystoreFilepublic void setCertificateKeystoreFile(java.lang.String certificateKeystoreFile) 
 - 
getCertificateKeystorePasswordpublic java.lang.String getCertificateKeystorePassword() 
 - 
setCertificateKeystorePasswordpublic void setCertificateKeystorePassword(java.lang.String certificateKeystorePassword) 
 - 
getCertificateKeystoreProviderpublic java.lang.String getCertificateKeystoreProvider() 
 - 
setCertificateKeystoreProviderpublic void setCertificateKeystoreProvider(java.lang.String certificateKeystoreProvider) 
 - 
getCertificateKeystoreTypepublic java.lang.String getCertificateKeystoreType() 
 - 
setCertificateKeystoreTypepublic void setCertificateKeystoreType(java.lang.String certificateKeystoreType) 
 - 
setKeyManagerAlgorithmpublic void setKeyManagerAlgorithm(java.lang.String keyManagerAlgorithm) 
 - 
getKeyManagerAlgorithmpublic java.lang.String getKeyManagerAlgorithm() 
 - 
setRevocationEnabledpublic void setRevocationEnabled(boolean revocationEnabled) 
 - 
getRevocationEnabledpublic boolean getRevocationEnabled() 
 - 
setSslProtocolpublic void setSslProtocol(java.lang.String sslProtocol) 
 - 
getSslProtocolpublic java.lang.String getSslProtocol() 
 - 
setTrustManagerClassNamepublic void setTrustManagerClassName(java.lang.String trustManagerClassName) 
 - 
getTrustManagerClassNamepublic java.lang.String getTrustManagerClassName() 
 - 
setTruststoreAlgorithmpublic void setTruststoreAlgorithm(java.lang.String truststoreAlgorithm) 
 - 
getTruststoreAlgorithmpublic java.lang.String getTruststoreAlgorithm() 
 - 
setTruststoreFilepublic void setTruststoreFile(java.lang.String truststoreFile) 
 - 
getTruststoreFilepublic java.lang.String getTruststoreFile() 
 - 
setTruststorePasswordpublic void setTruststorePassword(java.lang.String truststorePassword) 
 - 
getTruststorePasswordpublic java.lang.String getTruststorePassword() 
 - 
setTruststoreProviderpublic void setTruststoreProvider(java.lang.String truststoreProvider) 
 - 
getTruststoreProviderpublic java.lang.String getTruststoreProvider() 
 - 
setTruststoreTypepublic void setTruststoreType(java.lang.String truststoreType) 
 - 
getTruststoreTypepublic java.lang.String getTruststoreType() 
 - 
setTrustStorepublic void setTrustStore(java.security.KeyStore truststore) 
 - 
getTruststorepublic java.security.KeyStore getTruststore() throws java.io.IOException- Throws:
- java.io.IOException
 
 - 
getCertificateChainFilepublic java.lang.String getCertificateChainFile() 
 - 
setCertificateChainFilepublic void setCertificateChainFile(java.lang.String certificateChainFile) 
 - 
getCertificateFilepublic java.lang.String getCertificateFile() 
 - 
setCertificateFilepublic void setCertificateFile(java.lang.String certificateFile) 
 - 
getCertificateKeyFilepublic java.lang.String getCertificateKeyFile() 
 - 
setCertificateKeyFilepublic void setCertificateKeyFile(java.lang.String certificateKeyFile) 
 - 
setCertificateRevocationListPathpublic void setCertificateRevocationListPath(java.lang.String certificateRevocationListPath) 
 - 
getCertificateRevocationListPathpublic java.lang.String getCertificateRevocationListPath() 
 - 
setCaCertificateFilepublic void setCaCertificateFile(java.lang.String caCertificateFile) 
 - 
getCaCertificateFilepublic java.lang.String getCaCertificateFile() 
 - 
setCaCertificatePathpublic void setCaCertificatePath(java.lang.String caCertificatePath) 
 - 
getCaCertificatePathpublic java.lang.String getCaCertificatePath() 
 - 
setDisableCompressionpublic void setDisableCompression(boolean disableCompression) 
 - 
getDisableCompressionpublic boolean getDisableCompression() 
 - 
setDisableSessionTicketspublic void setDisableSessionTickets(boolean disableSessionTickets) 
 - 
getDisableSessionTicketspublic boolean getDisableSessionTickets() 
 - 
setInsecureRenegotiationpublic void setInsecureRenegotiation(boolean insecureRenegotiation) 
 - 
getInsecureRenegotiationpublic boolean getInsecureRenegotiation() 
 - 
adjustRelativePathpublic static java.lang.String adjustRelativePath(java.lang.String path) throws java.io.FileNotFoundException- Throws:
- java.io.FileNotFoundException
 
 
- 
 
-