GitLeaks GitLab CI घटक

GitLab CI घटक Gitleaks के लिए - एक SAST उपकरण जो गिट रिपॉजिटरी में हार्डकोडेड रहस्यों जैसे पासवर्ड, API कुंजी और टोकन का पता लगाने और रोकने के लिए है।

विशेषताएं

गुप्त पहचान: हार्डकोडेड रहस्यों और संवेदनशील जानकारी के लिए रिपॉजिटरी स्कैन करता है
व्यापक नियम: विभिन्न प्रकार के रहस्यों का पता लगाने के लिए अंतर्निहित नियमों का विस्तृत सेट
कस्टम कॉन्फ़िगरेशन: स्थानीय और रिमोट कॉन्फ़िगरेशन फ़ाइलों के लिए समर्थन
एकाधिक आउटपुट प्रारूप: JSON, SARIF और अन्य रिपोर्ट प्रारूपों के लिए समर्थन
लचीले तर्क: Gitleaks को सीधे अतिरिक्त फ़्लैग पास करें
रिमोट कॉन्फ़िगरेशन: रिमोट URL से कॉन्फ़िगरेशन फ़ाइलें डाउनलोड और उपयोग करें
कॉन्फ़िगरेबल जॉब सेटिंग्स: जॉब नाम, स्टेज और कंटेनर इमेज को अनुकूलित करें

उपयोग

मूल उपयोग

include:
  - component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest

stages:
  - test

कस्टम कॉन्फ़िगरेशन के साथ

include:
  - component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
    inputs:
      GITLEAKS_CONFIG: ".gitleaks.toml"
      GITLEAKS_EXTRA_ARGS: "--verbose --report-format sarif"

stages:
  - test

रिमोट कॉन्फ़िगरेशन के साथ

include:
  - component: $CI_SERVER_FQDN/niclas-zone/ci/gitleaks/main@latest
    inputs:
      GITLEAKS_REMOTE_CONFIG: "https://gitlab.com/niclas-zone/ci/gitleaks/-/raw/main/configs/gitleaks.toml"

stages:
  - test

इनपुट

कॉन्फ़िगरेशन फ़ाइलें

स्थानीय कॉन्फ़िगरेशन

अपनी रिपॉजिटरी रूट में .gitleaks.toml फ़ाइल रखें या GITLEAKS_CONFIG का उपयोग करके पथ निर्दिष्ट करें।

रिमोट कॉन्फ़िगरेशन

URL से कॉन्फ़िगरेशन फ़ाइल डाउनलोड करने के लिए GITLEAKS_REMOTE_CONFIG सेट करें। यह कई परियोजनाओं में कॉन्फ़िगरेशन साझा करने के लिए उपयोगी है।

डिफ़ॉल्ट कॉन्फ़िगरेशन

यदि कोई स्थानीय या रिमोट कॉन्फ़िगरेशन निर्दिष्ट नहीं है, तो घटक Gitleaks के अंतर्निहित डिफ़ॉल्ट नियमों का उपयोग करेगा।

आर्टिफैक्ट्स

घटक निम्नलिखित आर्टिफैक्ट उत्पन्न करता है:

gitleaks-report.json: JSON प्रारूप में स्कैन परिणाम (या --report-format तर्क पर आधारित अन्य प्रारूप)

दस्तावेज़ीकरण

Gitleaks कॉन्फ़िगरेशन और विकल्पों के बारे में अधिक जानकारी के लिए, देखें:

`job_name`	CI जॉब का नाम	`"गुप्त स्कैनिंग"`
`stage`	पाइपलाइन चरण	`"परीक्षण"`
`image`	Gitleaks के लिए Docker इमेज	`"registry.gitlab.com/niclas-zone/ctr/gitleaks:8.28.0"`
`GITLEAKS_EXTRA_ARGS`	Gitleaks के लिए अतिरिक्त तर्क	`"--verbose --redact --report-format json"`
`GITLEAKS_CONFIG`	स्थानीय Gitleaks कॉन्फ़िग फ़ाइल का पथ	`""`
`GITLEAKS_REMOTE_CONFIG`	Gitleaks कॉन्फ़िग फ़ाइल डाउनलोड करने का URL	`""`

GitLeaks

सबसे लोकप्रिय