clamavscan - RESTFul Virus Scanner Service

About

This is a highly available and scaleable RESTFul virus scanner dockerized to be able to deploy and operate it in different PaaS environments.

Dockerized open source antivirus daemon (clamav) combined with a open source RESTFul Spring service to use it via a REST interface in a decoupled container.

Description

To be able to push the service in one container to PaaS environments we combined the projects clamav-rest and mkodockx/docker-clamav to get this docker container which runs a RESTFul spring service calling the clamd to scan POSTed files on interface /scan. ClamAV daemon as a Docker image. It builds with a current virus database and runs freshclam in the background constantly updating the virus signature database.

Usage / Push to hub.docker.com

mvn clean install -DskipTests
docker build -t msarcher/clamavscan .
docker push msarcher/clamavscan:latest

Run local and test

docker run -d -p8080:8080 msarcher/clamavscan
sh ./testi.sh

Run in openshift

Import the YML files located in the "openshift" folder to your OpenShift Cluster.

WRK benchmarking

Download and install the HTTP benchmarking tool WRK and use the lua script in "test/test-files/wrktest.lua".

wrk -t1 -c1 -d20 -s wrktest.lua http://localhost:8080/scan

License

The used projects are licensed under MIT and GNU

File size

This clamav RESTFul service is configured to handle files up to a size of 100MB per default. If you wish to upload bigger files you need to juggle with different parameters but be warned that this could cause a instable or crashing service and is not recommeded if you dont know what you are doing:

StreamMaxLength in clamd.conf
clamd.maxfilesize andc camd.maxrequestsize parameter for clamav-rest-*.jar
java memory heap size (e.g. -Xmx2048m)

More Info

Inspired by work of

msa0311/clamavscan