{"id":13705911,"url":"https://github.com/cloudina/hawk","last_synced_at":"2026-01-11T22:46:31.244Z","repository":{"id":41334442,"uuid":"402105028","full_name":"cloudina/hawk","owner":"cloudina","description":"Multi Cloud Antivirus Scanning API using YARA and CLAMAV for AWS S3, Azure Blob Storage and GCP Cloud Storage","archived":false,"fork":false,"pushed_at":"2024-09-01T02:24:54.000Z","size":69,"stargazers_count":22,"open_issues_count":5,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-05-05T17:31:54.898Z","etag":null,"topics":["antivirus","api-rest","aws","azure","azure-blob-storage","clamav-antivirus","clamav-scanning","cloud","cloudsecurity","gcp","gcp-cloud-storage","infosec","rest-api","s3scanner","security","security-tools","virus-scanner","virus-scanning","yara","yara-scanner"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudina.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-09-01T15:10:41.000Z","updated_at":"2025-01-27T07:08:24.000Z","dependencies_parsed_at":"2024-01-07T09:41:47.033Z","dependency_job_id":"92c5565f-8f98-461f-b4c8-beb00e3fd24b","html_url":"https://github.com/cloudina/hawk","commit_stats":{"total_commits":14,"total_committers":2,"mean_commits":7.0,"dds":0.5,"last_synced_commit":"a9697af316a3f3fbdfa32fa391557d7f4561fa27"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/cloudina/hawk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudina%2Fhawk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudina%2Fhawk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudina%2Fhawk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudina%2Fhawk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudina","download_url":"https://codeload.github.com/cloudina/hawk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudina%2Fhawk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28326144,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-11T22:11:01.104Z","status":"ssl_error","status_checked_at":"2026-01-11T22:10:58.990Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["antivirus","api-rest","aws","azure","azure-blob-storage","clamav-antivirus","clamav-scanning","cloud","cloudsecurity","gcp","gcp-cloud-storage","infosec","rest-api","s3scanner","security","security-tools","virus-scanner","virus-scanning","yara","yara-scanner"],"created_at":"2024-08-02T22:00:49.550Z","updated_at":"2026-01-11T22:46:31.222Z","avatar_url":"https://github.com/cloudina.png","language":"Go","readme":"\n# HAWK\n\n## Introduction\nMulti Cloud antivirus scanning API based on CLAMAV and YARA for AWS S3, AZURE Blob Storage, GCP Cloud Storage.\n\n## Features\n-   Microservice for scanning stream with YARA and CLAMAV\n-   Scans S3 Bucket Object\n-   Moves Clean S3 Objects to another S3 Bucket\n-   Quarantines Infected S3 Objects to another S3 Bucket\n-   CLAMAV DB auto is updated to latest\n-   [TODO] AZURE and GCP support\n-   [TODO] Merge Various YARA rules to one set\n-   [TODO] Auto Update YARA rules\n-   [TODO] Support Yextend\n-   [TODO] Improve Logging using logrus [https://github.com/antonfisher/nested-logrus-formatter]\n-   [TODO] Harden Image\n\n\n## API\nAvailable API are\n```\n# Scan stream\nPOST /scanstream -d @file_to_scan\n\n# scan a file which is in s3 ( in scanning bucket )\nPOST -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\n\n# list all loaded ruleset\nGET /ruleset/\n\n# list all rules from a loaded rule\nGET /ruleset/{ruleset}\n\n# get metrics\nGET /metrics\n\n# get health info \nGET /health\n\n#get index\nGET /\n\n```\n\n## Installation\n\nAutomated builds of the image are available on [Registry](https://hub.docker.com/r/cloudina/hawk) and is the recommended method of installation.\n\n```bash\ndocker pull hub.docker.com/cloudina/hawk:(imagetag)\n```\n\nThe following image tags are available:\n* `latest` - Most recent release of ClamAV with REST API\n\n# Quick Start\n\nRun hawk docker image:\n```bash\ndocker run -p 9000:9999 -itd --name hawk cloudina/hawk\ndocker run -p 9000:9999 -v $HOME/.aws/credentials:/go/src/app/.aws/credentials:ro -itd --name hawk cloudina/hawk\n```\n\nTest that service detects common test virus signature:\n\n**EXAMPLES**\n```bash\n# Request - Scanning a file from S3 , ./testsamples/request/s3filescan has config for s3\ncurl --data \"@./testsamples/request/s3filescan\" http://0.0.0.0:9000/s3/scanfile -H 'Content-Type: application/json'\n\n# Response\n{\"filename\":\"stream\",\"matches\":[{\"Rule\":\"Win.Test.EICAR_HDB-1\",\"namespace\":\"\",\"tags\":null}],\"status\":\"INFECTED\"}%                                 \n\n# Request - Uploading sample virus file to API\ncurl --data \"@./testsamples/scanfiles/eicar\" http://0.0.0.0:9000/scanstream -H 'Content-Type: application/json'\n\n# Response\n{\"filename\":\"stream\",\"matches\":[{\"Rule\":\"Win.Test.EICAR_HDB-1\",\"namespace\":\"\",\"tags\":null}],\"status\":\"INFECTED\"}                           \n\n# Request - Uploading sample clean file to API\ncurl --data \"@./testsamples/scanfiles/hello.txt\" http://0.0.0.0:9000/scanstream -H 'Content-Type: application/json'\n\n# Response\n{\"filename\":\"stream\",\"matches\":[],\"status\":\"CLEAN\"} \n                                                                                         \n```\n## Networking\n\n| Port | Description |\n|-----------|-------------|\n| `3310`    | ClamD Listening Port |\n| `9999`    | HAWK Container Port |\n\n## Debug\nFor debugging the running container\n```bash\ndocker exec -it (whatever your container name is e.g. hawk) /bin/ash\n```\n\n## Build\nFor building\n```bash\ndocker build -t (whatever your image name is e.g. hawk) .\n```\n\n## Prebuild Image\n```bash\ndocker pull cloudina/hawk\n\n```\n\n## Acknowledgements\n\n* [yarascanner](https://github.com/jheise/yarascanner)\n* [clamscanner](https://github.com/ifad/clammit)\n\n## References\n\n* https://www.clamav.net\n* https://virustotal.github.io/yara/\n","funding_links":[],"categories":["Tools"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudina%2Fhawk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudina%2Fhawk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudina%2Fhawk/lists"}