Class OpenSslEngine

java.lang.Object

javax.net.ssl.SSLEngine

io.netty.handler.ssl.ReferenceCountedOpenSslEngine

io.netty.handler.ssl.OpenSslEngine

All Implemented Interfaces:

ReferenceCounted

public final class OpenSslEngine
extends ReferenceCountedOpenSslEngine

Implements a SSLEngine using OpenSSL BIO abstractions.

This class will use a finalizer to ensure native resources are automatically cleaned up. To avoid finalizers and manually release the native memory see ReferenceCountedOpenSslEngine.

Method Summary

Modifier and Type	Method	Description
protected void	finalize()

Methods inherited from class ReferenceCountedOpenSslEngine

addCredential, beginHandshake, closeInbound, closeOutbound, getApplicationProtocol, getDelegatedTask, getEnabledCipherSuites, getEnabledProtocols, getEnableSessionCreation, getHandshakeApplicationProtocol, getHandshakeSession, getHandshakeStatus, getNeedClientAuth, getNegotiatedApplicationProtocol, getOcspResponse, getSelectedCredential, getSession, getSSLParameters, getSupportedCipherSuites, getSupportedProtocols, getUseClientMode, getWantClientAuth, isInboundDone, isOutboundDone, refCnt, release, release, retain, retain, setEnabledCipherSuites, setEnabledProtocols, setEnableSessionCreation, setNeedClientAuth, setOcspResponse, setSSLParameters, setUseClientMode, setVerify, setWantClientAuth, shutdown, sslPointer, touch, touch, unwrap, unwrap, unwrap, unwrap, unwrap, wrap, wrap

Modifier and Type	Method	Description
void	addCredential(OpenSslCredential credential)	Adds an OpenSslCredential to this SSL engine.
final void	beginHandshake()
final void	closeInbound()
final void	closeOutbound()
String	getApplicationProtocol()
final Runnable	getDelegatedTask()
final String[]	getEnabledCipherSuites()
final String[]	getEnabledProtocols()
final boolean	getEnableSessionCreation()
String	getHandshakeApplicationProtocol()
final SSLSession	getHandshakeSession()
final SSLEngineResult.HandshakeStatus	getHandshakeStatus()
final boolean	getNeedClientAuth()
String	getNegotiatedApplicationProtocol()
byte[]	getOcspResponse()	Returns the OCSP response or null if the server didn't provide a stapled OCSP response.
OpenSslCredential	getSelectedCredential()	Returns the selected credential for this SSL connection, or null if no credential has been selected yet (e.g., handshake not complete).
final SSLSession	getSession()
final SSLParameters	getSSLParameters()
final String[]	getSupportedCipherSuites()
final String[]	getSupportedProtocols()
final boolean	getUseClientMode()
final boolean	getWantClientAuth()
final boolean	isInboundDone()
final boolean	isOutboundDone()
final int	refCnt()	Returns the reference count of this object.
final boolean	release()	Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
final boolean	release(int decrement)	Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.
final ReferenceCounted	retain()	Increases the reference count by 1.
final ReferenceCounted	retain(int increment)	Increases the reference count by the specified increment.
final void	setEnabledCipherSuites(String[] cipherSuites)
final void	setEnabledProtocols(String[] protocols)	TLS doesn't support a way to advertise non-contiguous versions from the client's perspective, and the client just advertises the max supported version.
final void	setEnableSessionCreation(boolean b)
final void	setNeedClientAuth(boolean b)
void	setOcspResponse(byte[] response)	Sets the OCSP response.
final void	setSSLParameters(SSLParameters sslParameters)
final void	setUseClientMode(boolean clientMode)
final void	setVerify(int verifyMode, int depth)	See SSL_set_verify and SSL.setVerify(long, int, int).
final void	setWantClientAuth(boolean b)
final void	shutdown()	Destroys this engine.
final long	sslPointer()	Returns the pointer to the SSL object for this ReferenceCountedOpenSslEngine.
final ReferenceCounted	touch()	Records the current access location of this object for debugging purposes.
final ReferenceCounted	touch(Object hint)	Records the current access location of this object with an additional arbitrary information for debugging purposes.
final SSLEngineResult	unwrap(ByteBuffer[] srcs, int srcsOffset, int srcsLength, ByteBuffer[] dsts, int dstsOffset, int dstsLength)
final SSLEngineResult	unwrap(ByteBuffer[] srcs, ByteBuffer[] dsts)
final SSLEngineResult	unwrap(ByteBuffer src, ByteBuffer dst)
final SSLEngineResult	unwrap(ByteBuffer src, ByteBuffer[] dsts)
final SSLEngineResult	unwrap(ByteBuffer src, ByteBuffer[] dsts, int offset, int length)
final SSLEngineResult	wrap(ByteBuffer[] srcs, int offset, int length, ByteBuffer dst)
final SSLEngineResult	wrap(ByteBuffer src, ByteBuffer dst)

Methods inherited from class SSLEngine

getHandshakeApplicationProtocolSelector, getPeerHost, getPeerPort, setHandshakeApplicationProtocolSelector, wrap

Methods inherited from class Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable