io.muserver

Class HttpsConfigBuilder

java.lang.Object

io.muserver.SSLContextBuilder

io.muserver.HttpsConfigBuilder

public class HttpsConfigBuilder
extends SSLContextBuilder

A builder for specifying HTTPS config.

To use HTTPS in your server, create an HTTPS Config builder and pass it to MuServerBuilder.withHttpsConfig(HttpsConfigBuilder)

Constructor Summary

Constructors

Constructor and Description
HttpsConfigBuilder()

Method Summary

Modifier and Type	Method and Description
static HttpsConfigBuilder	httpsConfig()
static HttpsConfigBuilder	unsignedLocalhost() Creates an SSL config builder that will serve HTTPS over a self-signed SSL cert for the localhost domain.
HttpsConfigBuilder	withCipherFilter(SSLCipherFilter cipherFilter) Sets a filter allowing you to specify which ciphers you would like to support.
HttpsConfigBuilder	withDefaultAlias(String certAlias) This option may be useful for cases where multiple certificates exist in a single keystore.
HttpsConfigBuilder	withKeyManagerFactory(KeyManagerFactory keyManagerFactory) Sets the key manager factory to use for SSL.
HttpsConfigBuilder	withKeyPassword(char[] keyPassword)
HttpsConfigBuilder	withKeyPassword(String keyPassword)
HttpsConfigBuilder	withKeystore(File file)
HttpsConfigBuilder	withKeystore(InputStream keystoreStream) Loads a keystore from the given stream.
HttpsConfigBuilder	withKeystoreFromClasspath(String classpath) Loads a keystore from the classpath
HttpsConfigBuilder	withKeystorePassword(char[] keystorePassword)
HttpsConfigBuilder	withKeystorePassword(String keystorePassword)
HttpsConfigBuilder	withKeystoreType(String keystoreType)
HttpsConfigBuilder	withProtocols(String... protocols) Sets the SSL/TLS protocols to use, for example "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3".

Methods inherited from class io.muserver.SSLContextBuilder

build, defaultSSLContext, setKeystoreBytes, sslContext, unsignedLocalhostCert, unsignedLocalhostCertBuilder

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpsConfigBuilder

public HttpsConfigBuilder()

Method Detail

httpsConfig

public static HttpsConfigBuilder httpsConfig()

Returns:

a new HttpsConfig builder

withKeystoreType

public HttpsConfigBuilder withKeystoreType(String keystoreType)

Overrides:

withKeystoreType in class SSLContextBuilder

withKeyPassword

public HttpsConfigBuilder withKeyPassword(String keyPassword)

Overrides:

withKeyPassword in class SSLContextBuilder

withKeystorePassword

public HttpsConfigBuilder withKeystorePassword(String keystorePassword)

Overrides:

withKeystorePassword in class SSLContextBuilder

withKeyPassword

public HttpsConfigBuilder withKeyPassword(char[] keyPassword)

Overrides:

withKeyPassword in class SSLContextBuilder

withKeystorePassword

public HttpsConfigBuilder withKeystorePassword(char[] keystorePassword)

Overrides:

withKeystorePassword in class SSLContextBuilder

withKeystore

public HttpsConfigBuilder withKeystore(InputStream keystoreStream)

Loads a keystore from the given stream.

Does not close the keystore afterwards.

Overrides:

withKeystore in class SSLContextBuilder

Parameters:

keystoreStream - A stream to a keystore

Returns:

This builder

withKeystore

public HttpsConfigBuilder withKeystore(File file)

Overrides:

withKeystore in class SSLContextBuilder

withKeystoreFromClasspath

public HttpsConfigBuilder withKeystoreFromClasspath(String classpath)

Loads a keystore from the classpath

Overrides:

withKeystoreFromClasspath in class SSLContextBuilder

Parameters:

classpath - A path to load a keystore from, for example /mycert.p12

Returns:

This builder

withKeyManagerFactory

public HttpsConfigBuilder withKeyManagerFactory(KeyManagerFactory keyManagerFactory)

Sets the key manager factory to use for SSL.

Note this is an alternative to setting a keystore directory.

Overrides:

withKeyManagerFactory in class SSLContextBuilder

Parameters:

keyManagerFactory - The key manager factory to use

Returns:

This builder

withDefaultAlias

public HttpsConfigBuilder withDefaultAlias(String certAlias)

This option may be useful for cases where multiple certificates exist in a single keystore. For clients that support it, SNI will be used to pick the correct certificate, however if the SNI is not used then by default the first cert from the keystore will be picked. To override this default behaviour, you can specify the certificate to use here when SNI is not available.

Note you do not need to set this if your keystore has only one certificate in it.

Overrides:

withDefaultAlias in class SSLContextBuilder

Parameters:

certAlias - The alias of the cert to pick when SNI isn't available, or null to allow an arbitrary cert to be picked (normally the first one).

Returns:

This builder

withCipherFilter

public HttpsConfigBuilder withCipherFilter(SSLCipherFilter cipherFilter)

Sets a filter allowing you to specify which ciphers you would like to support.

Overrides:

withCipherFilter in class SSLContextBuilder

Parameters:

cipherFilter - A Filter that takes all the supported ciphers, and all the default ciphers (normally the default will exclude insecure ciphers that technically could be supported) and returns a list of ciphers you want to use in your preferred order.

Returns:

This builder

withProtocols

public HttpsConfigBuilder withProtocols(String... protocols)

Sets the SSL/TLS protocols to use, for example "SSLv3", "TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3". The default is "TLSv1.2" and "TLSv1.3".

Note that if the current JDK does not support a requested protocol then it will be ignored. If no requested protocols are available, then an exception will be started when this is built.

Overrides:

withProtocols in class SSLContextBuilder

Parameters:

protocols - The protocols to use, or null to use the default.

Returns:

This builder.

unsignedLocalhost

public static HttpsConfigBuilder unsignedLocalhost()

Creates an SSL config builder that will serve HTTPS over a self-signed SSL cert for the localhost domain.

As no clients should trust this cert, this should be used only for testing purposes.

Returns:

An HTTPS Config builder