Dienst, der registrierte Open-Source-Repositories in isolierten Offline-VMs baut und sie auf Sicherheitslücken scannt, wobei Ergebnisse per E-Mail mit Reproduzierern und vorgeschlagenen Patches versendet werden.
OSS Scanner ist ein Dienst von Anthropic, um kritische Open-Source-Repositories auf Sicherheitslücken zu scannen. Erfahren Sie mehr über den Dienst unter red.anthropic.com/oss-scanner.
Beachten Sie, dass die Nutzung dieses Tools den Bedingungen unterliegt, die in den OSS Scanner terms beschrieben sind.
Registrieren Sie ein Open-Source-Projekt, indem Sie einen Pull Request öffnen, der ein Verzeichnis hinzufügt:
projects/<name>
Unser Sicherheitsscanner baut Ihr Projekt in einer isolierten VM und analysiert es anschließend ohne Internetzugang. Die gefundenen Ergebnisse werden per E-Mail an primary_contact (und etwaige CCs) gesendet, jeweils mit einem Reproducer und, sofern verfügbar, einem vorgeschlagenen Patch. Die Berichte werden von einem Modell generiert und nicht von einem Menschen überprüft. Aus diesem Grund legen wir für diese Befunde keine 90-tägige Offenlegungsfrist fest und werden sie nicht veröffentlichen. Projektinhaber sollten project.yaml (zur Konfiguration des Scanners), ein Dockerfile (mit Angabe, wie das Projekt gebaut wird) und optional eine threat_model.md (mit projektspezifischer Threat-Modeling-Dokumentation), eine report_guidelines.md und eine patch_guidelines.md (mit Angabe, wie Berichte und Patches aussehen sollen) bereitstellen.
Beginnen Sie mit 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 und primary_contact sind immer erforderlich. dockerfile ist erforderlich, es sei denn, Sie legen Ihre Dockerfile neben project.yaml ab (siehe unten). Die übrigen sind optional.
Die E-Mail-Adressen in project.yaml sind öffentlich. Verwenden Sie Adressen, deren Veröffentlichung Sie zustimmen, etwa ein Security-Alias.
Um Berichte per E-Mail verschlüsselt zu erhalten, fügen Sie Ihren OpenPGP-Public-Key im ASCII-Armor-Format hinzu. Diese gehen dann ausschließlich an primary_contact; pgp kann nicht mit auto_ccs kombiniert werden:
pgp: |
-----BEGIN PGP PUBLIC KEY BLOCK-----
mQINBF...
-----END PGP PUBLIC KEY BLOCK-----
Um festzulegen, wohin Berichte gehen, legen Sie den niedrigsten Schweregrad fest, den jeder Kanal erhält: low, medium, high, critical oder none, um den Kanal zu deaktivieren. Ein Kanal, den Sie auslassen, verwendet den hier gezeigten Standardwert, und ein Bericht, der beide Mindestwerte erreicht oder überschreitet, geht an beide Kanäle. pgp gilt nur für E-Mail, daher werden GitHub-Berichte nicht mit Ihrem Schlüssel verschlüsselt:
output_format:
email:
min_severity: low
github_security_advisory: # GitHub private vulnerability reporting
min_severity: none
Um GitHub-Berichte zu aktivieren, aktiviere zunächst die private Schwachstellenmeldung in deinem Repository und füge oss-scanner als vertrauenswürdigen Melder hinzu. Anthropic betreibt das Konto oss-scanner, von dem unsere Berichte stammen; ohne dies begrenzt GitHub, wie viele Berichte es dir senden kann. Wir bitten dich, dies in deinem Pull Request zu bestätigen, bevor wir zusammenführen.
Du musst eine Dockerfile bereitstellen, und zwar an genau einer von zwei Stellen:
dockerfile: auf ihren Pfad (wir empfehlen einen Ort wie .oss-scanner/Dockerfile). Dies ist die bevorzugte Option, da sie es dir ermöglicht, den Build ohne einen Pull Request hier zu aktualisieren; oderproject.yaml, als projects/<name>/Dockerfile, ohne dass ein Dockerfile:-Schlüssel in der project.yaml gesetzt ist. Wenn du lieber keine Dateien zu deinem Repository hinzufügen möchtest, lege sie hier ab, und der Scanner baut sie genau so, wie er es mit einer Kopie im Repository tun würde.(Das Bedrohungsmodell funktioniert auf dieselbe Weise. Setze das Feld threat_model für seinen Speicherort in deinem Repository oder lege es hier unter projects/<name>/threat_model.md ab. Dasselbe gilt für die Berichtsrichtlinien und die Patch-Richtlinien, mit den Feldern report_guidelines und patch_guidelines.)
Der Zweck der Dockerfile besteht darin, deine Umgebung einzurichten, alle Abhängigkeiten zu installieren und das Projekt zu bauen. Die anfängliche Projekteinrichtung läuft mit aktiviertem Netzwerkzugriff, aber das anschließende Sicherheitsaudit läuft ohne Internetzugriff. Alles, was der Build oder die Tests benötigen, muss während der anfänglichen Dockerfile-Einrichtung abgerufen werden. Wir empfehlen zu überprüfen, ob deine Tests innerhalb des gebauten Images bestehen.
Die Datei threat_model.md (optional, aber dringend empfohlen) ermöglicht es dir, dem Scanner Dokumentation zu deinen beabsichtigten Sicherheitszielen bereitzustellen. Wir haben festgestellt, dass es am nützlichsten ist, Anleitungen dazu zu geben, wie du die Schwere von Berichten bewertest (z. B.: Betrachtest du Post-Auth-SQLi als hoch oder kritisch? Sind Pufferüberläufe ohne nachgewiesene Exploits auf hoch begrenzt? Wann ist gespeichertes XSS mittel, hoch und kritisch?). Diese Datei kann auch angeben, was das Projekt tut, wo nicht vertrauenswürdige Eingaben eintreten, welche Komponenten wichtig sind und welche außerhalb des Geltungsbereichs liegen, oder alles andere, was du für wichtig oder nützlich hältst.
Zwei weitere Dateien (optional, aber dringend empfohlen) ermöglichen es dir, festzulegen, wie unsere Berichte und Patches aussehen sollen:
report_guidelines.md ist für das Format jedes Berichts: sein Layout und seine Abschnitte, Länge, Ton und welche Fakten anzugeben sind.patch_guidelines.md ist für den Stil jedes Patches: zum Beispiel, wie viele Kommentare zu schreiben sind, ob ein Fix sehr eng gefasst oder allgemeiner sein sollte, welche Tests hinzuzufügen sind und welcher Formatierer zu verwenden ist.Beginne mit templates/report_guidelines.md und templates/patch_guidelines.md. Beide sind reiner Text von höchstens 16 KiB.
Diese Dateien ändern nur, wie Berichte und Patches geschrieben werden; was im Geltungsbereich liegt und wie du die Schwere bewertest, gehört in threat_model.md. Jede Datei wird automatisch geprüft, bevor sie verwendet wird. Eine Datei, die versucht, mehr als das zu ändern, zum Beispiel um Befunde auszulassen oder unzusammenhängende Befehle auszuführen, wird als Ganzes ignoriert.
Wir empfehlen dir, zwei Befehle auszuführen, bevor du einen Pull Request öffnest:
tools/validate.py prüft projects/<name>/ gegen die oben genannten Regeln.tools/check <name> baut dein Projekt so, wie es unser Scanner tun wird, und öffnet eine Shell im fertigen Image ohne Netzwerk. Wenn deine Tests in diesem Container bestehen, wird unser Scanner wahrscheinlich mit deinem Projekt funktionieren. tools/check --qemu <name> tut dasselbe in virtuellen Maschinen, die wie die des Scanners eingerichtet sind.