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

fix: incorrect version coercion in container's pip scanner #4964

Merged
merged 1 commit into from
Dec 14, 2023

Conversation

SteveShani
Copy link
Contributor

@SteveShani SteveShani commented Dec 13, 2023

Pull Request Submission

Please check the boxes once done.

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

Pull Request Review

All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.

Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.

For Node projects: It’s important to make sure changes in package.json are also affecting package-lock.json correctly.

If a dependency is not necessary, don’t add it.

When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.

Pull Request Approval

Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.

What does this PR do?

This PR bumps a version of a dependency. This dependency bump fixes an issue with container's pip scanning code, that caused packages with versions that do not strickly conform to semver, to be coerced incorrectly. This caused false positives. For example, the package opencv-python:4.8.1.78 to coerce to version 4.8.1 that is vulnerable, where 4.8.1.78 is not.

Where should the reviewer start?

They can have a look at the original fix here. snyk/snyk-docker-plugin#557

How should this be manually tested?

Create a container image with a requirements.txt file containing opencv-python==4.8.1.78. Run pip install -r requirements.txt. Scan with the current CLI, and then pull this change and scan again.
The vulnerability https://security.snyk.io/vuln/SNYK-PYTHON-OPENCVPYTHON-5926695 should be resolved.

Risk Assessment

This is a medium risk. It should not break existing functionality but only expand on it.
This will affect pip application vulnerabilities.
This update triggered another dependency upgrade (packageurl-js). Its version was locked to 1.2.0, as 1.2.1 is incompatible with the way we generate dep graphs.

Link to tests:

https://app.circleci.com/pipelines/github/snyk/snyk-docker-plugin/2537/workflows/580f5ef7-3809-4d8c-b282-73c69670c52a/jobs/13219?invite=true#step-104-392826_177

@SteveShani SteveShani self-assigned this Dec 13, 2023
@SteveShani SteveShani requested a review from a team as a code owner December 13, 2023 05:06
@bastiandoetsch
Copy link
Contributor

Hi @SteveShani, thanks for the PR. Unfortunately, I fail to find the information required and marked as added with the checkboxes. Where's:

  • testing information
  • risk assessment
  • a detailed description of the changes,
  • ...

@SteveShani
Copy link
Contributor Author

Hi @SteveShani, thanks for the PR. Unfortunately, I fail to find the information required and marked as added with the checkboxes. Where's:

  • testing information
  • risk assessment
  • a detailed description of the changes,
  • ...

Oh you are correct. I didn't think those applied to version bumps. Let me fix that.

@bastiandoetsch
Copy link
Contributor

Please also check, why test_and_release is failing :)

Fixed issue when some pip dependency versions that were not strictly semver were being coerced incorrectly
@SteveShani SteveShani force-pushed the fix/container-python-version-parser branch from d81cd63 to e5e4c3f Compare December 14, 2023 08:22
@SteveShani SteveShani merged commit 025d352 into master Dec 14, 2023
14 checks passed
@SteveShani SteveShani deleted the fix/container-python-version-parser branch December 14, 2023 09:59
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