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

feat: Use osv-scalibr SBOM extractors #1380

Closed
wants to merge 16 commits into from

Conversation

another-rex
Copy link
Collaborator

Use osv-scalibr SBOM extractors rather than the internal ones.

Can't be merged yet as it is blocked on #1379

another-rex and others added 15 commits October 23, 2024 10:38
… our osv-scanner.toml in fixtures (google#1337)

Uses the new feature landed in google#1214
…ncy resolution (google#1331)

Part of google#1330 

No functional change is made compared to the version in
`internal/manifest`, just switched to use the osv-scalibr interface.

Extractors moved to lockfilescalibr as a temporary staging ground before
moving to osv-scalibr.
…#1341)

Turns out we don't need most of the functionality of the third party
tire library. Built a simple and focused library pathtree which is just
a tree with insert and get functions to allow us to implement a virtual
filesystem easily.
Add/migrate osv-scanner.json extractor to use the scalibr format. This
is intended to replace the current extractor located here:
pkg/lockfile/osv-vuln-results.go

This is extractor is intended to stay in osv-scanner and not moved to
osv-scalibr as it is very osv-scanner specific.
Ideally, node package extracts can be done with packagejson extractor
directly (As every dir inside a node_modules directory has a
package.json file), but that changes the image scanning snapshots too
much to be part of this initial PR, and introduces new OS findings that
are difficult to filter out.

This keeps the existing solution of extracting directly with
node_modules by implementing an extractor that wraps the
`packagejsonlock` extractor to minimise snapshot changes.
Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Xueqin Cui <[email protected]>
Co-authored-by: Michael Kedar <[email protected]>
Co-authored-by: Gareth Jones <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Resolves google#1316 

Update the --docker flag to:
- Only accept one image to scan at a time (to make displaying results
easier)
- Call new image scanning function internally.
- Acts like a convenience function for 
```
docker save <image-name> > img-name.tar && osv-scanner --experimental-oci-image=img.name.tar
```

TODO: 
- [x] Add an ACCEPTANCE test which uses docker to pull down a stable
image.
- [x] Include a docker pull first, as docker save only saves images
already on device and does not pull images online.
This PR contains all the code required to move to osv-scalibr while
making the existing code compile and pass all tests (container tests not
passing because of a bug in the scalibr alpine extractor).

Changes not mentioned in the following list will be split off in
separate PRs which should land before this PR.

Those are:
- [x] google#1337 
- [x] google#1331 
- [x] google#1338 
- [x] google#1341
- [x] google#1345


Changes in this PR:
- Fixture changes:
- Scalibr Python requirements.txt extractor currently doesn't support
packages without versions, so added some version strings to the test
files
- Image package required quite a bit of reworking to successfully
update.
- Add the ability to iterate through a directory via the pathtree
library
  - Support scalibr FS interface for Layers
- Add conversion code to convert inventories from osv-scalibr back to
v1's lockfile and Inventory
- This is done to minimize snapshot changes. Followup PRs should remove
this conversion
- Add `internal/lockfilescalibr` package:
  - `errors.go` adds common extraction errors we want to translate.
- `translation.go` adds helper functions and translation logic between
osv-scanner v1 extractor names, and osv-scalibr extractor names.



Changes in followup PRs:
- Delete lockfiles package and migrate everything to use osv-scalibr
extractors
- Remove conversion code in image

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Gareth Jones <[email protected]>
Co-authored-by: Xueqin Cui <[email protected]>
Co-authored-by: Michael Kedar <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Using a separate branch to resolve the merge conflicts, but other than
that this is a straightforward update of the v2 branch up to the latest
main branch.

---------

Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: Emmanuel Ferdman <[email protected]>
Co-authored-by: Xueqin Cui <[email protected]>
Co-authored-by: Michael Kedar <[email protected]>
Co-authored-by: Gareth Jones <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Emmanuel Ferdman <[email protected]>
Co-authored-by: Ignacio Vazquez <[email protected]>
@another-rex another-rex changed the base branch from main to v2 November 5, 2024 04:14
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.

1 participant