Netty 5.0.0.Alpha5 · io.netty5.handler.ssl.SslUtils

Field Summary

Modifier and Type	Field and Description
pack-priv static final String[]	DEFAULT_CIPHER_SUITES
pack-priv static final String[]	DEFAULT_TLSV13_CIPHER_SUITES
pack-priv static final TrustManager[]	EMPTY_TRUST_MANAGERS
pack-priv static final int	GMSSL_PROTOCOL_VERSION GMSSL Protocol Version
pack-priv static final String	INVALID_CIPHER
private static final InternalLogger	logger
pack-priv static final int	NOT_ENCRYPTED data is not encrypted
pack-priv static final int	NOT_ENOUGH_DATA Not enough data in buffer to parse the record length
pack-priv static final int	SSL_CONTENT_TYPE_ALERT alert
pack-priv static final int	SSL_CONTENT_TYPE_APPLICATION_DATA application data
pack-priv static final int	SSL_CONTENT_TYPE_CHANGE_CIPHER_SPEC change cipher spec
pack-priv static final int	SSL_CONTENT_TYPE_EXTENSION_HEARTBEAT HeartBeat Extension
pack-priv static final int	SSL_CONTENT_TYPE_HANDSHAKE handshake
pack-priv static final int	SSL_RECORD_HEADER_LENGTH the length of the ssl record header (in bytes)
pack-priv static final String[]	TLSV13_CIPHER_SUITES
pack-priv static final Set<String>	TLSV13_CIPHERS
private static final boolean	TLSV1_3_JDK_DEFAULT_ENABLED
private static final boolean	TLSV1_3_JDK_SUPPORTED

Constructor Summary

Access	Constructor and Description
private	SslUtils()

Method Summary

Modifier and Type	Method and Description
pack-priv static void	addIfSupported(Set<String> supported, List<String> enabled, String... names) Add elements from `names` into `enabled` if they are in `supported`.
pack-priv static boolean	arrayContains(String[] array, String value)
pack-priv static int	Returns: length The length of the encrypted packet that is included in the buffer or `SslUtils#NOT_ENOUGH_DATA` if not enough data is present in the `Buffer`. This will return `SslUtils#NOT_ENCRYPTED` if the given `Buffer` is not encrypted at all. getEncryptedPacketLength(Buffer The `Buffer` to read from. Be aware it must have at least `SSL_RECORD_HEADER_LENGTH` bytes to read, otherwise it will throw an `IllegalArgumentException`. buffer, int offset) Return how many bytes can be read out of the encrypted data.
pack-priv static int	getEncryptedPacketLength(ByteBuffer[] buffers, int offset)
private static int	getEncryptedPacketLength(ByteBuffer buffer)
pack-priv static SSLContext	getSSLContext(String provider)
private static String	getTlsVersion()
pack-priv static void	handleHandshakeFailure(ChannelHandlerContext ctx, SSLSession session, String applicationProtocol, Throwable cause, boolean notify)
pack-priv static boolean	isTLSv13Cipher(String cipher) Returns `true` if the given cipher (in openssl format) is for TLSv1.3, `false` otherwise.
pack-priv static boolean	isTLSv13EnabledByJDK(Provider provider) Returns `true` if the JDK itself supports TLSv1.3 and enabled it by default, `false` otherwise.
private static boolean	isTLSv13EnabledByJDK0(Provider provider)
pack-priv static boolean	isTLSv13SupportedByJDK(Provider provider) Returns `true` if the JDK itself supports TLSv1.3, `false` otherwise.
private static boolean	isTLSv13SupportedByJDK0(Provider provider)
pack-priv static boolean	isValidHostNameForSNI(String hostname) Validate that the given hostname can be used in SNI extension.
private static SSLContext	newInitContext(Provider provider)
private static short	shortBE(ByteBuffer buffer, int offset)
pack-priv static Buffer	toBase64(BufferAllocator allocator, Buffer src) Same as `Base64#encode(Buffer, boolean)` but uses `Buffer` and allows the use of a custom `BufferAllocator`.
pack-priv static SSLHandshakeException	toSSLHandshakeException(Throwable e) Converts the given exception to a `SSLHandshakeException`, if it isn't already.
private static short	unsignedByte(byte b)
private static int	unsignedShortBE(ByteBuffer buffer, int offset)
pack-priv static void	useFallbackCiphersIfDefaultIsEmpty(List<String> defaultCiphers, Iterable<String> fallbackCiphers)
pack-priv static void	useFallbackCiphersIfDefaultIsEmpty(List<String> defaultCiphers, String... fallbackCiphers)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

DEFAULT_CIPHER_SUITES	back to summary
pack-priv static final String[] DEFAULT_CIPHER_SUITES

DEFAULT_TLSV13_CIPHER_SUITES	back to summary
pack-priv static final String[] DEFAULT_TLSV13_CIPHER_SUITES

EMPTY_TRUST_MANAGERS	back to summary
pack-priv static final TrustManager[] EMPTY_TRUST_MANAGERS

GMSSL_PROTOCOL_VERSION	back to summary
pack-priv static final int GMSSL_PROTOCOL_VERSION GMSSL Protocol Version

INVALID_CIPHER	back to summary
pack-priv static final String INVALID_CIPHER

logger	back to summary
private static final InternalLogger logger

NOT_ENCRYPTED	back to summary
pack-priv static final int NOT_ENCRYPTED data is not encrypted

NOT_ENOUGH_DATA	back to summary
pack-priv static final int NOT_ENOUGH_DATA Not enough data in buffer to parse the record length

SSL_CONTENT_TYPE_ALERT	back to summary
pack-priv static final int SSL_CONTENT_TYPE_ALERT alert

SSL_CONTENT_TYPE_APPLICATION_DATA	back to summary
pack-priv static final int SSL_CONTENT_TYPE_APPLICATION_DATA application data

SSL_CONTENT_TYPE_CHANGE_CIPHER_SPEC	back to summary
pack-priv static final int SSL_CONTENT_TYPE_CHANGE_CIPHER_SPEC change cipher spec

SSL_CONTENT_TYPE_EXTENSION_HEARTBEAT	back to summary
pack-priv static final int SSL_CONTENT_TYPE_EXTENSION_HEARTBEAT HeartBeat Extension

SSL_CONTENT_TYPE_HANDSHAKE	back to summary
pack-priv static final int SSL_CONTENT_TYPE_HANDSHAKE handshake

SSL_RECORD_HEADER_LENGTH	back to summary
pack-priv static final int SSL_RECORD_HEADER_LENGTH the length of the ssl record header (in bytes)

TLSV13_CIPHER_SUITES	back to summary
pack-priv static final String[] TLSV13_CIPHER_SUITES

TLSV13_CIPHERS	back to summary
pack-priv static final Set<String> TLSV13_CIPHERS

TLSV1_3_JDK_DEFAULT_ENABLED	back to summary
private static final boolean TLSV1_3_JDK_DEFAULT_ENABLED

TLSV1_3_JDK_SUPPORTED	back to summary
private static final boolean TLSV1_3_JDK_SUPPORTED

Constructor Detail

SslUtils	back to summary
private SslUtils()

Method Detail

addIfSupported	back to summary
pack-priv static void addIfSupported(Set<String> supported, List<String> enabled, String... names) Add elements from `names` into `enabled` if they are in `supported`.

arrayContains	back to summary
pack-priv static boolean arrayContains(String[] array, String value)

getEncryptedPacketLength back to summary

getEncryptedPacketLength	back to summary
pack-priv static int getEncryptedPacketLength(Buffer buffer, int offset) Return how many bytes can be read out of the encrypted data. Be aware this method will not increase the readerIndex of the given `Buffer`. Parameters buffer:Buffer The `Buffer` to read from. Be aware it must have at least `SSL_RECORD_HEADER_LENGTH` bytes to read, otherwise it will throw an `IllegalArgumentException`. Returns:int length The length of the encrypted packet that is included in the buffer or `SslUtils#NOT_ENOUGH_DATA` if not enough data is present in the `Buffer`. This will return `SslUtils#NOT_ENCRYPTED` if the given `Buffer` is not encrypted at all. Exceptions IllegalArgumentException: Is thrown if the given `Buffer` has not at least `SSL_RECORD_HEADER_LENGTH` bytes to read.

pack-priv static int getEncryptedPacketLength(Buffer buffer, int offset)

Return how many bytes can be read out of the encrypted data. Be aware this method will not increase the readerIndex of the given Buffer.

Parameters

buffer:Buffer: The Buffer to read from. Be aware it must have at least SSL_RECORD_HEADER_LENGTH bytes to read, otherwise it will throw an IllegalArgumentException.

Returns:int

length The length of the encrypted packet that is included in the buffer or SslUtils#NOT_ENOUGH_DATA if not enough data is present in the Buffer. This will return SslUtils#NOT_ENCRYPTED if the given Buffer is not encrypted at all.

Exceptions

IllegalArgumentException:: Is thrown if the given Buffer has not at least SSL_RECORD_HEADER_LENGTH bytes to read.

getEncryptedPacketLength	back to summary
pack-priv static int getEncryptedPacketLength(ByteBuffer[] buffers, int offset)

getEncryptedPacketLength	back to summary
private static int getEncryptedPacketLength(ByteBuffer buffer)

getSSLContext	back to summary
pack-priv static SSLContext getSSLContext(String provider) throws NoSuchAlgorithmException, KeyManagementException, NoSuchProviderException

getTlsVersion	back to summary
private static String getTlsVersion()

handleHandshakeFailure	back to summary
pack-priv static void handleHandshakeFailure(ChannelHandlerContext ctx, SSLSession session, String applicationProtocol, Throwable cause, boolean notify)

isTLSv13Cipher	back to summary
pack-priv static boolean isTLSv13Cipher(String cipher) Returns `true` if the given cipher (in openssl format) is for TLSv1.3, `false` otherwise.

isTLSv13EnabledByJDK	back to summary
pack-priv static boolean isTLSv13EnabledByJDK(Provider provider) Returns `true` if the JDK itself supports TLSv1.3 and enabled it by default, `false` otherwise.

isTLSv13EnabledByJDK0	back to summary
private static boolean isTLSv13EnabledByJDK0(Provider provider)

isTLSv13SupportedByJDK	back to summary
pack-priv static boolean isTLSv13SupportedByJDK(Provider provider) Returns `true` if the JDK itself supports TLSv1.3, `false` otherwise.

isTLSv13SupportedByJDK0	back to summary
private static boolean isTLSv13SupportedByJDK0(Provider provider)

isValidHostNameForSNI	back to summary
pack-priv static boolean isValidHostNameForSNI(String hostname) Validate that the given hostname can be used in SNI extension.

newInitContext	back to summary
private static SSLContext newInitContext(Provider provider) throws NoSuchAlgorithmException, KeyManagementException

shortBE	back to summary
private static short shortBE(ByteBuffer buffer, int offset)

toBase64 back to summary

toBase64	back to summary
pack-priv static Buffer toBase64(BufferAllocator allocator, Buffer src) Same as `Base64#encode(Buffer, boolean)` but uses `Buffer` and allows the use of a custom `BufferAllocator`. See Also `Base64#encode(Buffer, boolean)`

pack-priv static Buffer toBase64(BufferAllocator allocator, Buffer src)

Same as Base64#encode(Buffer, boolean) but uses Buffer and allows the use of a custom BufferAllocator.

See Also: Base64#encode(Buffer, boolean)

toSSLHandshakeException	back to summary
pack-priv static SSLHandshakeException toSSLHandshakeException(Throwable e) Converts the given exception to a `SSLHandshakeException`, if it isn't already.

unsignedByte	back to summary
private static short unsignedByte(byte b)

unsignedShortBE	back to summary
private static int unsignedShortBE(ByteBuffer buffer, int offset)

useFallbackCiphersIfDefaultIsEmpty	back to summary
pack-priv static void useFallbackCiphersIfDefaultIsEmpty(List<String> defaultCiphers, Iterable<String> fallbackCiphers)

useFallbackCiphersIfDefaultIsEmpty	back to summary
pack-priv static void useFallbackCiphersIfDefaultIsEmpty(List<String> defaultCiphers, String... fallbackCiphers)