org.eclipse.californium.scandium.dtls

Class HandshakeMessage

java.lang.Object

org.eclipse.californium.scandium.dtls.AbstractMessage

org.eclipse.californium.scandium.dtls.HandshakeMessage

All Implemented Interfaces:

DTLSMessage

Direct Known Subclasses:

CertificateMessage, CertificateRequest, CertificateVerify, ClientHello, ClientKeyExchange, Finished, FragmentedHandshakeMessage, GenericHandshakeMessage, HelloRequest, HelloVerifyRequest, MultiHandshakeMessage, ServerHello, ServerHelloDone, ServerKeyExchange

public abstract class HandshakeMessage
extends AbstractMessage

Represents a general handshake message and defines the common header. The subclasses are responsible for the rest of the message body. See RFC 6347 for the message format.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FRAGMENT_LENGTH_BITS
static int	FRAGMENT_OFFSET_BITS
static int	MESSAGE_HEADER_LENGTH_BYTES
static int	MESSAGE_LENGTH_BITS
static int	MESSAGE_SEQ_BITS
static int	MESSAGE_TYPE_BITS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HandshakeMessage(InetSocketAddress peerAddress) Creates a new handshake message for a given peer.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	fragmentChanged() Reset the byteArray in order to generate an outgoing raw message with the changed payload / fragment.
abstract byte[]	fragmentToByteArray() The serialization of the handshake body (without the handshake header).
static HandshakeMessage	fromByteArray(byte[] byteArray, InetSocketAddress peerAddress) Read handshake message from (received) byte array.
static HandshakeMessage	fromGenericHandshakeMessage(GenericHandshakeMessage message, HandshakeParameter parameter) Create specific handshake from generic handshake message using the now available handshake parameter.
ContentType	getContentType() Gets the message's content type.
int	getFragmentLength() Get fragment length.
int	getFragmentOffset() Get fragment offset.
abstract int	getMessageLength() Must be implemented by each subclass.
int	getMessageSeq() Get handshake message sequence number.
abstract HandshakeType	getMessageType() Returns the type of the handshake message.
HandshakeMessage	getNextHandshakeMessage() Get next handshake message.
protected byte[]	getRawMessage() Gets the raw bytes of the message received from a client that this instance has been created from.
void	setMessageSeq(int messageSeq) Set the handshake message sequence number.
void	setNextHandshakeMessage(HandshakeMessage message) Set next handshake message.
int	size() Gets the number of bytes representing this message as defined by TLS 1.2, Appendix A.
byte[]	toByteArray() Returns the raw binary representation of the handshake message.
String	toString()
protected void	writeTo(org.eclipse.californium.elements.util.DatagramWriter writer) Write handshake message to writer.

Methods inherited from class org.eclipse.californium.scandium.dtls.AbstractMessage

getPeer

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_TYPE_BITS

public static final int MESSAGE_TYPE_BITS

See Also:

Constant Field Values

MESSAGE_LENGTH_BITS

public static final int MESSAGE_LENGTH_BITS

See Also:

Constant Field Values

MESSAGE_SEQ_BITS

public static final int MESSAGE_SEQ_BITS

See Also:

Constant Field Values

FRAGMENT_OFFSET_BITS

public static final int FRAGMENT_OFFSET_BITS

See Also:

Constant Field Values

FRAGMENT_LENGTH_BITS

public static final int FRAGMENT_LENGTH_BITS

See Also:

Constant Field Values

MESSAGE_HEADER_LENGTH_BYTES

public static final int MESSAGE_HEADER_LENGTH_BYTES

See Also:

Constant Field Values

Constructor Detail

HandshakeMessage

protected HandshakeMessage(InetSocketAddress peerAddress)

Creates a new handshake message for a given peer.

Parameters:

peerAddress - the IP address and port of the peer this message has been received from or should be sent to

Method Detail

size

public int size()

Description copied from interface: DTLSMessage

Gets the number of bytes representing this message as defined by TLS 1.2, Appendix A.

Returns:

number of bytes

getMessageType

public abstract HandshakeType getMessageType()

Returns the type of the handshake message. See HandshakeType.

Returns:

the HandshakeType.

getMessageLength

public abstract int getMessageLength()

Must be implemented by each subclass. The length is given in bytes and only includes the length of the subclass' specific fields (not the handshake message header).

Returns:

the length of the message in bytes.

fragmentToByteArray

public abstract byte[] fragmentToByteArray()

The serialization of the handshake body (without the handshake header). Must be implemented by each subclass. Except the ClientHello, the fragments are considered to be not modified. If a modification is required, call fragmentChanged().

Returns:

the raw byte representation of the handshake body.

getContentType

public final ContentType getContentType()

Description copied from interface: DTLSMessage

Gets the message's content type.

Returns:

the type

toString

public String toString()

Overrides:

toString in class Object

toByteArray

public byte[] toByteArray()

Returns the raw binary representation of the handshake message. for incoming messages this it the same as getRawMessage(). For outgoing messages the header is generated by this method and the subclasses are responsible for the specific rest of the payload / fragment. The result is only created once at the first call. Following calls will get the same bytes until fragmentChanged() gets called.

Returns:

the byte representation of the handshake message.

See Also:

byteArray, fragmentToByteArray(), fragmentChanged()

writeTo

protected void writeTo(org.eclipse.californium.elements.util.DatagramWriter writer)

Write handshake message to writer.

Parameters:

writer - writer to write handshake message.

Since:

2.4

fragmentChanged

protected void fragmentChanged()

Reset the byteArray in order to generate an outgoing raw message with the changed payload / fragment. Only used by ClientHello.setCookie(byte[]).

fromByteArray

public static HandshakeMessage fromByteArray(byte[] byteArray,
                             InetSocketAddress peerAddress)
                                      throws HandshakeException

Read handshake message from (received) byte array. Most handshake messages will be returned as specific subclass. Only a few will be returned as GenericHandshakeMessage or FragmentedHandshakeMessage. If multiple handshake messages are contained, the returned handshake messages are chained by getNextHandshakeMessage().

Parameters:

byteArray - byte array containing the handshake message

peerAddress - peer address of handshake message

Returns:

created handshake message

Throws:

HandshakeException - if handshake message could not be read.

fromGenericHandshakeMessage

public static HandshakeMessage fromGenericHandshakeMessage(GenericHandshakeMessage message,
                                           HandshakeParameter parameter)
                                                    throws HandshakeException

Create specific handshake from generic handshake message using the now available handshake parameter.

Parameters:

message - generic handshake message

parameter - handshake parameter

Returns:

specific handshake message.

Throws:

HandshakeException - if specific handshake message could not be created.

Since:

2.4

getFragmentOffset

public int getFragmentOffset()

Get fragment offset.

Returns:

fragment offset.

getFragmentLength

public int getFragmentLength()

Get fragment length.

Returns:

fragment length

getMessageSeq

public int getMessageSeq()

Get handshake message sequence number.

Returns:

handshake message sequence number

setMessageSeq

public void setMessageSeq(int messageSeq)

Set the handshake message sequence number.

Parameters:

messageSeq - handshake message sequence number

Throws:

IllegalStateException - if toByteArray() was already called without calling fragmentChanged().

setNextHandshakeMessage

public void setNextHandshakeMessage(HandshakeMessage message)

Set next handshake message.

Parameters:

message - next handshake message.

getNextHandshakeMessage

public HandshakeMessage getNextHandshakeMessage()

Get next handshake message.

Returns:

next handshake message. null, if no next handshake message is available.

getRawMessage

protected final byte[] getRawMessage()

Gets the raw bytes of the message received from a client that this instance has been created from. The raw message is used for calculating the handshake hash sent in the FINISHED message.

Returns:

the message or null if this instance has not been created from a message received from a client.