rpeterson / aws-s3-virusscan

Antivirus for S3 buckets

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

S3 VirusScan

Antivirus for S3 buckets. You can connect as many buckets as you like by using S3 Event Notifications

Features

  • Uses ClamAV to scan newly added files on S3 buckets
  • Automatically updates ClamAV db every 3 hours
  • Scale EC2 instance workers to distribute workload

How does it work

A picture is worth a thousand words:

Architecture

  1. S3 VirusScan uses a SQS queue to decouple scan jobs from the ClamAV workers. Each S3 bucket can fire events to that SQS queue in case of new objects. This feature of S3 is called S3 Event Notifications.
  2. The SQS queue is consumed by a fleet of EC2 instances running in an Auto Scaling Group. If the number of outstanding scan jobs reaches a treshold a new ClamAV worker is automatically added. If the queue is mostly empty workers are removed.
  3. The ClamAV workers run a simple ruby script that executes the clamscan command. In the background the virus db is updated every three hours.
  4. If clamscan finds a virus the file is directly deleted (you can configure that) and a SNS notification is published.

Installation

Create a CloudFormation stack based on template.json.

Configure the buckets you want to connect to S3 VirusScan as shown in the next figure:

Configure Event Notifications

Make sure you select the -ScanQueue- NOT the -ScanQueueDLQ-!

If you like to receive emails if a virus was found you must subscribe to the SNS topic as shown in the next two figures:

Subscribe Topic: Step 1

Subscribe Topic: Step 2

You will receive a confirmation email.

Test

Create a EICAR Standard Anti-Virus Test File with the following content:

X5O!P%@AP[4\PZX54(P^)7CC)7}$EICAR-STANDARD-ANTIVIRUS-TEST-FILE!$H+H*

and upload that file to your S3 bucket.

TODO

  • Support versioned S3 buckets
  • An initial scan may also be useful. This could be implemented with a Lambda function that pushes every key to SQS.

About

Antivirus for S3 buckets

License:Apache License 2.0


Languages

Language:Ruby 100.0%