pcpp::SSHKeyExchangeInitMessage Class Reference

#include <SSHLayer.h>

Inheritance diagram for pcpp::SSHKeyExchangeInitMessage:

Public Member Functions
	SSHKeyExchangeInitMessage (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
uint8_t *	getCookie ()
std::string	getCookieAsHexStream ()
std::string	getKeyExchangeAlgorithms ()
std::string	getServerHostKeyAlgorithms ()
std::string	getEncryptionAlgorithmsClientToServer ()
std::string	getEncryptionAlgorithmsServerToClient ()
std::string	getMacAlgorithmsClientToServer ()
std::string	getMacAlgorithmsServerToClient ()
std::string	getCompressionAlgorithmsClientToServer ()
std::string	getCompressionAlgorithmsServerToClient ()
std::string	getLanguagesClientToServer ()
std::string	getLanguagesServerToClient ()
bool	isFirstKexPacketFollows ()
Public Member Functions inherited from pcpp::SSHHandshakeMessage
SSHHandshakeMessageType	getMessageType () const
std::string	getMessageTypeStr () const
uint8_t *	getSSHHandshakeMessage () const
size_t	getSSHHandshakeMessageLength () const
size_t	getPaddingLength () const
size_t	getHeaderLen () const override
std::string	toString () const override
Public Member Functions inherited from pcpp::SSHLayer
void	parseNextLayer () override
void	computeCalculateFields () override
	Does nothing for this layer.
OsiModelLayer	getOsiModelLayer () const override
Public Member Functions inherited from pcpp::Layer
	~Layer () override
Layer *	getNextLayer () const
Layer *	getPrevLayer () const
ProtocolType	getProtocol () const
bool	isMemberOfProtocolFamily (ProtocolTypeFamily protocolTypeFamily) const
uint8_t *	getData () const
size_t	getDataLen () const
uint8_t *	getLayerPayload () const
size_t	getLayerPayloadSize () const
bool	isAllocatedToPacket () const
void	copyData (uint8_t *toArr) const
uint8_t *	getDataPtr (size_t offset=0) const override

Additional Inherited Members
Public Types inherited from pcpp::SSHHandshakeMessage
enum	SSHHandshakeMessageType {   SSH_MSG_KEX_INIT = 20 , SSH_MSG_NEW_KEYS = 21 , SSH_MSG_KEX_DH_INIT = 30 , SSH_MSG_KEX_DH_REPLY = 31 ,   SSH_MSG_KEX_DH_GEX_INIT = 32 , SSH_MSG_KEX_DH_GEX_REPLY = 33 , SSH_MSG_KEX_DH_GEX_REQUEST = 34 , SSH_MSG_UNKNOWN = 999 }
	An enum that represents SSH non-encrypted message types. More...
Static Public Member Functions inherited from pcpp::SSHHandshakeMessage
static SSHHandshakeMessage *	tryParse (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
Static Public Member Functions inherited from pcpp::SSHLayer
static SSHLayer *	createSSHMessage (uint8_t *data, size_t dataLen, Layer *prevLayer, Packet *packet)
static bool	isSSHPort (uint16_t portSrc, uint16_t portDst)
Protected Member Functions inherited from pcpp::Layer
Packet *	getAttachedPacket ()
	Get a pointer to the Packet this layer is attached to (if any). More...
Packet const *	getAttachedPacket () const
	Get a pointer to the Packet this layer is attached to (if any). More...
template<typename T , typename... Args>
Layer *	constructNextLayer (uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Construct the next layer in the protocol stack. No validation is performed on the data. More...
template<typename T , typename... Args>
Layer *	constructNextLayer (uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
template<typename TFactory , typename... Args>
Layer *	constructNextLayerFromFactory (TFactory factoryFn, uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Construct the next layer in the protocol stack using a factory functor. More...
template<typename TFactory , typename... Args>
Layer *	constructNextLayerFromFactory (TFactory factoryFn, uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
	Construct the next layer in the protocol stack using a factory functor. More...
template<typename T , typename... Args>
Layer *	tryConstructNextLayer (uint8_t *data, size_t dataLen, Args &&... extraArgs)
template<typename T , typename... Args>
Layer *	tryConstructNextLayer (uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
template<typename T , typename TFallback , typename... Args>
Layer *	tryConstructNextLayerWithFallback (uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Try to construct the next layer in the protocol stack with a fallback option. More...
template<typename T , typename TFallback , typename... Args>
Layer *	tryConstructNextLayerWithFallback (uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
template<typename TFallback , typename TFactory , typename... Args>
Layer *	tryConstructNextLayerFromFactoryWithFallback (TFactory factoryFn, uint8_t *data, size_t dataLen, Args &&... extraArgs)
	Try to construct the next layer in the protocol stack using a factory functor with a fallback option. More...
template<typename TFallback , typename TFactory , typename... Args>
Layer *	tryConstructNextLayerFromFactoryWithFallback (TFactory factoryFn, uint8_t *data, size_t dataLen, Packet *packet, Args &&... extraArgs)
	Try to construct the next layer in the protocol stack using a factory functor with a fallback option. More...
Static Protected Member Functions inherited from pcpp::Layer
template<typename T >
static bool	canReinterpretAs (const uint8_t *data, size_t dataLen)
	Check if the data is large enough to reinterpret as a type. More...

Detailed Description

A class representing the SSH Key Exchange Init message. This is a non-encrypted message that contains information about the algorithms used for key exchange, encryption, MAC and compression. This class provides methods to access these details

Constructor & Destructor Documentation

SSHKeyExchangeInitMessage()

pcpp::SSHKeyExchangeInitMessage::SSHKeyExchangeInitMessage	(	uint8_t *	data,
		size_t	dataLen,
		Layer *	prevLayer,
		Packet *	packet
	)

A c'tor for this class that accepts raw message data. Please avoid using it as it's used internally when parsing SSH handshake messages in SSHHandshakeMessage::tryParse()

Parameters

[in]	data	A pointer to the raw data
[in]	dataLen	Size of the data in bytes
[in]	prevLayer	A pointer to the previous layer
[in]	packet	A pointer to the Packet instance where layer will be stored in

Member Function Documentation

getCompressionAlgorithmsClientToServer()

std::string pcpp::SSHKeyExchangeInitMessage::getCompressionAlgorithmsClientToServer ( )

inline

Returns

A comma-separated list of acceptable compression algorithms from the client to the server. Can be empty if the value is missing or the message is malformed

getCompressionAlgorithmsServerToClient()

std::string pcpp::SSHKeyExchangeInitMessage::getCompressionAlgorithmsServerToClient ( )

inline

Returns

A comma-separated list of acceptable compression algorithms from the server to the client. Can be empty if the value is missing or the message is malformed

getCookie()

uint8_t* pcpp::SSHKeyExchangeInitMessage::getCookie

(

)

Each SSH Key Exchange Init message contains a random 16-byte value generated by the sender. This method returns a pointer to this 16-byte cookie. To get the value as a hex string please refer to getCookieAsHexStream()

Returns

A pointer to the 16-byte cookie value or nullptr if the message is malformed

getCookieAsHexStream()

std::string pcpp::SSHKeyExchangeInitMessage::getCookieAsHexStream

(

)

Each SSH Key Exchange Init message contains a random 16-byte value generated by the sender. This method returns the 16-byte cookie as a hex stream. To get the raw data please refer to getCookie()

Returns

A hex stream of the 16-byte cookie value or an empty string if the message is malformed

getEncryptionAlgorithmsClientToServer()

std::string pcpp::SSHKeyExchangeInitMessage::getEncryptionAlgorithmsClientToServer ( )

inline

Returns

A comma-separated list of acceptable symmetric encryption algorithms (also known as ciphers) from the client to the server. Can be empty if the value is missing or the message is malformed

getEncryptionAlgorithmsServerToClient()

std::string pcpp::SSHKeyExchangeInitMessage::getEncryptionAlgorithmsServerToClient ( )

inline

Returns

A comma-separated list of acceptable symmetric encryption algorithms (also known as ciphers) from the server to the client. Can be empty if the value is missing or the message is malformed

getKeyExchangeAlgorithms()

std::string pcpp::SSHKeyExchangeInitMessage::getKeyExchangeAlgorithms ( )

inline

Returns

A comma-separated list of the key exchange algorithms used in this session. Can be empty if the value is missing or the message is malformed

getLanguagesClientToServer()

std::string pcpp::SSHKeyExchangeInitMessage::getLanguagesClientToServer ( )

inline

Returns

A comma-separated list of language tags from the client to the server. Can be empty if the value is missing or the message is malformed

getLanguagesServerToClient()

std::string pcpp::SSHKeyExchangeInitMessage::getLanguagesServerToClient ( )

inline

Returns

A comma-separated list of language tags from the server to the client. Can be empty if the value is missing or the message is malformed

getMacAlgorithmsClientToServer()

std::string pcpp::SSHKeyExchangeInitMessage::getMacAlgorithmsClientToServer ( )

inline

Returns

A comma-separated list of acceptable MAC algorithms from the client to the server. Can be empty if the value is missing or the message is malformed

getMacAlgorithmsServerToClient()

std::string pcpp::SSHKeyExchangeInitMessage::getMacAlgorithmsServerToClient ( )

inline

Returns

A comma-separated list of acceptable MAC algorithms from the server to the client. Can be empty if the value is missing or the message is malformed

getServerHostKeyAlgorithms()

std::string pcpp::SSHKeyExchangeInitMessage::getServerHostKeyAlgorithms ( )

inline

Returns

A comma-separated list of the algorithms supported for the server host key. Can be empty if the value is missing or the message is malformed

isFirstKexPacketFollows()

bool pcpp::SSHKeyExchangeInitMessage::isFirstKexPacketFollows

(

)

Returns

Indicates whether a guessed key exchange packet follows. If a guessed packet will be sent, the return value is true. If no guessed packet will be sent or if this value is missing, the return value is false.