Package io.netty.handler.ssl
Class ReferenceCountedOpenSslContext
- java.lang.Object
-
- io.netty.handler.ssl.SslContext
-
- io.netty.handler.ssl.ReferenceCountedOpenSslContext
-
- All Implemented Interfaces:
ReferenceCounted
- Direct Known Subclasses:
OpenSslContext,ReferenceCountedOpenSslClientContext,ReferenceCountedOpenSslServerContext
public abstract class ReferenceCountedOpenSslContext extends SslContext implements ReferenceCounted
An implementation ofSslContextwhich works with libraries that support the OpenSsl C library API.Instances of this class must be
releasedor else native memory will leak!Instances of this class must not be released before any
ReferenceCountedOpenSslEnginewhich depends upon the instance of this class is released. Otherwise if any method ofReferenceCountedOpenSslEngineis called which uses this class's JNI resources the JVM may crash.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static classReferenceCountedOpenSslContext.AbstractCertificateVerifierprivate static classReferenceCountedOpenSslContext.AsyncPrivateKeyMethodprivate static classReferenceCountedOpenSslContext.CompressionAlgorithmprivate static classReferenceCountedOpenSslContext.DefaultOpenSslEngineMapprivate static classReferenceCountedOpenSslContext.PrivateKeyMethod
-
Field Summary
Fields Modifier and Type Field Description private OpenSslApplicationProtocolNegotiatorapnprivate intbioNonApplicationBufferSize(package private) static booleanCLIENT_ENABLE_SESSION_CACHE(package private) static booleanCLIENT_ENABLE_SESSION_TICKET(package private) static booleanCLIENT_ENABLE_SESSION_TICKET_TLSV13(package private) ClientAuthclientAuthprotected longctxThe OpenSSL SSL_CTX object.(package private) java.util.concurrent.locks.ReadWriteLockctxLockprivate static intDEFAULT_BIO_NON_APPLICATION_BUFFER_SIZEprivate static java.lang.IntegerDH_KEY_LENGTH(package private) booleanenableOcsp(package private) java.lang.StringendpointIdentificationAlgorithm(package private) OpenSslEngineMapengineMap(package private) booleanhasTLSv13Cipher(package private) booleanhasTmpDhKeys(package private) java.security.cert.Certificate[]keyCertChainprivate ResourceLeakTracker<ReferenceCountedOpenSslContext>leakprivate static ResourceLeakDetector<ReferenceCountedOpenSslContext>leakDetectorprivate static InternalLoggerloggerprivate intmode(package private) static OpenSslApplicationProtocolNegotiatorNONE_PROTOCOL_NEGOTIATOR(package private) java.lang.String[]protocolsprivate AbstractReferenceCountedrefCnt(package private) static booleanSERVER_ENABLE_SESSION_CACHE(package private) static booleanSERVER_ENABLE_SESSION_TICKET(package private) static booleanSERVER_ENABLE_SESSION_TICKET_TLSV13(package private) booleantlsFalseStartprivate java.util.List<java.lang.String>unmodifiableCiphers(package private) static booleanUSE_TASKSprotected static intVERIFY_DEPTH-
Fields inherited from class io.netty.handler.ssl.SslContext
ALIAS, resumptionController, X509_CERT_FACTORY
-
-
Constructor Summary
Constructors Constructor Description ReferenceCountedOpenSslContext(java.lang.Iterable<java.lang.String> ciphers, CipherSuiteFilter cipherFilter, OpenSslApplicationProtocolNegotiator apn, int mode, java.security.cert.Certificate[] keyCertChain, ClientAuth clientAuth, java.lang.String[] protocols, boolean startTls, java.lang.String endpointIdentificationAlgorithm, boolean enableOcsp, boolean leakDetection, ResumptionController resumptionController, java.util.Map.Entry<SslContextOption<?>,java.lang.Object>... ctxOptions)
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ApplicationProtocolNegotiatorapplicationProtocolNegotiator()Returns the object responsible for negotiating application layer protocols for the TLS NPN/ALPN extensions.protected static java.security.cert.X509Certificate[]certificates(byte[][] chain)protected static javax.net.ssl.X509TrustManagerchooseTrustManager(javax.net.ssl.TrustManager[] managers)Deprecated.This method is kept for API backwards compatibility.(package private) static javax.net.ssl.X509TrustManagerchooseTrustManager(javax.net.ssl.TrustManager[] managers, ResumptionController resumptionController)protected static javax.net.ssl.X509KeyManagerchooseX509KeyManager(javax.net.ssl.KeyManager[] kms)java.util.List<java.lang.String>cipherSuites()Returns the list of enabled cipher suites, in the order of preference.longcontext()Deprecated.this method is considered unsafe as the returned pointer may be released later.private voiddestroy()(package private) static voidfreeBio(long bio)intgetBioNonApplicationBufferSize()Returns the size of the buffer used by the BIO for non-application based writesbooleangetRejectRemoteInitiatedRenegotiation()Deprecated.booleanisClient()Returns thetrueif and only if this context is for client-side.private static longnewBIO(ByteBuf buffer)javax.net.ssl.SSLEnginenewEngine(ByteBufAllocator alloc)Returns a new server-sideSSLEnginewith the current configuration.javax.net.ssl.SSLEnginenewEngine(ByteBufAllocator alloc, java.lang.String peerHost, int peerPort)Creates a newSSLEngineusing advisory peer information.(package private) javax.net.ssl.SSLEnginenewEngine0(ByteBufAllocator alloc, java.lang.String peerHost, int peerPort, boolean jdkCompatibilityMode)protected SslHandlernewHandler(ByteBufAllocator alloc, boolean startTls)Create a new SslHandler.protected SslHandlernewHandler(ByteBufAllocator alloc, boolean startTls, java.util.concurrent.Executor executor)Create a new SslHandler.protected SslHandlernewHandler(ByteBufAllocator alloc, java.lang.String peerHost, int peerPort, boolean startTls)Create a new SslHandler.protected SslHandlernewHandler(ByteBufAllocator alloc, java.lang.String peerHost, int peerPort, boolean startTls, java.util.concurrent.Executor executor)private static intopensslSelectorFailureBehavior(ApplicationProtocolConfig.SelectorFailureBehavior behavior)(package private) static OpenSslKeyMaterialProviderproviderFor(javax.net.ssl.KeyManagerFactory factory, java.lang.String password)Returns theOpenSslKeyMaterialProviderthat should be used for OpenSSL.intrefCnt()Returns the reference count of this object.booleanrelease()Decreases the reference count by1and deallocates this object if the reference count reaches at0.booleanrelease(int decrement)Decreases the reference count by the specifieddecrementand deallocates this object if the reference count reaches at0.ReferenceCountedretain()Increases the reference count by1.ReferenceCountedretain(int increment)Increases the reference count by the specifiedincrement.private static ReferenceCountedOpenSslEngineretrieveEngine(OpenSslEngineMap engineMap, long ssl)abstract OpenSslSessionContextsessionContext()Returns theSSLSessionContextobject held by this context.voidsetBioNonApplicationBufferSize(int bioNonApplicationBufferSize)Set the size of the buffer used by the BIO for non-application based writes (e.g.(package private) static voidsetKeyMaterial(long ctx, java.security.cert.X509Certificate[] keyCertChain, java.security.PrivateKey key, java.lang.String keyPassword)voidsetPrivateKeyMethod(OpenSslPrivateKeyMethod method)Deprecated.voidsetRejectRemoteInitiatedRenegotiation(boolean rejectRemoteInitiatedRenegotiation)Deprecated.voidsetTicketKeys(byte[] keys)Deprecated.voidsetUseTasks(boolean useTasks)Deprecated.longsslCtxPointer()Deprecated.this method is considered unsafe as the returned pointer may be released later.OpenSslSessionStatsstats()Deprecated.use {@link #sessionContext#stats()}(package private) static longtoBIO(ByteBufAllocator allocator, PemEncoded pem)(package private) static longtoBIO(ByteBufAllocator allocator, java.security.cert.X509Certificate... certChain)(package private) static longtoBIO(ByteBufAllocator allocator, java.security.PrivateKey key)(package private) static OpenSslApplicationProtocolNegotiatortoNegotiator(ApplicationProtocolConfig config)Translate aApplicationProtocolConfigobject to aOpenSslApplicationProtocolNegotiatorobject.ReferenceCountedtouch()Records the current access location of this object for debugging purposes.ReferenceCountedtouch(java.lang.Object hint)Records the current access location of this object with an additional arbitrary information for debugging purposes.(package private) static booleanuseExtendedTrustManager(javax.net.ssl.X509TrustManager trustManager)private static byte[]verifyResult(byte[] result)-
Methods inherited from class io.netty.handler.ssl.SslContext
attributes, buildKeyManagerFactory, buildKeyManagerFactory, buildKeyStore, buildTrustManagerFactory, buildTrustManagerFactory, buildTrustManagerFactory, defaultClientProvider, defaultServerProvider, generateKeySpec, isServer, keyStorePassword, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContext, newClientContextInternal, newHandler, newHandler, newHandler, newHandler, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContext, newServerContextInternal, nextProtocols, sessionCacheSize, sessionTimeout, toApplicationProtocolConfig, toPrivateKey, toPrivateKey, toPrivateKey, toPrivateKeyInternal, toX509Certificates, toX509Certificates, toX509CertificatesInternal
-
-
-
-
Field Detail
-
logger
private static final InternalLogger logger
-
DEFAULT_BIO_NON_APPLICATION_BUFFER_SIZE
private static final int DEFAULT_BIO_NON_APPLICATION_BUFFER_SIZE
-
USE_TASKS
static final boolean USE_TASKS
-
DH_KEY_LENGTH
private static final java.lang.Integer DH_KEY_LENGTH
-
leakDetector
private static final ResourceLeakDetector<ReferenceCountedOpenSslContext> leakDetector
-
VERIFY_DEPTH
protected static final int VERIFY_DEPTH
- See Also:
- Constant Field Values
-
CLIENT_ENABLE_SESSION_TICKET
static final boolean CLIENT_ENABLE_SESSION_TICKET
-
CLIENT_ENABLE_SESSION_TICKET_TLSV13
static final boolean CLIENT_ENABLE_SESSION_TICKET_TLSV13
-
SERVER_ENABLE_SESSION_TICKET
static final boolean SERVER_ENABLE_SESSION_TICKET
-
SERVER_ENABLE_SESSION_TICKET_TLSV13
static final boolean SERVER_ENABLE_SESSION_TICKET_TLSV13
-
SERVER_ENABLE_SESSION_CACHE
static final boolean SERVER_ENABLE_SESSION_CACHE
-
CLIENT_ENABLE_SESSION_CACHE
static final boolean CLIENT_ENABLE_SESSION_CACHE
-
ctx
protected long ctx
The OpenSSL SSL_CTX object.ctxLockmust be hold while using ctx!
-
unmodifiableCiphers
private final java.util.List<java.lang.String> unmodifiableCiphers
-
apn
private final OpenSslApplicationProtocolNegotiator apn
-
mode
private final int mode
-
leak
private final ResourceLeakTracker<ReferenceCountedOpenSslContext> leak
-
refCnt
private final AbstractReferenceCounted refCnt
-
keyCertChain
final java.security.cert.Certificate[] keyCertChain
-
clientAuth
final ClientAuth clientAuth
-
protocols
final java.lang.String[] protocols
-
endpointIdentificationAlgorithm
final java.lang.String endpointIdentificationAlgorithm
-
hasTLSv13Cipher
final boolean hasTLSv13Cipher
-
hasTmpDhKeys
final boolean hasTmpDhKeys
-
enableOcsp
final boolean enableOcsp
-
engineMap
final OpenSslEngineMap engineMap
-
ctxLock
final java.util.concurrent.locks.ReadWriteLock ctxLock
-
bioNonApplicationBufferSize
private volatile int bioNonApplicationBufferSize
-
NONE_PROTOCOL_NEGOTIATOR
static final OpenSslApplicationProtocolNegotiator NONE_PROTOCOL_NEGOTIATOR
-
tlsFalseStart
final boolean tlsFalseStart
-
-
Constructor Detail
-
ReferenceCountedOpenSslContext
ReferenceCountedOpenSslContext(java.lang.Iterable<java.lang.String> ciphers, CipherSuiteFilter cipherFilter, OpenSslApplicationProtocolNegotiator apn, int mode, java.security.cert.Certificate[] keyCertChain, ClientAuth clientAuth, java.lang.String[] protocols, boolean startTls, java.lang.String endpointIdentificationAlgorithm, boolean enableOcsp, boolean leakDetection, ResumptionController resumptionController, java.util.Map.Entry<SslContextOption<?>,java.lang.Object>... ctxOptions) throws javax.net.ssl.SSLException- Throws:
javax.net.ssl.SSLException
-
-
Method Detail
-
opensslSelectorFailureBehavior
private static int opensslSelectorFailureBehavior(ApplicationProtocolConfig.SelectorFailureBehavior behavior)
-
cipherSuites
public final java.util.List<java.lang.String> cipherSuites()
Description copied from class:SslContextReturns the list of enabled cipher suites, in the order of preference.- Specified by:
cipherSuitesin classSslContext
-
applicationProtocolNegotiator
public ApplicationProtocolNegotiator applicationProtocolNegotiator()
Description copied from class:SslContextReturns the object responsible for negotiating application layer protocols for the TLS NPN/ALPN extensions.- Specified by:
applicationProtocolNegotiatorin classSslContext
-
isClient
public final boolean isClient()
Description copied from class:SslContextReturns thetrueif and only if this context is for client-side.- Specified by:
isClientin classSslContext
-
newEngine
public final javax.net.ssl.SSLEngine newEngine(ByteBufAllocator alloc, java.lang.String peerHost, int peerPort)
Description copied from class:SslContextCreates a newSSLEngineusing advisory peer information.If
SslProvider.OPENSSL_REFCNTis used then the object must be released. One way to do this is to wrap in aSslHandlerand insert it into a pipeline. SeeSslContext.newHandler(ByteBufAllocator, String, int).- Specified by:
newEnginein classSslContextpeerHost- the non-authoritative name of the hostpeerPort- the non-authoritative port- Returns:
- a new
SSLEngine
-
newHandler
protected final SslHandler newHandler(ByteBufAllocator alloc, boolean startTls)
Description copied from class:SslContextCreate a new SslHandler.- Overrides:
newHandlerin classSslContext- See Also:
SslContext.newHandler(ByteBufAllocator)
-
newHandler
protected final SslHandler newHandler(ByteBufAllocator alloc, java.lang.String peerHost, int peerPort, boolean startTls)
Description copied from class:SslContextCreate a new SslHandler.- Overrides:
newHandlerin classSslContext- See Also:
SslContext.newHandler(ByteBufAllocator, String, int, boolean, Executor)
-
newHandler
protected SslHandler newHandler(ByteBufAllocator alloc, boolean startTls, java.util.concurrent.Executor executor)
Description copied from class:SslContextCreate a new SslHandler.- Overrides:
newHandlerin classSslContext- See Also:
SslContext.newHandler(ByteBufAllocator, String, int, boolean, Executor)
-
newHandler
protected SslHandler newHandler(ByteBufAllocator alloc, java.lang.String peerHost, int peerPort, boolean startTls, java.util.concurrent.Executor executor)
- Overrides:
newHandlerin classSslContext
-
newEngine0
javax.net.ssl.SSLEngine newEngine0(ByteBufAllocator alloc, java.lang.String peerHost, int peerPort, boolean jdkCompatibilityMode)
-
newEngine
public final javax.net.ssl.SSLEngine newEngine(ByteBufAllocator alloc)
Returns a new server-sideSSLEnginewith the current configuration.- Specified by:
newEnginein classSslContext- Returns:
- a new
SSLEngine
-
context
@Deprecated public final long context()
Deprecated.this method is considered unsafe as the returned pointer may be released later. Dont use it!Returns the pointer to theSSL_CTXobject for thisReferenceCountedOpenSslContext. Be aware that it is freed as soon as theObject.finalize()method is called. At this point0will be returned.
-
stats
@Deprecated public final OpenSslSessionStats stats()
Deprecated.use {@link #sessionContext#stats()}Returns the stats of this context.
-
setRejectRemoteInitiatedRenegotiation
@Deprecated public void setRejectRemoteInitiatedRenegotiation(boolean rejectRemoteInitiatedRenegotiation)
Deprecated.{@deprecated Renegotiation is not supported} Specify if remote initiated renegotiation is supported or not. If not supported and the remote side tries to initiate a renegotiation aSSLHandshakeExceptionwill be thrown during decoding.
-
getRejectRemoteInitiatedRenegotiation
@Deprecated public boolean getRejectRemoteInitiatedRenegotiation()
Deprecated.{@deprecated Renegotiation is not supported}- Returns:
truebecause renegotiation is not supported.
-
setBioNonApplicationBufferSize
public void setBioNonApplicationBufferSize(int bioNonApplicationBufferSize)
Set the size of the buffer used by the BIO for non-application based writes (e.g. handshake, renegotiation, etc...).
-
getBioNonApplicationBufferSize
public int getBioNonApplicationBufferSize()
Returns the size of the buffer used by the BIO for non-application based writes
-
setTicketKeys
@Deprecated public final void setTicketKeys(byte[] keys)
Deprecated.Sets the SSL session ticket keys of this context.
-
sessionContext
public abstract OpenSslSessionContext sessionContext()
Description copied from class:SslContextReturns theSSLSessionContextobject held by this context.- Specified by:
sessionContextin classSslContext
-
sslCtxPointer
@Deprecated public final long sslCtxPointer()
Deprecated.this method is considered unsafe as the returned pointer may be released later. Dont use it!Returns the pointer to theSSL_CTXobject for thisReferenceCountedOpenSslContext. Be aware that it is freed as soon as therelease()method is called. At this point0will be returned.
-
setPrivateKeyMethod
@Deprecated @UnstableApi public final void setPrivateKeyMethod(OpenSslPrivateKeyMethod method)
Deprecated.Set theOpenSslPrivateKeyMethodto use. This allows to offload private-key operations if needed. This method is currently only supported whenBoringSSLis used.- Parameters:
method- method to use.
-
setUseTasks
@Deprecated public final void setUseTasks(boolean useTasks)
Deprecated.
-
destroy
private void destroy()
-
certificates
protected static java.security.cert.X509Certificate[] certificates(byte[][] chain)
-
chooseTrustManager
@Deprecated protected static javax.net.ssl.X509TrustManager chooseTrustManager(javax.net.ssl.TrustManager[] managers)
Deprecated.This method is kept for API backwards compatibility.
-
chooseTrustManager
static javax.net.ssl.X509TrustManager chooseTrustManager(javax.net.ssl.TrustManager[] managers, ResumptionController resumptionController)
-
chooseX509KeyManager
protected static javax.net.ssl.X509KeyManager chooseX509KeyManager(javax.net.ssl.KeyManager[] kms)
-
toNegotiator
static OpenSslApplicationProtocolNegotiator toNegotiator(ApplicationProtocolConfig config)
Translate aApplicationProtocolConfigobject to aOpenSslApplicationProtocolNegotiatorobject.- Parameters:
config- The configuration which defines the translation- Returns:
- The results of the translation
-
useExtendedTrustManager
static boolean useExtendedTrustManager(javax.net.ssl.X509TrustManager trustManager)
-
refCnt
public final int refCnt()
Description copied from interface:ReferenceCountedReturns the reference count of this object. If0, it means this object has been deallocated.- Specified by:
refCntin interfaceReferenceCounted
-
retain
public final ReferenceCounted retain()
Description copied from interface:ReferenceCountedIncreases the reference count by1.- Specified by:
retainin interfaceReferenceCounted
-
retain
public final ReferenceCounted retain(int increment)
Description copied from interface:ReferenceCountedIncreases the reference count by the specifiedincrement.- Specified by:
retainin interfaceReferenceCounted
-
touch
public final ReferenceCounted touch()
Description copied from interface:ReferenceCountedRecords the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you viaResourceLeakDetector. This method is a shortcut totouch(null).- Specified by:
touchin interfaceReferenceCounted
-
touch
public final ReferenceCounted touch(java.lang.Object hint)
Description copied from interface:ReferenceCountedRecords the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you viaResourceLeakDetector.- Specified by:
touchin interfaceReferenceCounted
-
release
public final boolean release()
Description copied from interface:ReferenceCountedDecreases the reference count by1and deallocates this object if the reference count reaches at0.- Specified by:
releasein interfaceReferenceCounted- Returns:
trueif and only if the reference count became0and this object has been deallocated
-
release
public final boolean release(int decrement)
Description copied from interface:ReferenceCountedDecreases the reference count by the specifieddecrementand deallocates this object if the reference count reaches at0.- Specified by:
releasein interfaceReferenceCounted- Returns:
trueif and only if the reference count became0and this object has been deallocated
-
setKeyMaterial
static void setKeyMaterial(long ctx, java.security.cert.X509Certificate[] keyCertChain, java.security.PrivateKey key, java.lang.String keyPassword) throws javax.net.ssl.SSLException- Throws:
javax.net.ssl.SSLException
-
freeBio
static void freeBio(long bio)
-
toBIO
static long toBIO(ByteBufAllocator allocator, java.security.PrivateKey key) throws java.lang.Exception
Return the pointer to a in-memory BIO or0if thekeyisnull. The BIO contains the content of thekey.- Throws:
java.lang.Exception
-
toBIO
static long toBIO(ByteBufAllocator allocator, java.security.cert.X509Certificate... certChain) throws java.lang.Exception
Return the pointer to a in-memory BIO or0if thecertChainisnull. The BIO contains the content of thecertChain.- Throws:
java.lang.Exception
-
toBIO
static long toBIO(ByteBufAllocator allocator, PemEncoded pem) throws java.lang.Exception
- Throws:
java.lang.Exception
-
newBIO
private static long newBIO(ByteBuf buffer) throws java.lang.Exception
- Throws:
java.lang.Exception
-
providerFor
static OpenSslKeyMaterialProvider providerFor(javax.net.ssl.KeyManagerFactory factory, java.lang.String password)
Returns theOpenSslKeyMaterialProviderthat should be used for OpenSSL. Depending on the givenKeyManagerFactorythis may cache theOpenSslKeyMaterialfor better performance if it can ensure that the same material is always returned for the same alias.
-
retrieveEngine
private static ReferenceCountedOpenSslEngine retrieveEngine(OpenSslEngineMap engineMap, long ssl) throws javax.net.ssl.SSLException
- Throws:
javax.net.ssl.SSLException
-
verifyResult
private static byte[] verifyResult(byte[] result) throws java.security.SignatureException- Throws:
java.security.SignatureException
-
-