Skip to main content

AuditConfig

Struct AuditConfig 

Source
pub struct AuditConfig {
Show 14 fields pub enabled: bool, pub log_path: String, pub signed: bool, pub integrity_key: Option<SecretRef>, pub rotation_policy: RotationPolicy, pub max_file_size: u64, pub retention_count: u32, pub log_to_db: bool, pub overflow_policy: OverflowPolicy, pub max_rows: Option<u64>, pub alarm_threshold: u32, pub alarm_action: String, pub auditable_events: Vec<String>, pub rotation_check_interval_secs: Option<u64>,
}
Expand description

[audit] section — audit trail configuration.

[audit]
enabled = true
log_path = "/var/log/kipuka/audit.log"
signed = true
rotation_policy = "daily"
overflow_policy = "halt"
max_rows = 1000000

Fields§

§enabled: bool

Enable audit logging. Default: true.

§log_path: String

Path to the audit log file.

When using database-backed audit (log_to_db = true), this path is used for the file-based backup copy.

§signed: bool

Enable keyed (HMAC) integrity protection of the audit hash chain.

Every audit row stores record_hash = H(prev_hash || record_bytes), forming a tamper-evident chain (NIAP CA PP FAU_STG.1). When signed is false (the default), H is plain SHA-256 — this detects in-place edits, deletions, and reordering as long as the chain head is anchored out-of-band. When signed is true, H is HMAC-SHA256 keyed by integrity_key, which additionally prevents an attacker who can write to the database from forging a valid chain.

§integrity_key: Option<SecretRef>

Secret reference for the HMAC integrity key (required when signed = true).

Resolved at startup via the standard SecretRef backends (env:, file:, keyring:, systemd-creds:). Never store the raw key inline in the config file.

§rotation_policy: RotationPolicy

Log rotation policy.

§max_file_size: u64

Maximum rotation file size in bytes (when rotation_policy = "size"). Default: 100 MiB.

§retention_count: u32

Number of rotated log files to retain. Default: 10.

§log_to_db: bool

Store audit events in the database in addition to the log file.

§overflow_policy: OverflowPolicy

Overflow policy when audit storage is full (FAU_STG.4).

§max_rows: Option<u64>

Maximum number of audit rows in the database.

When this limit is reached, the overflow_policy determines whether old rows are dropped or EST operations are halted. None means no limit (rely on disk space monitoring).

§alarm_threshold: u32

Number of consecutive security violations before the alarm action fires (FAU_ARP.1).

Default: 10.

§alarm_action: String

Action taken when the alarm threshold is reached.

  • "syslog" — emit a syslog alert.
  • "halt" — halt EST operations.

Default: "syslog".

§auditable_events: Vec<String>

NIAP CA PP FAU_GEN.1: list of auditable event types.

When non-empty, only these event types are recorded. When empty (default), all events are audited.

§rotation_check_interval_secs: Option<u64>

Override the interval (in seconds) between rotation checks.

When None (the default), the interval is derived from the rotation_policy: 3600s for size, 86400s for daily/weekly.

Implementations§

Source§

impl AuditConfig

Source

pub fn validate(&self) -> Result<(), String>

Validate audit configuration constraints.

Trait Implementations§

Source§

impl Clone for AuditConfig

Source§

fn clone(&self) -> AuditConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for AuditConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for AuditConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AuditConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,