Prevent invalid CPE field values #514
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Dan Luhring <dan.luhring@anchore.com>
Signed-off-by: Dan Luhring <dan.luhring@anchore.com>
Signed-off-by: Dan Luhring <dan.luhring@anchore.com>
Signed-off-by: Dan Luhring <dan.luhring@anchore.com>
Benchmark Test ResultsBenchmark results from the latest changes vs base branch |
kzantow
reviewed
Sep 23, 2021
| @@ -129,6 +133,8 @@ func candidateVendors(p pkg.Package) []string { | |||
| // generate sub-selections of each candidate based on separators (e.g. jenkins-ci -> [jenkins, jenkins-ci]) | |||
| addAllSubSelections(vendors) | |||
|
|
|||
| vendors.removeByCondition(invalidCPEValue) | |||
There was a problem hiding this comment.
This would all clearly work for the case where there's as : in the vendor... are there other fields that could contain colons or other characters that would result in these being invalid? Would a better approach be validating the CPE can be re-parsed later on? Would that be too slow?
There was a problem hiding this comment.
That's interesting! I'm up for that approach. If I understand correctly: before returning all generated CPEs, we'd test each one by serializing it and then deserializing it. Is that right?
@wagoodman Curious for your thoughts here, too
There was a problem hiding this comment.
... I just remembered we have benchmark tests that could show us a substantial change in performance!
There was a problem hiding this comment.
Attempted in 1a51bd5 — let me know what you think
There was a problem hiding this comment.
I like this approach much better... instead of covering the single case of : we're getting to the root problem of "don't allow CPEs that will never work" 👍
wagoodman
reviewed
Sep 23, 2021
Signed-off-by: Dan Luhring <dan.luhring@anchore.com>
Signed-off-by: Dan Luhring <dan.luhring@anchore.com>
Signed-off-by: Dan Luhring <dan.luhring@anchore.com>
wagoodman
approved these changes
Sep 24, 2021
spiffcs
added a commit
that referenced
this pull request
Sep 30, 2021
* main: Add vendor + product known good CPE field values (#517) Add SBOM to releases (#500) Add announcement for KubeCon meetup (#515) Prevent invalid CPE field values (#514) Filter out CPE product candidates that are asterisks (#513) Use Anchore fork of packageurl lib without replace directive (#512) update log file permissions to 0644 (#511) Signed-off-by: Christopher Angelo Phillips <christopher.phillips@anchore.com>
GijsCalis
pushed a commit
to GijsCalis/syft
that referenced
this pull request
Feb 19, 2024
* Fix CPE set comparison mismatch Signed-off-by: Dan Luhring <dan.luhring@anchore.com> * Add failing test to assert CPE generation excludes URLs Signed-off-by: Dan Luhring <dan.luhring@anchore.com> * Add removeByCondition method to fieldCandidateSet Signed-off-by: Dan Luhring <dan.luhring@anchore.com> * Prevent invalid CPE values for products and vendors Signed-off-by: Dan Luhring <dan.luhring@anchore.com> * Introduce removeWhere and rename filter to condition Signed-off-by: Dan Luhring <dan.luhring@anchore.com> * Refactor fieldCandidateSet and condition logic Signed-off-by: Dan Luhring <dan.luhring@anchore.com> * Move CPE parsing filter to end of CPE generation Signed-off-by: Dan Luhring <dan.luhring@anchore.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the second half of the solution to anchore/grype#417 (the first half being anchore/grype#425).
This PR prevents CPEs from being generated where the product or vendor field contains URL-like strings (e.g.
http://jcp_org/en/jsr/detail?id=173), or more generically, invalid string values.This PR takes the approach of considering any field value that contains a colon (
:) to be invalid, since colons are the delimiter of CPE fields, and this covers the case of URLs that contain substrings likehttp://.