Get the FREE Ultimate OpenClaw Setup Guide →

Defense-in-Depth Validation

Scanned
npx machina-cli add skill zircote/agents/defense-in-depth --openclaw
Files (1)
SKILL.md
3.8 KB

Defense-in-Depth Validation

Overview

When you fix a bug caused by invalid data, adding validation at one place feels sufficient. But that single check can be bypassed by different code paths, refactoring, or mocks.

Core principle: Validate at EVERY layer data passes through. Make the bug structurally impossible.

Why Multiple Layers

Single validation: "We fixed the bug" Multiple layers: "We made the bug impossible"

Different layers catch different cases:

  • Entry validation catches most bugs
  • Business logic catches edge cases
  • Environment guards prevent context-specific dangers
  • Debug logging helps when other layers fail

The Four Layers

Layer 1: Entry Point Validation

Purpose: Reject obviously invalid input at API boundary

function createProject(name: string, workingDirectory: string) {
  if (!workingDirectory || workingDirectory.trim() === '') {
    throw new Error('workingDirectory cannot be empty');
  }
  if (!existsSync(workingDirectory)) {
    throw new Error(`workingDirectory does not exist: ${workingDirectory}`);
  }
  if (!statSync(workingDirectory).isDirectory()) {
    throw new Error(`workingDirectory is not a directory: ${workingDirectory}`);
  }
  // ... proceed
}

Layer 2: Business Logic Validation

Purpose: Ensure data makes sense for this operation

function initializeWorkspace(projectDir: string, sessionId: string) {
  if (!projectDir) {
    throw new Error('projectDir required for workspace initialization');
  }
  // ... proceed
}

Layer 3: Environment Guards

Purpose: Prevent dangerous operations in specific contexts

async function gitInit(directory: string) {
  // In tests, refuse git init outside temp directories
  if (process.env.NODE_ENV === 'test') {
    const normalized = normalize(resolve(directory));
    const tmpDir = normalize(resolve(tmpdir()));

    if (!normalized.startsWith(tmpDir)) {
      throw new Error(
        `Refusing git init outside temp dir during tests: ${directory}`
      );
    }
  }
  // ... proceed
}

Layer 4: Debug Instrumentation

Purpose: Capture context for forensics

async function gitInit(directory: string) {
  const stack = new Error().stack;
  logger.debug('About to git init', {
    directory,
    cwd: process.cwd(),
    stack,
  });
  // ... proceed
}

Applying the Pattern

When you find a bug:

  1. Trace the data flow - Where does bad value originate? Where used?
  2. Map all checkpoints - List every point data passes through
  3. Add validation at each layer - Entry, business, environment, debug
  4. Test each layer - Try to bypass layer 1, verify layer 2 catches it

Example from Session

Bug: Empty projectDir caused git init in source code

Data flow:

  1. Test setup → empty string
  2. Project.create(name, '')
  3. WorkspaceManager.createWorkspace('')
  4. git init runs in process.cwd()

Four layers added:

  • Layer 1: Project.create() validates not empty/exists/writable
  • Layer 2: WorkspaceManager validates projectDir not empty
  • Layer 3: WorktreeManager refuses git init outside tmpdir in tests
  • Layer 4: Stack trace logging before git init

Result: All 1847 tests passed, bug impossible to reproduce

Key Insight

All four layers were necessary. During testing, each layer caught bugs the others missed:

  • Different code paths bypassed entry validation
  • Mocks bypassed business logic checks
  • Edge cases on different platforms needed environment guards
  • Debug logging identified structural misuse

Don't stop at one validation point. Add checks at every layer.

Source

git clone https://github.com/zircote/agents/blob/main/skills/debugging/defense-in-depth/SKILL.mdView on GitHub

Overview

Defense-in-Depth Validation enforces checks at every data touchpoint instead of relying on a single validation. By validating at entry, business logic, environment guards, and debug instrumentation, you reduce the chance of bugs slipping through refactors or mocks and make issues structurally impossible.

How This Skill Works

Split validation into four layers: Entry Point Validation, Business Logic Validation, Environment Guards, and Debug Instrumentation. Each layer validates the data it handles, and debug logging provides context for forensic analysis when a failure occurs. Tests should attempt to bypass outer layers to verify that inner layers still catch issues.

When to Use It

  • When invalid data causes failures deep in execution and a single check isn't enough
  • When different code paths bypass a single validation and multi-layer coverage is needed
  • When you operate across APIs and services where each layer can protect against distinct failure modes
  • When you want context-specific safety checks that depend on environment or runtime context
  • When you need debug traces to diagnose data misuse across layers

Quick Start

  1. Step 1: Trace the data flow from source to usage
  2. Step 2: Map all checkpoints where data passes through
  3. Step 3: Add validations at entry, business, environment, and debug layers and test bypass attempts

Best Practices

  • Map the data flow from source to usage
  • Validate at entry, business logic, environment, and debug layers
  • Write tests that attempt to bypass Layer 1 to ensure Layer 2+ catches it
  • Keep error messages actionable and specific to the layer
  • Add structured, searchable debug logs for forensics

Example Use Cases

  • Layer 1 entry point: validate input exists and is a directory (e.g., workingDirectory checks)
  • Layer 2 business logic: validate essential parameters like projectDir are not empty
  • Layer 3 environment guards: prevent dangerous operations in non-permissive contexts (eg tests)
  • Layer 4 debug instrumentation: log context and stack trace before critical actions
  • Result: applying all four layers reduces flaky behavior and makes bugs hard to reproduce

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers