model-due-diligence
is a Python command-line tool for performing static supply-chain due diligence on local AI model files and cloned model repositories before they are imported into runtimes such as Ollama, llama.cpp, LM Studio or Transformers.
It is designed to help answer one practical question:
βIs there obvious static evidence that this model artefact or repository should not be trusted, loaded or run without further review?β
It reduces practical risk from unsafe serialisation, suspicious repository content, weak provenance, exposed secrets, unexpected binaries, unsafe dependency files and malformed model metadata.
It does not prove that a model is safe.
A clean report means only that this tool did not identify the specific static artefact risks it is designed to detect. It must not be treated as proof that model weights, repository content, runtime behaviour or downstream use are benign.
What the tool doesWhat the tool does not doArchitectureScanner coverageRisk scoringInstallQuick startCLI referenceExample workflowsReports and outputsRecommended operating modelDevelopment workflowTesting and quality gatesRepository structureSecurity postureStandards alignmentLimitationsRoadmapContributingLicence
model-due-diligence
statically inspects a local path and generates reviewable evidence.
It checks:
- file inventory, SHA-256 hashes, permissions and symlinks;
- high-risk serialisation formats such as pickle,
.pt
,.pth
,.bin
,.joblib
and H5; - lower-risk model formats such as
.gguf
,.safetensors
and.onnx
; - GGUF magic bytes and version metadata;
- safetensors header metadata;
- suspicious text and binary strings;
- Python AST indicators such as
eval
,exec
,compile
,pickle.loads
,os.system
andsubprocess
; trust_remote_code=True
usage in Python and text files;- risky pickle-like byte markers in high-risk serialisation formats;
- high-entropy non-model files;
- Git provenance, origin remote, current commit, dirty worktree and Git LFS listing where available;
- external scanner output from ModelScan, Semgrep, Bandit, pip-audit and detect-secrets;
- optional quality self-checks using Ruff, Pyright and mypy.
The tool produces:
- a human-readable Markdown report;
- a deterministic JSON report for automation;
- an optional SARIF report for code-scanning workflows;
- raw external scanner outputs where external tools are run.
The tool is intentionally static. During normal scanning it does not:
- load model weights;
- import untrusted repository code;
- execute model-specific scripts;
- run model inference;
- send artefacts to external services;
- require network access for local scanning;
- decide automatically that a model is safe.
Static scanning cannot reliably detect:
- malicious behaviour encoded directly into model weights;
- sleeper-agent or trigger-based backdoors;
- training-data poisoning;
- benchmark-specific manipulation;
- malicious behaviour that appears only after fine-tuning;
- malicious behaviour that appears only after tools are connected;
- prompt-injection obedience in downstream RAG or agent workflows;
- data exfiltration behaviour that only appears at runtime;
- vulnerabilities in local model runtimes;
- all unsafe deserialisation evasions.
Use it as a risk-reduction gate, not as a trust oracle.
The project uses a modular monolith architecture. This keeps installation and local execution simple while maintaining clear internal boundaries between CLI, orchestration, scanners, risk scoring and reports.
flowchart LR
user[User / CI] --> cli[CLI]
cli --> app[Application Orchestrator]
app --> inventory[File Inventory]
app --> native[Native Static Scanners]
app --> external[External Scanner Adapters]
app --> risk[Risk Scorer]
risk --> report_model[Audit Report Model]
app --> report_model
report_model --> markdown[Markdown Report]
report_model --> json[JSON Report]
report_model --> sarif[SARIF Report]
native --> text[Text Patterns]
native --> ast[Python AST]
native --> binary[Binary Strings]
native --> entropy[Entropy]
native --> metadata[Model Metadata]
native --> pickle[Pickle Heuristics]
native --> git[Git Provenance]
external --> modelscan[ModelScan]
external --> semgrep[Semgrep]
external --> bandit[Bandit]
external --> pipaudit[pip-audit]
external --> secrets[detect-secrets]
external --> quality[Quality Self-Checks]
sequenceDiagram
participant U as User / CI
participant C as CLI
participant A as App
participant I as Inventory
participant N as Native Scanners
participant E as External Scanners
participant R as Risk Scorer
participant W as Report Writers
U->>C: mdd <target> --out <dir>
C->>C: Parse arguments and build ScanContext
C->>A: Run scan
A->>I: Build file inventory and hashes
I-->>A: FileRecord[] + Finding[]
A->>N: Run static native scanners
N-->>A: Finding[] + ModelMetadata[]
A->>E: Run optional external scanners
E-->>A: CommandResult[] + Finding[]
A->>R: Score findings and tool outcomes
R-->>A: Risk score + risk level
A-->>C: AuditReport
C->>W: Write Markdown / JSON / SARIF
C-->>U: Print risk score, risk level and report paths
Dependencies should flow in one direction:
cli -> app -> domain
app -> inventory
app -> scanners
app -> external
app -> reporting
scanners -> domain/config/utils
external -> domain/config/command_runner
reporting -> domain/config
Rules:
- scanners must not import
app
; - reporters must not run scanners;
- external adapters must not write final project reports directly;
- domain models must not depend on filesystem, subprocess or reporting modules;
- native scanners must not execute model artefacts or repository code.
| Coverage area | Native support | External support | Status |
|---|---|---|---|
| File inventory, hashes and permissions | Yes | No | Covered |
| Symlink detection | Yes | No | Covered |
| Executable/script detection | Yes | Semgrep / Bandit | Covered |
| High-risk serialisation detection | Yes | ModelScan | Covered |
| Pickle heuristic indicators | Yes | ModelScan | Covered |
| GGUF header inspection | Yes | No | Basic coverage |
| Safetensors header inspection | Yes | No | Basic coverage |
| Suspicious text/code patterns | Yes | Semgrep / Bandit | Covered |
| Python AST dangerous-call detection | Yes | Bandit / CodeQL | Covered |
| Binary string indicators | Yes | No | Basic coverage |
| High-entropy anomaly detection | Yes | No | Basic coverage |
| Secrets detection | Yes | detect-secrets | Covered |
| Dependency vulnerability checks | No | pip-audit / Dependabot | Covered for requirements.txt |
| Git provenance checks | Yes | No | Basic coverage |
| Project code quality | No | Ruff / Pyright / mypy / pytest | Covered |
| Repository semantic security analysis | No | CodeQL | Covered in GitHub Actions |
| SARIF output | Yes | CodeQL native SARIF | Partial |
| SBOM generation | No | No | Planned |
| Sigstore / SLSA provenance | No | No | Planned |
| Licence compatibility checks | No | No | Planned |
| Model-card quality checks | No | No | Planned |
| Weight-level backdoor detection | No | No | Not reliably detectable |
| Runtime behavioural testing | No | No | Planned separately |
Findings are normalised into severities and converted into a bounded score from 0
to 100
.
| Severity | Current score contribution |
|---|---|
| INFO | 0 |
| LOW | 3 |
| MEDIUM | 10 |
| HIGH | 30 |
| CRITICAL | 60 |
External scanner non-zero exits can also contribute to the score when the tool was available and produced reviewable signals.
| Risk level | Score range | Meaning | Recommended action |
|---|---|---|---|
| LOW | 0-29 | No obvious supported static artefact risks were found | Acceptable for sandboxed first run |
| MEDIUM | 30-69 | Reviewable findings exist | Do not import until findings are understood |
| HIGH | 70-89 | Material risk indicators exist | Do not load unless every finding is justified |
| CRITICAL | 90-100 | Severe or multiple high-risk indicators exist | Treat as unsafe by default |
The score is intentionally conservative. It is a decision aid, not an automated trust verdict.
- Python 3.11 or later;
- Git;
- a Unix-like shell for the provided scripts;
- optional external scanner CLIs if you want full coverage.
python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e ".[dev,scanners]"
Or use the setup script:
./scripts/dev-setup.sh
For a lighter install without optional scanner integrations:
./scripts/dev-setup.sh --no-scanners
mdd --help
mdd-ollama --help
model-due-diligence --help
python -m model_due_diligence --help
Scan a cloned model repository:
mdd ./downloaded-model --out ./audit
Scan a local GGUF file:
mdd ~/models/qwen.gguf --out ./audit-qwen
Scan an installed Ollama model by name:
mdd-ollama qwen3:4b --out ./audit-qwen3-ollama
Fail the command when the risk level is medium or above:
mdd ./downloaded-model --out ./audit --fail-on medium
Run a fast smoke scan without optional external tools:
mdd tests/fixtures/safe_repo \
--out ./audit-smoke \
--fail-on critical \
--skip-external
Generate only JSON output:
mdd ./downloaded-model \
--out ./audit-json \
--format json
usage: model-due-diligence [-h] [--out OUT] [--timeout TIMEOUT]
[--format FORMATS] [--skip-external]
[--skip-modelscan] [--skip-semgrep]
[--skip-bandit] [--skip-pip-audit]
[--skip-detect-secrets]
[--skip-quality-self-check]
[--quality-self-check]
[--fail-on {low,medium,high,critical}]
[--version]
target
| Argument | Description |
|---|---|
target |
|
| Path to a model file or model directory | |
--out |
|
| Output report directory | |
--timeout |
|
| Per-tool timeout in seconds | |
--format |
|
Comma-separated report formats: markdown,json,sarif |
|
--skip-external |
|
| Skip all optional external scanner tools | |
--skip-modelscan |
|
| Skip ModelScan only | |
--skip-semgrep |
|
| Skip Semgrep only | |
--skip-bandit |
|
| Skip Bandit only | |
--skip-pip-audit |
|
| Skip pip-audit only | |
--skip-detect-secrets |
|
| Skip detect-secrets only | |
--quality-self-check |
|
| Run Ruff, Pyright and mypy against this project as optional self-checks | |
--skip-quality-self-check |
|
| Skip quality self-checks | |
--fail-on |
|
| Return non-zero when risk is at or above the selected level | |
--version |
|
| Print package version |
mdd-ollama
resolves an installed Ollama model from the local
OLLAMA_MODELS
store, stages scan-friendly filenames in a temporary directory, and then runs the normal static due-diligence flow on that staged directory.
It does not require the Ollama server to be running as long as the local manifest and blob store is present.
usage: mdd-ollama [-h] [--ollama-models-dir OLLAMA_MODELS_DIR] [--out OUT]
[--timeout TIMEOUT] [--format FORMATS] [--skip-external]
[--skip-modelscan] [--skip-semgrep] [--skip-bandit]
[--skip-pip-audit] [--skip-detect-secrets]
[--skip-quality-self-check] [--quality-self-check]
[--fail-on {low,medium,high,critical}] [--keep-staged]
model
Typical usage:
mdd-ollama llama3:8b --out ./audit-llama3
For an uninstalled checkout, run it with:
PYTHONPATH=src python3 -m model_due_diligence.ollama_cli llama3:8b --out ./audit-llama3
Use the helper script:
./examples/audit-huggingface-clone.sh \
https://huggingface.co/Qwen/Qwen3-8B-GGUF \
./audit-qwen3
The script clones into a temporary directory, runs the scanner, writes reports to the output directory and removes the temporary clone afterwards.
./examples/audit-local-gguf.sh \
~/models/qwen3-8b-q4_k_m.gguf \
./audit-qwen3-gguf
./examples/audit-installed-ollama.sh \
qwen3:4b \
./audit-qwen3-ollama
A conservative CI smoke gate can run without optional external scanners:
mdd tests/fixtures/safe_repo \
--out ./audit-smoke \
--fail-on critical \
--skip-external
A fuller CI gate can install scanner extras and run:
mdd ./downloaded-model \
--out ./audit \
--fail-on high
A normal run can produce:
audit/
βββ model_due_diligence_report.md
βββ model_due_diligence_report.json
βββ model_due_diligence_report.sarif
βββ modelscan.json
βββ semgrep.json
βββ bandit.json
βββ pip-audit-<hash>.json
βββ detect-secrets.json
| File | Purpose |
|---|---|
model_due_diligence_report.md |
|
| Human-readable review report | |
model_due_diligence_report.json |
|
| Machine-readable deterministic report | |
model_due_diligence_report.sarif |
|
| Static-analysis output suitable for code-scanning workflows | |
modelscan.json |
|
| Raw ModelScan output | |
semgrep.json |
|
| Raw Semgrep output | |
bandit.json |
|
| Raw Bandit output | |
pip-audit-<hash>.json |
|
| Raw pip-audit output per requirements file | |
detect-secrets.json |
|
| Raw detect-secrets output |
Generated audit outputs may contain local paths, hashes, snippets and scanner evidence. Do not commit them unless you have reviewed them for sensitive content.
Use model-due-diligence
as one control in a broader model supply-chain process:
Official or reputable source
+ pinned commit or hash
+ static due-diligence scan
+ first run in a no-network sandbox
+ no credentials mounted
+ restricted filesystem access
+ adversarial behavioural test suite
+ runtime monitoring
+ human review
= reasonable practical risk reduction
Recommended practice:
- Prefer official publisher repositories or reputable quantisers.
- Avoid floating tags such as
latest
for operational use. - Pin exact Git revisions and record SHA-256 hashes.
- Run
model-due-diligence
before importing or artefacts. - Review all HIGH and CRITICAL findings manually.
- Run first inference in a network-disabled container or VM.
- Do not mount API keys, SSH keys, cloud credentials or client data.
- Test prompt-injection and tool-use behaviour before RAG or agent deployment.
- Keep reports and accepted hashes for reproducibility.
Set up the environment:
./scripts/dev-setup.sh
source .venv/bin/activate
Run quality gates:
./scripts/run-quality.sh
Run tests:
./scripts/run-tests.sh
Build the package:
./scripts/build-package.sh
Build without running local checks first:
./scripts/build-package.sh --skip-checks
The expected local quality gates are:
ruff format --check src tests
ruff check src tests
pyright
mypy src tests
pytest
mdd tests/fixtures/safe_repo --out ./audit-smoke --fail-on critical --skip-external
The helper script runs the same pattern:
./scripts/run-quality.sh
Use fix mode for Ruff formatting and safe lint fixes:
./scripts/run-quality.sh --fix
Run unit tests only:
./scripts/run-tests.sh --unit
Run integration tests only:
./scripts/run-tests.sh --integration
Run with coverage:
./scripts/run-tests.sh --coverage
model-due-diligence/
βββ .github/
β βββ workflows/
β β βββ ci.yml
β β βββ codeql.yml
β β βββ release.yml
β βββ dependabot.yml
β βββ pull_request_template.md
βββ docs/
β βββ architecture.md
β βββ contribution-guide.md
β βββ limitations.md
β βββ scanner-coverage.md
β βββ standards-alignment.md
β βββ threat-model.md
βββ examples/
β βββ audit-installed-ollama.sh
β βββ audit-huggingface-clone.sh
β βββ audit-local-gguf.sh
β βββ sample-report.md
βββ scripts/
β βββ build-package.sh
β βββ dev-setup.sh
β βββ run-quality.sh
β βββ run-tests.sh
βββ src/model_due_diligence/
β βββ cli.py
β βββ app.py
β βββ config/
β βββ domain/
β βββ external/
β βββ inventory/
β βββ ollama.py
β βββ ollama_cli.py
β βββ reporting/
β βββ scanners/
β βββ utils.py
βββ tests/
β βββ fixtures/
β βββ integration/
β βββ unit/
βββ .env.example
βββ .gitattributes
βββ .gitignore
βββ .python-version
βββ LICENSE
βββ pyproject.toml
βββ README.md
The project follows these design rules:
- static by default;
- no model execution during scanning;
- no untrusted repository code execution during scanning;
- no shell invocation for external scanner commands;
- external tool failures are visible in reports;
- findings include severity, category, file, message, evidence where available and recommendation;
- missing scanners are reported rather than silently ignored;
- generated reports are ignored by Git by default;
- real model artefacts are ignored by Git by default;
- dependency updates are managed through Dependabot;
- CodeQL runs through GitHub Actions;
- releases build source and wheel distributions and validate metadata before publishing.
An explicit control mapping for relevant NIST, MITRE, and OWASP guidance is in docs/standards-alignment.md.
A clean report does not mean a model is safe.
Static checks cannot reliably detect:
- subtle weight-level backdoors;
- sleeper-agent behaviour;
- poisoned training data;
- malicious behaviour activated by rare prompts;
- malicious behaviour activated only through tool use;
- all deserialisation evasions;
- all obfuscated payloads;
- prompt-injection obedience in downstream RAG or agent workflows;
- runtime exfiltration behaviour;
- vulnerabilities in Ollama, llama.cpp, LM Studio, Transformers or other runtimes.
This tool should not be the sole approval mechanism for regulated production deployment, client-data processing, internet-connected agentic systems, autonomous coding agents with write access, or systems with access to secrets or privileged infrastructure.
Planned or candidate improvements:
- fuller GGUF metadata validation;
- safetensors tensor offset and shape validation;
- Hugging Face metadata retrieval using pinned revisions;
- SBOM generation;
- Sigstore or SLSA provenance checks;
- licence compatibility checks;
- model-card quality scoring;
- SARIF upload workflow;
- sandboxed behavioural test harness for local inference;
- prompt-injection and tool-use behavioural tests for RAG and agent workloads.
See docs/contribution-guide.md.
Before opening a pull request, run:
./scripts/run-quality.sh
Contributions should preserve the projectβs core boundary: scanning must remain static by default and must not execute untrusted model artefacts or repository code.
Licensed under the Apache License, Version 2.0. See LICENSE.