Add user-facing doc "SLSA Provenance"

Fixes #786 The doc includes instruction on how to configure a pipeline/task so that Tekton Chains can generate provenance properly. Signed-off-by: Chuang Wang <[email protected]>
tektoncd · Oct 5, 2023 · c4f3956 · c4f3956
1 parent e0c67ae
commit c4f3956
Show file tree

Hide file tree

Showing 4 changed files with 328 additions and 501 deletions.
diff --git a/docs/config.md b/docs/config.md
@@ -10,37 +10,8 @@ weight: 20
 `Chains` works by observing `TaskRun` and `PipelineRun` executions, capturing relevant information, and storing it in a cryptographically-signed format.
 
 `TaskRuns` and `PipelineRuns` can indicate inputs and outputs which are then captured and surfaced in the `Chains` payload formats, where relevant.
-`Chains` uses the standard mechanisms (`Results` and `PipelineResources`) where possible, and provides a few other mechanisms to *hint* at the correct inputs and outputs. These are outlined below:
+`Chains` uses the `Results` to *hint* at the correct inputs and outputs. Check out [how-to-chain-with-pipeline.md](how-to-chain-with-pipeline.md) for more details.
 
-## Chains Type Hinting
-
-When outputting an OCI image without using a `PipelineResource`, `Chains` will look for the following Results:
-
-* `*IMAGE_URL` - The URL to the built OCI image
-* `*IMAGE_DIGEST` - The Digest of the built OCI image
-
-where `*` indicates any expression.
-For example, if **both** `MYIMAGE_IMAGE_URL` AND `MYIMAGE_IMAGE_DIGEST` are correctly formatted to point to an OCI image, then `chains` will pick up on it and try to sign the image.
-
-Multiple images can be specified by using different prefixes in place of `*`.
-
-Multiple images can also be specified by using the `IMAGES` Result.
-The value of the `IMAGES` result is a list of images, each qualified by digest.
-The list of images can be separated by commas or by newlines.
-
-```shell
-- name: IMAGES
-  value: img1@sha256:digest1, img2@sha256:digest2
-```
-
-When processing a `TaskRun`, Chains will parse through the list, then sign and attest each image.
-When processing a `PipelineRun`, Chains will only attest each image. Thus, if both `TaskRun` and
-`PipelineRun` produce type hint results, each image will have one signature and two attestations.
-
-For in-toto attestations, see [intoto.md](intoto.md) for description
-of in-toto specific type hinting.
-
-Note that these are provided automatically when using `PipelineResources`.
 
 ## Chains Configuration
 

diff --git a/docs/how-to-chain-with-pipeline.md b/docs/how-to-chain-with-pipeline.md
@@ -0,0 +1,327 @@
+<!--
+linkTitle: "SLSA Provenance"
+weight: 40
+---
+-->
+
+# SLSA Provenance
+
+## Goal
+
+This doc includes instructions for how to configure a Tekton Pipeline/Task
+so that Tekton Chains can generate SLSA provenances properly.
+
+## Glossary
+
+- **_SLSA_**: SLSA stands for Supply-chain Levels for Software Artifacts, or SLSA ("salsa"). It’s a security framework, a checklist of standards and controls to prevent tampering, improve integrity, and secure packages and infrastructure. It’s how you get from "safe enough" to being as resilient as possible, at any link in the chain. ([source](https://slsa.dev/))
+- **_Attestation_** ([in-toto attestation](https://github.com/in-toto/attestation/blob/main/spec/README.md)): An in-toto attestation is authenticated metadata about one or more software artifacts. The intended consumers are automated policy engines, such as in-toto-verify and Binary Authorization. There are [a variety of attestations](https://github.com/in-toto/attestation/tree/main/spec/predicates), and the type of attestation is determined by the [predicate](https://github.com/in-toto/attestation/blob/main/spec/v1/predicate.md).
+- **_SLSA Provenance_**: [SLSA Provenance](https://slsa.dev/spec/v1.0/provenance) is an attestation that a build platform generated to describe how an artifact or set of artifacts was produced.
+- **_Pipeline-level provenance_**: Provenance that Tekton Chains generates to cover the whole picture of the PipelineRun execution.
+- **_Task-level provenance_**: Provenance that Tekton Chains generates to only include the details of a particular TaskRun execution. It's particularly needed for a standalone TaskRun that is not spawned by a PipelineRun. By contrast, if it's a child TaskRun of a PipelineRun, Task-level provenance will miss the details of other TaskRuns within that Pipeline.
+- **_Input Artifacts_**: A canonical term used in this doc to refer to the artifacts that influenced the build process such as source code repository, dependencies and so on. It's mapped to `resolvedDependences` field in SLSA v1.0, and mapped to `materials` field in SLSA v0.1 & v0.2.
+- **_Output Artifacs_**: A canonical term used in this doc to refer to the artifacts that the build process produced i.e. an OCI image. This is mapped to `Subjects` field in all SLSA versions.
+- **_`Results`_**: `Results` are Tekton API fields that authors can use to emit some information after a TaskRun/PipelineRun is complete. `Results` can be used to pass along information to different tasks within a pipeline or aggregate different task results to a pipeline result. Check out [Tekton official doc](https://tekton.dev/docs/pipelines/pipelines/#using-results) more information. _Note: API result field is completely different from [Tekton Results Operator](https://tekton.dev/docs/results/)_.
+- **_Type hinting_**: Refer to specially named results/params that aim to enable Tekton Chains to understand the input artifacts and outputs of a PipelineRun/TaskRun.
+
+## How does Tekton Chains work?
+
+Tekton Chains works by reconciling the run of a task or a pipeline. Once the run is observed as `completed`, Tekton Chains will take a snapshot of the completed TaskRun/PipelineRun, and start its core works in the order of **_`formatting`_** (generate provenance json) -> **_`signing`_** (sign the payload using the key configured by user) -> **_`uploading`_** (upload the provenance and its signature to the storage configured by user).
+
+![](../images/how-chains-works.png)
+
+## How to configure Tekton Chains
+
+Tekton Chains supports both SLSA v0.2 and v1.0 provenance for both task-level and pipeline-level provenance.
+
+The following shows the mapping between slsa version and formatter name.
+
+| SLSA Version | Formatter Name         |
+| ------------ | ---------------------- |
+| v1.0         | `slsa/v2alpha2`        |
+| v0.2         | `slsa/v1` or `in-toto` |
+
+To configure Task-level provenance version
+
+```shell
+kubectl patch configmap chains-config -n tekton-chains -p='{"data":{"artifacts.taskrun.format": "slsa/v1"}}'
+```
+
+To configure Pipeline-level provenance version
+
+```shell
+kubectl patch configmap chains-config -n tekton-chains -p='{"data":{"artifacts.pipelinerun.format": "slsa/v1"}}'
+```
+
+> Note:\
+> While Chains is able to generate both task-level and pipeline-level provenance at the same time, it's not recommended to upload both to a storage backend because it would be confusing to have 2 different provenances for the same artifact.\
+> To disable Task-level provenance, simply config empty string `""` as the storage backend
+>
+> ```shell
+> kubectl patch configmap chains-config -n tekton-chains -p='> {"data":{"artifacts.taskrun.storage": ""}}'
+> ```
+>
+> To disable Pipeline-level provenance, simply config empty string `""` as the storage backend
+>
+> ```shell
+> kubectl patch configmap chains-config -n tekton-chains -p='> {"data":{"artifacts.pipelinerun.storage": ""}}'
+> ```
+
+## How to configure a Task or Pipeline
+
+As mentioned in the [Glossary](#glossary), SLSA provenance describes the build process of a particular artifact being produced. While Tekton Chains is able to capture the build process regardless of how the pipeline was configured, it is mandatory to signal Chains what the output and input artifacts are in the pipeline config. The way to do that is through the type hinting.
+
+- Task-level Provenance: The type hinting carrying the references of input/output artifacts should be defined in the TaskSpec.
+- Pipeline-level Provenance: The type hinting carrying the references of input/output artifacts can be defined either:
+  - in the PipelineSpec
+  - in the TaskSpec. However, in this case, the feature flag [`artifacts.pipelinerun.enable-deep-inspection`](config.md#pipelinerun-configuration) must be enabled to instruct Chains to dive deep into each child TaskRuns to look for type-hinting.
+
+## Type Hinting
+
+Type hinting is a way to let Chains to understand the input and output artifacts throughout a PipelineRun. Chains expects different type hinting names for inputs and outputs. However, both input and output artifacts should have the uri and digest components, which is the common thing in the following type hinting list.
+
+### Input Artifacts
+
+Input artifacts can be defined either in `params` or `results` using one of following options.
+
+It's worth noting that the value for the digest component needs to be precise commit SHA. It can't be other mutable references i.e. tag, branch name and so on.
+
+#### Git Results
+
+In this approach, one can define the url of the source code repository and the precise commit sha digest in type hinting **_exactly named as `CHAINS-GIT_URL` and `CHAINS-GIT_COMMIT`_** respectively.
+
+<details>
+<summary>Example TaskRun</summary>
+
+```yaml
+apiVersion: tekton.dev/v1
+kind: TaskRun
+metadata:
+  name: git-clone
+spec:
+  taskSpec:
+    params:
+      - name: url
+        description: Repository URL to clone from.
+        type: string
+        default: "https://github.com/tektoncd/pipeline"
+      - name: revision
+        description: Revision to checkout. (branch, tag, sha, ref, etc...)
+        type: string
+        default: "main"
+    results:
+      - name: CHAINS-GIT_URL
+        type: string
+        description: The precise URL that was fetched by this Task.
+      - name: CHAINS-GIT_COMMIT
+        type: string
+        description: The precise commit SHA that was fetched by this Task.
+    steps:
+      - name: dummy-clone
+        image: bash:latest
+        script: |
+          #!/usr/bin/env bash
+          echo -n "https://github.com/tektoncd/pipeline" | tee $(results.CHAINS-GIT_URL.path)
+          echo -n "7f2f46e1b97df36b2b82d1b1d87c81b8b3d21601" | tee $(results.CHAINS-GIT_COMMIT.path)
+```
+
+</details>
+
+Note: This can be either params or results.
+
+- **_Param_**: To surface a git URL/commit as the input artifact, add a parameter named `CHAINS-GIT_COMMIT` and `CHAINS-GIT_URL`. The value of these
+  parameters should be fed by some VCS task (e.g like this
+  [task](https://github.com/tektoncd/catalog/blob/ee409b23543881457c2f35cbd630ea55732b1856/task/git-clone/0.9/git-clone.yaml#L112-L115)) so that the reported url and revision are guaranteed to be the one that was fetched.
+  A `PipeLine` example where another task `checkout` has URL/commit as
+  task results:
+
+  ```yaml
+  - name: build
+    params:
+      - name: CHAINS-GIT_COMMIT
+        value: "$(tasks.checkout.results.commit)"
+      - name: CHAINS-GIT_URL
+        value: "$(tasks.checkout.results.url)"
+  ```
+
+- **_Result_**: Alternatively, `CHAINS-GIT_COMMIT` and `CHAINS-GIT_URL` can be results instead.
+  Another `Pipeline` example where results are used:
+
+  ```yaml
+  spec:
+    results:
+      - description: Repository URL used for buiding the image.
+        name: CHAINS-GIT_URL
+        value: $(tasks.checkout.results.url)
+      - description: Repository commit used for building the image.
+        name: CHAINS-GIT_COMMIT
+        value: $(tasks.checkout.results.commit)
+    tasks:
+      - name: checkout
+  ```
+
+#### `*ARTIFACT_INPUTS`
+
+> Note:\
+> `*` indicates any expression
+
+In this approach, one can group the url of the source code repository and the precise commit sha into a single object type hinting. The object type hinting only needs to have the **_suffix `ARTIFACT_INPUTS`_** and have the 2 keys exactly named as `uri` and `digest`. This is particularly useful if there are multiple input artifacts. For example, one object type hinting can be `first_ARTIFACT_INPUTS` and another one is `second_ARTIFACT_INPUTS`.
+
+> Note:
+>
+> - The digest component must be in the format of `cryptographic hash algorithm name` + `:` + `a valid hex value` i.e. "sha1:7f2f46e1b97df36b2b82d1b1d87c81b8b3d21601".
+
+<details>
+<summary>Example TaskRun</summary>
+
+```yaml
+apiVersion: tekton.dev/v1
+kind: TaskRun
+metadata:
+  name: git-clone
+spec:
+  taskSpec:
+    params:
+      - name: url
+        description: Repository URL to clone from.
+        type: string
+        default: "https://github.com/tektoncd/pipeline"
+      - name: revision
+        description: Revision to checkout. (branch, tag, sha, ref, etc...)
+        type: string
+        default: "main"
+    results:
+      - name: source_repo_ARTIFACT_INPUTS
+        description: The source code repo artifact
+        type: object
+        properties:
+          uri: {}
+          digest: {}
+    steps:
+      - name: dummy-clone
+        image: bash:latest
+        script: |
+          #!/usr/bin/env bash
+          echo -n "{\"uri\":\"https://github.com/tektoncd/pipeline\", \"digest\":\"sha1:7f2f46e1b97df36b2b82d1b1d87c81b8b3d21601\"}" > $(results.source_repo_ARTIFACT_INPUTS.path)
+```
+
+</details>
+
+---
+
+### Output Artifacts
+
+Output artifacts should be defined in `results` only, using one of following options.
+
+#### `*IMAGE_URL` / `*IMAGE_DIGEST`
+
+In this approach, one can write the url and digest of an output OCI artifact into 2 results that have same prefix, but the one for url has suffix `IMAGE_URL` and the one for digest has suffix `IMAGE_DIGEST`.
+
+> Note:
+>
+> - The `IMAGE_URL` component must be a valid container repository URL.
+> - The `IMAGE_DIGEST` component must be in the format of `cryptographic hash algorithm name` + `:` + `a valid hex value` i.e. "sha256:586789aa031fafc7d78a5393cdc772e0b55107ea54bb8bcf3f2cdac6c6da51ee"
+
+<details>
+<summary>Example TaskRun</summary>
+
+```yaml
+apiVersion: tekton.dev/v1
+kind: TaskRun
+metadata:
+  name: image-build
+spec:
+  taskSpec:
+    results:
+      - name: first-image-IMAGE_URL
+        type: string
+        description: The precise URL of the OCI image built.
+      - name: first-image-IMAGE_DIGEST
+        type: string
+        description: The algorithm and digest of the OCI image built.
+    steps:
+      - name: dummy-build
+        image: bash:latest
+        script: |
+          #!/usr/bin/env bash
+          echo -n "gcr.io/foo/bar" | tee $(results.first-image-IMAGE_URL.path)
+          echo -n "sha256:586789aa031fafc7d78a5393cdc772e0b55107ea54bb8bcf3f2cdac6c6da51ee" | tee $(results.first-image-IMAGE_DIGEST.path)
+```
+
+</details>
+
+#### `IMAGES`
+
+Multiple images can also be specified by using a single `IMAGES` Result.
+The value of the `IMAGES` result is a list of images, each qualified by digest.
+The list of images can be separated by commas or by newlines.
+
+<details>
+<summary>Example TaskRun</summary>
+
+```yaml
+apiVersion: tekton.dev/v1
+kind: TaskRun
+metadata:
+  name: image-build
+spec:
+  taskSpec:
+    results:
+      - name: IMAGES
+        description: The multiple image artifacts
+        type: string
+    steps:
+      - name: dummy-build
+        image: bash:latest
+        script: |
+          #!/usr/bin/env bash
+          echo -n "img1@sha256:digest1, img2@sha256:digest2" | tee $(results.IMAGES.path)
+```
+
+</details>
+
+#### `*ARTIFACT_URI` / `*ARTIFACT_DIGEST`
+
+Similar to option 1 - `IMAGE_URL` and `IMAGE_DIGEST`, but just with different names.
+
+#### `*ARTIFACT_OUTPUTS`
+
+In this approach, one can group the url and digest of the output artifact a single object result. The object result only needs to have the **_suffix `ARTIFACT_OUTPUTS`_** and have the 2 keys exactly named as `uri` and `digest`. This is particularly useful if there are multiple artifacts produced throughout a task. For example, one object type hinting can be `first_ARTIFACT_OUTPUTS` and another one is `second_ARTIFACT_OUTPUTS`.
+
+> Note:
+>
+> - The digest component must be in the format of `cryptographic hash algorithm name` + `:` + `a valid hex value` i.e. "sha256:586789aa031fafc7d78a5393cdc772e0b55107ea54bb8bcf3f2cdac6c6da51ee".
+
+<details>
+<summary>Example TaskRun</summary>
+
+```yaml
+apiVersion: tekton.dev/v1
+kind: TaskRun
+metadata:
+  name: image-build
+spec:
+  taskSpec:
+    results:
+      - name: first-ARTIFACT_OUTPUTS
+        description: The first artifact built
+        type: object
+        properties:
+          uri: {}
+          digest: {}
+    steps:
+      - name: dummy-build
+        image: bash:latest
+        script: |
+          #!/usr/bin/env bash
+          echo -n "{\"uri\":\"gcr.io/foo/bar\", \"digest\":\"sha256:586789aa031fafc7d78a5393cdc772e0b55107ea54bb8bcf3f2cdac6c6da51ee\"}" > $(results.first-ARTIFACT_OUTPUTS.path)
+```
+
+</details>
+
+## Besides inputs/outputs
+
+Tekton Chains is also able to capture the feature flags being used for Tekton Pipelines controller and the origin of the build configuration file with immutable references such as task.yaml and pipeline.yaml. However, those fields in Tekton Pipelines are gated by a dedicated feature flag. Therefore, the feature flag needs to be enabled to let Tekton Pipelines controller to populate these fields.
+
+```shell
+kubectl patch -n tekton-pipelines configmap feature-flags -p '{"data":{"enable-provenance-in-status":"true"}}'
+```