control_consent_authority.hpp

Go to the documentation of this file.

#pragma once
 
#include <pulp/inspect/control_grants.hpp>
 
#include <chrono>
#include <functional>
#include <memory>
#include <optional>
#include <span>
#include <vector>
 
namespace pulp::inspect {
 
enum class ControlConsentPromptResult : std::uint8_t {
    Approved,
    Denied,
    TimedOut,
    Unavailable,
};
 
struct ControlConsentPrompt {
    ControlGrantConsentRequest request;
    std::string primary_message;
    std::string requested_operations_display;
    std::string technical_details_display;
    std::string approve_label;
    std::string client_executable_display;
    std::string client_publisher_display;
    std::string plugin_display;
    std::string instance_display;
    std::string target_publisher_display;
    std::string build_display;
    std::string artifact_digest_display;
    std::string selector_display;
};
 
struct ControlBrokerConsentAuthorityConfig {
    using Clock = std::function<std::chrono::steady_clock::time_point()>;
    using Entropy = std::function<std::optional<std::vector<std::uint8_t>>(std::size_t)>;
    using Prompt = std::function<ControlConsentPromptResult(const ControlConsentPrompt&,
                                                            std::chrono::milliseconds)>;
 
    std::chrono::milliseconds prompt_timeout = std::chrono::seconds(30);
    std::chrono::milliseconds global_prompt_cooldown = std::chrono::seconds(5);
    std::chrono::milliseconds client_prompt_cooldown = std::chrono::seconds(30);
    std::size_t maximum_tracked_clients = 64;
    Clock clock = [] { return std::chrono::steady_clock::now(); };
    Entropy entropy;
    Prompt prompt;
};

class ControlBrokerConsentAuthority {
  public:
    explicit ControlBrokerConsentAuthority(ControlBrokerConsentAuthorityConfig config = {});
    ~ControlBrokerConsentAuthority();
    ControlBrokerConsentAuthority(const ControlBrokerConsentAuthority&) = delete;
    ControlBrokerConsentAuthority& operator=(const ControlBrokerConsentAuthority&) = delete;
 
    ControlConsentDecision decide(const ControlGrantConsentRequest& request);
    void reset() noexcept;
 
  private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
 
} // namespace pulp::inspect