POST: Our approach to compare SBOMS, or the "10 steps for SBOM comparison".
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 38/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- markdown
- Domain
- content
Research direction
Start by locating the markdown-based website entry point and the existing format for posts. Use the issue body as the outline for the SBOM comparison article and include the linked owl image; done means the post is added in the site's expected location with its numbered guidance and image rendered correctly.
Written by the indexing model from the issue text.
Description
This is our approach to compare SBOMS, or what are the "more or less" "10 steps towards SBOM validation and comparison":
First, what are the requirements that make an SBOM comparable? At a high level, you can only compare apples-to-apples. In SBOM speak, this means that you have have a complete listing of all packages included in a software, using the same package (and license) identifiers.
Here are the requirements towards a comparable SBOM:
- Is this valid JSON? Otherwise, fix the JSON until it loads.
- Is the data schema-valid for its SBOM JSON schema? Otherwise, fix the JSON until it validates.
- Is the SBOM using PURLs to identify packages? Otherwise, fix the package identifiers to map to PURL.
- Are the PURLs using a correct syntax? Otherwise, fix the PURL until they validate.
- As these existing PURLs, known in the PURL spec as registered types, and pointing to actual real code? Otherwise, fix the PURL until they are correct.
- Are all the PURLs that should be present found in the SBOM? (is this complete and accurate?) Otherwise, fix the SBOM until it is accurate.
- Are the versions of each package available with each PURL? Otherwise, fix the PURL until they all have a version.
And also for licensing:
- Is the license for each package present? Otherwise, fix the SBOM.
- Are licenses using correct SPDX license expressions? Otherwise, fix the licenses to get expressions.
And also to cross check when some data is lacking or incorrect:
- Is there a copyright or some provenance information for each package? Otherwise, fix the SBOM to add the missing information.
- Are key URLs like home page or download URLs present for each package?0. Is this the list of PURLs for the deployed, as-run code? Otherwise, fix the SBOM to add the missing information.
Other interesting data points:
13. Is the relationship between packages described?
14. Are there other "enrichment", like package description, other attributes?
15. For each package, is there an indication of its intended usage or "scope" (test, prod, dev, doc, etc.)?
Finally:
16. What is the "type" of SBOM? OR at what point in time in the software lifecycle it was computed?
And now, here is how compare two SBOMs!
-
Esnure that all requirements 1. to 7. are met.
-
Extract and sort the list of PURLs from each SBOM, and compare these two sequences (an easy diff)
-
If 16. holds and this is the same analyzed code, there should be no differences at all.
-
You can further compare licenses for any matching PURLs pair assuming that 8. and 9. are met.
(Add an image of the How to Draw an Owl meme)
https://www.reddit.com/r/pics/comments/d3zhx/how_to_draw_an_owl/
- Dominant language
- JavaScript
- Stars
- 9
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from aboutcode-org/www.aboutcode.org
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Add hover effects to adopter logos in the Community and Adopters sectionPossibly taken @riddheshkadu3637-ui claimed this 3 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Making all post button.Possibly taken @sarthaklole claimed this 90 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
aboutcode-org/www.aboutcode.org#117 · 3 comments ·
-
WWW: Reduce frequency of update-releasesMay be free again @johnmhoran claimed this 71 days ago, and no pull request is open. Openci-workflow
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
aboutcode-org/www.aboutcode.org#180 · 1 assignee ·
-
DOCS: Create new AboutCode stack diagram(s)May be free again @hixvikas claimed this 72 days ago, and no pull request is open. Opendocumentation
Difficulty 5/5 Over a week Newbie friendliness 35/100
aboutcode-org/www.aboutcode.org#166 · 1 comment ·
All issues in aboutcode-org/www.aboutcode.org
Similar issues
-
bug pydanty:is-working
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
pydantic/pydantic-ai#13939 ·
Maintainers usually reply within 1 day
-
self-host
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
funmusicplace/mirlo#2625 ·
Maintainers usually reply within 1 day
-
Bug Tests
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
JSPrismarine/JSPrismarine#3271 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 Half a day Newbie friendliness 85/100
sindresorhus/eslint-plugin-unicorn#4034 ·
Maintainers usually reply within 1 day
-
Content:WebExt needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day