Module org.bzdev.ejws

Package org.bzdev.ejws

Class EmbeddedWebServer.SSLSetup

java.lang.Object

org.bzdev.ejws.EmbeddedWebServer.SSLSetup

Enclosing class:

EmbeddedWebServer

public static class EmbeddedWebServer.SSLSetup
extends Object

Setup parameters for an secure-socket server. The methods return the object created by the constructor so that one can chain the methods together for initialization. The default keystore and password are stored as a resource in the EJWS jar file. When this is used, there is a corresponding truststore in a file named ejwsCerts.jks. On Linux systems, this should be in the directory /usr/share/bzdev although its actual location may be system dependent. This truststore's password is "changeit". As it is in a directory owned by root, and is intended only for testing, this password should not be changed. ejwsCerts.jks is needed because without explicitly providing a keystore containing the server's certificate, a self-signed certificate will be used (a common practice during testing).

Constructor Summary

Constructors

Constructor	Description
SSLSetup()	Constructor using a default protocol (TLS).
SSLSetup(String protocol)	Constructor.

Method Summary

Modifier and Type	Method	Description
EmbeddedWebServer.SSLSetup	configurator(EmbeddedWebServer.Configurator configurator)	Provide a configurator.
EmbeddedWebServer.SSLSetup	keyPassword(char[] pw)	Provide a password for using a key in the keystore
EmbeddedWebServer.SSLSetup	keystore(InputStream is)	Provide an input stream for a keystore
EmbeddedWebServer.SSLSetup	keystorePassword(char[] pw)	Provide a password for modifying/reading a keystore
EmbeddedWebServer.SSLSetup	trustManagers(TrustManager[] tms)	Provide trust managers.
EmbeddedWebServer.SSLSetup	truststore(InputStream is)	Provide an input stream for a truststore.
EmbeddedWebServer.SSLSetup	truststorePassword(char[] pw)	Provide a password for modifying/reading a truststore

Methods inherited from class java.lang.Object

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

Constructor Details

SSLSetup

public SSLSetup()

Constructor using a default protocol (TLS).

SSLSetup

public SSLSetup(String protocol)

Constructor. Possible secure-socket protocols are currently SSL, SSLv2, SSLv3, TLS, TLSv1, TLSv1.1, TLSv1.2, TLSv1.3, DTLS, DTLSv1.0, or DTLSv1.2 as described in the Java API documentation.

Parameters:

protocol - the secure-socket protocol (for example, "SSL" or "TSL")

Method Details

keystore

public EmbeddedWebServer.SSLSetup keystore(InputStream is)

Provide an input stream for a keystore

Parameters:

is - an input stream used to load the keystore

Returns:

this object

truststore

public EmbeddedWebServer.SSLSetup truststore(InputStream is)

Provide an input stream for a truststore.

Parameters:

is - an input stream used to load the truststore; null to cancel

Returns:

this object

Throws:

IllegalStateException - if trustManagers(javax.net.ssl.TrustManager[]) has been called with a non-null value

See Also:

• trustManagers(TrustManager[])

trustManagers

public EmbeddedWebServer.SSLSetup trustManagers(TrustManager[] tms)

Provide trust managers.

Parameters:

tms - the trust managers; null too cancel

Returns:

this object

Throws:

IllegalStateException - if truststore(java.io.InputStream) was called with a non-null value

See Also:

• truststore(InputStream)

keystorePassword

public EmbeddedWebServer.SSLSetup keystorePassword(char[] pw)

Provide a password for modifying/reading a keystore

Parameters:

pw - the password (as a char array); null for the default ("changeit");

Returns:

this object

keyPassword

public EmbeddedWebServer.SSLSetup keyPassword(char[] pw)

Provide a password for using a key in the keystore

Parameters:

pw - the password (as a char array); null for the default ("changeit");

Returns:

this object

truststorePassword

public EmbeddedWebServer.SSLSetup truststorePassword(char[] pw)

Provide a password for modifying/reading a truststore

Parameters:

pw - the password (as a char array); null for the default ("changeit");

Returns:

this object

configurator

public EmbeddedWebServer.SSLSetup configurator(EmbeddedWebServer.Configurator configurator)

Provide a configurator. Configurators are instance of the functional interface EmbeddedWebServer.Configurator, and will typically be provided by a lambda expression that takes two arguments: an instance of SSLContext and an instance of HttpsParameters. These two arguments are provided by the HttpsServer implementation.

Parameters:

configurator - the configurator

Returns:

an instance of EmbeddedWebServer.SSLSetup, encapsulating SSL parameters

See Also:

• HttpsConfigurator