https://github.com/pvarentsov/virus-scanner

Virus scanner microservice based on ClamAV and NodeJS.
https://github.com/pvarentsov/virus-scanner

clamav docker microservice nestjs nodejs pet-project rest-api typescript virus-scanning

Last synced: 3 months ago
JSON representation

Virus scanner microservice based on ClamAV and NodeJS.

• Host: GitHub
• URL: https://github.com/pvarentsov/virus-scanner
• Owner: pvarentsov
• License: mit
• Created: 2019-10-27T11:54:28.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-11T22:45:10.000Z (about 2 years ago)
• Last Synced: 2023-03-05T04:58:22.791Z (almost 2 years ago)
• Topics: clamav, docker, microservice, nestjs, nodejs, pet-project, rest-api, typescript, virus-scanning
• Language: TypeScript
• Homepage:
• Size: 3.51 MB
• Stars: 23
• Watchers: 2
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Virus Scanner

This project is a virus scanner as a microservice with REST interface. It consists of ClamAV and NodeJS client for ClamAV.

[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](./LICENSE)

![Build](https://github.com/pvarentsov/virus-scanner/workflows/Build/badge.svg)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=pvarentsov_virus-scanner&metric=alert_status)](https://sonarcloud.io/dashboard?id=pvarentsov_virus-scanner)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=pvarentsov_virus-scanner&metric=coverage)](https://sonarcloud.io/dashboard?id=pvarentsov_virus-scanner)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=pvarentsov_virus-scanner&metric=ncloc)](https://sonarcloud.io/dashboard?id=pvarentsov_virus-scanner)

## ClamAV

[ClamAV](https://www.clamav.net/) is used as a docker image. It runs:

* `clamd` daemon socket listening on port 3310;

* `freshclam` signature database update tool in the background.

## REST Client

REST Client is a NodeJS application based on [NestJS](https://nestjs.com/) framework. 

## How-To

To run microservice you can use `docker compose`. It will run Scanner service on port 3310 and API service on port 1337.

Usage: 

1. `docker-compose pull`

2. `docker-compose up -d`

  

    The API documentation will be available on endpoint GET http://localhost:1337/api/documentation

  

  


  

  ![API documentation](./assets/readme.api-documentation.png)

## Configuring

REST Client configuring is based on environment variables. See all variables [here](nodejs-rest-client/env/.env). In current implementation all variables are required and must be exposed before starting the REST Client.

ClamAV uses [clamd.conf](scanner/clamav/docker/clamd.conf) and [freshclam.conf](scanner/clamav/docker/freshclam.conf) configuration files. You can change these before building the docker image. See the full documentation for [clamd.conf](https://linux.die.net/man/5/clamd.conf) and [freshclam.conf](https://linux.die.net/man/5/freshclam.conf).

## Local Development

To develop locally you can run ClamAV container in the background: `docker-compose up -d scanner`.

To run REST Client manually on your machine need to:

* have NodeJS with version `> 11` and `yarn` installed globally

* enter to the client directory - `cd ./nodejs-rest-client`

* install dependencies - `yarn install`

* build project - `yarn build`

* run project - `yarn start`

To run unit tests use:

* `yarn test:unit`

* `yarn test:unit:coverage`

You can run client with variables from [.env](nodejs-rest-client/env/.env). Use `yarn start:local` command instead `yarn start`.

## Notes

* This project is not production-ready. 

* The running of the `clamd` and `freshclam` can take a little time. So clamav can be unavailable the first 20-30 seconds after starting.