Bitbucket सुरक्षा: सीक्रेट स्कैनर

हार्डकोड किए गए सीक्रेट, कुंजियों और पासवर्ड के लिए आपकी फ़ाइलों को स्कैन करता है। यदि पाए जाते हैं तो एक सुरक्षा Code Insights रिपोर्ट बनाता है।

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

नोट: संस्करण 2.0.0 में ब्रेकिंग परिवर्तन पेश किए गए थे। कृपया Pipe के वर्तमान संस्करण की समीक्षा करें और अपग्रेड करने से पहले अपने कॉन्फ़िगरेशन को तदनुसार अपडेट करें।

नोट: संस्करण 3.0.0 में ब्रेकिंग परिवर्तन पेश किए गए थे। कृपया Pipe के वर्तमान संस्करण की समीक्षा करें और अपग्रेड करने से पहले अपने कॉन्फ़िगरेशन को तदनुसार अपडेट करें।

YAML परिभाषा

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

- pipe: atlassian/git-secrets-scan:3.2.0
  variables:
    # GITLEAKS_COMMAND: '<string>' # Optional. Default: `git`
    # GITLEAKS_EXTRA_ARGS: '<array>' # Optional.
    # CREATE_REPORT: "<boolean>" # Optional. Default: `true`
    # DEBUG: "<boolean>" # Optional. Default: `false`

वेरिएबल्स

वेरिएबल	उपयोग
GITLEAKS_COMMAND	gitleaks के साथ उपयोग किया जाने वाला कमांड। उपलब्ध: git, dir, stdin। डिफ़ॉल्ट: git।
GITLEAKS_EXTRA_ARGS	gitleaks gitleaks extra args को पास किए जाने वाले अतिरिक्त फ़्लैग।
CREATE_REPORT	नियंत्रित करता है कि पाइप gitleaks निष्पादन के परिणामों का उपयोग करके Bitbucket CodeInsights रिपोर्ट बनाएगा या नहीं। डिफ़ॉल्ट: true।
DEBUG	अतिरिक्त डिबग जानकारी चालू करें। डिफ़ॉल्ट: false।

विवरण

डिफ़ॉल्ट रूप से, पाइप gitleaks git कमांड के साथ हार्डकोडेड सीक्रेट क्रेडेंशियल्स के लिए आपकी फ़ाइलों को स्कैन करेगा और प्रत्येक पाए गए क्रेडेंशियल के लिए एनोटेशन के साथ एक सुरक्षा रिपोर्ट बनाएगा।

उन्नत उपयोग

उन्नत gitleaks कॉन्फ़िगरेशन सेटअप के लिए इस ब्लॉगपोस्ट पर एक नज़र डालें: gitleaks advanced configuration setup।

टेस्ट सीक्रेट्स को कैसे अनदेखा करें: gitleaks additional-configuration।

उदाहरण

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

डिफ़ॉल्ट git कमांड के साथ सीक्रेट क्रेडेंशियल्स के लिए स्कैन चलाएँ:

script:
  - pipe: atlassian/git-secrets-scan:3.2.0

dir कमांड आपको निर्देशिकाओं और फ़ाइलों को स्कैन करने देता है:

script:
  - pipe: atlassian/git-secrets-scan:3.2.0
    variables:
      GITLEAKS_COMMAND: "dir"
      GITLEAKS_EXTRA_ARGS: "./path_to_directory_or_file"

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

script:
  - pipe: atlassian/git-secrets-scan:3.2.0
    variables:
      CREATE_REPORT: "false"

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

निर्देशिकाओं और फ़ाइलों को स्कैन करें, कस्टम gitleaks कॉन्फ़िग प्रदान करें और डीबग चालू करें:

script:
  - pipe: atlassian/git-secrets-scan:3.2.0
    variables:
      DEBUG: "true"
      GITLEAKS_COMMAND: "dir"
      GITLEAKS_EXTRA_ARGS: 
        - "./path_to_directory_or_file"
        - "--config=my-gitleaks-config.toml"

सहायता

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

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

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

लाइसेंस

Copyright (c) 2020 Atlassian और अन्य। Apache 2.0 लाइसेंस प्राप्त, देखें LICENSE.txt फ़ाइल।