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

Add CPE to cargo dependency metadata #187

Merged
merged 2 commits into from
Jun 7, 2021
Merged

Conversation

sophiewigmore
Copy link
Member

Summary

In #181 we added the jam update-dependencies command to keep our buildpack dependencies up to date with our new dependency server. This PR results in a buildpack.toml with the same fields on metadata.dependency that we have always had.

This PR adds in the support for the new CPE field (common platform enumeration) field on each dependency, since this is important for vulnerability lookup.

The resulting buildpack.toml dependencies will look like:

[[metadata.dependencies]]	
  cpe = "dependency-specific-cpe"	
  id = "dependency-id"	
  name = "Dependency Name"	
  sha256 = "sha"	
  source = "source-uri"	
  source_sha256 = "source-sha"	
  stacks = ["stack"]	
  uri = "dependency-server-uri"	
  version = "version"

Use Cases

Our dependency server provides CPE notation for each dependency so that we can look up specific vulnerabilities in a NIST database, for example. This is helpful information to surface, so that we can include it in a bill of materials down the line.

Checklist

  • I have viewed, signed, and submitted the Contributor License Agreement.
  • I have linked issue(s) that this PR should close using keywords or the Github UI (See docs)
  • I have added an integration test, if necessary.
  • I have reviewed the styleguide for guidance on my code quality.
  • I'm happy with the commit history on this PR (I have rebased/squashed as needed).

@ForestEckhardt ForestEckhardt merged commit eea8806 into main Jun 7, 2021
@ForestEckhardt ForestEckhardt deleted the add-cpe-metadata branch June 7, 2021 15:00
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.

2 participants