CLAMAPI

Api to submit a file to clamav and get the information is the file is infected.

This work is inspired by https://github.com/solita/clamav-rest, but we use the spring-boot framework and log the idClient for security purpose.

It is a spring boot application with all requirements to be deployed in kubernetes :

• Liveness/Readiness Probe
• Metrics endpoint
• Gracefull shutdown

How does it works

This spring boot application offer an api with the /scan endpoint.

This endpoint must be used with 2 parameters :

• file: A multipart file
• idClient (Optionnal): A string

You can use this curl command line to test service :

curl -X POST "http://localhost:8080/scan?idClient=12345" -H "accept: */*" -H "Content-Type: multipart/form-data" -F "file=@yourfile;type=application/json"

For more information you can visit the swagger-ui at /swagger-ui.html after running the service

Usage

Usage in docker

docker run --env SERVICES_CLAMAV_HOST=<yourClamAvHost> --env SERVICES_CLAMAV_PORT=<yourClamAvPort> -p 8080:8080 <image_tag>

You can pass additional variable env to increse the scan timeout :

• SERVICES_CLAMAV_TIMEOUT : time in ms

Metrics

All metrics are available under /actuator/prometheus and can be scrape by prometheus

Some custom metrics are available at /actuator/prometheus:

• clamav_scan : Counter and timer for Clamav scan
• clamav_scan_infected : Counter for infected Clamav scan

Deployment with helm in kubernetes

Can be deployed with helm :

helm repo add github-cnieg https://cnieg.github.io/helm-charts
helm install github-cnieg/clamapi --name clamapi --namespace clamapi

Configuration available in values.yaml at https://github.com/cnieg/helm-charts/blob/master/charts/clamapi/values.yaml