Skip to main content

KeyRedactor

Struct KeyRedactor 

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

Redacts values whose key matches a denylist, case-insensitively.

§Examples

use ash_log::*;
use std::sync::Arc;

let logger = ash_logger!(
    backend: Arc::new(NoopAuditBackend),
    redact: Arc::new(KeyRedactor::default().and("session_id")),
);

// `password` is on the default list; `session_id` was added above.
ash_info!(logger, "login"; password = "hunter2", session_id = "abc");

Implementations§

Source§

impl KeyRedactor

Source

pub const DEFAULT_KEYS: &'static [&'static str]

The conventional secret-bearing key names.

Matching is on substrings by default, so api_key, apiKey, and x-api-key are all caught by key.

Source

pub fn new<I, S>(keys: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

A redactor matching exactly keys and nothing else.

Source

pub fn and<S: Into<String>>(self, key: S) -> Self

Add another key to the list.

Source

pub const fn exact(self) -> Self

Require the key to equal a listed name rather than contain it.

Substring matching is the safer default — it catches user_password — but it also catches password_last_changed_at, which is not a secret. Switch to exact matching when the field names are known.

Source

pub fn keys(&self) -> &[String]

The keys this redactor matches, in normalized form.

Separators and case are stripped at construction, so api_key and X-API-Key both appear here as apikey.

Trait Implementations§

Source§

impl Clone for KeyRedactor

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 KeyRedactor

Source§

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

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

impl Default for KeyRedactor

Source§

fn default() -> Self

A redactor loaded with DEFAULT_KEYS.

Source§

impl Redactor for KeyRedactor

Source§

fn redacts(&self, key: &str, _path: &str) -> bool

Whether the value stored under key should be replaced. Read more
Source§

fn redact_event(&self, event: &mut AuditEvent)

Rewrite an event in place. 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.

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