audit
Module: config::audit
Section titled “Module: config::audit”Contents
Section titled “Contents”Structs
AuditConfig- Validated audit emitter configuration.
Enums
AuditConfigError- Error validating an [AuditConfig].AuditSigningKey- Where the audit event-signing key comes from, after state-directory
firma_sidecar::config::audit::AuditConfig
Section titled “firma_sidecar::config::audit::AuditConfig”Struct
Validated audit emitter configuration.
| Sink | Required fields | Filled from the state directory |
|---|---|---|
stdout | none | signing key |
file | none | signing key, file_path |
grpc | grpc_url, buffer_path | signing key |
wal | grpc_url, wal_path | signing key |
Every path here is already resolved: this type is only ever built by
SidecarConfig::resolve, which
fills in the state-directory defaults for whatever the config left unset.
buffer_path is the exception: the grpc sink is durable, so the operator
has to say where it buffers.
Trait Implementations:
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
- Clone
fn clone(self: &Self) -> Self
firma_sidecar::config::audit::AuditConfigError
Section titled “firma_sidecar::config::audit::AuditConfigError”Enum
Error validating an [AuditConfig].
Variants:
RuntimeGrpcUnsupported- Legacy buffering cannot preserve runtime execution provenance.EmptyFilePath-file_pathwas empty.GrpcUrlRequired-grpcsink was selected without agrpc_url.EmptyGrpcUrl-grpc_urlwas empty.InvalidGrpcUrl(String)-grpc_urlwas not a valid URI.GrpcUrlMissingScheme(String)-grpc_urlhad no scheme.GrpcUrlUnsupportedScheme(String)-grpc_urlused a scheme the sink cannot dial.GrpcUrlMissingHost(String)-grpc_urlhad no host.BufferPathRequired-grpcsink was selected without abuffer_path.EmptyBufferPath-buffer_pathwas empty.WalPathRequired-walwas selected without a journal path.EmptyWalPath-wal_pathwas empty.SigningKeyMutuallyExclusive- Both signing-key sources were set.EmptySigningKeyPath-signing_key_pathwas empty.EmptySigningKeyEnv-signing_key_envwas empty.
Traits: Error, Eq
Trait Implementations:
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result
- Display
fn fmt(self: &Self, __formatter: & mut ::core::fmt::Formatter) -> ::core::fmt::Result
- Clone
fn clone(self: &Self) -> Self
- PartialEq
fn eq(self: &Self, other: &Self) -> bool
firma_sidecar::config::audit::AuditSigningKey
Section titled “firma_sidecar::config::audit::AuditSigningKey”Enum
Where the audit event-signing key comes from, after state-directory resolution.
The variant is what tells a startup failure how to phrase its remedy:
“run firma config” is the right advice for a path nobody chose, and the
wrong advice for one the operator pinned.
Variants:
Env(String)-audit.signing_key_env: the PEM is the value of this variable.Path(std::path::PathBuf)-audit.signing_key_path: the operator pinned this file.StateDefault(std::path::PathBuf)- Neither was set, so the key is the onefirma configgenerates in the
Traits: Eq
Trait Implementations:
- Clone
fn clone(self: &Self) -> Self
- PartialEq
fn eq(self: &Self, other: &Self) -> bool
- Debug
fn fmt(self: &Self, f: & mut $crate::fmt::Formatter) -> $crate::fmt::Result