Перейти к файлу
Yves Brissaud 7d2ec59e56
chore: add golangci-lint task and config
Signed-off-by: Yves Brissaud <yves.brissaud@docker.com>
2023-01-09 17:57:39 +01:00
.github/workflows Update docker-publish.yaml 2023-01-09 17:49:16 +01:00
commands Make cve and base image query async 2022-11-21 11:16:33 +01:00
format Make cve and base image query async 2022-11-21 11:16:33 +01:00
internal Rev sbom version 2022-11-24 14:30:30 +01:00
query Break early in case of errors 2022-11-24 13:30:49 +01:00
registry Merge pull request #9 from eunomie/fix-tests 2023-01-09 10:49:56 +01:00
sbom Merge pull request #9 from eunomie/fix-tests 2023-01-09 10:49:56 +01:00
types Add secret scanning 2023-01-04 11:53:03 +01:00
.gitignore Add diff command 2022-10-28 16:25:28 +02:00
.golangci.yml chore: add golangci-lint task and config 2023-01-09 17:57:39 +01:00
.goreleaser.yaml Run standalone 2022-10-27 22:41:00 +02:00
Dockerfile Initial commit 2022-10-27 07:44:35 +02:00
LICENSE Initial commit 2022-10-27 07:44:35 +02:00
README.md Some more progress 2022-11-01 16:09:47 +01:00
Taskfile.yaml chore: add golangci-lint task and config 2023-01-09 17:57:39 +01:00
go.mod Bump github.com/containerd/containerd from 1.6.8 to 1.6.12 2023-01-09 09:52:29 +00:00
go.sum Bump github.com/containerd/containerd from 1.6.8 to 1.6.12 2023-01-09 09:52:29 +00:00
install.sh Run standalone 2022-10-27 22:41:00 +02:00
main.go Add diff command 2022-10-28 16:25:28 +02:00

README.md

Note: This repository is not an officially supported Docker project.

docker index Docker CLI tool

Docker CLI tool to create image SBOMs as well as analyze packages for known vulnerabilities using the Atomist data plane.

Installation

You can install manually by following these steps:

  • Download the binary from the release page
  • Unzip the archive

Usage

docker-index sbom

To create an SBOM for a local or remote image, run the following command:

$ docker-index sbom --image <IMAGE> 
  • --image <IMAGE> can either be a local image id or fully qualified image name from a remote registry
  • --oci-dir <DIR> can point to a local image in OCI directory format
  • --output <OUTPUT FILE> allows to store the generated SBOM in a local file
  • --include-cves will include all detected CVEs in generated output

docker-index cve

To detect base images for local or remote images, use the following command:

$ docker-index cve --image <IMAGE> CVE_ID 
  • --image <IMAGE> can either be a local image id or fully qualified image name from a remote registry
  • --oci-dir <DIR> can point to a local image in OCI directory format
  • --remediate include suggested remediation in the output
  • CVE_ID can be any known CVE id