Struct DataMasker 

pub struct DataMasker { /* private fields */ }

Data masking utility for sensitive information protection.

The DataMasker struct provides functionality to detect and mask sensitive data in log messages and JSON structures. It uses a combination of pattern matching and field name detection to identify sensitive information.

Features

• Pattern-based masking: Detects sensitive data by regex patterns (emails, phones, etc.)
• Field name detection: Identifies sensitive fields by name (password, api_key, etc.)
• Nested structure support: Recursively processes nested JSON objects and arrays
• Customizable rules: Supports multiple mask rules with configurable patterns

Sensitive Field Detection

The following field name patterns are automatically detected as sensitive:

• Authentication: password, token, secret, credential, auth
• API Keys: api_key, api_secret, access_key, secret_key
• Encryption: encryption_key, decryption_key, private_key
• OAuth: oauth, oauth_token, bearer_token, jwt
• AWS: aws_secret, aws_key, aws_credentials
• Payment: credit_card, card_number, cvv, ssn

Pattern-based Detection

In addition to field names, the following patterns are detected:

• Email addresses (partial masking: ***@***.***)
• Phone numbers (last 4 digits shown: 138****5678)
• ID card numbers (partial masking)
• Bank card numbers (partial masking)
• JWT tokens
• AWS access keys
• Generic API keys

Example

use inklog::masking::DataMasker;

let masker = DataMasker::new();

// Mask by pattern
let mut email = serde_json::json!("user@example.com");
masker.mask_value(&mut email);
assert_eq!(email, serde_json::json!("***@***.***"));

// Detect sensitive fields
assert!(DataMasker::is_sensitive_field("password"));
assert!(DataMasker::is_sensitive_field("api_key"));
assert!(!DataMasker::is_sensitive_field("message"));

Thread Safety

DataMasker is immutable and can be safely shared between threads.

Implementations

impl DataMasker

pub fn new() -> Self

pub fn is_sensitive_field(field_name: &str) -> bool

检查字段名是否为敏感字段（大小写不敏感，使用词边界正则避免误判）

例如：

• "cakey" 不会匹配 "key"（避免误判）
• "polygon" 不会匹配 "gon"（避免误判）
• "password" 会匹配（正确检测）

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

pub fn mask_value(&self, value: &mut Value)

pub fn mask_hashmap(&self, map: &mut HashMap<String, Value>)

Trait Implementations

impl Clone for DataMasker

fn clone(&self) -> DataMasker

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DataMasker

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

Formats the value using the given formatter.

impl Default for DataMasker

fn default() -> DataMasker

Returns the “default value” for a type.