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

Remove legacy bom for platform/0.9 #288

Merged
merged 2 commits into from
Mar 9, 2022
Merged

Remove legacy bom for platform/0.9 #288

merged 2 commits into from
Mar 9, 2022

Conversation

natalieparellano
Copy link
Member

@natalieparellano natalieparellano commented Jan 27, 2022

This change proposes that legacy boms output by older buildpacks be ignored on the newest platform.

The lifecycle implementation could output a warning if any boms are ignored.

@natalieparellano natalieparellano requested a review from a team as a code owner January 27, 2022 16:19
@natalieparellano
Copy link
Member Author

cc @ekcasey @matthewmcnew

@natalieparellano
Copy link
Member Author

Per discussion in 2/17 Working Group, instead of totally discarding legacy boms, we may want to save them to a file such as <layers>/sbom/launch/<buildpack-id>/sbom.toml and <layers>/sbom/build/<buildpack-id>/sbom.toml. Slack conversation around if/how this should be spec'd.

@natalieparellano
Copy link
Member Author

From yesterday's core sync, @samj1912 to provide suggestions for the "compat" format given that we have requirements around media types.

@hone
Copy link
Member

hone commented Mar 2, 2022

@natalieparellano sorry for not voting on this, but based on the recent discussions are we deciding to add the "compat" part to the spec? It looks like we did in the slack conversations as well. Are there supposed to be changes to this PR?

@hone
Copy link
Member

hone commented Mar 2, 2022

@samj1912 will leave a media type suggestion to this PR.

@sambhav
Copy link
Member

sambhav commented Mar 7, 2022

We should do the following - put the legacy bom in JSON format in (the same format we put it in the label) with the extension *.legacy.json

We can document that if users wish to upload it as an attestation or attachment the media type can be application/vnd.buildpacks.io.legacy.sbom+json and the attestation predicate type can be buildpacks.io/legacy/SBOM/v0

@natalieparellano
Copy link
Member Author

We should do the following - put the legacy bom in JSON format in (the same format we put it in the label) with the extension *.legacy.json

We can document that if users wish to upload it as an attestation or attachment the media type can be application/vnd.buildpacks.io.legacy.sbom+json and the attestation predicate type can be buildpacks.io/legacy/SBOM/v0

Please see 9089048

@hone
Copy link
Member

hone commented Mar 9, 2022

We should do the following - put the legacy bom in JSON format in (the same format we put it in the label) with the extension *.legacy.json
We can document that if users wish to upload it as an attestation or attachment the media type can be application/vnd.buildpacks.io.legacy.sbom+json and the attestation predicate type can be buildpacks.io/legacy/SBOM/v0

Please see 9089048

Do we need to document the media type as well in the buildpack API? https://github.com/buildpacks/spec/blob/main/buildpack.md#software-bill-of-materials

Legacy boms output by older buildpacks will be ignored by the platform.

Signed-off-by: Natalie Arellano <[email protected]>
@ekcasey ekcasey merged commit 6261d3e into platform/0.9 Mar 9, 2022
@ekcasey ekcasey deleted the remove-bom branch March 9, 2022 19:13
@sambhav
Copy link
Member

sambhav commented Mar 9, 2022

@natalieparellano I see that the legacy boms were added underneath individual buildpacks. I was hoping we could just output the combined one at the top level and save lifecycle some effort. It already has the combination logic and puts it in a label. We could just output the same JSON blob in a file at the top level?

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.

7 participants