This is a two in one docker image which runs the open source virus scanner ClamAV (https://www.clamav.net/), performs automatic virus definition updates as a background process and provides a REST API interface to interact with the ClamAV process.
An issue was found using echo "RELOAD" | nc 127.0.0.1 3310 behind a proxy to force reload the sig database. Due to this, and with us rebuilding the image weekly to get a new sha256, on top of our terraform redeploying clamav during the week with new sha256's, force reloading the database like this makes it impossible to use the scanner, as 3310 gets soft locked on the database update, and causes any subsequent scans to fail.
As of October 21 2024, freshclam notifies the correct .clamd.conf so that clamd is notified about updates and the correct version is returned now.
This is an additional fix to the latest fix from October 15 2024 which was not working. Thanks to christianbumann and arizon-dread.
As of October 15 2024, ClamAV was thought to handle database updates correctly thanks to christianbumann. It turned out that this was not the case.
As of May 2024, the releases are built for multiple architectures thanks to efforts from kcirtapfromspace and support non-root read-only deployments thanks to robaca.
The additional endpoint /version is now available to check the clamd version and signature date. Thanks pastral.
Closed a security hole by upgrading our Dockerfile to the alpine base image version 3.19 thanks to Marsup.
This container doesn't do much on it's own unless you use an additional service or communicator to talk to it!
Automated builds of the image are available on Registry and is the recommended method of installation.
docker pull hub.docker.com/ajilaag/clamav-rest:(imagetag)The following image tags are available:
latest- Most recent release of ClamAV with REST APIYYYYMMDD- The day of the releasesha-...- The git commit sha. This version ensures that the exact image is used and will be unique for each build
See this docker-compose file for non-root read-only usage.
Run clamav-rest docker image:
docker run -p 9000:9000 -p 9443:9443 -itd --name clamav-rest ajilaag/clamav-restTest that service detects common test virus signature:
HTTP
$ curl -i -F "file=@eicar.com.txt" http://localhost:9000/scan
HTTP/1.1 100 Continue
HTTP/1.1 406 Not Acceptable
Content-Type: application/json; charset=utf-8
Date: Mon, 28 Aug 2017 20:22:34 GMT
Content-Length: 56
{ "Status": "FOUND", "Description": "Eicar-Test-Signature" }HTTPS
$ curl -i -k -F "file=@eicar.com.txt" https://localhost:9443/scan
HTTP/1.1 100 Continue
HTTP/1.1 406 Not Acceptable
Content-Type: application/json; charset=utf-8
Date: Mon, 28 Aug 2017 20:22:34 GMT
Content-Length: 56
{ "Status": "FOUND", "Description": "Eicar-Test-Signature" }Test that service returns 200 for clean file:
HTTP
$ curl -i -F "file=@clamrest.go" http://localhost:9000/scan
HTTP/1.1 100 Continue
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 28 Aug 2017 20:23:16 GMT
Content-Length: 33
{ "Status": "OK", "Description": "" }HTTPS
$ curl -i -k -F "file=@clamrest.go" https://localhost:9443/scan
HTTP/1.1 100 Continue
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 28 Aug 2017 20:23:16 GMT
Content-Length: 33
{ "Status": "OK", "Description": "" }- 200 - clean file = no KNOWN infections
- 400 - ClamAV returned general error for file
- 406 - INFECTED
- 412 - unable to parse file
- 501 - unknown request
Below is the complete list of available options that can be used to customize your installation.
| Parameter | Description |
|---|---|
MAX_SCAN_SIZE |
Amount of data scanned for each file - Default 100M |
MAX_FILE_SIZE |
Don't scan files larger than this size - Default 25M |
MAX_RECURSION |
How many nested archives to scan - Default 16 |
MAX_FILES |
Number of files to scan withn archive - Default 10000 |
MAX_EMBEDDEDPE |
Maximum file size for embedded PE - Default 10M |
MAX_HTMLNORMALIZE |
Maximum size of HTML to normalize - Default 10M |
MAX_HTMLNOTAGS |
Maximum size of Normlized HTML File to scan- Default 2M |
MAX_SCRIPTNORMALIZE |
Maximum size of a Script to normalize - Default 5M |
MAX_ZIPTYPERCG |
Maximum size of ZIP to reanalyze type recognition - Default 1M |
MAX_PARTITIONS |
How many partitions per Raw disk to scan - Default 50 |
MAX_ICONSPE |
How many Icons in PE to scan - Default 100 |
PCRE_MATCHLIMIT |
Maximum PCRE Match Calls - Default 100000 |
PCRE_RECMATCHLIMIT |
Maximum Recursive Match Calls to PCRE - Default 2000 |
SIGNATURE_CHECKS |
Check times per day for a new database signature. Must be between 1 and 50. - Default 2 |
PROXY_SERVER |
Specify a proxy for freshclam to utilize, if applicable, set in environment variables - Optional |
PROXY_PORT |
The port for the proxy server, if applicable, set in environment variables - Optional |
PROXY_USERNAME |
The username for the proxy server, if applicable, set in environment variables - Optional |
PROXY_PASSWORD |
The password for the proxy server, if applicable, set in environment variables - Optional |
| Port | Description |
|---|---|
3310 |
ClamD Listening Port |
For debugging and maintenance purposes you may want access the containers shell.
docker exec -it (whatever your container name is e.g. clamav-rest) /bin/shChecking the version with the clamscan command requires to provide the custom database path.
The default value is overwritten to /clamav/data in the /clamav/etc/clamd.conf, and the clamav service
was started with this/clamav/etc/clamd.conf from the entrypoint.sh.
clamscan --database=/clamav/data --versionPrometheus metrics were implemented, which can be retrieved as follows
HTTP: curl http://localhost:9000/metrics
HTTPS: curl https://localhost:9443/metrics
Source Code can be found here: https://github.com/ajilach/clamav-rest
Build golang (linux) binary and docker image:
# env GOOS=linux GOARCH=amd64 go build
docker build . -t clamav-go-rest
docker run -p 9000:9000 -p 9443:9443 -itd --name clamav-rest clamav-go-rest