BLACKSHIELD

Guia público

Ingira seus primeiros achados

Execute sua primeira verificação, envie as descobertas e confirme a qualidade dos dados antes de expandir para mais integrações. Público: Engenheiros de segurança, proprietários de CI e engenheiros de integração. Tempo típico de configuração: 10-15 minutos.

Comece aquijourney

Use isto se

Execute sua primeira verificação, envie as descobertas e confirme a qualidade dos dados antes de expandir para mais integrações.

Audience
Engenheiros de segurança, proprietários de CI e engenheiros de integração
Typical time
10-15 minutos

Comece aqui

Step 4 of 6

Recomendado
1
2
3
4
5
6

Antes de começar

  • Crie uma chave de API de ingestão em /api-keys e salve a chave bruta (mostrada uma vez).
  • Use a imagem do scanner public.ecr.aws/blackshield-security/pipeline-scanner:1.0.0 (ou seu alias public.ecr.aws espelhado).
  • Defina BLACKSHIELD_API_URL para seu endpoint de back-end (local: http://localhost:8000).

Faça isto agora

Passo 1

Escolha a imagem do scanner e o primeiro alvo

Use um alvo determinístico e uma imagem de scanner conhecida para que os resultados sejam fáceis de validar.

  • Use `public.ecr.aws/blackshield-security/pipeline-scanner:1.0.0` (ou seu alias ECR público espelhado) para a primeira execução.
  • Escolha um alvo conhecido como `python:3.11-slim` para obter primeiros resultados previsíveis.
  • Execute Trivy ou Semgrep no modo JSON compatível com o cliente do scanner.
  • Mantenha metadados de branch, commit ou artefato para solução de problemas.

Como é o sucesso

Mantenha metadados de branch, commit ou artefato para solução de problemas.

Deploy the Pipeline Scanner

Passo 2

Criar e usar uma chave de API de ingestão

Crie uma chave de espaço de trabalho em Chaves de API e use-a somente para ingestão de scanner.

  • Abra `/api-keys`, crie uma chave e salve o valor bruto de `sp_...` imediatamente.
  • Defina `BLACKSHIELD_API_URL` e `BLACKSHIELD_API_KEY` por meio de variáveis ​​de ambiente.
  • Execute o ponto de entrada do cliente do scanner ou comando de contêiner correspondente.
  • Capture logs de resposta como prova de cargas aceitas.

Como é o sucesso

Capture logs de resposta como prova de cargas aceitas.

Abrir chaves de API · Requer login

Passo 3

Valide a qualidade e a desduplicação

Certifique-se de que as descobertas estejam completas, que a gravidade esteja mapeada corretamente e que uploads repetidos não dupliquem os problemas.

  • Abra Descobertas e filtre por scanner e recurso.
  • Verifique se os campos `first_seen` e `last_seen` estão preenchidos.
  • Reenvie a mesma carga uma vez e verifique o comportamento da desduplicação.

Como é o sucesso

Reenvie a mesma carga uma vez e verifique o comportamento da desduplicação.

Abrir descobertas · Requer login

Executar isto

Crie uma chave de API de ingestão via API

bash
TOKEN=$(curl -s -X POST "http://localhost:8000/api/v1/auth/login?email=admin@acme.com&password=changeme123" | python3 -c "import sys, json; print(json.load(sys.stdin)['access_token'])")

curl -s -X POST http://localhost:8000/api/v1/api-keys \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"label":"Pipeline Scanner","expires_in_days":90}'

Execute a primeira verificação do pipeline e ingira as descobertas

bash
docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -e BLACKSHIELD_API_URL=http://localhost:8000 \
  -e BLACKSHIELD_API_KEY=sp_your_key_here \
  -e SCAN_TOOL=trivy \
  -e SCAN_TARGET=python:3.11-slim \
  public.ecr.aws/blackshield-security/pipeline-scanner:1.0.0

Como é o sucesso

  • O status do trabalho de ingestão é concluído com criado > 0 ou atualizado > 0.
  • Novas descobertas aparecem em /findings com gravidade, scanner de origem e carimbos de data/hora.
Ingira seus primeiros achados | Documentação BlackShield