Skip to main content

AuditEvent

Struct AuditEvent 

Source
pub struct AuditEvent {
Show 14 fields pub timestamp: SystemTime, pub event_type: AuditEventType, pub correlation_id: Option<String>, pub remote_addr: Option<SocketAddr>, pub principal: Option<String>, pub method: Option<String>, pub result: AuditResult, pub severity: AuditSeverity, pub metadata: HashMap<String, Value>, pub params: Option<Value>, pub error: Option<String>, pub message: Option<String>, pub provenance: Provenance, pub hlc: Option<EventClock>,
}
Expand description

A security audit event representing a significant action or decision

Fields§

§timestamp: SystemTime

Precise timestamp with nanosecond precision

§event_type: AuditEventType

Type of audit event

§correlation_id: Option<String>

Unique correlation ID spanning the request chain

§remote_addr: Option<SocketAddr>

Remote address of the client

§principal: Option<String>

Principal identifier (user ID, API key, certificate DN, etc.)

§method: Option<String>

Method or action being performed

§result: AuditResult

Result of the action

§severity: AuditSeverity

Event severity level

§metadata: HashMap<String, Value>

Additional context and metadata

§params: Option<Value>

Request parameters (sanitized)

§error: Option<String>

Error message if result is Failure or Denied

§message: Option<String>

Human-readable message.

Primarily carried by AuditEventType::Diagnostic records. It is part of the canonical form, so it is covered by any integrity mechanism.

§provenance: Provenance

Where the event was emitted from.

Part of the canonical form, so provenance is covered by any integrity mechanism: it can be proved, not merely recorded.

§hlc: Option<EventClock>

Monotonic causal timestamp, when the logger was given a clock.

timestamp comes from the system clock and can move backwards; this cannot. It is part of the canonical form, so the causal ordering is covered by the integrity mechanism. Absent unless the hlc feature is enabled and a clock is configured, and skipped when absent, so events written without it canonicalize exactly as before.

Implementations§

Source§

impl AuditEvent

Source

pub fn diagnostic<S: Into<String>>(message: S) -> AuditEventBuilder

Start building a diagnostic log record.

Pre-sets AuditEventType::Diagnostic, AuditResult::NotApplicable, and the message, so a message-shaped log line does not have to invent a security classification it does not have. The default severity is AuditSeverity::Info; set an explicit level with severity.

Diagnostic records are subject to level filtering, unlike every other event type.

let event = AuditEvent::diagnostic("cache warm complete")
    .severity(AuditSeverity::Debug)
    .build();

assert_eq!(event.event_type, AuditEventType::Diagnostic);
assert!(!event.event_type.is_security_relevant());
assert_eq!(event.message.as_deref(), Some("cache warm complete"));
Source

pub fn builder() -> AuditEventBuilder

Create a new audit event builder

Source

pub fn add_metadata<K: Into<String>, V: Into<Value>>( &mut self, key: K, value: V, )

Add a metadata entry

Source

pub fn with_correlation_id(self, correlation_id: Option<String>) -> Self

Set the correlation ID from a request

Source

pub fn with_principal<S: Into<String>>(self, principal: S) -> Self

Set the principal from connection context

Source

pub fn with_remote_addr(self, addr: SocketAddr) -> Self

Set the remote address

Trait Implementations§

Source§

impl Clone for AuditEvent

Source§

fn clone(&self) -> Self

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 AuditEvent

Source§

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

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

impl<'de> Deserialize<'de> for AuditEvent

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for AuditEvent

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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