42Crunch scand-agent Docker镜像文档

镜像概述

42Crunch scand-agent Docker镜像提供本地部署运行API契约一致性扫描的能力，替代42Crunch云平台执行环境。该扫描通过动态应用安全测试（DAST）验证API实现是否符合其OpenAPI定义中设定的契约，适用于集成到CI/CD管道，实现代码推送时的自动化测试。

注意：此功能目前为私有测试版，开发仍在进行中。扫描会对选定API端点生成真实流量，可能根据配置产生成本。API必须已部署且端点处于活动状态，其使用的后端服务器需可被扫描工具访问，否则无法执行扫描。该功能目前仅对42Crunch付费客户开放。

核心功能与特性

• API契约验证：测试API实现是否符合OpenAPI定义的契约要求
• OpenAPI支持：兼容OpenAPI规范（OAS，原Swagger）v2和v3版本，支持JSON和YAML格式
• 本地部署：可在私有环境运行，避免依赖云平台，适合内部CI/CD集成
• 自动化集成：可作为CI/CD管道任务，在代码推送时自动触发扫描
• 结果上传：扫描报告和日志自动上传至42Crunch平台，便于集中查看

前提条件

• API已部署且端点可访问，后端服务器需对扫描工具开放网络访问
• OpenAPI定义需有效且格式良好（建议扫描前验证定义有效性）
• 需拥有42Crunch平台账号（仅限付费客户使用）

快速启动

1. 获取扫描令牌

1. 登录42Crunch平台，进入需扫描的API页面
2. 在本地扫描选项卡中创建扫描配置，系统将生成唯一扫描令牌（用于标识配置）
3. 点击设置图标，查看并复制扫描令牌值

2. 拉取并运行镜像

使用以下命令拉取镜像并运行扫描（替换<replace with your token value>为实际扫描令牌）：

bash
# 拉取镜像（首次运行或更新版本时执行）
docker pull 42crunch/scand-agent:latest

# 运行扫描容器
docker run -e SCAN_TOKEN=<replace with your token value> 42crunch/scand-agent:latest

3. 扫描管理

• 镜像更新：仅首次运行或需更新版本时需执行docker pull
• 配置变更：如需修改扫描配置，需在42Crunch平台删除当前配置并重新创建，然后更新Docker命令中的令牌值
• 结果查看：扫描完成后，报告和日志将自动上传至42Crunch平台，可在API的本地扫描选项卡查看最新报告及扫描时间

支持

如遇问题或有未覆盖的疑问，可访问support.42crunch.com创建支持工单。