#include <debug.h>

Public Types
enum	ForceAuthRole { FORCE_AUTH_ROLE_NORMAL, FORCE_AUTH_ROLE_LEADER, FORCE_AUTH_ROLE_FOLLOWER }

Public Member Functions
	SecurityDebug ()

void	set_all_flags_to (bool value)
	Set all security debug message flags to this value. More...

void	parse_flags (const ACE_TCHAR *flags)

void	set_debug_level (unsigned level)

Public Attributes
bool	fake_encryption
	Disable all encryption for security, even the required builtin encryption. More...

enum OpenDDS::DCPS::SecurityDebug::ForceAuthRole	force_auth_role

SecurityFlags
These are the categories of Security Debug Messages
bool	encdec_error

bool	encdec_warn

bool	encdec_debug

bool	auth_debug
	Authentication and Handshake. More...

bool	auth_warn

bool	new_entity_error
	New entity creating. More...

bool	new_entity_warn

bool	cleanup_error
	Cleanup. More...

bool	access_error
	Permissions and Governance. More...

bool	access_warn

bool	bookkeeping
	Generation and Tracking of Crypto Handles and Keys. More...

bool	showkeys
	Print the Key when Generating it or Using It. More...

bool	chlookup
	Print Verbose Search Info About Getting the Crypto Handle from a Key id. More...

Detailed Description

Global Security Debug Settings

Definition at line 92 of file debug.h.

Member Enumeration Documentation

◆ ForceAuthRole

enum OpenDDS::DCPS::SecurityDebug::ForceAuthRole

Force role in authentication handshake. Like fake encryption this will break everything if applied inconsistently.

Enumerator
FORCE_AUTH_ROLE_NORMAL
FORCE_AUTH_ROLE_LEADER
FORCE_AUTH_ROLE_FOLLOWER

Definition at line 152 of file debug.h.

                      {
     FORCE_AUTH_ROLE_NORMAL,
     FORCE_AUTH_ROLE_LEADER,
     FORCE_AUTH_ROLE_FOLLOWER
   } force_auth_role;

Constructor & Destructor Documentation

◆ SecurityDebug()

OpenDDS::DCPS::SecurityDebug::SecurityDebug ( )

Definition at line 110 of file debug.cpp.

References set_all_flags_to().

   : fake_encryption(false)
   , force_auth_role(FORCE_AUTH_ROLE_NORMAL)
 {
   set_all_flags_to(false);
 }

Member Function Documentation

◆ parse_flags()

void OpenDDS::DCPS::SecurityDebug::parse_flags ( const ACE_TCHAR * flags )

Parse a comma delimited string and set the corresponding flags. Unknown ones are ignored and "all" enables all the flags. Ex: "bookkeeping,showkeys"

Definition at line 134 of file debug.cpp.

References access_error, access_warn, ACE_ERROR, ACE_TEXT_ALWAYS_CHAR, auth_debug, auth_warn, bookkeeping, chlookup, cleanup_error, encdec_debug, encdec_error, encdec_warn, LM_WARNING, OpenDDS::DCPS::log_level, new_entity_error, new_entity_warn, set_all_flags_to(), showkeys, and OpenDDS::DCPS::LogLevel::Warning.

Referenced by OpenDDS::DCPS::Service_Participant::load_common_configuration(), and OpenDDS::DCPS::Service_Participant::parse_args().

 {
   String s(ACE_TEXT_ALWAYS_CHAR(flags));
   const String delim(",");
   while (true) {
     const size_t pos = s.find(delim);
     const String flag = s.substr(0, pos);
     if (flag.length()) {
       if (flag == "all") {
         set_all_flags_to(true);
       } else if (flag == "encdec_error") {
         encdec_error = true;
       } else if (flag == "encdec_warn") {
         encdec_warn = true;
       } else if (flag == "encdec_debug") {
         encdec_debug = true;
       } else if (flag == "auth_debug") {
         auth_debug = true;
       } else if (flag == "auth_warn") {
         auth_warn = true;
       } else if (flag == "new_entity_error") {
         new_entity_error = true;
       } else if (flag == "new_entity_warn") {
         new_entity_warn = true;
       } else if (flag == "cleanup_error") {
         cleanup_error = true;
       } else if (flag == "access_error") {
         access_error = true;
       } else if (flag == "access_warn") {
         access_warn = true;
       } else if (flag == "bookkeeping") {
         bookkeeping = true;
       } else if (flag == "showkeys") {
         showkeys = true;
       } else if (flag == "chlookup") {
         chlookup = true;
       } else if (log_level >= LogLevel::Warning) {
         ACE_ERROR((LM_WARNING, "(%P|%t) WARNING: SecurityDebug::parse_flags: "
           "Unknown Security Debug Category: \"%C\"\n", flag.c_str()));
       }
     }
     if (pos == String::npos) {
       break;
     }
     s.erase(0, pos + delim.length());
   }
 }

◆ set_all_flags_to()

void OpenDDS::DCPS::SecurityDebug::set_all_flags_to ( bool value )

Set all security debug message flags to this value.

Definition at line 117 of file debug.cpp.

References access_error, access_warn, auth_debug, auth_warn, bookkeeping, chlookup, cleanup_error, encdec_debug, encdec_error, encdec_warn, new_entity_error, new_entity_warn, showkeys, and value.

Referenced by parse_flags(), and SecurityDebug().

 {
   encdec_error = value;
   encdec_warn = value;
   encdec_debug = value;
   auth_debug = value;
   auth_warn = value;
   new_entity_error = value;
   new_entity_warn = value;
   cleanup_error = value;
   access_error = value;
   access_warn = value;
   bookkeeping = value;
   showkeys = value;
   chlookup = value;
 }

◆ set_debug_level()

void OpenDDS::DCPS::SecurityDebug::set_debug_level ( unsigned level )

Set debug level similarly to DCPSDebugLevel

Definition at line 182 of file debug.cpp.

References access_error, access_warn, auth_debug, auth_warn, bookkeeping, chlookup, cleanup_error, encdec_debug, encdec_error, encdec_warn, new_entity_error, new_entity_warn, OPENDDS_END_VERSIONED_NAMESPACE_DECL, and showkeys.

Referenced by OpenDDS::DCPS::Service_Participant::load_common_configuration(), and OpenDDS::DCPS::Service_Participant::parse_args().

 {
   access_error = new_entity_error = cleanup_error = level >= 1;
   access_warn = level >= 2;
   auth_warn = encdec_error = level >= 3;
   new_entity_warn = level >= 3;
   auth_debug = encdec_warn = bookkeeping = level >= 4;
   encdec_debug = level >= 8;
   showkeys = level >= 9;
   chlookup = level >= 10;
 }