Class OpenSslEngine

java.lang.Object

javax.net.ssl.SSLEngine

org.jboss.netty.handler.ssl.OpenSslEngine

public final class OpenSslEngine
extends SSLEngine

Implements a SSLEngine using OpenSSL BIO abstractions.

Field Summary

Fields

Modifier and Type	Field	Description
private int	accepted	0 - not accepted, 1 - accepted implicitly via wrap()/unwrap(), 2 - accepted explicitly via beginHandshake() call
private String	applicationProtocol
private final SslBufferPool	bufPool
private String	cipher
private int	destroyed
private static final AtomicIntegerFieldUpdater<OpenSslEngine>	DESTROYED_UPDATER
private static final Certificate[]	EMPTY_CERTIFICATES
private static final X509Certificate[]	EMPTY_X509_CERTIFICATES
private static final SSLException	ENCRYPTED_PACKET_OVERSIZED
private static final SSLException	ENGINE_CLOSED
private boolean	engineClosed
private final String	fallbackApplicationProtocol
private boolean	handshakeFinished
private boolean	isInboundDone
private boolean	isOutboundDone
private int	lastPrimingReadResult
private static final InternalLogger	logger
private static final int	MAX_CIPHERTEXT_LENGTH
private static final int	MAX_COMPRESSED_LENGTH
(package private) static final int	MAX_ENCRYPTED_PACKET_LENGTH
private static final int	MAX_PLAINTEXT_LENGTH
private long	networkBIO
private boolean	receivedShutdown
private static final SSLException	RENEGOTIATION_UNSUPPORTED
private SSLSession	session
private long	ssl

Constructor Summary

Constructors

Constructor	Description
OpenSslEngine(long sslCtx, SslBufferPool bufPool, String fallbackApplicationProtocol)	Creates a new instance

Method Summary

Modifier and Type	Method	Description
void	beginHandshake()
private void	beginHandshakeImplicitly()
void	closeInbound()
void	closeOutbound()
Runnable	getDelegatedTask()
String[]	getEnabledCipherSuites()
String[]	getEnabledProtocols()
boolean	getEnableSessionCreation()
private SSLEngineResult.Status	getEngineStatus()
SSLEngineResult.HandshakeStatus	getHandshakeStatus()
boolean	getNeedClientAuth()
SSLSession	getSession()
String[]	getSupportedCipherSuites()
String[]	getSupportedProtocols()
boolean	getUseClientMode()
boolean	getWantClientAuth()
boolean	isInboundDone()
boolean	isOutboundDone()
private int	readEncryptedData(ByteBuffer dst, int pending)	Read encrypted data from the OpenSSL network BIO
private int	readPlaintextData(ByteBuffer dst)	Read plaintext data from the OpenSSL internal BIO
void	setEnabledCipherSuites(String[] strings)
void	setEnabledProtocols(String[] strings)
void	setEnableSessionCreation(boolean b)
void	setNeedClientAuth(boolean b)
void	setUseClientMode(boolean clientMode)
void	setWantClientAuth(boolean b)
void	shutdown()	Destroys this engine.
SSLEngineResult	unwrap(ByteBuffer src, ByteBuffer[] dsts, int offset, int length)
SSLEngineResult	wrap(ByteBuffer[] srcs, int offset, int length, ByteBuffer dst)
private int	writeEncryptedData(ByteBuffer src)	Write encrypted data to the OpenSSL network BIO
private int	writePlaintextData(ByteBuffer src)	Write plaintext data to the OpenSSL internal BIO Calling this function with src.remaining == 0 is undefined.

Methods inherited from class SSLEngine

getApplicationProtocol, getHandshakeApplicationProtocol, getHandshakeApplicationProtocolSelector, getHandshakeSession, getPeerHost, getPeerPort, getSSLParameters, setHandshakeApplicationProtocolSelector, setSSLParameters, unwrap, unwrap, wrap, wrap

Methods inherited from class Object

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

Field Details

logger

private static final InternalLogger logger

EMPTY_CERTIFICATES

private static final Certificate[] EMPTY_CERTIFICATES

EMPTY_X509_CERTIFICATES

private static final X509Certificate[] EMPTY_X509_CERTIFICATES

ENGINE_CLOSED

private static final SSLException ENGINE_CLOSED

RENEGOTIATION_UNSUPPORTED

private static final SSLException RENEGOTIATION_UNSUPPORTED

ENCRYPTED_PACKET_OVERSIZED

private static final SSLException ENCRYPTED_PACKET_OVERSIZED

MAX_PLAINTEXT_LENGTH

private static final int MAX_PLAINTEXT_LENGTH

See Also:

• Constant Field Values

MAX_COMPRESSED_LENGTH

private static final int MAX_COMPRESSED_LENGTH

See Also:

• Constant Field Values

MAX_CIPHERTEXT_LENGTH

private static final int MAX_CIPHERTEXT_LENGTH

See Also:

• Constant Field Values

MAX_ENCRYPTED_PACKET_LENGTH

static final int MAX_ENCRYPTED_PACKET_LENGTH

See Also:

• Constant Field Values

DESTROYED_UPDATER

private static final AtomicIntegerFieldUpdater<OpenSslEngine> DESTROYED_UPDATER

ssl

private long ssl

networkBIO

private long networkBIO

accepted

private int accepted

0 - not accepted, 1 - accepted implicitly via wrap()/unwrap(), 2 - accepted explicitly via beginHandshake() call

handshakeFinished

private boolean handshakeFinished

receivedShutdown

private boolean receivedShutdown

destroyed

private volatile int destroyed

cipher

private String cipher

applicationProtocol

private volatile String applicationProtocol

isInboundDone

private boolean isInboundDone

isOutboundDone

private boolean isOutboundDone

engineClosed

private boolean engineClosed

lastPrimingReadResult

private int lastPrimingReadResult

bufPool

private final SslBufferPool bufPool

fallbackApplicationProtocol

private final String fallbackApplicationProtocol

session

private SSLSession session

Constructor Details

OpenSslEngine

public OpenSslEngine(long sslCtx,
 SslBufferPool bufPool,
 String fallbackApplicationProtocol)

Creates a new instance

Parameters:

sslCtx - an OpenSSL SSL_CTX object

bufPool - the SslBufferPool that will be used by this engine

Method Details

shutdown

public void shutdown()

Destroys this engine.

writePlaintextData

private int writePlaintextData(ByteBuffer src)

Write plaintext data to the OpenSSL internal BIO Calling this function with src.remaining == 0 is undefined.

writeEncryptedData

private int writeEncryptedData(ByteBuffer src)

Write encrypted data to the OpenSSL network BIO

readPlaintextData

private int readPlaintextData(ByteBuffer dst)

Read plaintext data from the OpenSSL internal BIO

readEncryptedData

private int readEncryptedData(ByteBuffer dst,
 int pending)

Read encrypted data from the OpenSSL network BIO

wrap

public SSLEngineResult wrap(ByteBuffer[] srcs,
 int offset,
 int length,
 ByteBuffer dst)
                     throws SSLException

Specified by:

wrap in class SSLEngine

Throws:

SSLException

unwrap

public SSLEngineResult unwrap(ByteBuffer src,
 ByteBuffer[] dsts,
 int offset,
 int length)
                       throws SSLException

Specified by:

unwrap in class SSLEngine

Throws:

SSLException

getDelegatedTask

public Runnable getDelegatedTask()

Specified by:

getDelegatedTask in class SSLEngine

closeInbound

public void closeInbound()
                  throws SSLException

Specified by:

closeInbound in class SSLEngine

Throws:

SSLException

isInboundDone

public boolean isInboundDone()

Specified by:

isInboundDone in class SSLEngine

closeOutbound

public void closeOutbound()

Specified by:

closeOutbound in class SSLEngine

isOutboundDone

public boolean isOutboundDone()

Specified by:

isOutboundDone in class SSLEngine

getSupportedCipherSuites

public String[] getSupportedCipherSuites()

Specified by:

getSupportedCipherSuites in class SSLEngine

getEnabledCipherSuites

public String[] getEnabledCipherSuites()

Specified by:

getEnabledCipherSuites in class SSLEngine

setEnabledCipherSuites

public void setEnabledCipherSuites(String[] strings)

Specified by:

setEnabledCipherSuites in class SSLEngine

getSupportedProtocols

public String[] getSupportedProtocols()

Specified by:

getSupportedProtocols in class SSLEngine

getEnabledProtocols

public String[] getEnabledProtocols()

Specified by:

getEnabledProtocols in class SSLEngine

setEnabledProtocols

public void setEnabledProtocols(String[] strings)

Specified by:

setEnabledProtocols in class SSLEngine

getSession

public SSLSession getSession()

Specified by:

getSession in class SSLEngine

beginHandshake

public void beginHandshake()
                    throws SSLException

Specified by:

beginHandshake in class SSLEngine

Throws:

SSLException

beginHandshakeImplicitly

private void beginHandshakeImplicitly()
                               throws SSLException

Throws:

SSLException

getEngineStatus

private SSLEngineResult.Status getEngineStatus()

getHandshakeStatus

public SSLEngineResult.HandshakeStatus getHandshakeStatus()

Specified by:

getHandshakeStatus in class SSLEngine

setUseClientMode

public void setUseClientMode(boolean clientMode)

Specified by:

setUseClientMode in class SSLEngine

getUseClientMode

public boolean getUseClientMode()

Specified by:

getUseClientMode in class SSLEngine

setNeedClientAuth

public void setNeedClientAuth(boolean b)

Specified by:

setNeedClientAuth in class SSLEngine

getNeedClientAuth

public boolean getNeedClientAuth()

Specified by:

getNeedClientAuth in class SSLEngine

setWantClientAuth

public void setWantClientAuth(boolean b)

Specified by:

setWantClientAuth in class SSLEngine

getWantClientAuth

public boolean getWantClientAuth()

Specified by:

getWantClientAuth in class SSLEngine

setEnableSessionCreation

public void setEnableSessionCreation(boolean b)

Specified by:

setEnableSessionCreation in class SSLEngine

getEnableSessionCreation

public boolean getEnableSessionCreation()

Specified by:

getEnableSessionCreation in class SSLEngine