Class astutedds::security::LoggingPlugin

Class astutedds::security::LoggingPlugin

ClassList > astutedds > security > LoggingPlugin

Logging Service Plugin Interface (SPI) More...

  • #include <logging_spi.hpp>

Public Functions

Type Name
virtual bool flush (SecurityException & ex) = 0
Flush log buffer to storage.
virtual bool log (const SecurityEvent & event, SecurityException & ex) = 0
Log a security event.
virtual bool log_access_control_event (SecurityLogLevel level, PermissionsHandle permissions, const std::string & topic_name, const std::string & message, SecurityException & ex) = 0
Log access control event.
virtual bool log_authentication_event (SecurityLogLevel level, IdentityHandle local_identity, IdentityHandle remote_identity, const std::string & message, SecurityException & ex) = 0
Log authentication event.
virtual bool log_crypto_event (SecurityLogLevel level, CryptoHandle crypto_handle, const std::string & message, SecurityException & ex) = 0
Log cryptographic event.
virtual bool set_log_level (SecurityLogLevel level, SecurityException & ex) = 0
Set logging verbosity level.
virtual ~LoggingPlugin () = default

Detailed Description

Based on DDS Security 1.1 Section 8.6 Provides security event logging and audit trail

Public Functions Documentation

function flush

Flush log buffer to storage. 

virtual bool astutedds::security::LoggingPlugin::flush (
    SecurityException & ex
) = 0

Parameters:

  • ex Security exception output

Returns:

True if successful

function log

Log a security event. 

virtual bool astutedds::security::LoggingPlugin::log (
    const SecurityEvent & event,
    SecurityException & ex
) = 0

Parameters:

  • event Security event to log
  • ex Security exception output

Returns:

True if successful

function log_access_control_event

Log access control event. 

virtual bool astutedds::security::LoggingPlugin::log_access_control_event (
    SecurityLogLevel level,
    PermissionsHandle permissions,
    const std::string & topic_name,
    const std::string & message,
    SecurityException & ex
) = 0

Parameters:

  • level Log level
  • permissions Permissions handle
  • topic_name Topic name (if applicable)
  • message Event message
  • ex Security exception output

Returns:

True if successful

function log_authentication_event

Log authentication event. 

virtual bool astutedds::security::LoggingPlugin::log_authentication_event (
    SecurityLogLevel level,
    IdentityHandle local_identity,
    IdentityHandle remote_identity,
    const std::string & message,
    SecurityException & ex
) = 0

Parameters:

  • level Log level
  • local_identity Local participant identity
  • remote_identity Remote participant identity
  • message Event message
  • ex Security exception output

Returns:

True if successful

function log_crypto_event

Log cryptographic event. 

virtual bool astutedds::security::LoggingPlugin::log_crypto_event (
    SecurityLogLevel level,
    CryptoHandle crypto_handle,
    const std::string & message,
    SecurityException & ex
) = 0

Parameters:

  • level Log level
  • crypto_handle Crypto handle
  • message Event message
  • ex Security exception output

Returns:

True if successful

function set_log_level

Set logging verbosity level. 

virtual bool astutedds::security::LoggingPlugin::set_log_level (
    SecurityLogLevel level,
    SecurityException & ex
) = 0

Parameters:

  • level Minimum log level to record
  • ex Security exception output

Returns:

True if successful

function ~LoggingPlugin

virtual astutedds::security::LoggingPlugin::~LoggingPlugin () = default

The documentation for this class was generated from the following file include/astutedds/security/logging_spi.hpp