Library Rules

Overview

The Scanning Rule Library is a collection of predefined rules for detecting common patterns such as email addresses, credit card numbers, API keys, authorization tokens, and more.

The library rules are organized into the following categories:


These rules can also be viewed in Datadog:

  1. Navigate to Sensitive Data Scanner.
  2. Click Scanning Rules Library on the top right side of the page.
  3. To add rules from the library to a scanning group:
    1. Select the rules you want to add.
    2. Click Add Rules to Scanning Group.
    3. Follow the steps in Set Up Sensitive Data Scanner to finish the setup.

Secrets and credentials

Library ruleDefault Keywords
AWS Access Key ID Scanneraws_access_key_id, access key, aws access, x-amz-credential
AWS Secret Access Key Scanneraws_secret_access_key, credentials, secret access key, secret key, set-awscredential
Amazon Marketplace Web Services Auth Token Scanneramazon, marketplace, aws, auth, token, authorization, authentication
Azure Personal Access Token Scanner-
Azure SQL Connection String Scannerazure, sql, connection string
Azure Subscription Key Scannerazure, subscription key
Bearer Token Scanner-
Checkout.com API Secret Key Scannercheckout, secret
Databricks Personal Access Token Scannerdatabricks, access, token
Docker Swarm Join Token Scannerdocker, docker swarm, join token
Docker Swarm Unlock Key Scannerdocker, docker swarm, unlock key
Dynatrace Token Scannerdynatrace, token
Facebook Access Token Scannerfacebook, access, token
Github Access Token Scannergithub, access, token
Github Refresh Token Scannergithub, refresh token
Gitlab Personal and Project Access Token Scannergitlab, token
Google API Key Scannerg_places_key, gcp api key, gcp key, google cloud key, google-api-key, google-cloud-apikeys, googlekey, x-goog-api-key
Google OAuth Access Token Scannergoogle, oauth, access, token, authorization, authentication
Heroku API Key Scanner-
Instagram Token Scanner-
JIRA API Token Scanner-
JSON Web Token Scanner-
LinkedIn Secret Scanner-
Mailchimp API Key Scannermailchimp, api key
Mailgun API Key Scannermailgun, api key
Okta API Token Scannerokta, api token
OpenAI API Key Scanner-
PGP Private Key Scanner-
PagerDuty API Token Scannerpagerduty, pager_duty, token, pg
Paypal Braintree Access Token Scannerpaypal, braintree, access, token
Postman API Key Scannerpostman, x-api-key, postman-api-key
RSA Private Key Scanner-
SSH Key Scanner-
SendGrid API Key Scannersend grid, api token
Shopify Access Secret Scannershopify, shared secret
Shopify Access Token Scannershopify, access, token
Slack Access Token Scannerslack, access, token
Slack Webhook Secret Scannerslack, webhook, secret
Square Access Token Scannersquare, access, token
Square OAuth Secret Scannersquare, oauth, secret, authorization, authentication
Stripe Restricted API Key Scannerstripe, api key
Stripe Secret API Key Scannerstripe, api key
Twilio API Key Scannertwilio, api key
Twitter Secret Scanner-

Credit cards and banking

Library ruleDefault Keywords
American Express Card Scanner (1x15 digits)account number, american express, amex, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, pan, payment account number, payment card number, pcn, union pay
American Express Card Scanner (4+4+4+3 digits)account number, american express, amex, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, pan, payment account number, payment card number, pcn, union pay
American Express Card Scanner (4+6+5 digits)account number, american express, amex, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, pan, payment account number, payment card number, pcn, union pay
American Express Card Scanner (8+7 digits)account number, american express, amex, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, pan, payment account number, payment card number, pcn, union pay
Diners Card Scanner (1x14 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, diners club, mastercard, mc, pan, payment account number, payment card number, pcn
Diners Card Scanner (4+4+4+2 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, diners club, mastercard, mc, pan, payment account number, payment card number, pcn
Diners Card Scanner (4+6+4 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, diners club, mastercard, mc, pan, payment account number, payment card number, pcn
Diners Card Scanner (8+6 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, diners club, mastercard, mc, pan, payment account number, payment card number, pcn
Discover Card Scanner (1x16 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, discover, pan, payment account number, payment card number, pcn
Discover Card Scanner (2x8 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, discover, pan, payment account number, payment card number, pcn
Discover Card Scanner (4x4 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, discover, pan, payment account number, payment card number, pcn
JCB Card Scanner (1x16 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, japanese card bureau, jcb, pan, payment account number, payment card number, pcn
JCB Card Scanner (2x8 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, japanese card bureau, jcb, pan, payment account number, payment card number, pcn
JCB Card Scanner (4x4 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, japanese card bureau, jcb, pan, payment account number, payment card number, pcn
Maestro Card Scanner (1x16 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, mastercard, mc, pan, payment account number, payment card number, pcn
Maestro Card Scanner (2x8 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, mastercard, mc, pan, payment account number, payment card number, pcn
Maestro Card Scanner (4x4 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, mastercard, mc, pan, payment account number, payment card number, pcn
MasterCard Scanner (1x16 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, mastercard, mc, pan, payment account number, payment card number, pcn, union pay
MasterCard Scanner (2x8 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, mastercard, mc, pan, payment account number, payment card number, pcn, union pay
MasterCard Scanner (4x4 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, mastercard, mc, pan, payment account number, payment card number, pcn, union pay
Standard IBAN Code Scannerbank account, bank acct, checking account, checking acct, deposit account, deposit acct, savings account, savings acct, chequing account, chequing acct, iban, account code, account number, accountno#, accountnumber#, bban, customer account id, customer account number, customer bank account id, sepa
Visa Card Scanner (1x16 & 1x19 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, electron, pan, payment account number, payment card number, pcn, union pay, visa
Visa Card Scanner (2x8 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, electron, pan, payment account number, payment card number, pcn, union pay, visa
Visa Card Scanner (4x4 digits)account number, bank card, card, card num, card number, cc #, ccn, check card, credit, credit card#, dankort, debit, debit card, electron, pan, payment account number, payment card number, pcn, union pay, visa

Personal identifiable information (PII)

Library ruleDefault Keywords
Canadian Social Insurance Number Scanner-
Chinese Car License Plate Number Scannercar, plate, license, platenumber
Chinese Identity Card Number Scannernational id, resident identity, identity number, identification number, identity card number, national identification number
Chinese Passport Scannerpassport, travel document
Chinese Phone Number Scannermobile, phone, cell
Chinese Vehicle Identification Number Scannervin, vehicle identification number
France Social Security Number Scanner (INSEE/NIR)social security, insee, nir
Standard Email Address Scanner-
UK National Health Service Number Scannernational health number, nhs
UK National Insurance Number Scanner-
US Individual Taxpayer Identification Number Scanner (ITIN)i.t.i.n., individual taxpayer, itin
US Passport Scanner-
US Social Security Number Scannerssn, social security
US Vehicle Identification Number Scanner-

Network and device information

Library ruleDefault Keywords
HTTP Basic Authentication Header Scanner-
HTTP Cookie Scannercookie
HTTP(S) URL Scanner-
IPv4 Address Scanner-
IPv6 Address Scanner-
Standard MAC Address Scanner-

Further Reading

Additional helpful documentation, links, and articles:

Set up Sensitive Data ScannerDOCUMENTATION more more