Logging utility for Zero Trust simulation modules in NS-3. More...

#include <zt-logger.h>

Collaboration diagram for ZtLogger:

Static Public Member Functions
static void	EnableTimestamps (bool enable)
	Enables or disables timestamp logging.

static void	Log (const std::string &tag, const std::string &message)
	Logs a general message with a specified tag.

static void	LogCertIssued (uint32_t nodeId, const std::string &role, time_t expiry)
	Logs a certificate issuance event.

static void	LogCertValidationResult (uint32_t nodeId, bool valid)
	Logs the result of certificate validation.

static void	LogCertRevoked (uint32_t nodeId)
	Logs a certificate revocation event.

static void	LogCertRejected (const std::string &reason)
	Logs a rejected certificate attempt with a reason.

static void	LogEncryption (const std::string &payload, const std::string &ivHex)
	Logs an encryption event with payload and IV.

static void	LogDecryption (const std::string &payload)
	Logs a successful decryption event.

static void	LogDecryptionFailure ()
	Logs a decryption failure event.

Static Private Attributes
static bool	timestampsEnabled = true
	Flag to indicate if timestamps are enabled in logs.

Detailed Description

Logging utility for Zero Trust simulation modules in NS-3.

Provides logging functions for general events, certificate-related events, and encryption/decryption actions. Supports optional timestamps.

Definition at line 15 of file zt-logger.h.

Member Function Documentation

◆ EnableTimestamps()

void ZtLogger::EnableTimestamps ( bool enable )

static

Enables or disables timestamp logging.

Enables or disables timestamps in log messages.

Parameters

enable	True to include timestamps in logs, false to omit them.
enable	If true, timestamps will be included in logs.

Definition at line 16 of file zt-logger.cc.

                                           {
  timestampsEnabled = enable;
}

Here is the caller graph for this function:

◆ Log()

void ZtLogger::Log	(	const std::string &	tag,
		const std::string &	message
	)

static

Logs a general message with a specified tag.

Logs a message with a given tag and optional timestamp.

Parameters

tag	Context label (e.g., "INFO", "ERROR").
message	The message content.
tag	A short string indicating the type or source of the message.
message	The actual log message content.

Definition at line 25 of file zt-logger.cc.

                                                                 {
  std::ostringstream output;
 
  if (timestampsEnabled) {
    std::time_t now = std::time(nullptr);
    std::tm *lt = std::localtime(&now);
    output << "[" << std::put_time(lt, "%H:%M:%S") << "] ";
  }
 
  output << "[" << tag << "] " << message;
  NS_LOG_UNCOND(output.str());
}

Here is the caller graph for this function:

◆ LogCertIssued()

void ZtLogger::LogCertIssued	(	uint32_t	nodeId,
		const std::string &	role,
		time_t	expiry
	)

static

Logs a certificate issuance event.

Logs the issuance of a certificate.

Parameters

nodeId	ID of the node receiving the certificate.
role	Assigned role for the node.
expiry	Expiry time of the certificate.
nodeId	The ID of the node receiving the certificate.
role	The assigned role in the certificate.
expiry	The expiration time of the certificate.

Definition at line 46 of file zt-logger.cc.

                                                                                  {
  std::ostringstream msg;
  msg << "Issued certificate to Node " << nodeId << " | Role: " << role
      << " | Expiry: " << expiry;
  Log("ZT-CERT", msg.str());
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LogCertRejected()

void ZtLogger::LogCertRejected ( const std::string & reason )

static

Logs a rejected certificate attempt with a reason.

Logs a rejection reason for a certificate.

Parameters

reason	Description of the rejection cause.
reason	The explanation for why the certificate was rejected.

Definition at line 75 of file zt-logger.cc.

                                                      {
  Log("ZT-CERT", "Certificate rejected: " + reason);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LogCertRevoked()

void ZtLogger::LogCertRevoked ( uint32_t nodeId )

static

Logs a certificate revocation event.

Logs the revocation of a certificate.

Parameters

nodeId	ID of the node whose certificate was revoked.
nodeId	The ID of the node whose certificate was revoked.

Definition at line 67 of file zt-logger.cc.

                                             {
  Log("ZT-CERT", "Node " + std::to_string(nodeId) + " certificate revoked");
}

Here is the call graph for this function:

◆ LogCertValidationResult()

void ZtLogger::LogCertValidationResult	(	uint32_t	nodeId,
		bool	valid
	)

static

Logs the result of certificate validation.

Logs the result of a certificate validation attempt.

Parameters

nodeId	ID of the node whose certificate was validated.
valid	True if the certificate is valid, false otherwise.
nodeId	The node whose certificate was validated.
valid	True if the certificate is valid, false otherwise.

Definition at line 58 of file zt-logger.cc.

                                                                  {
  Log("ZT-CERT", "Validation for Node " + std::to_string(nodeId) +
      (valid ? ": VALID" : ": INVALID"));
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LogDecryption()

void ZtLogger::LogDecryption ( const std::string & payload )

static

Logs a successful decryption event.

Logs a successful decryption result.

Parameters

payload	The decrypted plaintext data.
payload	The decrypted plaintext.

Definition at line 94 of file zt-logger.cc.

                                                     {
  Log("ZT-DEC", "Decrypted Payload: " + payload);
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LogDecryptionFailure()

void ZtLogger::LogDecryptionFailure ( )

static

Logs a decryption failure event.

Logs a failure during decryption due to invalid session or corrupted data.

Definition at line 101 of file zt-logger.cc.

                                    {
  Log("ZT-DEC", "Decryption failed: Invalid session or corrupt data");
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LogEncryption()

void ZtLogger::LogEncryption	(	const std::string &	payload,
		const std::string &	ivHex
	)

static

Logs an encryption event with payload and IV.

Logs encryption activity with IV and encrypted data.

Parameters

payload	The encrypted data.
ivHex	Initialization Vector in hex string format.
payload	The encrypted data in hex or readable format.
ivHex	The IV used during encryption, in hex format.

Definition at line 86 of file zt-logger.cc.

                                                                             {
  Log("ZT-ENC", "Payload encrypted | IV: " + ivHex + " | Data: " + payload);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ timestampsEnabled

bool ZtLogger::timestampsEnabled = true

staticprivate

Flag to indicate if timestamps are enabled in logs.

Static flag to control timestamp display.

Definition at line 76 of file zt-logger.h.

The documentation for this class was generated from the following files:

model/zt-logger.h
model/zt-logger.cc

Static Public Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

◆ EnableTimestamps()

◆ Log()

◆ LogCertIssued()

◆ LogCertRejected()

◆ LogCertRevoked()

◆ LogCertValidationResult()

◆ LogDecryption()

◆ LogDecryptionFailure()

◆ LogEncryption()

Field Documentation

◆ timestampsEnabled