docs: add release image signing guidance #129
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,7 @@ Refer to vulerability management and release documentation [here](https://github | |
|
|
||
| ## Signature Validation | ||
|
|
||
| Ratify signs all release images, dev images, and dev helm OCI artifacts with Notary Project and Sigstore Cosign signatures. | ||
|
|
||
| ### Verifying Notary Project Signature | ||
|
|
||
|
|
@@ -24,6 +24,9 @@ cat <<EOF > ./trustpolicy.json | |
| { | ||
| "name": "ratify-images", | ||
| "registryScopes": [ | ||
| "ghcr.io/ratify-project/ratify", | ||
| "ghcr.io/ratify-project/ratify-base", | ||
| "ghcr.io/ratify-project/ratify-crds", | ||
| "ghcr.io/ratify-project/ratify-dev", | ||
| "ghcr.io/ratify-project/ratify-base-dev", | ||
| "ghcr.io/ratify-project/ratify-crds-dev", | ||
|
|
@@ -41,11 +44,11 @@ cat <<EOF > ./trustpolicy.json | |
| } | ||
| EOF | ||
| notation policy import ./trustpolicy.json | ||
| notation verify ghcr.io/ratify-project/ratify:v1.4.0 | ||
| notation verify ghcr.io/ratify-project/ratify-dev:latest | ||
| ``` | ||
|
|
||
| Sample output of `verify` for ratify dev image: | ||
|
|
||
| ```shell | ||
| Warning: Always verify the artifact using digest(@sha256:...) rather than a tag(:latest) because resolved digest may not point to the same signed artifact, as tags are mutable. | ||
|
|
@@ -60,21 +63,21 @@ A keyless signature is published per image. The signature is uploaded to the Rek | |
|
|
||
| ```shell | ||
| cosign verify \ | ||
| --certificate-identity-regexp "https://github.com/ratify-project/ratify/.github/workflows/publish-package.yml@*" \ | ||
| --certificate-oidc-issuer https://token.actions.githubusercontent.com \ | ||
| --certificate-github-workflow-repository ratify-project/ratify \ | ||
| ghcr.io/ratify-project/ratify:v1.4.0 | ||
|
There was a problem hiding this comment. Get answered above. |
||
| ``` | ||
|
|
||
| ```shell | ||
| cosign verify \ | ||
| --certificate-identity "https://github.com/ratify-project/ratify/.github/workflows/publish-dev-assets.yml@refs/heads/dev" \ | ||
| --certificate-oidc-issuer https://token.actions.githubusercontent.com \ | ||
| --certificate-github-workflow-repository ratify-project/ratify \ | ||
| ghcr.io/ratify-project/ratify-dev:latest | ||
| ``` | ||
|
|
||
| Sample output of verifcation of ratify dev image: | ||
|
|
||
| ```shell | ||
| Verification for ghcr.io/ratify-project/ratify-dev:latest -- | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just curious about that, since
v1.4.0is not released shall we go with the latest versionv1.3.1instead?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was thinking that updates to the docs here are for the
nextversion on the website, which corresponds to unreleased changes. The current v1.3.1 release is not signed so we don't want to give that as an example. When v1.4.0 is released, the published release images will be signed and match the docs.