sqa6825/chainsaw-firewall

Chainsaw Firewall镜像说明

镜像概述

Chainsaw Firewall是基于Go语言开发的拉取代理工具，支持Maven、npm、PyPI、NuGet、Composer、Cargo、Docker Registry v2、Go模块及Yum/RPM等多种包管理格式。它遵循仓库管理器模式，具备缓存、索引、浏览服务等功能，同时保持轻量可审计的特性，用于保障软件供应链安全。

核心功能

• 多格式拉取代理：统一处理多种包管理工具的拉取请求，共享代理逻辑。
• 负缓存：避免重复请求不存在的资源，减轻上游服务器压力。
• 文件存储：使用文件系统存储缓存的 artifacts及JSON元数据。
• 包索引：支持/api/repos/<repo>/packages接口的包列表与版本查询。
• 配置驱动仓库：通过单一YAML文件管理仓库的上游地址、请求头及缓存TTL。
• 内置仪表板：提供/catalog（缓存包目录）和/violations/blocked（违规记录）页面，无需额外UI即可查看状态。

使用场景

• 企业内部包管理代理，统一管控外部包的拉取。
• 软件供应链安全防护，阻止包含漏洞或违规的包下载。
• 加速包下载，通过缓存减少重复请求的网络开销。

配置说明

所有运行时配置通过YAML文件管理，核心配置项包括：

• server：监听地址（默认:8787）。
• blob_store：缓存文件存储路径。
• index：包索引文件路径。
• blocking_mode：是否阻止违规包（默认true）。
• remotes：各格式的默认上游地址。
• repositories：仓库配置，包括名称、格式、类型及缓存策略。

Docker部署示例

基础运行

bash
docker run -d \
  --name chainsaw-firewall \
  -p 8787:8787 \
  sqa6825/chainsaw-firewall:latest

挂载配置与数据卷

bash
docker run -d \
  --name chainsaw-firewall \
  -p 8787:8787 \
  -v chainsaw-data:/var/lib/chainsaw \
  -v $(pwd)/config.yaml:/etc/chainsaw-firewall/config.yaml:ro \
  sqa6825/chainsaw-firewall:latest

查看日志

bash
docker logs -f chainsaw-firewall

客户端使用示例

pip/PyPI

bash
pip install --index-url http://localhost:8787/repository/pypi/simple/ requests

npm

bash
npm install lodash --registry http://localhost:8787/repository/npmjs/

Composer

bash
composer config --global repos.packagist composer http://localhost:8787/repository/packagist/

HTTP端点

• 仓库代理：GET /repository/<repo>/...
• 目录页面：GET /catalog
• 违规记录：GET /violations/blocked
• 健康检查：GET /healthz

部署注意事项

1. 确保缓存目录（/var/lib/chainsaw）使用持久化存储。
2. 生产环境建议启用TLS并配置合适的缓存策略。
3. 定期备份缓存文件与索引数据。

可观测性与维护

• 通过日志查看请求流量与违规记录。
• 使用/api接口获取机器可读的状态数据。
• 调整log-level参数控制日志 verbosity。