run
Module: run
Section titled “Module: run”Contents
Section titled “Contents”Structs
CapabilityLeasePatch- Capability lease settings patch.CommandMediatorPatch- Runtime command mediation settings patch.ExecutableLaunchPolicyPatch- Per-executable CLI argument policy patch.FileConfig- Top-level[run]file config.MountPatch- Mount entry patch.NetworkPolicyPatch- Network policy toggles patch.ProfilePatch- Partial profile configuration merged from defaults, file, and CLI layers.SeccompPolicyPatch- Seccomp policy compilation settings patch.
Enums
BackendKind- Sandbox backend selected for a Run profile.CaTrustMode- How the sandbox CA trust store is assembled for the agent.CapabilitySourcePatch- Source for capability material patch.CommandMediatorHitlMode- Human-in-the-loop mediation mode for governed local execution.SandboxIdentityMode- Identity mode used inside sandboxed execution.SeccompRuntimeMode- Runtime behavior for managed seccomp artifact selection.
firma_config_schema::run::BackendKind
Section titled “firma_config_schema::run::BackendKind”Enum
Sandbox backend selected for a Run profile.
Variants:
BwrapVzWsl2Firecracker
Traits: Copy, Eq
Trait Implementations:
- PartialEq
fn eq(self: &Self, other: &BackendKind) -> bool
- Clone
fn clone(self: &Self) -> BackendKind
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
- Deserialize
fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
- Serialize
fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
firma_config_schema::run::CaTrustMode
Section titled “firma_config_schema::run::CaTrustMode”Enum
How the sandbox CA trust store is assembled for the agent.
Variants:
Sole- Inject only the firma-ca path (current behavior). System roots are notAppendSystemRoots- Inject a bundle of system roots + firma-ca. Needed for agents that talk
Traits: Copy, Eq
Trait Implementations:
- Default
fn default() -> CaTrustMode
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
- Deserialize
fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
- PartialEq
fn eq(self: &Self, other: &CaTrustMode) -> bool
- Serialize
fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
- Clone
fn clone(self: &Self) -> CaTrustMode
firma_config_schema::run::CapabilityLeasePatch
Section titled “firma_config_schema::run::CapabilityLeasePatch”Struct
Capability lease settings patch.
Fields:
source: Option<CapabilitySourcePatch>public_key_path: Option<std::path::PathBuf>refresh_ratio: Option<f64>grace: Option<std::time::Duration>requested_actions: Option<Vec<String>>
Trait Implementations:
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
- Deserialize
fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
- Clone
fn clone(self: &Self) -> CapabilityLeasePatch
firma_config_schema::run::CapabilitySourcePatch
Section titled “firma_config_schema::run::CapabilitySourcePatch”Enum
Source for capability material patch.
Variants:
DisabledFile{ path: std::path::PathBuf }
Trait Implementations:
- Clone
fn clone(self: &Self) -> CapabilitySourcePatch
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
- Deserialize
fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
firma_config_schema::run::CommandMediatorHitlMode
Section titled “firma_config_schema::run::CommandMediatorHitlMode”Enum
Human-in-the-loop mediation mode for governed local execution.
Variants:
SyncWaitAsyncToken
Traits: Copy, Eq
Trait Implementations:
- Deserialize
fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
- PartialEq
fn eq(self: &Self, other: &CommandMediatorHitlMode) -> bool
- Serialize
fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
- Clone
fn clone(self: &Self) -> CommandMediatorHitlMode
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
firma_config_schema::run::CommandMediatorPatch
Section titled “firma_config_schema::run::CommandMediatorPatch”Struct
Runtime command mediation settings patch.
Fields:
endpoint: Option<String>timeout: Option<crate::utils::NonZeroDuration>hitl_mode: Option<CommandMediatorHitlMode>hitl_max_wait: Option<crate::utils::NonZeroDuration>enforce_known_executables: Option<bool>allowed_executables: Option<Vec<std::path::PathBuf>>- Executables allowed when enforcement is enabled.Noneinherits the
Trait Implementations:
- Deserialize
fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
- Clone
fn clone(self: &Self) -> CommandMediatorPatch
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
firma_config_schema::run::ExecutableLaunchPolicyPatch
Section titled “firma_config_schema::run::ExecutableLaunchPolicyPatch”Struct
Per-executable CLI argument policy patch.
Fields:
enforce_wrapper_defaults: Option<bool>sandbox_mode: Option<String>approval_policy: Option<String>config_overrides: Option<std::collections::BTreeMap<String, String>>- Wrapper configuration values.Noneinherits the lower policy, a
Trait Implementations:
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
- Deserialize
fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
- Clone
fn clone(self: &Self) -> ExecutableLaunchPolicyPatch
firma_config_schema::run::FileConfig
Section titled “firma_config_schema::run::FileConfig”Struct
Top-level [run] file config.
Fields:
profile: Option<String>- Profile used byfirma runwhen--profileis not supplied.defaults: ProfilePatchprofiles: std::collections::BTreeMap<String, ProfilePatch>
Trait Implementations:
- Clone
fn clone(self: &Self) -> FileConfig
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
- Default
fn default() -> FileConfig
- Deserialize
fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
firma_config_schema::run::MountPatch
Section titled “firma_config_schema::run::MountPatch”Struct
Mount entry patch.
Fields:
source: std::path::PathBuftarget: std::path::PathBufread_only: bool
Trait Implementations:
- Clone
fn clone(self: &Self) -> MountPatch
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
- Default
fn default() -> MountPatch
- Deserialize
fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
firma_config_schema::run::NetworkPolicyPatch
Section titled “firma_config_schema::run::NetworkPolicyPatch”Struct
Network policy toggles patch.
Fields:
enforce_network_namespace: Option<bool>fail_closed: Option<bool>
Trait Implementations:
- Clone
fn clone(self: &Self) -> NetworkPolicyPatch
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
- Deserialize
fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
firma_config_schema::run::ProfilePatch
Section titled “firma_config_schema::run::ProfilePatch”Struct
Partial profile configuration merged from defaults, file, and CLI layers.
Fields:
backend: Option<BackendKind>- Sandbox backend (bwrap,vz,wsl2, orfirecracker).sidecar_endpoint: Option<String>seccomp_policy: Option<SeccompPolicyPatch>env_passthrough: Option<Vec<String>>- Environment variable names inherited from the host.Noneinherits theenv_set: Option<std::collections::BTreeMap<String, String>>- Fixed environment values.Noneinherits the lower profile layer, amounts: Option<Vec<MountPatch>>- Sandbox mounts.Noneinherits the lower profile layer; a present listnetwork: Option<NetworkPolicyPatch>identity_mode: Option<SandboxIdentityMode>capability: Option<CapabilityLeasePatch>sidecar_local_exec: Option<CommandMediatorPatch>- Preferred governance config path. This routes local tool executionexecutable_policies: Option<std::collections::BTreeMap<String, ExecutableLaunchPolicyPatch>>- Per-executable launch policies.Noneinherits the lower profile layer,use_http_proxy_sidecar: Option<bool>- Configure the autostarted sidecar in HTTP proxy interceptor mode.allow_non_structural: Option<bool>- Allow non-structural (proxy-only) backends to run without failing closed.mask_home_paths: Option<Vec<std::path::PathBuf>>- Home-relative paths to mask with a tmpfs overlay inside the bwrap sandbox.ca_trust_mode: Option<CaTrustMode>- How the sandbox CA trust store is assembled.Noneresolves to thesecret_gateway_addr: Option<String>secret_providers: Option<Vec<crate::secret_provider::SecretProviderPatch>>- Secret providers to activate: bare strings reference a built-in
Trait Implementations:
- Default
fn default() -> ProfilePatch
- Deserialize
fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
- Clone
fn clone(self: &Self) -> ProfilePatch
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
firma_config_schema::run::SandboxIdentityMode
Section titled “firma_config_schema::run::SandboxIdentityMode”Enum
Identity mode used inside sandboxed execution.
Variants:
SandboxUserHostUser
Traits: Eq, Copy
Trait Implementations:
- Serialize
fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
- Clone
fn clone(self: &Self) -> SandboxIdentityMode
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
- Deserialize
fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
- PartialEq
fn eq(self: &Self, other: &SandboxIdentityMode) -> bool
firma_config_schema::run::SeccompPolicyPatch
Section titled “firma_config_schema::run::SeccompPolicyPatch”Struct
Seccomp policy compilation settings patch.
Fields:
source_policy_path: Option<std::path::PathBuf>- Policy source path. Required after all profile layers merge.artifact_dir: Option<std::path::PathBuf>- Managed artifact directory. Required after all profile layers merge.runtime_mode: Option<SeccompRuntimeMode>
Trait Implementations:
- Deserialize
fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
- Clone
fn clone(self: &Self) -> SeccompPolicyPatch
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
firma_config_schema::run::SeccompRuntimeMode
Section titled “firma_config_schema::run::SeccompRuntimeMode”Enum
Runtime behavior for managed seccomp artifact selection.
Variants:
CompileOnLaunch- Compile/update managed seccomp artifacts during launch and then load.PrecompiledOnly- Require a precompiled managed seccomp artifact; do not compile at launch.
Traits: Copy, Eq
Trait Implementations:
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
- Deserialize
fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
- PartialEq
fn eq(self: &Self, other: &SeccompRuntimeMode) -> bool
- Serialize
fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
- Clone
fn clone(self: &Self) -> SeccompRuntimeMode