BLACKSHIELD

सार्वजनिक गाइड

अपनी पहली फाइंडिंग्स इनजेस्ट करें

अधिक एकीकरणों का विस्तार करने से पहले अपना पहला स्कैन चलाएं, निष्कर्ष सबमिट करें और डेटा गुणवत्ता की पुष्टि करें। लक्षित पाठक: सुरक्षा इंजीनियर, सीआई मालिक, और एकीकरण इंजीनियर. सामान्य सेटअप समय: 10-15 मिनट.

शुरू करने से पहले

  • /api-keys में एक अंतर्ग्रहण एपीआई कुंजी बनाएं और कच्ची कुंजी सहेजें (एक बार दिखाया गया है)।
  • स्कैनर छवि secplatform/pipeline-scanner:latest (या आपके प्रतिबिंबित public.ecr.aws उपनाम) का उपयोग करें।
  • SECPLATFORM_API_URL को अपने बैकएंड एंडपॉइंट पर सेट करें (स्थानीय: http://localhost:8000).

चरण-दर-चरण

चरण 1

स्कैनर छवि और पहला लक्ष्य चुनें

एक नियतात्मक लक्ष्य और एक ज्ञात स्कैनर छवि का उपयोग करें ताकि परिणामों को सत्यापित करना आसान हो।

  • पहली बार चलाने के लिए `secplatform/pipeline-scanner:latest` (या अपना प्रतिबिंबित सार्वजनिक ईसीआर उपनाम) का उपयोग करें।
  • पूर्वानुमानित प्रथम परिणामों के लिए `python:3.11-slim` जैसा ज्ञात लक्ष्य चुनें।
  • स्कैनर क्लाइंट द्वारा समर्थित JSON मोड में ट्रिवी या सेमग्रेप चलाएँ।
  • समस्या निवारण के लिए ब्रांच, कमिट या आर्टिफैक्ट मेटाडेटा रखें।

चरण 2

अंतर्ग्रहण एपीआई कुंजी बनाएं और उसका उपयोग करें

एपीआई कुंजी में एक कार्यस्थान कुंजी बनाएं और इसका उपयोग केवल स्कैनर अंतर्ग्रहण के लिए करें।

  • `/api-keys` खोलें, एक कुंजी बनाएं, और कच्चे `sp_...` मान को तुरंत सहेजें।
  • पर्यावरण चर के माध्यम से `SECPLATFORM_API_URL` और `SECPLATFORM_API_KEY` सेट करें।
  • मिलान स्कैनर क्लाइंट एंट्रीपॉइंट या कंटेनर कमांड चलाएँ।
  • स्वीकृत पेलोड के प्रमाण के रूप में प्रतिक्रिया लॉग कैप्चर करें।

चरण 3

गुणवत्ता और डिडुप्लीकेशन को मान्य करें

सुनिश्चित करें कि निष्कर्ष पूर्ण हैं, गंभीरता को सही ढंग से मैप किया गया है, और बार-बार अपलोड करने से समस्याएँ दोहराई नहीं जाती हैं।

  • निष्कर्ष खोलें और स्कैनर और संसाधन द्वारा फ़िल्टर करें।
  • सत्यापित करें कि `first_seen` और `last_seen` फ़ील्ड भरे हुए हैं।
  • एक ही पेलोड को एक बार पुनः सबमिट करें और डिडुप्लीकेशन व्यवहार को सत्यापित करें।

यह चलाएँ

एपीआई के माध्यम से एक अंतर्ग्रहण एपीआई कुंजी बनाएं

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 SECPLATFORM_API_URL=http://localhost:8000 \
  -e SECPLATFORM_API_KEY=sp_your_key_here \
  -e SCAN_TOOL=trivy \
  -e SCAN_TARGET=python:3.11-slim \
  secplatform/pipeline-scanner:latest

सफलता जाँच

  • अंतर्ग्रहण कार्य की स्थिति निर्मित > 0 या अद्यतन > 0 के साथ पूर्ण हो जाती है।
  • नए निष्कर्ष गंभीरता, स्रोत स्कैनर और टाइमस्टैम्प के साथ /findings में दिखाई देते हैं।
अपनी पहली फाइंडिंग्स इनजेस्ट करें | BlackShield Docs