Class ServerSSLOptions

java.lang.Object

io.vertx.core.net.SSLOptions

io.vertx.core.net.ServerSSLOptions

public class ServerSSLOptions
extends SSLOptions

Server SSL options.

Field Summary

Fields

Modifier and Type	Field	Description
static final ClientAuth	DEFAULT_CLIENT_AUTH	Default value of whether client auth is required (SSL/TLS) = No
static final boolean	DEFAULT_SNI	Default value of whether the server supports SNI = false

Fields inherited from class SSLOptions

DEFAULT_ENABLED_SECURE_TRANSPORT_PROTOCOLS, DEFAULT_PQC_ENFORCEMENT_POLICY, DEFAULT_SSL_HANDSHAKE_TIMEOUT, DEFAULT_SSL_HANDSHAKE_TIMEOUT_TIME_UNIT, DEFAULT_USE_ALPN

Constructor Summary

Constructors

Constructor	Description
ServerSSLOptions()	Default constructor
ServerSSLOptions(JsonObject json)	Create options from JSON
ServerSSLOptions(ServerSSLOptions other)	Copy constructor

Method Summary

Modifier and Type	Method	Description
ServerSSLOptions	addCrlPath(String crlPath)	Add a CRL path
ServerSSLOptions	addCrlValue(Buffer crlValue)	Add a CRL value
ServerSSLOptions	addEnabledCipherSuite(String suite)	Add an enabled cipher suite, appended to the ordered suites.
ServerSSLOptions	addEnabledSecureTransportProtocol(String protocol)	Add an enabled SSL/TLS protocols, appended to the ordered protocols.
ServerSSLOptions	addKeyExchangeGroup(String group)	Add a key exchange group name.
ServerSSLOptions	copy()
ClientAuth	getClientAuth()
protected void	init()
boolean	isSni()
ServerSSLOptions	removeEnabledCipherSuite(String suite)	Removes an enabled cipher suite from the ordered suites.
ServerSSLOptions	removeEnabledSecureTransportProtocol(String protocol)	Removes an enabled SSL/TLS protocol from the ordered protocols.
ServerSSLOptions	setApplicationLayerProtocols(List<String> protocols)	Set the list of application-layer protocols to provide to the server during the Application-Layer Protocol Negotiation.
ServerSSLOptions	setClientAuth(ClientAuth clientAuth)	Set whether client auth is required
ServerSSLOptions	setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)	Sets the list of enabled SSL/TLS protocols.
ServerSSLOptions	setKeyCertOptions(KeyCertOptions options)	Set the key/cert options.
ServerSSLOptions	setKeyExchangeGroups(List<String> keyExchangeGroups)	Set the list of key exchange group names to use for TLS connections.
ServerSSLOptions	setPqcEnforcementPolicy(PqcEnforcementPolicy pqcEnforcementPolicy)	Set the post-quantum cryptography enforcement policy.
ServerSSLOptions	setSni(boolean sni)	Set whether the server supports Server Name Indiciation
ServerSSLOptions	setSslHandshakeTimeout(long sslHandshakeTimeout)	Set the SSL handshake timeout, default time unit is seconds.
ServerSSLOptions	setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)	Set the SSL handshake timeout unit.
ServerSSLOptions	setTrustOptions(TrustOptions options)	Set the trust options.
ServerSSLOptions	setUseAlpn(boolean useAlpn)	Set the ALPN usage.
JsonObject	toJson()	Convert to JSON

Methods inherited from class SSLOptions

equals, getApplicationLayerProtocols, getCrlPaths, getCrlValues, getEnabledCipherSuites, getEnabledSecureTransportProtocols, getKeyCertOptions, getKeyExchangeGroups, getPqcEnforcementPolicy, getSslHandshakeTimeout, getSslHandshakeTimeoutUnit, getTrustOptions, hashCode, isUseAlpn

Methods inherited from class Object

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

Field Details

DEFAULT_CLIENT_AUTH

public static final ClientAuth DEFAULT_CLIENT_AUTH

Default value of whether client auth is required (SSL/TLS) = No

DEFAULT_SNI

public static final boolean DEFAULT_SNI

Default value of whether the server supports SNI = false

See Also:

• Constant Field Values

Constructor Details

ServerSSLOptions

public ServerSSLOptions()

Default constructor

ServerSSLOptions

public ServerSSLOptions(ServerSSLOptions other)

Copy constructor

Parameters:

other - the options to copy

ServerSSLOptions

public ServerSSLOptions(JsonObject json)

Create options from JSON

Parameters:

json - the JSON

Method Details

init

protected void init()

Overrides:

init in class SSLOptions

copy

public ServerSSLOptions copy()

Overrides:

copy in class SSLOptions

getClientAuth

public ClientAuth getClientAuth()

setClientAuth

public ServerSSLOptions setClientAuth(ClientAuth clientAuth)

Set whether client auth is required

Parameters:

clientAuth - One of "NONE, REQUEST, REQUIRED". If it's set to "REQUIRED" then server will require the SSL cert to be presented otherwise it won't accept the request. If it's set to "REQUEST" then it won't mandate the certificate to be presented, basically make it optional.

Returns:

a reference to this, so the API can be used fluently

isSni

public boolean isSni()

Returns:

whether the server supports Server Name Indication

setSni

public ServerSSLOptions setSni(boolean sni)

Set whether the server supports Server Name Indiciation

Returns:

a reference to this, so the API can be used fluently

setKeyCertOptions

public ServerSSLOptions setKeyCertOptions(KeyCertOptions options)

Description copied from class: SSLOptions

Set the key/cert options.

Overrides:

setKeyCertOptions in class SSLOptions

Parameters:

options - the key store options

Returns:

a reference to this, so the API can be used fluently

setTrustOptions

public ServerSSLOptions setTrustOptions(TrustOptions options)

Description copied from class: SSLOptions

Set the trust options.

Overrides:

setTrustOptions in class SSLOptions

Parameters:

options - the trust options

Returns:

a reference to this, so the API can be used fluently

setUseAlpn

public ServerSSLOptions setUseAlpn(boolean useAlpn)

Description copied from class: SSLOptions

Set the ALPN usage.

Overrides:

setUseAlpn in class SSLOptions

Parameters:

useAlpn - true when Application-Layer Protocol Negotiation should be used

setKeyExchangeGroups

public ServerSSLOptions setKeyExchangeGroups(List<String> keyExchangeGroups)

Description copied from class: SSLOptions

Set the list of key exchange group names to use for TLS connections.

The effective groups used during the TLS handshake depend on the SSLOptions.getPqcEnforcementPolicy():

• PqcEnforcementPolicy.RELAXED: uses the specified groups as-is, or engine defaults if null
• PqcEnforcementPolicy.CLIENT_NEGOTIATED: prepends X25519MLKEM768 if not already present
• PqcEnforcementPolicy.STRICT: replaces the list with only X25519MLKEM768

Overrides:

setKeyExchangeGroups in class SSLOptions

Parameters:

keyExchangeGroups - the key exchange group names

Returns:

a reference to this, so the API can be used fluently

addKeyExchangeGroup

public ServerSSLOptions addKeyExchangeGroup(String group)

Description copied from class: SSLOptions

Add a key exchange group name.

Overrides:

addKeyExchangeGroup in class SSLOptions

Parameters:

group - the group name to add

Returns:

a reference to this, so the API can be used fluently

setPqcEnforcementPolicy

public ServerSSLOptions setPqcEnforcementPolicy(PqcEnforcementPolicy pqcEnforcementPolicy)

Description copied from class: SSLOptions

Set the post-quantum cryptography enforcement policy.

When set to PqcEnforcementPolicy.STRICT or PqcEnforcementPolicy.CLIENT_NEGOTIATED, the SSL engine will be automatically switched to OpenSSL if not already configured.

Overrides:

setPqcEnforcementPolicy in class SSLOptions

Parameters:

pqcEnforcementPolicy - the enforcement policy

Returns:

a reference to this, so the API can be used fluently

setSslHandshakeTimeout

public ServerSSLOptions setSslHandshakeTimeout(long sslHandshakeTimeout)

Description copied from class: SSLOptions

Set the SSL handshake timeout, default time unit is seconds.

Overrides:

setSslHandshakeTimeout in class SSLOptions

Parameters:

sslHandshakeTimeout - the SSL handshake timeout to set, in milliseconds

Returns:

a reference to this, so the API can be used fluently

setSslHandshakeTimeoutUnit

public ServerSSLOptions setSslHandshakeTimeoutUnit(TimeUnit sslHandshakeTimeoutUnit)

Description copied from class: SSLOptions

Set the SSL handshake timeout unit. If not specified, default is seconds.

Overrides:

setSslHandshakeTimeoutUnit in class SSLOptions

Parameters:

sslHandshakeTimeoutUnit - specify time unit.

Returns:

a reference to this, so the API can be used fluently

setEnabledSecureTransportProtocols

public ServerSSLOptions setEnabledSecureTransportProtocols(Set<String> enabledSecureTransportProtocols)

Description copied from class: SSLOptions

Sets the list of enabled SSL/TLS protocols.

Overrides:

setEnabledSecureTransportProtocols in class SSLOptions

Parameters:

enabledSecureTransportProtocols - the SSL/TLS protocols to enable

Returns:

a reference to this, so the API can be used fluently

setApplicationLayerProtocols

public ServerSSLOptions setApplicationLayerProtocols(List<String> protocols)

Description copied from class: SSLOptions

Set the list of application-layer protocols to provide to the server during the Application-Layer Protocol Negotiation.

Overrides:

setApplicationLayerProtocols in class SSLOptions

Parameters:

protocols - the protocols

Returns:

a reference to this, so the API can be used fluently

addEnabledCipherSuite

public ServerSSLOptions addEnabledCipherSuite(String suite)

Description copied from class: SSLOptions

Add an enabled cipher suite, appended to the ordered suites.

Overrides:

addEnabledCipherSuite in class SSLOptions

Parameters:

suite - the suite

Returns:

a reference to this, so the API can be used fluently

See Also:

• SSLOptions.getEnabledCipherSuites()

addCrlPath

public ServerSSLOptions addCrlPath(String crlPath)
                            throws NullPointerException

Description copied from class: SSLOptions

Add a CRL path

Overrides:

addCrlPath in class SSLOptions

Parameters:

crlPath - the path

Returns:

a reference to this, so the API can be used fluently

Throws:

NullPointerException

addCrlValue

public ServerSSLOptions addCrlValue(Buffer crlValue)
                             throws NullPointerException

Description copied from class: SSLOptions

Add a CRL value

Overrides:

addCrlValue in class SSLOptions

Parameters:

crlValue - the value

Returns:

a reference to this, so the API can be used fluently

Throws:

NullPointerException

addEnabledSecureTransportProtocol

public ServerSSLOptions addEnabledSecureTransportProtocol(String protocol)

Description copied from class: SSLOptions

Add an enabled SSL/TLS protocols, appended to the ordered protocols.

Overrides:

addEnabledSecureTransportProtocol in class SSLOptions

Parameters:

protocol - the SSL/TLS protocol to enable

Returns:

a reference to this, so the API can be used fluently

removeEnabledCipherSuite

public ServerSSLOptions removeEnabledCipherSuite(String suite)

Description copied from class: SSLOptions

Removes an enabled cipher suite from the ordered suites.

Overrides:

removeEnabledCipherSuite in class SSLOptions

Parameters:

suite - the suite

Returns:

a reference to this, so the API can be used fluently

removeEnabledSecureTransportProtocol

public ServerSSLOptions removeEnabledSecureTransportProtocol(String protocol)

Description copied from class: SSLOptions

Removes an enabled SSL/TLS protocol from the ordered protocols.

Overrides:

removeEnabledSecureTransportProtocol in class SSLOptions

Parameters:

protocol - the SSL/TLS protocol to disable

Returns:

a reference to this, so the API can be used fluently

toJson

public JsonObject toJson()

Convert to JSON

Overrides:

toJson in class SSLOptions

Returns:

the JSON