kosli attest sbom

Synopsis

kosli attest sbom [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags]

Report a software bill of materials to an artifact or a trail in a Kosli flow.
The SBOM file is given with the --sbom-file flag. CycloneDX (JSON and XML) and SPDX (JSON and tag-value) are supported. The file is uploaded as it is, so the recorded checksum is the checksum of the file you supplied and you can verify it by hand. It must be a single file: it is not compressed, and a gzipped file is rejected, because the format and the summary below are read from it. Kosli reads the format, the creation time, the tools that produced it, the subject it describes and how many packages it lists. A plain SBOM file is not checked against the artifact; it is recorded as reported. The SBOM may also arrive inside an in-toto attestation, as a Sigstore bundle or a DSSE envelope. The SPDX or CycloneDX document is then read from it, and the bundle or envelope is what is uploaded and checksummed. When the artifact’s fingerprint is known, because it is calculated from the artifact or given with --fingerprint, the attestation must list that artifact as its subject, signed or not. When the attestation is bound by the artifact’s template name and commit instead, or to the trail alone, there is no fingerprint to check the subject against, so it is not checked. To verify its signature, pass --certificate-identity (or --certificate-identity-regexp) with --certificate-oidc-issuer, or --key. Without them the signature is not checked, and even a signed bundle is recorded with verified set to false. The record is annotated with verified and the verification details, as kosli attest in-toto annotates it. To pick the SBOM from a file holding several attestations, or to record provenance, use kosli attest in-toto. Verifying a certificate-signed attestation needs the trust root of the Sigstore instance that signed it: Sigstore’s public-good instance, or GitHub’s own, which signs attestations for private repositories. It is fetched over TUF on every run that verifies one, from https://tuf-repo-cdn.sigstore.dev or https://tuf-repo.github.com respectively, and cached under ~/.sigstore, so the runner needs outbound HTTPS to that host and a writable ~/.sigstore directory. A key-signed attestation needs neither, unless it carries a transparency log entry or a signed timestamp, which are checked against Sigstore’s public-good trust root. An unsigned attestation needs neither. The SBOM file is the only attachment: this command does not accept additional attachments, because two or more would be compressed together. The format and the file checksum are also added as the sbom_format and sbom_sha256 annotations. The attestation can be bound to a trail using the trail name. The attestation can be bound to an artifact in two ways:

using the artifact’s SHA256 fingerprint which is calculated (based on the --artifact-type flag and the artifact name/path argument) or can be provided directly (with the --fingerprint flag).
using the artifact’s name in the flow yaml template and the git commit from which the artifact is/will be created. Useful when reporting an attestation before creating/reporting the artifact.

To specify paths in a directory artifact that should always be excluded from the SHA256 calculation, you can add a .kosli_ignore file to the root of the artifact. Each line should specify a relative path or path glob to be ignored. You can include comments in this file, using #. The .kosli_ignore file is always treated as part of the artifact: its own entries cannot exclude it, so the exclusion list cannot be changed without changing the fingerprint. Paths the list already matches stay excluded whatever is later added there, so keep its entries as narrow as possible. Excluding the file with --exclude keeps it out of the fingerprint but still applies the paths it lists, which lets a writable directory change the list again. To drop the file from the fingerprint safely, move its entries to --exclude and delete it. You can optionally associate the attestation to a git commit using --commit. The commit is read from the git repository at --repo-root, which must be the repository’s top-level directory. Without --commit, no git repository is needed. If --commit is only defaulted from CI and --repo-root is left at ., a missing repository or commit prints a warning and the attestation is sent without commit info. Note that when the attestation is reported for an artifact that does not yet exist in Kosli, --commit is required to facilitate binding the attestation to the right artifact. You can optionally redact some of the git commit data sent to Kosli using --redact-commit-info. To record repository information, all three of --repo-id, --repo-url, and --repository must be set together. These are automatically set in GitHub Actions, GitLab CI, Bitbucket Pipelines, and Azure DevOps. In other CI systems, set them explicitly to capture repository metadata.

Flags

Flag	Type	Description
`--annotate`	stringToString	[optional] Annotate the attestation with data using key=value.
`-t`, `--artifact-type`	string	The type of the artifact to calculate its SHA256 fingerprint. One of: [oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don’t specify ‘`--fingerprint`’ on commands that allow it).
`--certificate-identity`	string	[conditional] The identity a signed attestation’s certificate must name, such as a GitHub workflow URL. Use with `--certificate-oidc-issuer`.
`--certificate-identity-regexp`	string	[conditional] A regular expression the identity in a signed attestation’s certificate must match. Use instead of `--certificate-identity`, with `--certificate-oidc-issuer`.
`--certificate-oidc-issuer`	string	[conditional] The OIDC issuer a signed attestation’s certificate must name, such as https://token.actions.githubusercontent.com.
`-g`, `--commit`	string	[conditional] The git commit for which the attestation is associated to. Becomes required when reporting an attestation for an artifact before reporting it to Kosli. (defaulted in some CIs: docs ). If both `--commit` and `--repo-root` are left at their defaults and the commit cannot be read from the repository, a warning is printed and the attestation is sent without commit info.
`--description`	string	[optional] attestation description
`-D`, `--dry-run`	bool	[optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors.
`-x`, `--exclude`	strings	[optional] The comma separated list of directories and files to exclude from fingerprinting. Can take glob patterns. Only applicable for `--artifact-type` dir.
`--external-fingerprint`	stringToString	[optional] A SHA256 fingerprint of an external attachment represented by `--external-url`. The format is label=fingerprint (labels cannot contain ’.’ or ’=’). This flag can be set multiple times. There must be an external url with a matching label for each external fingerprint.
`--external-url`	stringToString	[optional] Add labeled reference URL for an external resource. The format is label=url (labels cannot contain ’.’ or ’=’). This flag can be set multiple times. If the resource is a file or dir, you can optionally add its fingerprint via `--external-fingerprint`
`-F`, `--fingerprint`	string	[conditional] The SHA256 fingerprint of the artifact to attach the attestation to. Only required if the attestation is for an artifact and `--artifact-type` and artifact name/path are not used.
`-f`, `--flow`	string	The Kosli flow name.
`-h`, `--help`	bool	help for sbom
`--key`	string	[conditional] The path to a PEM public key, to verify an attestation signed with a key rather than a certificate.
`-n`, `--name`	string	The name of the attestation as declared in the flow or trail yaml template.
`-o`, `--origin-url`	string	[optional] The url pointing to where the attestation came from or is related. (defaulted to the CI url in some CIs: docs ).
`--redact-commit-info`	strings	[optional] The list of commit info to be redacted before sending to Kosli. Allowed values are one or more of [author, message, branch].
`--registry-password`	string	[conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry and it is not already accessible via Docker/Podman auth files or a credential helper.
`--registry-provider`	string	[deprecated] The docker registry provider or url. Only required if you want to read docker image SHA256 digest from a remote docker registry. (DEPRECATED: no longer used)
`--registry-username`	string	[conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry and it is not already accessible via Docker/Podman auth files or a credential helper.
`--repo-id`	string	[conditional] The stable, unique identifier for the repository in your VCS provider (e.g. a numeric ID). Do not use the repository name as it can change if the repo is renamed. All three of `--repo-id`, `--repo-url` and `--repository` must be set to record repository information (defaulted in some CIs: docs ).
`--repo-provider`	string	[optional] The source code hosting provider. One of: github, gitlab, bitbucket, bitbucket_cloud, bitbucket_dc, azure-devops, azure_devops_services, azure_devops_server, git, subversion (defaulted in some CIs: docs ).
`--repo-root`	string	[defaulted] The directory where the source git repository is available. It must be the repository’s top-level directory. Only used if `--commit` is used or defaulted in CI, see docs . (default ”.”)
`--repo-url`	string	[conditional] The URL of the repository. Must be a valid URL. All three of `--repo-id`, `--repo-url` and `--repository` must be set to record repository information (defaulted in some CIs: docs ).
`--repository`	string	[conditional] The name of the repository (e.g. owner/repo-name). All three of `--repo-id`, `--repo-url` and `--repository` must be set to record repository information (defaulted in some CIs: docs ).
`--sbom-file`	string	The path to the SBOM file. CycloneDX (JSON, XML) and SPDX (JSON, tag-value) are supported, also inside an in-toto attestation in a Sigstore bundle or DSSE envelope.
`-T`, `--trail`	string	The Kosli trail name.
`-u`, `--user-data`	string	[optional] The path to a JSON file containing additional data you would like to attach to the attestation. The maximum JSON payload size is 1MB.

Flags inherited from parent commands

Flag	Type	Description
`-a`, `--api-token`	string	The Kosli API token.
`-c`, `--config-file`	string	[optional] The Kosli config file path. Config is read from this path or the default only, never implicitly from the current directory. (default “$HOME/.kosli.yml”)
`--debug`	bool	[optional] Print debug logs to stdout.
`-H`, `--host`	string	[defaulted] The Kosli endpoint. (default “https://app.kosli.com”)
`--http-proxy`	string	[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`
`-r`, `--max-api-retries`	int	[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)
`--org`	string	The Kosli organization.
`-q`, `--quiet`	bool	[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both `--quiet` and `--debug` are set, `--debug` wins.

Examples Use Cases

These examples all assume that the flags --api-token, --org, --host, (and --flow, --trail when required), are set/provided.

report an SBOM about a pre-built docker artifact (kosli finds the fingerprint)

kosli attest sbom yourDockerImageName 
	--artifact-type docker 
	--name yourAttestationName 
	--sbom-file yourSbomPath 

report an SBOM signed into a Sigstore bundle, verifying who signed it

kosli attest sbom yourDockerImageName 
	--artifact-type docker 
	--name yourAttestationName 
	--sbom-file yourSbom.sigstore.json 
	--certificate-identity https://github.com/yourOrg/yourRepo/.github/workflows/build.yml@refs/heads/main 
	--certificate-oidc-issuer https://token.actions.githubusercontent.com 

report an SBOM about a trail

kosli attest sbom 
	--name yourAttestationName 
	--sbom-file yourSbomPath 

General

Top-level commands

kosli allow

kosli archive

kosli assert

kosli attest

kosli begin

kosli create

kosli delete

kosli diff

kosli disable / enable

kosli dismiss

kosli evaluate

kosli get

kosli join

kosli list

kosli log

kosli publish

kosli rename

kosli report

kosli rotate

kosli snapshot

kosli unarchive

kosli update

Synopsis

Flags

Flags inherited from parent commands

Examples Use Cases