Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create and verify dsse evidence with intotot attestation documentation #108

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 90 additions & 0 deletions jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/evidence.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# Evidence

## Overview

This page describes how to use JFrog CLI with [Evidence](https://jfrog.com/help/r/jfrog-artifactory-documentation/promote-a-release-bundle-v2-to-a-target-environment).

***

**Note**

> JFrog CLI enables creation for custom evidence.

> For now, an evidence can be signed and verified with one key only.

> Evidence is only available with [Artifactory 7.xx.x](https://jfrog.com/help/r/jfrog-release-information/artifactory-7.63.2-cloud) or above.

***

## Syntax

When used with JFrog Evidence, JFrog CLI uses the following syntax:

```
jf evd attest --predicate file-path --predicate-type predicate-type-uri --subjects <target-path[@digest];[target-path[@digest]]> --key <local-private-key-path> [--name <evidence-name>] [--override]
```

### **Command parameters**

1. `--predicate` file-path

Mandatory field.
Is the path to a locally stored json file which contains the predicates
```json
{
// any kind of a valid json
}
```
2. `--predicate-type` predicate-type-uri

Mandatory field.
The uri of the predicate type, ie:

https://in-toto.io/attestation/link/v0.3
https://in-toto.io/attestation/scai/attribute-report
https://in-toto.io/attestation/runtime-trace/v0.1
https://in-toto.io/attestation/test-result/v0.1
https://in-toto.io/attestation/vulns


3. `--subjects` target-path[@digets][;]other-target-path[@digets]


Mandatory field.

A semicolon(;) separated list.

Must include path.

Digest (sha256) is optional.

If digest provided it is verified against the paths sha256 in artifactory.

If digest is not provided sha256 is taken from the path in artifactory.


4. `--key` local-private-key-path

Mandatory path for a private key.

Supported keys are:

`rsa`
`ed25519`
`ecdsa`

5. `--name`

Optional field.

If name is provided it will be saved in artifactory with the provided name (including .json.evd suffix).

If name is not provided it will be saved in artifactory with the default name evidence.json.evd

6. `--override`

Optional field.

If `--override` param is provided then the to be saved evidence will be saved on artifactory regardless if the file exists.

If `--override` param is not provided then the to be saved evidence will fail to be saved if a file with the same name already exists on artifactory.
Loading