Skip to content
mandiantPublic

About

Windows kernel and user mode emulation.

Topics

Resources

Stars

2.1k stars

Watchers

52 watching

Forks

Repository files navigation

Speakeasy

Speakeasy is a Windows malware emulation framework that executes binaries, drivers and shellcode in a modeled Windows runtime instead of a full VM. It emulates the Windows APIs, processes, threads, file system, registry and network that a sample uses, so the sample runs further than in a bare CPU emulator. The speakeasy CLI writes the report as JSON for triage, and the Python library returns the same report to your code.

For background, see Mandiant's introduction to Speakeasy.

Quick start

Install from PyPI:

python3 -m pip install speakeasy-emulator

Emulate a sample and print some fields of the report. Replace sample.dll with your file:

speakeasy -t sample.dll --no-mp -o report.json 2>/dev/null
jq '{sha256, arch, file_type, runs: (.runs | length)}' report.json

The values depend on the sample:

{
  "sha256": "…",
  "arch": "x86",
  "file_type": "dll",
  "runs": 3
}

By default, Speakeasy turns on all its features: it runs the exports and the child processes, and the report has coverage, memory access counts and the final memory contents. Each feature has a --no- flag that turns it off, for example --no-code-coverage. A run with fewer features is faster and gives a smaller report. The CLI reference lists the flags.

Documentation

Start with installation, Python library usage and the CLI reference. The documentation index lists all pages.

For help, see doc/help.md or open an issue at github.com/mandiant/speakeasy/issues.

About

Windows kernel and user mode emulation.

Topics

Resources

Stars

2.1k stars

Watchers

52 watching

Forks

Releases

Packages

Used by

Contributors

Languages