Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ Once restarted, the plugin will automatically scan all prompts before they reach
✅ **Secrets**
- OpenAI API keys (`sk-...`, `sk-proj-...`)
- AWS credentials
- GitHub tokens
- GitHub tokens (classic and fine-grained PATs)
- GitLab tokens (personal access, deploy, runner, pipeline trigger, service account)
- Azure client secrets (Microsoft Entra ID)
- Stripe keys
- JWT tokens
- Bearer tokens
Expand Down
23 changes: 17 additions & 6 deletions dist/scanner/detectors.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 17 additions & 6 deletions src/scanner/detectors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -187,13 +187,13 @@ export const BUILTIN_RULES: DetectionRule[] = [
enabled: true,
},
{
id: 'gitlab-personal-access-token',
title: 'GitLab Personal Access Token',
description: 'Detects GitLab personal access tokens (default glpat- prefix)',
severity: 'high',
id: 'gitlab-token',
title: 'GitLab Token',
description: 'Detects GitLab personal access, deploy, runner, pipeline trigger, and service account tokens',
severity: 'critical',
category: 'secret',
pattern: /\bglpat-[A-Za-z0-9_-]{20,64}\b/g,
examples: ['glpat-EXAMPLExxxxEXAMPLExxxx'],
pattern: /\bgl(?:pat|ptt|dt|rt|soat|ft)-[A-Za-z0-9_-]{20,}(?:\.[A-Za-z0-9_-]{2,})*\b/g,
examples: ['glpat-abcdefghij1234567890', 'glpat-EXAMPLEabcd1234567890.01.0example12'],
redactionStrategy: 'token-replace',
enabled: true,
},
Expand Down Expand Up @@ -268,6 +268,17 @@ export const BUILTIN_RULES: DetectionRule[] = [
redactionStrategy: 'token-replace',
enabled: true,
},
{
id: 'azure-client-secret',
title: 'Azure Client Secret',
description: 'Detects Microsoft Entra ID (Azure AD) application client secrets',
severity: 'critical',
category: 'secret',
pattern: /(?<![A-Za-z0-9_~.-])[A-Za-z0-9_~.]{3}\dQ~[A-Za-z0-9_~.-]{31,34}(?![A-Za-z0-9_~.-])/g,
examples: ['q_x8Q~AbCdEfGhIjKlMnOpQrStUvWxYz.12345~a'],
redactionStrategy: 'token-replace',
enabled: true,
},
{
id: 'database-connection-string-credentials',
title: 'Database Connection String with Credentials',
Expand Down
75 changes: 58 additions & 17 deletions tests/rules.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,64 @@ describe('openai-api-key rule', () => {
});
});

describe('github-token rule', () => {
const githubRule = BUILTIN_RULES.find((rule) => rule.id === 'github-token') as DetectionRule;
const scanner = new PrivacyScanner([githubRule]);

test.each([
'ghp_AbCdEfGhIjKlMnOpQrStUvWxYz0123456789',
'github_pat_11ABCDEFG0abcdefghijklm_AbCdEfGhIjKlMnOpQrStUvWxYz0123456789abcdefghijklmnopqrstuvw',
])('matches realistic token: %s', (token: string) => {
const result = scanner.scan(`my token is ${token}`);
expect(result.findings.some((finding) => finding.ruleId === 'github-token')).toBe(true);
});

test('does not match prose mentioning github_pat or short placeholders', () => {
const result = scanner.scan('set github_pat_here and ghp_abc123 in your env');
expect(result.findings).toHaveLength(0);
});
});

describe('gitlab-token rule', () => {
const gitlabRule = BUILTIN_RULES.find((rule) => rule.id === 'gitlab-token') as DetectionRule;
const scanner = new PrivacyScanner([gitlabRule]);

test.each([
'glpat-abcdefghij1234567890',
'glpat-EXAMPLEabcd1234567890.01.0example12',
'gldt-AbCdEfGhIjKlMnOpQrSt',
'glrt-t1_AbCdEfGhIjKlMnOpQr',
])('matches realistic token: %s', (token: string) => {
const result = scanner.scan(`CI_JOB_TOKEN=${token}`);
expect(result.findings.some((finding) => finding.ruleId === 'gitlab-token')).toBe(true);
});

test('does not match prose or short placeholder values', () => {
const result = scanner.scan('create a glpat-style token; glpat-abc123 is a placeholder');
expect(result.findings).toHaveLength(0);
});
});

describe('azure-client-secret rule', () => {
const azureRule = BUILTIN_RULES.find((rule) => rule.id === 'azure-client-secret') as DetectionRule;
const scanner = new PrivacyScanner([azureRule]);

test.each([
'q_x8Q~AbCdEfGhIjKlMnOpQrStUvWxYz.12345~a',
'Iq18Q~yfZ2K7Vt.wNxE4pDb-Mh9cRj3sGl6uT',
])('matches realistic secret: %s', (secret: string) => {
const result = scanner.scan(`AZURE_CLIENT_SECRET=${secret}`);
expect(result.findings.some((finding) => finding.ruleId === 'azure-client-secret')).toBe(true);
});

test('does not match GUIDs or generic base64-like strings', () => {
const result = scanner.scan(
'client_id 4f9d2b1a-7c3e-4a5b-9d8f-1e2a3b4c5d6e value dGhpc2lzYWxvbmdiYXNlNjRzdHJpbmc0MGNoYXJz'
);
expect(result.findings).toHaveLength(0);
});
});

describe('bearer-token rule', () => {
const bearerRule = BUILTIN_RULES.find((rule) => rule.id === 'bearer-token') as DetectionRule;
const scanner = new PrivacyScanner([bearerRule]);
Expand Down Expand Up @@ -226,23 +284,6 @@ describe('slack-token rule', () => {
});
});

describe('gitlab-personal-access-token rule', () => {
const scanner = ruleScanner('gitlab-personal-access-token');

test('matches a realistic glpat- token', () => {
const result = scanner.scan('export GITLAB_TOKEN=glpat-EXAMPLExxxxEXAMPLExxxx');
expect(result.findings.some((f) => f.ruleId === 'gitlab-personal-access-token')).toBe(true);
});

test.each(['glpat-xxxx', 'set GITLAB_TOKEN to your glpat- value'])(
'does not match placeholders: %s',
(text: string) => {
const result = scanner.scan(text);
expect(result.findings).toHaveLength(0);
}
);
});

describe('gitlab-ci-job-token rule', () => {
const scanner = ruleScanner('gitlab-ci-job-token');

Expand Down
Loading