Skip to main content

DevShield for Linux

An installable Python CLI package is included. See INSTALL.md to build a wheel and install the devshield command on servers using an isolated environment under /opt/devshield. There is no published npm or Python registry package yet. devshield --version displays the CLI version; existing scanner flags are unchanged.

Read-only host and Docker filesystem malware scanning using the locally installed ClamAV signature engine. Requires Linux, Python 3.8+, clamscan, updated ClamAV databases, and the Docker CLI for container scanning. Run on the Docker host with a local Unix socket context. Root access normally provides the required file/socket access.

On Debian/Ubuntu, install prerequisites using your normal package-management policy:

sudo apt-get update
sudo apt-get install python3 clamav clamav-freshclam

Ensure the ClamAV databases have downloaded before scanning. Use your distribution's freshclam service, or sudo freshclam if that service is not already managing updates. The scanner does not install software, change services, or update databases automatically. Docker must already be installed if you use it.

Copy this folder onto the server, then run:

sudo python3 devshield_linux.py

Console messages identify each stage and show a heartbeat every 10 seconds during long scans. Verbose file-level progress is saved to each stage's log; inspect a log with tail -f /path/printed/by/script.log. JSON results are checkpointed after every completed scan and on interruption, under /var/log/devshield/<run>/report.json.

# Check a small directory first
sudo python3 devshield_linux.py --host-root /srv/project --skip-docker

# Containers and volumes only
sudo python3 devshield_linux.py --skip-host

# Use a scratch disk with room for the largest container filesystem export
sudo python3 devshield_linux.py --temp-dir /mnt/scratch --heartbeat 5

Host scanning starts at / and traverses mounted filesystems, including potentially slow network mounts. /proc, /sys, /dev, /run, raw default Docker/containerd storage, the report directory and scratch directory are excluded. No symlinks are followed. Custom Docker storage may be scanned twice. Logs can be large and contain private file paths; keep them private.

For each running container the script uses docker export, scans the resulting TAR as an archive, then deletes only its own temporary export. It does not execute programs inside containers, extract archives, stop containers or change their files. It separately scans bind-mount sources and discovered Docker volumes, including unused volumes. Remote daemons are rejected. Volume plugins/network-backed volumes may need separate mounting and scanning. If using a local socket proxy to a remote daemon, do not use this script: mount paths must refer to this machine.

Stopped containers, unused image layers, RAM, kernel state and rootkits are not covered. ClamAV's configured/default size, archive and recursion limits still apply, including to large container TAR exports; a successful scan can miss content past those limits. Review ClamAV summaries and warnings in every log. This is a best-effort filesystem scan, not a comprehensive compromise assessment. Live files can change during scanning. Use a trusted rescue environment for suspected root-level compromise.

Exit status: 0 = no signature detections reported and no recorded orchestration errors; 1 = detections; 2 = incomplete/error (detections may also exist; always inspect the report). No deletion or quarantine is requested. Reports persist if Docker scanning fails or the scan is interrupted with Ctrl+C. A forced kill or power loss may lose the active stage, but earlier checkpoints remain.

Validation on the development Windows machine covers syntax and mocked orchestration only. A real Linux/Docker/ClamAV integration scan must be validated on your server before operational use.

Metadata

Release files for devshield-scanner 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for devshield-scanner 0.1.0
File Size Uploaded Provenance Actions
devshield_scanner-0.1.0.tar.gz 7.0 kB Without provenance Details for devshield_scanner-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for devshield-scanner 0.1.0
File Interpreter ABI Platform Actions
devshield_scanner-0.1.0-py3-none-any.whl Python 3 none any Details for devshield_scanner-0.1.0-py3-none-any.whl

Total release size: 14.5 kB

Release files / devshield_scanner-0.1.0.tar.gz

Download URL devshield_scanner-0.1.0.tar.gz
Size 7.0 kB
Tags Source
SHA-256 checksum
How to use checksums
41b2f12e3d953081c46af2688947ed9a3f1fafba488366c8e764d38e20a550f8
BLAKE2b-256 checksum
How to use checksums
8ae7644fcd6fceb43a496a40a977ab254037bdb40aabd487df5a568d7166a761
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.6

Release files / devshield_scanner-0.1.0-py3-none-any.whl

Download URL devshield_scanner-0.1.0-py3-none-any.whl
Size 7.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
67f67c8de68f6a5ef4a7a149599993307c62150255c04b8da6a8bd2e2d2f4e64
BLAKE2b-256 checksum
How to use checksums
46f5ba4586bd8586e91d2ebde1be9aa9259ec9781a9782846f12239de81b2499
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.6

Security for devshield-scanner 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page