philiprehberger-mask
v0.2.3145 downloadsMIT
Data masking and redaction for strings, emails, and sensitive data
$
cargo add philiprehberger-maskREADME
rs-mask
Data masking and redaction for strings, emails, and sensitive data
Installation
[dependencies]
philiprehberger-mask = "0.3.0"
Usage
use philiprehberger_mask::{mask_email, mask_credit_card, mask_partial, MaskedString};
// Mask an email
assert_eq!(mask_email("john@example.com"), "j***@example.com");
// Mask a credit card
assert_eq!(mask_credit_card("4111-1111-1111-1111"), "****-****-****-1111");
// Partial masking
assert_eq!(mask_partial("SSN123456789", 4), "********6789");
// Safe wrapper for logging
let secret = MaskedString::new("my-api-key-123");
println!("{}", secret); // prints "**************"
println!("{:?}", secret); // prints MaskedString("**************")
assert_eq!(secret.reveal(), "my-api-key-123");
// SSN masking
use philiprehberger_mask::mask_ssn;
assert_eq!(mask_ssn("123-45-6789"), "***-**-6789");
// IBAN masking
use philiprehberger_mask::mask_iban;
assert_eq!(mask_iban("GB29NWBK60161331926819"), "GB****************6819");
// From trait
let secret = MaskedString::from("api-key");
JWTs, URL credentials, and partial-start masking
use philiprehberger_mask::{mask_jwt, mask_url_credentials, mask_partial_start};
// JWT — mask all three segments
assert_eq!(
mask_jwt("eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIn0.SflKxwRJSMeKKF2QT4"),
"***.***.***"
);
// URL credentials — preserve scheme/host/path, redact basic auth
assert_eq!(
mask_url_credentials("https://user:secret@db.example.com:5432/app"),
"https://***:***@db.example.com:5432/app"
);
// Keep a recognizable prefix, hide the rest
assert_eq!(mask_partial_start("sk_live_abcdef", 7), "sk_live*******");
API
| Function / Type | Description |
|---|---|
mask_string(s) | Replace all characters with * |
mask_partial(s, show_last) | Mask all but last N characters |
mask_email(s) | Mask email local part |
mask_credit_card(s) | Mask all but last 4 digits |
mask_phone(s) | Mask phone digits except last 4 |
mask_digits(s) | Replace all digits with * |
mask_between(s, start, end) | Mask content between markers |
MaskedString::new(s) | Create a masked wrapper |
.reveal() | Get the real value |
mask_ssn(s) | Mask SSN keeping last 4 digits |
mask_iban(s) | Mask IBAN keeping country code + last 4 |
mask_jwt(s) | Mask all three segments of a JWT token |
mask_url_credentials(s) | Redact basic-auth credentials in a URL |
mask_partial_start(s, show_first) | Keep first N characters, mask the rest |
MaskedString::default() | Create empty masked string |
MaskedString::from(s) | Create from &str or String |
Development
cargo test
cargo clippy -- -D warnings
Support
If you find this project useful: