org.eclipse.californium.scandium.dtls

Class ClientHello

java.lang.Object

org.eclipse.californium.scandium.dtls.AbstractMessage

org.eclipse.californium.scandium.dtls.HandshakeMessage

org.eclipse.californium.scandium.dtls.ClientHello

All Implemented Interfaces:

DTLSMessage

public final class ClientHello
extends HandshakeMessage

When a client first connects to a server, it is required to send the ClientHello as its first message. The client can also send a ClientHello in response to a HelloRequest or on its own initiative in order to re-negotiate the security parameters in an existing connection. See RFC 5246.

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
ClientHello(ProtocolVersion version, DTLSSession session, List<SignatureAndHashAlgorithm> supportedSignatureAndHashAlgorithms, List<CertificateType> supportedClientCertificateTypes, List<CertificateType> supportedServerCertificateTypes, List<XECDHECryptography.SupportedGroup> supportedGroups) Creates a Client Hello message to be used for resuming an existing DTLS session.
ClientHello(ProtocolVersion version, List<CipherSuite> supportedCipherSuites, List<SignatureAndHashAlgorithm> supportedSignatureAndHashAlgorithms, List<CertificateType> supportedClientCertificateTypes, List<CertificateType> supportedServerCertificateTypes, List<XECDHECryptography.SupportedGroup> supportedGroups, InetSocketAddress peerAddress) Creates a Client Hello message to be sent to a server.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCompressionMethod(CompressionMethod compressionMethod)
byte[]	fragmentToByteArray() The serialization of the handshake body (without the handshake header).
static ClientHello	fromReader(org.eclipse.californium.elements.util.DatagramReader reader, InetSocketAddress peerAddress) Creates a new ClientHello instance from its byte representation.
List<CipherSuite>	getCipherSuites()
ClientCertificateTypeExtension	getClientCertificateTypeExtension()
ProtocolVersion	getClientVersion()
List<CompressionMethod>	getCompressionMethods()
ConnectionIdExtension	getConnectionIdExtension() Gets the connection id extension data from this message.
byte[]	getCookie() Get cookie.
HelloExtensions	getExtensions() Gets the client hello extensions the client has included in this message.
MaxFragmentLengthExtension	getMaxFragmentLengthExtension() Gets the MaximumFragmentLength extension data from this message.
int	getMessageLength() Must be implemented by each subclass.
HandshakeType	getMessageType() Returns the type of the handshake message.
Random	getRandom()
RecordSizeLimitExtension	getRecordSizeLimitExtension() Gets the RecordSizeLimit extension data from this message.
ServerCertificateTypeExtension	getServerCertificateTypeExtension()
ServerNameExtension	getServerNameExtension() Gets the Server Name Indication extension data from this message.
SessionId	getSessionId()
SupportedEllipticCurvesExtension	getSupportedEllipticCurvesExtension() Gets the supported elliptic curves.
SupportedPointFormatsExtension	getSupportedPointFormatsExtension() Gets the supported point formats.
SignatureAlgorithmsExtension	getSupportedSignatureAlgorithms() Gets the Signature and Hash Algorithms extension data from this message.
boolean	hasSessionId() Checks whether this message contains a session ID.
void	setCompressionMethods(List<CompressionMethod> compressionMethods)
void	setCookie(byte[] cookie) Set received cookie.
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

ClientHello

public ClientHello(ProtocolVersion version,
           List<CipherSuite> supportedCipherSuites,
           List<SignatureAndHashAlgorithm> supportedSignatureAndHashAlgorithms,
           List<CertificateType> supportedClientCertificateTypes,
           List<CertificateType> supportedServerCertificateTypes,
           List<XECDHECryptography.SupportedGroup> supportedGroups,
           InetSocketAddress peerAddress)

Creates a Client Hello message to be sent to a server.

Parameters:

version - the protocol version to use

supportedCipherSuites - the list of the supported cipher suites in order of the client’s preference (favorite choice first)

supportedSignatureAndHashAlgorithms - the list of the supported signature and hash algorithms

supportedClientCertificateTypes - the list of certificate types supported by the client

supportedServerCertificateTypes - the list of certificate types supported by the server

supportedGroups - the list of the supported groups (curves) in order of the client’s preference (favorite choice first)

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

Since:

2.3

ClientHello

public ClientHello(ProtocolVersion version,
           DTLSSession session,
           List<SignatureAndHashAlgorithm> supportedSignatureAndHashAlgorithms,
           List<CertificateType> supportedClientCertificateTypes,
           List<CertificateType> supportedServerCertificateTypes,
           List<XECDHECryptography.SupportedGroup> supportedGroups)

Creates a Client Hello message to be used for resuming an existing DTLS session.

Parameters:

version - the protocol version to use

session - the (already existing) DTLS session to resume

supportedSignatureAndHashAlgorithms - the list of the supported signature and hash algorithms

supportedClientCertificateTypes - the list of certificate types supported by the client

supportedServerCertificateTypes - the list of certificate types supported by the server

supportedGroups - the list of the supported groups (curves) in order of the client’s preference (favorite choice first)

Since:

2.3

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 ClientHello fromReader(org.eclipse.californium.elements.util.DatagramReader reader,
                     InetSocketAddress peerAddress)
                              throws HandshakeException

Creates a new ClientHello instance from its byte representation.

Parameters:

reader - reader with 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 ClientHello object

Throws:

HandshakeException - if any of the extensions included in the message is of an unsupported type

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.

toString

public String toString()

Overrides:

toString in class HandshakeMessage

getClientVersion

public ProtocolVersion getClientVersion()

getRandom

public Random getRandom()

getSessionId

public SessionId getSessionId()

hasSessionId

public boolean hasSessionId()

Checks whether this message contains a session ID.

Returns:

true if the message contains a non-null session ID with length > 0

getCookie

public byte[] getCookie()

Get cookie.

Returns:

cookie, or Bytes.EMPTY, if no cookie is available.

setCookie

public void setCookie(byte[] cookie)

Set received cookie. Adjust fragment length.

Parameters:

cookie - received cookie

Throws:

NullPointerException - if cookie is null

IllegalArgumentException - if cookie is empty

getCipherSuites

public List<CipherSuite> getCipherSuites()

getCompressionMethods

public List<CompressionMethod> getCompressionMethods()

setCompressionMethods

public void setCompressionMethods(List<CompressionMethod> compressionMethods)

addCompressionMethod

public void addCompressionMethod(CompressionMethod compressionMethod)

getExtensions

public HelloExtensions getExtensions()

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

Returns:

The extensions or null if no extensions are used.

getSupportedEllipticCurvesExtension

public SupportedEllipticCurvesExtension getSupportedEllipticCurvesExtension()

Gets the supported elliptic curves.

Returns:

the client's supported elliptic curves extension if available, otherwise null.

getSupportedPointFormatsExtension

public SupportedPointFormatsExtension getSupportedPointFormatsExtension()

Gets the supported point formats.

Returns:

the client's supported point formats extension if available, otherwise null.

getClientCertificateTypeExtension

public ClientCertificateTypeExtension getClientCertificateTypeExtension()

Returns:

the client's certificate type extension if available, otherwise null.

getServerCertificateTypeExtension

public ServerCertificateTypeExtension getServerCertificateTypeExtension()

Returns:

the server's certificate type extension if available, otherwise null.

getSupportedSignatureAlgorithms

public SignatureAlgorithmsExtension getSupportedSignatureAlgorithms()

Gets the Signature and Hash Algorithms extension data from this message.

Returns:

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

Since:

2.3

getMaxFragmentLengthExtension

public MaxFragmentLengthExtension getMaxFragmentLengthExtension()

Gets the MaximumFragmentLength extension data from this message.

Returns:

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

getRecordSizeLimitExtension

public RecordSizeLimitExtension getRecordSizeLimitExtension()

Gets the RecordSizeLimit extension data from this message.

Returns:

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

Since:

2.4

getServerNameExtension

public ServerNameExtension getServerNameExtension()

Gets the Server Name Indication extension data from this message.

Returns:

the extension data or null if this message does not contain the Server Name Indication extension.

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.