use crate::builder::RedactorBuilder;
use crate::patterns::DEFAULT_SENSITIVE_FIELDS;
#[derive(Debug, Clone)]
pub struct Redactor {
pub(crate) fields: Vec<String>,
pub(crate) mask: String,
#[cfg(feature = "regex")]
pub(crate) field_patterns: Vec<regex::Regex>,
#[cfg(feature = "regex")]
pub(crate) value_patterns: Vec<(regex::Regex, String)>,
}
impl Redactor {
pub fn builder() -> RedactorBuilder {
RedactorBuilder::new()
}
pub fn should_redact_field(&self, field: &str) -> bool {
if self.fields.iter().any(|name| name == field) {
return true;
}
#[cfg(feature = "regex")]
{
if self.field_patterns.iter().any(|re| re.is_match(field)) {
return true;
}
}
false
}
pub fn redact_field(&self, field: &str, value: &str) -> String {
if self.should_redact_field(field) {
return self.mask.clone();
}
#[cfg_attr(not(feature = "regex"), allow(unused_mut))]
let mut result = value.to_string();
#[cfg(feature = "regex")]
{
for (re, replacement) in &self.value_patterns {
result = re.replace_all(&result, replacement.as_str()).into_owned();
}
}
result
}
pub fn redact_value(&self, _value: &str) -> String {
self.mask.clone()
}
}
pub fn default_redactor() -> Redactor {
Redactor::builder()
.fields(DEFAULT_SENSITIVE_FIELDS.iter().copied())
.build()
}
impl Default for Redactor {
fn default() -> Self {
default_redactor()
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn redacts_exact_field_name() {
let redactor = Redactor::builder().field("password").build();
assert!(redactor.should_redact_field("password"));
assert!(!redactor.should_redact_field("username"));
}
#[test]
fn redact_field_returns_mask_for_sensitive_field() {
let redactor = Redactor::builder().field("password").build();
assert_eq!(redactor.redact_field("password", "s3cr3t"), "******");
}
#[test]
fn redact_field_returns_original_for_non_sensitive_field() {
let redactor = Redactor::builder().field("password").build();
assert_eq!(redactor.redact_field("username", "anna"), "anna");
}
#[test]
fn supports_multiple_fields() {
let redactor = Redactor::builder().fields(["password", "token"]).build();
assert!(redactor.should_redact_field("password"));
assert!(redactor.should_redact_field("token"));
assert!(!redactor.should_redact_field("username"));
}
#[test]
fn custom_mask_can_be_used() {
let redactor = Redactor::builder()
.field("password")
.mask("[hidden]")
.build();
assert_eq!(redactor.redact_field("password", "s3cr3t"), "[hidden]");
}
#[test]
fn redact_value_always_returns_mask() {
let redactor = Redactor::builder().field("password").build();
assert_eq!(redactor.redact_value("anything"), "******");
}
#[test]
fn field_matching_is_case_sensitive_for_now() {
let redactor = Redactor::builder().field("password").build();
assert!(redactor.should_redact_field("password"));
assert!(!redactor.should_redact_field("PASSWORD"));
assert!(!redactor.should_redact_field("Password"));
}
#[test]
fn default_redactor_redacts_common_fields() {
let redactor = default_redactor();
assert!(redactor.should_redact_field("password"));
assert!(redactor.should_redact_field("passwd"));
assert!(redactor.should_redact_field("secret"));
assert!(redactor.should_redact_field("token"));
assert!(redactor.should_redact_field("access_token"));
assert!(redactor.should_redact_field("refresh_token"));
assert!(redactor.should_redact_field("api_key"));
assert!(redactor.should_redact_field("apikey"));
assert!(redactor.should_redact_field("authorization"));
assert!(redactor.should_redact_field("private_key"));
assert!(redactor.should_redact_field("client_secret"));
assert!(redactor.should_redact_field("database_url"));
}
#[test]
fn default_redactor_does_not_redact_random_fields() {
let redactor = default_redactor();
assert!(!redactor.should_redact_field("username"));
assert!(!redactor.should_redact_field("email"));
assert!(!redactor.should_redact_field("host"));
assert!(!redactor.should_redact_field("port"));
}
#[test]
fn default_redactor_masks_values() {
let redactor = default_redactor();
assert_eq!(redactor.redact_field("password", "s3cr3t"), "******");
assert_eq!(redactor.redact_field("username", "anna"), "anna");
}
#[test]
fn redactor_default_is_same_as_default_redactor() {
let from_default = Redactor::default();
let from_function = default_redactor();
assert!(from_default.should_redact_field("password"));
assert!(from_function.should_redact_field("password"));
}
}