Veja [Instalação](#installation) e [Exemplos Comuns](#common-examples)

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

# Comparação de Checkpoints

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

# Índice

- [Características](#features)
- [Comparação](#comparison)
- [Instalação](#installation)
  - [Homebrew (Mac OS X / Linux e 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)
  - [Binário](#binary)
  - [asdf](#asdf)
  - [mise](#mise)
  - [A partir do código fonte](#from-source)
  - [Usar Docker](#use-docker)
- [Início Rápido](#quick-start)
  - [Básico](#basic)
  - [Docker](#docker)
- [Resumo de Checkpoints](#checkpoint-summary)
- [Exemplos Comuns](#common-examples)
  - [Escaneie uma imagem](#scan-an-image)
  - [Escaneie um arquivo de imagem](#scan-an-image-file)
  - [Obter ou salvar os resultados como JSON](#get-or-save-the-results-as-json)
  - [Obter ou salvar os resultados como SARIF](#get-or-save-the-results-as-sarif)
  - [Especificar código de saída](#specify-exit-code)
  - [Especificar nível de saída](#specify-exit-level)
  - [Ignorar os checkpoints especificados](#ignore-the-specified-checkpoints)
  - [Aceitar `variáveis de ambiente` / `arquivos` / `extensões de arquivo` suspeitas](#accept-suspicious-environment-variables--files--file-extensions)
  - [Rejeitar `variáveis de ambiente` / `arquivos` / `extensões de arquivo` suspeitas](#reject-suspicious-environment-variables--files--file-extensions)
- [Integração Contínua](#continuous-integration-ci)
  - [GitHub Action](#github-action)
  - [Travis CI](#travis-ci)
  - [CircleCI](#circleci)
  - [GitLab CI](#gitlab-ci)
  - [Autorização para Registro Privado 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)
    - [Registro Autogerenciado (BasicAuth)](#self-hosted-registry-basicauth)
- [Contribuidores](#contributors)
  - [Contribuidores de Código](#code-contributors)
  - [Contribuidores Financeiros](#financial-contributors)
    - [Indivíduos](#individuals)
    - [Organizações](#organizations)
- [Licença](#license)
- [Autor](#author)

# Características

- Detecta vulnerabilidades do contêiner
- Ajuda na construção de Dockerfiles de melhores práticas
- Uso simples
  - Especifique apenas o nome da imagem
  - Veja [Início Rápido](#quick-start) e [Exemplos Comuns](#common-examples)
- Suporte a CIS Benchmarks
  - Alta precisão
- DevSecOps
  - Adequado para CI como Travis CI, CircleCI, Jenkins, etc.
  - Veja [Exemplo de CI](#continuous-integration-ci)

# Comparação

|  | [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) |
|--- |---:|---:|---:|---:|
| Alvo |  Imagem | Dockerfile | Anfitrião<br/>Docker Daemon<br/>Imagem<br/>Runtime do Contêiner | Imagem |
| Como executar | Binário | Binário | ShellScript | Binário |
| Dependência | Não | Não | Algumas dependências | Não |
| Adequado para CI | ✓ | ✓ | x | x | 
| Propósito | Auditoria de Segurança<br/>Lint de Dockerfile | Lint de Dockerfile | Auditoria de Segurança<br/>Lint de Dockerfile | Escanear Vulnerabilidades |

# Instalação

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

Você pode usar Homebrew no [Mac OS X](https://brew.sh/) ou [Linux e WSL (Subsistema Windows para 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]

## Binário

Você pode obter o binário da versão mais recente na [página de releases](https://github.com/goodwithtech/dockle/releases/latest).

Baixe o arquivo compactado para seu sistema operacional/arquitetura. Descompacte o arquivo e coloque o binário em algum lugar no seu `$PATH` (em sistemas UNIX, `/usr/local/bin` ou similar).

- NOTA: Certifique-se de que as permissões de execução estão ativadas. (`chmod +x dockle`)

## asdf

Você pode instalar o dockle com o [asdf version manager](https://asdf-vm.com/) usando este [plugin](https://github.com/mathew-fleisch/asdf-dockle), que automatiza o processo de instalação (e alternância) de várias versões dos binários de release do GitHub. Com o asdf já instalado, execute estes comandos para instalar o 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

## A partir do código-fonte```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

Você só precisa de `-v /var/run/docker.sock:/var/run/docker.sock` quando quiser escanear a imagem em sua máquina host.

# Início Rápido

## Básico

Simplesmente especifique um nome de imagem (e uma tag).```bash
$ dockle [YOUR_IMAGE_NAME]

### Obter ou Salvar os resultados como JSON```bash
$ dockle -f json goodwithtech/test-image:v1
$ dockle -f json -o results.json goodwithtech/test-image:v1

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

### Especificar nível de saída

Por padrão, `--exit-code` é executado quando há alertas de nível `WARN` ou `FATAL`.

Use a opção `--exit-level, -l` para alterar o nível de alerta. Você pode definir `info`, `warn` ou `fatal`.```bash
$ dockle --exit-code 1 --exit-level info [IMAGE_NAME]
$ dockle --exit-code 1 --exit-level fatal [IMAGE_NAME]

Ou, use `DOCKLE_IGNORES`:```
export DOCKLE_IGNORES=CIS-DI-0001,DKL-DI-0006
dockle [IMAGE_NAME]

### Aceitar suspeitos `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]

## Integração Contínua (CI)

Você pode escanear sua imagem construída com `Dockle` no Travis CI/CircleCI.

Nestes exemplos, o teste falhará se algum aviso for encontrado.

No entanto, você pode ignorar os checkpoints alvo especificados usando o arquivo `.dockleignore`.

Ou, se você apenas deseja que os resultados sejam exibidos e não deixar o teste falhar por isso, especifique `--exit-code` como `0` no comando `dockle`.

### GitHub Action

Fornecemos o [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'