Skip to content
Scan images for security vulnerabilities in a Kubernetes cluster using Clair and Klar
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
README.md
clair-kubernetes.yaml artifacts for minikube and initial readme instructions Jun 29, 2018
config.yaml artifacts for minikube and initial readme instructions Jun 29, 2018
klar.yaml standardized first image to scan Jun 29, 2018

README.md

Scan Your Docker Containers For Vulnerabilities

This is a beginner friendly tutorial to introduce the user to Docker image vulnerability scanning. The intent is to give a overview of what is involved in scanning a Docker image for vulnerabilities so you can integrate a container scan task into your CI/CD pipeline. In this tutorial we will setup a demo scanner system using Clair and Klar running in pods in a Kubernetes cluster.

Before we start - let's talk vocabulary. We are going to talk about Docker, Dockerfiles, containers and images - what's the difference? Docker is a "container runtime", it wraps the fundamental concept of containers with tools that help humans build, run and archive containers. There are many container runtimes to help you run containers, we are going to focus on Docker.

An image is a static file that is a snapshot of a container. Images are built from a blueprint (in Docker's case a "Dockerfile") and can be stored in a registry. The image produces a container when started with run.

Docker containers are a great way to encapsulate your application with everything you need to run your application. Combining docker containers and a CI/CD system can allow developers to push, test and deploy changes to containerized applications quickly to different environments. But with this fast iterative development style how can you trust the software running in your production containers are secure?

Security is a multilayered problem that should be considered from many angles. This article is going to consider one angle: how to scan static images for vulnerabilities. We will look at how to scan an image in a Kubernetes cluster (using minikube), once you have an idea of how to scan and image it should make sense how you can integrate this process into your CI/CD platform. This will allow developers or admins to configure a CI job that will set a maximum number of security vulnerabilities of a certain level and the pipeline will fail if the scan discovers more vulnerabilities than the stated maximum. This will provide an automated way to know how secure your production containers are.

Before jumping in, let's break down the problem and concepts a bit more. Most importantly, why should you care? Why scan your docker images for vulnerabilities?

What even is a vulnerability?

A vulnerability or exposure in a piece of software is a weak section of code or process that allows access from a potentially malicious third party. Generally speaking, it's a bug that a hacker could take advantage of. Remember the "Heartbleed" fiasco - that was a major bug in software that many companies relied on. Not all bugs are that big, but they can still be a disaster for your organization.

The MITRE corporation currently maintains the "Common Vulnerabilities and Exposures" or "CVE" which is a list of common identifiers for publicly known cybersecurity vulnerabilities. Plainly - the MITRE corporation maintains a list of these bugs. Each vulnerability in the CVE is standardized with details so developers can know how serious it is, what software it affects and how it works. You can learn more about how CVE work, but for this article we will focus on an averaged "severity level" which ranges from low, medium, high to critical, this score is calculated by the CVSS "Common Vulnerability Scoring System".

So we have a list of knowns bugs (CVE) and we have a Docker image full of software - how do we make sure the software in the Docker image doesn't include a known vulnerability? Scan it!

Clair: Vulnerability Static Analysis for Containers

We are going to use an open source vulnerability scanner for containers called Clair which was created by CoreOS. Let's get an idea of how Clair works by running a demo in Kubernetes cluster using Minikube.

First you need to get minikube up and running - learn more about minikube and follow the quickstart to spin up a local Kubernetes cluster. Once minikube has spun up your Kubernetes cluster, you should be able to access it using kubectl.

Here are the Kubernetes resources we are going to deploy to scan our images:

Clair is a process that will check each layer in your Docker image for vulnerabilities. Our Postgres database resources will be populated with the CVE by Clair. Klar is a process we will run as a job and will pass our static image to Clair then return the results. Think of Clair as the backend process that coordinates with the database and Klar as the front end process that coordinates getting the image from the registry and passing it to Clair, then returning results for us humans to consume. Let's create the resources in our minikube cluster:

  • > kubectl create secret generic clairsecret --from-file=./config.yaml
  • > kubectl get secret
  • > kubectl create -f clair-kubernetes.yaml

NOTE: Clair will take ~20 minutes to populate the database with the list of vulnerabilities. You can run Klar without errors, but the vulnerability count will not be correct until the database is populated. Grab some coffee or catch up on Reddit before continuing to the next step.

At this point you should have all the resources to scan an image. Now let's take a look at the klar.yaml file. This is a job that will run a container that contains the Klar application. We will pass klar the image we want to scan in the form of an argument (we will be scanning: quay.io/samsung_cnct/fluentd-central:latest) and provide the necessary environment variables for Klar to connect to Clair and set our maximum vulnerability number (CLAIR_ADDR, CLAIR_OUTPUT, CLAIR_THRESHOLD. Before we scan our first image, let's make sure our CLAIR_ADDR variable is correct by running:

  • > minikube service clairsvc --url

Take the first address of the output and put it in the klar.yaml file as the value for the CLAIR_ADDR variable. Save your file and let's create the job:

  • > kubectl create -f klar.yaml

Wait until the klar pod's status is "Completed" then run:

  • > kubectl logs <klar pod>

You should see the summary of vulnerabilities found at the top and the details of each vulnerability listed after. To see the pod exit code run:

  • > kubectl describe po <klar pod>

and look for:

State:          Terminated
   Reason:       Completed
   Exit Code:    0

So, the process exited successfully with a 0, let's modify the maximum vulnerabilities to make our klar process fail. In klar.yaml change the CLAIR_THRESHOLD variable to 1. Then cleanup the old klar job and start a new one:

  • > kubectl delete job klar
  • > kubectl create -f klar.yaml

If you take a look at the logs, you should see the same output, but if you describe the pod you will notice the exit status is 1, indicating the maximum vulnerabilities were exceeded. If you want to try scanning a different image, change the arg we pass to klar in the klar.yaml file (currently it is: quay.io/samsung_cnct/fluentd-central:latest).

So, what level of risk is appropriate? This question really depends on your company and the details of what is running in the container and where. You should work with your team to outline a strategy and best practices approach to vulnerability levels and patterns to address fixes.

Now we have Secure Containers? ...don't be so sure

By integrating a CVE scan into your CI pipeline you can guarantee a certain risk level for all your containers that go into production. But before you say you've solved your container security issues - think about this scenario: you have a long lived container that doesn't get built via CI often, maybe because it doesn't require updates or new features. Since the time it passed your CI vulnerability scan, a vulnerability was added to the CVE for one of the processes in that container. How would you ever know?

Scanning a static image and verifying it's contents before it deploys to production is one way to keep secure containers - scanning running containers in your cluster on regular intervals is another step you can take towards automating container security. Another task for another day!

Thanks for checking out my tutorial and don't be a stranger: @eccomi_leah.

You can’t perform that action at this time.