Bitbucket सुरक्षा: Infrastructure as Code सुरक्षा स्कैनर

आपकी Infrastructure as Code कॉन्फ़िगरेशन फ़ाइलों को स्कैन करता है ताकि अच्छी सुरक्षा प्रथाएँ सुनिश्चित की जा सकें। यदि कोई समस्या पाई जाती है तो एक सुरक्षा Code Insights रिपोर्ट बनाता है।

यह Bitbucket Cloud समर्थित Pipe उद्योग-अग्रणी KICS स्कैनिंग टूल का लाभ उठाकर Bitbucket ग्राहकों को IaC स्कैनिंग क्षमताएँ प्रदान करता है। अधिक जानकारी के लिए विवरण और उदाहरण अनुभाग देखें।

YAML परिभाषा

अपनी bitbucket-pipelines.yml फ़ाइल के script अनुभाग में निम्नलिखित स्निपेट जोड़ें:

- pipe: atlassian/bitbucket-iac-scan:0.5.2
  variables:
    FILES_TO_SCAN_PATH: '<string>'
    # SCAN_EXTRA_ARGS: '<array>' # Optional.
    # CONFIG_PATH: '<string>' # Optional.
    # CREATE_REPORT: "<boolean>" # Optional. Default: `true`
    # FAIL_ON: "<integer>" # Optional.
    # DEBUG: "<boolean>" # Optional. Default: `false`

वेरिएबल्स

वेरिएबल	उपयोग
FILES_TO_SCAN_PATH (*)	स्कैन करने के लिए फ़ाइलें या निर्देशिकाएँ, , से अलग की गई। उदाहरण: "./path_to_dir,path_to_file.txt"।
SCAN_EXTRA_ARGS	KICS स्कैन कमांड में पास करने के लिए अतिरिक्त विकल्प। यदि -p आर्ग्युमेंट पास किया जाता है, तो यह FILES_TO_SCAN_PATH वेरिएबल में दी गई फ़ाइलों या निर्देशिकाओं को बढ़ाएगा। यदि --config आर्ग्युमेंट पास किया जाता है, तो इसे CONFIG_PATH वेरिएबल के पक्ष में अनदेखा कर दिया जाएगा।
CONFIG_PATH	KICS कॉन्फ़िगरेशन फ़ाइल का पथ। SCAN_EXTRA_ARGS वेरिएबल का विकल्प। यदि कॉन्फ़िग फ़ाइल के अंदर path कीवर्ड दिया गया है, तो इसे FILES_TO_SCAN_PATH वेरिएबल के पक्ष में अनदेखा कर दिया जाएगा।
CREATE_REPORT	नियंत्रित करता है कि पाइप KICS निष्पादन के परिणामों का उपयोग करके Bitbucket CodeInsights रिपोर्ट बनाएगा या नहीं। डिफ़ॉल्ट: true।
FAIL_ON	KICS स्कैनर के [परिणाम स्थिति कोड][result status code] का थ्रेशोल्ड मान जिस पर पाइप को विफलता ट्रिगर करनी चाहिए।
DEBUG	अतिरिक्त डीबग जानकारी चालू करें। डिफ़ॉल्ट: false।

(*) = आवश्यक वेरिएबल।

अतिरिक्त विकल्प

यदि आवश्यक हो, तो उपयोगकर्ता SCAN_EXTRA_ARGS वेरिएबल के साथ स्कैन कमांड से विकल्पों को शामिल करके अपने स्कैन को बेहतर बना सकते हैं।

इसके अतिरिक्त, उपयोगकर्ताओं के पास एक कस्टम KICS कॉन्फ़िगरेशन फ़ाइल बनाने और प्रदान करने का विकल्प है, जिसे bitbucket-iac-scan पाइप में CONFIG_PATH वेरिएबल के माध्यम से लागू किया जाता है। यह कॉन्फ़िगरेशन फ़ाइल SCAN_EXTRA_ARGS का उपयोग करने का एक विकल्प है। कस्टम KICS कॉन्फ़िग बनाने के बाद, इसे उपयोगकर्ता के रिपॉज़िटरी के भीतर संग्रहीत किया जाना चाहिए। यह वह स्थान है जहाँ bitbucket-iac-scan पाइप वाली पाइपलाइन ट्रिगर होगी।

यदि SCAN_EXTRA_ARGS और CONFIG_PATH दोनों वेरिएबल्स को डुप्लिकेट आर्ग्युमेंट्स के साथ प्रदान किया जाता है, तो SCAN_EXTRA_ARGS वेरिएबल के आर्ग्युमेंट्स की प्राथमिकता अधिक होगी।

उदाहरण

बुनियादी उदाहरण:

script:
  - pipe: atlassian/bitbucket-iac-scan:0.5.2
    variables:
      FILES_TO_SCAN_PATH: ./my_files_to_scan_dir

स्रोतों को स्कैन करें और यदि KICS स्कैनर का [result status code][result status code] दिए गए threshold मान से अधिक या उसके बराबर है तो pipe को विफल होना चाहिए।

script:
  - pipe: atlassian/bitbucket-iac-scan:0.5.2
    variables:
      FILES_TO_SCAN_PATH: ./my_files_to_scan_dir
      FAIL_ON: 40

उन्नत उदाहरण:

पाइप में उपयोग किए जा सकने वाले kics कॉन्फ़िग के साथ उदाहरण:

kics-config.json. path कुंजी को अनदेखा किया जाएगा

{
  "path": "assets/iac_samples",
  "verbose": true,
  "log-file": true,
  "type": "Dockerfile,Kubernetes",
  "queries-path": "assets/queries",
  "exclude-paths": [
     "foo/",
     "bar/"
  ],
  "output-path": "results"
}

script:
  - pipe: atlassian/bitbucket-iac-scan:0.5.2
    variables:
      FILES_TO_SCAN_PATH: ./my_files_to_scan_dir
      CONFIG_PATH: kics-config.json

स्कैन विकल्पों के साथ उदाहरण:

script:
  - pipe: atlassian/bitbucket-iac-scan:0.5.2
    variables:
      FILES_TO_SCAN_PATH: ./my_files_to_scan_dir
      SCAN_EXTRA_ARGS:
        - "--disable-secrets"
        - "--type=Dockerfile"

CodeInsights रिपोर्ट न बनाएँ:

script:
  - pipe: atlassian/bitbucket-iac-scan:0.5.2
    variables:
      FILES_TO_SCAN_PATH: ./my_files_to_scan_dir
      CREATE_REPORT: 'false'

सहायता

यदि आपको इस pipe के साथ सहायता चाहिए, या आपके पास कोई समस्या या फ़ीचर अनुरोध है, तो हमें Community पर बताएं।

यदि आप किसी समस्या की रिपोर्ट कर रहे हैं, तो कृपया शामिल करें:

• pipe का संस्करण
• प्रासंगिक लॉग और त्रुटि संदेश
• समस्या को दोहराने के चरण

लाइसेंस

Copyright (c) 2024 Atlassian and others. Apache 2.0 लाइसेंस प्राप्त, देखें LICENSE.txt फ़ाइल।