Serviço que compila repositórios open-source inscritos em VMs isoladas offline e os analisa em busca de vulnerabilidades de segurança, enviando por e-mail os resultados com reprodutores e patches propostos.
OSS Scanner é um serviço da Anthropic para escanear repositórios de código aberto críticos em busca de vulnerabilidades de segurança. Saiba mais sobre o serviço em red.anthropic.com/oss-scanner.
Observe que o uso desta ferramenta está sujeito aos termos e condições descritos nos termos do OSS Scanner.
Inscreva um projeto de código aberto abrindo um pull request que adiciona um diretório:
projects/<name>
Nosso scanner de segurança compila seu projeto em uma VM isolada, depois o analisa sem acesso à Internet e envia por e-mail o que encontra para primary_contact (e quaisquer CCs), cada um com um reprodutor e um patch proposto quando disponível. Os relatórios são gerados por modelo e não são revisados por um humano. Por isso, não impomos um período de divulgação de 90 dias sobre essas descobertas e não as tornaremos públicas. Os proprietários do projeto devem fornecer project.yaml (para configurar o scanner), um Dockerfile (indicando como compilar o projeto) e, opcionalmente, um threat_model.md (fornecendo modelagem de ameaças específica do projeto), um report_guidelines.md e um patch_guidelines.md (indicando como você gostaria que os relatórios e patches fossem apresentados).
Comece a partir de 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 são sempre obrigatórios. dockerfile é obrigatório, a menos que você mantenha seu Dockerfile ao lado de project.yaml (veja abaixo). Os demais são opcionais.
Os endereços de e-mail em project.yaml são públicos. Use endereços que você não se importe em ver publicados, como um alias de segurança.
Para receber relatórios por e-mail criptografados, adicione sua chave pública OpenPGP em formato armored. Eles então serão enviados apenas para primary_contact; pgp não pode ser combinado com auto_ccs:
pgp: |
-----BEGIN PGP PUBLIC KEY BLOCK-----
mQINBF...
-----END PGP PUBLIC KEY BLOCK-----
Para escolher para onde vão os relatórios, defina a severidade mínima que cada canal recebe: low, medium, high, critical, ou none para desativar o canal. Um canal que você omitir usa o padrão mostrado aqui, e um relatório igual ou superior a ambos os mínimos vai para ambos os canais. pgp aplica-se apenas ao email, portanto os relatórios do GitHub não são encriptados com a sua chave:
output_format:
email:
min_severity: low
github_security_advisory: # GitHub private vulnerability reporting
min_severity: none
Para ativar os relatórios do GitHub, primeiro habilite o relatório privado de vulnerabilidades no seu repositório e adicione oss-scanner como um relator confiável. A Anthropic opera a conta oss-scanner, de onde vêm os nossos relatórios; sem isso, o GitHub limita quantos relatórios pode enviar para você. Pedimos que você confirme isso no seu pull request antes de fazermos o merge.
Você deve fornecer um Dockerfile, em exatamente um de dois lugares:
dockerfile: com o caminho dele (sugerimos algum local como .oss-scanner/Dockerfile). Esta é a opção preferida porque permite atualizar o build sem um pull request aqui; ou,project.yaml, como projects/<name>/Dockerfile, sem a chave Dockerfile: definida no project.yaml. Se você preferir não adicionar arquivos ao seu repositório, coloque-o aqui e o scanner o compilará exatamente como faria com uma cópia no repositório.(O modelo de ameaças funciona da mesma forma. Defina o campo threat_model para o local dele no seu repositório, ou coloque-o aqui em projects/<name>/threat_model.md. O mesmo vale para as diretrizes de relatório e as diretrizes de patch, com os campos report_guidelines e patch_guidelines.)
O propósito do Dockerfile é configurar o seu ambiente, instalar todas as dependências e compilar o projeto. A configuração inicial do projeto é executada com acesso à rede habilitado, mas a auditoria de segurança que vem depois é executada sem acesso à Internet. Tudo o que o build ou os testes precisarem deve ser obtido durante a configuração inicial do Dockerfile. Recomendamos verificar se os seus testes passam dentro da imagem compilada.
O arquivo threat_model.md (opcional, mas fortemente recomendado) permite fornecer ao scanner documentação sobre os seus objetivos de segurança pretendidos. Descobrimos que é mais útil fornecer orientações sobre como você classifica a gravidade dos relatórios (por exemplo, você considera um SQLi pós-autenticação alto ou crítico? estouros de buffer sem exploits demonstrados são limitados a alto? quando um XSS armazenado é médio, alto e crítico?). Este arquivo também pode declarar o que o projeto faz, onde entram as entradas não confiáveis, quais componentes importam e quais estão fora do escopo, ou qualquer outra coisa que você considere importante ou útil.
Mais dois arquivos (opcionais, mas fortemente recomendados) permitem que você diga como gostaria que os nossos relatórios e patches fossem:
report_guidelines.md é para o formato de cada relatório: seu layout e seções, comprimento, tom e quais fatos declarar.patch_guidelines.md é para o estilo de cada patch: por exemplo, quantos comentários escrever, se uma correção deve ser muito restrita ou mais geral, quais testes adicionar e qual formatador usar.Comece a partir de templates/report_guidelines.md e templates/patch_guidelines.md. Ambos são texto simples de no máximo 16 KiB.
Esses arquivos apenas alteram como os relatórios e patches são escritos; o que está no escopo e como você classifica a gravidade pertencem ao threat_model.md. Cada arquivo é verificado automaticamente antes de ser usado. Um arquivo que tente alterar mais do que isso, por exemplo, para omitir descobertas ou executar comandos não relacionados, é ignorado por completo.
Sugerimos que você execute dois comandos antes de abrir um pull request:
tools/validate.py verifica projects/<name>/ em relação às regras acima.tools/check <name> compila o seu projeto da forma como o nosso scanner fará e abre um shell na imagem finalizada sem rede. Se os seus testes passarem neste contêiner, o nosso scanner provavelmente funcionará com o seu projeto. tools/check --qemu <name> faz o mesmo dentro de máquinas virtuais organizadas como as do scanner.Essas ferramentas exigem que o seu host tenha git, Docker e Python 3 com PyYAML instalados (pip install pyyaml); --qemu requer Linux em x86-64 com QEMU em vez de Docker.