Skip to content

Commit

Permalink
doc: update notation sign and verify spec for metadata (notaryproject…
Browse files Browse the repository at this point in the history
…#498)

Spec update to support notaryproject/roadmap#67

`notation sign`:
- user will be able to specify additional key value pairs with the `--user-metadata` flag (`-um` short) that will be signed as part of the payload.

`notation verify`:
- user will be able to specify additional key value pairs with the `--user-metadata` flag (`-um` short) that must be present in the signature to pass verification.

Signed-off-by: Byron Chien <chienb@amazon.com>
  • Loading branch information
byronchien authored and Pritesh Bandi committed Feb 1, 2023
1 parent cb907d6 commit a11250e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions specs/commandline/sign.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ notation sign <registry>/<repository>@<digest>
### Sign an OCI Artifact with user metadata

```shell
# Prerequisites:
# Prerequisites:
# A default signing key is configured using CLI "notation key"

# sign an artifact stored in a registry and add user-metadata io.wabbit-networks.buildId=123 to the payload
Expand Down Expand Up @@ -165,7 +165,7 @@ notation sign --image-spec v1.1-image <registry>/<repository>@<digest>
```

[oci-artifact-manifest]: https://github.com/opencontainers/image-spec/blob/v1.1.0-rc2/artifact.md
[oci-image-spec]: https://github.com/opencontainers/image-spec/blob/v1.1.0-rc2/spec.md
[oci-image-spec]: https://github.com/opencontainers/image-spec/blob/v1.1.0-rc2/spec.md
[oci-backward-compatibility]: https://github.com/opencontainers/distribution-spec/blob/v1.1.0-rc1/spec.md#backwards-compatibility
[registry-support]: https://notaryproject.dev/docs/registrysupport/
[oras-land]: https://oras.land/

0 comments on commit a11250e

Please sign in to comment.