A server-side SslContext which uses OpenSSL's SSL/TLS implementation.

Instances of this class must be released or else native memory will leak!

Instances of this class must not be released before any ReferenceCountedOpenSslEngine which depends upon the instance of this class is released. Otherwise if any method of ReferenceCountedOpenSslEngine is called which uses this class's JNI resources the JVM may crash.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ReferenceCountedOpenSslServerContext.ExtendedTrustManagerVerifyCallback
private static class	ReferenceCountedOpenSslServerContext.OpenSslServerCertificateCallback
private static class	ReferenceCountedOpenSslServerContext.OpenSslSniHostnameMatcher
private static class	ReferenceCountedOpenSslServerContext.TrustManagerVerifyCallback

Field Summary

Modifier and Type	Field and Description
private static final byte[]	ID
private static final InternalLogger	logger Hides io.netty.handler.ssl.ReferenceCountedOpenSslContext.logger.
private final OpenSslServerSessionContext	sessionContext

Inherited from io.netty.handler.ssl.ReferenceCountedOpenSslContext:: CLIENT_ENABLE_SESSION_CACHE CLIENT_ENABLE_SESSION_TICKET CLIENT_ENABLE_SESSION_TICKET_TLSV13 clientAuth ctx ctxLock enableOcsp engineMap keyCertChain NONE_PROTOCOL_NEGOTIATOR protocols SERVER_ENABLE_SESSION_CACHE SERVER_ENABLE_SESSION_TICKET SERVER_ENABLE_SESSION_TICKET_TLSV13 tlsFalseStart USE_TASKS VERIFY_DEPTH

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
pack-priv	ReferenceCountedOpenSslServerContext(X509Certificate[] trustCertCollection, TrustManagerFactory trustManagerFactory, X509Certificate[] keyCertChain, PrivateKey key, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout, ClientAuth clientAuth, String[] protocols, boolean startTls, boolean enableOcsp, String keyStore, Map.Entry<SslContextOption<?>, Object>... options)
pack-priv	ReferenceCountedOpenSslServerContext(X509Certificate[] trustCertCollection, TrustManagerFactory trustManagerFactory, X509Certificate[] keyCertChain, PrivateKey key, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, OpenSslApplicationProtocolNegotiator apn, long sessionCacheSize, long sessionTimeout, ClientAuth clientAuth, String[] protocols, boolean startTls, boolean enableOcsp, String keyStore, Map.Entry<SslContextOption<?>, Object>... options) Deprecated as a consequence of `OpenSslApplicationProtocolNegotiator` being deprecated.

pack-priv

ReferenceCountedOpenSslServerContext(X509Certificate[] trustCertCollection, TrustManagerFactory trustManagerFactory, X509Certificate[] keyCertChain, PrivateKey key, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout, ClientAuth clientAuth, String[] protocols, boolean startTls, boolean enableOcsp, String keyStore, Map.Entry<SslContextOption<?>, Object>... options)

pack-priv

ReferenceCountedOpenSslServerContext(X509Certificate[] trustCertCollection, TrustManagerFactory trustManagerFactory, X509Certificate[] keyCertChain, PrivateKey key, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, OpenSslApplicationProtocolNegotiator apn, long sessionCacheSize, long sessionTimeout, ClientAuth clientAuth, String[] protocols, boolean startTls, boolean enableOcsp, String keyStore, Map.Entry<SslContextOption<?>, Object>... options)

Deprecated as a consequence of OpenSslApplicationProtocolNegotiator being deprecated.

Method Summary

Modifier and Type	Method and Description
pack-priv static OpenSslServerSessionContext	newSessionContext(ReferenceCountedOpenSslContext thiz, long ctx, OpenSslEngineMap engineMap, X509Certificate[] trustCertCollection, TrustManagerFactory trustManagerFactory, X509Certificate[] keyCertChain, PrivateKey key, String keyPassword, KeyManagerFactory keyManagerFactory, String keyStore, long sessionCacheSize, long sessionTimeout)
public OpenSslServerSessionContext	sessionContext() Implements abstract io.netty.handler.ssl.ReferenceCountedOpenSslContext.sessionContext. Returns the `SSLSessionContext` object held by this context.
private static void	setVerifyCallback(long ctx, OpenSslEngineMap engineMap, X509TrustManager manager)

Field Detail

ID	back to summary
private static final byte[] ID

logger	back to summary
private static final InternalLogger logger Hides io.netty.handler.ssl.ReferenceCountedOpenSslContext.logger.

sessionContext	back to summary
private final OpenSslServerSessionContext sessionContext

Constructor Detail

ReferenceCountedOpenSslServerContext	back to summary
pack-priv ReferenceCountedOpenSslServerContext(X509Certificate[] trustCertCollection, TrustManagerFactory trustManagerFactory, X509Certificate[] keyCertChain, PrivateKey key, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout, ClientAuth clientAuth, String[] protocols, boolean startTls, boolean enableOcsp, String keyStore, Map.Entry<SslContextOption<?>, Object>... options) throws SSLException

ReferenceCountedOpenSslServerContext

back to summary

pack-priv ReferenceCountedOpenSslServerContext(X509Certificate[] trustCertCollection, TrustManagerFactory trustManagerFactory, X509Certificate[] keyCertChain, PrivateKey key, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, ApplicationProtocolConfig apn, long sessionCacheSize, long sessionTimeout, ClientAuth clientAuth, String[] protocols, boolean startTls, boolean enableOcsp, String keyStore, Map.Entry<SslContextOption<?>, Object>... options) throws SSLException

ReferenceCountedOpenSslServerContext back to summary

ReferenceCountedOpenSslServerContext	back to summary
pack-priv ReferenceCountedOpenSslServerContext(X509Certificate[] trustCertCollection, TrustManagerFactory trustManagerFactory, X509Certificate[] keyCertChain, PrivateKey key, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, OpenSslApplicationProtocolNegotiator apn, long sessionCacheSize, long sessionTimeout, ClientAuth clientAuth, String[] protocols, boolean startTls, boolean enableOcsp, String keyStore, Map.Entry<SslContextOption<?>, Object>... options) throws SSLException Deprecated as a consequence of `OpenSslApplicationProtocolNegotiator` being deprecated. See corresponding docs for further information.

pack-priv ReferenceCountedOpenSslServerContext(X509Certificate[] trustCertCollection, TrustManagerFactory trustManagerFactory, X509Certificate[] keyCertChain, PrivateKey key, String keyPassword, KeyManagerFactory keyManagerFactory, Iterable<String> ciphers, CipherSuiteFilter cipherFilter, OpenSslApplicationProtocolNegotiator apn, long sessionCacheSize, long sessionTimeout, ClientAuth clientAuth, String[] protocols, boolean startTls, boolean enableOcsp, String keyStore, Map.Entry<SslContextOption<?>, Object>... options) throws SSLException

Deprecated

as a consequence of OpenSslApplicationProtocolNegotiator being deprecated. See corresponding docs for further information.

Method Detail

newSessionContext	back to summary
pack-priv static OpenSslServerSessionContext newSessionContext(ReferenceCountedOpenSslContext thiz, long ctx, OpenSslEngineMap engineMap, X509Certificate[] trustCertCollection, TrustManagerFactory trustManagerFactory, X509Certificate[] keyCertChain, PrivateKey key, String keyPassword, KeyManagerFactory keyManagerFactory, String keyStore, long sessionCacheSize, long sessionTimeout) throws SSLException

newSessionContext

back to summary

pack-priv static OpenSslServerSessionContext newSessionContext(ReferenceCountedOpenSslContext thiz, long ctx, OpenSslEngineMap engineMap, X509Certificate[] trustCertCollection, TrustManagerFactory trustManagerFactory, X509Certificate[] keyCertChain, PrivateKey key, String keyPassword, KeyManagerFactory keyManagerFactory, String keyStore, long sessionCacheSize, long sessionTimeout) throws SSLException

sessionContext back to summary

sessionContext	back to summary
public OpenSslServerSessionContext sessionContext() Implements abstract io.netty.handler.ssl.ReferenceCountedOpenSslContext.sessionContext. Doc from io.netty.handler.ssl.SslContext.sessionContext. Returns the `SSLSessionContext` object held by this context. Annotations @Override

public OpenSslServerSessionContext sessionContext()

Implements abstract io.netty.handler.ssl.ReferenceCountedOpenSslContext.sessionContext.

Doc from io.netty.handler.ssl.SslContext.sessionContext.

Returns the SSLSessionContext object held by this context.

Annotations

@Override

setVerifyCallback	back to summary
private static void setVerifyCallback(long ctx, OpenSslEngineMap engineMap, X509TrustManager manager) Annotations @SuppressJava6Requirement reason:Guarded by java version check

io.netty.handler.ssl back to summary

private final Class ReferenceCountedOpenSslServerContext.ExtendedTrustManagerVerifyCallback

Class Inheritance

extends AbstractCertificateVerifier

java.lang.Object
io.netty.internal.tcnative.CertificateVerifier
io.netty.handler.ssl.ReferenceCountedOpenSslContext.AbstractCertificateVerifier
io.netty.handler.ssl.ReferenceCountedOpenSslServerContext.ExtendedTrustManagerVerifyCallback

Annotations

@SuppressJava6Requirement
reason:Usage guarded by java version check

Field Summary

Modifier and Type	Field and Description
private final X509ExtendedTrustManager	manager

Constructor Summary

Access	Constructor and Description
pack-priv	ExtendedTrustManagerVerifyCallback(OpenSslEngineMap engineMap, X509ExtendedTrustManager manager)

Method Summary

Modifier and Type	Method and Description
pack-priv void	verify(ReferenceCountedOpenSslEngine engine, X509Certificate[] peerCerts, String auth) Implements abstract io.netty.handler.ssl.ReferenceCountedOpenSslContext.AbstractCertificateVerifier.verify.

Inherited from io.netty.handler.ssl.ReferenceCountedOpenSslContext.AbstractCertificateVerifier:: verify

Field Detail

manager	back to summary
private final X509ExtendedTrustManager manager

Constructor Detail

ExtendedTrustManagerVerifyCallback	back to summary
pack-priv ExtendedTrustManagerVerifyCallback(OpenSslEngineMap engineMap, X509ExtendedTrustManager manager)

Method Detail

verify	back to summary
pack-priv void verify(ReferenceCountedOpenSslEngine engine, X509Certificate[] peerCerts, String auth) throws Exception Implements abstract io.netty.handler.ssl.ReferenceCountedOpenSslContext.AbstractCertificateVerifier.verify. Annotations @Override

verify

back to summary

pack-priv void verify(ReferenceCountedOpenSslEngine engine, X509Certificate[] peerCerts, String auth) throws Exception

Implements abstract io.netty.handler.ssl.ReferenceCountedOpenSslContext.AbstractCertificateVerifier.verify.

Annotations

@Override

io.netty.handler.ssl back to summary

private final Class ReferenceCountedOpenSslServerContext.OpenSslServerCertificateCallback

Class Inheritance

extends Object
implements CertificateCallback

java.lang.Object
io.netty.handler.ssl.ReferenceCountedOpenSslServerContext.OpenSslServerCertificateCallback

All Implemented Interfaces

io.netty.internal.tcnative.CertificateCallback

Field Summary

Modifier and Type	Field and Description
private final OpenSslEngineMap	engineMap
private final OpenSslKeyMaterialManager	keyManagerHolder

Constructor Summary

Access	Constructor and Description
pack-priv	OpenSslServerCertificateCallback(OpenSslEngineMap engineMap, OpenSslKeyMaterialManager keyManagerHolder)

Method Summary

Modifier and Type	Method and Description
public void	handle(long the SSL instance ssl, byte[] an array of the key types on client-mode or `null` on server-mode. keyTypeBytes, byte[][] the principals or `null`. asn1DerEncodedPrincipals) Implements io.netty.internal.tcnative.CertificateCallback.handle. Called during cert selection.

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

Field Detail

engineMap	back to summary
private final OpenSslEngineMap engineMap

keyManagerHolder	back to summary
private final OpenSslKeyMaterialManager keyManagerHolder

Constructor Detail

OpenSslServerCertificateCallback	back to summary
pack-priv OpenSslServerCertificateCallback(OpenSslEngineMap engineMap, OpenSslKeyMaterialManager keyManagerHolder)

Method Detail

handle back to summary

handle	back to summary
public void handle(long ssl, byte[] keyTypeBytes, byte[][] asn1DerEncodedPrincipals) throws Exception Implements io.netty.internal.tcnative.CertificateCallback.handle. Doc from io.netty.internal.tcnative.CertificateCallback.handle. Called during cert selection. If a certificate chain / key should be used `SSL#setKeyMaterial(long, long, long)` must be called from this callback after all preparations / validations were completed. Parameters ssl:long the SSL instance keyTypeBytes:byte[] an array of the key types on client-mode or `null` on server-mode. asn1DerEncodedPrincipals:byte[][] the principals or `null`. Annotations @Override

public void handle(long ssl, byte[] keyTypeBytes, byte[][] asn1DerEncodedPrincipals) throws Exception

Implements io.netty.internal.tcnative.CertificateCallback.handle.

Doc from io.netty.internal.tcnative.CertificateCallback.handle.

Called during cert selection. If a certificate chain / key should be used SSL#setKeyMaterial(long, long, long) must be called from this callback after all preparations / validations were completed.

Parameters

ssl:long: the SSL instance
keyTypeBytes:byte[]: an array of the key types on client-mode or null on server-mode.
asn1DerEncodedPrincipals:byte[][]: the principals or null.

Annotations

@Override

io.netty.handler.ssl back to summary

private final Class ReferenceCountedOpenSslServerContext.OpenSslSniHostnameMatcher

Class Inheritance

extends Object
implements SniHostNameMatcher

java.lang.Object
io.netty.handler.ssl.ReferenceCountedOpenSslServerContext.OpenSslSniHostnameMatcher

All Implemented Interfaces

io.netty.internal.tcnative.SniHostNameMatcher

Field Summary

Modifier and Type	Field and Description
private final OpenSslEngineMap	engineMap

Constructor Summary

Access	Constructor and Description
pack-priv	OpenSslSniHostnameMatcher(OpenSslEngineMap engineMap)

Method Summary

Modifier and Type	Method and Description
public boolean	match(long the SSL instance ssl, String the hostname to match. hostname) Implements io.netty.internal.tcnative.SniHostNameMatcher.match. Returns `true` if the hostname was matched and so SNI should be allowed.

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

Field Detail

engineMap	back to summary
private final OpenSslEngineMap engineMap

Constructor Detail

OpenSslSniHostnameMatcher	back to summary
pack-priv OpenSslSniHostnameMatcher(OpenSslEngineMap engineMap)

Method Detail

match back to summary

match	back to summary
public boolean match(long ssl, String hostname) Implements io.netty.internal.tcnative.SniHostNameMatcher.match. Doc from io.netty.internal.tcnative.SniHostNameMatcher.match. Returns `true` if the hostname was matched and so SNI should be allowed. Parameters ssl:long the SSL instance hostname:String the hostname to match. Returns:boolean `true` if the hostname was matched Annotations @Override

public boolean match(long ssl, String hostname)

Implements io.netty.internal.tcnative.SniHostNameMatcher.match.

Doc from io.netty.internal.tcnative.SniHostNameMatcher.match.

Returns true if the hostname was matched and so SNI should be allowed.

Parameters

ssl:long: the SSL instance
hostname:String: the hostname to match.

Returns:boolean

true if the hostname was matched

Annotations

@Override

io.netty.handler.ssl back to summary

private final Class ReferenceCountedOpenSslServerContext.TrustManagerVerifyCallback

Class Inheritance

extends AbstractCertificateVerifier

java.lang.Object
io.netty.internal.tcnative.CertificateVerifier
io.netty.handler.ssl.ReferenceCountedOpenSslContext.AbstractCertificateVerifier
io.netty.handler.ssl.ReferenceCountedOpenSslServerContext.TrustManagerVerifyCallback

Field Summary

Modifier and Type	Field and Description
private final X509TrustManager	manager

Constructor Summary

Access	Constructor and Description
pack-priv	TrustManagerVerifyCallback(OpenSslEngineMap engineMap, X509TrustManager manager)

Method Summary

Modifier and Type	Method and Description
pack-priv void	verify(ReferenceCountedOpenSslEngine engine, X509Certificate[] peerCerts, String auth) Implements abstract io.netty.handler.ssl.ReferenceCountedOpenSslContext.AbstractCertificateVerifier.verify.

Inherited from io.netty.handler.ssl.ReferenceCountedOpenSslContext.AbstractCertificateVerifier:: verify

Field Detail

manager	back to summary
private final X509TrustManager manager

Constructor Detail

TrustManagerVerifyCallback	back to summary
pack-priv TrustManagerVerifyCallback(OpenSslEngineMap engineMap, X509TrustManager manager)

Method Detail

verify	back to summary
pack-priv void verify(ReferenceCountedOpenSslEngine engine, X509Certificate[] peerCerts, String auth) throws Exception Implements abstract io.netty.handler.ssl.ReferenceCountedOpenSslContext.AbstractCertificateVerifier.verify. Annotations @Override

verify

back to summary

pack-priv void verify(ReferenceCountedOpenSslEngine engine, X509Certificate[] peerCerts, String auth) throws Exception

Implements abstract io.netty.handler.ssl.ReferenceCountedOpenSslContext.AbstractCertificateVerifier.verify.

Annotations

@Override

public final Class ReferenceCountedOpenSslServerContext

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ReferenceCountedOpenSslServerContext.ExtendedTrustManagerVerifyCallback

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ReferenceCountedOpenSslServerContext.OpenSslServerCertificateCallback

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ReferenceCountedOpenSslServerContext.OpenSslSniHostnameMatcher

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ReferenceCountedOpenSslServerContext.TrustManagerVerifyCallback

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail