From a6ef54591ccbc2d03db8486ef854fa016cbbc634 Mon Sep 17 00:00:00 2001 From: Ron <45816308+rjaegers@users.noreply.github.com> Date: Wed, 8 Jan 2025 13:05:11 +0000 Subject: [PATCH] docs: added new verification commands --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 037f89b2..f538374e 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,8 @@ Both containers can be used in Visual Studio Code or GitHub Codespaces without a ### Verify image signature +
Prior to version 5.6.0 + The container images are signed with [SigStore](https://www.sigstore.dev/) [Cosign](https://docs.sigstore.dev/cosign/signing/overview/) using a keyless signing method. The signature can be [verified](https://docs.sigstore.dev/cosign/verifying/verify/) with the following command (using Docker), verifying that the image is actually signed by the GitHub CI system: @@ -69,12 +71,33 @@ docker run --rm gcr.io/projectsigstore/cosign verify ghcr.io/philips-software/am docker run --rm gcr.io/projectsigstore/cosign verify ghcr.io/philips-software/amp-devcontainer-rust --certificate-oidc-issuer https://token.actions.githubusercontent.com --certificate-identity-regexp https://github.com/philips-software/amp-devcontainer ``` +
+ +The container images are signed using the [attest-build-provenance](https://github.com/actions/attest-build-provenance) action. + +The attestations can be checked with the following command, verifying that the image is actually built by the GitHub CI system: + +> amp-devcontainer-cpp + +```sh +gh attestation verify --repo philips-software/amp-devcontainer oci://ghcr.io/philips-software/amp-devcontainer-cpp +``` + +> amp-devcontainer-rust + +```sh +gh attestation verify --repo philips-software/amp-devcontainer oci://ghcr.io/philips-software/amp-devcontainer-rust +``` + +### Local development + The resulting containers can be used in a `.devcontainer.json` file or in a `.devcontainer` folder. > [!NOTE] > While the following examples use the `latest` tag, it is recommended to pin to a specific version. Or better yet, a specific SHA. +> See the [releases](https://github.com/philips-software/amp-devcontainer/releases) for the SHA corresponding to a specific release. -### amp-devcontainer-cpp +#### amp-devcontainer-cpp > .devcontainer/devcontainer.json or .devcontainer.json @@ -84,7 +107,7 @@ The resulting containers can be used in a `.devcontainer.json` file or in a `.de } ``` -### amp-devcontainer-rust +#### amp-devcontainer-rust > .devcontainer/devcontainer.json or .devcontainer.json