Library rules are the built-in patterns that Atatus maintains for you. They cover formats that are the same for everyone, such as payment card numbers and email addresses, so you do not have to write and maintain the regular expressions yourself.

To use one, open a scanning group, select Add Rule, choose Library Rules, and pick the rules you want. You then choose the match action and any extra tags.

Note:

Library rule patterns are managed by Atatus and cannot be edited. If you need a variation on one, create a custom rule instead.


What is included

There are 35 library rules across four categories:

Category Rules What it covers
Credit card and banking 24 Visa, MasterCard, American Express, Discover, JCB, Maestro, Diners, and IBAN.
Personally identifiable information 7 Email addresses, phone numbers, national identifiers, passports, ZIP codes, and vehicle identification numbers.
Secrets and credentials 2 JSON Web Tokens and Bearer tokens.
Network and device information 2 HTTP Basic and Digest authentication headers.

Why there are several rules per card brand

Card numbers appear in different groupings depending on how the application formatted them. A Visa number might arrive as 4111111111111111, 4111 1111 1111 1111, or 41111111 11111111. Each grouping needs its own pattern, which is why you see rules such as Visa Card Scanner (4x4 digits) and Visa Card Scanner (2x8 digits).

Enable every variant for a brand you care about. Enabling only one leaves the other formats unmasked.

Tip:

Card rules use keyword proximity by default, with keywords such as credit, card, cvv, and the brand names. That keeps them from matching every long number in your logs. See Keywords and proximity if you need to adjust the behavior.


Rule catalog

The Priority column is the default triage label Atatus assigns to each rule. You can change it when you add the rule to a group.

Personally identifiable information

Rule Priority Tags Example match
Standard E-mail Address Medium sensitive_data:email_address
sensitive_data_category:pii
simple@example.com
Phone Number High sensitive_data:phone_number
sensitive_data_category:pii
+1 555-123-4567
UK National Insurance Number High sensitive_data:uk_nin
sensitive_data_category:pii
AB123456C
US Passport High sensitive_data:passport_number
sensitive_data_category:pii
E00007734
Canadian Social Insurancea Number Scanner High sensitive_data:canadian_sin
sensitive_data_category:pii
123-456-789
ZipCode Low sensitive_data:zip_code
sensitive_data_category:pii
12345
US Vehicle Identification Number High sensitive_data:vin
sensitive_data_category:pii
1HGBH41JXMN109186

Credit card and banking

Rule Priority Tags Example match
Visa Card Critical sensitive_data:visa_credit_card
sensitive_data_category:credit_card
4111111111111111
Visa Card Scanner (2x8 digits) Critical sensitive_data:visa_credit_card
sensitive_data_category:credit_card
41111111 11111111
Visa Card Scanner (4x4 digits) Critical sensitive_data:visa_credit_card
sensitive_data_category:credit_card
4111 1111 1111 1111
Visa Card Scanner (1x15 & 1x16 & 1x19 digits) Critical sensitive_data:visa_credit_card
sensitive_data_category:credit_card
4111111111111111
American Express Card(4+4+4+3 digits) Critical sensitive_data:american_express_credit_card
sensitive_data_category:credit_card
3782 8224 6310 005
American Express Card(4+6|5+5|6 digits) Critical sensitive_data:american_express_credit_card
sensitive_data_category:credit_card
3782 82246 310005
American Express Card Scanner (8+7 digits) Critical sensitive_data:american_express_credit_card
sensitive_data_category:credit_card
37828224 6310005
American Express Card Scanner (1x15 digits) Critical sensitive_data:american_express_credit_card
sensitive_data_category:credit_card
378282246310005
American Express Card Scanner (1x14 digits) Critical sensitive_data:american_express_credit_card
sensitive_data_category:credit_card
36123456789012
MasterCard Scanner (2x8 digits) Critical sensitive_data:master_card_credit_card
sensitive_data_category:credit_card
51051051 05105100
Discover Card Scanner (4x4 digits) Critical sensitive_data:discover_credit_card
sensitive_data_category:credit_card
6011 0009 9013 9424
Discover Card Scanner (1x16 digits) Critical sensitive_data:discover_credit_card
sensitive_data_category:credit_card
6011000990139424
JCB Card Scanner (1x16 digits) Critical sensitive_data:jcb_credit_card
sensitive_data_category:credit_card
3530111333300000
JCB Card Scanner (2x8 digits) Critical sensitive_data:jcb_credit_card
sensitive_data_category:credit_card
35301113 33300000
JCB Card Scanner (4x4 digits) Critical sensitive_data:jcb_credit_card
sensitive_data_category:credit_card
3530 1113 3330 0000
Maestro Card Scanner (1x16 digits) Critical sensitive_data:maestro_card
sensitive_data_category:credit_card
6759649826438453
Maestro Card Scanner (2x8 digits) Critical sensitive_data:maestro_card
sensitive_data_category:credit_card
67596498 26438453
Maestro Card Scanner (4x4 digits) Critical sensitive_data:maestro_card
sensitive_data_category:credit_card
6759 6498 2643 8453
Diners Card Scanner (4+4+4+2 digits) Critical sensitive_data:diners_credit_card
sensitive_data_category:credit_card
3056 9309 0259 04
Diners Card Scanner (4+6+4 digits) Critical sensitive_data:diners_credit_card
sensitive_data_category:credit_card
3056 930902 5904
Diners Card Scanner (8+6 digits) Critical sensitive_data:diners_credit_card
sensitive_data_category:credit_card
30569309 025904
IBAN (International Bank Account Number) Critical sensitive_data:iban_code
sensitive_data_category:iban_code
GB33BUKB20201555555555
MasterCard Scanner (4x4 digits) Not set sensitive_data:mastercard_credit_card
sensitive_data_category:credit_card
5105 1051 0510 5100
MasterCard Scanner (1x16 digits) Not set sensitive_data:mastercard_credit_card
sensitive_data_category:credit_card
5105105105105100

Secrets and credentials

Rule Priority Tags Example match
JSON Web Token Medium sensitive_data:json_web_token
sensitive_data_category:credentials
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
Bearer Authentication Scanner Not set sensitive_data:bearer_token
sensitive_data_category:credentials
Bearer example-token_123/+

Network and device information

Rule Priority Tags Example match
Digest Authentication Scanner Medium sensitive_data:digest_auth
sensitive_data_category:network_and_device_info
Digest username="admin"
Basic Authentication Scanner Medium sensitive_data:basic_auth
sensitive_data_category:network_and_device_info
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Note:

The Digest Authentication Scanner rule matches the Digest scheme prefix at the start of an Authorization header value, not the credentials that follow it. Enable it to find where digest authentication is being logged. To mask the credentials themselves, pair it with a custom rule.


Tags applied by library rules

Every library rule attaches two tags to a matched event:

  • sensitive_data:<type> records what was found, for example sensitive_data:visa_credit_card.
  • sensitive_data_category:<category> records the broad grouping, for example sensitive_data_category:credit_card.

You can add your own tags on top when you add the rule, which is useful for routing findings to a team or a compliance program.

These tags become the Sensitive Data and SDC Category facets in Logs. See Investigate Sensitive Data for how to search and alert on them.


Next steps