Metadata-Version: 2.5
Name: filevet
Version: 0.2.0
Summary: Self-hosted scanner that inspects financial files for security risks before they are opened or ingested. Name reserved, under active development.
Project-URL: Homepage, https://github.com/pablodt00/filevet
Project-URL: Issues, https://github.com/pablodt00/filevet/issues
Author: Pablo Durán
License-Expression: Apache-2.0
License-File: LICENSE
License-File: NOTICE
Classifier: Development Status :: 1 - Planning
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Security
Requires-Python: >=3.11
Requires-Dist: charset-normalizer>=3.5.2
Requires-Dist: defusedxml>=0.7.1
Requires-Dist: olefile>=0.47
Requires-Dist: pydantic>=2
Requires-Dist: rich>=15.0.0
Requires-Dist: xmlschema>=4.3.2
Requires-Dist: yara-python>=4.5.4
Description-Content-Type: text/markdown

# filevet

Self-hosted, open-source scanner that checks the files finance teams receive for security risks before anyone opens or ingests them.

[![CI](https://github.com/pablodt00/filevet/actions/workflows/ci.yml/badge.svg)](https://github.com/pablodt00/filevet/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/filevet)](https://pypi.org/project/filevet/)
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/pablodt00/filevet/badge)](https://scorecard.dev/viewer/?uri=github.com/pablodt00/filevet)
[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/pablodt00/filevet/blob/master/LICENSE)

## Why

Fintechs and finance teams take in files from outside every day: invoices, bank statements, KYC documents, payment files. Any of them can carry malware, exploit the parser that reads it, or hide instructions meant for an AI system further down the line. Commercial scanners are closed and expensive, and the open-source ones don't understand financial formats like ISO 20022. filevet runs several independent analyzers over a file and returns one report you can act on.

## Status

> [!WARNING]
> filevet is pre-1.0. It detects active content, known malware and parser attacks in PDF, CSV, XLSX and legacy Office files, ISO 20022 XML and ZIP archives, but it hasn't been tested against real-world traffic yet. Until 1.0, the CLI, report format and Python API may change between minor versions.

## Quickstart

```sh
pipx install filevet
# or
uv tool install filevet

filevet scan statement.pdf
```

With Docker, without network access and with the file mounted read-only:

```sh
docker run --rm --network none --read-only --tmpfs /tmp -v "$PWD:/in:ro" ghcr.io/pablodt00/filevet scan /in/statement.pdf
```

To add ClamAV signature scanning, use the Compose file, which runs `clamd` as a sidecar and shares its socket with filevet:

```sh
docker compose --profile clamav up -d clamav
docker compose run --rm filevet scan /in/statement.pdf
```

filevet alone needs about 200 MB of RAM. With ClamAV, plan for 1 to 2 GB more for its signature database.

## Example

```sh
filevet scan invoice.pdf
```

Trimmed output from a file named `invoice.pdf` that's really a Windows executable (the format may still change):

```json
{
  "filevet_version": "0.1.1",
  "artifacts": [
    {
      "id": "1bf01f46-66b9-4b57-a40c-031d8d71615f",
      "name": "invoice.pdf",
      "sha256": "9f2c…e41a",
      "declared_type": "pdf",
      "detected_type": "pe",
      "depth": 0
    }
  ],
  "findings": [
    {
      "rule_id": "basic.type_mismatch",
      "title": "File content does not match its extension",
      "severity": "critical",
      "confidence": 1.0,
      "evidence": "invoice.pdf",
      "references": ["https://cwe.mitre.org/data/definitions/434.html"],
      "analyzer": "basic.type_mismatch/0.1.0"
    }
  ],
  "summary": { "critical": 1, "high": 1, "medium": 0, "low": 0, "info": 0 },
  "verdict": "block"
}
```

`--format table` prints the same report as a table for people. The full report format is in [docs/schema/report.schema.json](https://github.com/pablodt00/filevet/blob/master/docs/schema/report.schema.json), and `filevet schema` prints it too.

Other commands: `filevet analyzers` lists the registered analyzers, and `filevet version` prints the version.

### Exit codes

CI jobs can act on the exit code of `filevet scan` without parsing the report.

| Code | Meaning |
| --- | --- |
| `0` | No findings of `medium` or higher (verdict `pass`) |
| `1` | At least one `medium` finding (verdict `review`) |
| `2` | At least one `high` or `critical` finding (verdict `block`) |
| `3` | Usage error, including a missing input file or one over the size limit |
| `4` | Internal error in filevet |

## What it checks

Each rule has a page in [docs/rules/](https://github.com/pablodt00/filevet/tree/master/docs/rules) that explains what it means, why it matters for finance files, how to fix the file and when it can be a false positive.

| Rule ID | File types | Detects | Severity | References |
| --- | --- | --- | --- | --- |
| `basic.type_mismatch` | All | Extension doesn't match the content | medium, critical for disguised executables | [CWE-434](https://cwe.mitre.org/data/definitions/434.html) |
| `basic.executable` | All | Programs, scripts and `.lnk` shortcuts | high | [CWE-434](https://cwe.mitre.org/data/definitions/434.html) |
| `malware.clamav` (optional) | All | Known malware signatures, via a ClamAV sidecar | critical | [ADR 5](https://github.com/pablodt00/filevet/blob/master/docs/adr/0005-clamav-optional-sidecar.md) |
| `malware.yara` | All | Bundled or your own YARA rules: embedded PE and `.lnk` headers, DDE commands, XXE, PDF auto-run | from the rule, medium by default | [YARA](https://virustotal.github.io/yara/) |
| `malware.pdf_active_content` | PDF | JavaScript, launch actions, auto-actions, rich media, XFA, form submission, URIs, embedded files, hex-obfuscated names, filter chains | low to critical | [CWE-829](https://cwe.mitre.org/data/definitions/829.html) |
| `malware.office_macros` | XLSX, XLSM, DOCX, DOCM, XLS, DOC | VBA, auto-run macros, `Shell`/`CreateObject`/`URLDownloadToFile`, XLM macro sheets, DDE, remote template injection | medium to critical | [ATT&CK T1137](https://attack.mitre.org/techniques/T1137/), [T1221](https://attack.mitre.org/techniques/T1221/), CVE-2017-0199 |
| `malware.embedded_executable` | All containers | PE, ELF, Mach-O, scripts or `.lnk` files inside another file | critical | [ATT&CK T1027.009](https://attack.mitre.org/techniques/T1027/009/) |
| `parser.csv_formula_injection` | CSV, XLSX | Cells that spreadsheet apps run as formulas, including hidden prefixes, full-width characters and DDE payloads | medium, high | [OWASP](https://owasp.org/www-community/attacks/CSV_Injection), [CWE-1236](https://cwe.mitre.org/data/definitions/1236.html) |
| `parser.xml_unsafe` | XML, ISO 20022 | DTDs, external and parameter entities, entity expansion, XInclude, deep nesting | medium to critical | [CWE-611](https://cwe.mitre.org/data/definitions/611.html), [CWE-776](https://cwe.mitre.org/data/definitions/776.html) |
| `parser.archive_bomb` | ZIP, OOXML | Extreme compression ratios, nested archives, too many entries, overlapping entries, quines | high, critical | [CWE-409](https://cwe.mitre.org/data/definitions/409.html) |
| `parser.path_traversal` | ZIP, OOXML | `../` entries, absolute paths, drive letters, symbolic links | high | [CWE-22](https://cwe.mitre.org/data/definitions/22.html) |
| `parser.polyglot` | All | Files that are valid as more than one type | medium | [CWE-434](https://cwe.mitre.org/data/definitions/434.html) |
| `parser.malformed` | All | Broken structure that viewers would repair, each in its own way | medium | |
| `format.iso20022_schema` | ISO 20022 XML | camt.052/053/054, pain.001/008 and pacs.008 messages that don't match their XSD | low | [ISO 20022](https://www.iso20022.org/iso-20022-message-definitions) |

### Configuration

| Variable | Effect |
| --- | --- |
| `FILEVET_CLAMD` | Address of `clamd`: `unix:/path/clamd.sock` or `tcp:host:port`. Without it, ClamAV isn't used |
| `FILEVET_YARA_RULES` | Directories of extra `.yar` files, separated by `:` |
| `FILEVET_XSD_DIR` | Directory of ISO 20022 XSDs, one `<message>.xsd` per version, such as `camt.053.001.08.xsd` |

The synthetic test corpus in `tests/corpus/cases/` has one case per threat and per legitimate look-alike. `uv run pytest tests/corpus` prints a detection matrix showing which rules fire on which case.

## Limitations

- filevet never declares a file safe. It reports what it checked and what it found, and no scanner catches everything.
- PDFs are scanned as raw objects. Content hidden behind encryption, or behind filters other than Flate, isn't decoded.
- 7z, RAR and gzip archives are detected but not extracted, so their contents aren't scanned.
- VBA is found by its source text. P-code-only projects (VBA stomping) can get past it.
- No ISO 20022 XSDs ship with filevet yet, so schema validation only runs once you supply them.
- The rules are tested against a synthetic corpus, not real-world malware.
- It doesn't replace antivirus or EDR, email security, or human review of high-value payments.
- v0.1 doesn't detect document tampering or inconsistent financial data (planned for v0.2), or content aimed at AI pipelines (planned for v0.3).
- It doesn't analyze network traffic, attribute malware to families, or store scanned files.

The full scope is in [docs/SCOPE.md](https://github.com/pablodt00/filevet/blob/master/docs/SCOPE.md).

## Roadmap

Work is split into phases, each tracked as a [milestone](https://github.com/pablodt00/filevet/milestones): foundations, MVP (v0.1), integrity checks (v0.2), platform features such as a REST API and policy engine (v0.3), and hardening for v1.0.

## Contributing

Start with [CONTRIBUTING.md](https://github.com/pablodt00/filevet/blob/master/CONTRIBUTING.md). Everyone taking part is expected to follow the [Code of Conduct](https://github.com/pablodt00/filevet/blob/master/CODE_OF_CONDUCT.md).

## Security

Report vulnerabilities privately, as described in [SECURITY.md](https://github.com/pablodt00/filevet/blob/master/SECURITY.md). Please don't open public issues for them.

## License

[Apache License 2.0](https://github.com/pablodt00/filevet/blob/master/LICENSE). See also [NOTICE](https://github.com/pablodt00/filevet/blob/master/NOTICE).
