Struct AuditLog 

pub struct AuditLog { /* private fields */ }

Audit log for recording and verifying security events.

Implementations

impl AuditLog

pub fn open(path: impl AsRef<Path>, runtime_key: KeyPair) -> AuditResult<Self>

Create a new audit log with SurrealKV persistence.

Errors

Returns an error if the storage backend fails to open at the given path.

pub fn in_memory(runtime_key: KeyPair) -> Self

Create an in-memory audit log (for testing).

pub fn append( &self, session_id: SessionId, action: AuditAction, authorization: AuthorizationProof, outcome: AuditOutcome, ) -> AuditResult<AuditEntryId>

Append a new audit entry.

Errors

Returns an error if the entry cannot be stored or the chain head cannot be updated.

pub fn append_with_principal( &self, session_id: SessionId, principal: PrincipalId, action: AuditAction, authorization: AuthorizationProof, outcome: AuditOutcome, ) -> AuditResult<AuditEntryId>

Append a new audit entry tagged with the acting principal.

Use this when the action was performed on behalf of a specific user (e.g., cross-principal KV write, tool execution). The principal is included in the cryptographic signing data.

Errors

Returns an error if the entry cannot be stored or the chain head cannot be updated.

pub fn get(&self, id: &AuditEntryId) -> AuditResult<Option<AuditEntry>>

Get an entry by ID.

Errors

Returns an error if the storage backend fails to retrieve the entry.

pub fn get_session_entries( &self, session_id: &SessionId, ) -> AuditResult<Vec<AuditEntry>>

Get all entries for a session.

Errors

Returns an error if the storage backend fails to retrieve entries.

pub fn verify_chain( &self, session_id: &SessionId, ) -> AuditResult<ChainVerificationResult>

Verify the integrity of all audit chains in a session.

Each principal (and the system chain) is verified independently. A session with entries from principals “alice” and “bob” plus system entries will verify three independent chains.

Errors

Returns an error if entries cannot be retrieved from storage.

pub fn verify_principal_chain( &self, session_id: &SessionId, principal: Option<&PrincipalId>, ) -> AuditResult<ChainVerificationResult>

Verify the integrity of a single principal’s chain within a session.

Pass None to verify the system chain (entries without a principal).

Errors

Returns an error if entries cannot be retrieved from storage.

pub fn get_principal_entries( &self, session_id: &SessionId, principal: Option<&PrincipalId>, ) -> AuditResult<Vec<AuditEntry>>

Get entries for a specific principal within a session.

Pass None to get system entries (no principal).

Errors

Returns an error if entries cannot be retrieved from storage.

pub fn verify_all( &self, ) -> AuditResult<Vec<(SessionId, ChainVerificationResult)>>

Verify the entire audit log (all sessions).

Errors

Returns an error if sessions cannot be listed or verified.

pub fn count(&self) -> AuditResult<usize>

Count total entries.

Errors

Returns an error if the storage backend fails.

pub fn count_session(&self, session_id: &SessionId) -> AuditResult<usize>

Count entries for a session.

Errors

Returns an error if the storage backend fails.

pub fn list_sessions(&self) -> AuditResult<Vec<SessionId>>

List all sessions.

Errors

Returns an error if the storage backend fails.

pub fn flush(&self) -> AuditResult<()>

Flush pending writes.

Errors

Returns an error if the storage backend fails to flush.

pub fn runtime_public_key(&self) -> PublicKey

Get the runtime public key.

Trait Implementations

impl Debug for AuditLog

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

Formats the value using the given formatter.