io.micronaut.http.ssl

Class SslConfiguration

java.lang.Object

io.micronaut.http.ssl.SslConfiguration

All Implemented Interfaces:

Toggleable

Direct Known Subclasses:

AbstractClientSslConfiguration, DefaultSslConfiguration, ServerSslConfiguration

public class SslConfiguration
extends Object
implements Toggleable

Configuration properties for SSL handling.

Since:

1.0

Author:

James Kleeh

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SslConfiguration.KeyConfiguration Configuration properties for SSL key.
static class	SslConfiguration.KeyStoreConfiguration Configuration properties for SSL key store.
static class	SslConfiguration.TrustStoreConfiguration Configuration properties for SSL trust store.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	buildSelfSigned
static boolean	DEFAULT_BUILDSELFSIGNED The default build self signed value.
static boolean	DEFAULT_ENABLED The default enable value.
static int	DEFAULT_PORT The default port value.
static String	DEFAULT_PROTOCOL The default protocol.
protected int	port
static String	PREFIX The prefix used to resolve this configuration.

Constructor Summary

Constructors

Constructor and Description
SslConfiguration()

Method Summary

Modifier and Type	Method and Description
boolean	buildSelfSigned()
Optional<String[]>	getCiphers()
Optional<ClientAuthentication>	getClientAuthentication()
Duration	getHandshakeTimeout()
SslConfiguration.KeyConfiguration	getKey()
SslConfiguration.KeyStoreConfiguration	getKeyStore()
int	getPort()
Optional<String>	getProtocol()
Optional<String[]>	getProtocols()
SslConfiguration.TrustStoreConfiguration	getTrustStore()
boolean	isEnabled()
protected void	readExisting(SslConfiguration defaultSslConfiguration, SslConfiguration.KeyConfiguration defaultKeyConfiguration, SslConfiguration.KeyStoreConfiguration defaultKeyStoreConfiguration, SslConfiguration.TrustStoreConfiguration defaultTrustStoreConfiguration) Reads an existing config.
void	setBuildSelfSigned(boolean buildSelfSigned) Deprecated. Please use micronaut.server.ssl.build-self-signed instead (buildSelfSigned()).
void	setCiphers(String[] ciphers) Sets the ciphers to use.
void	setClientAuthentication(ClientAuthentication clientAuthentication) Sets the client authentication mode.
void	setEnabled(boolean enabled) Whether SSL is enabled.
void	setHandshakeTimeout(Duration handshakeTimeout)
void	setKey(SslConfiguration.KeyConfiguration key) Sets the key configuration.
void	setKeyStore(SslConfiguration.KeyStoreConfiguration keyStore) Sets the keystore configuration.
void	setPort(int port) Deprecated. Please use micronaut.server.ssl.port instead (ServerSslConfiguration.setPort(int)).
void	setProtocol(String protocol) Sets the protocol to use.
void	setProtocols(String[] protocols) Sets the protocols to use.
void	setTrustStore(SslConfiguration.TrustStoreConfiguration trustStore) Sets the trust store configuration.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

The prefix used to resolve this configuration.

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

The default port value.

See Also:

Constant Field Values

DEFAULT_BUILDSELFSIGNED

public static final boolean DEFAULT_BUILDSELFSIGNED

The default build self signed value.

See Also:

Constant Field Values

DEFAULT_PROTOCOL

public static final String DEFAULT_PROTOCOL

The default protocol.

See Also:

Constant Field Values

port

protected int port

buildSelfSigned

protected boolean buildSelfSigned

Constructor Detail

SslConfiguration

public SslConfiguration()

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Toggleable

Returns:

Whether SSL is enabled.

setEnabled

public void setEnabled(boolean enabled)

Whether SSL is enabled. Default value (false).

Parameters:

enabled - True if SSL is enabled

getPort

public int getPort()

Returns:

The default SSL port

buildSelfSigned

public boolean buildSelfSigned()

Returns:

Whether or not to build a self signed certificate

getClientAuthentication

public Optional<ClientAuthentication> getClientAuthentication()

Returns:

The type of client authentication

getCiphers

public Optional<String[]> getCiphers()

Returns:

Which SSL ciphers to use

getProtocols

public Optional<String[]> getProtocols()

Returns:

Which protocols to use

getKey

public SslConfiguration.KeyConfiguration getKey()

Returns:

The configuration for the key

getKeyStore

public SslConfiguration.KeyStoreConfiguration getKeyStore()

Returns:

The configuration for the key store

getTrustStore

public SslConfiguration.TrustStoreConfiguration getTrustStore()

Returns:

The configuration for the trust store

getProtocol

public Optional<String> getProtocol()

Returns:

The protocol to use

getHandshakeTimeout

@NonNull
public Duration getHandshakeTimeout()

Returns:

The timeout for the SSL handshake

setPort

@Deprecated
public void setPort(int port)

Deprecated. Please use micronaut.server.ssl.port instead (ServerSslConfiguration.setPort(int)).

Sets the SSL port. Default value (8443).

Parameters:

port - The port

setBuildSelfSigned

@Deprecated
public void setBuildSelfSigned(boolean buildSelfSigned)

Deprecated. Please use micronaut.server.ssl.build-self-signed instead (buildSelfSigned()).

Sets whether to build a self signed certificate. Default value (false).

Parameters:

buildSelfSigned - True if a certificate should be built

setKey

public void setKey(SslConfiguration.KeyConfiguration key)

Sets the key configuration.

Parameters:

key - The key configuration

setKeyStore

public void setKeyStore(SslConfiguration.KeyStoreConfiguration keyStore)

Sets the keystore configuration.

Parameters:

keyStore - The keystore configuration

setTrustStore

public void setTrustStore(SslConfiguration.TrustStoreConfiguration trustStore)

Sets the trust store configuration.

Parameters:

trustStore - The trust store.

setClientAuthentication

public void setClientAuthentication(ClientAuthentication clientAuthentication)

Sets the client authentication mode.

Parameters:

clientAuthentication - The client authentication mode

setCiphers

public void setCiphers(String[] ciphers)

Sets the ciphers to use.

Parameters:

ciphers - The ciphers

setProtocols

public void setProtocols(String[] protocols)

Sets the protocols to use.

Parameters:

protocols - The protocols

setProtocol

public void setProtocol(String protocol)

Sets the protocol to use. Default value ("TLS").

Parameters:

protocol - The protocol

setHandshakeTimeout

public void setHandshakeTimeout(@NonNull
                                Duration handshakeTimeout)

Parameters:

handshakeTimeout - The timeout for the SSL handshake

readExisting

protected final void readExisting(SslConfiguration defaultSslConfiguration,
                                  SslConfiguration.KeyConfiguration defaultKeyConfiguration,
                                  SslConfiguration.KeyStoreConfiguration defaultKeyStoreConfiguration,
                                  SslConfiguration.TrustStoreConfiguration defaultTrustStoreConfiguration)

Reads an existing config.

Parameters:

defaultSslConfiguration - The default SSL config

defaultKeyConfiguration - The default key config

defaultKeyStoreConfiguration - The default keystore config

defaultTrustStoreConfiguration - The Default truststore config