From c9b4b9e55e6a9843219c7f53d5d456209f869c04 Mon Sep 17 00:00:00 2001 From: Diogo Teles Sant'Anna Date: Wed, 16 Nov 2022 16:49:10 -0300 Subject: [PATCH] docs(generic-generator): clarify that created provenance is encapsulated After exposing the expected provenance format, clarify that the actual result will be encapsulated in a DSSA envelope and encoded in base64. Also includes quick command to decode the human readable JSON. Closes #1186 Signed-off-by: Diogo Teles Sant'Anna --- internal/builders/generic/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/internal/builders/generic/README.md b/internal/builders/generic/README.md index 23eb8307e4..bd3b4ca867 100644 --- a/internal/builders/generic/README.md +++ b/internal/builders/generic/README.md @@ -241,6 +241,8 @@ The project generates SLSA provenance with the following values. | `buildType` | `"https://github.com/slsa-framework/slsa-github-generator/generic@v1"` | Identifies a generic GitHub Actions build. | | `metadata.buildInvocationID` | `"[run_id]-[run_attempt]"` | The GitHub Actions [`run_id`](https://docs.github.com/en/actions/learn-github-actions/contexts#github-context) does not update when a workflow is re-run. Run attempt is added to make the build invocation ID unique. | +**Note**: The generated provenance will probably be wrapped in a [DSSE](https://github.com/secure-systems-lab/dsse) envelope and encoded in base64. Check the human-readable result running `cat encoded-artifact.intoto.jsonl | jq -r '.payload' | base64 -d | jq`. + ### Provenance Example The following is an example of the generated provenance. Provenance is