Expand description
Universal PII recognizers for cloakrs.
This crate provides recognizers for email, phone, credit cards, IBAN, IP addresses, URLs, secrets, MAC addresses, hostnames, user home paths, crypto wallet addresses, and dates of birth.
§Examples
use cloakrs_core::EntityType;
let findings = cloakrs_patterns::default_registry().scan_all("email jane@example.com");
assert!(findings.iter().any(|finding| finding.entity_type == EntityType::Email));Structs§
- ApiKey
Recognizer - Recognizes generic API keys and bearer-style tokens with nearby key context.
- AwsAccess
KeyRecognizer - Recognizes AWS access key identifiers with the
AKIAprefix. - Credit
Card Recognizer - Recognizes credit and debit card numbers with Luhn validation.
- Crypto
Address Recognizer - Recognizes common Bitcoin and Ethereum wallet address shapes.
- Date
OfBirth Recognizer - Recognizes dates that are likely dates of birth from nearby birth context.
- Email
Recognizer - Recognizes common email addresses.
- Hostname
Recognizer - Recognizes internal hostnames and machine names that can leak infrastructure.
- Iban
Recognizer - Recognizes International Bank Account Numbers with MOD-97 validation.
- IpAddress
Recognizer - Recognizes IPv4 and IPv6 addresses.
- JwtRecognizer
- Recognizes JSON Web Tokens in
header.payload.signatureform. - MacAddress
Recognizer - Recognizes MAC addresses in common colon, hyphen, and dotted forms.
- Phone
Recognizer - Recognizes common international and North American phone numbers.
- SsnRecognizer
- Recognizes United States Social Security Numbers.
- UrlRecognizer
- Recognizes HTTP, HTTPS, FTP, and
www.URLs. - User
Path Recognizer - Recognizes home-directory paths that expose system usernames.
Enums§
- Card
Brand - Known payment card brand families.
Functions§
- card_
brand - Identifies common payment card brand families from card digits.
- default_
registry - Builds a registry containing the Sprint 2 universal recognizers.
- iban_
country_ length - Returns the expected IBAN length for supported countries.
- iban_
mod97_ valid - Returns true when an IBAN passes ISO 13616 MOD-97 validation.
- luhn_
valid - Returns true when the supplied digits pass the Luhn checksum.
- register_
default_ recognizers - Registers the Sprint 2 recognizers into an existing registry.
- version
- Returns the crate version.