isolated_scanner.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: MIT
#pragma once
 
// Crash-isolated plugin scanner.
//
// Loads a single plugin bundle in a CHILD PROCESS via the canonical
// `pulp::platform::ChildProcess` API + the pre-existing
// `pulp-scan-worker` helper binary (tools/scan-worker/). A crash, hang,
// or format error in the worker is reported back to the parent as a
// `ScanResult` with a structured `ScanStatus` instead of taking down
// the host.
//
// Uses the `pulp-scan-worker` binary.
//
// Usage:
//   pulp::host::IsolatedPluginScanner s{worker_path};
//   auto result = s.scan(bundle_path, /*timeout_ms=*/5000);
//   if (result.status == ScanStatus::Ok) {
//       use(result.descriptor);
//   } else if (result.status == ScanStatus::Crash) {
//       blacklist.blacklist(bundle_path, result.error_message);
//   }
 
#include <pulp/host/scanner.hpp>
 
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
namespace pulp::host {

std::string find_scan_worker(std::string_view explicit_path = {});

enum class ScanStatus {
    Ok,            
    Crash,         
    Timeout,       
    FormatError,   
    NotPlugin,     
    WorkerMissing, 
    ProtocolError  
};
 
struct ScanResult {
    ScanStatus status = ScanStatus::Crash;
    std::optional<PluginInfo> descriptor;
    std::vector<PluginInfo> descriptors;
    int exit_code = -1;
    std::string error_message;
};
 
class IsolatedPluginScanner {
public:
    explicit IsolatedPluginScanner(std::string worker_path)
        : worker_path_(std::move(worker_path)) {}

    ScanResult scan(const std::string& bundle_path, int timeout_ms = 5000) const;

    const std::string& worker_path() const noexcept { return worker_path_; }
 
private:
    std::string worker_path_;
};
 
}  // namespace pulp::host