Package org.conscrypt

Class SSLEngineImpl

java.lang.Object

javax.net.ssl.SSLEngine

org.conscrypt.SSLEngineImpl

public class SSLEngineImpl
extends SSLEngine

Implementation of SSLEngine.

See Also:

class documentation for more information.

Field Summary

Fields

Modifier and Type	Field	Description
protected SSLRecordProtocol	recordProtocol
protected SSLParametersImpl	sslParameters

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SSLEngineImpl(String host, int port, SSLParametersImpl sslParameters)
protected	SSLEngineImpl(SSLParametersImpl sslParameters)

Method Summary

Modifier and Type	Method	Description
void	beginHandshake()	Starts the handshake.
void	closeInbound()	Closes inbound operations of this engine
void	closeOutbound()	Closes outbound operations of this engine
Runnable	getDelegatedTask()	Returns handshake's delegated tasks to be run
String[]	getEnabledCipherSuites()	This method works according to the specification of implemented class.
String[]	getEnabledProtocols()	This method works according to the specification of implemented class.
boolean	getEnableSessionCreation()	This method works according to the specification of implemented class.
SSLEngineResult.HandshakeStatus	getHandshakeStatus()	This method works according to the specification of implemented class.
boolean	getNeedClientAuth()	This method works according to the specification of implemented class.
SSLSession	getSession()	This method works according to the specification of implemented class.
String[]	getSupportedCipherSuites()	Returns names of supported cipher suites.
String[]	getSupportedProtocols()	This method works according to the specification of implemented class.
boolean	getUseClientMode()	This method works according to the specification of implemented class.
boolean	getWantClientAuth()	This method works according to the specification of implemented class.
boolean	isInboundDone()	This method works according to the specification of implemented class.
boolean	isOutboundDone()	This method works according to the specification of implemented class.
void	setEnabledCipherSuites(String[] suites)	This method works according to the specification of implemented class.
void	setEnabledProtocols(String[] protocols)	This method works according to the specification of implemented class.
void	setEnableSessionCreation(boolean flag)	This method works according to the specification of implemented class.
void	setNeedClientAuth(boolean need)	This method works according to the specification of implemented class.
void	setUseClientMode(boolean mode)	This method works according to the specification of implemented class.
void	setWantClientAuth(boolean want)	This method works according to the specification of implemented class.
SSLEngineResult	unwrap(ByteBuffer src, ByteBuffer[] dsts, int offset, int length)	Decodes one complete SSL/TLS record provided in the source buffer.
SSLEngineResult	wrap(ByteBuffer[] srcs, int offset, int len, ByteBuffer dst)	Encodes the application data into SSL/TLS record.

Methods inherited from class javax.net.ssl.SSLEngine

getPeerHost, getPeerPort, getSSLParameters, setSSLParameters, unwrap, unwrap, wrap, wrap

Methods inherited from class java.lang.Object

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

Field Details

recordProtocol

protected SSLRecordProtocol recordProtocol

sslParameters

protected SSLParametersImpl sslParameters

Constructor Details

SSLEngineImpl

protected SSLEngineImpl(SSLParametersImpl sslParameters)

SSLEngineImpl

protected SSLEngineImpl(String host,
int port,
SSLParametersImpl sslParameters)

Method Details

beginHandshake

public void beginHandshake()
                    throws SSLException

Starts the handshake.

Specified by:

beginHandshake in class SSLEngine

Throws:

SSLException

See Also:

method documentation for more information

closeInbound

public void closeInbound()
                  throws SSLException

Closes inbound operations of this engine

Specified by:

closeInbound in class SSLEngine

Throws:

SSLException

See Also:

method documentation for more information

closeOutbound

public void closeOutbound()

Closes outbound operations of this engine

Specified by:

closeOutbound in class SSLEngine

See Also:

method documentation for more information

getDelegatedTask

public Runnable getDelegatedTask()

Returns handshake's delegated tasks to be run

Specified by:

getDelegatedTask in class SSLEngine

Returns:

the delegated task to be executed.

See Also:

method documentation for more information

getSupportedCipherSuites

public String[] getSupportedCipherSuites()

Returns names of supported cipher suites.

Specified by:

getSupportedCipherSuites in class SSLEngine

Returns:

array of strings containing the names of supported cipher suites

See Also:

method documentation for more information

getEnabledCipherSuites

public String[] getEnabledCipherSuites()

This method works according to the specification of implemented class.

Specified by:

getEnabledCipherSuites in class SSLEngine

Returns:

the SSL cipher suite names that are enabled in this engine instance.

See Also:

method documentation for more information

setEnabledCipherSuites

public void setEnabledCipherSuites(String[] suites)

This method works according to the specification of implemented class.

Specified by:

setEnabledCipherSuites in class SSLEngine

Parameters:

suites - the SSL cipher suite names to be enabled.

See Also:

method documentation for more information

getSupportedProtocols

public String[] getSupportedProtocols()

This method works according to the specification of implemented class.

Specified by:

getSupportedProtocols in class SSLEngine

Returns:

the protocol names that are supported by this engine.

See Also:

method documentation for more information

getEnabledProtocols

public String[] getEnabledProtocols()

This method works according to the specification of implemented class.

Specified by:

getEnabledProtocols in class SSLEngine

Returns:

the protocol version names that are enabled in this engine instance.

See Also:

method documentation for more information

setEnabledProtocols

public void setEnabledProtocols(String[] protocols)

This method works according to the specification of implemented class.

Specified by:

setEnabledProtocols in class SSLEngine

Parameters:

protocols - the protocol version names to be enabled.

See Also:

method documentation for more information

setUseClientMode

public void setUseClientMode(boolean mode)

This method works according to the specification of implemented class.

Specified by:

setUseClientMode in class SSLEngine

Parameters:

mode - true if this engine should act in client mode, false if not.

See Also:

method documentation for more information

getUseClientMode

public boolean getUseClientMode()

This method works according to the specification of implemented class.

Specified by:

getUseClientMode in class SSLEngine

Returns:

true if the engine is set to do handshaking in client mode.

See Also:

method documentation for more information

setNeedClientAuth

public void setNeedClientAuth(boolean need)

This method works according to the specification of implemented class.

Specified by:

setNeedClientAuth in class SSLEngine

Parameters:

need - true if client authentication is required, false if no authentication is needed.

See Also:

method documentation for more information

getNeedClientAuth

public boolean getNeedClientAuth()

This method works according to the specification of implemented class.

Specified by:

getNeedClientAuth in class SSLEngine

Returns:

true if this engine will require client authentication, false if no client authentication is needed.

See Also:

method documentation for more information

setWantClientAuth

public void setWantClientAuth(boolean want)

This method works according to the specification of implemented class.

Specified by:

setWantClientAuth in class SSLEngine

Parameters:

want - true if client authentication should be requested, false if no authentication is needed.

See Also:

method documentation for more information

getWantClientAuth

public boolean getWantClientAuth()

This method works according to the specification of implemented class.

Specified by:

getWantClientAuth in class SSLEngine

Returns:

true if client authentication will be requested, false otherwise.

See Also:

method documentation for more information

setEnableSessionCreation

public void setEnableSessionCreation(boolean flag)

This method works according to the specification of implemented class.

Specified by:

setEnableSessionCreation in class SSLEngine

Parameters:

flag - true if new SSL sessions may be established, false if existing SSL sessions must be reused.

See Also:

method documentation for more information

getEnableSessionCreation

public boolean getEnableSessionCreation()

This method works according to the specification of implemented class.

Specified by:

getEnableSessionCreation in class SSLEngine

Returns:

true if new session may be established, false if existing sessions must be reused.

See Also:

method documentation for more information

getHandshakeStatus

public SSLEngineResult.HandshakeStatus getHandshakeStatus()

This method works according to the specification of implemented class.

Specified by:

getHandshakeStatus in class SSLEngine

Returns:

the status of the handshake of this engine instance.

See Also:

method documentation for more information

getSession

public SSLSession getSession()

This method works according to the specification of implemented class.

Specified by:

getSession in class SSLEngine

Returns:

the SSL session for this engine instance.

See Also:

method documentation for more information

isInboundDone

public boolean isInboundDone()

This method works according to the specification of implemented class.

Specified by:

isInboundDone in class SSLEngine

Returns:

true if no more inbound data will be accepted by this engine, false otherwise.

See Also:

method documentation for more information

isOutboundDone

public boolean isOutboundDone()

This method works according to the specification of implemented class.

Specified by:

isOutboundDone in class SSLEngine

Returns:

true if no more outbound data will be producted by this engine, otherwise false.

See Also:

method documentation for more information

unwrap

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

Decodes one complete SSL/TLS record provided in the source buffer. If decoded record contained application data, this data will be placed in the destination buffers. For more information about TLS record fragmentation see TLS v 1 specification (http://www.ietf.org/rfc/rfc2246.txt) p 6.2.

Specified by:

unwrap in class SSLEngine

Parameters:

src - source buffer containing SSL/TLS record.

dsts - destination buffers to place received application data.

offset - the offset in the array of destination buffers to which data is to be transferred.

length - the maximum number of destination buffers to be used.

Returns:

the result object of this operation.

Throws:

SSLException - if a problem occurred while processing the data.

See Also:

method documentation for more information

wrap

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

Encodes the application data into SSL/TLS record. If handshake status of the engine differs from NOT_HANDSHAKING the operation can work without consuming of the source data. For more information about TLS record fragmentation see TLS v 1 specification (http://www.ietf.org/rfc/rfc2246.txt) p 6.2.

Specified by:

wrap in class SSLEngine

Parameters:

srcs - the source buffers with application data to be encoded into SSL/TLS record.

offset - the offset in the destination buffers array pointing to the first buffer with the source data.

len - specifies the maximum number of buffers to be procesed.

dst - the destination buffer where encoded data will be placed.

Returns:

the result object of this operation.

Throws:

SSLException - if a problem occurred while processing the data.

See Also:

method documentation for more information