USBGuard
Software framework that protects your computer against rogue USB devices by implementing basic whitelisting and blacklisting capabilities.
Public Types | Public Member Functions | Friends | List of all members
usbguard::AuditEvent Class Reference

Describes policy or device event and its result that should be audited using given audit identity and backend. More...

#include <Audit.hpp>

Public Types

using Keys = std::unordered_map< std::string, std::string >
 

Public Member Functions

 AuditEvent (AuditEvent &&event)
 Constructs audit event from existing audit event. More...
 
 AuditEvent (const AuditEvent &event)=delete
 
 ~AuditEvent ()
 Destructs this audit event. More...
 
void success ()
 Commits this audit event with result "SUCCESS".
 
void failure ()
 Commits this audit event with result "FAILURE".
 
const AuditIdentityidentity () const
 Returns AuditIdentity. More...
 
const Keys & keys () const
 Returns map of key=value pairs describing what happened/changed that should be audited. More...
 

Friends

class Audit
 

Detailed Description

Describes policy or device event and its result that should be audited using given audit identity and backend.

Constructor & Destructor Documentation

◆ AuditEvent()

usbguard::AuditEvent::AuditEvent ( AuditEvent &&  event)

Constructs audit event from existing audit event.

Parameters
eventEvent from which this object will be constructed.

◆ ~AuditEvent()

usbguard::AuditEvent::~AuditEvent ( )

Destructs this audit event.

If audit event was not commited, then it is assumed it failed.

See also
failure()

Member Function Documentation

◆ identity()

const AuditIdentity & usbguard::AuditEvent::identity ( ) const

Returns AuditIdentity.

Returns
AuditIdentity.

◆ keys()

const AuditEvent::Keys & usbguard::AuditEvent::keys ( ) const

Returns map of key=value pairs describing what happened/changed that should be audited.

Returns
Map of key=value pairs.

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