ClamAV-REST Docker镜像文档

概述

ClamAV-REST是一个二合一Docker镜像，集成了开源病毒扫描器ClamAV（[***] API接口，用于与ClamAV进程交互。

先决条件

此容器本身功能有限，需配合额外服务或通信工具与其交互使用。

安装

推荐通过Docker Hub自动构建镜像进行安装，镜像地址：Registry。

bash
docker pull ajilaag/clamav-rest:(imagetag)

可用镜像标签：

• latest - 包含最新版本ClamAV和REST API

快速启动

运行容器

bash
docker run -p 9000:9000 -p 9443:9443 -itd --name clamav-rest ajilaag/clamav-rest

测试服务

检测测试病毒签名（Eicar测试文件）

HTTP方式：

bash
$ curl -i -F "file=@eicar.com.txt" http://localhost:9000/scan
HTTP/1.1 100 Continue

HTTP/1.1 406 Not Acceptable
Content-Type: application/json; charset=utf-8
Date: Mon, 28 Aug 2017 20:22:34 GMT
Content-Length: 56

{ Status: "FOUND", Description: "Eicar-Test-Signature" }

HTTPS方式：

bash
$ curl -i -k -F "file=@eicar.com.txt" https://localhost:9443/scan
HTTP/1.1 100 Continue

HTTP/1.1 406 Not Acceptable
Content-Type: application/json; charset=utf-8
Date: Mon, 28 Aug 2017 20:22:34 GMT
Content-Length: 56

{ Status: "FOUND", Description: "Eicar-Test-Signature" }

检测干净文件

HTTP方式：

bash
$ curl -i -F "file=@clamrest.go" http://localhost:9000/scan

HTTP/1.1 100 Continue

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 28 Aug 2017 20:23:16 GMT
Content-Length: 33

{ Status: "OK", Description: "" }

HTTPS方式：

bash
$ curl -i -k -F "file=@clamrest.go" https://localhost:9443/scan

HTTP/1.1 100 Continue

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Date: Mon, 28 Aug 2017 20:23:16 GMT
Content-Length: 33

{ Status: "OK", Description: "" }

状态码说明

• 200 - 文件干净（无已知感染）
• 400 - ClamAV返回文件通用错误
• 406 - 文件感染
• 412 - 无法解析文件
• 501 - 未知请求

配置

环境变量

可通过以下环境变量自定义镜像配置：

网络

维护与监控

Shell访问

如需调试或维护，可通过以下命令访问容器shell：

bash
docker exec -it (容器名称，如clamav-rest) /bin/sh

Prometheus指标

已实现Prometheus指标（[***]

HTTP:

bash
curl http://localhost:9000/metrics

HTTPS:

bash
curl https://localhost:9443/metrics

开发

源代码地址：[***]

构建Golang（Linux）二进制文件和Docker镜像：

bash
# env GOOS=linux GOARCH=amd64 go build
docker build . -t clamav-go-rest
docker run -p 9000:9000 -p 9443:9443 -itd --name clamav-rest clamav-go-rest

参考

• [***]
• [***]