Introduction

Features

API

# Scan streamPOST /scanstream -d @file_to_scan# scan a file which is in s3 ( in scanning bucket )POST -d '{"bucketname": $S3_SCANNING_BUCKET, "key": $S3_OBJECT_TO_SCAN, "clean_files_bucket": $S3_CLEAN_FILES_BUCKET, "qurantine_files_bucket": $S3_QUARNTINE_FILES_BUCKET}' /s3/scanfile# list all loaded rulesetGET /ruleset/# list all rules from a loaded ruleGET /ruleset/{ruleset}# get metricsGET /metrics# get health info GET /health#get indexGET /

Installation

docker pull hub.docker.com/cloudina/hawk:(imagetag)

Quick Start

docker run -p 9000:9999 -itd --name hawk cloudina/hawkdocker run -p 9000:9999 -v$HOME/.aws/credentials:/go/src/app/.aws/credentials:ro -itd --name hawk cloudina/hawk

# Request - Scanning a file from S3 , ./testsamples/request/s3filescan has config for s3curl --data"@./testsamples/request/s3filescan" http://0.0.0.0:9000/s3/scanfile -H'Content-Type: application/json'# Response{"filename":"stream","matches":[{"Rule":"Win.Test.EICAR_HDB-1","namespace":"","tags":null}],"status":"INFECTED"}%# Request - Uploading sample virus file to APIcurl --data"@./testsamples/scanfiles/eicar" http://0.0.0.0:9000/scanstream -H'Content-Type: application/json'# Response{"filename":"stream","matches":[{"Rule":"Win.Test.EICAR_HDB-1","namespace":"","tags":null}],"status":"INFECTED"}# Request - Uploading sample clean file to APIcurl --data"@./testsamples/scanfiles/hello.txt" http://0.0.0.0:9000/scanstream -H'Content-Type: application/json'# Response{"filename":"stream","matches":[],"status":"CLEAN"}

Networking

Debug

dockerexec -it (whatever your container name is e.g. hawk) /bin/ash

Build

docker build -t (whatever your image name is e.g. hawk).

Prebuild Image

docker pull cloudina/hawk

Acknowledgements

References