Package io.netty.handler.ssl

Class OpenSslContextOption<T>

java.lang.Object

io.netty.util.AbstractConstant<SslContextOption<T>>

io.netty.handler.ssl.SslContextOption<T>

io.netty.handler.ssl.OpenSslContextOption<T>

Type Parameters:

T - the type of the value.

All Implemented Interfaces:

Constant<SslContextOption<T>>, java.lang.Comparable<SslContextOption<T>>

public final class OpenSslContextOption<T>
extends SslContextOption<T>

SslContextOptions that are specific to the SslProvider.OPENSSL / SslProvider.OPENSSL_REFCNT.

Field Summary

Fields

Modifier and Type	Field	Description
static OpenSslContextOption<OpenSslAsyncPrivateKeyMethod>	ASYNC_PRIVATE_KEY_METHOD	Set the OpenSslAsyncPrivateKeyMethod to use.
static OpenSslContextOption<OpenSslCertificateCompressionConfig>	CERTIFICATE_COMPRESSION_ALGORITHMS	Set the OpenSslCertificateCompressionConfig to use.
static OpenSslContextOption<java.lang.String[]>	GROUPS	Set the groups that should be used.
static OpenSslContextOption<java.lang.Integer>	MAX_CERTIFICATE_LIST_BYTES	Set the maximum number of bytes that is allowed during the handshake for certificate chain.
static OpenSslContextOption<OpenSslPrivateKeyMethod>	PRIVATE_KEY_METHOD	Set the OpenSslPrivateKeyMethod to use.
static OpenSslContextOption<java.lang.Boolean>	TLS_FALSE_START	If enabled TLS false start will be enabled if supported.
static OpenSslContextOption<java.lang.Integer>	TMP_DH_KEYLENGTH	Set the desired length of the Diffie-Hellman ephemeral session keys.
static OpenSslContextOption<java.lang.Boolean>	USE_JDK_PROVIDER_SIGNATURES	Set the policy for handling alternative key providers (such as hardware security keys, smart cards, remote signing services, etc.) when using BoringSSL.
static OpenSslContextOption<java.lang.Boolean>	USE_TASKS	If enabled heavy-operations may be offloaded from the EventLoop if possible.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	OpenSslContextOption(java.lang.String name)

Method Summary

Methods inherited from class io.netty.handler.ssl.SslContextOption

exists, validate, valueOf, valueOf

Methods inherited from class io.netty.util.AbstractConstant

compareTo, equals, hashCode, id, name, toString

Methods inherited from class java.lang.Object

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

Field Detail

USE_TASKS

public static final OpenSslContextOption<java.lang.Boolean> USE_TASKS

If enabled heavy-operations may be offloaded from the EventLoop if possible.

TLS_FALSE_START

public static final OpenSslContextOption<java.lang.Boolean> TLS_FALSE_START

If enabled TLS false start will be enabled if supported. When TLS false start is enabled the flow of SslHandshakeCompletionEvents may be different compared when, not enabled. This is currently only supported when BoringSSL and ALPN is used.

PRIVATE_KEY_METHOD

public static final OpenSslContextOption<OpenSslPrivateKeyMethod> PRIVATE_KEY_METHOD

Set the OpenSslPrivateKeyMethod to use. This allows to offload private-key operations if needed. This is currently only supported when BoringSSL is used.

ASYNC_PRIVATE_KEY_METHOD

public static final OpenSslContextOption<OpenSslAsyncPrivateKeyMethod> ASYNC_PRIVATE_KEY_METHOD

Set the OpenSslAsyncPrivateKeyMethod to use. This allows to offload private-key operations if needed. This is currently only supported when BoringSSL is used.

CERTIFICATE_COMPRESSION_ALGORITHMS

public static final OpenSslContextOption<OpenSslCertificateCompressionConfig> CERTIFICATE_COMPRESSION_ALGORITHMS

Set the OpenSslCertificateCompressionConfig to use. This allows for the configuration of certificate compression algorithms which should be used, the priority of those algorithms and the directions in which they should be used. If this option is not specified, zlib compression is enabled in both directions. An empty configuration disables it. The jdk.tls.client.disableExtensions and jdk.tls.server.disableExtensions system properties disable the default for the corresponding side when they contain compress_certificate. An explicitly configured option takes precedence over these system properties. This is currently only supported when BoringSSL or AWS-LC is used.

MAX_CERTIFICATE_LIST_BYTES

public static final OpenSslContextOption<java.lang.Integer> MAX_CERTIFICATE_LIST_BYTES

Set the maximum number of bytes that is allowed during the handshake for certificate chain. Positive values below 16 KiB are treated as 16 KiB.

GROUPS

public static final OpenSslContextOption<java.lang.String[]> GROUPS

Set the groups that should be used. This will override curves set with -Djdk.tls.namedGroups.

See SSL_CTX_set1_groups_list.

TMP_DH_KEYLENGTH

public static final OpenSslContextOption<java.lang.Integer> TMP_DH_KEYLENGTH

Set the desired length of the Diffie-Hellman ephemeral session keys. This will override the key length set with -Djdk.tls.ephemeralDHKeySize.

The only supported values are 512, 1024, 2048, and 4096.

See SSL_CTX_set_tmp_dh_callback.

USE_JDK_PROVIDER_SIGNATURES

public static final OpenSslContextOption<java.lang.Boolean> USE_JDK_PROVIDER_SIGNATURES

Set the policy for handling alternative key providers (such as hardware security keys, smart cards, remote signing services, etc.) when using BoringSSL.

Note: this feature only works when BoringSSL or AWS-LC is used.

Constructor Detail

OpenSslContextOption

private OpenSslContextOption(java.lang.String name)