Skip to content

config

Structs

Enums

Functions


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 not
  • AppendSystemRoots - Inject a bundle of system roots + firma-ca. Needed for agents that talk

Traits: Copy, Eq

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> CaTrustMode
  • 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>

Struct

Capability lease refresh settings.

Fields:

  • source: CapabilitySource
  • public_key_path: Option<std::path::PathBuf> - Raw Ed25519 public key used to verify Authority-issued capabilities.
  • refresh_ratio: f64
  • grace_seconds: u64
  • requested_actions: Vec<String> - Action classes the auto-minted per-session token requests. Defaults to

Methods:

  • fn default_requested_actions() -> Vec<String> - Fallback action set when a profile does not set requested_actions.

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> CapabilityLeaseConfig
  • PartialEq
    • fn eq(self: &Self, other: &CapabilityLeaseConfig) -> bool
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>

Enum

Source for capability material.

Variants:

  • Disabled
  • File{ path: std::path::PathBuf }

Traits: Eq

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> CapabilitySource
  • PartialEq
    • fn eq(self: &Self, other: &CapabilitySource) -> bool
  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

Struct

Runtime command mediation settings for governed local execution.

Traits: Eq

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> CommandMediatorConfig
  • PartialEq
    • fn eq(self: &Self, other: &CommandMediatorConfig) -> bool
  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

firma_run::config::CommandMediatorEndpoint

Section titled “firma_run::config::CommandMediatorEndpoint”

Enum

Variants:

  • Tcp{ addr: std::net::SocketAddr }
  • Unix{ path: std::path::PathBuf }

Traits: Eq

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> CommandMediatorEndpoint
  • PartialEq
    • fn eq(self: &Self, other: &CommandMediatorEndpoint) -> bool
  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

firma_run::config::CommandMediatorHitlMode

Section titled “firma_run::config::CommandMediatorHitlMode”

Enum

Variants:

  • SyncWait
  • AsyncToken

Traits: Eq, Copy

Trait Implementations:

  • 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
  • Deserialize
    • fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>

Struct

Per-executable CLI argument policy injected by firma run.

Traits: Eq

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> ExecutableLaunchPolicy
  • PartialEq
    • fn eq(self: &Self, other: &ExecutableLaunchPolicy) -> bool
  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

Struct

Mount entry passed to sandbox backends.

Traits: Eq

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> MountSpec
  • PartialEq
    • fn eq(self: &Self, other: &MountSpec) -> bool
  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

Struct

Network policy toggles used by backend implementations.

Fields:

  • enforce_network_namespace: bool
  • fail_closed: bool

Traits: Eq

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> NetworkPolicy
  • PartialEq
    • fn eq(self: &Self, other: &NetworkPolicy) -> bool
  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

Struct

Resolved runtime profile after combining built-in defaults, optional file config, and CLI overrides.

Fields:

  • id: String
  • backend: crate::backend::BackendKind
  • env_passthrough: std::collections::BTreeSet<String>
  • env_set: std::collections::BTreeMap<String, String>
  • capability: CapabilityLeaseConfig

Trait Implementations:

  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
  • Clone
    • fn clone(self: &Self) -> ResolvedProfile
  • PartialEq
    • fn eq(self: &Self, other: &ResolvedProfile) -> bool
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

Enum

Identity mode used inside sandboxed execution.

Variants:

  • SandboxUser
  • HostUser

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

Struct

Seccomp policy compilation settings for Linux bwrap backend.

Traits: Eq

Trait Implementations:

  • Clone
    • fn clone(self: &Self) -> SeccompPolicyConfig
  • PartialEq
    • fn eq(self: &Self, other: &SeccompPolicyConfig) -> bool
  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

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

Enum

Sidecar endpoint form used by the wrapper.

Variants:

  • Tcp{ addr: std::net::SocketAddr }
  • Unix{ path: std::path::PathBuf }

Methods:

  • fn proxy_url(self: &Self) -> Option<String> - Returns the HTTP proxy URL when represented as TCP endpoint.

Traits: Eq

Trait Implementations:

  • FromStr
    • fn from_str(value: &str) -> Result<Self, <Self as >::Err>
  • Clone
    • fn clone(self: &Self) -> SidecarEndpoint
  • PartialEq
    • fn eq(self: &Self, other: &SidecarEndpoint) -> bool
  • Serialize
    • fn serialize<__S>(self: &Self, __serializer: __S) -> _serde::__private228::Result<<__S as >::Ok, <__S as >::Error>
  • Debug
    • fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result

firma_run::config::read_configured_profile

Section titled “firma_run::config::read_configured_profile”

Function

Read [run].profile from firma.toml, if present.

Returns an error when the file cannot be read or the [run] section cannot be parsed as FileConfig.

fn read_configured_profile(path: &std::path::Path) -> Result<Option<String>, crate::error::RunError>

Function

Resolve profile configuration for a run invocation.

Returns an error when profile resolution fails due to invalid inputs, parse errors, or resulting validation failures.

fn resolve_profile(args: &crate::runtime::RunInput) -> Result<ResolvedProfile, crate::error::RunError>