Skip to content

audit

Structs

Enums


Struct

Validated audit emitter configuration.

SinkRequired fieldsFilled from the state directory
stdoutnonesigning key
filenonesigning key, file_path
grpcgrpc_url, buffer_pathsigning key
walgrpc_url, wal_pathsigning 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_path was empty.
  • GrpcUrlRequired - grpc sink was selected without a grpc_url.
  • EmptyGrpcUrl - grpc_url was empty.
  • InvalidGrpcUrl(String) - grpc_url was not a valid URI.
  • GrpcUrlMissingScheme(String) - grpc_url had no scheme.
  • GrpcUrlUnsupportedScheme(String) - grpc_url used a scheme the sink cannot dial.
  • GrpcUrlMissingHost(String) - grpc_url had no host.
  • BufferPathRequired - grpc sink was selected without a buffer_path.
  • EmptyBufferPath - buffer_path was empty.
  • WalPathRequired - wal was selected without a journal path.
  • EmptyWalPath - wal_path was empty.
  • SigningKeyMutuallyExclusive - Both signing-key sources were set.
  • EmptySigningKeyPath - signing_key_path was empty.
  • EmptySigningKeyEnv - signing_key_env was 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 one firma config generates 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