Package io.netty.handler.ssl

SSL · TLS implementation based on SSLEngine

Interface Summary

Interface	Description
ApplicationProtocolNegotiator	Deprecated. use ApplicationProtocolConfig
CipherSuiteFilter	Provides a means to filter the supplied cipher suite based upon the supported and default cipher suites.
JdkApplicationProtocolNegotiator	Deprecated. use ApplicationProtocolConfig
JdkApplicationProtocolNegotiator.ProtocolSelectionListener	A listener to be notified by which protocol was select by its peer.
JdkApplicationProtocolNegotiator.ProtocolSelectionListenerFactory	Factory interface for JdkApplicationProtocolNegotiator.ProtocolSelectionListener objects.
JdkApplicationProtocolNegotiator.ProtocolSelector	Interface to define the role of an application protocol selector in the SSL handshake process.
JdkApplicationProtocolNegotiator.ProtocolSelectorFactory	Factory interface for JdkApplicationProtocolNegotiator.ProtocolSelector objects.
JdkApplicationProtocolNegotiator.SslEngineWrapperFactory	Abstract factory pattern for wrapping an SSLEngine object.
OpenSslApplicationProtocolNegotiator	Deprecated. use ApplicationProtocolConfig
OpenSslAsyncPrivateKeyMethod
OpenSslCertificateCompressionAlgorithm	Provides compression and decompression implementations for TLS Certificate Compression (RFC 8879).
OpenSslPrivateKeyMethod	Allow to customize private key signing / decrypting (when using RSA).
OpenSslSession	SSLSession sub-type that is used by our native implementation.
ResumableX509ExtendedTrustManager	An interface that TrustManager instances can implement, to be notified of resumed SSL sessions.

Class Summary

Class	Description
AbstractSniHandler<T>	Enables SNI (Server Name Indication) extension for server side SSL.
ApplicationProtocolConfig	Provides an SSLEngine agnostic way to configure a ApplicationProtocolNegotiator.
ApplicationProtocolNames	Provides a set of protocol names used in ALPN and NPN.
ApplicationProtocolNegotiationHandler	Configures a ChannelPipeline depending on the application-level protocol negotiation result of SslHandler.
Ciphers	Cipher suites
CipherSuiteConverter	Converts a Java cipher suite string to an OpenSSL cipher suite string and vice versa.
DelegatingSslContext	Adapter class which allows to wrap another SslContext and init SSLEngine instances.
IdentityCipherSuiteFilter	This class will not do any filtering of ciphers suites.
JdkAlpnApplicationProtocolNegotiator	Deprecated. use ApplicationProtocolConfig.
JdkApplicationProtocolNegotiator.AllocatorAwareSslEngineWrapperFactory
JdkSslClientContext	Deprecated. Use SslContextBuilder to create JdkSslContext instances and only use JdkSslContext in your code.
JdkSslContext	An SslContext which uses JDK's SSL/TLS implementation.
JdkSslServerContext	Deprecated. Use SslContextBuilder to create JdkSslContext instances and only use JdkSslContext in your code.
OpenSsl	Tells if netty-tcnative and its OpenSSL support are available.
OpenSslCachingX509KeyManagerFactory	Wraps another KeyManagerFactory and caches its chains / certs for an alias for better performance when using SslProvider.OPENSSL or SslProvider.OPENSSL_REFCNT.
OpenSslCertificateCompressionConfig	Configuration for TLS1.3 certificate compression extension.
OpenSslCertificateCompressionConfig.AlgorithmConfig	The configuration for algorithm.
OpenSslCertificateCompressionConfig.Builder	Builder for an OpenSslCertificateCompressionAlgorithm.
OpenSslClientContext	A client-side SslContext which uses OpenSSL's SSL/TLS implementation.
OpenSslContext	This class will use a finalizer to ensure native resources are automatically cleaned up.
OpenSslContextOption<T>	SslContextOptions that are specific to the SslProvider.OPENSSL / SslProvider.OPENSSL_REFCNT.
OpenSslDefaultApplicationProtocolNegotiator	Deprecated. use ApplicationProtocolConfig.
OpenSslEngine	Implements a SSLEngine using OpenSSL BIO abstractions.
OpenSslNpnApplicationProtocolNegotiator	Deprecated. use ApplicationProtocolConfig
OpenSslServerContext	A server-side SslContext which uses OpenSSL's SSL/TLS implementation.
OpenSslServerSessionContext	OpenSslSessionContext implementation which offers extra methods which are only useful for the server-side.
OpenSslSessionContext	OpenSSL specific SSLSessionContext implementation.
OpenSslSessionStats	Stats exposed by an OpenSSL session context.
OpenSslSessionTicketKey	Session Ticket Key
OpenSslX509KeyManagerFactory	Special KeyManagerFactory that pre-compute the keymaterial used when SslProvider.OPENSSL or SslProvider.OPENSSL_REFCNT is used and so will improve handshake times and its performance.
OptionalSslHandler	OptionalSslHandler is a utility decoder to support both SSL and non-SSL handlers based on the first message received.
PemPrivateKey	This is a special purpose implementation of a PrivateKey which allows the user to pass PEM/PKCS#8 encoded key material straight into OpenSslContext without having to parse and re-encode bytes in Java land.
PemX509Certificate	This is a special purpose implementation of a X509Certificate which allows the user to pass PEM/PKCS#8 encoded data straight into OpenSslContext without having to parse and re-encode bytes in Java land.
ReferenceCountedOpenSslClientContext	A client-side SslContext which uses OpenSSL's SSL/TLS implementation.
ReferenceCountedOpenSslContext	An implementation of SslContext which works with libraries that support the OpenSsl C library API.
ReferenceCountedOpenSslEngine	Implements a SSLEngine using OpenSSL BIO abstractions.
ReferenceCountedOpenSslServerContext	A server-side SslContext which uses OpenSSL's SSL/TLS implementation.
SniCompletionEvent	Event that is fired once we did a selection of a SslContext based on the SNI hostname, which may be because it was successful or there was an error.
SniHandler	Enables SNI (Server Name Indication) extension for server side SSL.
SslClientHelloHandler<T>	ByteToMessageDecoder which allows to be notified once a full ClientHello was received.
SslCloseCompletionEvent	Event that is fired once the close_notify was received or if an failure happens before it was received.
SslCompletionEvent
SslContext	A secure socket protocol implementation which acts as a factory for SSLEngine and SslHandler.
SslContextBuilder	Builder for configuring a new SslContext for creation.
SslContextOption<T>	A SslContextOption allows to configure a SslContext in a type-safe way.
SslHandler	Adds SSL · TLS and StartTLS support to a Channel.
SslHandshakeCompletionEvent	Event that is fired once the SSL handshake is complete, which may be because it was successful or there was an error.
SslMasterKeyHandler	The SslMasterKeyHandler is a channel-handler you can include in your pipeline to consume the master key & session identifier for a TLS session.
SslProtocols	SSL/TLS protocols
SupportedCipherSuiteFilter	This class will filter all requested ciphers out that are not supported by the current SSLEngine.

Enum Summary

Enum	Description
ApplicationProtocolConfig.Protocol	Defines which application level protocol negotiation to use.
ApplicationProtocolConfig.SelectedListenerFailureBehavior	Defines the most common behaviors for the peer which is notified of the selected protocol.
ApplicationProtocolConfig.SelectorFailureBehavior	Defines the most common behaviors for the peer that selects the application protocol.
ClientAuth	Indicates the state of the SSLEngine with respect to client authentication.
OpenSslCertificateCompressionConfig.AlgorithmMode	The usage mode of the OpenSslCertificateCompressionAlgorithm.
SslProvider	An enumeration of SSL/TLS protocol providers.

Exception Summary

Exception	Description
NotSslRecordException	Special SSLException which will get thrown if a packet is received that not looks like a TLS/SSL record.
OpenSslCertificateException	A special CertificateException which allows to specify which error code is included in the SSL Record.
SslClosedEngineException	SSLException which signals that the exception was caused by an SSLEngine which was closed already.
SslHandshakeTimeoutException	SSLHandshakeException that is used when a handshake failed due a configured timeout.