Package org.kiwiproject.config

Class TlsContextConfiguration.TlsContextConfigurationBuilder

java.lang.Object

org.kiwiproject.config.TlsContextConfiguration.TlsContextConfigurationBuilder

Enclosing class:

TlsContextConfiguration

public static class TlsContextConfiguration.TlsContextConfigurationBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
TlsContextConfiguration	build()
TlsContextConfiguration.TlsContextConfigurationBuilder	certAlias(String certAlias)	The alias of a specific client certificate to present when authenticating.
TlsContextConfiguration.TlsContextConfigurationBuilder	disableSniHostCheck(boolean disableSniHostCheck)	Whether the SNI (Server Name Indication) host check is disabled.
TlsContextConfiguration.TlsContextConfigurationBuilder	keyStorePassword(String keyStorePassword)	Key store password.
TlsContextConfiguration.TlsContextConfigurationBuilder	keyStorePath(String keyStorePath)	Absolute path to the key store.
TlsContextConfiguration.TlsContextConfigurationBuilder	keyStoreProvider(String keyStoreProvider)	The name of the provider for the key store, i.e., the value of provider to use when getting the KeyStore instance for the key store.
TlsContextConfiguration.TlsContextConfigurationBuilder	keyStoreType(String keyStoreType)	Key store type.
TlsContextConfiguration.TlsContextConfigurationBuilder	protocol(String protocol)	The TLS/SSL protocol to use.
TlsContextConfiguration.TlsContextConfigurationBuilder	provider(String provider)	The name of the JCE (Java Cryptography Extension) provider to use on the client side for cryptographic support (for example, SunJCE, Conscrypt, BC, etc.).
TlsContextConfiguration.TlsContextConfigurationBuilder	supportedCiphers(List<String> supportedCiphers)	A list of cipher suites (e.g., TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256) which are supported.
TlsContextConfiguration.TlsContextConfigurationBuilder	supportedProtocols(List<String> supportedProtocols)	List of supported protocols.
String	toString()
TlsContextConfiguration.TlsContextConfigurationBuilder	trustSelfSignedCertificates(boolean trustSelfSignedCertificates)	Whether self-signed certificates should be trusted.
TlsContextConfiguration.TlsContextConfigurationBuilder	trustStorePassword(String trustStorePassword)	Trust store password.
TlsContextConfiguration.TlsContextConfigurationBuilder	trustStorePath(String trustStorePath)	Absolute path to the trust store.
TlsContextConfiguration.TlsContextConfigurationBuilder	trustStoreProvider(String trustStoreProvider)	The name of the provider for the trust store, i.e., the value of provider to use when getting the KeyStore instance for the trust store.
TlsContextConfiguration.TlsContextConfigurationBuilder	trustStoreType(String trustStoreType)	Trust store type.
TlsContextConfiguration.TlsContextConfigurationBuilder	verifyHostname(boolean verifyHostname)	Should host names be verified when establishing secure connections?

Methods inherited from class java.lang.Object

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

Method Details

protocol

public TlsContextConfiguration.TlsContextConfigurationBuilder protocol(String protocol)

The TLS/SSL protocol to use. Default is SSLContextProtocol.TLS_1_2.

Returns:

this.

See Also:

• SSLContextProtocol

provider

public TlsContextConfiguration.TlsContextConfigurationBuilder provider(String provider)

The name of the JCE (Java Cryptography Extension) provider to use on the client side for cryptographic support (for example, SunJCE, Conscrypt, BC, etc.).

For more details, see the "Java Cryptography Architecture (JCA) Reference Guide" section of the Java Security Developer’s Guide.

Returns:

this.

keyStorePath

public TlsContextConfiguration.TlsContextConfigurationBuilder keyStorePath(String keyStorePath)

Absolute path to the key store.

Returns:

this.

keyStorePassword

public TlsContextConfiguration.TlsContextConfigurationBuilder keyStorePassword(String keyStorePassword)

Key store password.

Returns:

this.

keyStoreType

public TlsContextConfiguration.TlsContextConfigurationBuilder keyStoreType(String keyStoreType)

Key store type. Defaults to KeyStoreType.JKS.

Returns:

this.

See Also:

• KeyStoreType

keyStoreProvider

public TlsContextConfiguration.TlsContextConfigurationBuilder keyStoreProvider(String keyStoreProvider)

The name of the provider for the key store, i.e., the value of provider to use when getting the KeyStore instance for the key store.

For more details, see the "Java Cryptography Architecture (JCA) Reference Guide" section of the Java Security Developer’s Guide.

Returns:

this.

See Also:

• KeyStore.getInstance(String, String)

trustStorePath

public TlsContextConfiguration.TlsContextConfigurationBuilder trustStorePath(String trustStorePath)

Absolute path to the trust store.

Returns:

this.

trustStorePassword

public TlsContextConfiguration.TlsContextConfigurationBuilder trustStorePassword(String trustStorePassword)

Trust store password.

Returns:

this.

trustStoreType

public TlsContextConfiguration.TlsContextConfigurationBuilder trustStoreType(String trustStoreType)

Trust store type. Defaults to KeyStoreType.JKS.

Returns:

this.

See Also:

• KeyStoreType

trustStoreProvider

public TlsContextConfiguration.TlsContextConfigurationBuilder trustStoreProvider(String trustStoreProvider)

The name of the provider for the trust store, i.e., the value of provider to use when getting the KeyStore instance for the trust store.

For more details, see the "Java Cryptography Architecture (JCA) Reference Guide" section of the Java Security Developer’s Guide.

Returns:

this.

See Also:

• KeyStore.getInstance(String, String)

trustSelfSignedCertificates

public TlsContextConfiguration.TlsContextConfigurationBuilder trustSelfSignedCertificates(boolean trustSelfSignedCertificates)

Whether self-signed certificates should be trusted. Default is false.

Returns:

this.

verifyHostname

public TlsContextConfiguration.TlsContextConfigurationBuilder verifyHostname(boolean verifyHostname)

Should host names be verified when establishing secure connections? Default is true.

Returns:

this.

disableSniHostCheck

public TlsContextConfiguration.TlsContextConfigurationBuilder disableSniHostCheck(boolean disableSniHostCheck)

Whether the SNI (Server Name Indication) host check is disabled. Default is false

Returns:

this.

See Also:

• What is SNI? How TLS server name indication works

supportedProtocols

public TlsContextConfiguration.TlsContextConfigurationBuilder supportedProtocols(List<String> supportedProtocols)

List of supported protocols. It can be null. See the implementation note for why.

Returns:

this.

Implementation Note:

Yes, this is null by default. This is due to the Dropwizard TlsConfiguration which has this same property null by default; I suspect this is ultimately due to the (unfortunate) way in which Apache HttpClient's SSLConnectionSocketFactory accepts supportedProtocols in its constructors as arrays that are supposed to be null if you aren't specifying a specific list of them. The HttpClient code does an explicit null check on the supportedProtocols in SSLConnectionSocketFactory.createLayeredSocket(Socket, String, int, org.apache.hc.core5.http.protocol.HttpContext). You will need to look at the source code, as the JavaDoc doesn't mention this tidbit, nor do the constructors since they don't have any documentation regarding their arguments. If you don't like reading source code of the open-source tools you rely on, then please close this file, log out, and change careers.

supportedCiphers

public TlsContextConfiguration.TlsContextConfigurationBuilder supportedCiphers(List<String> supportedCiphers)

A list of cipher suites (e.g., TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256) which are supported. All other cipher suites will be refused.

Note that this can be null for similar reason as supportedProtocols. See the implementation note on supportedProtocols.

Returns:

this.

certAlias

public TlsContextConfiguration.TlsContextConfigurationBuilder certAlias(String certAlias)

The alias of a specific client certificate to present when authenticating. Use this when the specified keystore has multiple certificates to force use of a non-default certificate.

Returns:

this.

build

public TlsContextConfiguration build()

toString

public String toString()

Overrides:

toString in class Object