Container Scanning (ULTIMATE)
If you are using GitLab CI/CD, you can check your Docker images (or more precisely the containers) for known vulnerabilities by using Clair and klar, two open source tools for Vulnerability Static Analysis for containers.
GitLab checks the Container Scanning report, compares the found vulnerabilities between the source and target branches, and shows the information right on the merge request.
If you distribute your application with Docker, then there's a great chance that your image is based on other Docker images that may in turn contain some known vulnerabilities that could be exploited.
Having an extra job in your pipeline that checks for those vulnerabilities, and the fact that they are displayed inside a merge request, makes it very easy to perform audits for your Docker-based apps.
To enable Container Scanning in your pipeline, you need:
18.09.03or higher installed on the machine where the Runners are running. If you're using the shared Runners on GitLab.com, this is already the case.
The variables above can be found in the predefined environment variables document.
For GitLab 11.9 and later, to enable Container Scanning, you must
that's provided as a part of your GitLab installation.
For GitLab versions earlier than 11.9, you can copy and use the job as defined
in that template.
Add the following to your
include: template: Container-Scanning.gitlab-ci.yml
The included template will:
- Create a
container_scanningjob in your CI/CD pipeline.
- Pull the already built Docker image from your project's Container Registry (see requirements) and scan it for possible vulnerabilities.
The results will be saved as a Container Scanning report artifact that you can later download and analyze. Due to implementation limitations, we always take the latest Container Scanning artifact available. Behind the scenes, the GitLab Klar analyzer is used and runs the scans.
The following is a sample
.gitlab-ci.yml that will build your Docker Image, push it to the container registry and run Container Scanning.
variables: DOCKER_DRIVER: overlay2 services: - docker:stable-dind stages: - build - test include: - template: Container-Scanning.gitlab-ci.yml build: image: docker:stable stage: build variables: IMAGE: $CI_REGISTRY_IMAGE/$CI_COMMIT_REF_SLUG:$CI_COMMIT_SHA script: - docker info - docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY - docker build -t $IMAGE . - docker push $IMAGE
If you want to whitelist specific vulnerabilities, you'll need to:
GIT_STRATEGY: fetchin your
.gitlab-ci.ymlfile by following the instructions described in the overriding the Container Scanning template section of this document.
- Define the whitelisted vulnerabilities in a YAML file named
clair-whitelist.ymlwhich must use the format described in the following whitelist example file.
- Add the
clair-whitelist.ymlfile to the git repository of your project
Overriding the Container Scanning template
If you want to override the job definition (for example, change properties like
variables), you need to declare a
container_scanning job after the
template inclusion and specify any additional keys under it. For example:
include: - template: Container-Scanning.gitlab-ci.yml container_scanning: variables: GIT_STRATEGY: fetch
Container Scanning can be configured using environment variables.
||Set to true to enable more verbose output from klar.||
||Username for accessing a Docker registry requiring authentication.||
||Password for accessing a Docker registry requiring authentication.||
||Severity level threshold. Vulnerabilities with severity level higher than or equal to this threshold will be outputted. Supported levels are
||Allow Klar to access insecure registries (HTTP only). Should only be set to
||This variable is explicitly set in the services section of the
||Docker repository URL for the image to be scanned.||
||Docker respository tag for the image to be scanned.||
||The Docker image name and tag for the postgres server hosting the vulnerabilities definitions. It can be useful to override this value with a specific version, for example, to provide a consistent set of vulnerabilities for integration testing purposes, or to refer to a locally hosted vulnerabilities database for an on-premise air-gapped installation.||
||(DEPRECATED - use
The Security Dashboard is a good place to get an overview of all the security vulnerabilities in your groups, projects and pipelines. Read more about the Security Dashboard.
Interacting with the vulnerabilities
Once a vulnerability is found, you can interact with it. Read more on how to interact with the vulnerabilities.
Vulnerabilities database update
For more information about the vulnerabilities database update, check the maintenance table.
Running Container Scanning in an offline air-gapped installation
Container Scanning can be executed on an offline air-gapped GitLab Ultimate installation using the following process:
Host the following Docker images on a local Docker container registry:
Override the container scanning template in your
.gitlab-ci.ymlfile to refer to the Docker images hosted on your local Docker container registry:
include: - template: Container-Scanning.gitlab-ci.yml container_scanning: image: $CI_REGISTRY/namespace/gitlab-klar-analyzer variables: CLAIR_DB_IMAGE: $CI_REGISTRY/namespace/clair-vulnerabilities-db
It may be worthwhile to set up a scheduled pipeline to automatically build a new version of the vulnerabilities database on a preset schedule. You can use the following
.gitlab-yml.ci as a template:
image: docker:stable services: - docker:stable-dind stages: - build build_latest_vulnerabilities: stage: build script: - docker pull arminc/clair-db:latest - docker tag arminc/clair-db:latest $CI_REGISTRY/namespace/clair-vulnerabilities-db - docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY - docker push $CI_REGISTRY/namespace/clair-vulnerabilities-db
The above template will work for a GitLab Docker registry running on a local installation, however, if you're using a non-GitLab Docker registry, you'll need to change the
$CI_REGISTRY value and the
docker login credentials to match the details of your local registry.
docker: Error response from daemon: failed to copy xattrs
When the GitLab Runner uses the Docker executor and NFS is used
/var/lib/docker is on an NFS mount), Container Scanning might fail with
an error like the following:
docker: Error response from daemon: failed to copy xattrs: failed to set xattr "security.selinux" on /path/to/file: operation not supported.