「[インストール](#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 ベンチマーク対応
  - 高精度
- 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/>コンテナランタイム | イメージ |
| 実行方法 | バイナリ | バイナリ | シェルスクリプト | バイナリ |
| 依存関係 | なし | なし | 一部依存あり | なし |
| CI での利用 | ✓ | ✓ | × | × | 
| 目的 | セキュリティ監査<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

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

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

## Continuous Integration (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'