PcapPlusPlus
pcpp::SSLClientHelloMessage Class Reference

#include <SSLHandshake.h>

Inheritance diagram for pcpp::SSLClientHelloMessage:
pcpp::SSLHandshakeMessage

Public Member Functions

 SSLClientHelloMessage (uint8_t *data, size_t dataLen, SSLHandshakeLayer *container)
 
ssl_tls_client_server_hellogetClientHelloHeader ()
 
SSLVersion getHandshakeVersion ()
 
uint8_t getSessionIDLength ()
 
uint8_t * getSessionID ()
 
int getCipherSuiteCount ()
 
SSLCipherSuitegetCipherSuite (int index)
 
uint8_t getCompressionMethodsValue ()
 
int getExtensionCount ()
 
uint16_t getExtensionsLenth ()
 
SSLExtensiongetExtension (int index)
 
SSLExtensiongetExtensionOfType (uint16_t type)
 
SSLExtensiongetExtensionOfType (SSLExtensionType type)
 
template<class TExtension >
TExtension * getExtensionOfType ()
 
std::string toString ()
 
- Public Member Functions inherited from pcpp::SSLHandshakeMessage
virtual SSLHandshakeType getHandshakeType ()
 
virtual size_t getMessageLength ()
 
virtual bool isMessageComplete ()
 
SSLHandshakeLayergetContainingLayer ()
 

Additional Inherited Members

- Static Public Member Functions inherited from pcpp::SSLHandshakeMessage
static SSLHandshakeMessagecreateHandhakeMessage (uint8_t *data, size_t dataLen, SSLHandshakeLayer *container)
 

Detailed Description

Represents a client-hello message (type 1). Inherits from SSLHandshakeMessage and adds parsing of all fields of this message including the message extensions, cipher-suite list, etc.

Constructor & Destructor Documentation

pcpp::SSLClientHelloMessage::SSLClientHelloMessage ( uint8_t *  data,
size_t  dataLen,
SSLHandshakeLayer container 
)

C'tor for this class. Currently only in use in SSLHandshakeMessage::createHandhakeMessage() and shouldn't be used by a user

Parameters
[in]dataThe message as raw data
[in]dataLenMessage raw data length in bytes
[in]containerThe SSL handshake layer which shall contain this message

Member Function Documentation

SSLCipherSuite* pcpp::SSLClientHelloMessage::getCipherSuite ( int  index)

Get a pointer to a cipher-suite by index. The cipher-suites are numbered according to their order of appearance in the message. If index is out of bounds (less than 0 or larger than total amount of cipher suites) NULL will be returned

Parameters
[in]indexThe index of the cipher-suite to return
Returns
The pointer to the cipher-suite object or NULL if index is out of bounds
int pcpp::SSLClientHelloMessage::getCipherSuiteCount ( )
Returns
The number of cipher-suites included in this message
ssl_tls_client_server_hello* pcpp::SSLClientHelloMessage::getClientHelloHeader ( )
inline
Returns
A struct containing common fields for client-hello and server-hello messages. Notice this points directly to the data, so every change will change the actual packet data
uint8_t pcpp::SSLClientHelloMessage::getCompressionMethodsValue ( )
Returns
The value of the compression method byte
SSLExtension* pcpp::SSLClientHelloMessage::getExtension ( int  index)

Get a pointer to an extension by index. The extensions are numbered according to their order of appearance in the message. If index is out of bounds (less than 0 or larger than total amount of extensions) NULL will be returned

Parameters
[in]indexThe index of the extension to return
Returns
The pointer to the extension or NULL if index is out of bounds
int pcpp::SSLClientHelloMessage::getExtensionCount ( )
Returns
The number of extensions in this message
SSLExtension* pcpp::SSLClientHelloMessage::getExtensionOfType ( uint16_t  type)

Get a pointer to an extension by numeric type field. Every extension has a 2-byte numeric value representing its type (for example: renegotiation info extension type is 0x1ff). This method gets the type and returns a pointer to the extension object

Parameters
[in]typeThe 2-byte numeric type of the extension
Returns
A pointer to the extension object of NULL if this type doesn't exist in this message
SSLExtension* pcpp::SSLClientHelloMessage::getExtensionOfType ( SSLExtensionType  type)

Get a pointer to an extension by its enum type

Parameters
[in]typeThe type of extension to return
Returns
A pointer to the extension object or NULL if this type doesn't exist in this message
template<class TExtension >
TExtension * pcpp::SSLClientHelloMessage::getExtensionOfType ( )

Get a pointer to an extension by its class type. This is a templated method that is used with the type of the requested extension and returns the first extension instance of this type

Returns
A pointer to the extension object or NULL if this extension type doesn't exist in this message
uint16_t pcpp::SSLClientHelloMessage::getExtensionsLenth ( )
Returns
The size (in bytes) of all extensions data in this message. Extracted from the "extensions length" field
SSLVersion pcpp::SSLClientHelloMessage::getHandshakeVersion ( )
Returns
Handshake SSL/TLS version (notice it may be different than SSLLayer::getRecordVersion(). Each client-hello or server-hello message has both record version and handshake version and they may differ from one another)
uint8_t* pcpp::SSLClientHelloMessage::getSessionID ( )
Returns
Session ID as byte array. If server-hello message doesn't include session ID NULL will be returned
uint8_t pcpp::SSLClientHelloMessage::getSessionIDLength ( )
Returns
Session ID length in bytes. If server-hello message doesn't include session ID 0 will be returned
std::string pcpp::SSLClientHelloMessage::toString ( )
virtual
Returns
A string representation of the message type (e.g "Client Hello message")

Implements pcpp::SSLHandshakeMessage.