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-keys واحفظ المفتاح الأولي (يظهر مرة واحدة).
  • استخدم صورة الماسح الضوئي public.ecr.aws/blackshield-security/pipeline-scanner:1.0.0 (أو الاسم المستعار public.ecr.aws المتطابق).
  • قم بتعيين BLACKSHIELD_API_URL إلى نقطة النهاية الخلفية الخاصة بك (المحلي: http://localhost:8000).

Do this now

الخطوة 1

اختر صورة الماسح الضوئي والهدف الأول

استخدام هدف محدد وصورة ماسح ضوئي معروفة حتى يسهل التحقق من صحة النتائج.

  • Use `public.ecr.aws/blackshield-security/pipeline-scanner:1.0.0` (أو الاسم المستعار ECR العام المنعكس) لأول مرة تشغيل.
  • اختر هدفًا معروفًا مثل `python:3.11-slim` للحصول على نتائج أولى يمكن التنبؤ بها.
  • Run Trivy أو Semgrep في وضع JSON مدعوم من عميل الماسح الضوئي.
  • احتفظ ببيانات تعريف الفرع أو الالتزام أو البيانات الاصطناعية لاستكشاف الأخطاء وإصلاحها.

What success looks like

احتفظ ببيانات تعريف الفرع أو الالتزام أو البيانات الاصطناعية لاستكشاف الأخطاء وإصلاحها.

الخطوة 2

إنشاء مفتاح API للابتلاع واستخدامه

أنشئ مفتاح مساحة عمل في API Keys واستخدمه فقط في استيعاب الماسح الضوئي.

  • فتح `/api-keys`، وإنشاء مفتاح، وحفظ قيمة `sp_...` الأولية على الفور.
  • قم بتعيين `BLACKSHIELD_API_URL` و`BLACKSHIELD_API_KEY` عبر متغيرات البيئة.
  • قم بتشغيل نقطة دخول عميل الماسح الضوئي المطابق أو أمر الحاوية.
  • التقط سجلات الاستجابة كدليل على الحمولات المقبولة.

What success looks like

التقط سجلات الاستجابة كدليل على الحمولات المقبولة.

الخطوة 3

التحقق من الجودة وإلغاء البيانات المكررة

تأكد من اكتمال النتائج، وتم تعيين الخطورة بشكل صحيح، وعدم تكرار التحميلات المتكررة للمشكلات.

  • فتح النتائج والتصفية حسب الماسح الضوئي والموارد.
  • التحقق من تعبئة الحقول `first_seen` و`last_seen`.
  • أعد إرسال نفس الحمولة مرة واحدة وتحقق من سلوك إلغاء البيانات المكررة.

What success looks like

أعد إرسال نفس الحمولة مرة واحدة وتحقق من سلوك إلغاء البيانات المكررة.

نفّذ هذا

أنشئ مفتاح واجهة برمجة تطبيقات الإدخال عبر 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}'

تشغيل أول مسح لخطوط الأنابيب واستيعاب النتائج

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