See [Installation](#installation) और [Common Examples](#common-examples)

<img src="https://assets.kitploit.com/production/public/readmes/4137/343598bd4d53296c6d6d23acde8c2917d5727f03e7b3a34c1ff0865c435bb974.png" width="800">

# चेकपॉइंट तुलना

<img src="https://assets.kitploit.com/production/public/readmes/4137/4f4835c3a5fd70f436d9d8ea656fd8a521112fece4e35977288064d3f6f4510a.png" width="800">
<img src="https://assets.kitploit.com/production/public/readmes/4137/7bee9da0b061957af6a175a3b975dca82813c27f72ab6921dfe8ab2d6747322b.png" width="800">

# विषयसूची

- [विशेषताएँ](#features)
- [तुलना](#comparison)
- [स्थापना](#installation)
  - [Homebrew (Mac OS X / Linux और WSL)](#homebrew-mac-os-x--linux-and-wsl)
  - [RHEL/CentOS](#rhelcentos)
  - [Debian/Ubuntu](#debianubuntu)
  - [Arch Linux](#arch-linux)
  - [Windows](#windows)
  - [Microsoft PowerShell 7](#microsoft-powershell-7)
  - [बाइनरी](#binary)
  - [asdf](#asdf)
  - [mise](#mise)
  - [स्रोत से](#from-source)
  - [Docker का उपयोग करें](#use-docker)
- [त्वरित प्रारंभ](#quick-start)
  - [मूल](#basic)
  - [Docker](#docker)
- [चेकपॉइंट सारांश](#checkpoint-summary)
- [सामान्य उदाहरण](#common-examples)
  - [इमेज स्कैन करें](#scan-an-image)
  - [इमेज फ़ाइल स्कैन करें](#scan-an-image-file)
  - [JSON के रूप में परिणाम प्राप्त या सहेजें](#get-or-save-the-results-as-json)
  - [SARIF के रूप में परिणाम प्राप्त या सहेजें](#get-or-save-the-results-as-sarif)
  - [एग्ज़िट कोड निर्दिष्ट करें](#specify-exit-code)
  - [एग्ज़िट स्तर निर्दिष्ट करें](#specify-exit-level)
  - [निर्दिष्ट चेकपॉइंट को अनदेखा करें](#ignore-the-specified-checkpoints)
  - [संदिग्ध `environment variables` / `files` / `file extensions` स्वीकार करें](#accept-suspicious-environment-variables--files--file-extensions)
  - [संदिग्ध `environment variables` / `files` / `file extensions` अस्वीकार करें](#reject-suspicious-environment-variables--files--file-extensions)
- [सतत एकीकरण](#continuous-integration-ci)
  - [GitHub Action](#github-action)
  - [Travis CI](#travis-ci)
  - [CircleCI](#circleci)
  - [GitLab CI](#gitlab-ci)
  - [निजी Docker रजिस्ट्री के लिए प्राधिकरण](#authorization-for-private-docker-registry)
    - [Docker Hub](#docker-hub)
    - [Amazon ECR (Elastic Container Registry)](#amazon-ecr-elastic-container-registry)
    - [GCR (Google Container Registry)](#gcr-google-container-registry)
    - [स्व-होस्टेड रजिस्ट्री (BasicAuth)](#self-hosted-registry-basicauth)
- [योगदानकर्ता](#contributors)
  - [कोड योगदानकर्ता](#code-contributors)
  - [वित्तीय योगदानकर्ता](#financial-contributors)
    - [व्यक्ति](#individuals)
    - [संगठन](#organizations)
- [लाइसेंस](#license)
- [लेखक](#author)

# विशेषताएँ

- कंटेनर की कमजोरियों का पता लगाएं
- सर्वोत्तम अभ्यास Dockerfile बनाने में मदद
- सरल उपयोग
  - केवल इमेज का नाम निर्दिष्ट करें
  - [त्वरित प्रारंभ](#quick-start) और [सामान्य उदाहरण](#common-examples) देखें
- CIS बेंचमार्क समर्थन
  - उच्च सटीकता
- DevSecOps
  - Travis CI, CircleCI, Jenkins आदि जैसे CI के लिए उपयुक्त
  - [CI उदाहरण](#continuous-integration-ci) देखें

# तुलना

| | [Dockle](https://github.com/goodwithtech/dockle) | [Hadolint](https://github.com/hadolint/hadolint) | [Docker Bench for Security](https://github.com/docker/docker-bench-security) | [Clair](https://github.com/coreos/clair) |
|--- |---:|---:|---:|---:|
| लक्ष्य |  इमेज | Dockerfile | होस्ट<br/>Docker डेमन<br/>इमेज<br/>कंटेनर रनटाइम | इमेज |
| चलाने का तरीका |  बाइनरी | बाइनरी | ShellScript | बाइनरी |
| निर्भरता |  नहीं | नहीं | कुछ निर्भरताएँ | नहीं |
| CI के लिए उपयुक्त | ✓ | ✓ | x | x | 
| उद्देश्य |सुरक्षा ऑडिट<br/>Dockerfile Lint| Dockerfile Lint | सुरक्षा ऑडिट<br/>Dockerfile Lint | कमजोरियों को स्कैन करें |

# स्थापना

## Homebrew (Mac OS X / Linux और WSL)

आप [Mac OS X](https://brew.sh/) या [Linux और WSL (Windows Subsystem for Linux)](https://docs.brew.sh/Homebrew-on-Linux) पर Homebrew का उपयोग कर सकते हैं।```bash
$ brew install goodwithtech/r/dockle

## Debian/Ubuntu```bash
VERSION=$(
 curl --silent "https://api.github.com/repos/goodwithtech/dockle/releases/latest" | \
 grep '"tag_name":' | \
 sed -E 's/.*"v([^"]+)".*/\1/' \
) && curl -L -o dockle.deb https://github.com/goodwithtech/dockle/releases/download/v${VERSION}/dockle_${VERSION}_Linux-64bit.deb
$ sudo dpkg -i dockle.deb && rm dockle.deb

## Windows```bash
VERSION=$(
 curl --silent "https://api.github.com/repos/goodwithtech/dockle/releases/latest" | \
 grep '"tag_name":' | \
 sed -E 's/.*"v([^"]+)".*/\1/' \
) && curl -L -o dockle.zip https://github.com/goodwithtech/dockle/releases/download/v${VERSION}/dockle_${VERSION}_Windows-64bit.zip
$ unzip dockle.zip && rm dockle.zip
$ ./dockle.exe [IMAGE_NAME]

## बाइनरी

आप नवीनतम संस्करण बाइनरी [रिलीज़ पेज](https://github.com/goodwithtech/dockle/releases/latest) से प्राप्त कर सकते हैं।

अपने ऑपरेटिंग सिस्टम/आर्किटेक्चर के लिए आर्काइव फ़ाइल डाउनलोड करें। आर्काइव को अनपैक करें, और बाइनरी को अपने `$PATH` में कहीं रखें (UNIX-जैसी प्रणालियों पर, `/usr/local/bin` या इसी तरह)।

- नोट: सुनिश्चित करें कि इसके निष्पादन बिट चालू हैं। (`chmod +x dockle`)

## asdf

आप [asdf संस्करण प्रबंधक](https://asdf-vm.com/) के साथ [इस प्लगइन](https://github.com/mathew-fleisch/asdf-dockle) का उपयोग करके dockle स्थापित कर सकते हैं, जो github रिलीज़ बाइनरी के विभिन्न संस्करणों को स्थापित करने (और उनके बीच स्विच करने) की प्रक्रिया को स्वचालित करता है।

asdf पहले से स्थापित होने पर, dockle स्थापित करने के लिए ये कमांड चलाएँ:```bash
# Add dockle plugin
asdf plugin add dockle

# Show all installable versions
asdf list-all dockle

# Install specific version
asdf install dockle latest

# Set a version globally (on your ~/.tool-versions file)
asdf global dockle latest

# Now dockle commands are available
dockle --version

## स्रोत से```bash
$ GO111MODULE=off go get github.com/goodwithtech/dockle/cmd/dockle
$ cd $GOPATH/src/github.com/goodwithtech/dockle && GO111MODULE=on go build -o $GOPATH/bin/dockle cmd/dockle/main.go

आपको केवल `-v /var/run/docker.sock:/var/run/docker.sock` की आवश्यकता है जब आप अपने होस्ट मशीन पर इमेज को स्कैन करना चाहते हैं।

# त्वरित आरंभ

## बुनियादी

बस एक इमेज नाम (और एक टैग) निर्दिष्ट करें।```bash
$ dockle [YOUR_IMAGE_NAME]

### परिणामों को JSON के रूप में प्राप्त करें या सहेजें```bash
$ dockle -f json goodwithtech/test-image:v1
$ dockle -f json -o results.json goodwithtech/test-image:v1

<details>
<summary>परिणाम</summary>```json
{
  "version": "2.1.0",
  "$schema": "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json",
  "runs": [
    {
      "tool": {
        "driver": {
          "name": "Dockle",
          "informationUri": "https://github.com/goodwithtech/dockle",
          "rules": [
            {
              "id": "CIS-DI-0009",
              "shortDescription": {
                "text": "Use COPY instead of ADD in Dockerfile"
              },
              "help": {
                "text": "https://github.com/goodwithtech/dockle/blob/master/CHECKPOINT.md#CIS-DI-0009"
              }
            },
            {
              "id": "CIS-DI-0010",
              "shortDescription": {
                "text": "Do not store credential in ENVIRONMENT vars/files"
              },
              "help": {
                "text": "https://github.com/goodwithtech/dockle/blob/master/CHECKPOINT.md#CIS-DI-0010"
              }
            },
            {
              "id": "DKL-DI-0005",
              "shortDescription": {
                "text": "Clear apt-get caches"
              },
              "help": {
                "text": "https://github.com/goodwithtech/dockle/blob/master/CHECKPOINT.md#DKL-DI-0005"
              }
            },
            {
              "id": "DKL-LI-0001",
              "shortDescription": {
                "text": "Avoid empty password"
              },
              "help": {
                "text": "https://github.com/goodwithtech/dockle/blob/master/CHECKPOINT.md#DKL-LI-0001"
              }
            },
            {
              "id": "CIS-DI-0005",
              "shortDescription": {
                "text": "Enable Content trust for Docker"
              },
              "help": {
                "text": "https://github.com/goodwithtech/dockle/blob/master/CHECKPOINT.md#CIS-DI-0005"
              }
            },
            {
              "id": "CIS-DI-0008",
              "shortDescription": {
                "text": "Confirm safety of setuid/setgid files"
              },
              "help": {
                "text": "https://github.com/goodwithtech/dockle/blob/master/CHECKPOINT.md#CIS-DI-0008"
              }
            },
            {
              "id": "CIS-DI-0001",
              "shortDescription": {
                "text": "Create a user for the container"
              },
              "help": {
                "text": "https://github.com/goodwithtech/dockle/blob/master/CHECKPOINT.md#CIS-DI-0001"
              }
            },
            {
              "id": "CIS-DI-0006",
              "shortDescription": {
                "text": "Add HEALTHCHECK instruction to the container image"
              },
              "help": {
                "text": "https://github.com/goodwithtech/dockle/blob/master/CHECKPOINT.md#CIS-DI-0006"
              }
            }
          ]
        }
      },
      "results": [
        {
          "ruleId": "CIS-DI-0009",
          "level": "error",
          "message": {
            "text": "Use COPY : /bin/sh -c #(nop) ADD file:81c0a803075715d1a6b4f75a29f8a01b21cc170cfc1bff6702317d1be2fe71a3 in /app/credentials.json "
          }
        },
        {
          "ruleId": "CIS-DI-0010",
          "level": "error",
          "message": {
            "text": "Suspicious filename found : app/credentials.json , Suspicious ENV key found : MYSQL_PASSWD"
          }
        },
        {
          "ruleId": "DKL-DI-0005",
          "level": "error",
          "message": {
            "text": "Use 'rm -rf /var/lib/apt/lists' after 'apt-get install' : /bin/sh -c apt-get update \u0026\u0026 apt-get install -y git"
          }
        },
        {
          "ruleId": "DKL-LI-0001",
          "level": "error",
          "message": {
            "text": "No password user found! username : nopasswd"
          }
        },
        {
          "ruleId": "CIS-DI-0005",
          "level": "note",
          "message": {
            "text": "export DOCKER_CONTENT_TRUST=1 before docker pull/build"
          }
        },
        {
          "ruleId": "CIS-DI-0008",
          "level": "note",
          "message": {
            "text": "setuid file: urwxr-xr-x usr/bin/newgrp, setgid file: grwxr-xr-x usr/bin/ssh-agent, setgid file: grwxr-xr-x usr/bin/expiry, setuid file: urwxr-xr-x usr/lib/openssh/ssh-keysign, setuid file: urwxr-xr-x bin/umount, setgid file: grwxr-xr-x usr/bin/chage, setuid file: urwxr-xr-x usr/bin/passwd, setgid file: grwxr-xr-x sbin/unix_chkpwd, setuid file: urwxr-xr-x usr/bin/chsh, setgid file: grwxr-xr-x usr/bin/wall, setuid file: urwxr-xr-x bin/ping, setuid file: urwxr-xr-x bin/su, setuid file: urwxr-xr-x usr/bin/chfn, setuid file: urwxr-xr-x usr/bin/gpasswd, setuid file: urwxr-xr-x bin/mount"
          }
        },
        {
          "ruleId": "CIS-DI-0001",
          "level": "none",
          "message": {
            "text": "Last user should not be root"
          }
        },
        {
          "ruleId": "CIS-DI-0006",
          "level": "none",
          "message": {
            "text": "not found HEALTHCHECK statement"
          }
        }
      ]
    }
  ]
}

### निकास स्तर निर्दिष्ट करें

डिफ़ॉल्ट रूप से, `--exit-code` तब चलता है जब `WARN` या `FATAL` स्तर की चेतावनियाँ होती हैं।

चेतावनी स्तर बदलने के लिए `--exit-level, -l` विकल्प का उपयोग करें। आप `info`, `warn` या `fatal` सेट कर सकते हैं।```bash
$ dockle --exit-code 1 --exit-level info [IMAGE_NAME]
$ dockle --exit-code 1 --exit-level fatal [IMAGE_NAME]

या, `DOCKLE_IGNORES` का उपयोग करें:```
export DOCKLE_IGNORES=CIS-DI-0001,DKL-DI-0006
dockle [IMAGE_NAME]

### संदिग्ध `environment variables` / `files` / `file extensions` स्वीकार करें```bash
# --accept-key value, --ak value             You can add acceptable keywords.
dockle -ak GPG_KEY -ak KEYCLOAK_VERSION [IMAGE_NAME]
or DOCKLE_ACCEPT_KEYS=GPG_KEY,KEYCLOAK_VERSION dockle [IMAGE_NAME]

# --accept-file value, --af value            You can add acceptable file names.
dockle -af id_rsa -af id_dsa [IMAGE_NAME]
or DOCKLE_ACCEPT_FILES=id_rsa,id_dsa dockle [IMAGE_NAME]

# --accept-file-extension value, --ae value  You can add acceptable file extensions.
dockle -ae pem -ae log [IMAGE_NAME]
or DOCKLE_ACCEPT_FILE_EXTENSIONS=pem,log dockle [IMAGE_NAME]

## सतत एकीकरण (CI)

आप Travis CI/CircleCI में `Dockle` के साथ अपनी निर्मित छवि को स्कैन कर सकते हैं।

इन उदाहरणों में, यदि कोई चेतावनी पाई जाती है तो परीक्षण विफल हो जाएगा।

हालांकि, आप `.dockleignore` फ़ाइल का उपयोग करके निर्दिष्ट लक्ष्य चेकपॉइंट्स को अनदेखा कर सकते हैं।

या, यदि आप केवल परिणाम प्रदर्शित करना चाहते हैं और इसके लिए परीक्षण को विफल नहीं होने देना चाहते, तो `dockle` कमांड में `--exit-code` को `0` पर निर्दिष्ट करें।

### GitHub Action

हम [goodwithtech/dockle-action](https://github.com/goodwithtech/dockle-action) प्रदान करते हैं।```yaml
- uses: goodwithtech/dockle-action@main
  with:
    image: 'target'
    format: 'list'
    exit-code: '1'
    exit-level: 'warn'
    ignore: 'CIS-DI-0001,DKL-DI-0006'