org.eclipse.californium.scandium.dtls

Class ServerHello

java.lang.Object

org.eclipse.californium.scandium.dtls.AbstractMessage

org.eclipse.californium.scandium.dtls.HandshakeMessage

org.eclipse.californium.scandium.dtls.ServerHello

All Implemented Interfaces:

DTLSMessage

public final class ServerHello
extends HandshakeMessage

A TLS handshake message sent by a server in response to a ClientHello message received from a client. The server will send this message in response to a ClientHello message when it was able to find an acceptable set of algorithms. If it cannot find such a match, it will respond with a handshake failure alert. See RFC 5246 for further details.

Field Summary

Fields inherited from class org.eclipse.californium.scandium.dtls.HandshakeMessage

FRAGMENT_LENGTH_BITS, FRAGMENT_OFFSET_BITS, MESSAGE_HEADER_LENGTH_BYTES, MESSAGE_LENGTH_BITS, MESSAGE_SEQ_BITS, MESSAGE_TYPE_BITS

Constructor Summary

Constructors

Constructor and Description
ServerHello(ProtocolVersion version, Random random, SessionId sessionId, CipherSuite cipherSuite, CompressionMethod compressionMethod, HelloExtensions extensions, InetSocketAddress peerAddress) Constructs a full ServerHello message.

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	fragmentToByteArray() The serialization of the handshake body (without the handshake header).
static HandshakeMessage	fromReader(org.eclipse.californium.elements.util.DatagramReader reader, InetSocketAddress peerAddress) Creates a Server Hello object from its binary encoding as used on the wire.
CipherSuite	getCipherSuite() Gets the cipher suite the server has chosen for the session being negotiated.
CompressionMethod	getCompressionMethod() Gets the compression method the server has chosen for the session being negotiated.
ConnectionIdExtension	getConnectionIdExtension() Gets the connection id extension data from this message.
HelloExtensions	getExtensions() Gets the server hello extensions the server has included in this message.
int	getMessageLength() Must be implemented by each subclass.
HandshakeType	getMessageType() Returns the type of the handshake message.
Random	getRandom() Gets the server's random value to use for generating the key material.
ProtocolVersion	getServerVersion() Gets the DTLS version the server is willing to use.
SessionId	getSessionId() Gets the identifier the server has created for the session being negotiated.
String	toString()

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

fragmentChanged, fromByteArray, fromGenericHandshakeMessage, getContentType, getFragmentLength, getFragmentOffset, getMessageSeq, getNextHandshakeMessage, getRawMessage, setMessageSeq, setNextHandshakeMessage, size, toByteArray, writeTo

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

Constructor Detail

ServerHello

public ServerHello(ProtocolVersion version,
           Random random,
           SessionId sessionId,
           CipherSuite cipherSuite,
           CompressionMethod compressionMethod,
           HelloExtensions extensions,
           InetSocketAddress peerAddress)

Constructs a full ServerHello message. See RFC 5246 (TLS 1.2), Section 7.4.1.3. Server Hello for details.

Parameters:

version - the negotiated version (highest supported by server).

random - the server's random.

sessionId - the new session's identifier.

cipherSuite - the negotiated cipher suite.

compressionMethod - the negotiated compression method.

extensions - a list of extensions supported by the client (may be null).

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

Throws:

NullPointerException - if any of the mandatory parameters is null

Method Detail

fragmentToByteArray

public byte[] fragmentToByteArray()

Description copied from class: HandshakeMessage

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 HandshakeMessage.fragmentChanged().

Specified by:

fragmentToByteArray in class HandshakeMessage

Returns:

the raw byte representation of the handshake body.

fromReader

public static HandshakeMessage fromReader(org.eclipse.californium.elements.util.DatagramReader reader,
                          InetSocketAddress peerAddress)
                                   throws HandshakeException

Creates a Server Hello object from its binary encoding as used on the wire.

Parameters:

reader - reader for the binary encoding of the message.

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

Returns:

the object representation

Throws:

HandshakeException - if the cipher suite code selected by the server is either unknown, i.e. not defined in CipherSuite at all, or CipherSuite.TLS_NULL_WITH_NULL_NULL

getMessageType

public HandshakeType getMessageType()

Description copied from class: HandshakeMessage

Returns the type of the handshake message. See HandshakeType.

Specified by:

getMessageType in class HandshakeMessage

Returns:

the HandshakeType.

getMessageLength

public int getMessageLength()

Description copied from class: HandshakeMessage

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).

Specified by:

getMessageLength in class HandshakeMessage

Returns:

the length of the message in bytes.

getServerVersion

public ProtocolVersion getServerVersion()

Gets the DTLS version the server is willing to use.

Returns:

The DTLS version.

getRandom

public Random getRandom()

Gets the server's random value to use for generating the key material.

Returns:

The random value.

getSessionId

public SessionId getSessionId()

Gets the identifier the server has created for the session being negotiated.

Returns:

The session identifier.

getCipherSuite

public CipherSuite getCipherSuite()

Gets the cipher suite the server has chosen for the session being negotiated.

Returns:

The cipher suite.

getCompressionMethod

public CompressionMethod getCompressionMethod()

Gets the compression method the server has chosen for the session being negotiated.

Returns:

The compression method.

getExtensions

public HelloExtensions getExtensions()

Gets the server hello extensions the server has included in this message.

Returns:

The extensions or null if no extensions are used.

getConnectionIdExtension

public ConnectionIdExtension getConnectionIdExtension()

Gets the connection id extension data from this message.

Returns:

the extension data or null if this message does not contain the connection id extension.

toString

public String toString()

Overrides:

toString in class HandshakeMessage