Data logging functions for debugging purpose (IKEv2) More...

#include "ike/ike.h"
#include "ike/ike_debug.h"
#include "debug.h"

Macros
#define	TRACE_LEVEL IKE_TRACE_LEVEL

Functions
void	ikeDumpMessage (const uint8_t *message, size_t length)
	Dump IKE message. More...

void	ikeDumpHeader (const IkeHeader *header)
	Dump IKE header. More...

void	ikeDumpFlags (uint8_t flags)
	Dump flags. More...

void	ikeDumpPayloads (const uint8_t *payloads, size_t length, uint8_t nextPayload)
	Dump IKE payloads. More...

void	ikeDumpPayloadHeader (const IkePayloadHeader *header)
	Dump generic payload header. More...

void	ikeDumpSaPayload (const IkeSaPayload *payload, size_t length)
	Dump Security Association payload. More...

void	ikeDumpProposal (const IkeProposal *proposal, size_t length)
	Dump Proposal substructure. More...

void	ikeDumpTransform (const IkeTransform *transform, size_t length)
	Dump Transform substructure. More...

error_t	ikeDumpTransformAttr (const IkeTransformAttr attr, size_t length, size_t consumed)
	Dump transform attribute. More...

void	ikeDumpKePayload (const IkeKePayload *payload, size_t length)
	Dump Key Exchange payload. More...

void	ikeDumpIdPayload (const IkeIdPayload *payload, size_t length)
	Dump Identification payload. More...

void	ikeDumpCertPayload (const IkeCertPayload *payload, size_t length)
	Dump Certificate payload. More...

void	ikeDumpCertReqPayload (const IkeCertReqPayload *payload, size_t length)
	Dump Certificate Request payload. More...

void	ikeDumpAuthPayload (const IkeAuthPayload *payload, size_t length)
	Dump Authentication payload. More...

void	ikeDumpNoncePayload (const IkeNoncePayload *payload, size_t length)
	Dump Nonce payload. More...

void	ikeDumpNotifyPayload (const IkeNotifyPayload *payload, size_t length)
	Dump Notify payload. More...

void	ikeDumpInvalidKePayloadNotification (const uint8_t *data, size_t length)
	Dump INVALID_KE_PAYLOAD notification data. More...

void	ikeDumpSignHashAlgosNotification (const uint8_t *data, size_t length)
	Dump IKE_NOTIFY_MSG_TYPE_SIGNATURE_HASH_ALGORITHMS notification data. More...

void	ikeDumpDeletePayload (const IkeDeletePayload *payload, size_t length)
	Dump Delete payload. More...

void	ikeDumpTsPayload (const IkeTsPayload *payload, size_t length)
	Dump Traffic Selector payload. More...

void	ikeDumpTs (const IkeTs *ts, size_t length)
	Dump Traffic Selector substructure. More...

void	ikeDumpEncryptedPayload (const IkeEncryptedPayload *payload, size_t length)
	Dump Encrypted payload. More...

void	ikeDumpEncryptedFragPayload (const IkeEncryptedFragPayload *payload, size_t length)
	Dump Encrypted Fragment payload. More...

const char_t *	ikeGetParamName (uint_t value, const IkeParamName *paramList, size_t paramListLen)
	Convert a parameter to string representation. More...

Detailed Description

Data logging functions for debugging purpose (IKEv2)

License

SPDX-License-Identifier: GPL-2.0-or-later

This file is part of CycloneIPSEC Open.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Author: Oryx Embedded SARL (www.oryx-embedded.com)

Version: 2.6.6

Definition in file ike_debug.c.

Macro Definition Documentation

◆ TRACE_LEVEL

#define TRACE_LEVEL IKE_TRACE_LEVEL

Definition at line 32 of file ike_debug.c.

Function Documentation

◆ ikeDumpAuthPayload()

void ikeDumpAuthPayload	(	const IkeAuthPayload *	payload,
		size_t	length
	)

Dump Authentication payload.

Parameters

[in]	payload	Pointer to the payload to dump
[in]	length	Length of the payload, in bytes

Definition at line 1210 of file ike_debug.c.

◆ ikeDumpCertPayload()

void ikeDumpCertPayload	(	const IkeCertPayload *	payload,
		size_t	length
	)

Dump Certificate payload.

Parameters

[in]	payload	Pointer to the payload to dump
[in]	length	Length of the payload, in bytes

Definition at line 1146 of file ike_debug.c.

◆ ikeDumpCertReqPayload()

void ikeDumpCertReqPayload	(	const IkeCertReqPayload *	payload,
		size_t	length
	)

Dump Certificate Request payload.

Parameters

[in]	payload	Pointer to the payload to dump
[in]	length	Length of the payload, in bytes

Definition at line 1178 of file ike_debug.c.

◆ ikeDumpDeletePayload()

void ikeDumpDeletePayload	(	const IkeDeletePayload *	payload,
		size_t	length
	)

Dump Delete payload.

Parameters

[in]	payload	Pointer to the payload to dump
[in]	length	Length of the payload, in bytes

Definition at line 1407 of file ike_debug.c.

◆ ikeDumpEncryptedFragPayload()

void ikeDumpEncryptedFragPayload	(	const IkeEncryptedFragPayload *	payload,
		size_t	length
	)

Dump Encrypted Fragment payload.

Parameters

[in]	payload	Pointer to the payload to dump
[in]	length	Length of the payload, in bytes

Definition at line 1619 of file ike_debug.c.

◆ ikeDumpEncryptedPayload()

void ikeDumpEncryptedPayload	(	const IkeEncryptedPayload *	payload,
		size_t	length
	)

Dump Encrypted payload.

Parameters

[in]	payload	Pointer to the payload to dump
[in]	length	Length of the payload, in bytes

Definition at line 1595 of file ike_debug.c.

◆ ikeDumpFlags()

void ikeDumpFlags ( uint8_t flags )

Dump flags.

Parameters

[in] flags specific options that are set for the IKE message

Definition at line 484 of file ike_debug.c.

◆ ikeDumpHeader()

void ikeDumpHeader ( const IkeHeader * header )

Dump IKE header.

Parameters

[in] header Pointer to the IKE header to dump

Definition at line 453 of file ike_debug.c.

◆ ikeDumpIdPayload()

void ikeDumpIdPayload	(	const IkeIdPayload *	payload,
		size_t	length
	)

Dump Identification payload.

Parameters

[in]	payload	Pointer to the payload to dump
[in]	length	Length of the payload, in bytes

Definition at line 1085 of file ike_debug.c.

◆ ikeDumpInvalidKePayloadNotification()

void ikeDumpInvalidKePayloadNotification	(	const uint8_t *	data,
		size_t	length
	)

Dump INVALID_KE_PAYLOAD notification data.

Parameters

[in]	data	Pointer to the notification data
[in]	length	Length of the notification data, in bytes

Definition at line 1345 of file ike_debug.c.

◆ ikeDumpKePayload()

void ikeDumpKePayload	(	const IkeKePayload *	payload,
		size_t	length
	)

Dump Key Exchange payload.

Parameters

[in]	payload	Pointer to the payload to dump
[in]	length	Length of the payload, in bytes

Definition at line 1048 of file ike_debug.c.

◆ ikeDumpMessage()

void ikeDumpMessage	(	const uint8_t *	message,
		size_t	length
	)

Dump IKE message.

Parameters

[in]	message	Pointer to the IKE message to dump
[in]	length	Length of the IKE message, in bytes

Definition at line 425 of file ike_debug.c.

◆ ikeDumpNoncePayload()

void ikeDumpNoncePayload	(	const IkeNoncePayload *	payload,
		size_t	length
	)

Dump Nonce payload.

Parameters

[in]	payload	Pointer to the payload to dump
[in]	length	Length of the payload, in bytes

Definition at line 1242 of file ike_debug.c.

◆ ikeDumpNotifyPayload()

void ikeDumpNotifyPayload	(	const IkeNotifyPayload *	payload,
		size_t	length
	)

Dump Notify payload.

Parameters

[in]	payload	Pointer to the payload to dump
[in]	length	Length of the payload, in bytes

Definition at line 1265 of file ike_debug.c.

◆ ikeDumpPayloadHeader()

void ikeDumpPayloadHeader ( const IkePayloadHeader * header )

Dump generic payload header.

Parameters

[in] header Pointer to the generic payload header to dump

Definition at line 683 of file ike_debug.c.

◆ ikeDumpPayloads()

void ikeDumpPayloads	(	const uint8_t *	payloads,
		size_t	length,
		uint8_t	nextPayload
	)

Dump IKE payloads.

Parameters

[in]	payloads	Pointer to the IKE payloads to dump
[in]	length	Length of the IKE payloads, in bytes
[in]	nextPayload	Next payload type

Definition at line 557 of file ike_debug.c.

◆ ikeDumpProposal()

void ikeDumpProposal	(	const IkeProposal *	proposal,
		size_t	length
	)

Dump Proposal substructure.

Parameters

[in]	proposal	Pointer to the Proposal substructure to dump
[in]	length	Length of the proposal, in bytes

Definition at line 753 of file ike_debug.c.

◆ ikeDumpSaPayload()

void ikeDumpSaPayload	(	const IkeSaPayload *	payload,
		size_t	length
	)

Dump Security Association payload.

Parameters

[in]	payload	Pointer to the payload to dump
[in]	length	Length of the payload, in bytes

Definition at line 704 of file ike_debug.c.

◆ ikeDumpSignHashAlgosNotification()

void ikeDumpSignHashAlgosNotification	(	const uint8_t *	data,
		size_t	length
	)

Dump IKE_NOTIFY_MSG_TYPE_SIGNATURE_HASH_ALGORITHMS notification data.

Parameters

[in]	data	Pointer to the notification data
[in]	length	Length of the notification data, in bytes

Definition at line 1373 of file ike_debug.c.

◆ ikeDumpTransform()

void ikeDumpTransform	(	const IkeTransform *	transform,
		size_t	length
	)

Dump Transform substructure.

Parameters

[in]	transform	Pointer to the Transform substructure to dump
[in]	length	Length of the transform, in bytes

Definition at line 841 of file ike_debug.c.

◆ ikeDumpTransformAttr()

error_t ikeDumpTransformAttr	(	const IkeTransformAttr *	attr,
		size_t	length,
		size_t *	consumed
	)

Dump transform attribute.

Parameters

[in]	attr	Pointer to the transform attribute to dump
[in]	length	Number of bytes available in the input stream
[out]	consumed	Total number of characters that have been consumed

Returns: Error code

Definition at line 971 of file ike_debug.c.

◆ ikeDumpTs()

void ikeDumpTs	(	const IkeTs *	ts,
		size_t	length
	)

Dump Traffic Selector substructure.

Parameters

[in]	ts	Pointer to the Traffic Selector substructure to dump
[in]	length	Length of the selector, in bytes

Definition at line 1506 of file ike_debug.c.

◆ ikeDumpTsPayload()

void ikeDumpTsPayload	(	const IkeTsPayload *	payload,
		size_t	length
	)

Dump Traffic Selector payload.

Parameters

[in]	payload	Pointer to the payload to dump
[in]	length	Length of the payload, in bytes

Definition at line 1449 of file ike_debug.c.

◆ ikeGetParamName()

const char_t* ikeGetParamName	(	uint_t	value,
		const IkeParamName *	paramList,
		size_t	paramListLen
	)

Convert a parameter to string representation.

Parameters

[in]	value	Parameter value
[in]	paramList	List of acceptable parameters
[in]	paramListLen	Number of entries in the list

Returns: NULL-terminated string describing the parameter

Definition at line 1654 of file ike_debug.c.

Macros

Functions

Detailed Description

License

Macro Definition Documentation

◆ TRACE_LEVEL

Function Documentation

◆ ikeDumpAuthPayload()

◆ ikeDumpCertPayload()

◆ ikeDumpCertReqPayload()

◆ ikeDumpDeletePayload()

◆ ikeDumpEncryptedFragPayload()

◆ ikeDumpEncryptedPayload()

◆ ikeDumpFlags()

◆ ikeDumpHeader()

◆ ikeDumpIdPayload()

◆ ikeDumpInvalidKePayloadNotification()

◆ ikeDumpKePayload()

◆ ikeDumpMessage()

◆ ikeDumpNoncePayload()

◆ ikeDumpNotifyPayload()

◆ ikeDumpPayloadHeader()

◆ ikeDumpPayloads()

◆ ikeDumpProposal()

◆ ikeDumpSaPayload()

◆ ikeDumpSignHashAlgosNotification()

◆ ikeDumpTransform()

◆ ikeDumpTransformAttr()

◆ ikeDumpTs()

◆ ikeDumpTsPayload()

◆ ikeGetParamName()