Tracking container vulnerabilities with Clair Control
Clairctl is a lightweight command-line tool doing the bridge between Registries as Docker Hub, Docker Registry or Quay.io, and the CoreOS vulnerability tracker, Clair. Clairctl will play as reverse proxy for authentication.
Clairctl version is align with the CoreOS Clair supported version.
Go to Release and download your corresponding version
Master branch version
curl -L https://raw.githubusercontent.com/jgsqware/clairctl/master/install.sh | sh
$ git clone email@example.com:jgsqware/clairctl.git $GOPATH/src/github.com/jgsqware/clairctl $ cd $GOPATH/src/github.com/jgsqware/clairctl $ docker-compose up -d postgres Creating network "clairctl_default" with the default driver Creating clairctl_postgres_1 ... Creating clairctl_clair_1 ... Creating clairctl_clairctl_1 ...
The above commands will check out the
clairctl repo and start the complete postgres/clair/clairctl stack.
$ docker-compose exec clairctl clairctl health Clair: ✔
The above command will make sure clairctl can reach clair.
If you wish to serve local images to clair, the user inside the clairctl container will need read access to
Give the user access by:
- Running the container as root (
- Add the container user to the docker group (
To get the group name or id, simply execute :
$ docker-compose exec clairctl ls -alh /var/run/docker.sock srw-rw---- 1 root 50 0 Jul 18 09:48 /var/run/docker.sock
In the example above, 50 is the required group.
clairctl get vulnerabilities report from Clair and generate HTML report
clairctl can be used for Docker Hub and self-hosted Registry
Analyze your docker image with Clair, directly from your registry. Usage: clairctl [command] Available Commands: analyze Analyze Docker image health Get Health of clairctl and underlying services pull Pull Docker image information (This will not pull the image !) push Push Docker image to Clair report Generate Docker Image vulnerabilities report version Get Versions of clairctl and underlying services Flags: --config string config file (default is ./.clairctl.yml) --log-level string log level [Panic,Fatal,Error,Warn,Info,Debug] Use "clairctl [command] --help" for more information about a command.
clair: port: 6060 healthPort: 6061 uri: http://clair report: path: ./reports format: html
Optional whitelist yaml file
This is an example yaml file. You can have an empty file or a mix with only
generalwhitelist: #Approve CVE for any image CVE-2016-2148: BusyBox CVE-2014-8625: Why is it whitelisted images: ubuntu: #Approve CVE only for ubuntu image, regardless of the version CVE-2014-2667: Python CVE-2017-5230: Something alpine: CVE-2016-7068: Something
Building the latest binaries
clairctl requires Go 1.8+.
curl https://glide.sh/get | sh
Clone and build:
git clone firstname.lastname@example.org:jgsqware/clairctl.git $GOPATH/src/github.com/jgsqware/clairctl cd $GOPATH/src/github.com/jgsqware/clairctl glide install -v go get -u github.com/jteeuwen/go-bindata/... go generate ./clair go build
This will result in a
clairctl executable in the
I get 400 errors !
If you get 400 errors, check out clair's logs. The usual reasons are :
- You are serving a local image, and clair cannot connect to clairctl.
- You are trying to analyze an official image from docker hub and you have not done a docker login first.
Please try these two things before opening an Issue.
I get access denied on /var/run/docker.sock
If you are running the stack with the provided
docker-compose.yml, don't forget to grant the user from the clairctl container access to
All steps are detailed in the Docker-compose section above.
Contribution and Test
Go to /contrib folder