Files
whitemagic/openspec/changes/whitemagic-foundation/specs/function-hooking/spec.md
T
kbeandClaude Opus 4.8 4405af15fd Add whitemagic-foundation OpenSpec design; isolate reference libs
Design-only foundation for WhiteMagic, a .NET 8 x64 library unifying the
four studied process-manipulation libs. Adds proposal, design (7 decisions),
7 capability specs, and TDD task breakdown; all validate strict.

Move Blackmagic, Blackmagic-old, GreyMagic, MemorySharp, fasm into
reference/ (gitignored) — studied, not built here; each has its own
upstream repo and nested .git. Rewrite plan doc paths to reference/.

Corrects two factual defects found in review:
- current BlackMagic has no D3D EndScene hook; MainThreadPump is net-new
  built on DetourManager, not a port
- no BlackMagic.slnx exists; task 1.3 creates a fresh solution

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-21 16:50:03 +02:00

2.5 KiB

ADDED Requirements

Requirement: Reversible inline detours

WhiteMagic SHALL provide a DetourManager that creates named inline detours redirecting a target function to a managed hook, supporting Apply, Remove, and calling the original function. Detours operate in-process.

Scenario: apply redirects the target

  • WHEN a detour from a target function to a hook delegate is applied
  • THEN calling the target MUST invoke the hook delegate

Scenario: call original

  • WHEN the hook invokes CallOriginal(args)
  • THEN the original target behavior MUST execute with those arguments and its result returned

Scenario: remove restores original bytes

  • WHEN an applied detour is removed
  • THEN the target's original prologue bytes MUST be restored and calling the target MUST no longer invoke the hook

Scenario: named lookup

  • WHEN a detour is created with a name
  • THEN it MUST be retrievable from the manager by that name

Requirement: Instruction-boundary validation before splicing

Before overwriting a target prologue, the detour SHALL verify the overwrite covers whole instructions so that no instruction is split.

Scenario: aligned splice permitted

  • WHEN the bytes required for the jump cover a whole number of prologue instructions
  • THEN the detour MUST apply

Scenario: misaligned splice rejected

  • WHEN the required overwrite would end in the middle of an instruction and boundary information is available
  • THEN the detour MUST refuse to apply rather than corrupt the target

Requirement: Named reversible byte patches

WhiteMagic SHALL provide a PatchManager that creates named byte patches with Apply, Remove, and IsApplied, usable in both external and in-process modes.

Scenario: apply writes patch bytes

  • WHEN a patch is applied at an address
  • THEN memory at that address MUST equal the patch bytes

Scenario: remove restores original

  • WHEN an applied patch is removed
  • THEN memory at that address MUST equal the original bytes captured at creation

Scenario: is-applied reflects state

  • WHEN IsApplied is queried
  • THEN it MUST return true only when the current bytes equal the patch bytes

Requirement: Auto-restore on dispose

All live detours and patches SHALL be reverted when their owning MemoryBase is disposed.

Scenario: dispose reverts modifications

  • WHEN a MemoryBase with active detours and patches is disposed
  • THEN every modified region MUST be restored to its pre-modification bytes