Feature: Add System Patterns for UUID and File Path Redaction

[matthewgoluba]

To support redaction of technical logs (specifically NSX/ESX logs), the core engine needs to identify and redact system-level identifiers.
Currently, the engine focuses on PII. We need to expand this to include:

• UUIDs: Universally Unique Identifiers common in log lines.
• File Paths: Windows and Unix style file paths and folder names.

Tasks:

• Create packages/core/src/patterns/system.ts.
• Implement UUIDPattern regex.
• Implement FilePathPattern regex (handling both \ and /).
• Export new patterns in packages/core/src/index.ts.
• Add unit tests for these patterns to ensure they don't false-positive on regular text.

[goobz22]

Implementation Notes Based on Codebase Review

Existing Architecture

The pattern system is well-established in packages/core/src/patterns/. Current pattern files:

• base.ts - BasePattern class with name, regex, strategy, enabled, test(), findAll()
• network.ts - IPv4, IPv6, MAC, Hostname patterns
• personal.ts - Email, Phone, SSN, Name patterns
• financial.ts - CreditCard patterns
• business.ts - TicketNumber pattern

Suggested Implementation

File to create: packages/core/src/patterns/system.ts

import { BasePattern } from './base';

export class UUIDPattern extends BasePattern {
  constructor() {
    super(
      'uuid',
      /\b[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}\b/g,
      'token'
    );
  }
}

export class FilePathPattern extends BasePattern {
  constructor() {
    super(
      'filePath',
      // Windows: C:\Users\... or Unix: /home/user/...
      /(?:[A-Za-z]:\[\w\.-]+|\/(?:[\w.-]+\/)+[\w.-]+)/g,
      'token'
    );
  }
}

Required Changes

1. Export in patterns/index.ts:

   export { UUIDPattern, FilePathPattern } from './system';

2. Add to types.ts PatternConfig:

   patterns?: {
     // ... existing
     uuid?: PatternConfig;
     filePath?: PatternConfig;
   }

3. Add to config.ts DEFAULT_CONFIG:

   uuid: { enabled: true, strategy: 'token' },
   filePath: { enabled: true, strategy: 'token' },

4. Update engine.ts - Add to pattern initialization in constructor

5. Add test data to DEFAULT_CONFIG.testData:

   UUID: 550e8400-e29b-41d4-a716-446655440000
   Path: /var/log/syslog or C:\Windows\System32\config
   

Testing Considerations

• UUID regex should NOT match partial UUIDs or malformed ones
• File paths need careful testing to avoid false positives on URLs
• Consider adding UNCPathPattern for \server\share format

[goobz22]

Implementation Complete

Added UUID and FilePath pattern detection in packages/core/src/patterns/system.ts:

UUIDPattern

• Detects standard UUID format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

FilePathPattern

• Detects Windows paths: C:\Users\...
• Detects Unix paths: /home/user/...

Files Changed

• packages/core/src/patterns/system.ts - New pattern classes
• packages/core/src/patterns/index.ts - Exports
• packages/core/src/types.ts - Added uuid/filePath to interface
• packages/core/src/config.ts - Defaults and test data
• packages/core/src/engine.ts - Pattern initialization

Build verified. Ready to close.

[goobz22]

Correction: Unit tests still need to be added. See updated task list above.