2021-10-11 21:06:27 +00:00
< p align = "center" >
2021-11-02 19:00:56 +00:00
< img src = "https://user-images.githubusercontent.com/5199289/136844524-1527b09f-c5cb-4aa9-be54-5aa92a6086c1.png" width = "271" alt = "Cute pink owl syft logo" >
2021-10-11 21:06:27 +00:00
< / p >
2020-07-24 00:54:04 +00:00
2021-04-16 12:59:07 +00:00
[![Validations ](https://github.com/anchore/syft/actions/workflows/validations.yaml/badge.svg )](https://github.com/anchore/syft/actions/workflows/validations.yaml)
2020-08-10 20:46:12 +00:00
[![Go Report Card ](https://goreportcard.com/badge/github.com/anchore/syft )](https://goreportcard.com/report/github.com/anchore/syft)
[![GitHub release ](https://img.shields.io/github/release/anchore/syft.svg )](https://github.com/anchore/syft/releases/latest)
2021-04-16 12:35:05 +00:00
[![GitHub go.mod Go version ](https://img.shields.io/github/go-mod/go-version/anchore/syft.svg )](https://github.com/anchore/syft)
2021-10-04 13:29:27 +00:00
[![License: Apache-2.0 ](https://img.shields.io/badge/License-Apache%202.0-blue.svg )](https://github.com/anchore/syft/blob/main/LICENSE)
[![Slack Invite ](https://img.shields.io/badge/Slack-Join-blue?logo=slack )](https://anchore.com/slack)
2020-08-10 20:46:12 +00:00
2022-03-25 15:36:43 +00:00
A CLI tool and Go library for generating a Software Bill of Materials (SBOM) from container images and filesystems. Exceptional for vulnerability detection when used with a scanner like [Grype ](https://github.com/anchore/grype ).
2021-09-24 15:42:06 +00:00
2021-12-06 17:18:34 +00:00
### Join our community meetings!
- Calendar: https://calendar.google.com/calendar/u/0/r?cid=Y182OTM4dGt0MjRtajI0NnNzOThiaGtnM29qNEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t
- Agenda: https://docs.google.com/document/d/1ZtSAa6fj2a6KRWviTn3WoJm09edvrNUp4Iz_dOjjyY8/edit?usp=sharing (join [this group ](https://groups.google.com/g/anchore-oss-community ) for write access)
- All are welcome!
2022-08-04 21:13:28 +00:00
For commercial support options with Syft or Grype, please [contact Anchore ](https://get.anchore.com/contact/ )
2021-12-06 17:18:34 +00:00
2020-08-14 17:58:45 +00:00
![syft-demo ](https://user-images.githubusercontent.com/590471/90277200-2a253000-de33-11ea-893f-32c219eea11a.gif )
2020-08-04 19:22:34 +00:00
2021-10-15 16:13:28 +00:00
## Features
2022-03-25 15:36:43 +00:00
- Generates SBOMs for container images, filesystems, archives, and more to discover packages and libraries
2022-09-07 18:43:38 +00:00
- Supports OCI, Docker and [Singularity ](https://github.com/sylabs/singularity ) image formats
2022-03-25 15:36:43 +00:00
- Linux distribution identification
- Works seamlessly with [Grype ](https://github.com/anchore/grype ) (a fast, modern vulnerability scanner)
- Able to create signed SBOM attestations using the [in-toto specification ](https://github.com/in-toto/attestation/blob/main/spec/README.md )
2022-05-10 00:28:33 +00:00
- Convert between SBOM formats, such as CycloneDX, SPDX, and Syft's own format.
2022-03-25 15:36:43 +00:00
### Supported Ecosystems
- Alpine (apk)
2022-07-05 14:49:24 +00:00
- C (conan)
- C++ (conan)
2022-03-31 19:44:55 +00:00
- Dart (pubs)
2022-03-25 15:36:43 +00:00
- Debian (dpkg)
2022-05-05 19:32:02 +00:00
- Dotnet (deps.json)
2022-07-11 14:09:08 +00:00
- Objective-C (cocoapods)
2023-01-12 17:10:46 +00:00
- Elixir (mix)
- Erlang (rebar3)
2022-03-25 15:36:43 +00:00
- Go (go.mod, Go binaries)
2022-07-18 19:33:54 +00:00
- Haskell (cabal, stack)
2023-01-06 23:31:22 +00:00
- Java (jar, ear, war, par, sar, native-image)
2022-03-25 15:36:43 +00:00
- JavaScript (npm, yarn)
- Jenkins Plugins (jpi, hpi)
- PHP (composer)
- Python (wheel, egg, poetry, requirements.txt)
- Red Hat (rpm)
- Ruby (gem)
- Rust (cargo.lock)
2022-07-11 14:09:08 +00:00
- Swift (cocoapods)
2020-08-11 11:07:55 +00:00
2021-10-04 13:29:27 +00:00
## Installation
2022-02-09 19:33:26 +00:00
**Note**: Currently, Syft is built only for Linux, macOS and Windows.
2021-10-04 13:29:27 +00:00
### Recommended
```bash
curl -sSfL https://raw.githubusercontent.com/anchore/syft/main/install.sh | sh -s -- -b /usr/local/bin
```
2022-02-09 19:33:26 +00:00
... or, you can specify a release version and destination directory for the installation:
2021-10-04 13:29:27 +00:00
```
curl -sSfL https://raw.githubusercontent.com/anchore/syft/main/install.sh | sh -s -- -b < DESTINATION_DIR > < RELEASE_VERSION >
```
2022-06-08 21:39:22 +00:00
### Chocolatey
The chocolatey distribution of syft is community maintained and not distributed by the anchore team
```powershell
choco install syft -y
```
2021-10-04 13:29:27 +00:00
### Homebrew
```bash
brew install syft
```
2022-02-09 19:33:26 +00:00
### Nix
2023-01-13 15:43:25 +00:00
**Note**: Nix packaging of Syft is [community maintained ](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/admin/syft/default.nix ). Syft is available in the [stable channel ](https://nixos.wiki/wiki/Nix_channels#The_official_channels ) since NixOS `22.05` .
2022-02-09 19:33:26 +00:00
```bash
nix-env -i syft
```
2022-03-25 15:36:43 +00:00
... or, just try it out in an ephemeral nix shell:
2022-02-09 19:33:26 +00:00
```bash
nix-shell -p syft
```
2021-10-04 13:29:27 +00:00
2020-08-04 19:22:34 +00:00
## Getting started
2022-08-04 21:14:23 +00:00
### SBOM
2020-08-04 19:22:34 +00:00
2022-03-25 15:36:43 +00:00
To generate an SBOM for a container image:
2021-03-23 17:00:25 +00:00
```
2022-03-25 15:36:43 +00:00
syft < image >
2021-03-23 17:00:25 +00:00
```
2022-03-25 15:36:43 +00:00
The above output includes only software that is visible in the container (i.e., the squashed representation of the image). To include software from all image layers in the SBOM, regardless of its presence in the final image, provide `--scope all-layers` :
2020-08-04 19:22:34 +00:00
```
2022-03-25 15:36:43 +00:00
syft < image > --scope all-layers
2020-08-04 19:22:34 +00:00
```
2022-05-10 00:28:33 +00:00
2022-08-04 21:14:23 +00:00
## Supported sources
2021-10-04 13:29:27 +00:00
2020-08-04 19:22:34 +00:00
Syft can generate a SBOM from a variety of sources:
2021-10-04 13:29:27 +00:00
2020-08-04 19:22:34 +00:00
```
2020-09-25 14:24:24 +00:00
# catalog a container image archive (from the result of `docker image save ...`, `podman save ...`, or `skopeo copy` commands)
2022-03-25 15:36:43 +00:00
syft path/to/image.tar
2020-08-04 19:22:34 +00:00
2022-09-07 18:43:38 +00:00
# catalog a Singularity Image Format (SIF) container
syft path/to/image.sif
2020-08-04 19:22:34 +00:00
# catalog a directory
2022-03-25 15:36:43 +00:00
syft path/to/dir
2020-08-04 19:22:34 +00:00
```
2021-04-13 13:30:57 +00:00
Sources can be explicitly provided with a scheme:
2021-10-04 13:29:27 +00:00
2021-04-13 13:30:57 +00:00
```
2022-08-02 15:42:46 +00:00
docker:yourrepo/yourimage:tag use images from the Docker daemon
podman:yourrepo/yourimage:tag use images from the Podman daemon
docker-archive:path/to/yourimage.tar use a tarball from disk for archives created from "docker save"
oci-archive:path/to/yourimage.tar use a tarball from disk for OCI archives (from Skopeo or otherwise)
oci-dir:path/to/yourimage read directly from a path on disk for OCI layout directories (from Skopeo or otherwise)
singularity:path/to/yourimage.sif read directly from a Singularity Image Format (SIF) container on disk
dir:path/to/yourproject read directly from a path on disk (any directory)
file:path/to/yourproject/file read directly from a path on disk (any single file)
registry:yourrepo/yourimage:tag pull image directly from a registry (no container runtime required)
2021-04-13 13:30:57 +00:00
```
2022-08-04 21:14:23 +00:00
#### Default Cataloger Configuration by scan type
##### Image Scanning:
- alpmdb
- rpmdb
- dpkgdb
- apkdb
- portage
- ruby-gemspec
- python-package
- php-composer-installed Cataloger
- javascript-package
- java
- go-module-binary
- dotnet-deps
##### Directory Scanning:
- alpmdb
- apkdb
- dpkgdb
- portage
- rpmdb
- ruby-gemfile
- python-index
- python-package
- php-composer-lock
- javascript-lock
- java
- java-pom
- go-module-binary
- go-mod-file
- rust-cargo-lock
- dartlang-lock
- dotnet-deps
- cocoapods
- conan
- hackage
#### Non Default:
- cargo-auditable-binary
2021-12-20 15:35:25 +00:00
### Excluding file paths
Syft can exclude files and paths from being scanned within a source by using glob expressions
with one or more `--exclude` parameters:
```
syft < source > --exclude './out/**/*.json' --exclude /etc
```
**Note:** in the case of _image scanning_ , since the entire filesystem is scanned it is
possible to use absolute paths like `/etc` or `/usr/**/*.txt` whereas _directory scans_
exclude files _relative to the specified directory_ . For example: scanning `/usr/foo` with
`--exclude ./package.json` would exclude `/usr/foo/package.json` and `--exclude '**/package.json'`
would exclude all `package.json` files under `/usr/foo` . For _directory scans_ ,
it is required to begin path expressions with `./` , `*/` , or `**/` , all of which
will be resolved _relative to the specified scan directory_ . Keep in mind, your shell
may attempt to expand wildcards, so put those parameters in single quotes, like:
`'**/*.json'` .
2021-10-04 13:29:27 +00:00
### Output formats
2022-01-06 22:52:20 +00:00
The output format for Syft is configurable as well using the
`-o` (or `--output` ) option:
2021-10-04 13:29:27 +00:00
2020-08-04 19:22:34 +00:00
```
2022-03-25 15:36:43 +00:00
syft < image > -o < format >
2020-08-04 19:22:34 +00:00
```
2021-11-02 19:00:56 +00:00
Where the `formats` available are:
2020-09-25 14:24:24 +00:00
- `json` : Use this to get as much information out of Syft as possible!
- `text` : A row-oriented, human-and-machine-friendly output.
2022-04-12 21:16:47 +00:00
- `cyclonedx-xml` : A XML report conforming to the [CycloneDX 1.4 specification ](https://cyclonedx.org/specification/overview/ ).
- `cyclonedx-json` : A JSON report conforming to the [CycloneDX 1.4 specification ](https://cyclonedx.org/specification/overview/ ).
2023-03-20 14:10:35 +00:00
- `spdx-tag-value` : A tag-value formatted report conforming to the [SPDX 2.3 specification ](https://spdx.github.io/spdx-spec/v2.3/ ).
- `spdx-tag-value@2.2` : A tag-value formatted report conforming to the [SPDX 2.2 specification ](https://spdx.github.io/spdx-spec/v2.2.2/ ).
- `spdx-json` : A JSON report conforming to the [SPDX 2.3 JSON Schema ](https://github.com/spdx/spdx-spec/blob/v2.3/schemas/spdx-schema.json ).
- `spdx-json@2.2` : A JSON report conforming to the [SPDX 2.2 JSON Schema ](https://github.com/spdx/spdx-spec/blob/v2.2/schemas/spdx-schema.json ).
2022-05-05 00:25:40 +00:00
- `github` : A JSON report conforming to GitHub's dependency snapshot format.
2020-09-25 14:24:24 +00:00
- `table` : A columnar summary (default).
2022-06-17 18:04:31 +00:00
- `template` : Lets the user specify the output format. See ["Using templates" ](#using-templates ) below.
2022-08-04 21:14:23 +00:00
## Using templates
2022-06-17 18:04:31 +00:00
Syft lets you define custom output formats, using [Go templates ](https://pkg.go.dev/text/template ). Here's how it works:
- Define your format as a Go template, and save this template as a file.
2022-08-04 21:14:23 +00:00
- Set the output format to "template" (`-o template`).
2022-06-17 18:04:31 +00:00
- Specify the path to the template file (`-t ./path/to/custom.template`).
- Syft's template processing uses the same data models as the `json` output format — so if you're wondering what data is available as you author a template, you can use the output from `syft <image> -o json` as a reference.
**Example:** You could make Syft output data in CSV format by writing a Go template that renders CSV data and then running `syft <image> -o template -t ~/path/to/csv.tmpl` .
Here's what the `csv.tmpl` file might look like:
```gotemplate
"Package","Version Installed","Found by"
{{- range .Artifacts}}
"{{.Name}}","{{.Version}}","{{.FoundBy}}"
{{- end}}
```
Which would produce output like:
```text
"Package","Version Installed","Found by"
"alpine-baselayout","3.2.0-r20","apkdb-cataloger"
"alpine-baselayout-data","3.2.0-r20","apkdb-cataloger"
"alpine-keys","2.4-r1","apkdb-cataloger"
...
```
Syft also includes a vast array of utility templating functions from [sprig ](http://masterminds.github.io/sprig/ ) apart from the default Golang [text/template ](https://pkg.go.dev/text/template#hdr-Functions ) to allow users to customize the output format.
2020-09-25 14:24:24 +00:00
2022-08-04 21:14:23 +00:00
## Multiple outputs
2022-01-06 22:52:20 +00:00
Syft can also output _multiple_ files in differing formats by appending
`=<file>` to the option, for example to output Syft JSON and SPDX JSON:
```shell
2022-03-25 15:36:43 +00:00
syft < image > -o json=sbom.syft.json -o spdx-json=sbom.spdx.json
2022-01-06 22:52:20 +00:00
```
2021-11-02 19:00:56 +00:00
## Private Registry Authentication
### Local Docker Credentials
2022-03-25 15:36:43 +00:00
When a container runtime is not present, Syft can still utilize credentials configured in common credential sources (such as `~/.docker/config.json` ). It will pull images from private registries using these credentials. The config file is where your credentials are stored when authenticating with private registries via some command like `docker login` . For more information see the `go-containerregistry` [documentation ](https://github.com/google/go-containerregistry/tree/main/pkg/authn ).
2021-11-02 19:00:56 +00:00
An example `config.json` looks something like this:
2022-03-25 15:36:43 +00:00
```json
2021-11-02 19:00:56 +00:00
{
"auths": {
"registry.example.com": {
"username": "AzureDiamond",
"password": "hunter2"
}
}
}
```
You can run the following command as an example. It details the mount/environment configuration a container needs to access a private registry:
2022-03-25 15:36:43 +00:00
```
docker run -v ./config.json:/config/config.json -e "DOCKER_CONFIG=/config" anchore/syft:latest < private_image >
```
2021-11-02 19:00:56 +00:00
### Docker Credentials in Kubernetes
2022-03-25 15:36:43 +00:00
Here's a simple workflow to mount this config file as a secret into a container on Kubernetes.
1. Create a secret. The value of `config.json` is important. It refers to the specification detailed [here ](https://github.com/google/go-containerregistry/tree/main/pkg/authn#the-config-file ). Below this section is the `secret.yaml` file that the pod configuration will consume as a volume. The key `config.json` is important. It will end up being the name of the file when mounted into the pod.
```yaml
2021-11-02 19:00:56 +00:00
# secret.yaml
2022-06-08 21:39:22 +00:00
2021-11-02 19:00:56 +00:00
apiVersion: v1
kind: Secret
metadata:
name: registry-config
namespace: syft
data:
config.json: < base64 encoded config . json >
```
2022-08-04 21:14:23 +00:00
`kubectl apply -f secret.yaml`
2021-11-02 19:00:56 +00:00
2022-03-25 15:36:43 +00:00
2. Create your pod running syft. The env `DOCKER_CONFIG` is important because it advertises where to look for the credential file. In the below example, setting `DOCKER_CONFIG=/config` informs syft that credentials can be found at `/config/config.json` . This is why we used `config.json` as the key for our secret. When mounted into containers the secrets' key is used as the filename. The `volumeMounts` section mounts our secret to `/config` . The `volumes` section names our volume and leverages the secret we created in step one.
```yaml
2021-11-02 19:00:56 +00:00
# pod.yaml
2022-06-08 21:39:22 +00:00
2021-11-02 19:00:56 +00:00
apiVersion: v1
kind: Pod
2022-02-08 21:00:19 +00:00
metadata:
name: syft-k8s-usage
2021-11-02 19:00:56 +00:00
spec:
containers:
- image: anchore/syft:latest
name: syft-private-registry-demo
env:
- name: DOCKER_CONFIG
value: /config
volumeMounts:
- mountPath: /config
name: registry-config
readOnly: true
args:
- < private_image >
volumes:
- name: registry-config
secret:
secretName: registry-config
```
2022-08-04 21:14:23 +00:00
`kubectl apply -f pod.yaml`
2021-11-02 19:00:56 +00:00
2022-03-25 15:36:43 +00:00
3. The user can now run `kubectl logs syft-private-registry-demo` . The logs should show the Syft analysis for the `<private_image>` provided in the pod configuration.
2021-11-02 19:00:56 +00:00
2022-03-25 15:36:43 +00:00
Using the above information, users should be able to configure private registry access without having to do so in the `grype` or `syft` configuration files. They will also not be dependent on a Docker daemon, (or some other runtime software) for registry configuration and access.
2021-11-02 19:00:56 +00:00
2022-08-04 21:14:23 +00:00
## Format conversion (experimental)
The ability to convert existing SBOMs means you can create SBOMs in different formats quickly, without the need to regenerate the SBOM from scratch, which may take significantly more time.
```
syft convert < ORIGINAL-SBOM-FILE > -o < NEW-SBOM-FORMAT > [=< NEW-SBOM-FILE > ]
```
This feature is experimental and data might be lost when converting formats. Packages are the main SBOM component easily transferable across formats, whereas files and relationships, as well as other information Syft doesn't support, are more likely to be lost.
We support formats with wide community usage AND good encode/decode support by Syft. The supported formats are:
- Syft JSON
- SPDX 2.2 JSON
- SPDX 2.2 tag-value
- CycloneDX 1.4 JSON
- CycloneDX 1.4 XML
Conversion example:
```sh
syft alpine:latest -o syft-json=sbom.syft.json # generate a syft SBOM
syft convert sbom.syft.json -o cyclonedx-json=sbom.cdx.json # convert it to CycloneDX
```
## Attestation (experimental)
### Keyless support
Syft supports generating attestations using cosign's [keyless ](https://github.com/sigstore/cosign/blob/main/KEYLESS.md ) signatures.
2023-01-12 17:22:05 +00:00
Note: users need to have >= v1.12.0 of cosign installed for this command to function
2022-08-04 21:14:23 +00:00
To use this feature with a format like CycloneDX json simply run:
```
syft attest --output cyclonedx-json < IMAGE WITH OCI WRITE ACCESS >
```
This command will open a web browser and allow the user to authenticate their OIDC identity as the root of trust for the attestation (Github, Google, Microsoft).
After authenticating, Syft will upload the attestation to the OCI registry specified by the image that the user has write access to.
You will need to make sure your credentials are configured for the OCI registry you are uploading to so that the attestation can write successfully.
Users can then verify the attestation(or any image with attestations) by running:
```
COSIGN_EXPERIMENTAL=1 cosign verify-attestation < IMAGE_WITH_ATTESTATIONS >
```
Users should see that the uploaded attestation claims are validated, the claims exist within the transparency log, and certificates on the attestations were verified against [fulcio ](https://github.com/SigStore/fulcio ).
There will also be a printout of the certificates subject `<user identity>` and the certificate issuer URL: `<provider of user identity (Github, Google, Microsoft)>` :
```
Certificate subject: test.email@testdomain.com
Certificate issuer URL: https://accounts.google.com
```
#### Local private key support
To generate an SBOM attestation for a container image using a local private key:
```
syft attest --output [FORMAT] --key [KEY] [SOURCE] [flags]
```
The above output is in the form of the [DSSE envelope ](https://github.com/secure-systems-lab/dsse/blob/master/envelope.md#dsse-envelope ).
The payload is a base64 encoded `in-toto` statement with the generated SBOM as the predicate. For details on workflows using this command see [here ](#adding-an-sbom-to-an-image-as-an-attestation-using-syft ).
2020-08-04 19:22:34 +00:00
## Configuration
Configuration search paths:
- `.syft.yaml`
- `.syft/config.yaml`
- `~/.syft.yaml`
- `<XDG_CONFIG_HOME>/syft/config.yaml`
Configuration options (example values are the default):
```yaml
2022-01-06 22:52:20 +00:00
# the output format(s) of the SBOM report (options: table, text, json, spdx, ...)
# same as -o, --output, and SYFT_OUTPUT env var
# to specify multiple output files in differing formats, use a list:
# output:
# - "json=<syft-json-output-file>"
# - "spdx-json=<spdx-json-output-file>"
2020-08-04 19:22:34 +00:00
output: "table"
2020-12-10 03:20:53 +00:00
# suppress all output (except for the SBOM report)
# same as -q ; SYFT_QUIET env var
2020-08-04 19:22:34 +00:00
quiet: false
2021-10-05 19:34:32 +00:00
# same as --file; write output report to a file (default is to write to stdout)
file: ""
2020-12-10 03:20:53 +00:00
# enable/disable checking for application updates on startup
# same as SYFT_CHECK_FOR_APP_UPDATE env var
check-for-app-update: true
2021-12-20 15:35:25 +00:00
# a list of globs to exclude from scanning. same as --exclude ; for example:
# exclude:
2022-01-06 22:52:20 +00:00
# - "/etc/**"
# - "./out/**/*.json"
2022-03-21 16:02:15 +00:00
exclude: []
# os and/or architecture to use when referencing container images (e.g. "windows/armv6" or "arm64")
# same as --platform; SYFT_PLATFORM env var
platform: ""
2021-12-20 15:35:25 +00:00
2022-06-21 13:06:25 +00:00
# set the list of package catalogers to use when generating the SBOM
# default = empty (cataloger set determined automatically by the source type [image or file/directory])
# catalogers:
# - ruby-gemfile
# - ruby-gemspec
# - python-index
# - python-package
# - javascript-lock
# - javascript-package
# - php-composer-installed
# - php-composer-lock
# - alpmdb
# - dpkgdb
# - rpmdb
# - java
# - apkdb
# - go-module-binary
# - go-mod-file
# - dartlang-lock
# - rust
# - dotnet-deps
2022-07-28 18:17:38 +00:00
# rust-audit-binary scans Rust binaries built with https://github.com/Shnatsel/rust-audit
# - rust-audit-binary
2022-06-21 13:06:25 +00:00
catalogers:
2021-03-18 14:58:47 +00:00
# cataloging packages is exposed through the packages and power-user subcommands
2021-03-20 11:33:13 +00:00
package:
2022-01-06 21:40:51 +00:00
# search within archives that do contain a file index to search against (zip)
# note: for now this only applies to the java package cataloger
# SYFT_PACKAGE_SEARCH_INDEXED_ARCHIVES env var
search-indexed-archives: true
# search within archives that do not contain a file index to search against (tar, tar.gz, tar.bz2, etc)
# note: enabling this may result in a performance impact since all discovered compressed tars will be decompressed
# note: for now this only applies to the java package cataloger
# SYFT_PACKAGE_SEARCH_UNINDEXED_ARCHIVES env var
search-unindexed-archives: false
2022-01-21 14:15:22 +00:00
2021-03-20 11:33:13 +00:00
cataloger:
2021-03-18 14:58:47 +00:00
# enable/disable cataloging of packages
2021-03-20 11:33:13 +00:00
# SYFT_PACKAGE_CATALOGER_ENABLED env var
enabled: true
2021-05-06 16:26:03 +00:00
2021-03-18 12:53:31 +00:00
# the search space to look for packages (options: all-layers, squashed)
2021-03-20 11:33:13 +00:00
# same as -s ; SYFT_PACKAGE_CATALOGER_SCOPE env var
2021-03-18 12:53:31 +00:00
scope: "squashed"
2023-03-23 14:38:15 +00:00
golang:
# search for go package licences in the GOPATH of the system running Syft, note that this is outside the
# container filesystem and potentially outside the root of a local directory scan
# SYFT_GOLANG_SEARCH_LOCAL_MOD_CACHE_LICENSES env var
search-local-mod-cache-licenses: false
# specify an explicit go mod cache directory, if unset this defaults to $GOPATH/pkg/mod or $HOME/go/pkg/mod
# SYFT_GOLANG_LOCAL_MOD_CACHE_DIR env var
local-mod-cache-dir: ""
2021-04-07 20:28:45 +00:00
# cataloging file contents is exposed through the power-user subcommand
2021-04-09 12:56:01 +00:00
file-contents:
2021-04-07 20:28:45 +00:00
cataloger:
# enable/disable cataloging of secrets
2021-04-09 12:56:01 +00:00
# SYFT_FILE_CONTENTS_CATALOGER_ENABLED env var
2021-04-07 20:28:45 +00:00
enabled: true
# the search space to look for secrets (options: all-layers, squashed)
2021-04-09 12:56:01 +00:00
# SYFT_FILE_CONTENTS_CATALOGER_SCOPE env var
2021-04-07 20:28:45 +00:00
scope: "squashed"
# skip searching a file entirely if it is above the given size (default = 1MB; unit = bytes)
2021-04-09 12:56:01 +00:00
# SYFT_FILE_CONTENTS_SKIP_FILES_ABOVE_SIZE env var
2021-04-07 20:28:45 +00:00
skip-files-above-size: 1048576
# file globs for the cataloger to match on
2021-04-09 12:56:01 +00:00
# SYFT_FILE_CONTENTS_GLOBS env var
2021-04-07 20:28:45 +00:00
globs: []
2021-03-18 14:58:47 +00:00
# cataloging file metadata is exposed through the power-user subcommand
2021-03-18 12:53:31 +00:00
file-metadata:
2021-03-20 11:33:13 +00:00
cataloger:
# enable/disable cataloging of file metadata
# SYFT_FILE_METADATA_CATALOGER_ENABLED env var
enabled: true
2021-05-06 16:26:03 +00:00
2021-03-20 11:33:13 +00:00
# the search space to look for file metadata (options: all-layers, squashed)
# SYFT_FILE_METADATA_CATALOGER_SCOPE env var
scope: "squashed"
2021-05-06 16:26:03 +00:00
2021-03-18 12:53:31 +00:00
# the file digest algorithms to use when cataloging files (options: "sha256", "md5", "sha1")
2021-03-18 14:58:47 +00:00
# SYFT_FILE_METADATA_DIGESTS env var
2021-03-18 12:53:31 +00:00
digests: ["sha256"]
2023-01-11 20:18:02 +00:00
# maximum number of workers used to process the list of package catalogers in parallel
parallelism: 1
2021-04-01 21:34:15 +00:00
# cataloging secrets is exposed through the power-user subcommand
secrets:
cataloger:
# enable/disable cataloging of secrets
# SYFT_SECRETS_CATALOGER_ENABLED env var
enabled: true
# the search space to look for secrets (options: all-layers, squashed)
# SYFT_SECRETS_CATALOGER_SCOPE env var
scope: "all-layers"
# show extracted secret values in the final JSON report
# SYFT_SECRETS_REVEAL_VALUES env var
reveal-values: false
2021-04-07 20:28:45 +00:00
# skip searching a file entirely if it is above the given size (default = 1MB; unit = bytes)
2021-04-01 21:34:15 +00:00
# SYFT_SECRETS_SKIP_FILES_ABOVE_SIZE env var
2021-04-07 20:28:45 +00:00
skip-files-above-size: 1048576
2021-04-01 21:34:15 +00:00
# name-regex pairs to consider when searching files for secrets. Note: the regex must match single line patterns
# but may also have OPTIONAL multiline capture groups. Regexes with a named capture group of "value" will
2021-05-06 16:26:03 +00:00
# use the entire regex to match, but the secret value will be assumed to be entirely contained within the
2021-04-01 21:34:15 +00:00
# "value" named capture group.
additional-patterns: {}
2021-05-06 16:26:03 +00:00
# names to exclude from the secrets search, valid values are: "aws-access-key", "aws-secret-key", "pem-private-key",
# "docker-config-auth", and "generic-api-key". Note: this does not consider any names introduced in the
2021-04-01 21:34:15 +00:00
# "secrets.additional-patterns" config option.
# SYFT_SECRETS_EXCLUDE_PATTERN_NAMES env var
exclude-pattern-names: []
2021-04-13 13:30:57 +00:00
# options when pulling directly from a registry via the "registry:" scheme
registry:
# skip TLS verification when communicating with the registry
# SYFT_REGISTRY_INSECURE_SKIP_TLS_VERIFY env var
insecure-skip-tls-verify: false
2021-08-17 16:52:51 +00:00
# use http instead of https when connecting to the registry
# SYFT_REGISTRY_INSECURE_USE_HTTP env var
insecure-use-http: false
2021-04-13 13:30:57 +00:00
# credentials for specific registries
auth:
2022-01-21 14:15:22 +00:00
# the URL to the registry (e.g. "docker.io", "localhost:5000", etc.)
2021-04-13 13:30:57 +00:00
# SYFT_REGISTRY_AUTH_AUTHORITY env var
2022-01-21 14:15:22 +00:00
- authority: ""
2021-04-13 13:30:57 +00:00
# SYFT_REGISTRY_AUTH_USERNAME env var
username: ""
# SYFT_REGISTRY_AUTH_PASSWORD env var
password: ""
# note: token and username/password are mutually exclusive
# SYFT_REGISTRY_AUTH_TOKEN env var
token: ""
2022-01-21 14:15:22 +00:00
# - ... # note, more credentials can be provided via config file only
2021-04-13 13:30:57 +00:00
2022-02-23 02:45:12 +00:00
# generate an attested SBOM
attest:
# path to the private key file to use for attestation
# SYFT_ATTEST_KEY env var
key: "cosign.key"
# password to decrypt to given private key
# SYFT_ATTEST_PASSWORD env var, additionally responds to COSIGN_PASSWORD
password: ""
2020-08-04 19:22:34 +00:00
log:
# use structured logging
2020-12-10 03:20:53 +00:00
# same as SYFT_LOG_STRUCTURED env var
2020-08-04 19:22:34 +00:00
structured: false
# the log level; note: detailed logging suppress the ETUI
2020-12-10 03:20:53 +00:00
# same as SYFT_LOG_LEVEL env var
2020-08-04 19:22:34 +00:00
level: "error"
# location to write the log file (default is not to have a log file)
2020-12-10 03:20:53 +00:00
# same as SYFT_LOG_FILE env var
2020-08-04 19:22:34 +00:00
file: ""
2021-05-06 16:26:03 +00:00
```
2022-01-24 15:04:57 +00:00
2022-02-23 02:45:12 +00:00
### Adding an SBOM to an image as an attestation using Syft
`syft attest --output [FORMAT] --key [KEY] [SOURCE] [flags]`
2022-03-25 15:36:43 +00:00
SBOMs themselves can serve as input to different analysis tools. [Grype ](https://github.com/anchore/grype ), a vulnerability scanner CLI tool from Anchore, is one such tool. Publishers of container images can use attestations to enable their consumers to trust Syft-generated SBOM descriptions of those container images. To create and provide these attestations, image publishers can run `syft attest` in conjunction with the [cosign ](https://github.com/sigstore/cosign ) tool to attach SBOM attestations to their images.
2022-01-24 15:04:57 +00:00
2022-03-25 15:36:43 +00:00
#### Example attestation
2022-06-08 21:39:22 +00:00
Note for the following example replace `docker.io/image:latest` with an image you own. You should also have push access to
2022-03-25 15:36:43 +00:00
its remote reference. Replace `$MY_PRIVATE_KEY` with a private key you own or have generated with cosign.
2022-01-24 15:04:57 +00:00
```bash
2022-10-29 20:18:53 +00:00
syft attest --key $MY_PRIVATE_KEY -o spdx-json docker.io/image:latest > image_latest_sbom_attestation.json
2022-02-23 02:45:12 +00:00
cosign attach attestation --attestation image_latest_sbom_attestation.json docker.io/image:latest
2022-01-24 15:04:57 +00:00
```
2022-03-25 15:36:43 +00:00
Verify the new attestation exists on your image.
2022-01-24 15:04:57 +00:00
```bash
2022-10-29 20:18:53 +00:00
cosign verify-attestation --key $MY_PUBLIC_KEY --type spdxjson docker.io/image:latest | jq '.payload | @base64d | .payload | fromjson | .predicate'
2022-01-24 15:04:57 +00:00
```
2022-03-25 15:36:43 +00:00
You should see this output along with the attached SBOM:
2022-01-24 15:04:57 +00:00
```
2022-02-23 02:45:12 +00:00
Verification for docker.io/image:latest --
2022-01-24 15:04:57 +00:00
The following checks were performed on each of these signatures:
- The cosign claims were validated
- The signatures were verified against the specified public key
- Any certificates were verified against the Fulcio roots.
```
Consumers of your image can now trust that the SBOM associated with your image is correct and from a trusted source.
2022-10-29 20:18:53 +00:00
The SBOM can be piped to Grype:
```bash
cosign verify-attestation --key $MY_PUBLIC_KEY --type spdxjson docker.io/image:latest | jq '.payload | @base64d | .payload | fromjson | .predicate' | grype
```