xds_audit_events.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2021-2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#ifndef PACS_SECURITY_XDS_AUDIT_EVENTS_HPP
#define PACS_SECURITY_XDS_AUDIT_EVENTS_HPP
 
#include "kcenon/pacs/security/atna_audit_logger.h"
 
#include <memory>
#include <string>
#include <vector>
 
namespace kcenon::pacs::security {
 
class atna_service_auditor;
 
struct xds_iti41_event {
    std::string source_id;
    std::string destination_endpoint;
    std::string patient_id;
    std::string submission_set_unique_id;
    std::vector<std::string> document_unique_ids;
    atna_event_outcome outcome{atna_event_outcome::success};
    std::string failure_description;
};
 
struct xds_iti43_event {
    std::string consumer_id;
    std::string source_endpoint;
    std::string document_unique_id;
    std::string repository_unique_id;
    atna_event_outcome outcome{atna_event_outcome::success};
    std::string failure_description;
};
 
struct xds_iti18_event {
    enum class kind : std::uint8_t {
        find_documents,
        get_documents
    };
 
    std::string querier_id;
    std::string registry_endpoint;
    kind query_kind{kind::find_documents};
    std::string patient_id;
    std::vector<std::string> document_uuids;
    atna_event_outcome outcome{atna_event_outcome::success};
    std::string failure_description;
};
 
class xds_audit_sink {
public:
    virtual ~xds_audit_sink() = default;
 
    virtual void on_iti41_submit(const xds_iti41_event& e) = 0;
    virtual void on_iti43_retrieve(const xds_iti43_event& e) = 0;
    virtual void on_iti18_query(const xds_iti18_event& e) = 0;
};
 
[[nodiscard]] std::shared_ptr<xds_audit_sink> make_null_xds_audit_sink();
 
[[nodiscard]] std::shared_ptr<xds_audit_sink> make_atna_xds_audit_sink(
    atna_service_auditor& auditor, std::string local_participant_id);
 
class recording_xds_audit_sink : public xds_audit_sink {
public:
    struct captured_event {
        enum class kind : std::uint8_t { iti41, iti43, iti18 };
        kind k{kind::iti41};
        xds_iti41_event iti41;
        xds_iti43_event iti43;
        xds_iti18_event iti18;
    };
 
    void on_iti41_submit(const xds_iti41_event& e) override;
    void on_iti43_retrieve(const xds_iti43_event& e) override;
    void on_iti18_query(const xds_iti18_event& e) override;
 
    [[nodiscard]] const std::vector<captured_event>& events() const noexcept;
    void clear() noexcept;
 
private:
    std::vector<captured_event> events_;
};
 
// =============================================================================
// Message-Build Helpers (testing surface)
// =============================================================================
 
[[nodiscard]] atna_audit_message build_iti41_audit_message(
    const std::string& audit_source_id, const xds_iti41_event& event,
    const std::string& local_participant_id = "");
[[nodiscard]] atna_audit_message build_iti43_audit_message(
    const std::string& audit_source_id, const xds_iti43_event& event,
    const std::string& local_participant_id = "");
[[nodiscard]] atna_audit_message build_iti18_audit_message(
    const std::string& audit_source_id, const xds_iti18_event& event,
    const std::string& local_participant_id = "");
 
}  // namespace kcenon::pacs::security
 
#endif  // PACS_SECURITY_XDS_AUDIT_EVENTS_HPP