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

Generate an SBOM #960

Open
ppalaga opened this issue Aug 14, 2023 · 11 comments
Open

Generate an SBOM #960

ppalaga opened this issue Aug 14, 2023 · 11 comments

Comments

@ppalaga
Copy link
Contributor

ppalaga commented Aug 14, 2023

No description provided.

@ppalaga
Copy link
Contributor Author

ppalaga commented Aug 16, 2023

@gastaldi do you happen to have some standardized way of generating an SBOM for Quarkiverse projects?

@gastaldi
Copy link
Member

@ppalaga no. I know @aloubyansky did some work to generate those, but I haven't checked yet.

As a side note, GitHub has a feature to export SBOMs from the UI: https://github.blog/2023-03-28-introducing-self-service-sboms/#whats-changing

@aloubyansky
Copy link
Member

./mvnw -Psbom from the platform project generates SBOMs for all the members.

@ppalaga
Copy link
Contributor Author

ppalaga commented Aug 16, 2023

./mvnw -Psbom from the platform project generates SBOMs for all the members.

Which mojo does that? I could not find anything quickly in https://github.com/quarkusio/quarkus-platform-bom-generator
I wonder if the mojo is general enough and would work for Quarkus CXF as well?

@gastaldi
Copy link
Member

@ppalaga
Copy link
Contributor Author

ppalaga commented Aug 16, 2023

I think the profile is here: https://github.com/quarkusio/quarkus-platform/blob/main/pom.xml#L775C18-L799

I was rather looking for the source of the mojo generating the SBOM to figure out whether it can be used inside quarkus-cxf

@aloubyansky
Copy link
Member

It depends on what you expect to be captured in an SBOM. But generally, I think we can make it work.

@ppalaga
Copy link
Contributor Author

ppalaga commented Aug 16, 2023

I have no precise expectations. The main questions I have are:

  1. Should maven plugins and other build related artifacts be a part of the SBOM? I was a bit surprised to see them in https://github.com/quarkiverse/quarkus-cxf/network/dependencies?q=plugin I guess no, but in that case, the GH SBOM export is rather useless.
  2. Should Quarkus CXF SBOM include quarkus artifacts and their transitives? I'd say no - is that also your opinion @aloubyansky?

@aloubyansky
Copy link
Member

It depends on what the consumer of the SBOM is expecting to find in it. It's about supply chain story and depends on how much details of that store you want to capture. Build tools are certainly a part of it but again it depends on how much detail you are after.

From the Quarkus platform perspective, I'd agree with you, from the perspective of CVE tracking and fixing, generating an SBOM per "deliverable" makes sense and is what we should do. However, this is not exactly how it is currently done in the Quarkus platform, we are still recording complete dependency trees in the SBOMs we generate for platform members. I need to fix this.

@ppalaga
Copy link
Contributor Author

ppalaga commented Aug 16, 2023

The main use case is scanning for CVEs in quarkus-cxf and its transitives minus stuff pulled via Quarkus.

we are still recording complete dependency trees in the SBOMs we generate for platform members. I need to fix this.

What needs to be excluded from the complete dependency trees from your PoV?

@aloubyansky
Copy link
Member

Components (Maven artifacts) that come from Quarkus itself.

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

No branches or pull requests

3 participants