Skip to main content

AuditLog

Struct AuditLog 

Source
pub struct AuditLog { /* private fields */ }
Expand description

Append-only JSONL audit log with within-session HMAC chain integrity.

The chain key is generated fresh at AuditLog::new() and is held only in memory for the lifetime of this handle. All entries appended through this handle form a verifiable chain via AuditLog::verify_chain(). Entries from prior sessions (different AuditLog instances) have prev_entry_hmac = None and act as chain anchors for the new session.

Implementations§

Source§

impl AuditLog

Source

pub fn new(path: &Path) -> Self

Create a handle to the audit log at path. The file is created lazily on first Self::append.

Source

pub fn append(&self, entry: &AuditEntry) -> SafeResult<()>

Append an entry. The entry’s prev_entry_hmac is set to the HMAC of the previously written entry (within this session), then the entry is written and this handle’s chain state is advanced.

Errors here are non-fatal (caller should .ok() if audit is best-effort).

Source

pub fn verify_chain(&self) -> Result<(), AuditVerifyError>

Verify the HMAC chain for all entries written by this session.

Reads the log file and replays the chain using this session’s key. Entries with prev_entry_hmac = None are treated as chain anchors (session boundaries or pre-v2 entries) — they reset the expected HMAC to None and verification continues from there.

Returns Ok(()) if every non-anchor entry’s prev_entry_hmac matches the HMAC computed from the previous entry. Returns AuditVerifyError::ChainBroken at the first mismatch.

Source

pub fn read(&self, limit: Option<usize>) -> SafeResult<Vec<AuditEntry>>

Read entries, most recent first. Silently skip malformed lines.

Source

pub fn explain(&self, limit: Option<usize>) -> SafeResult<AuditTimeline>

Read and project entries into plaintext-free explanation sessions.

Source

pub fn last_successful_operation( &self, profile: &str, operation: &str, scan_limit: usize, ) -> SafeResult<Option<DateTime<Utc>>>

Most recent successful audit entry for this profile and operation, if any. Entries are scanned newest-first (up to scan_limit lines worth of entries).

Source

pub fn filter_audit( &self, since: Option<DateTime<Utc>>, until: Option<DateTime<Utc>>, command: Option<&str>, ) -> SafeResult<Vec<AuditEntry>>

Return filtered audit entries.

All parameters are optional:

  • since — only entries with timestamp >= since are returned.
  • until — only entries with timestamp <= until are returned.
  • command — only entries whose operation exactly matches this string.

Results are returned newest-first (matching read()).

Source

pub fn prune_audit_before(&self, before: DateTime<Utc>) -> SafeResult<usize>

Remove all audit entries with timestamp < before (i.e. older than the cutoff).

Rewrites the log file atomically. Entries at or after before are kept. Returns the number of entries that were removed.

Note: pruning breaks the HMAC chain because it removes entries; the retained entries’ prev_entry_hmac values become invalid relative to the new session’s key. This is expected — prune is a privileged administrative operation.

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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