在隔离的离线虚拟机中构建已注册的开源仓库,并扫描其安全漏洞,通过电子邮件发送包含复现步骤和建议补丁的发现结果的服务。
OSS Scanner 是 Anthropic 提供的一项服务,用于扫描关键开源仓库中的安全漏洞。请访问 red.anthropic.com/oss-scanner 了解更多关于该服务的信息。
请注意,使用此工具须遵守 OSS Scanner 条款 中规定的条款和条件。
通过提交一个添加单个目录的拉取请求来注册一个开源项目:
projects/<name>
我们的安全扫描器会在隔离的虚拟机中构建你的项目,然后在无互联网访问的情况下对其进行分析,并将发现的问题通过电子邮件发送给 primary_contact(以及任何抄送对象),每份报告都附带一个复现器,并在可用时附带一个建议的补丁。报告由模型生成,未经人工审核。因此,我们不会对这些发现设定 90 天的披露期,也不会将其公开。项目所有者应提供 project.yaml(用于配置扫描器)、一个 Dockerfile(说明如何构建项目),以及可选的 threat_model.md(提供项目特定的威胁建模)、report_guidelines.md 和 patch_guidelines.md(说明你希望报告和补丁呈现的样子)。
从 templates/project.yaml 开始:
repo: https://github.com/example/project # required: the git repository to scan; add #branch to pin one
primary_contact: [email protected] # required: reports and build problems go here (one address)
auto_ccs: # optional: more addresses on every mail
- [email protected]
homepage: https://example.org # optional
disabled: false # optional: true pauses reports without removing the enrolment
dockerfile: .oss-scanner/Dockerfile # required unless a Dockerfile sits in this repo next to your project.yaml
threat_model: .oss-scanner/threat_model.md # optional; also supports placing the file in this repository
# report_guidelines: .oss-scanner/report_guidelines.md # optional; the same
# patch_guidelines: .oss-scanner/patch_guidelines.md # optional; the same
repo 和 primary_contact 始终为必填项。除非你将 Dockerfile 与 project.yaml 放在同一目录下(见下文),否则 dockerfile 为必填项。其他字段均为可选项。
project.yaml 中的电子邮件地址是公开的。请使用你愿意公开的地址,例如安全别名。
如需接收加密的电子邮件报告,请添加你的 ASCII 装甲格式 OpenPGP 公钥。此时报告仅发送至 primary_contact;pgp 不能与 auto_ccs 同时使用:
pgp: |
-----BEGIN PGP PUBLIC KEY BLOCK-----
mQINBF...
-----END PGP PUBLIC KEY BLOCK-----
要选择报告的发送位置,请为每个渠道设置其接收的最低严重级别:low、medium、high、critical,或使用 none 关闭该渠道。未指定的渠道将使用此处显示的默认值,达到或超过两个最低级别的报告会同时发送到两个渠道。pgp 仅适用于电子邮件,因此 GitHub 报告不会使用你的密钥加密:
output_format:
email:
min_severity: low
github_security_advisory: # GitHub private vulnerability reporting
min_severity: none
要开启 GitHub 报告,请先在您的仓库中启用私有漏洞报告,并将 oss-scanner 添加为可信报告者。Anthropic 运营着 oss-scanner 账户,我们的报告即来自该账户;若不进行此操作,GitHub 会限制其能向您发送的报告数量。我们会在合并前请您在拉取请求中确认。
您必须提供 Dockerfile,且只能放在以下两个位置之一:
dockerfile: 设置为其路径(我们建议放在类似 .oss-scanner/Dockerfile 的位置)。这是首选方案,因为它允许您在此处无需拉取请求即可更新构建;或者,project.yaml 放在一起,作为 projects/<name>/Dockerfile,且不在 project.yaml 中设置 Dockerfile: 键。如果您不想向自己的仓库添加文件,可以将其放在此处,扫描器会完全按照仓库内副本的方式构建它。(威胁模型的工作方式相同。在您的仓库中为其位置设置 threat_model 字段,或将其放在此处 projects/<name>/threat_model.md。报告指南和补丁指南也是如此,分别使用 report_guidelines 和 patch_guidelines 字段。)
Dockerfile 的用途是设置您的环境、安装所有依赖并构建项目。初始项目设置运行时启用网络访问,但之后的安全审计运行时无互联网访问。构建或测试所需的任何内容都必须在初始 Dockerfile 设置期间获取。我们建议检查您的测试在构建的镜像内能否通过。
threat_model.md(可选但强烈推荐)文件允许您向扫描器提供有关您预期安全目标的文档。我们发现,提供关于如何评定报告严重性的指导最为有用(例如,您认为认证后 SQLi 是高危还是严重?没有演示利用的缓冲区溢出是否上限为高危?存储型 XSS 何时为中危、高危和严重?)此文件还可以说明项目做什么、不可信输入从何处进入、哪些组件重要、哪些不在范围内,或任何您认为重要或有用的事项。
另外两个文件(可选但强烈推荐)让您说明希望我们的报告和补丁呈现何种形式:
report_guidelines.md 用于规定每份报告的格式:其布局和章节、长度、语气以及应陈述哪些事实。patch_guidelines.md 用于规定每个补丁的风格:例如,写多少注释、修复应该非常狭窄还是更通用、添加哪些测试以及使用哪个格式化工具。从 templates/report_guidelines.md 和 templates/patch_guidelines.md 开始。两者均为纯文本,最多 16 KiB。
这些文件仅改变报告和补丁的撰写方式;哪些内容在范围内以及如何评定严重性属于 threat_model.md 的范畴。每个文件在使用前都会自动检查。若某个文件试图改变超出上述范围的内容,例如遗漏发现结果或运行无关命令,则该文件整体被忽略。
我们建议您在打开拉取请求之前运行两个命令:
tools/validate.py 根据上述规则检查 projects/<name>/。tools/check <name> 按照我们扫描器的方式构建您的项目,并在完成的镜像中打开一个无网络的 shell。如果您的测试在此容器中通过,我们的扫描器很可能能与您的项目配合工作。tools/check --qemu <name> 在按扫描器方式布局的虚拟机内执行相同操作。这些工具需要您的主机已安装 git、Docker 以及带 PyYAML 的 Python 3(pip install pyyaml);--qemu 需要 x86-64 上的 Linux 并使用 QEMU 而非 Docker。
primary_contact 发送包含错误信息的电子邮件。primary_contact 以及任何额外的抄送对象,其中包含复现步骤以及可用的建议补丁。你可以随时通过 PR 编辑你的项目。要取消注册你的项目,请将 disabled 字段设置为 true 以暂停报告,或删除 projects/\<name\>/ 以完全撤回项目。
tools/check 会像 docker build 一样,在具有网络访问权限的情况下运行你项目的 Dockerfile。使用 --qemu 时,构建会在虚拟机内运行,这可以使其无法访问你的文件,但它仍然可以访问你计算机上的服务和你的本地网络。只检查你信任的项目,或使用一台没有重要数据的机器。tools/check 会将 Claude Code 安装到它构建的镜像中(与扫描器所做的一样)。Claude Code 受其自身条款约束。请访问 red.anthropic.com/oss-scanner。
维护状态: 此仓库由 Anthropic 积极维护。我们仅审查并合并注册拉取请求(projects/<name>/ 下的更改);我们不接受其他贡献,包括对 tools/ 或 templates/ 的更改。有关如何注册,请参阅 CONTRIBUTING.md;要报告此仓库中的漏洞,请参阅 SECURITY.md;以及 CODE_OF_CONDUCT.md。