~ A webservice which scans files with ClamAV ~
Developed by @veeso
Current version: 0.1.0 (26/06/2023)
Ozone is a Rust web service which comes integrated with ClamAV. The service provides an API endpoint to scan files with ClamAV.
The entire ozone web service comes with a docker compose file to easily run the service on your machine. Just run:
sh
docker-compose build
docker-compose up -d
At this point ozone will be served on the specified port in the docker-compose file. (Default: 3010)
Check web service status:
txt
GET /check
Response:
json
{
"status": "ok"
}
Scan different files:
txt
POST /scan
curl --request POST \
--url http://localhost:3010/scan \
--header 'Content-Type: multipart/form-data' \
--form file=@/tmp/file1.txt \
--form malware=@/tmp/eicarcom2.zip
Response:
json
{
"files": [
{
"name": "file",
"filename": "file1.txt",
"safe": true,
"size": 222
},
{
"name": "malware",
"filename": "eicarcom2.zip",
"safe": false,
"size": 308,
"threat": "Win.Test.EICAR_HDB-1"
}
]
}
Where:
name: is the form field namefilename: is the filenamesafe: whether the file is safesize: the file sizethreat: the threat name found (optional; only if safe is false)If you like Ozone and you're grateful for the work I've done, please consider a little donation 🥳
You can make a donation with one of these platforms:
Contributions, bug reports, new features and questions are welcome! 😉 If you have any question or concern, or you want to suggest a new feature, or you want just want to improve pavao, feel free to open an issue or a PR.
Please follow our contributing guidelines
View Ozone's changelog HERE
Ozone is licensed under the MIT license.
You can read the entire license HERE
