Skip to content

sidecar

Modules

  • audit - Schema for [sidecar.audit].
  • authority - Schema for [sidecar.authority] and its [sidecar.authority.credentials].
  • capability_seed - Schema for [sidecar.capability_seed].
  • connector - Schema for [sidecar.connector].
  • enforcement - Schema for the enforcement-engine sections of [sidecar].
  • infra - Schema for the sidecar’s top-level infrastructure sections:
  • interceptor - Schema for [sidecar.interceptor] and its sub-tables.
  • local_exec - Schema for [sidecar.local_exec].
  • revocation - Schema for [sidecar.revocation].
  • tenancy - Schema for [sidecar.tenancy].

Structs

  • SidecarConfig - Top-level sidecar configuration, deserialized from the [sidecar] section

firma_config_schema::sidecar::SidecarConfig

Section titled “firma_config_schema::sidecar::SidecarConfig”

Struct

Top-level sidecar configuration, deserialized from the [sidecar] section of firma.toml.

Contains both infrastructure settings (interceptor, policy, CA, credentials) and enforcement-engine settings (mapping, capability validation, constraint enforcement).

Fields:

  • mode: SidecarMode - Enforcement mode: "enforce" (default) or "monitor".
  • interceptor: InterceptorConfig - Interceptor settings (mode, listen address or socket path, drain
  • policy: PolicyConfig - Policy directory.
  • ca: CaConfig - Certificate authority directory.
  • credentials: std::collections::HashMap<String, CredentialConfig> - Per-target credential injection entries, keyed by an arbitrary label
  • connector: ConnectorConfig - Outbound connector settings (default timeout + per-host overrides with
  • authority: AuthorityConfig - Background Authority stream client tuning.
  • mapping: MappingConfig - Intent normalization / mapping rules.
  • capability_validation: CapabilityValidationConfig - Capability validation settings.
  • constraint_enforcement: ConstraintEnforcementConfig - Constraint enforcement settings.
  • revocation: RevocationConfig - Revocation cache settings (bloom filter + LRU sizing).
  • capability_seed: CapabilitySeedConfig - Static capability provisioning seed files.
  • audit: AuditConfig - Audit event emitter settings.
  • local_exec: Option<LocalExecConfig> - Local-exec governance endpoint configuration. When absent, the
  • tenancy: TenancyConfig - Tenancy settings (agent isolation mode).
  • http_secret_providers: Vec<crate::secret_provider::http::HttpSecretProviderConfig> - HTTP secret-provider registry for MITM interception.
  • secret_gateway: crate::gateway::GatewayConfig - Secret-gateway client tuning.

Trait Implementations:

  • 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
  • Deserialize
    • fn deserialize<__D>(__deserializer: __D) -> _serde::__private228::Result<Self, <__D as >::Error>
  • Default
    • fn default() -> SidecarConfig
  • Clone
    • fn clone(self: &Self) -> SidecarConfig

Schema for [sidecar.audit].

Representation only. firma-sidecar validates the sink-specific required fields and the signing-key source.

Schema for [sidecar.authority] and its [sidecar.authority.credentials].

Schema value types own intrinsic invariants. firma-sidecar validates cross-field constraints, parses the url into an endpoint, and resolves the pre-shared-key source.

Schema for [sidecar.capability_seed].

Representation only. Lists pre-issued capability seed files the sidecar loads at startup. firma-sidecar validates that no path is empty.

Schema for [sidecar.connector].

Describes the default dispatch timeout applied to unconfigured hosts and the per-host overrides. Schema value types own intrinsic invariants; firma-sidecar validates rate limits, host names, and duplicate hosts.

Schema for the enforcement-engine sections of [sidecar].

Representation only. These sections are flattened at the top level of the sidecar config ([sidecar.mapping], [sidecar.capability_validation], [sidecar.constraint_enforcement]). firma-sidecar validates them and re-bases the mapping paths.

Schema for the sidecar’s top-level infrastructure sections: sidecar.mode, [sidecar.policy], [sidecar.ca], and [sidecar.credentials.*].

Representation only. firma-sidecar validates these values and parses them into its own configuration types (for example, the credential header parses into an http::HeaderName).

Schema for [sidecar.interceptor] and its sub-tables.

Schema value types own intrinsic invariants. firma-sidecar validates cross-field constraints and parses these values into its own interceptor configuration types.

Schema for [sidecar.local_exec].

When present, the sidecar binds a UDS endpoint that firma-run clients contact for pre-execution governance decisions. Schema value types own intrinsic invariants; firma-sidecar validates the absolute socket path and constraints imposed by the millisecond wire representation.

Schema for [sidecar.revocation].

Representation only. firma-sidecar validates these values (capacity and LRU size must be non-zero; the false-positive rate must fall in (0, 1)) and builds its revocation store configuration from them.

Schema for [sidecar.tenancy].

Representation only. The sidecar partitions state across agents; V1 enforces a one-sidecar-one-agent invariant.