Skip to main content

Crate redactkit

Crate redactkit 

Source
Expand description

§redactkit

Small toolkit for redacting sensitive data in debug output and tracing logs.

Warning: redactkit redacts formatted output only. It does not modify or erase original field values in memory.

§Features

FeatureDefaultDescription
stdyesStandard library support.
deriveyesEnables the RedactDebug derive macro.
regexnoEnables regex-based field and value rules.
tracingnoEnables tracing-subscriber field redaction.

§Derive example

use redactkit::RedactDebug;

#[derive(RedactDebug)]
struct User {
    username: String,
    #[redact]
    password: String,
}

let user = User {
    username: "anna".to_string(),
    password: "s3cr3t".to_string(),
};

assert_eq!(
    format!("{user:?}"),
    "User { username: \"anna\", password: \"******\" }"
);

§Builder example

use redactkit::Redactor;

let redactor = Redactor::builder()
    .field("password")
    .field("token")
    .mask("[hidden]")
    .build();

assert_eq!(redactor.redact_field("password", "secret"), "[hidden]");
assert_eq!(redactor.redact_field("username", "anna"), "anna");

§Default redactor

let redactor = redactkit::default_redactor();

assert_eq!(redactor.redact_field("password", "secret"), "******");
assert_eq!(redactor.redact_field("api_key", "abc123"), "******");

§Regex rules

use redactkit::Redactor;

let redactor = Redactor::builder()
    .field_pattern("(?i)token|secret")
    .unwrap()
    .value_pattern(r"\d{4}", "****")
    .unwrap()
    .build();

assert_eq!(redactor.redact_field("api_token", "abcd"), "******");
assert_eq!(redactor.redact_field("note", "card 1234"), "card ****");

§Tracing integration

use tracing_subscriber::fmt;

fmt()
    .fmt_fields(redactkit::tracing::redact_fields())
    .init();

Re-exports§

pub use builder::RedactorBuilder;
pub use error::Error;
pub use redactor::Redactor;
pub use redactor::default_redactor;

Modules§

builder
Builder for Redactor.
error
Errors returned by redactkit.
patterns
redactor

Derive Macros§

RedactDebug
Derives Debug for structs, redacting fields marked with #[redact].