pcpp::SSLHandshakeMessage Class Reference

#include <SSLHandshake.h>

Inheritance diagram for pcpp::SSLHandshakeMessage:

Public Member Functions
virtual SSLHandshakeType	getHandshakeType () const
virtual size_t	getMessageLength () const
virtual bool	isMessageComplete () const
SSLHandshakeLayer *	getContainingLayer () const
virtual std::string	toString () const =0

Static Public Member Functions
static SSLHandshakeMessage *	createHandshakeMessage (uint8_t *data, size_t dataLen, SSLHandshakeLayer *container)

Detailed Description

A base class for SSL/TLS handshake messages. This is an abstract class and cannot be instantiated. SSL/TLS handshake messages are contained in SSLHandshakeLayer, meaning a SSLHandshakeLayer instance can contain one or more SSLHandshakeMessage instances. For example: one SSLHandshakeLayer may contain a server-hello, certificate, server-key-exchange, and server-hello-done messages (although it's not such a common case, most handshake layers contain 1 handshake message only)

Member Function Documentation

createHandshakeMessage()

static SSLHandshakeMessage* pcpp::SSLHandshakeMessage::createHandshakeMessage ( uint8_t *  data, size_t  dataLen, SSLHandshakeLayer *  container  )

static

A factory method for creating instances of handshake messages from raw data

Parameters

[in]	data	The raw data containing 1 handshake message
[in]	dataLen	Raw data length in bytes
[in]	container	A pointer to the SSLHandshakeLayer instance which will contain the created message. This parameter is required because the handshake message includes a pointer to its container

getContainingLayer()

SSLHandshakeLayer* pcpp::SSLHandshakeMessage::getContainingLayer ( ) const

inline

Returns

A pointer to the SSLHandshakeLayer instance containing this message

getHandshakeType()

virtual SSLHandshakeType pcpp::SSLHandshakeMessage::getHandshakeType ( ) const

virtual

Returns

The handshake message type

Reimplemented in pcpp::SSLUnknownMessage.

getMessageLength()

virtual size_t pcpp::SSLHandshakeMessage::getMessageLength ( ) const

virtual

Returns

The handshake message length in bytes. Notice that sometimes the handshake message is divided between several packets, in this case this method will return the length of part of the message in the current packet

Reimplemented in pcpp::SSLUnknownMessage.

isMessageComplete()

virtual bool pcpp::SSLHandshakeMessage::isMessageComplete ( ) const

virtual

Returns

True if current packet contains the entire message or false otherwise. This method is important because sometimes handshake messages are divided in consequent packets (happens a lot in certificate messages which usually contain several KB of data which is larger than standard packet size, so the message is divided between several packets)

toString()

virtual std::string pcpp::SSLHandshakeMessage::toString ( ) const

pure virtual

Returns

A string representation of the message type (e.g "Client Hello message")

Implemented in pcpp::SSLUnknownMessage, pcpp::SSLNewSessionTicketMessage, pcpp::SSLFinishedMessage, pcpp::SSLCertificateVerifyMessage, pcpp::SSLServerHelloDoneMessage, pcpp::SSLCertificateRequestMessage, pcpp::SSLClientKeyExchangeMessage, pcpp::SSLServerKeyExchangeMessage, pcpp::SSLHelloRequestMessage, pcpp::SSLCertificateMessage, pcpp::SSLServerHelloMessage, and pcpp::SSLClientHelloMessage.