BLACKSHIELD

公開ガイド

最初の検出結果を取り込む

最初のスキャンを実行し、結果を送信し、さらに統合を拡張する前にデータ品質を確認します。 対象: セキュリティエンジニア、CIオーナー、統合エンジニア. 一般的な設定時間: 10-15 分.

Start herejourney

Use this if

最初のスキャンを実行し、結果を送信し、さらに統合を拡張する前にデータ品質を確認します。

Audience
セキュリティエンジニア、CIオーナー、統合エンジニア
Typical time
10-15 分

Start here

Step 4 of 6

Recommended
1
2
3
4
5
6

開始前に

  • 取り込み API を作成する/api-keys にキーを入力し、生のキーを保存します (一度表示)。
  • スキャナー イメージ public.ecr.aws/blackshield-security/pipeline-scanner:1.0.0 (またはミラーリングされた public.ecr.aws エイリアス) を使用します。
  • BLACKSHIELD_API_URL をバックエンド エンドポイントに設定します (ローカル: http://localhost:8000).

Do this now

ステップ 1

スキャナー イメージと最初のターゲットを選択します

結果を簡単に検証できるように、決定的なターゲットと既知のスキャナー イメージを使用します。

  • 最初の実行には `public.ecr.aws/blackshield-security/pipeline-scanner:1.0.0` (またはミラーリングされたパブリック ECR エイリアス) を使用します。
  • `python:3.11-slim` などの既知のターゲットを選択します予測可能な最初の結果を得るには。
  • Rスキャナ クライアントでサポートされている JSON モードで Trivy または Semgrep を実行します。
  • トラブルシューティング用にブランチ、コミット、またはアーティファクトのメタデータを保持します。

What success looks like

トラブルシューティング用にブランチ、コミット、またはアーティファクトのメタデータを保持します。

Deploy the Pipeline Scanner

ステップ 2

取り込み API キーを作成して使用する

API キーにワークスペース キーを作成し、スキャナー取り込みにのみ使用します。

  • `/api-keys` を開いてキーを作成し、生の `sp_...` 値をすぐに保存します。
  • 環境変数を介して `BLACKSHIELD_API_URL` と `BLACKSHIELD_API_KEY` を設定します。
  • R 一致するスキャナ クライアント エントリポイントまたはコンテナを実行します。 command.
  • 受け入れられたペイロードの証拠として応答ログをキャプチャします。

What success looks like

受け入れられたペイロードの証拠として応答ログをキャプチャします。

API キーを開く · Sign-in required

ステップ 3

品質と重複排除を検証する

検出結果が完全であり、重大度が正しくマッピングされており、繰り返しアップロードしても問題が重複しないことを確認します。

  • 調査結果を開き、スキャナーとリソースでフィルターします。
  • `first_seen` フィールドと `last_seen` フィールドが入力されていることを確認します。
  • 同じペイロードを 1 回再送信して検証します重複排除動作。

What success looks like

同じペイロードを 1 回再送信して検証します重複排除動作。

調査結果を開く · Sign-in required

実行する

API 経由で取り込み 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}'

R最初のパイプライン スキャンを実行し、結果を取り込みます

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

  • 取り込みジョブのステータスが、作成済み > 0 または更新済み > 0 で完了に達します。
  • 新しい検出結果は、重大度、ソース スキャナー、およびタイムスタンプとともに /findings に表示されます。
最初の検出結果を取り込む | BlackShield Docs