anonymizer.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.
 
#pragma once
 
#include "anonymization_profile.h"
#include "tag_action.h"
#include "uid_mapping.h"
 
#include <kcenon/pacs/core/dicom_dataset.h>
#include <kcenon/pacs/core/dicom_tag.h>
 
#include <kcenon/common/patterns/result.h>
 
#include <chrono>
#include <functional>
#include <map>
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
namespace kcenon::pacs::security {
 
enum class private_tag_action : std::uint8_t {
    keep,        
    remove_all,  
    remove_data  
};
 
class anonymizer {
public:
    // ========================================================================
    // Construction
    // ========================================================================
 
    explicit anonymizer(anonymization_profile profile = anonymization_profile::basic);
 
    anonymizer(const anonymizer& other);
 
    anonymizer(anonymizer&& other) noexcept;
 
    auto operator=(const anonymizer& other) -> anonymizer&;
 
    auto operator=(anonymizer&& other) noexcept -> anonymizer&;
 
    ~anonymizer() = default;
 
    // ========================================================================
    // Anonymization Operations
    // ========================================================================
 
    [[nodiscard]] auto anonymize(core::dicom_dataset& dataset)
        -> kcenon::common::Result<anonymization_report>;
 
    [[nodiscard]] auto anonymize_with_mapping(
        core::dicom_dataset& dataset,
        uid_mapping& mapping
    ) -> kcenon::common::Result<anonymization_report>;
 
    // ========================================================================
    // Profile Configuration
    // ========================================================================
 
    [[nodiscard]] auto get_profile() const noexcept -> anonymization_profile;
 
    void set_profile(anonymization_profile profile);
 
    // ========================================================================
    // Private Tag Handling
    // ========================================================================
 
    void set_private_tag_action(private_tag_action action);
 
    [[nodiscard]] auto get_private_tag_action() const noexcept
        -> private_tag_action;
 
    // ========================================================================
    // Custom Tag Actions
    // ========================================================================
 
    void add_tag_action(core::dicom_tag tag, tag_action_config config);
 
    void add_tag_actions(
        const std::map<core::dicom_tag, tag_action_config>& actions
    );
 
    auto remove_tag_action(core::dicom_tag tag) -> bool;
 
    void clear_custom_actions();
 
    [[nodiscard]] auto get_tag_action(core::dicom_tag tag) const
        -> tag_action_config;
 
    // ========================================================================
    // Date Shifting
    // ========================================================================
 
    void set_date_offset(std::chrono::days offset);
 
    [[nodiscard]] auto get_date_offset() const noexcept
        -> std::optional<std::chrono::days>;
 
    void clear_date_offset();
 
    [[nodiscard]] static auto generate_random_date_offset(
        std::chrono::days min_days = std::chrono::days{-365},
        std::chrono::days max_days = std::chrono::days{365}
    ) -> std::chrono::days;
 
    // ========================================================================
    // Encryption Configuration
    // ========================================================================
 
    [[nodiscard]] auto set_encryption_key(std::span<const std::uint8_t> key)
        -> kcenon::common::VoidResult;
 
    [[nodiscard]] auto has_encryption_key() const noexcept -> bool;
 
    // ========================================================================
    // Hash Configuration
    // ========================================================================
 
    void set_hash_salt(std::string salt);
 
    [[nodiscard]] auto get_hash_salt() const
        -> std::optional<std::string>;
 
    // ========================================================================
    // Audit and Reporting
    // ========================================================================
 
    void set_detailed_reporting(bool enable);
 
    [[nodiscard]] auto is_detailed_reporting() const noexcept -> bool;
 
    // ========================================================================
    // Static Helpers
    // ========================================================================
 
    [[nodiscard]] static auto get_profile_actions(anonymization_profile profile)
        -> std::map<core::dicom_tag, tag_action_config>;
 
    [[nodiscard]] static auto get_hipaa_identifier_tags()
        -> std::vector<core::dicom_tag>;
 
    [[nodiscard]] static auto get_gdpr_personal_data_tags()
        -> std::vector<core::dicom_tag>;
 
private:
    anonymization_profile profile_;
 
    std::map<core::dicom_tag, tag_action_config> custom_actions_;
 
    std::optional<std::chrono::days> date_offset_;
 
    std::vector<std::uint8_t> encryption_key_;
 
    std::optional<std::string> hash_salt_;
 
    private_tag_action private_tag_action_{private_tag_action::keep};
 
    bool detailed_reporting_{false};
 
    // Internal helpers
    [[nodiscard]] auto apply_action(
        core::dicom_dataset& dataset,
        core::dicom_tag tag,
        const tag_action_config& config,
        uid_mapping* mapping
    ) -> tag_action_record;
 
    [[nodiscard]] auto shift_date(std::string_view date_string) const
        -> std::string;
 
    [[nodiscard]] auto hash_value(std::string_view value) const
        -> std::string;
 
    [[nodiscard]] auto encrypt_value(std::string_view value) const
        -> kcenon::common::Result<std::string>;
 
    void initialize_profile_actions();
};
 
} // namespace kcenon::pacs::security