control_host_preflight.hpp

Go to the documentation of this file.

#pragma once
 
#include <pulp/inspect/control_host_bootstrap.hpp>
#include <pulp/platform/child_process.hpp>
 
#include <chrono>
#include <cstdint>
#include <functional>
#include <optional>
#include <string>
 
namespace pulp::inspect {

enum class ControlHostPreflightStatus : std::uint8_t {
    Accepted,
    Unsupported,
    InvalidChannel,
    EntropyUnavailable,
    Timeout,
    MalformedMessage,
    DirectionMismatch,
    NonceMismatch,
    PeerUnavailable,
    ProcessMismatch,
    AuthorityRejected,
    SendFailed,
    BootstrapInvalid,
};
 
struct ControlHostPreflightDiagnostics {
    ControlHostPreflightStatus status = ControlHostPreflightStatus::InvalidChannel;
    std::string explanation;
};

using ControlHostBootstrapProvider =
    std::function<ControlHostBootstrapBytes(const VerifiedControlPeerIdentity&)>;
 
std::optional<VerifiedControlPeerIdentity>
preflight_control_host(platform::ChildProcessInputChannel channel, std::int64_t expected_process_id,
                       ControlPeerRole role, const ControlPeerVerifier& verifier,
                       const ControlHostBootstrapProvider& provide_bootstrap,
                       std::chrono::milliseconds timeout = std::chrono::seconds(3),
                       ControlHostPreflightDiagnostics* diagnostics = nullptr);

std::optional<VerifiedControlPeerIdentity>
preflight_control_host(platform::ChildProcessInputChannel channel, std::int64_t expected_process_id,
                       ControlPeerRole role, const ControlPeerVerifier& verifier,
                       ControlHostBootstrapBytes bootstrap,
                       std::chrono::milliseconds timeout = std::chrono::seconds(3),
                       ControlHostPreflightDiagnostics* diagnostics = nullptr);

std::optional<ControlHostBootstrapRecord> receive_control_host_preflight(
    ControlHostBootstrapHandle handle, std::chrono::milliseconds timeout = std::chrono::seconds(3),
    std::optional<std::chrono::system_clock::time_point> now = std::nullopt,
    ControlHostPreflightDiagnostics* diagnostics = nullptr);
 
} // namespace pulp::inspect