totalcross.net.ssl

Class SSL4D

java.lang.Object

totalcross.net.ssl.SSL4D

public class SSL4D
extends java.lang.Object

A representation of an SSL connection.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	nativeHeap

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SSL4D() Store the reference to an SSL context.

Method Summary

Modifier and Type	Method and Description
void	dispose4D() Free any used resources on this connection.
protected void	finalize()
java.lang.String	getCertificateDN4D(int component) Retrieve an X.509 distinguished name component.
byte	getCipherId4D() Return the SSL cipher id.
java.lang.Exception	getLastException()
byte[]	getSessionId4D() Get the session id for a handshake.
int	handshakeStatus4D() Return the result of a handshake.
int	read4D(SSLReadHolder rh) Read the SSL data stream.
int	renegotiate4D() Force the client to perform its handshake again.
int	verifyCertificate4D() Authenticate a received certificate.
int	write(byte[] out_data) Write to the SSL data stream.
int	write4D(byte[] out_data, int out_len) Write to the SSL data stream.

Methods inherited from class java.lang.Object

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

Field Detail

nativeHeap

protected java.lang.Object nativeHeap

Constructor Detail

SSL4D

protected SSL4D()

Store the reference to an SSL context.

Parameters:

ssl - [in] A reference to an SSL object.

Method Detail

dispose4D

public void dispose4D()

Free any used resources on this connection. A "Close Notify" message is sent on this connection (if possible). It is up to the application to close the socket.

handshakeStatus4D

public int handshakeStatus4D()

Return the result of a handshake.

Returns:

SSL_OK if the handshake is complete and ok.

getCipherId4D

public byte getCipherId4D()

Return the SSL cipher id.

Returns:

The cipher id which is one of: - TLS_RSA_WITH_AES_128_CBC_SHA (0x2f) - TLS_RSA_WITH_AES_256_CBC_SHA (0x35) - TLS_RSA_WITH_RC4_128_SHA (0x05) - TLS_RSA_WITH_RC4_128_MD5 (0x04)

getSessionId4D

public byte[] getSessionId4D()

Get the session id for a handshake. This will be a 32 byte sequence and is available after the first handshaking messages are sent.

Returns:

The session id as a 32 byte sequence.

getCertificateDN4D

public java.lang.String getCertificateDN4D(int component)

Retrieve an X.509 distinguished name component. When a handshake is complete and a certificate has been exchanged, then the details of the remote certificate can be retrieved. This will usually be used by a client to check that the server's common name matches the URL. A full handshake needs to occur for this call to work.

Parameters:

component - [in] one of: - SSL_X509_CERT_COMMON_NAME - SSL_X509_CERT_ORGANIZATION - SSL_X509_CERT_ORGANIZATIONAL_NAME - SSL_X509_CA_CERT_COMMON_NAME - SSL_X509_CA_CERT_ORGANIZATION - SSL_X509_CA_CERT_ORGANIZATIONAL_NAME

Returns:

The appropriate string (or null if not defined)

read4D

public int read4D(SSLReadHolder rh)

Read the SSL data stream.

Parameters:

rh - [out] After a successful read, the decrypted data can be retrieved with rh.getData(). It will be null otherwise.

Returns:

The number of decrypted bytes: - if > 0, then the handshaking is complete and we are returning the number of decrypted bytes. - SSL_OK if the handshaking stage is successful (but not yet complete). - < 0 if an error.

write

public final int write(byte[] out_data)

Write to the SSL data stream.

Parameters:

out_data - [in] The data to be written

Returns:

The number of bytes sent, or if < 0 if an error.

write4D

public int write4D(byte[] out_data,
                   int out_len)

Write to the SSL data stream.

Parameters:

out_data - [in] The data to be written

out_len - [in] The number of bytes to be written

Returns:

The number of bytes sent, or if < 0 if an error.

verifyCertificate4D

public int verifyCertificate4D()

Authenticate a received certificate. This call is usually made by a client after a handshake is complete and the context is in SSL_SERVER_VERIFY_LATER mode.

Returns:

SSL_OK if the certificate is verified.

renegotiate4D

public int renegotiate4D()

Force the client to perform its handshake again. For a client this involves sending another "client hello" message. For the server is means sending a "hello request" message. This is a blocking call on the client (until the handshake completes).

Returns:

SSL_OK if renegotiation instantiation was ok

getLastException

public final java.lang.Exception getLastException()

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object