@coo-quack/sensitive-canary 0.5.3 → 0.7.0

package/src/lib/default-config.json

@@ -0,0 +1,461 @@
+{
+  "contextWindow": 3,
+  "rules": [
+    {
+      "id": "aws-access-key",
+      "description": "AWS Access Key ID",
+      "regex": "\\b(A3T[A-Z0-9]|AKIA|AGPA|AIDA|AROA|AIPA|ANPA|ANVA|ASIA)[A-Z0-9]{16}\\b",
+      "category": "secret"
+    },
+    {
+      "id": "gcp-api-key",
+      "description": "Google Cloud API Key",
+      "regex": "AIza[0-9A-Za-z_-]{35}",
+      "category": "secret"
+    },
+    {
+      "id": "private-key",
+      "description": "PEM Private Key",
+      "regex": "-----BEGIN (RSA |EC |DSA |PGP |OPENSSH )?PRIVATE KEY",
+      "category": "secret"
+    },
+    {
+      "id": "github-pat",
+      "description": "GitHub Personal Access Token",
+      "regex": "gh[pousr]_[A-Za-z0-9]{36,255}",
+      "category": "secret"
+    },
+    {
+      "id": "github-fine-grained",
+      "description": "GitHub Fine-Grained Token",
+      "regex": "github_pat_[A-Za-z0-9_]{82}",
+      "category": "secret"
+    },
+    {
+      "id": "gitlab-pat",
+      "description": "GitLab Personal Access Token",
+      "regex": "glpat-[A-Za-z0-9_=-]{20,22}",
+      "category": "secret"
+    },
+    {
+      "id": "npm-token",
+      "description": "npm Access Token",
+      "regex": "npm_[A-Za-z0-9]{36}",
+      "category": "secret"
+    },
+    {
+      "id": "slack-token",
+      "description": "Slack Token",
+      "regex": "xox[baprs]-[0-9a-zA-Z-]{10,72}",
+      "category": "secret"
+    },
+    {
+      "id": "slack-webhook",
+      "description": "Slack Webhook URL",
+      "regex": "https:\\/\\/hooks\\.slack\\.com\\/services\\/T[A-Za-z0-9_]{8,10}\\/B[A-Za-z0-9_]{8,12}\\/[A-Za-z0-9_]{23,24}",
+      "category": "secret"
+    },
+    {
+      "id": "discord-webhook",
+      "description": "Discord Webhook URL",
+      "regex": "https:\\/\\/discord(?:app)?\\.com\\/api\\/webhooks\\/[0-9]{17,20}\\/[A-Za-z0-9_-]{68}",
+      "category": "secret"
+    },
+    {
+      "id": "telegram-bot-token",
+      "description": "Telegram Bot Token",
+      "regex": "[0-9]{8,10}:AA[0-9A-Za-z_-]{33}",
+      "category": "secret"
+    },
+    {
+      "id": "twilio-sid",
+      "description": "Twilio Account SID",
+      "regex": "AC[0-9a-f]{32}",
+      "category": "secret"
+    },
+    {
+      "id": "sendgrid-key",
+      "description": "SendGrid API Key",
+      "regex": "SG\\.[A-Za-z0-9_-]{20,24}\\.[A-Za-z0-9_-]{39,50}",
+      "category": "secret"
+    },
+    {
+      "id": "mailgun-key",
+      "description": "Mailgun API Key",
+      "regex": "key-[0-9a-zA-Z]{32}",
+      "category": "secret"
+    },
+    {
+      "id": "mailchimp-key",
+      "description": "Mailchimp API Key",
+      "regex": "[0-9a-f]{32}-us[0-9]{1,2}",
+      "category": "secret"
+    },
+    {
+      "id": "stripe-secret-key",
+      "description": "Stripe Secret Key",
+      "regex": "sk_(live|test)_[0-9a-zA-Z]{24}",
+      "category": "secret"
+    },
+    {
+      "id": "stripe-restricted-key",
+      "description": "Stripe Restricted Key",
+      "regex": "rk_(live|test)_[0-9a-zA-Z]{24}",
+      "category": "secret"
+    },
+    {
+      "id": "openai-key",
+      "description": "OpenAI API Key (legacy)",
+      "regex": "sk-(?!proj-|ant-)[A-Za-z0-9]{48}",
+      "category": "secret"
+    },
+    {
+      "id": "openai-project-key",
+      "description": "OpenAI Project API Key",
+      "regex": "sk-proj-[A-Za-z0-9_-]{40,}",
+      "category": "secret",
+      "entropyThreshold": 3.5
+    },
+    {
+      "id": "anthropic-key",
+      "description": "Anthropic API Key",
+      "regex": "sk-ant-[A-Za-z0-9_-]{95}",
+      "category": "secret"
+    },
+    {
+      "id": "replicate-token",
+      "description": "Replicate API Token",
+      "regex": "r8_[0-9A-Za-z_]{37}",
+      "category": "secret"
+    },
+    {
+      "id": "huggingface-token",
+      "description": "Hugging Face Access Token",
+      "regex": "hf_[a-zA-Z0-9]{34}",
+      "category": "secret"
+    },
+    {
+      "id": "groq-key",
+      "description": "Groq API Key",
+      "regex": "gsk_[A-Za-z0-9]{52}",
+      "category": "secret"
+    },
+    {
+      "id": "openrouter-key",
+      "description": "OpenRouter API Key",
+      "regex": "sk-or-v1-[0-9a-f]{64}",
+      "category": "secret"
+    },
+    {
+      "id": "xai-key",
+      "description": "xAI (Grok) API Key",
+      "regex": "xai-[0-9A-Za-z_]{80}",
+      "category": "secret"
+    },
+    {
+      "id": "perplexity-key",
+      "description": "Perplexity API Key",
+      "regex": "pplx-[a-zA-Z0-9]{48}",
+      "category": "secret"
+    },
+    {
+      "id": "digitalocean-pat",
+      "description": "DigitalOcean Personal Access Token",
+      "regex": "dop_v1_[a-f0-9]{64}",
+      "category": "secret"
+    },
+    {
+      "id": "square-access-token",
+      "description": "Square Access Token",
+      "regex": "EAAA[a-zA-Z0-9\\-_+=]{60}",
+      "category": "secret"
+    },
+    {
+      "id": "mapbox-token",
+      "description": "Mapbox Token",
+      "regex": "(?:pk|sk)\\.eyJ[A-Za-z0-9_-]{10,}\\.[A-Za-z0-9_-]{10,}\\.[A-Za-z0-9_-]{10,}",
+      "category": "secret"
+    },
+    {
+      "id": "sentry-user-token",
+      "description": "Sentry User Auth Token",
+      "regex": "sntryu_[a-f0-9]{64}",
+      "category": "secret"
+    },
+    {
+      "id": "sentry-org-token",
+      "description": "Sentry Organization Auth Token",
+      "regex": "sntrys_eyJ[A-Za-z0-9_-]{10,}\\.[A-Za-z0-9_-]{10,}\\.[A-Za-z0-9_-]{10,}",
+      "category": "secret"
+    },
+    {
+      "id": "atlassian-token",
+      "description": "Atlassian API Token",
+      "regex": "ATATT3[A-Za-z0-9_\\-=]{180,}",
+      "category": "secret"
+    },
+    {
+      "id": "linear-key",
+      "description": "Linear API Key",
+      "regex": "lin_api_[a-z0-9]{40}",
+      "category": "secret"
+    },
+    {
+      "id": "postman-key",
+      "description": "Postman API Key",
+      "regex": "PMAK-[a-f0-9]{24}-[a-f0-9]{34}",
+      "category": "secret"
+    },
+    {
+      "id": "supabase-key",
+      "description": "Supabase Personal Access Token",
+      "regex": "sbp_[a-z0-9]{40}",
+      "category": "secret"
+    },
+    {
+      "id": "jwt",
+      "description": "JSON Web Token (JWT)",
+      "regex": "(?<!sntrys_|pk\\.|sk\\.)eyJ[A-Za-z0-9_-]{10,}\\.eyJ[A-Za-z0-9_-]{10,}\\.[A-Za-z0-9_-]{10,}",
+      "category": "secret"
+    },
+    {
+      "id": "generic-secret",
+      "description": "Generic API Key / Secret",
+      "regex": "(api[_-]?key|secret[_-]?key|access[_-]?token|api[_-]?secret)\\s*[:=]\\s*['\"]?([A-Za-z0-9\\-_.]{20,})",
+      "category": "secret",
+      "flags": "gi",
+      "secretGroup": 2,
+      "entropyThreshold": 3.5
+    },
+    {
+      "id": "env-assignment",
+      "description": ".env style secret assignment",
+      "regex": "\\b[A-Z_]*(SECRET|PASSWORD|PASSWD|TOKEN|API_KEY|PRIVATE_KEY)[A-Z_0-9]*\\s*=\\s*(\\S{8,})",
+      "category": "secret",
+      "secretGroup": 2,
+      "entropyThreshold": 3
+    },
+    {
+      "id": "connection-string",
+      "description": "Database Connection String with credentials",
+      "regex": "(mongodb|mysql|postgres|postgresql|redis):\\/\\/[^:\\s]+:[^@\\s]+@",
+      "category": "secret"
+    },
+    {
+      "id": "pii-email",
+      "description": "Email Address",
+      "regex": "\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}\\b",
+      "category": "pii"
+    },
+    {
+      "id": "pii-credit-card",
+      "description": "Credit Card Number",
+      "regex": "\\b(?:4[0-9]{3}(?:[\\s-]?[0-9]{4}){3}|5[1-5][0-9]{2}(?:[\\s-]?[0-9]{4}){3}|3[47][0-9]{2}[\\s-]?[0-9]{6}[\\s-]?[0-9]{5}|6(?:011|5[0-9]{2})[0-9](?:[\\s-]?[0-9]{4}){3})\\b",
+      "category": "pii",
+      "validate": "luhn"
+    },
+    {
+      "id": "pii-ssn",
+      "description": "US Social Security Number",
+      "regex": "\\b(?!000|666|9\\d{2})\\d{3}[- ](?!00)\\d{2}[- ](?!0000)\\d{4}\\b",
+      "category": "pii"
+    },
+    {
+      "id": "pii-phone-us",
+      "description": "US Phone Number",
+      "regex": "\\b(\\+1[\\s.-]?)?\\(?\\d{3}\\)?[\\s.-]\\d{3}[\\s.-]\\d{4}\\b",
+      "category": "pii"
+    },
+    {
+      "id": "pii-phone-jp",
+      "description": "Japanese Phone Number",
+      "regex": "\\b0\\d{1,4}[\\s-]\\d{1,4}[\\s-]\\d{4}\\b",
+      "category": "pii"
+    },
+    {
+      "id": "pii-postal-jp",
+      "description": "Japanese Postal Code",
+      "regex": "〒\\d{3}[\\s-]\\d{4}",
+      "category": "pii"
+    },
+    {
+      "id": "pii-ipv4",
+      "description": "IPv4 Address (private range)",
+      "regex": "\\b(10\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}|172\\.(1[6-9]|2\\d|3[01])\\.\\d{1,3}\\.\\d{1,3}|192\\.168\\.\\d{1,3}\\.\\d{1,3})\\b",
+      "category": "pii"
+    },
+    {
+      "id": "pii-mynumber-jp",
+      "description": "Japanese Individual Number (My Number)",
+      "regex": "\\b\\d{12}\\b",
+      "category": "pii",
+      "validate": "mynumber-jp"
+    },
+    {
+      "id": "pii-nir-fr",
+      "description": "French NIR / Social Security Number",
+      "regex": "\\b[12]\\d{2}(?:0[1-9]|1[0-2]|20)(?:\\d{5}|2[AB]\\d{3})\\d{3}\\s?\\d{2}\\b",
+      "category": "pii",
+      "flags": "gi",
+      "validate": "nir-fr"
+    },
+    {
+      "id": "pii-codice-fiscale-it",
+      "description": "Italian Codice Fiscale",
+      "regex": "\\b[A-Z]{6}\\d{2}[A-Z]\\d{2}[A-Z]\\d{3}[A-Z]\\b",
+      "category": "pii",
+      "validate": "codice-fiscale-it"
+    },
+    {
+      "id": "pii-steuer-id-de",
+      "description": "German Steuer-Identifikationsnummer",
+      "regex": "\\b[1-9]\\d{10}\\b",
+      "category": "pii",
+      "validate": "steuer-id-de"
+    },
+    {
+      "id": "pii-dni-nie-es",
+      "description": "Spanish DNI / NIE",
+      "regex": "\\b(?:\\d{8}[A-Z]|[XYZ]\\d{7}[A-Z])\\b",
+      "category": "pii",
+      "validate": "dni-nie-es"
+    },
+    {
+      "id": "pii-phone-fr",
+      "description": "French Phone Number",
+      "regex": "\\b0[1-9](?:[\\s.-]?\\d{2}){4}\\b",
+      "category": "pii",
+      "requireContext": true,
+      "contextWords": [
+        "tél",
+        "tel",
+        "téléphone",
+        "telephone",
+        "phone",
+        "mobile",
+        "portable",
+        "fax"
+      ]
+    },
+    {
+      "id": "pii-phone-it",
+      "description": "Italian Phone Number",
+      "regex": "\\b(?:0\\d{8,9}|3\\d{8,9})\\b",
+      "category": "pii",
+      "requireContext": true,
+      "contextWords": ["telefono", "tel", "cellulare", "mobile", "phone", "fax"]
+    },
+    {
+      "id": "pii-phone-de",
+      "description": "German Phone Number",
+      "regex": "\\b0[1-9]\\d{6,11}\\b",
+      "category": "pii",
+      "requireContext": true,
+      "contextWords": ["telefon", "tel", "handy", "mobil", "phone", "fax"]
+    },
+    {
+      "id": "pii-phone-es",
+      "description": "Spanish Phone Number",
+      "regex": "\\b[67]\\d{8}\\b",
+      "category": "pii",
+      "requireContext": true,
+      "contextWords": [
+        "teléfono",
+        "telefono",
+        "tel",
+        "móvil",
+        "movil",
+        "phone",
+        "fax"
+      ]
+    },
+    {
+      "id": "pii-postal-code",
+      "description": "Postal Code (US ZIP / EU / KR)",
+      "regex": "\\b\\d{5}(?:-\\d{4})?\\b",
+      "category": "pii",
+      "requireContext": true,
+      "contextWords": [
+        "zip",
+        "postal",
+        "postale",
+        "postcode",
+        "plz",
+        "postleitzahl",
+        "cap",
+        "우편번호"
+      ]
+    },
+    {
+      "id": "pii-rrn-kr",
+      "description": "Korean Resident Registration Number",
+      "regex": "\\b\\d{6}[-\\s]?\\d{7}\\b",
+      "category": "pii",
+      "validate": "rrn-kr"
+    },
+    {
+      "id": "pii-brn-kr",
+      "description": "Korean Business Registration Number",
+      "regex": "\\b\\d{3}[-\\s]?\\d{2}[-\\s]?\\d{5}\\b",
+      "category": "pii",
+      "validate": "brn-kr"
+    },
+    {
+      "id": "pii-resident-id-cn",
+      "description": "Chinese Resident Identity Card",
+      "regex": "\\b\\d{17}[\\dXx]\\b",
+      "category": "pii",
+      "validate": "resident-id-cn"
+    },
+    {
+      "id": "pii-phone-kr",
+      "description": "Korean Phone Number",
+      "regex": "(?:\\+82[-\\s]?)?(?:01[016789]|0\\d{1,2})[-\\s]?\\d{3,4}[-\\s]?\\d{4}",
+      "category": "pii",
+      "requireContext": true,
+      "contextWords": [
+        "전화",
+        "핸드폰",
+        "휴대",
+        "tel",
+        "phone",
+        "mobile",
+        "fax"
+      ]
+    },
+    {
+      "id": "pii-phone-cn",
+      "description": "Chinese Phone Number",
+      "regex": "(?:\\+86[-\\s]?)?(?:1[3-9]\\d{9}|0\\d{2,3}[-\\s]?\\d{7,8})",
+      "category": "pii",
+      "requireContext": true,
+      "contextWords": ["电话", "手机", "tel", "phone", "mobile", "fax"]
+    },
+    {
+      "id": "pii-postal-cn",
+      "description": "Chinese Postal Code",
+      "regex": "\\b[1-9]\\d{5}\\b",
+      "category": "pii",
+      "requireContext": true,
+      "contextWords": ["邮编", "邮政编码", "postal", "postcode", "zip"]
+    },
+    {
+      "id": "pii-ipv4-public",
+      "description": "Public IPv4 Address",
+      "regex": "\\b\\d{1,3}(?:\\.\\d{1,3}){3}\\b",
+      "category": "pii",
+      "requireContext": true,
+      "contextWords": ["ip", "ipv4"],
+      "validate": "public-ipv4"
+    },
+    {
+      "id": "pii-ipv6",
+      "description": "IPv6 Address",
+      "regex": "\\b[0-9A-Fa-f]{1,4}(?::[0-9A-Fa-f]{0,4}){2,7}\\b",
+      "category": "pii",
+      "requireContext": true,
+      "contextWords": ["ipv6", "ip"],
+      "validate": "public-ipv6"
+    }
+  ]
+}