Skip to main content

Redactor

Struct Redactor 

Source
pub struct Redactor {
    level: RedactionLevel,
    re_aws_key_id: Regex,
    re_secret: Regex,
    re_session: Regex,
    re_presigned: Regex,
    re_account_id: Regex,
    re_bearer: Regex,
    home_dir: Option<String>,
}
Expand description

Compiled redaction patterns.

Construct once with Redactor::new() and reuse across many calls.

Fields§

§level: RedactionLevel§re_aws_key_id: Regex

(AKIA|ASIA|AROA)[A-Z0-9]{16} — AWS access key IDs.

§re_secret: Regex

(?i)(aws_secret_access_key|secret_access_key|secret)\s*=\s*['"]?([A-Za-z0-9/+=]{40})['"]?

§re_session: Regex

(?i)(aws_session_token|session_token)\s*=\s*['"]?([A-Za-z0-9/+=]{100,})['"]?

§re_presigned: Regex

Presigned URLs — everything after ? when X-Amz-Signature is present.

§re_account_id: Regex

12-digit AWS account IDs (only applied at RedactionLevel::Full).

§re_bearer: Regex

Bearer token values.

§home_dir: Option<String>

Actual home-dir prefix at runtime (e.g. /Users/alice).

Implementations§

Source§

impl Redactor

Source

pub fn with_level(level: RedactionLevel) -> Self

Build a Redactor with the given RedactionLevel.

Source

pub fn new() -> Self

Build a Redactor with the default RedactionLevel::Full.

Source

pub fn redact_text(&self, text: &str) -> String

Apply all active patterns to text and return the redacted string.

Patterns are applied in this order so that more-specific matches are replaced before generic ones (e.g. presigned URLs before account IDs):

  1. Presigned URLs (full querystring)
  2. AWS session tokens (longest values first, before secrets)
  3. AWS secret access keys
  4. Bearer tokens
  5. AWS access key IDs
  6. AWS account IDs (Full level only)
Source

pub fn redact_path(&self, path: &str) -> String

Replace $HOME/ and the literal home-dir path prefix with ~/.

If the home directory cannot be determined at runtime, the input is returned unchanged.

Trait Implementations§

Source§

impl Default for Redactor

Source§

fn default() -> Self

Returns the “default value” for a type. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
§

impl<T> NoneValue for T
where T: Default,

§

type NoneType = T

§

fn null_value() -> T

The none-equivalent value.
§

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, 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<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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