Top Description Fields Constructors Methods
io.netty.handler.ssl

pack-priv final Class SslUtils

extends Object
Class Inheritance
Imports
io.netty.buffer.ByteBuf, .ByteBufAllocator, .ByteBufUtil, io.netty.channel.ChannelHandlerContext, io.netty.handler.codec.base64.Base64, .Base64Dialect, io.netty.util.NetUtil, io.netty.util.internal.EmptyArrays, .StringUtil, io.netty.util.internal.logging.InternalLogger, .InternalLoggerFactory, java.nio.ByteBuffer, .ByteOrder, java.security.KeyManagementException, .NoSuchAlgorithmException, .NoSuchProviderException, .Provider, java.util.Collections, .LinkedHashSet, .List, .Set, javax.net.ssl.SSLContext, .SSLHandshakeException, .TrustManager
Constants for SSL packets.

Field Summary

Modifier and TypeField and Description
pack-priv static final String[]
DEFAULT_CIPHER_SUITES

pack-priv static final String[]
DEFAULT_TLSV13_CIPHER_SUITES

pack-priv static final short
DTLS_1_0

pack-priv static final short
DTLS_1_2

pack-priv static final short
DTLS_1_3

pack-priv static final short
DTLS_RECORD_HEADER_LENGTH

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

AccessConstructor and Description
private
SslUtils()

Method Summary

Modifier and TypeMethod 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 ByteBuf. This will return SslUtils#NOT_ENCRYPTED if the given ByteBuf is not encrypted at all.
getEncryptedPacketLength(ByteBuf
The ByteBuf to read from.
buffer, int offset)

Return how much 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, 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(ByteBuf buffer, int offset)

private static short
shortBE(ByteBuffer buffer, int offset)

pack-priv static ByteBuf
toBase64(ByteBufAllocator allocator, ByteBuf src)

Same as Base64#encode(ByteBuf, boolean) but allows the use of a custom ByteBufAllocator.

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(ByteBuf buffer, int offset)

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)

pack-priv static void
zeroout(ByteBuf buffer)

Fills the ByteBuf with zero bytes.

pack-priv static void
zerooutAndRelease(ByteBuf buffer)

Fills the ByteBuf with zero bytes and releases it.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DEFAULT_CIPHER_SUITESback to summary
pack-priv static final String[] DEFAULT_CIPHER_SUITES
DEFAULT_TLSV13_CIPHER_SUITESback to summary
pack-priv static final String[] DEFAULT_TLSV13_CIPHER_SUITES
DTLS_1_0back to summary
pack-priv static final short DTLS_1_0
DTLS_1_2back to summary
pack-priv static final short DTLS_1_2
DTLS_1_3back to summary
pack-priv static final short DTLS_1_3
DTLS_RECORD_HEADER_LENGTHback to summary
pack-priv static final short DTLS_RECORD_HEADER_LENGTH
GMSSL_PROTOCOL_VERSIONback to summary
pack-priv static final int GMSSL_PROTOCOL_VERSION

GMSSL Protocol Version

INVALID_CIPHERback to summary
pack-priv static final String INVALID_CIPHER
loggerback to summary
private static final InternalLogger logger
NOT_ENCRYPTEDback to summary
pack-priv static final int NOT_ENCRYPTED

data is not encrypted

NOT_ENOUGH_DATAback to summary
pack-priv static final int NOT_ENOUGH_DATA

Not enough data in buffer to parse the record length

SSL_CONTENT_TYPE_ALERTback to summary
pack-priv static final int SSL_CONTENT_TYPE_ALERT

alert

SSL_CONTENT_TYPE_APPLICATION_DATAback to summary
pack-priv static final int SSL_CONTENT_TYPE_APPLICATION_DATA

application data

SSL_CONTENT_TYPE_CHANGE_CIPHER_SPECback to summary
pack-priv static final int SSL_CONTENT_TYPE_CHANGE_CIPHER_SPEC

change cipher spec

SSL_CONTENT_TYPE_EXTENSION_HEARTBEATback to summary
pack-priv static final int SSL_CONTENT_TYPE_EXTENSION_HEARTBEAT

HeartBeat Extension

SSL_CONTENT_TYPE_HANDSHAKEback to summary
pack-priv static final int SSL_CONTENT_TYPE_HANDSHAKE

handshake

SSL_RECORD_HEADER_LENGTHback to summary
pack-priv static final int SSL_RECORD_HEADER_LENGTH

the length of the ssl record header (in bytes)

TLSV13_CIPHER_SUITESback to summary
pack-priv static final String[] TLSV13_CIPHER_SUITES
TLSV13_CIPHERSback to summary
pack-priv static final Set<String> TLSV13_CIPHERS
TLSV1_3_JDK_DEFAULT_ENABLEDback to summary
private static final boolean TLSV1_3_JDK_DEFAULT_ENABLED
TLSV1_3_JDK_SUPPORTEDback to summary
private static final boolean TLSV1_3_JDK_SUPPORTED

Constructor Detail

SslUtilsback to summary
private SslUtils()

Method Detail

addIfSupportedback 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.

arrayContainsback to summary
pack-priv static boolean arrayContains(String[] array, String value)
getEncryptedPacketLengthback to summary
pack-priv static int getEncryptedPacketLength(ByteBuf buffer, int offset)

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

Parameters
buffer:ByteBuf

The ByteBuf to read from.

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 ByteBuf. This will return SslUtils#NOT_ENCRYPTED if the given ByteBuf is not encrypted at all.

getEncryptedPacketLengthback to summary
pack-priv static int getEncryptedPacketLength(ByteBuffer[] buffers, int offset)
getEncryptedPacketLengthback to summary
private static int getEncryptedPacketLength(ByteBuffer buffer)
getSSLContextback to summary
pack-priv static SSLContext getSSLContext(String provider) throws NoSuchAlgorithmException, KeyManagementException, NoSuchProviderException
getTlsVersionback to summary
private static String getTlsVersion()
handleHandshakeFailureback to summary
pack-priv static void handleHandshakeFailure(ChannelHandlerContext ctx, Throwable cause, boolean notify)
isTLSv13Cipherback to summary
pack-priv static boolean isTLSv13Cipher(String cipher)

Returns true if the given cipher (in openssl format) is for TLSv1.3, false otherwise.

isTLSv13EnabledByJDKback 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.

isTLSv13EnabledByJDK0back to summary
private static boolean isTLSv13EnabledByJDK0(Provider provider)
isTLSv13SupportedByJDKback to summary
pack-priv static boolean isTLSv13SupportedByJDK(Provider provider)

Returns true if the JDK itself supports TLSv1.3, false otherwise.

isTLSv13SupportedByJDK0back to summary
private static boolean isTLSv13SupportedByJDK0(Provider provider)
isValidHostNameForSNIback to summary
pack-priv static boolean isValidHostNameForSNI(String hostname)

Validate that the given hostname can be used in SNI extension.

newInitContextback to summary
private static SSLContext newInitContext(Provider provider) throws NoSuchAlgorithmException, KeyManagementException
shortBEback to summary
private static short shortBE(ByteBuf buffer, int offset)
Annotations
@SuppressWarnings:deprecation
shortBEback to summary
private static short shortBE(ByteBuffer buffer, int offset)
toBase64back to summary
pack-priv static ByteBuf toBase64(ByteBufAllocator allocator, ByteBuf src)

Same as Base64#encode(ByteBuf, boolean) but allows the use of a custom ByteBufAllocator.

See Also
Base64#encode(ByteBuf, boolean)
toSSLHandshakeExceptionback to summary
pack-priv static SSLHandshakeException toSSLHandshakeException(Throwable e)

Converts the given exception to a SSLHandshakeException, if it isn't already.

unsignedByteback to summary
private static short unsignedByte(byte b)
unsignedShortBEback to summary
private static int unsignedShortBE(ByteBuf buffer, int offset)
Annotations
@SuppressWarnings:deprecation
unsignedShortBEback to summary
private static int unsignedShortBE(ByteBuffer buffer, int offset)
useFallbackCiphersIfDefaultIsEmptyback to summary
pack-priv static void useFallbackCiphersIfDefaultIsEmpty(List<String> defaultCiphers, Iterable<String> fallbackCiphers)
useFallbackCiphersIfDefaultIsEmptyback to summary
pack-priv static void useFallbackCiphersIfDefaultIsEmpty(List<String> defaultCiphers, String... fallbackCiphers)
zerooutback to summary
pack-priv static void zeroout(ByteBuf buffer)

Fills the ByteBuf with zero bytes.

zerooutAndReleaseback to summary
pack-priv static void zerooutAndRelease(ByteBuf buffer)

Fills the ByteBuf with zero bytes and releases it.