См. [Установка](#installation) и [Примеры использования](#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)
  - [Принятие подозрительных `переменных окружения` / `файлов` / `расширений файлов`](#accept-suspicious-environment-variables--files--file-extensions)
  - [Отклонение подозрительных `переменных окружения` / `файлов` / `расширений файлов`](#reject-suspicious-environment-variables--files--file-extensions)
- [Непрерывная интеграция (CI)](#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 Benchmarks
  - Высокая точность
- DevSecOps
  - Подходит для CI, таких как Travis CI, CircleCI, Jenkins и т.д.
  - См. [Пример 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/>Среда выполнения контейнера | Образ |
| Способ запуска | Бинарный файл | Бинарный файл | Shell-скрипт | Бинарный файл |
| Зависимости | Нет | Нет | Некоторые зависимости | Нет |
| Подходит для CI | ✓ | ✓ | x | x | 
| Назначение | Аудит безопасности<br />Линтинг Dockerfile | Линтинг Dockerfile | Аудит безопасности<br />Линтинг Dockerfile | Сканирование уязвимостей |

# Установка

## Homebrew (Mac OS X / Linux и WSL)

Вы можете использовать Homebrew в [Mac OS X](https://brew.sh/) или [Linux и WSL (подсистема Windows для Linux)](https://docs.brew.sh/Homebrew-on-Linux).```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]

## Binary

Вы можете получить последнюю версию бинарного файла на [странице релизов](https://github.com/goodwithtech/dockle/releases/latest).

Загрузите архивный файл для вашей операционной системы/архитектуры. Распакуйте архив и поместите бинарный файл в каталог, находящийся в вашем `$PATH` (в UNIX-подобных системах это `/usr/local/bin` или аналогичный).

- ПРИМЕЧАНИЕ: Убедитесь, что у него включены биты выполнения. (`chmod +x dockle`)

## asdf

Вы можете установить dockle с помощью [менеджера версий asdf](https://asdf-vm.com/) с помощью этого [плагина](https://github.com/mathew-fleisch/asdf-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

You only need `-v /var/run/docker.sock:/var/run/docker.sock` when you'd like to scan the image on your host machine.

# Быстрый старт

## Основы

Просто укажите имя образа (и тег).```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>

</details>```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"
          }
        }
      ]
    }
  ]
}

### Specify exit level

By default, `--exit-code` run when there are `WARN` or `FATAL` level alerts.

Use the `--exit-level, -l` option to change alert level. You can set `info`, `warn` or `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)

Вы можете сканировать созданный образ с помощью `Dockle` в Travis CI/CircleCI.

В этих примерах тест завершится ошибкой, если будут найдены какие-либо предупреждения.

Однако вы можете игнорировать указанные целевые контрольные точки, используя файл `.dockleignore`.

Или, если вы просто хотите отобразить результаты и не допускать сбоя теста из-за этого, укажите `--exit-code` в `0` в команде `dockle`.

### 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'