Skip to content

Fuzzing.md

Latest commit

 

History

History
85 lines (55 loc) · 2.13 KB

Fuzzing.md

File metadata and controls

85 lines (55 loc) · 2.13 KB
Raw

Fuzzing MFCMAPI

MFCMAPI supports fuzzing with libFuzzer and the fsanitize switch in Visual Studio. See fuzz.cpp for implementation details.

Prerequisites

  • Visual Studio 2026 with the Fuzz build configuration
  • PowerShell for corpus generation

Quick Start

# 1. Generate the corpus (converts hex test data to binary)
npm run fuzz:corpus

# 2. Build the fuzz configuration
npm run build:fuzz

# 3. Run the fuzzer
npm run fuzz

Building the Fuzzing Corpus

The fuzzer needs binary input files. The unit test data is stored as hex strings in .dat files. Run the corpus builder to convert them:

npm run fuzz:corpus

This reads from UnitTest/SmartViewTestData/In/*.dat and writes binary files to fuzz/corpus/.

Note: You must run this before fuzzing. The corpus directory won't exist until you do.

Building the Fuzz Configuration

From Command Line

npm run build:fuzz

From Visual Studio

  1. Open MFCMapi.sln in Visual Studio 2026
  2. Select Fuzz from the Solution Configurations dropdown
  3. Build the solution

Running the Fuzzer

From VS Code

  1. Run pwsh .\fuzz\Build-FuzzingCorpus.ps1 first (if you haven't already)
  2. Open the Run and Debug panel (Ctrl+Shift+D)
  3. Select "Fuzz (x64)" or "Fuzz (x86)" from the configuration dropdown
  4. Press F5 to start

The fuzzer runs for 60 seconds by default.

To change the runtime in the debug panel, edit the selected fuzz entry in .vscode/launch.json and update the "-MaxTotalTime", "60" arguments.

From Command Line

npm run fuzz
# or
npm run fuzz:x86

To run longer or shorter from command line:

npm run fuzz:x64 -- -MaxTotalTime 300
npm run fuzz:x86 -- -MaxTotalTime 120

From Visual Studio

  1. Open MFCMapi.sln in Visual Studio
  2. Select the fuzz/x64 project (or fuzz/x86)
  3. Press F5 to run

Artifacts

When the fuzzer discovers a crash or hang, it saves the input that caused it to fuzz/artifacts/. These files can be used to reproduce and debug the issue.