detect-secrets — एंटरप्राइज़ के अनुकूल तरीके से कोड में गुप्त जानकारी का पता लगाना और उसे रोकना। | Kitploit

या, किसी भिन्न निर्देशिका से चलाने के लिए:```bash
$ detect-secrets -C /path/to/directory scan > /path/to/directory/.secrets.baseline

### बेसलाइन में नए रहस्य जोड़ना:

यह आपके कोडबेस को पुनः स्कैन करेगा, और:

1. नवीनतम संस्करण के साथ संगत होने के लिए आपकी बेसलाइन को अपडेट/अपग्रेड करेगा,
2. आपकी बेसलाइन में मिलने वाले किसी भी नए रहस्य को जोड़ेगा,
3. आपके कोडबेस से अब हटाए गए किसी भी रहस्य को हटाएगा

यह आपके द्वारा लेबल किए गए किसी भी रहस्य को भी संरक्षित करेगा।```bash
$ detect-secrets scan --baseline .secrets.baseline

**सभी ट्रैक की गई फ़ाइलों को स्कैन करना:**```bash
$ git ls-files -z | xargs -0 detect-secrets-hook --baseline .secrets.baseline

### आधार रेखा का ऑडिट करना:

यह आपकी आधार रेखा में परिणामों को लेबल करने का एक वैकल्पिक कदम है। इसका उपयोग माइग्रेट करने के लिए रहस्यों की अपनी चेकलिस्ट को संकीर्ण करने,
या अपने प्लगइन्स को बेहतर ढंग से कॉन्फ़िगर करने के लिए किया जा सकता है ताकि इसका सिग्नल-टू-शोर
अनुपात बेहतर हो सके।```bash
$ detect-secrets audit .secrets.baseline

**अधिक उन्नत कॉन्फ़िगरेशन:**```python
from detect_secrets import SecretsCollection
from detect_secrets.settings import transient_settings

secrets = SecretsCollection()
with transient_settings({
    # Only run scans with only these plugins.
    # This format is the same as the one that is saved in the generated baseline.
    'plugins_used': [
        # Example of configuring a built-in plugin
        {
            'name': 'Base64HighEntropyString',
            'limit': 5.0,
        },

        # Example of using a custom plugin
        {
            'name': 'HippoDetector',
            'path': 'file:///Users/aaronloo/Documents/github/detect-secrets/testing/plugins.py',
        },
    ],

    # We can also specify whichever additional filters we want.
    # This is an example of using the function `is_identified_by_ML_model` within the
    # local file `./private-filters/example.py`.
    'filters_used': [
        {
            'path': 'file://private-filters/example.py::is_identified_by_ML_model',
        },
    ]
}) as settings:
    # If we want to make any further adjustments to the created settings object (e.g.
    # disabling default filters), we can do so as such.
    settings.disable_filters(
        'detect_secrets.filters.heuristic.is_prefixed_with_dollar_sign',
        'detect_secrets.filters.heuristic.is_likely_id_string',
    )

    secrets.scan_file('test_data/config.ini')

### बेसलाइन में नहीं हैं गुप्त जानकारियों को ब्लॉक करना```
$ detect-secrets-hook --help
usage: detect-secrets-hook [-h] [-v] [--version] [--baseline FILENAME]
                           [--list-all-plugins] [-p PLUGIN]
                           [--base64-limit [BASE64_LIMIT]]
                           [--hex-limit [HEX_LIMIT]]
                           [--disable-plugin DISABLE_PLUGIN]
                           [-n | --only-verified]
                           [--exclude-lines EXCLUDE_LINES]
                           [--exclude-files EXCLUDE_FILES]
                           [--exclude-secrets EXCLUDE_SECRETS]
                           [--word-list WORD_LIST_FILE] [-f FILTER]
                           [--disable-filter DISABLE_FILTER]
                           [filenames [filenames ...]]

positional arguments:
  filenames             Filenames to check.

optional arguments:
  -h, --help            show this help message and exit
  -v, --verbose         Verbose mode.
  --version             Display version information.
  --json                Print detect-secrets-hook output as JSON
  --baseline FILENAME   Explicitly ignore secrets through a baseline generated
                        by `detect-secrets scan`

plugin options:
  Configure settings for each secret scanning ruleset. By default, all
  plugins are enabled unless explicitly disabled.

  --list-all-plugins    Lists all plugins that will be used for the scan.
  -p PLUGIN, --plugin PLUGIN
                        Specify path to custom secret detector plugin.
  --base64-limit [BASE64_LIMIT]
                        Sets the entropy limit for high entropy strings. Value
                        must be between 0.0 and 8.0, defaults to 4.5.
  --hex-limit [HEX_LIMIT]
                        Sets the entropy limit for high entropy strings. Value
                        must be between 0.0 and 8.0, defaults to 3.0.
  --disable-plugin DISABLE_PLUGIN
                        Plugin class names to disable. e.g.
                        Base64HighEntropyString

filter options:
  Configure settings for filtering out secrets after they are flagged by the
  engine.

  -n, --no-verify       Disables additional verification of secrets via
                        network call.
  --only-verified       Only flags secrets that can be verified.
  --exclude-lines EXCLUDE_LINES
                        If lines match this regex, it will be ignored.
  --exclude-files EXCLUDE_FILES
                        If filenames match this regex, it will be ignored.
  --exclude-secrets EXCLUDE_SECRETS
                        If secrets match this regex, it will be ignored.
  -f FILTER, --filter FILTER
                        Specify path to custom filter. May be a python module
                        path (e.g.
                        detect_secrets.filters.common.is_invalid_file) or a
                        local file path (e.g.
                        file://path/to/file.py::function_name).
  --disable-filter DISABLE_FILTER
                        Specify filter to disable. e.g.
                        detect_secrets.filters.common.is_invalid_file

#### इनलाइन अनुमति सूची

कभी-कभी हम किसी झूठे सकारात्मक (false positive) को कमिट को ब्लॉक करने से बाहर करना चाहते हैं, बिना कोई बेसलाइन बनाए। ऐसा आप इस प्रकार एक टिप्पणी जोड़कर कर सकते हैं:```python
secret = "hunter2"      # pragma: allowlist secret

### बेसलाइन में गुप्त जानकारी का ऑडिट```bash
$ detect-secrets audit --help
usage: detect-secrets audit [-h] [--diff] [--stats]
                      [--report] [--only-real | --only-false]
                      [--json]
                      filename [filename ...]

Auditing a baseline allows analysts to label results, and optimize plugins for
the highest signal-to-noise ratio for their environment.

positional arguments:
  filename      Audit a given baseline file to distinguish the difference
                between false and true positives.

optional arguments:
  -h, --help    show this help message and exit
  --diff        Allows the comparison of two baseline files, in order to
                effectively distinguish the difference between various plugin
                configurations.
  --stats       Displays the results of an interactive auditing session which
                have been saved to a baseline file.
  --report      Displays a report with the secrets detected

reporting:
  Display a summary with all the findings and the made decisions. To be used with the report mode (--report).

  --only-real   Only includes real secrets in the report
  --only-false  Only includes false positives in the report

analytics:
  Quantify the success of your plugins based on the labelled results in your
  baseline. To be used with the statistics mode (--stats).

  --json        Outputs results in a machine-readable format.

Regex-आधारित नियम

ये सबसे सामान्य प्रकार के प्लगइन हैं, और अच्छी तरह से संरचित रहस्यों के साथ अच्छा काम करते हैं। इन रहस्यों को वैकल्पिक रूप से सत्यापित किया जा सकता है, जो स्कैनिंग परिशुद्धता बढ़ाता है। हालाँकि, केवल इन पर निर्भर रहने से आपके स्कैन की प्रभाविता (recall) पर नकारात्मक प्रभाव पड़ सकता है।
एंट्रॉपी डिटेक्टर

यह विभिन्न अनुमानात्मक दृष्टिकोणों के माध्यम से "गुप्त-दिखने वाले" स्ट्रिंग्स की खोज करता है। यह गैर-संरचित रहस्यों के लिए बहुत अच्छा है, लेकिन स्कैनिंग परिशुद्धता को समायोजित करने के लिए ट्यूनिंग की आवश्यकता हो सकती है।
कीवर्ड डिटेक्टर

यह गुप्त मान को अनदेखा करता है, और उन चर नामों की खोज करता है जो अक्सर हार्ड-कोडेड मानों के साथ रहस्यों को निर्दिष्ट करने से जुड़े होते हैं। यह "गैर-गुप्त-दिखने वाले" स्ट्रिंग्स (जैसे le3tc0de पासवर्ड) के लिए बहुत अच्छा है, लेकिन स्कैनिंग परिशुद्धता को समायोजित करने के लिए फ़िल्टर ट्यूनिंग की आवश्यकता हो सकती है।

या आप इस प्रकार एकाधिक regex नियम निर्दिष्ट कर सकते हैं:```bash
$ detect-secrets scan --exclude-lines 'password = blah' --exclude-lines 'password = fake'

या आप एकाधिक regex पैटर्न इस प्रकार निर्दिष्ट कर सकते हैं:```bash
$ detect-secrets scan --exclude-files '.*\.signature$' --exclude-files '.*/i18n/.*'

या आप इस प्रकार कई regex नियम निर्दिष्ट कर सकते हैं:```bash
$ detect-secrets scan --exclude-secrets 'fakesecret' --exclude-secrets '\${.*})'

ये टिप्पणियाँ कई भाषाओं में समर्थित हैं। जैसे.```java
const GoogleCredentialPassword = "something-secret-here";     //  pragma: allowlist secret

यह आपके लिए रहस्यों को अनदेखा करने का एक सुविधाजनक तरीका हो सकता है, बिना पूरी बेसलाइन को फिर से उत्पन्न करने की आवश्यकता के। यदि आपको इन अनुमत सूचीबद्ध रहस्यों को स्पष्ट रूप से खोजने की आवश्यकता है, तो आप ऐसा भी कर सकते हैं:```bash
$ detect-secrets scan --only-allowlisted

फिर, आप इसका उपयोग इस प्रकार कर सकते हैं:```bash
$ cat wordlist.txt
not-a-real-secret
$ cat sample.ini
password = not-a-real-secret

# Will show results
$ detect-secrets scan sample.ini

# No results found
$ detect-secrets scan --word-list wordlist.txt

मॉडल को प्रशिक्षित करने के तरीके के बारे में अधिक जानकारी के लिए [gibberish-detector](https://github.com/domanchi/gibberish-detector) पैकेज देखें। एक पूर्व-प्रशिक्षित मॉडल (RFCs को संसाधित करके सीड किया गया) आसान उपयोग के लिए शामिल किया जाएगा।

आप अपना स्वयं का मॉडल भी इस प्रकार निर्दिष्ट कर सकते हैं:```bash
$ detect-secrets scan --gibberish-model custom.model

detect-secrets

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

उदाहरण

त्वरित आरंभ:

नव जोड़े गए रहस्यों पर अलर्ट बंद करना:

सभी सक्षम प्लगइन्स देखना:```bash

अन्य पायथन स्क्रिप्ट्स में उपयोग

स्थापना```bash

उपयोग

बेसलाइन में रहस्य जोड़ना```

.pre-commit-config.yaml

कॉन्फ़िगरेशन

प्लगइन्स

फ़िल्टर

--exclude-lines

--exclude-files

--exclude-secrets

इनलाइन अनुमति सूची

pragma: allowlist nextline secret

एक्सटेंशन्स

वर्डलिस्ट

गिबरिश डिटेक्टर

सावधानियाँ

सामान्य प्रश्न

सामान्य

विंडोज

detect-secrets

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

detect-secrets

परिचय

उदाहरण

त्वरित आरंभ:

नव जोड़े गए रहस्यों पर अलर्ट बंद करना:

सभी सक्षम प्लगइन्स देखना:```bash

अन्य पायथन स्क्रिप्ट्स में उपयोग

स्थापना```bash

उपयोग

बेसलाइन में रहस्य जोड़ना```

.pre-commit-config.yaml

कॉन्फ़िगरेशन

प्लगइन्स

फ़िल्टर

--exclude-lines

--exclude-files

--exclude-secrets

इनलाइन अनुमति सूची

pragma: allowlist nextline secret

एक्सटेंशन्स

वर्डलिस्ट

गिबरिश डिटेक्टर

सावधानियाँ

सामान्य प्रश्न

सामान्य

विंडोज