42Crunch REST API静态安全测试Docker镜像允许您在CI/CD管道中添加自动静态应用安全测试(SAST)任务。该镜像创建Docker容器,检查OpenAPI定义文件的质量和安全性。
此Docker镜像由42Crunch API安全审计提供支持。安全审计对API定义执行静态分析,包括300多项检查,涉及最佳实践以及API在认证、授权、传输和数据进出方面的潜在漏洞。
安全测试的结果会为您的API提供审计分数,100分表示最安全、定义最佳的API。默认情况下,容器成功终止的阈值分数为每个被审计API 75分,但您可以在容器配置中更改最低分数。
API契约必须遵循OpenAPI规范(OAS,前身为Swagger)。支持OAS v2和v3,以及JSON和YAML格式。
您可以在[***]
默认情况下,容器会在其当前工作目录中定位所有OpenAPI文件,并提交它们进行静态安全测试。您可以在发现阶段包含或排除特定路径,也可以通过在仓库根目录添加配置文件42c-conf.yaml并指定发现阶段规则来完全省略发现阶段。有关详细信息,请参阅文档。
所有发现的API都会上传到42Crunch平台的API集合中。容器使用多个环境变量(如下所述)来显示API集合源自的仓库以及分支/标签/PR名称。在后续容器运行期间,集合中的API会与仓库中的更改保持同步。
您可以在仓库根目录添加配置文件42c-conf.yaml,以微调成功/失败标准。例如,您可以选择是否接受无效的API契约,或定义特定级别问题严重性的临界值。
您可以为仓库中的不同分支/标签/PR定义不同的配置。在指定配置适用的分支时,可以使用分支的全名(例如master)或通配符(例如release-*)。
以下是Docker的最小命令行,用于审计本地文件系统目录中的所有OpenAPI文件。
容器假设文件来自源代码控制仓库,因此必须始终提供仓库URL和分支/标签/PR信息。此信息用于在42Crunch平台上创建或查找(后续运行时)API集合。
shdocker run \ -v <OPENAPI文件目录>:/workspace \ -e X42C_REPOSITORY_URL=https://github.com/我的公司/我的-openapi仓库 \ -e X42C_API_TOKEN=<令牌> \ -e X42C_BRANCH_NAME=master \ 42crunch/docker-api-security-audit:v3
| 变量 | 用途 |
|---|---|
| X42C_REPOSITORY_URL (*) | 源代码控制仓库URL。用于在42Crunch平台上标识API集合。 |
| X42C_BRANCH_NAME (**) | 源代码控制分支名称。 |
| X42C_TAG_NAME (**) | 源代码控制标签名称。 |
| X42C_PR_ID (**) | 源代码控制PR ID。 |
| X42C_PR_TARGET_BRANCH | 源代码控制PR目标分支名称。 |
| X42C_API_TOKEN (*) | 访问42Crunch平台的API令牌。这是敏感机密,需要安全存储。 |
| X42C_MIN_SCORE | OpenAPI文件的最低分数。默认值:75。 |
| X42C_PLATFORM_URL | 42Crunch平台URL。默认值:[***] |
| X42C_DEFAULT_COLLECTION_NAME | 创建发现的API集合时使用的默认集合名称。 |
| X42C_LOG_LEVEL | 日志级别,可选值:FATAL、ERROR、WARN、INFO、DEBUG。默认值:INFO。 |
| X42C_SHARE_EVERYONE | 与所有人共享新API集合,可选值:OFF、READ_ONLY、READ_WRITE。默认值:OFF。 |
| X42C_ROOT_DIRECTORY | 默认情况下,容器在其/workspace目录中查找OpenAPI文件和42c-conf.yaml配置文件。通过设置此变量,您可以配置审计使用不同的目录。 |
(*) = 必填变量。
(**) = 必须设置其中一项。如果设置了X42C_PR_ID,则还必须设置X42C_PR_TARGET_BRANCH。
在42Crunch平台中创建API令牌。
该镜像由***维护。如果您遇到问题或有未在此处解答的问题,可以在support.42crunch.com创建支持工单。
报告问题时,请包含:
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本,请访问 标签列表页面。

探索更多轩辕镜像的使用方法,找到最适合您系统的配置方式
通过 Docker 登录认证访问私有仓库
无需登录使用专属域名
Kubernetes 集群配置 Containerd
K3s 轻量级 Kubernetes 镜像加速
VS Code Dev Containers 配置
Podman 容器引擎配置
HPC 科学计算容器配置
ghcr、Quay、nvcr 等镜像仓库
Harbor Proxy Repository 对接专属域名
Portainer Registries 加速拉取
Nexus3 Docker Proxy 内网缓存
需要其他帮助?请查看我们的 常见问题Docker 镜像访问常见问题解答 或 提交工单
docker search 限制
站内搜不到镜像
离线 save/load
插件要用 plugin install
WSL 拉取慢
安全与 digest
新手拉取配置
镜像合规机制
manifest unknown
no matching manifest(架构)
invalid tar header(解压)
TLS 证书失败
DNS 超时
域名连通性排查
410 Gone 排查
402 与流量用尽
401 认证失败
429 限流
D-Bus 凭证提示
413 与超大单层
来自真实用户的反馈,见证轩辕镜像的优质服务