tsamps/clamav-rest-client

ClamAV IFormFile扫描RESTful客户端镜像

概述

该镜像提供一个RESTful客户端服务，专门用于将IFormFile对象传递给ClamAV antivirus引擎，实现文件的按需病毒扫描功能。适用于需要集成文件安全扫描的应用场景，尤其便于与基于ASP.NET Core等框架的应用集成。

核心功能与特性

• RESTful API接口：提供标准HTTP接口，支持文件扫描请求的接收与处理
• IFormFile对象支持：原生支持IFormFile类型文件，便于与Web应用集成
• ClamAV集成：无缝对接ClamAV antivirus引擎，利用其病毒库进行扫描
• 按需扫描：仅在接收到请求时执行扫描操作，资源占用可控
• 轻量级设计：优化的镜像体积，适合容器化部署环境

使用场景与适用范围

• Web应用文件上传前的实时病毒扫描
• 企业内部系统文件交换的安全检查
• 内容管理系统(CMS)的附件安全验证
• 基于ASP.NET Core的应用中IFormFile类型文件的安全处理
• 需要第三方独立病毒扫描服务的微服务架构

使用方法与配置说明

前提条件

• 已部署并运行ClamAV服务(clamd)，确保客户端可网络访问
• 客户端与ClamAV服务之间网络连通（建议使用Docker网络或内部局域网）

Docker运行命令

bash
docker run -d \
  --name clamav-scan-client \
  -p 8080:80 \
  -e CLAMAV_HOST=clamav-service \
  -e CLAMAV_PORT=3310 \
  -e LOG_LEVEL=Info \
  [镜像名称]:[标签]

环境变量配置

docker-compose配置示例

yaml
version: '3.8'

services:
  clamav:
    image: clamav/clamav:latest
    container_name: clamav-service
    ports:
      - "3310:3310"
    volumes:
      - clamav_data:/var/lib/clamav
    restart: unless-stopped

  scan-client:
    image: [镜像名称]:[标签]
    container_name: clamav-scan-client
    ports:
      - "8080:80"
    environment:
      - CLAMAV_HOST=clamav-service
      - CLAMAV_PORT=3310
      - LOG_LEVEL=Info
      - TIMEOUT_SECONDS=45
    depends_on:
      - clamav
    restart: unless-stopped

volumes:
  clamav_data:

API接口使用示例

扫描文件接口

• 请求方法: POST
• 接口路径: /api/scan (可通过API_PATH环境变量自定义)
• 请求类型: multipart/form-data
• 请求参数:
  • file: IFormFile类型文件 (必填)

请求示例(curl)

bash
curl -X POST "http://localhost:8080/api/scan" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@/path/to/your/file.txt"

响应示例

安全文件响应:

json
{
  "status": "clean",
  "fileName": "file.txt",
  "fileSize": 1024,
  "scanDurationMs": 120,
  "message": "File is clean"
}

感染文件响应:

json
{
  "status": "infected",
  "fileName": "malicious.exe",
  "fileSize": 2048,
  "scanDurationMs": 150,
  "message": "Virus detected",
  "virusName": "Win.Test.EICAR_HDB-1"
}

注意事项

• 定期更新ClamAV病毒库以确保扫描效果 (freshclam命令)
• 根据文件大小适当调整TIMEOUT_SECONDS参数
• 生产环境建议启用HTTPS加密传输(可通过反向代理如Nginx实现)
• 高并发场景下建议配置负载均衡和水平扩展
• 监控容器资源使用情况，根据实际负载调整CPU/内存限制

故障排查

• 若扫描失败，首先检查ClamAV服务状态及网络连通性
• 查看容器日志: docker logs clamav-scan-client
• 验证ClamAV服务可用性: telnet <clamav-host> <clamav-port>
• 大文件扫描超时可适当增加TIMEOUT_SECONDS值