AuditableEvents.hpp

Go to the documentation of this file.

#ifndef IV_SRC_MODEL_DIAMAR_AUDITABLEEVENTS_HPP_
#define IV_SRC_MODEL_DIAMAR_AUDITABLEEVENTS_HPP_
 
#include "core/types.hpp"
#include "diamar/enums.hpp"
 
namespace iv::model::diamar
{
 
enum class EventCategory
{
    AccessControl,
    RequestErrors,
    OperatingSystemEvents,
    ControlSystemEvents,
    BackupAndRestoreEvents,
    ConfigurationChanges,
    PotentialAttackActivity,
    AuditLogEvents
};
 
enum class EventTypes
{
    NotApplicable,
    //TODO: Add more event types
    //AccessControl
    LoginIn,
    LoginOut,
    LoginError,
    //RequestErrors
    //OperatingSystemEvents
    Start,
    Reboot,
    Shutdown,
    FailedAttempt,
    //ControlSystemEvents
    Download,
    ReplaceLom,
    LoginConfigChange,
    //BackupAndRestoreEvents
    Backup,
    Restore,
    LimitBackUp,
    DeleteBackUp,
    //ConfigurationChanges
    DateAndTime,
    Language,
    //PotentialAttackActivity
    ScanPort,
};
 
struct AuditableEvent
{
    AuditableEvent(std::string id, iv::types::timestamp timestamp, iv::model::diamar::EventCategory category,
                   iv::model::diamar::EventTypes type, std::string source, std::string description);
    virtual ~AuditableEvent() = default;
    std::string id;
    iv::types::timestamp timestamp;
    iv::model::diamar::EventCategory category;
    iv::model::diamar::EventTypes type;
    std::string source;
    std::string description;
 
    virtual std::string toString() const = 0;
};
 
struct AccessControlEvent : public AuditableEvent
{
    AccessControlEvent(std::string id, iv::types::timestamp timestamp, iv::model::diamar::EventTypes type,
                       std::string source, std::string description, iv::diamar::eUserProfileType inUser,
                       iv::diamar::eUserProfileType outUser);
    ~AccessControlEvent() = default;
    iv::diamar::eUserProfileType userProfileOut;
    iv::diamar::eUserProfileType userProfileIn;
 
    std::string toString() const override;
};
 
struct RequestErrorsEvent : public AuditableEvent
{
    RequestErrorsEvent(std::string id, iv::types::timestamp timestamp, iv::model::diamar::EventTypes type,
                       std::string source, std::string description, iv::types::ipAddress ipAddress,
                       iv::types::ipPort port);
    iv::types::ipAddress ipAddress;
    iv::types::ipPort port;
 
    std::string toString() const override;
};
 
struct OperatingSystemEvent : public AuditableEvent
{
    OperatingSystemEvent(std::string idValue, iv::types::timestamp timestampValue,
                         iv::model::diamar::EventTypes typeValue, std::string sourceValue, std::string descriptionValue)
        : AuditableEvent(idValue, timestampValue, iv::model::diamar::EventCategory::OperatingSystemEvents, typeValue,
                         sourceValue, descriptionValue) {};
    std::string toString() const override;
};
 
struct ControlSystemEvent : public AuditableEvent
{
    ControlSystemEvent(std::string id, iv::types::timestamp timestamp, iv::model::diamar::EventTypes type,
                       std::string source, std::string description, iv::types::unitId unitId,
                       iv::types::channelId channelId, iv::types::groupId groupId);
    iv::types::unitId unitId;
    iv::types::channelId channelId;
    iv::types::groupId groupId;
 
    std::string toString() const override;
};
 
struct BackupAndRestoreEvent : public AuditableEvent
{
    BackupAndRestoreEvent(std::string id, iv::types::timestamp timestamp, iv::model::diamar::EventTypes type,
                          std::string source, std::string description, std::string backupName);
    std::string backupName;
 
    std::string toString() const override;
};
 
struct ConfigurationChangeEvent : public AuditableEvent
{
    ConfigurationChangeEvent(std::string idValue, iv::types::timestamp timestampValue,
                             iv::model::diamar::EventTypes typeValue, std::string sourceValue,
                             std::string descriptionValue)
        : AuditableEvent(idValue, timestampValue, iv::model::diamar::EventCategory::ConfigurationChanges, typeValue,
                         sourceValue, descriptionValue) {};
    std::string toString() const override;
};
 
struct PotentialAttackActivityEvent : public AuditableEvent
{
    PotentialAttackActivityEvent(std::string id, iv::types::timestamp timestamp, iv::model::diamar::EventTypes type,
                                 std::string source, std::string description, iv::types::ipAddress ipAddress,
                                 iv::types::ipPort port);
    iv::types::ipAddress ipAddress;
    iv::types::ipPort port;
 
    std::string toString() const override;
};
 
struct AuditLogEvent : public AuditableEvent
{
    AuditLogEvent(std::string idValue, iv::types::timestamp timestampValue, iv::model::diamar::EventTypes typeValue,
                  std::string sourceValue, std::string descriptionValue)
        : AuditableEvent(idValue, timestampValue, iv::model::diamar::EventCategory::AuditLogEvents, typeValue,
                         sourceValue, descriptionValue) {};
    std::string toString() const override;
};
 
}// namespace iv::model::diamar
 
#endif//IV_SRC_MODEL_DIAMAR_AUDITABLEEVENTS_HPP_