The Docker Bench for Security is a script that checks for dozens of common best-practices around deploying Docker containers in production.
Find a file
Thomas Sjögren 937ec4958a
Merge pull request #419 from zawazawa0316/fix_5
Fix check conditions
2020-03-09 14:54:32 +00:00
distros alpine:3.11 2019-12-21 21:31:33 +01:00
tests Merge pull request #419 from zawazawa0316/fix_5 2020-03-09 14:54:32 +00:00
.dockerignore perf(update .dockerignore file): 2017-12-14 19:41:02 +01:00
.gitignore ignore all logs 2017-10-10 14:20:38 +02:00
benchmark_log.png remove macosx shadow... 2019-11-05 11:34:51 +01:00
CONTRIBUTING.md update README and contributors 2019-08-28 12:30:34 +02:00
CONTRIBUTORS.md update benchmark_log.png and contributors 2019-11-05 10:46:15 +01:00
docker-bench-security.sh Merge pull request #407 from Intermax-Cloudsourcing/allow-include-checks-mixing 2020-01-29 12:07:32 +00:00
docker-compose.yml Mount volumes read only 2019-08-29 15:11:26 +02:00
Dockerfile alpine:3.11 2019-12-21 21:31:33 +01:00
functions_lib.sh tmp fix for json 2019-08-28 12:36:49 +02:00
helper_lib.sh locate configuration file before we run the tests #410 2019-12-17 15:03:54 +01:00
LICENSE.md Fix unpopulated copyright in license 2015-05-29 11:12:47 -07:00
MAINTAINERS add CONTRIBUTORS.md and update email 2019-05-05 22:27:05 +02:00
output_lib.sh shellcheck 2019-10-16 09:49:18 +02:00
README.md feat: all mixes of include and excludes are now supported 2019-12-09 15:19:17 +01:00

Docker Bench for Security

Docker Bench for Security running

The Docker Bench for Security is a script that checks for dozens of common best-practices around deploying Docker containers in production. The tests are all automated, and are inspired by the CIS Docker Benchmark v1.2.0.

We are making this available as an open-source utility so the Docker community can have an easy way to self-assess their hosts and docker containers against this benchmark.

Running Docker Bench for Security

We packaged docker bench as a small container for your convenience. Note that this container is being run with a lot of privilege -- sharing the host's filesystem, pid and network namespaces, due to portions of the benchmark applying to the running host. Don't forget to adjust the shared volumes according to your operating system, for example it might not use systemd.

The easiest way to run your hosts against the Docker Bench for Security is by running our pre-built container:

docker run -it --net host --pid host --userns host --cap-add audit_control \
    -e DOCKER_CONTENT_TRUST=$DOCKER_CONTENT_TRUST \
    -v /etc:/etc:ro \
    -v /usr/bin/docker-containerd:/usr/bin/docker-containerd:ro \
    -v /usr/bin/docker-runc:/usr/bin/docker-runc:ro \
    -v /usr/lib/systemd:/usr/lib/systemd:ro \
    -v /var/lib:/var/lib:ro \
    -v /var/run/docker.sock:/var/run/docker.sock:ro \
    --label docker_bench_security \
    docker/docker-bench-security

Docker bench requires Docker 1.13.0 or later in order to run.

Note that when distributions doesn't contain auditctl, the audit tests will check /etc/audit/audit.rules to see if a rule is present instead.

Distribution specific Dockerfiles that fixes this issue are available in the distros directory.

The distribution specific Dockerfiles may also help if the distribution you're using haven't yet shipped Docker version 1.13.0 or later.

Docker Bench for Security options

  -b           optional  Do not print colors
  -h           optional  Print this help message
  -l FILE      optional  Log output in FILE
  -c CHECK     optional  Comma delimited list of specific check(s)
  -e CHECK     optional  Comma delimited list of specific check(s) to exclude
  -i INCLUDE   optional  Comma delimited list of patterns within a container or image name to check
  -x EXCLUDE   optional  Comma delimited list of patterns within a container or image name to exclude from check

By default the Docker Bench for Security script will run all available CIS tests and produce logs in the current directory named docker-bench-security.sh.log.json and docker-bench-security.sh.log. The CIS based checks are named check_<section>_<number>, e.g. check_2_6 and community contributed checks are named check_c_<number>. A complete list of checks are present in functions_lib.sh.

sh docker-bench-security.sh -l /tmp/docker-bench-security.sh.log -c check_2_2 will only run check 2.2 Ensure the logging level is set to 'info'.

sh docker-bench-security.sh -l /tmp/docker-bench-security.sh.log -e check_2_2 will run all available checks except 2.2 Ensure the logging level is set to 'info'.

sh docker-bench-security.sh -l /tmp/docker-bench-security.sh.log -e docker_enterprise_configuration will run all available checks except the docker_enterprise_configuration group

sh docker-bench-security.sh -l /tmp/docker-bench-security.sh.log -e docker_enterprise_configuration,check_2_2 will run all available checks except the docker_enterprise_configuration group and 2.2 Ensure the logging level is set to 'info'

sh docker-bench-security.sh -l /tmp/docker-bench-security.sh.log -c container_images -e check_4_5 will run just the container_images checks except 4.5 Ensure Content trust for Docker is Enabled

Note that when submitting checks, provide information why it is a reasonable test to add and please include some kind of official documentation verifying that information.

Building Docker Bench for Security

If you wish to build and run this container yourself, you can follow the following steps:

git clone https://github.com/docker/docker-bench-security.git
cd docker-bench-security
docker build --no-cache -t docker-bench-security .
docker run -it --net host --pid host --cap-add audit_control \
    -e DOCKER_CONTENT_TRUST=$DOCKER_CONTENT_TRUST \
    -v /var/lib:/var/lib:ro \
    -v /var/run/docker.sock:/var/run/docker.sock:ro \
    -v /usr/lib/systemd:/usr/lib/systemd:ro \
    -v /etc:/etc:ro --label docker_bench_security \
    docker-bench-security

or use Docker Compose:

git clone https://github.com/docker/docker-bench-security.git
cd docker-bench-security
docker-compose run --rm docker-bench-security

Also, this script can also be simply run from your base host by running:

git clone https://github.com/docker/docker-bench-security.git
cd docker-bench-security
sudo sh docker-bench-security.sh

This script was built to be POSIX 2004 compliant, so it should be portable across any Unix platform.