Servizio che compila repository open-source registrati in VM offline isolate e li analizza alla ricerca di vulnerabilità di sicurezza, inviando via email i risultati con reproducer e patch proposte.
OSS Scanner è un servizio di Anthropic per scansionare repository open-source critici alla ricerca di vulnerabilità di sicurezza. Scopri di più sul servizio su red.anthropic.com/oss-scanner.
Nota: l'uso di questo strumento è soggetto ai termini e alle condizioni descritti nei termini di OSS Scanner.
Iscrivi un progetto open-source aprendo una pull request che aggiunge una directory:
projects/<name>
Il nostro scanner di sicurezza compila il tuo progetto in una VM isolata, poi lo analizza senza accesso a Internet e invia via email ciò che trova a primary_contact (e a eventuali CC), ciascuno con un reproducer e una patch proposta ove disponibile. I report sono generati da modelli e non sono revisionati da una persona. Per questo motivo non applichiamo un periodo di divulgazione di 90 giorni a queste segnalazioni e non le renderemo pubbliche. I proprietari dei progetti dovrebbero fornire project.yaml (per configurare lo scanner), un Dockerfile (che indichi come compilare il progetto) e facoltativamente un threat_model.md (che fornisca una modellazione delle minacce specifica del progetto), un report_guidelines.md e un patch_guidelines.md (che indichino come vorresti che apparissero i report e le patch).
Parti da 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 e primary_contact sono sempre obbligatori. dockerfile è obbligatorio a meno che tu non tenga il tuo Dockerfile accanto a project.yaml (vedi sotto). Gli altri sono facoltativi.
Gli indirizzi email in project.yaml sono pubblici. Usa indirizzi che sei felice di vedere pubblicati, come un alias di sicurezza.
Per ricevere i report via email in forma crittografata, aggiungi la tua chiave pubblica OpenPGP in formato armored. Questi verranno quindi inviati solo a primary_contact; pgp non può essere combinato con auto_ccs:
pgp: |
-----BEGIN PGP PUBLIC KEY BLOCK-----
mQINBF...
-----END PGP PUBLIC KEY BLOCK-----
Per scegliere dove vanno i report, imposta la severità minima che ogni canale riceve: low, medium, high, critical, oppure none per disattivare il canale. Un canale che ometti usa il valore predefinito mostrato qui, e un report pari o superiore a entrambi i minimi viene inviato a entrambi i canali. pgp si applica solo all'email, quindi i report GitHub non vengono cifrati con la tua chiave:
output_format:
email:
min_severity: low
github_security_advisory: # GitHub private vulnerability reporting
min_severity: none
Per attivare i report di GitHub, abilita prima la segnalazione privata delle vulnerabilità sul tuo repository e aggiungi oss-scanner come segnalatore attendibile. Anthropic gestisce l'account oss-scanner, da cui provengono i nostri report; senza questa configurazione, GitHub limita il numero di report che può inviarti. Ti chiediamo di confermarlo nella tua pull request prima che procediamo al merge.
Devi fornire un Dockerfile, esattamente in una delle due posizioni seguenti:
dockerfile: con il suo percorso (suggeriamo una posizione come .oss-scanner/Dockerfile). Questa è l'opzione preferita perché ti consente di aggiornare la build senza una pull request qui; oppure,project.yaml, come projects/<name>/Dockerfile, senza alcuna chiave Dockerfile: impostata nel project.yaml. Se preferisci non aggiungere file al tuo repository, mettilo qui e lo scanner lo compila esattamente come farebbe con una copia interna al repository.(Il threat model funziona allo stesso modo. Imposta il campo threat_model con la sua posizione nel tuo repository, oppure inseriscilo qui in projects/<name>/threat_model.md. Lo stesso vale per le linee guida dei report e le linee guida delle patch, con i campi report_guidelines e patch_guidelines.)
Lo scopo del Dockerfile è configurare il tuo ambiente, installare ogni dipendenza e compilare il progetto. La configurazione iniziale del progetto viene eseguita con accesso alla rete abilitato, ma l'audit di sicurezza successivo viene eseguito senza accesso a Internet. Tutto ciò di cui la build o i test hanno bisogno deve essere scaricato durante la configurazione iniziale del Dockerfile. Consigliamo di verificare che i tuoi test passino all'interno dell'immagine compilata.
Il file threat_model.md (opzionale ma fortemente consigliato) ti consente di fornire allo scanner la documentazione sui tuoi obiettivi di sicurezza previsti. Abbiamo riscontrato che è molto utile fornire indicazioni su come valuti la gravità dei report (ad esempio, consideri una SQLi post-autenticazione alta o critica? i buffer overflow senza exploit dimostrati sono limitati ad alta? quando una XSS memorizzata è media, alta e critica?). Questo file può anche indicare cosa fa il progetto, dove entra l'input non attendibile, quali componenti contano e quali sono fuori ambito, o qualsiasi altra cosa tu ritenga importante o utile.
Altri due file (opzionali ma fortemente consigliati) ti permettono di indicare come vorresti che apparissero i nostri report e le nostre patch:
report_guidelines.md riguarda il formato di ciascun report: la sua struttura e le sue sezioni, la lunghezza, il tono e quali fatti indicare.patch_guidelines.md riguarda lo stile di ciascuna patch: ad esempio, quanti commenti scrivere, se una correzione debba essere molto ristretta o più generale, quali test aggiungere e quale formatter usare.Parti da templates/report_guidelines.md e templates/patch_guidelines.md. Entrambi sono testo semplice di al massimo 16 KiB.
Questi file cambiano solo il modo in cui vengono scritti report e patch; ciò che è in ambito e come valuti la gravità appartiene a threat_model.md. Ogni file viene verificato automaticamente prima di essere usato. Un file che tenta di cambiare più di questo, ad esempio per omettere risultati o eseguire comandi non correlati, viene ignorato nella sua interezza.
Suggeriamo di eseguire due comandi prima di aprire una pull request:
tools/validate.py verifica projects/<name>/ rispetto alle regole sopra.tools/check <name> compila il tuo progetto come farà il nostro scanner e apre una shell nell'immagine finale senza rete. Se i tuoi test passano in questo container, è probabile che il nostro scanner funzioni con il tuo progetto. tools/check --qemu <name> fa lo stesso all'interno di macchine virtuali configurate come quelle dello scanner.Questi strumenti richiedono che il tuo host abbia installato git, Docker e Python 3 con PyYAML (pip install pyyaml); --qemu richiede Linux su x86-64 con QEMU invece di Docker.