Skip to content

Commit

Permalink
editorial: Clarify DependencyLevels, SlsaResult, and quote level keys.
Browse files Browse the repository at this point in the history
Co-authored-by: Mark Lodato <[email protected]>
Signed-off-by: Zhenyu (Adam) Wu <[email protected]>
  • Loading branch information
AdamZWu and MarkLodato committed Oct 20, 2023
1 parent 88dfad6 commit f400a63
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 31 deletions.
35 changes: 20 additions & 15 deletions docs/spec/v1.0/verification_summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,8 @@ of the other top-level fields, such as `subject`, see [Statement]._
> its dependencies), or "FAILED" if policy verification failed.
>
> Users MUST NOT include more than one level per SLSA track. Note that each SLSA
> level implies all levels below it (e.g. SLSA_BUILD_LEVEL_3 implies
> SLSA_BUILD_LEVEL_2 and SLSA_BUILD_LEVEL_1), so there is no need to
> level implies all levels below it (e.g. `SLSA_BUILD_LEVEL_3` implies
> `SLSA_BUILD_LEVEL_2` and `SLSA_BUILD_LEVEL_1`), so there is no need to
> include more than one level per track.
<a id="dependencyLevels"></a>
Expand All @@ -192,11 +192,14 @@ of the other top-level fields, such as `subject`, see [Statement]._
> Map from [SlsaResult] to the number of the artifact's _transitive_ dependencies
> that were verified at the indicated level. Absence of a given level of
> [SlsaResult] MUST be interpreted as reporting _0_ dependencies at that level.
> A set but empty `dependencyLevels` object means that the artifact has **no**
> dependency at all, while an unset or null `dependencyLevels` means that the
> verifier makes no claims about the artifact's dependencies.
>
> Users MUST count each dependency only once per SLSA track, at the highest
> level verified. For example, if a dependency meets SLSA_BUILD_LEVEL_2,
> you include it with the count for SLSA_BUILD_LEVEL_2 but not the count for
>SLSA_BUILD_LEVEL_1.
> level verified. For example, if a dependency meets `SLSA_BUILD_LEVEL_2`,
> you include it with the count for `SLSA_BUILD_LEVEL_2` but not the count for
> `SLSA_BUILD_LEVEL_1`.
<a id="slsaVersion"></a>
`slsaVersion` _string, optional_
Expand Down Expand Up @@ -251,18 +254,20 @@ WARNING: This is just for demonstration purposes.

</div>

The result of evaluating an artifact (or set of artifacts) against SLSA.
The result of evaluating an artifact (or set of artifacts) against SLSA tracks.
SHOULD be one of these values:

- SLSA_BUILD_LEVEL_0
- SLSA_BUILD_LEVEL_1
- SLSA_BUILD_LEVEL_2
- SLSA_BUILD_LEVEL_3
- FAILED (Indicates policy evaluation failed)

Note that each SLSA level implies the levels below it. For example,
SLSA_BUILD_LEVEL_3 means (SLSA_BUILD_LEVEL_1 + SLSA_BUILD_LEVEL_2 +
SLSA_BUILD_LEVEL_3).
- SLSA BUILD track:
- `SLSA_BUILD_LEVEL_0`
- `SLSA_BUILD_LEVEL_1`
- `SLSA_BUILD_LEVEL_2`
- `SLSA_BUILD_LEVEL_3`
- General policy evaluation track:
- `FAILED`

Note that each SLSA level implies the levels below it in the same track.
For example, `SLSA_BUILD_LEVEL_3` means (`SLSA_BUILD_LEVEL_1` +
`SLSA_BUILD_LEVEL_2` + `SLSA_BUILD_LEVEL_3`).

Users MAY use custom values here but MUST NOT use custom values starting with
`SLSA_`.
Expand Down
37 changes: 21 additions & 16 deletions docs/spec/v1.1/verification_summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,8 @@ of the other top-level fields, such as `subject`, see [Statement]._
> its dependencies), or "FAILED" if policy verification failed.
>
> Users MUST NOT include more than one level per SLSA track. Note that each SLSA
> level implies all levels below it (e.g. SLSA_BUILD_LEVEL_3 implies
> SLSA_BUILD_LEVEL_2 and SLSA_BUILD_LEVEL_1), so there is no need to
> level implies all levels below it (e.g. `SLSA_BUILD_LEVEL_3` implies
> `SLSA_BUILD_LEVEL_2` and `SLSA_BUILD_LEVEL_1`), so there is no need to
> include more than one level per track.
<a id="dependencyLevels"></a>
Expand All @@ -192,11 +192,14 @@ of the other top-level fields, such as `subject`, see [Statement]._
> Map from [SlsaResult] to the number of the artifact's _transitive_ dependencies
> that were verified at the indicated level. Absence of a given level of
> [SlsaResult] MUST be interpreted as reporting _0_ dependencies at that level.
> A set but empty `dependencyLevels` object means that the artifact has **no**
> dependency at all, while an unset or null `dependencyLevels` means that the
> verifier makes no claims about the artifact's dependencies.
>
> Users MUST count each dependency only once per SLSA track, at the highest
> level verified. For example, if a dependency meets SLSA_BUILD_LEVEL_2,
> you include it with the count for SLSA_BUILD_LEVEL_2 but not the count for
>SLSA_BUILD_LEVEL_1.
> level verified. For example, if a dependency meets `SLSA_BUILD_LEVEL_2`,
> you include it with the count for `SLSA_BUILD_LEVEL_2` but not the count for
> `SLSA_BUILD_LEVEL_1`.
<a id="slsaVersion"></a>
`slsaVersion` _string, optional_
Expand Down Expand Up @@ -348,19 +351,21 @@ verifiers they add to their roots of trust.

</div>

The result of evaluating an artifact (or set of artifacts) against SLSA.
The result of evaluating an artifact (or set of artifacts) against SLSA tracks.
SHOULD be one of these values:

- SLSA_BUILD_LEVEL_UNEVALUATED
- SLSA_BUILD_LEVEL_0
- SLSA_BUILD_LEVEL_1
- SLSA_BUILD_LEVEL_2
- SLSA_BUILD_LEVEL_3
- FAILED (Indicates policy evaluation failed)

Note that each SLSA level implies the levels below it. For example,
SLSA_BUILD_LEVEL_3 means (SLSA_BUILD_LEVEL_1 + SLSA_BUILD_LEVEL_2 +
SLSA_BUILD_LEVEL_3).
- SLSA BUILD track:
- `SLSA_BUILD_LEVEL_UNEVALUATED`
- `SLSA_BUILD_LEVEL_0`
- `SLSA_BUILD_LEVEL_1`
- `SLSA_BUILD_LEVEL_2`
- `SLSA_BUILD_LEVEL_3`
- General policy evaluation track:
- `FAILED`

Note that each SLSA level implies the levels below it in the same track.
For example, `SLSA_BUILD_LEVEL_3` means (`SLSA_BUILD_LEVEL_1` +
`SLSA_BUILD_LEVEL_2` + `SLSA_BUILD_LEVEL_3`).

Users MAY use custom values here but MUST NOT use custom values starting with
`SLSA_`.
Expand Down

0 comments on commit f400a63

Please sign in to comment.