feat(db): Add dbRepository flag to get advisory database from OCI registry #1873

ksashikumar · 2022-03-23T15:15:43Z

Description

This MR adds a new option --db-repository to download the vulnerability database from an external OCI registry. This will be helpful for GitLab's Cluster Image Scanning to use GitLab's Advisory DB.

Related issue in GitLab: #350232

Checklist

I've read the guidelines for contributing to this repository.
I've followed the conventions in the PR title.
I've added tests that prove my fix is effective or that my feature works.
I've updated the documentation with the relevant information (if needed).
I've added usage information (if the PR introduces new options)
[-] I've included a "before" and "after" example to the description (if the PR is a user interface change).

…istry Author: Sashi Kumar<[email protected]>

knqyf263 · 2022-03-23T15:42:04Z

pkg/db/db.go

@@ -132,13 +129,13 @@ func (c *Client) isNewDB(meta metadata.Metadata) bool {
 }

 // Download downloads the DB file
-func (c *Client) Download(ctx context.Context, dst string) error {
+func (c *Client) Download(ctx context.Context, dst string, dbRepository string) error {


What if we add WithDBRepository here?

trivy/pkg/db/db.go

Lines 26 to 46 in bd243bc

type options struct {

artifact *oci.Artifact

clock clock.Clock

}

// Option is a functional option

type Option func(*options)

// WithOCIArtifact takes an OCI artifact

func WithOCIArtifact(art *oci.Artifact) Option {

return func(opts *options) {

opts.artifact = art

}

}

// WithClock takes a clock

func WithClock(clock clock.Clock) Option {

return func(opts *options) {

opts.clock = clock

}

}

Good idea! I've updated it 👍

Thanks for the update.

CLAassistant · 2022-03-23T16:19:36Z

All committers have signed the CLA.

pkg/db/db.go

knqyf263 · 2022-03-28T08:01:21Z

pkg/rpc/server/listen.go

@@ -50,7 +51,7 @@ func (s Server) ListenAndServe(serverCache cache.Cache) error {
 	dbUpdateWg := &sync.WaitGroup{}

 	go func() {
-		worker := newDBWorker(dbc.NewClient(s.cacheDir, true))
+		worker := newDBWorker(dbc.NewClient(s.cacheDir, true, dbc.WithDBRepository(dbRepository)))


Then, we don't have to pass the default value here.

knqyf263 · 2022-03-28T08:01:32Z

pkg/db/db_test.go

@@ -206,7 +207,7 @@ func TestClient_Download(t *testing.T) {
 			art, err := oci.NewArtifact("db", mediaType, true, oci.WithImage(img))
 			require.NoError(t, err)

-			client := db.NewClient(cacheDir, true, db.WithOCIArtifact(art), db.WithClock(timeDownloadedAt))
+			client := db.NewClient(cacheDir, true, db.WithOCIArtifact(art), db.WithClock(timeDownloadedAt), db.WithDBRepository(dbRepository))


knqyf263 · 2022-03-28T08:02:30Z

pkg/db/db.go

@@ -171,7 +178,7 @@ func (c *Client) updateDownloadedAt(dst string) error {
 	return nil
 }

-func (c *Client) populateOCIArtifact() error {
+func (c *Client) populateOCIArtifact(dbRepository string) error {


We have dbRepository as a member of Client. Do we need to pass it as an argument? We can access c.dbRepository in this method.

knqyf263 · 2022-03-28T08:02:58Z

pkg/db/db.go

@@ -171,7 +178,7 @@ func (c *Client) updateDownloadedAt(dst string) error {
 	return nil
 }

-func (c *Client) populateOCIArtifact() error {
+func (c *Client) populateOCIArtifact(dbRepository string) error {
 	if c.artifact == nil {
 		repo := fmt.Sprintf("%s:%d", dbRepository, db.SchemaVersion)


Like

Suggested change

repo := fmt.Sprintf("%s:%d", dbRepository, db.SchemaVersion)

repo := fmt.Sprintf("%s:%d", c.dbRepository, db.SchemaVersion)

knqyf263 · 2022-03-28T08:03:41Z

pkg/commands/operation/operation.go

@@ -106,6 +106,7 @@ func DownloadDB(appVersion, cacheDir string, quiet, skipUpdate bool) error {
 	if needsUpdate {
 		log.Logger.Info("Need to update DB")
 		log.Logger.Info("Downloading DB...")
+		log.Logger.Infof("Repository: %s", dbRepository)


nit: I want to put it before Downloading DB....

ksashikumar · 2022-03-28T16:41:01Z

@knqyf263 Thanks for the great comments, I've addressed them. Could you please take a look again?

knqyf263

Looks great! Thanks for the contribution!

knqyf263 · 2022-03-31T12:49:39Z

I'll fix the lint issues

ksashikumar · 2022-03-31T15:30:38Z

Looks great! Thanks for the contribution!

Thanks for helping me to merge this 👍 🙏

…istry (#1873) Co-authored-by: knqyf263 <[email protected]>

feat(db): Add dbRepository flag to get advisory database from OCI reg…

bd243bc

…istry Author: Sashi Kumar<[email protected]>

ksashikumar force-pushed the sk/add-db-repository branch from 90b8f47 to bd243bc Compare March 23, 2022 15:23

knqyf263 reviewed Mar 23, 2022

View reviewed changes

ksashikumar marked this pull request as ready for review March 23, 2022 16:30

ksashikumar mentioned this pull request Mar 24, 2022

feat(trivy): Add dbRepository flag to get advisory database from OCI registry aquasecurity/starboard#1064

Merged

Review comment: use WithDBRepository

6b8cc3e

ksashikumar requested a review from knqyf263 March 24, 2022 17:45

Fix db package name

003173f

knqyf263 reviewed Mar 28, 2022

View reviewed changes

Review comment: refactor to functional option

1dceb4f

ksashikumar force-pushed the sk/add-db-repository branch from 62d86e7 to 1dceb4f Compare March 28, 2022 16:39

ksashikumar requested a review from knqyf263 March 28, 2022 16:39

Merge branch 'main' into sk/add-db-repository

cbe276a

knqyf263 approved these changes Mar 31, 2022

View reviewed changes

knqyf263 added 2 commits March 31, 2022 15:50

refactor(db): update a log message

f96fd19

style: gofmt

ceaa7c7

knqyf263 merged commit 0210567 into aquasecurity:main Mar 31, 2022

ksashikumar deleted the sk/add-db-repository branch March 31, 2022 15:30

knqyf263 mentioned this pull request Apr 7, 2022

fix(sbom): add --db-repository #1964

Merged

8 tasks

knqyf263 mentioned this pull request May 31, 2022

Configurable database repository (dbRepository) #1783

Closed

liamg pushed a commit that referenced this pull request Jun 7, 2022

feat(db): Add dbRepository flag to get advisory database from OCI reg…

83cb99a

…istry (#1873) Co-authored-by: knqyf263 <[email protected]>

This was referenced Jun 16, 2022

Helm support for configurable database repository (dbRepository) #2344

Closed

feat(helm): add support for trivy dbRepository #2345

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(db): Add dbRepository flag to get advisory database from OCI registry #1873

feat(db): Add dbRepository flag to get advisory database from OCI registry #1873

ksashikumar commented Mar 23, 2022 •

edited

Loading

knqyf263 Mar 23, 2022

ksashikumar Mar 24, 2022

knqyf263 Mar 28, 2022

CLAassistant commented Mar 23, 2022 •

edited

Loading

knqyf263 Mar 28, 2022

knqyf263 Mar 28, 2022

knqyf263 Mar 28, 2022

knqyf263 Mar 28, 2022

knqyf263 Mar 28, 2022

ksashikumar commented Mar 28, 2022

knqyf263 left a comment

knqyf263 commented Mar 31, 2022

ksashikumar commented Mar 31, 2022

	type options struct {
	artifact *oci.Artifact
	clock clock.Clock
	}

	// Option is a functional option
	type Option func(*options)

	// WithOCIArtifact takes an OCI artifact
	func WithOCIArtifact(art *oci.Artifact) Option {
	return func(opts *options) {
	opts.artifact = art
	}
	}

	// WithClock takes a clock
	func WithClock(clock clock.Clock) Option {
	return func(opts *options) {
	opts.clock = clock
	}
	}

	repo := fmt.Sprintf("%s:%d", dbRepository, db.SchemaVersion)
	repo := fmt.Sprintf("%s:%d", c.dbRepository, db.SchemaVersion)

feat(db): Add dbRepository flag to get advisory database from OCI registry #1873

feat(db): Add dbRepository flag to get advisory database from OCI registry #1873

Conversation

ksashikumar commented Mar 23, 2022 • edited Loading

Description

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CLAassistant commented Mar 23, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ksashikumar commented Mar 28, 2022

knqyf263 left a comment

Choose a reason for hiding this comment

knqyf263 commented Mar 31, 2022

ksashikumar commented Mar 31, 2022

ksashikumar commented Mar 23, 2022 •

edited

Loading

CLAassistant commented Mar 23, 2022 •

edited

Loading