Skip to content

Commit 8b6cc30

Browse files
authored
Remove duplicate Additional resources section from metadata index (#438)
- Remove second Additional resources heading - Remove self-referential link to metadata:index.adoc - Consolidate Conforma tool information into single resources section Fixes #436
1 parent c6128d9 commit 8b6cc30

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

modules/metadata/pages/index.adoc

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The SLSA Build (v1.0) specification assigns two primary responsibilities to buil
2121

2222
SLSA also includes three Build Levels, which provide you with increasing guarantees about how build platforms fulfill these responsibilities. Any build platform that generates provenance conforms to the SLSA framework’s Build Level 1 (L1) specifications. Build platforms produce artifacts with higher Build Levels by hardening provenance against forgery and by isolating the build process. As of the v1.0 specification, Build Level 3 (L3) is the highest Build Level. {ProductName} produces Build L3 artifacts.
2323

24-
The rest of this document further explains our key responsibilities, provenance and build isolation, and how we fulfill those responsibilities. It concludes with a table summarizing how {ProductName} meets the requirements for SLSA Build L3.
24+
The rest of this document further explains our key responsibilities, provenance and build isolation, and how we fulfill those responsibilities. It concludes with a table summarizing how {ProductName} meets the requirements for SLSA Build L3.
2525

2626

2727
=== SLSA Provenance
@@ -30,11 +30,11 @@ In the context of its framework, link:https://slsa.dev/spec/v1.0/provenance[SLSA
3030

3131
==== Attestation
3232

33-
You can think of attestation like a recipe: a recipe tells you how someone made a certain dish, and attestation tells you how a build platform created a software artifact. SLSA provenance is a form of attestation. The SLSA provenance that {ProductName} provides includes a subject that tells you which artifact the attestation belongs to, and a predicate that explains how {ProductName} built each artifact, including relevant links.
33+
You can think of attestation like a recipe: a recipe tells you how someone made a certain dish, and attestation tells you how a build platform created a software artifact. SLSA provenance is a form of attestation. The SLSA provenance that {ProductName} provides includes a subject that tells you which artifact the attestation belongs to, and a predicate that explains how {ProductName} built each artifact, including relevant links.
3434

3535
==== Signing the attestation
3636

37-
At higher Build Levels, SLSA directs build platforms to harden their provenance by signing each attestation. With the signature, you can verify that no one tampered with the attestation for your artifacts. Currently, {ProductName} signs attestations using a private key.
37+
At higher Build Levels, SLSA directs build platforms to harden their provenance by signing each attestation. With the signature, you can verify that no one tampered with the attestation for your artifacts. Currently, {ProductName} signs attestations using a private key.
3838

3939
==== Evaluating provenance
4040

@@ -44,9 +44,9 @@ In its Build Levels, SLSA evaluates provenance based on three questions:
4444
* Authenticity: How certain are you that the provenance came from the builder?
4545
* Accuracy: How difficult is it to tamper with provenance during the build process?
4646

47-
Completeness of provenance comes from its attestation format, and authenticity derives from the signature.
47+
Completeness of provenance comes from its attestation format, and authenticity derives from the signature.
4848

49-
Accuracy is where provenance and build isolation intersect. To generate unforgeable provenance, build platforms must store those secret materials in a secure management system that platform users cannot access. In {ProductName}, only Tekton Chains, which generates and signs provenance, has access to the private key.
49+
Accuracy is where provenance and build isolation intersect. To generate unforgeable provenance, build platforms must store those secret materials in a secure management system that platform users cannot access. In {ProductName}, only Tekton Chains, which generates and signs provenance, has access to the private key.
5050

5151

5252
== Build isolation
@@ -55,25 +55,25 @@ According to the SLSA framework, our other primary responsibility is to guarante
5555

5656
=== Hosted
5757

58-
If builds run on an individual’s workstation, they become inconsistent. This inconsistency can cause mundane technical issues, but it also introduces security risks. What if undetected malware is lurking on that person’s machine?
58+
If builds run on an individual’s workstation, they become inconsistent. This inconsistency can cause mundane technical issues, but it also introduces security risks. What if undetected malware is lurking on that person’s machine?
5959

6060
To shrink the attack plane, SLSA dictates that builds should execute “using a hosted build platform on shared or dedicated infrastructure, not on an individual’s workstation.” By using an environment that comes from a known, auditable state, build platforms can largely ensure that they generate artifacts in the same way every time.
6161

62-
{ProductName} is a hosted build platform. We execute builds on Amazon Web Services (AWS) through Red Hat OpenShift Service on AWS (ROSA).
62+
{ProductName} is a hosted build platform. We execute builds on Amazon Web Services (AWS) through Red Hat OpenShift Service on AWS (ROSA).
6363

6464

6565
=== Internally isolated
6666

6767
Running builds in a hosted environment can protect your builds from malware installed on an individual’s workstation. But an attacker could gain access to your instance of a hosted build platform. What if they inject a malicious payload into one of your artifacts during the build process, and falsify the provenance to cover their tracks? Or what if they use one build to poison an environment that another build uses?
6868

69-
To mitigate these threats, and others, SLSA instructs build platforms to execute builds in an environment that, within the larger hosted environment, is internally isolated from other builds, users, and the control plane. The only external influence that is permissible is influence that the build itself requests, such as dependencies.
69+
To mitigate these threats, and others, SLSA instructs build platforms to execute builds in an environment that, within the larger hosted environment, is internally isolated from other builds, users, and the control plane. The only external influence that is permissible is influence that the build itself requests, such as dependencies.
7070

7171
{ProductName} internally isolates builds within ROSA using several different tactics. For example, Tekton Chains generates and signs provenance in its own namespace, separate from the one that runs user-defined build steps, so attackers cannot forge provenance. And builds themselves run in their own ephemeral pods, so they cannot persist or influence the build environment of subsequent builds.
7272

7373

7474
== How we meet the requirements for SLSA Build L3
7575

76-
The following table summarizes how {ProductName} conforms to the specification for producing SLSA Build L3 software artifacts.
76+
The following table summarizes how {ProductName} conforms to the specification for producing SLSA Build L3 software artifacts.
7777

7878
[cols="1,1, 1"]
7979
|===
@@ -153,9 +153,5 @@ a|In {ProductName}:
153153

154154
== Additional resources
155155

156-
* Learn xref:metadata:index.adoc[how to inspect the SLSA] provenance for your components.
157156
* Visit the link:https://slsa.dev/spec/v1.0/[SLSA overview page], the link:https://slsa.dev/spec/v1.0/levels[Build Levels] page, or the link:https://slsa.dev/spec/v1.0/verifying-systems[verifying build platforms] page.
158-
159-
== Additional resources
160-
* Learn about the SLSA framework and xref:metadata:index.adoc#supply-chain-security-through-slsa-conformity[how {ProductName} meets the requirements of SLSA Build Level 3].
161157
* Conforma is a powerful tool that you can also use to verify your SLSA provenance; visit link:https://conforma.dev/docs/user-guide/cli.html#_validating_an_image[this page] to learn how to use the EC CLI tool to verify your provenance. You will need the public key used by Tekton Chains, which you can find by following link:https://conforma.dev/docs/user-guide/cli.html#_finding_the_public_key[these instructions].

0 commit comments

Comments
 (0)