Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Build] Specify v0.2 version number for SLSA Provenance #808

Merged
merged 1 commit into from
Jul 30, 2024

Conversation

bact
Copy link
Collaborator

@bact bact commented Jul 26, 2024

In the Build class description, a reference to "SLSA provenance" contains no version or date information.

Definitions of "buildType", "configSourceEntrypoint", "configSourceUri",
"parameters" and "environment" follow those defined in
SLSA provenance.

The "SLSA provenance" text links to https://slsa.dev/provenance/v0.2

This PR add "v0.2" to the text, to match the version in the URL.

This is also to make it explicit in the text about the desired version, which is necessary because:

  • Normative References section states that:

    For undated references, the latest edition of the referenced document (including any amendments) applies.

  • The latest version of SLSA is 1.0 https://slsa.dev/provenance/v1
  • parameters and environment are renamed to externalParameters and internalParameters in 1.0
  • configSource (and its .entryPoint and .uri) is removed in 1.0
  • See changes from 0.2 to 1.0 https://slsa.dev/spec/v1.0/provenance#v10

Add "v0.2" to the text, to match the version in the URL.

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@lpanni
Copy link

lpanni commented Jul 29, 2024

What is the reasoning behind using v0.2 instead of 1.0?

@bact
Copy link
Collaborator Author

bact commented Jul 29, 2024

What is the reasoning behind using v0.2 instead of 1.0?

Because at the time of SPDX 3.0 Build Profile development, SLSA Provenance v1.0 is not exist yet.
SLSA Provenance v0.2 is the latest version available at the time.

See this email from 2022-08-05 https://lists.spdx.org/g/Spdx-tech/message/4725
The email has a link to slsa-framework/slsa#460 which is an SLSA project issue to collect what should be included in SLSA Provenance v1.0.

@lpanni
Copy link

lpanni commented Jul 29, 2024

Makes sense, did not know that.

@goneall
Copy link
Member

goneall commented Jul 30, 2024

From tech call, we'll go ahead and merge this.

Separately @nishakm will investigate if SLSA version 1.0 is close enough to 0.2 we could refer to that version instead. If so, a separate PR will be open to update the SLSA version.

Copy link
Member

@goneall goneall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@goneall goneall merged commit 61df7f4 into spdx:main Jul 30, 2024
1 check passed
@bact
Copy link
Collaborator Author

bact commented Jul 30, 2024

Thank you Nisha for taking a look.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants