dockle

Dockle — Линтер контейнерных образов для безопасности, помогающий создавать Docker-образы в соответствии с лучшими практиками. Прост в использовании

Dockle помогает вам:

1. Создавать Docker-образы в соответствии с лучшими практиками
2. Создавать безопасные Docker-образы
   • Контрольные точки включают CIS Benchmarks```bash $ brew untap goodwithtech/dockle # who use 0.1.16 or older version $ brew install goodwithtech/r/dockle $ dockle [YOUR_IMAGE_NAME]

См. [Установка](#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

RHEL/CentOS```bash

VERSION=$( curl --silent "https://api.github.com/repos/goodwithtech/dockle/releases/latest" |
grep '"tag_name":' |
sed -E 's/."v([^"]+)"./\1/'
) && rpm -ivh https://github.com/goodwithtech/dockle/releases/download/v${VERSION}/dockle_${VERSION}_Linux-64bit.rpm

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

Arch Linux

dockle может быть установлен из Arch User Repository с помощью пакета dockle или dockle-bin.``` git clone https://aur.archlinux.org/dockle-bin.git cd dockle-bin makepkg -sri

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

Microsoft PowerShell 7```bash

if (((Invoke-WebRequest "https://api.github.com/repos/goodwithtech/dockle/releases/latest").Content) -match '"tag_name":"v(?[^"]+)"') { $VERSION=$Matches.ver && Invoke-WebRequest "https://github.com/goodwithtech/dockle/releases/download/v${VERSION}/dockle_${VERSION}_Windows-64bit.zip" -OutFile dockle.zip && Expand-Archive dockle.zip && Remove-Item dockle.zip }

## Binary

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

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

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

## asdf