참조: [설치](#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 and 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)
- [지속적 통합](#continuous-integration-ci)
  - [GitHub Action](#github-action)
  - [Travis CI](#travis-ci)
  - [CircleCI](#circleci)
  - [GitLab CI](#gitlab-ci)
  - [Private Docker Registry 인증](#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)
    - [Self Hosted 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 적합 | ✓ | ✓ | x | x | 
| 목적 |보안 감사<br/>Dockerfile 린트| Dockerfile 린트 | 보안 감사<br/>Dockerfile 린트 | 취약점 스캔 |

# 설치

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

Homebrew를 [Mac OS X](https://brew.sh/) 또는 [Linux and WSL (Windows Subsystem for 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

## 윈도우```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

asdf 버전 관리자와 [이 플러그인](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'