RestAV

.Net core REST API providing methods to scan files with ClamAV Antivirus running in Docker.

This will run in a docker container that is defined in a docker-compose.yml which has a dependency on ClamAV container.

Running:

Create a directory called Cert for a volume that will hold our certificate and place your certificate in. Replace certificatepassword in the docker compose sample blow. Replace Certificate.pfx with the name of your pfx file.

version: '3.4'

services:
  clamav-server:
    image: mkodockx/docker-clamav  
    networks:
      - clamav
  restav:
    image: 3583bytes/restav
    environment:
      - Kestrel__Certificates__Default__Path=/root/.dotnet/https/Certificate.pfx
      - Kestrel__Certificates__Default__Password=certificatepassword
    ports:
      - "8080:80"
      - "40443:443"
    networks:
      - clamav
    volumes:
      - ./Cert:/root/.dotnet/https/:ro
networks:
   clamav:

Docker Hub:

https://hub.docker.com/r/3583bytes/restav

RestAV API Methods:

Post:

/api/RestAV/ScanFile: Accepts a multipart/from-data file to scan and provides synchronous result: Returns:

[
    "Result",
    "Clean",
    "TotalSeconds",
    "0.0295759"
]

/api/RestAV/ScanFileAsync: Accepts a multipart/from-data file to scan and provides a GUID which can be used to asynchrounously fetch a result Returns:

[
    "GUID",
    "0cc52015-2217-4c20-be93-907fb680d6ae"
]

Get:

/api/RestAV/{GUID}

[
    "Result",
    "Clean"
]

Run:

build solution then run

docker-compose up

FYI: Running the solution in Docker via Visual Studio will only run the RestAV docker image withough the require ClamAV container. Hence the need to run docker-compose up.

Test:

Postman Collection provided for testing.

Restart

To remove all containers & images (to start again)

docker system prune -a