runtime_paths

Module: runtime_paths

Contents

Structs

• RunEntryLayout - Canonical paths within one <runtime>/run/<sandbox_id> entry.
• RuntimeLayout - Canonical paths rooted at one resolved Firma runtime directory.
• RuntimeRootInputs - Inputs consulted, in field order, when resolving a runtime root.

Constants

• CA_BUNDLE_FILE_NAME - File name of the Sidecar MITM CA appended to the host’s system roots.
• CA_CERT_FILE_NAME - File name of the Sidecar MITM CA certificate.
• CA_DIR_NAME - Directory holding the per-run Sidecar HTTPS MITM CA material.
• CA_KEY_FILE_NAME - File name of the Sidecar MITM CA private key.

---

firma_runtime_state::runtime_paths::CA_BUNDLE_FILE_NAME

Constant: &str

File name of the Sidecar MITM CA appended to the host’s system roots.

firma_runtime_state::runtime_paths::CA_CERT_FILE_NAME

Constant: &str

File name of the Sidecar MITM CA certificate.

firma_runtime_state::runtime_paths::CA_DIR_NAME

Constant: &str

Directory holding the per-run Sidecar HTTPS MITM CA material.

firma_runtime_state::runtime_paths::CA_KEY_FILE_NAME

Constant: &str

File name of the Sidecar MITM CA private key.

firma_runtime_state::runtime_paths::RunEntryLayout

Struct

Canonical paths within one <runtime>/run/<sandbox_id> entry.

This layout models the files shared between the per-run Sidecar producer and runtime-state observers. Component-private files remain with their owning crates.

Methods:

• fn from_root<impl Into<PathBuf>>(root: impl Trait) -> Self - Construct a run-entry layout from an already resolved root.
• fn root(self: &Self) -> &Path - Return the run-entry root.
• fn into_root(self: Self) -> PathBuf - Consume the layout and return its run-entry root.
• fn sidecar_socket(self: &Self) -> PathBuf - Return the per-run Sidecar Unix socket path.
• fn sidecar_config(self: &Self) -> PathBuf - Return the generated per-run Sidecar configuration path.
• fn sidecar_pid(self: &Self) -> PathBuf - Return the per-run Sidecar PID file path.
• fn sidecar_metadata(self: &Self) -> PathBuf - Return the per-run Sidecar metadata path.
• fn ca_dir(self: &Self) -> PathBuf - Return the directory holding the per-run Sidecar HTTPS MITM CA.
• fn ca_cert(self: &Self) -> PathBuf - Return the Sidecar MITM CA certificate.
• fn ca_bundle(self: &Self) -> PathBuf - Return the Sidecar MITM CA appended to the host’s system roots.
• fn ca_key(self: &Self) -> PathBuf - Return the Sidecar MITM CA private key.

Traits: Eq

Trait Implementations:

• Clone
  • fn clone(self: &Self) -> RunEntryLayout
• Debug
  • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
• PartialEq
  • fn eq(self: &Self, other: &RunEntryLayout) -> bool

firma_runtime_state::runtime_paths::RuntimeLayout

Struct

Canonical paths rooted at one resolved Firma runtime directory.

Construct this value once at a process boundary and pass it to code that reads or publishes runtime files. This prevents separate operations from resolving environment variables differently.

Methods:

• fn resolve(flag: Option<PathBuf>) -> Result<Self> - Resolve a runtime layout from an optional explicit root and the process
• fn from_root<impl Into<PathBuf>>(root: impl Trait) -> Self - Construct a layout from an already resolved runtime root.
• fn root(self: &Self) -> &Path - Return the resolved runtime root.
• fn into_root(self: Self) -> PathBuf - Consume the layout and return its runtime root.
• fn capabilities_dir(self: &Self) -> PathBuf - Return <runtime>/capabilities.
• fn capability_seed(self: &Self, sandbox_id: &SandboxId) -> PathBuf - Return <runtime>/capabilities/<sandbox_id>.toml.
• fn run_dir(self: &Self) -> PathBuf - Return <runtime>/run.
• fn run_entry_layout(self: &Self, sandbox_id: &SandboxId) -> RunEntryLayout - Return the canonical layout for <runtime>/run/<sandbox_id>.
• fn audit_log(self: &Self) -> PathBuf - Return the default shared audit log path.
• fn sidecar_socket(self: &Self) -> PathBuf - Return the default long-lived sidecar Unix socket path.
• fn session_state(self: &Self) -> PathBuf - Return the default persistent enforcement session-state path.

Traits: Eq

Trait Implementations:

• PartialEq
  • fn eq(self: &Self, other: &RuntimeLayout) -> bool
• Clone
  • fn clone(self: &Self) -> RuntimeLayout
• Debug
  • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

firma_runtime_state::runtime_paths::RuntimeRootInputs

Struct

Inputs consulted, in field order, when resolving a runtime root.

Every field is an environment value read at a process boundary, so build this from [Default] and set only what the caller actually has:

use firma_runtime_state::runtime_paths::RuntimeRootInputs;

let inputs = RuntimeRootInputs {
    firma_state_dir: Some("/var/lib/firma".to_string()),
    ..RuntimeRootInputs::default()
};

Fields:

• flag: Option<std::path::PathBuf> - Explicit root supplied on the command line; wins over the environment.
• firma_state_dir: Option<String> - FIRMA_STATE_DIR.
• xdg_runtime_dir: Option<String> - XDG_RUNTIME_DIR, used only on Unix.
• local_app_data: Option<String> - LOCALAPPDATA, used only on Windows.
• temp: Option<String> - TEMP, used only on Windows.
• uid: u32 - Effective user id, used only by the Unix /tmp/firma-$UID fallback.

Traits: Eq

Trait Implementations:

• Default
  • fn default() -> Self
• PartialEq
  • fn eq(self: &Self, other: &RuntimeRootInputs) -> bool
• Clone
  • fn clone(self: &Self) -> RuntimeRootInputs
• Debug
  • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result