BLACKSHIELD

Guida pubblica

Ingerisci i primi risultati

Esegui la tua prima scansione, invia i risultati e conferma la qualità dei dati prima di espanderli a ulteriori integrazioni. Pubblico: Ingegneri di sicurezza, proprietari di CI e ingegneri dell'integrazione. Tempo medio di configurazione: 10-15 minuti.

Start herejourney

Use this if

Esegui la tua prima scansione, invia i risultati e conferma la qualità dei dati prima di espanderli a ulteriori integrazioni.

Audience
Ingegneri di sicurezza, proprietari di CI e ingegneri dell'integrazione
Typical time
10-15 minuti

Start here

Step 4 of 6

Recommended
1
2
3
4
5
6

Prima di iniziare

  • Crea una chiave API di acquisizione in /api-keys e salva la chiave non elaborata (mostrata una volta).
  • Utilizza l'immagine dello scanner public.ecr.aws/blackshield-security/pipeline-scanner:1.0.0 (o il tuo alias public.ecr.aws con mirroring).
  • Imposta BLACKSHIELD_API_URL sull'endpoint backend (locale: http://localhost:8000).

Do this now

Passo 1

Scegli l'immagine dello scanner e il primo target

Utilizza un target deterministico e un'immagine scanner nota in modo che i risultati siano facili da convalidare.

  • Utilizza `public.ecr.aws/blackshield-security/pipeline-scanner:1.0.0` (o l'alias ECR pubblico con mirroring) per primo esegui.
  • Scegliere un obiettivo noto come ad esempio `python:3.11-slim` per primi risultati prevedibili.
  • Esegui Trivy o Semgrep in modalità JSON supportata dal client dello scanner.
  • Mantieni metadati di rami, commit o artefatti per la risoluzione dei problemi.

What success looks like

Mantieni metadati di rami, commit o artefatti per la risoluzione dei problemi.

Deploy the Pipeline Scanner

Passo 2

Crea e utilizza un'API di acquisizione key

Crea una chiave dell'area di lavoro in Chiavi API e utilizzala solo per l'acquisizione dello scanner.

  • Apri `/api-keys`, crea una chiave e salva immediatamente il valore non elaborato `sp_...`.
  • Imposta `BLACKSHIELD_API_URL` e `BLACKSHIELD_API_KEY` tramite variabili di ambiente.
  • Esegui il punto di ingresso del client dello scanner corrispondente o il comando del contenitore.
  • Acquisisci i log di risposta come prova dei payload accettati.

What success looks like

Acquisisci i log di risposta come prova dei payload accettati.

Apri chiavi API · Sign-in required

Passo 3

Convalida qualità e deduplicazione

Essicurati che i risultati siano completi, la gravità sia mappata correttamente e i caricamenti ripetuti non si duplicano problemi.

  • Apri risultati e filtra per scanner e risorsa.
  • Verificare che i campi `first_seen` e `last_seen` siano popolati.
  • Riinvia lo stesso payload una volta e verifica il comportamento di deduplicazione.

What success looks like

Riinvia lo stesso payload una volta e verifica il comportamento di deduplicazione.

Apri risultati · Sign-in required

Esegui

Crea una chiave API di acquisizione tramite 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}'

Esegui la prima scansione e acquisizione della pipeline risultati

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

What success looks like

  • Lo stato del processo di acquisizione viene completato con creato > 0 o aggiornato > 0.
  • I nuovi risultati vengono visualizzati in /findings con gravità, scanner di origine e timestamp.
Ingerisci i primi risultati | BlackShield Docs