https://github.com/veeso-dev/ozone
Web service to scan files with ClamAV
https://github.com/veeso-dev/ozone
clamav rust rust-lang webservice
Last synced: 6 months ago
JSON representation
Web service to scan files with ClamAV
- Host: GitHub
- URL: https://github.com/veeso-dev/ozone
- Owner: veeso-dev
- License: mit
- Created: 2023-06-25T15:42:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-26T08:38:51.000Z (over 2 years ago)
- Last Synced: 2025-03-08T23:17:12.965Z (7 months ago)
- Topics: clamav, rust, rust-lang, webservice
- Language: Rust
- Homepage:
- Size: 57.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Ozone
~ A webservice which scans files with ClamAV ~
Developed by @veeso
Current version: 0.1.0 (26/06/2023)
---
- [Ozone](#ozone)
- [About Ozone](#about-ozone)
- [Get started](#get-started)
- [Run with docker](#run-with-docker)
- [Ozone API](#ozone-api)
- [Check](#check)
- [Scan](#scan)
- [Support the developer](#support-the-developer)
- [Contributing and issues](#contributing-and-issues)
- [Changelog](#changelog)
- [License](#license)
---
## About Ozone
Ozone is a Rust web service which comes integrated with ClamAV. The service provides an API endpoint to scan files with ClamAV.
---
## Get started
### Run with docker
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`)
## Ozone API
### Check
Check web service status:
```txt
GET /check
```
Response:
```json
{
"status": "ok"
}
```
### Scan
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 name
- `filename`: is the filename
- `safe`: whether the file is safe
- `size`: the file size
- `threat`: the threat name found (optional; only if safe is `false`)
---
## Support the developer
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:
[](https://ko-fi.com/veeso)
[](https://www.paypal.me/chrisintin)
---
## Contributing and issues
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](CONTRIBUTING.md)
---
## Changelog
View Ozone's changelog [HERE](CHANGELOG.md)
---
## License
Ozone is licensed under the MIT license.
You can read the entire license [HERE](LICENSE)