python / python/cpython

Update SBOM generation to meet new guidance from CISA

Open
#123,038 4 comments 1 reaction 1 assignee View on GitHub

@sethmlarson is already working on this.

Since Aug 15, 2024.

triaged type-security
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Proposal:

CISA has published the third revision of SBOM guidance, which at the moment isn't approved but is headed towards final rounds of review. Currently our SBOMs met the old revision which is "Minimum Elements of an SBOM" published by NTIA.

The new guidance uses a "maturity level", ranging from minimum required to aspirational. Below I've used the "aspirational" maturity level for all the criteria.

I checked our SBOM documents against the document to see how much would be needed to follow this new set of guidance. It turns out, not too much! Here's the breakdown:

Elements that need more work:
  • Author Name: We need to add an email address
  • SBOM Type: We need to upgrade to SPDX 3 for this field
  • Supplier Name: Need to double-check that these names conform. Also need to update where we add Heritage information.
  • Unique Identifier: We're almost there, there's at least one project we should request a CPE for.
  • Heritage: We don't encode this information today. Some of our components are slightly modified from upstream dependency, should be automatable.
  • Relationship Completeness
  • License
  • Copyright Notice
Elements we already conform with:
  • Timestamp
  • Primary Component
  • Component Name
  • Component Version
  • Cryptographic Hashes
  • Relationships
  • Redacted and Unknown Components and Attributes
Has this already been discussed elsewhere?

This is a minor feature, which does not need previous discussion elsewhere

Links to previous discussion of this feature:

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.