@oculum/scanner 1.0.11 → 1.0.13

package/src/__tests__/score/adjustments.test.ts

@@ -0,0 +1,385 @@
+/**
+ * Unit tests for adjustment rules
+ */
+
+import {
+  FILE_CONTEXT_RULES,
+  AUTO_DISMISS_RULES,
+  ALL_ADJUSTMENT_RULES,
+  TAINT_RULES,
+  ROUTE_RULES,
+  FRAMEWORK_RULES,
+} from '../../score/adjustments'
+import type { AdjustmentContext } from '../../score/types'
+import type { Vulnerability } from '../../shared/types'
+
+// Helper to create a minimal finding
+function makeFinding(overrides: Partial<Vulnerability> = {}): Vulnerability {
+  return {
+    id: 'test-1',
+    filePath: 'src/app.ts',
+    lineNumber: 10,
+    lineContent: 'const x = 1',
+    severity: 'medium',
+    category: 'hardcoded_secret',
+    title: 'Test finding',
+    description: 'Test',
+    confidence: 'medium',
+    layer: 1,
+    baseConfidence: 0.50,
+    ...overrides,
+  }
+}
+
+function makeContext(overrides: Partial<AdjustmentContext> = {}): AdjustmentContext {
+  return {
+    file: {
+      isTestFile: false,
+      isExampleFile: false,
+      isDocFile: false,
+      isScannerCode: false,
+      isToolingDir: false,
+      isServerOnly: false,
+      isClientBundled: false,
+    },
+    project: {
+      hasAuthMiddleware: false,
+      hasTypeScript: true,
+      orm: null,
+      validationLib: null,
+    },
+    lineContent: 'const x = 1',
+    filePath: 'src/app.ts',
+    ...overrides,
+  }
+}
+
+function findRule(name: string) {
+  return ALL_ADJUSTMENT_RULES.find(r => r.name === name)
+}
+
+describe('File Context Rules', () => {
+  it('test_file applies for test files', () => {
+    const rule = findRule('test_file')!
+    expect(rule).toBeDefined()
+    expect(rule.delta).toBe(-0.35)
+
+    const finding = makeFinding({ filePath: 'src/__tests__/auth.test.ts' })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+  })
+
+  it('test_file does not apply for production files', () => {
+    const rule = findRule('test_file')!
+    const finding = makeFinding({ filePath: 'src/auth.ts' })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(false)
+  })
+
+  it('example_file applies for example files', () => {
+    const rule = findRule('example_file')!
+    expect(rule.delta).toBe(-0.30)
+
+    const finding = makeFinding({ filePath: '/examples/basic/app.ts' })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+  })
+
+  it('example_file does not apply for production files', () => {
+    const rule = findRule('example_file')!
+    const finding = makeFinding({ filePath: 'src/app.ts' })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(false)
+  })
+
+  it('doc_file applies for markdown files', () => {
+    const rule = findRule('doc_file')!
+    expect(rule.delta).toBe(-0.30)
+
+    const finding = makeFinding({ filePath: 'docs/setup.md' })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+  })
+
+  it('scanner_code applies for scanner files', () => {
+    const rule = findRule('scanner_code')!
+    expect(rule.delta).toBe(-0.30)
+
+    const finding = makeFinding({ filePath: 'packages/scanner/src/detect/secrets/patterns.ts' })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+  })
+
+  it('tooling_dir applies for scripts directory', () => {
+    const rule = findRule('tooling_dir')!
+    expect(rule.delta).toBe(-0.25)
+
+    const finding = makeFinding({ filePath: '/project/scripts/deploy.sh' })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+  })
+
+  it('config_env_substitution applies for env var references in secrets', () => {
+    const rule = findRule('config_env_substitution')!
+    expect(rule.delta).toBe(-0.15)
+
+    const finding = makeFinding({
+      category: 'hardcoded_secret',
+      lineContent: 'const key = process.env.API_KEY',
+    })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+  })
+
+  it('config_env_substitution does not apply for non-secret categories', () => {
+    const rule = findRule('config_env_substitution')!
+    const finding = makeFinding({
+      category: 'missing_auth',
+      lineContent: 'const key = process.env.API_KEY',
+    })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(false)
+  })
+
+  it('comment_context applies for comment lines', () => {
+    const rule = findRule('comment_context')!
+    expect(rule.delta).toBe(-0.20)
+
+    const finding = makeFinding({ lineContent: '// TODO: fix this secret key' })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+  })
+
+  it('comment_context does not apply for ai_pattern category', () => {
+    const rule = findRule('comment_context')!
+    const finding = makeFinding({
+      category: 'ai_pattern',
+      lineContent: '// TODO: fix this',
+    })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(false)
+  })
+
+  it('server_only_client_finding applies for XSS in server files', () => {
+    const rule = findRule('server_only_client_finding')!
+    expect(rule.delta).toBe(-0.10)
+
+    const finding = makeFinding({
+      category: 'xss',
+      filePath: 'src/api/handler.ts',
+    })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+  })
+})
+
+describe('Auto-Dismiss Equivalent Rules', () => {
+  it('css_class_pattern applies for Tailwind CSS entropy findings', () => {
+    const rule = findRule('css_class_pattern')!
+    expect(rule.delta).toBe(-0.40)
+
+    const finding = makeFinding({
+      category: 'high_entropy_string',
+      lineContent: 'className="flex grid text-lg bg-blue-500 px-4 py-2 rounded shadow"',
+    })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+  })
+
+  it('css_class_pattern does not apply for non-entropy findings', () => {
+    const rule = findRule('css_class_pattern')!
+    const finding = makeFinding({
+      category: 'hardcoded_secret',
+      lineContent: 'className="flex grid text-lg bg-blue-500 px-4 py-2 rounded shadow"',
+    })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(false)
+  })
+
+  it('health_check_endpoint applies for health checks', () => {
+    const rule = findRule('health_check_endpoint')!
+    expect(rule.delta).toBe(-0.35)
+
+    const finding = makeFinding({
+      category: 'missing_auth',
+      lineContent: 'app.get("/health", handler)',
+      filePath: 'src/routes.ts',
+    })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+  })
+
+  it('info_severity_low_priority applies for info + high base confidence', () => {
+    const rule = findRule('info_severity_low_priority')!
+    expect(rule.delta).toBe(-0.15)
+
+    const finding = makeFinding({
+      severity: 'info',
+      baseConfidence: 0.70,
+    })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+  })
+
+  it('info_severity_low_priority does not apply for low base confidence', () => {
+    const rule = findRule('info_severity_low_priority')!
+    const finding = makeFinding({
+      severity: 'info',
+      baseConfidence: 0.20,
+    })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(false)
+  })
+
+  it('low_severity_ai_pattern applies for low/info ai_pattern', () => {
+    const rule = findRule('low_severity_ai_pattern')!
+    expect(rule.delta).toBe(-0.10)
+
+    const finding = makeFinding({ category: 'ai_pattern', severity: 'low' })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+
+    const finding2 = makeFinding({ category: 'ai_pattern', severity: 'info' })
+    expect(rule.applies(finding2, ctx)).toBe(true)
+  })
+
+  it('generic_message applies for generic UI messages', () => {
+    const rule = findRule('generic_message')!
+    expect(rule.delta).toBe(-0.25)
+
+    const finding = makeFinding({
+      category: 'ai_pattern',
+      lineContent: 'console.log("success")',
+    })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+  })
+
+  it('type_definition_any applies for .d.ts files', () => {
+    const rule = findRule('type_definition_any')!
+    expect(rule.delta).toBe(-0.25)
+
+    const finding = makeFinding({
+      category: 'ai_pattern',
+      title: 'TypeScript any usage',
+      filePath: 'types/global.d.ts',
+    })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+  })
+
+  it('timeout_magic_number applies for setTimeout patterns', () => {
+    const rule = findRule('timeout_magic_number')!
+    expect(rule.delta).toBe(-0.20)
+
+    const finding = makeFinding({
+      category: 'ai_pattern',
+      lineContent: 'setTimeout(callback, 3000)',
+    })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+  })
+
+  it('data_config_file_secret applies for config file secret findings', () => {
+    const rule = findRule('data_config_file_secret')!
+    expect(rule).toBeDefined()
+    expect(rule.delta).toBe(-0.15)
+
+    const finding = makeFinding({
+      category: 'high_entropy_string',
+      filePath: 'config/defaults.yml',
+    })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(true)
+
+    // Also applies for JSON config files
+    const jsonFinding = makeFinding({
+      category: 'hardcoded_secret',
+      filePath: 'data/seed.json',
+    })
+    expect(rule.applies(jsonFinding, ctx)).toBe(true)
+  })
+
+  it('data_config_file_secret does not apply for .env files', () => {
+    const rule = findRule('data_config_file_secret')!
+
+    const finding = makeFinding({
+      category: 'hardcoded_secret',
+      filePath: '.env.production',
+    })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(false)
+  })
+
+  it('data_config_file_secret does not apply for non-secret categories', () => {
+    const rule = findRule('data_config_file_secret')!
+
+    const finding = makeFinding({
+      category: 'missing_auth',
+      filePath: 'config/defaults.yml',
+    })
+    const ctx = makeContext()
+    expect(rule.applies(finding, ctx)).toBe(false)
+  })
+})
+
+describe('Context Engine Rules', () => {
+  it('TAINT_RULES has 4 taint adjustment rules', () => {
+    expect(TAINT_RULES).toHaveLength(4)
+    const ruleNames = TAINT_RULES.map(r => r.name)
+    expect(ruleNames).toContain('confirmed_taint_unsanitised')
+    expect(ruleNames).toContain('confirmed_taint_sanitised')
+    expect(ruleNames).toContain('no_taint_path')
+    expect(ruleNames).toContain('low_confidence_taint')
+  })
+
+  it('ROUTE_RULES has 5 rules', () => {
+    expect(ROUTE_RULES).toHaveLength(5)
+    const ruleNames = ROUTE_RULES.map(r => r.name)
+    expect(ruleNames).toContain('no_auth_on_route')
+    expect(ruleNames).toContain('has_auth_on_route')
+    expect(ruleNames).toContain('public_route')
+    expect(ruleNames).toContain('mutation_route')
+    expect(ruleNames).toContain('rate_limited_route')
+  })
+
+  it('FRAMEWORK_RULES has 3 rules', () => {
+    expect(FRAMEWORK_RULES).toHaveLength(3)
+    const ruleNames = FRAMEWORK_RULES.map(r => r.name)
+    expect(ruleNames).toContain('framework_auto_protects')
+    expect(ruleNames).toContain('framework_unsafe_pattern')
+    expect(ruleNames).toContain('orm_safe_query')
+  })
+})
+
+describe('ALL_ADJUSTMENT_RULES', () => {
+  it('contains all file context, auto-dismiss, taint, route, and framework rules', () => {
+    expect(ALL_ADJUSTMENT_RULES.length).toBe(
+      FILE_CONTEXT_RULES.length + AUTO_DISMISS_RULES.length + TAINT_RULES.length + ROUTE_RULES.length + FRAMEWORK_RULES.length
+    )
+  })
+
+  it('each rule has required fields', () => {
+    for (const rule of ALL_ADJUSTMENT_RULES) {
+      expect(rule.name).toBeDefined()
+      expect(typeof rule.name).toBe('string')
+      expect(rule.source).toBeDefined()
+      expect(typeof rule.applies).toBe('function')
+      expect(typeof rule.delta).toBe('number')
+      expect(typeof rule.reason).toBe('string')
+    }
+  })
+
+  it('all deltas are between -1.0 and 1.0', () => {
+    for (const rule of ALL_ADJUSTMENT_RULES) {
+      expect(rule.delta).toBeGreaterThanOrEqual(-1.0)
+      expect(rule.delta).toBeLessThanOrEqual(1.0)
+    }
+  })
+
+  it('all rule names are unique', () => {
+    const names = ALL_ADJUSTMENT_RULES.map(r => r.name)
+    const uniqueNames = new Set(names)
+    expect(uniqueNames.size).toBe(names.length)
+  })
+})

package/src/__tests__/score/confidence.test.ts

@@ -0,0 +1,283 @@
+/**
+ * Unit tests for computeConfidence()
+ */
+
+import { computeConfidence } from '../../score/confidence'
+import type { Vulnerability } from '../../shared/types'
+import type { AdjustmentRule, AdjustmentContext, DepthConfig } from '../../score/types'
+
+// Helper to create a minimal finding
+function makeFinding(overrides: Partial<Vulnerability> = {}): Vulnerability {
+  return {
+    id: 'test-1',
+    filePath: 'src/app.ts',
+    lineNumber: 10,
+    lineContent: 'const secret = "sk-abc123"',
+    severity: 'medium',
+    category: 'hardcoded_secret',
+    title: 'Hardcoded secret',
+    description: 'Found a hardcoded secret',
+    confidence: 'medium',
+    layer: 1,
+    baseConfidence: 0.70,
+    ...overrides,
+  }
+}
+
+// Helper to create a minimal context
+function makeContext(overrides: Partial<AdjustmentContext> = {}): AdjustmentContext {
+  return {
+    file: {
+      isTestFile: false,
+      isExampleFile: false,
+      isDocFile: false,
+      isScannerCode: false,
+      isToolingDir: false,
+      isServerOnly: false,
+      isClientBundled: false,
+    },
+    project: {
+      hasAuthMiddleware: false,
+      hasTypeScript: true,
+      orm: null,
+      validationLib: null,
+    },
+    lineContent: 'const secret = "sk-abc123"',
+    filePath: 'src/app.ts',
+    ...overrides,
+  }
+}
+
+// Standard depth configs for testing
+const DEPTH_VERIFIED: DepthConfig = {
+  surfaceThreshold: 0.70,
+  validateThreshold: 0.30,
+  aiEnabled: true,
+}
+
+const DEPTH_LOCAL: DepthConfig = {
+  surfaceThreshold: 0.70,
+  validateThreshold: 1.0,
+  aiEnabled: false,
+}
+
+const DEPTH_DEEP: DepthConfig = {
+  surfaceThreshold: 0.70,
+  validateThreshold: 0.10,
+  aiEnabled: true,
+}
+
+describe('computeConfidence', () => {
+  describe('basic score computation', () => {
+    it('returns base confidence when no rules match', () => {
+      const finding = makeFinding({ baseConfidence: 0.70 })
+      const context = makeContext()
+      const result = computeConfidence(finding, context, [], DEPTH_VERIFIED)
+
+      expect(result.score).toBe(0.70)
+      expect(result.base).toBe(0.70)
+      expect(result.adjustments).toEqual([])
+    })
+
+    it('applies a single negative adjustment', () => {
+      const finding = makeFinding({ baseConfidence: 0.70 })
+      const context = makeContext()
+      const rules: AdjustmentRule[] = [{
+        name: 'test_file',
+        source: 'file_context',
+        applies: () => true,
+        delta: -0.35,
+        reason: 'Test file',
+      }]
+
+      const result = computeConfidence(finding, context, rules, DEPTH_VERIFIED)
+      expect(result.score).toBe(0.35)
+      expect(result.adjustments).toHaveLength(1)
+      expect(result.adjustments[0].delta).toBe(-0.35)
+    })
+
+    it('applies multiple adjustments', () => {
+      const finding = makeFinding({ baseConfidence: 0.50 })
+      const context = makeContext()
+      const rules: AdjustmentRule[] = [
+        { name: 'a', source: 'file_context', applies: () => true, delta: -0.10, reason: 'A' },
+        { name: 'b', source: 'auto_dismiss', applies: () => true, delta: -0.20, reason: 'B' },
+      ]
+
+      const result = computeConfidence(finding, context, rules, DEPTH_VERIFIED)
+      expect(result.score).toBeCloseTo(0.20, 10)
+      expect(result.adjustments).toHaveLength(2)
+    })
+
+    it('skips rules that do not apply', () => {
+      const finding = makeFinding({ baseConfidence: 0.50 })
+      const context = makeContext()
+      const rules: AdjustmentRule[] = [
+        { name: 'matches', source: 'file_context', applies: () => true, delta: -0.10, reason: 'yes' },
+        { name: 'no_match', source: 'file_context', applies: () => false, delta: -0.30, reason: 'no' },
+      ]
+
+      const result = computeConfidence(finding, context, rules, DEPTH_VERIFIED)
+      expect(result.score).toBe(0.40)
+      expect(result.adjustments).toHaveLength(1)
+    })
+  })
+
+  describe('score clamping', () => {
+    it('clamps score at 0.0 when adjustments drive it negative', () => {
+      const finding = makeFinding({ baseConfidence: 0.20 })
+      const context = makeContext()
+      const rules: AdjustmentRule[] = [
+        { name: 'big_negative', source: 'file_context', applies: () => true, delta: -0.50, reason: 'large penalty' },
+      ]
+
+      const result = computeConfidence(finding, context, rules, DEPTH_VERIFIED)
+      expect(result.score).toBe(0.0)
+    })
+
+    it('clamps score at 1.0 when adjustments exceed maximum', () => {
+      const finding = makeFinding({ baseConfidence: 0.80 })
+      const context = makeContext()
+      const rules: AdjustmentRule[] = [
+        { name: 'big_positive', source: 'detector', applies: () => true, delta: 0.50, reason: 'boost' },
+      ]
+
+      const result = computeConfidence(finding, context, rules, DEPTH_VERIFIED)
+      expect(result.score).toBe(1.0)
+    })
+  })
+
+  describe('default base confidence', () => {
+    it('uses 0.35 when baseConfidence is undefined', () => {
+      const finding = makeFinding({ baseConfidence: undefined })
+      const context = makeContext()
+      const result = computeConfidence(finding, context, [], DEPTH_VERIFIED)
+
+      expect(result.score).toBe(0.35)
+      expect(result.base).toBe(0.35)
+    })
+  })
+
+  describe('routing thresholds', () => {
+    it('routes to surface when score >= surfaceThreshold', () => {
+      const finding = makeFinding({ baseConfidence: 0.70 })
+      const context = makeContext()
+      const result = computeConfidence(finding, context, [], DEPTH_VERIFIED)
+
+      expect(result.routing).toBe('surface')
+    })
+
+    it('routes to validate when score >= validateThreshold and AI enabled', () => {
+      const finding = makeFinding({ baseConfidence: 0.50 })
+      const context = makeContext()
+      const result = computeConfidence(finding, context, [], DEPTH_VERIFIED)
+
+      expect(result.routing).toBe('validate')
+    })
+
+    it('routes to suppress when score < validateThreshold', () => {
+      const finding = makeFinding({ baseConfidence: 0.20 })
+      const context = makeContext()
+      const result = computeConfidence(finding, context, [], DEPTH_VERIFIED)
+
+      expect(result.routing).toBe('suppress')
+    })
+
+    it('routes to suppress in local mode even when score could validate', () => {
+      const finding = makeFinding({ baseConfidence: 0.50 })
+      const context = makeContext()
+      const result = computeConfidence(finding, context, [], DEPTH_LOCAL)
+
+      // 0.50 < surfaceThreshold(0.70), validateThreshold(1.0) unreachable, aiEnabled=false
+      expect(result.routing).toBe('suppress')
+    })
+
+    it('routes to validate in deep mode with very low threshold', () => {
+      const finding = makeFinding({ baseConfidence: 0.15 })
+      const context = makeContext()
+      const result = computeConfidence(finding, context, [], DEPTH_DEEP)
+
+      // 0.15 >= validateThreshold(0.10) and aiEnabled=true
+      expect(result.routing).toBe('validate')
+    })
+  })
+
+  describe('worked examples', () => {
+    // Example 1: Known API key in production code (high confidence, surfaces directly)
+    it('surfaces a known API key in production code', () => {
+      const finding = makeFinding({ baseConfidence: 0.70, category: 'hardcoded_secret' })
+      const context = makeContext()
+      const result = computeConfidence(finding, context, [], DEPTH_VERIFIED)
+
+      expect(result.score).toBe(0.70)
+      expect(result.routing).toBe('surface')
+    })
+
+    // Example 2: Known API key in test file (adjusted down, validate or suppress)
+    it('adjusts down a known API key in test file', () => {
+      const finding = makeFinding({ baseConfidence: 0.70, category: 'hardcoded_secret' })
+      const context = makeContext()
+      const rules: AdjustmentRule[] = [{
+        name: 'test_file',
+        source: 'file_context',
+        applies: () => true,
+        delta: -0.35,
+        reason: 'Test file',
+      }]
+
+      const result = computeConfidence(finding, context, rules, DEPTH_VERIFIED)
+      // 0.70 - 0.35 = 0.35 → validate
+      expect(result.score).toBe(0.35)
+      expect(result.routing).toBe('validate')
+    })
+
+    // Example 3: Entropy finding in scanner code (suppressed)
+    it('suppresses entropy finding in scanner code', () => {
+      const finding = makeFinding({ baseConfidence: 0.30, category: 'high_entropy_string' })
+      const context = makeContext()
+      const rules: AdjustmentRule[] = [{
+        name: 'scanner_code',
+        source: 'file_context',
+        applies: () => true,
+        delta: -0.30,
+        reason: 'Scanner code',
+      }]
+
+      const result = computeConfidence(finding, context, rules, DEPTH_VERIFIED)
+      // 0.30 - 0.30 = 0.00 → suppress
+      expect(result.score).toBe(0.00)
+      expect(result.routing).toBe('suppress')
+    })
+
+    // Example 4: Comment finding (experimental equivalent, suppressed)
+    it('suppresses a comment finding (low base confidence)', () => {
+      const finding = makeFinding({ baseConfidence: 0.15, category: 'ai_pattern' })
+      const context = makeContext()
+      const result = computeConfidence(finding, context, [], DEPTH_VERIFIED)
+
+      // 0.15 < validateThreshold(0.30) → suppress
+      expect(result.routing).toBe('suppress')
+    })
+
+    // Example 5: SSRF detection surfaces at verified depth
+    it('routes SSRF detection to validate at verified depth', () => {
+      const finding = makeFinding({ baseConfidence: 0.40, category: 'ssrf' })
+      const context = makeContext()
+      const result = computeConfidence(finding, context, [], DEPTH_VERIFIED)
+
+      // 0.40 >= validateThreshold(0.30) → validate
+      expect(result.routing).toBe('validate')
+    })
+
+    // Example 6: XXE detection surfaces directly
+    it('routes XXE detection to surface when base is high enough', () => {
+      const finding = makeFinding({ baseConfidence: 0.55, category: 'xxe' })
+      const context = makeContext()
+      // With a surface threshold of 0.55:
+      const customDepth: DepthConfig = { surfaceThreshold: 0.55, validateThreshold: 0.30, aiEnabled: true }
+      const result = computeConfidence(finding, context, [], customDepth)
+
+      expect(result.routing).toBe('surface')
+    })
+  })
+})