Skip to main content

DFTK — Digital Forensics Toolkit

CI License Python PyPI

Evidence-preserving forensic primitives and composable workflows for analysts, automation systems, and autonomous agents.

🇨🇳 中文文档:README.zh-CN.md


DFTK is a capability layer, not an autonomous forensic agent. It exposes stable, structured forensic operations that can be driven directly from the CLI or composed by a higher-level Agent / TaskGraph runtime. Every operation returns a normalized Observation with explicit status, machine-readable facts, and source-traceable evidence — so upstream systems can reason about findings instead of scraping terminal output.

Why DFTK

  • Evidence-first. Reads are read-only by default; nothing mutates source evidence unless you explicitly raise the safety ceiling.
  • Zero mandatory dependencies. The base package installs cleanly anywhere with no third-party runtime requirements. Specialist parsers (E01/TSK, Windows Registry/EVTX, DKIM/SPF, SSH) are optional extras and report unsupported when absent rather than silently guessing.
  • Agent-ready. A single registry of 66 tools with JSON contracts, semantic tags, declared safety level, network gating, and produced-evidence types — designed for planners to select tools from an evidence requirement.
  • Safe by construction. READ_ONLY < STATEFUL < DESTRUCTIVE; no registered tool is DESTRUCTIVE. Network traffic is independently gated behind an explicit opt-in.

Contents

Installation

pip install dftk

Optional integrations are installed as extras:

pip install "dftk[email]"     # DKIM / SPF / DNS email authentication
pip install "dftk[ssh]"       # fixed-command read-only SSH inventory
pip install "dftk[windows]"   # Windows Registry / EVTX parsers
pip install "dftk[all]"       # every optional parser

The base package intentionally keeps zero mandatory runtime dependencies. E01 filesystem traversal additionally requires a forensic environment providing pyewf / libewf bindings and pytsk3.

Quick start

List every registered capability:

dftk list

Inspect a tool's contract (parameters, safety level, tags, produced evidence):

dftk describe android.apk_manifest

Analyze an artifact:

dftk run artifact.inspect --params '{"path":"sample.apk"}'

Extract Android manifest evidence:

dftk run android.apk_manifest --params '{"path":"sample.apk"}'

Search an APK for network endpoints:

dftk run android.apk_endpoints --params '{"path":"sample.apk"}'

Extract protocol-level observations from a capture:

dftk run network.capture_protocols --params '{"path":"traffic.pcapng"}'

Search a SQLite database without opening it read/write:

dftk run database.sqlite_search --params '{"path":"app.db","query":"example"}'

Run a bounded first-pass recipe:

dftk recipe artifact.auto_triage --params '{"path":"unknown.bin"}'

Export the full tool manifest (agent-readable):

dftk export-manifest --out manifest.json

Python / Agent API

import dftk

registry = dftk.get_registry()

observation = dftk.run_tool(
    "artifact.inspect",
    {"path": "evidence.bin"},
)

print(observation.status)   # ok | partial | error | unsupported | blocked
print(observation.facts)    # machine-readable findings
print(observation.evidence) # source + locator + value + confidence

get_registry() and run_tool() are the stable public integration entry points. Callers do not need to import primitive modules for registration side effects.

Observation contract

Every tool returns one structured Observation with distinct execution states:

status       ok | partial | error | unsupported | blocked
facts        machine-readable findings
evidence[]   source + locator + value + confidence / method / source hash
warnings[]   limitations that do not erase useful evidence
errors[]     execution or parsing failures
meta         tool and run metadata

unsupported, error, blocked, and a genuine negative finding are deliberately different states — a missing parser is not the same as "no findings".

Capability model

DFTK 2.1.0 contains a registry of 66 tools (65 READ_ONLY, 1 STATEFUL) and 13 recipes spanning:

  • artifact identification, hashing, strings, search and timeline;
  • APK, DEX, binary AXML, Android app data and endpoint extraction;
  • ELF and PE inventory plus native indicators;
  • SQLite and SQL dump analysis;
  • PCAP / PCAPNG, DNS, HTTP and TLS SNI extraction;
  • Linux root filesystems, authentication and persistence artifacts;
  • Docker metadata and logs;
  • web configuration and access logs;
  • Windows Registry, USB artifacts and EVTX through optional parsers;
  • E01 / TSK filesystem inventory through specialist forensic bindings;
  • Chromium / Edge and Firefox artifacts;
  • MIME / email authentication analysis;
  • BIP39, entropy and reversible encoding helpers.

See CAPABILITIES.md for the detailed map.

Safety model

DFTK separates execution safety from forensic reasoning:

Level Behavior
READ_ONLY reads evidence or immutable / read-only views
STATEFUL may write derived workspace output without changing source evidence
DESTRUCTIVE reserved for target-modifying actions; not registered in 2.1.0

The default policy allows only READ_ONLY operations. Network access is independently gated and must be enabled with --allow-network. Controlled archive extraction (archive.extract_safe) is STATEFUL and blocked unless the caller explicitly raises the ceiling:

dftk run archive.extract_safe \
  --max-safety STATEFUL \
  --params '{"path":"evidence.zip","output_dir":"workspace/extracted"}'

Full details — database access, archive guards, specialist-parser semantics, legacy-script policy — are in SAFETY.md.

Supported Python versions

DFTK supports CPython 3.10+ on OS-independent platforms. Verified on 3.10, 3.11, 3.12 and 3.13.

Development

git clone https://github.com/DigiForensics/DFTK.git
cd DFTK
python -m venv .venv
python -m pip install -e ".[dev]"
pytest -q

Build distributions (for maintainers):

python -m build
python -m twine check --strict dist/*

Documentation

  • ARCHITECTURE.md — public tool boundary, evidence contract, primitive-vs-recipe, promotion rules.
  • CAPABILITIES.md — full capability map by domain.
  • SAFETY.md — safety levels, network isolation, database/archive guards, specialist-parser semantics.
  • CONTRIBUTING.md — how to add a capability and open a PR.
  • SECURITY.md — vulnerability disclosure policy.
  • CHANGELOG.md — notable public changes.
  • PUBLISHING.md — release / PyPI Trusted Publishing workflow.

Contributing

Small, deterministic forensic primitives are favored over challenge-specific answer scripts. See CONTRIBUTING.md for the full guidelines, then open a pull request.

Security

Please report vulnerabilities privately — do not open a public issue. See SECURITY.md.

License

Released under the Apache License 2.0. Copyright 2026 DyNooob @ DigiForensics.

Disclaimer

DFTK is a technical toolkit, not legal advice. It is designed to support lawful, authorized forensic examination of evidence you own or are explicitly permitted to analyze. Users are responsible for compliance with applicable laws, authorization requirements, and chain-of-custody practices in their jurisdiction. The maintainers accept no liability for misuse.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dftk-2.1.1.tar.gz (91.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dftk-2.1.1-py3-none-any.whl (77.8 kB view details)

Uploaded Python 3

File details

Details for the file dftk-2.1.1.tar.gz.

File metadata

  • Download URL: dftk-2.1.1.tar.gz
  • Upload date:
  • Size: 91.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for dftk-2.1.1.tar.gz
Algorithm Hash digest
SHA256 c8a5a836c97c78ed4ff40cb57257dfea65675ad11f05aa76b208d639c27566be
MD5 66cddd6427253a3c52655bf53c881fb7
BLAKE2b-256 78fce3ebf5ff557d928cc673935f6a24bb1591781b91d421ec03132e2f28a663

See more details on using hashes here.

Provenance

The following attestation bundles were made for dftk-2.1.1.tar.gz:

Publisher: publish.yml on DigiForensics/DFTK

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dftk-2.1.1-py3-none-any.whl.

File metadata

  • Download URL: dftk-2.1.1-py3-none-any.whl
  • Upload date:
  • Size: 77.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for dftk-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 439aeec2ed008db6f03aa8772443323c296fb9dc73f2c372928945e965099be5
MD5 cc2d871f4d9e1940ce985f7c727f4286
BLAKE2b-256 46cc525e6c8523762d9cee826d6d77e3701fc0759802a57dbad4a8f09a98b809

See more details on using hashes here.

Provenance

The following attestation bundles were made for dftk-2.1.1-py3-none-any.whl:

Publisher: publish.yml on DigiForensics/DFTK

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

3.4.0

2 files

3.3.0

2 files

3.2.1

2 files

3.1.1

2 files

3.1.0

2 files

3.0.0

2 files

This release

2.1.1 This release

2 files

2.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page