BLACKSHIELD

Öffentlicher Leitfaden

Ihre ersten Findings importieren

Führen Sie Ihren ersten Scan durch, übermitteln Sie Ergebnisse und bestätigen Sie die Datenqualität, bevor Sie auf weitere Integrationen erweitern. Zielgruppe: Sicherheitsingenieure, CI-Besitzer und Integrationsingenieure. Typische Einrichtungszeit: 10-15 Minuten.

Start herejourney

Use this if

Führen Sie Ihren ersten Scan durch, übermitteln Sie Ergebnisse und bestätigen Sie die Datenqualität, bevor Sie auf weitere Integrationen erweitern.

Audience
Sicherheitsingenieure, CI-Besitzer und Integrationsingenieure
Typical time
10-15 Minuten

Start here

Step 4 of 6

Recommended
1
2
3
4
5
6

Bevor Sie beginnen

  • Erstellen Sie einen Aufnahme-API-Schlüssel in /api-keys und speichern Sie den Rohschlüssel (einmal angezeigt).
  • Verwenden Sie das Scanner-Image public.ecr.aws/blackshield-security/pipeline-scanner:1.0.0 (oder Ihren gespiegelten public.ecr.aws-Alias).
  • Legen Sie BLACKSHIELD_API_URL auf Ihren Backend-Endpunkt fest (lokal: http://localhost:8000).)

Do this now

Schritt 1

Wählen Sie das Scannerbild und das erste Ziel

Verwenden Sie ein deterministisches Ziel und ein bekanntes Scannerbild, damit die Ergebnisse leicht zu validieren sind.

  • Verwenden Sie zunächst `public.ecr.aws/blackshield-security/pipeline-scanner:1.0.0` (oder Ihren gespiegelten öffentlichen ECR-Alias). run.
  • Wählen Sie ein bekanntes Ziel wie `python:3.11-slim` für vorhersehbare erste Ergebnisse.
  • RFühren Sie Trivy oder Semgrep im vom Scanner unterstützten JSON-Modus aus client.
  • Bewahren Sie Branch-, Commit- oder Artefakt-Metadaten zur Fehlerbehebung auf.

What success looks like

Bewahren Sie Branch-, Commit- oder Artefakt-Metadaten zur Fehlerbehebung auf.

Deploy the Pipeline Scanner

Schritt 2

Erstellen und verwenden Sie eine Aufnahme-API Schlüssel

Erstellen Sie einen Arbeitsbereichsschlüssel in API-Schlüsseln und verwenden Sie ihn nur für die Scanneraufnahme.

  • Öffnen Sie `/api-keys`, erstellen Sie einen Schlüssel und speichern Sie den Rohwert `sp_...` sofort.
  • Legen Sie `BLACKSHIELD_API_URL` und `BLACKSHIELD_API_KEY` über Umgebungsvariablen fest.
  • RFühren Sie den passenden Scanner-Client-Einstiegspunkt oder Container-Befehl aus.
  • Erfassen Sie Antwortprotokolle als Nachweis akzeptierter Nutzlasten.

What success looks like

Erfassen Sie Antwortprotokolle als Nachweis akzeptierter Nutzlasten.

Offene API-Schlüssel · Sign-in required

Schritt 3

Qualität und Deduplizierung validieren

Stellen Sie sicher, dass die Ergebnisse vollständig sind, der Schweregrad korrekt zugeordnet ist und wiederholte Uploads keine doppelten Probleme verursachen.

  • Öffnen Sie „Ergebnisse“ und filtern Sie nach Scanner und Ressource.
  • Überprüfen Sie, ob die Felder `first_seen` und `last_seen` ausgefüllt sind.
  • Senden Sie dieselbe Nutzlast einmal erneut und überprüfen Sie das Deduplizierungsverhalten.

What success looks like

Senden Sie dieselbe Nutzlast einmal erneut und überprüfen Sie das Deduplizierungsverhalten.

Offene Befunde · Sign-in required

Ausführen

Erstellen Sie einen Aufnahme-API-Schlüssel über 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}'

RFühren Sie den ersten Pipeline-Scan durch und erfassen Sie Ergebnisse.

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

  • Der Status des Aufnahmejobs erreicht „Abgeschlossen“ mit „Erstellt“ > 0 oder „Aktualisiert“ > 0.
  • Neue Erkenntnisse werden in /findings mit Schweregrad, Quellenscanner und Zeitstempel angezeigt.
Ihre ersten Findings importieren | BlackShield Docs