Ozone

~ 使用ClamAV扫描文件的webservice ~

开始使用 · Crates.io

由@veeso开发

当前版本：0.1.0 (26/06/2023)

• Ozone
  • 关于Ozone
  • 开始使用
    • 使用Docker运行
  • Ozone API
    • 检查
    • 扫描
  • 支持开发者
  • 贡献和问题
  • 变更日志
  • 许可证

关于Ozone

Ozone是一个集成了ClamAV的Rust Web服务。该服务提供了一个API端点以使用ClamAV扫描文件。

开始使用

使用Docker运行

整个ozone Web服务都附带了一个docker-compose文件，以便在您的机器上轻松运行该服务。只需运行

docker-compose build
docker-compose up -d

此时，ozone将在docker-compose文件中指定的端口上提供服务。（默认：3010）

Ozone API

检查

检查Web服务状态

GET /check

响应

{
  "status": "ok"
}

扫描

扫描不同的文件

POST /scan
curl --request POST \
  --url https://127.0.0.1:3010/scan \
  --header 'Content-Type: multipart/form-data' \
  --form file=@/tmp/file1.txt \
  --form malware=@/tmp/eicarcom2.zip

响应

{
  "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"
    }
  ]
}

位置

• name：是表单字段名称
• filename：是文件名
• safe：文件是否安全
• size：文件大小
• threat：找到的威胁名称（可选；仅当safe为false时）

支持开发者

如果你喜欢Ozone并且感激我所做的工作，请考虑进行小额捐赠 🥳

你可以使用以下平台之一进行捐赠

贡献和问题

欢迎贡献、错误报告、新功能和提问！😉如果你有任何问题或疑虑，或者你想建议一个新功能，或者你只是想改进pavao，请随意打开一个问题或PR。

请遵循我们的贡献指南

变更日志

查看Ozone的变更日志在这里

许可证

Ozone在MIT许可证下授权。

你可以在这里阅读完整的许可证这里