//go:build search // +build search package trivy import ( "bytes" "encoding/json" "os" "path" "testing" "time" godigest "github.com/opencontainers/go-digest" ispec "github.com/opencontainers/image-spec/specs-go/v1" . "github.com/smartystreets/goconvey/convey" "zotregistry.io/zot/pkg/extensions/monitoring" "zotregistry.io/zot/pkg/extensions/search/common" "zotregistry.io/zot/pkg/log" "zotregistry.io/zot/pkg/meta/bolt" "zotregistry.io/zot/pkg/meta/repodb" boltdb_wrapper "zotregistry.io/zot/pkg/meta/repodb/boltdb-wrapper" "zotregistry.io/zot/pkg/storage" "zotregistry.io/zot/pkg/storage/local" "zotregistry.io/zot/pkg/test" ) func generateTestImage(storeController storage.StoreController, image string) { repoName, tag := common.GetImageDirAndTag(image) config, layers, manifest, err := test.GetImageComponents(10) So(err, ShouldBeNil) store := storeController.GetImageStore(repoName) err = store.InitRepo(repoName) So(err, ShouldBeNil) for _, layerBlob := range layers { layerReader := bytes.NewReader(layerBlob) layerDigest := godigest.FromBytes(layerBlob) _, _, err = store.FullBlobUpload(repoName, layerReader, layerDigest) So(err, ShouldBeNil) } configBlob, err := json.Marshal(config) So(err, ShouldBeNil) configReader := bytes.NewReader(configBlob) configDigest := godigest.FromBytes(configBlob) _, _, err = store.FullBlobUpload(repoName, configReader, configDigest) So(err, ShouldBeNil) manifestBlob, err := json.Marshal(manifest) So(err, ShouldBeNil) _, err = store.PutImageManifest(repoName, tag, ispec.MediaTypeImageManifest, manifestBlob) So(err, ShouldBeNil) } func TestMultipleStoragePath(t *testing.T) { Convey("Test multiple storage path", t, func() { // Create temporary directory firstRootDir := t.TempDir() secondRootDir := t.TempDir() thirdRootDir := t.TempDir() log := log.NewLogger("debug", "") metrics := monitoring.NewMetricsServer(false, log) // Create ImageStore firstStore := local.NewImageStore(firstRootDir, false, storage.DefaultGCDelay, false, false, log, metrics, nil, nil) secondStore := local.NewImageStore(secondRootDir, false, storage.DefaultGCDelay, false, false, log, metrics, nil, nil) thirdStore := local.NewImageStore(thirdRootDir, false, storage.DefaultGCDelay, false, false, log, metrics, nil, nil) storeController := storage.StoreController{} storeController.DefaultStore = firstStore subStore := make(map[string]storage.ImageStore) subStore["/a"] = secondStore subStore["/b"] = thirdStore storeController.SubStore = subStore params := bolt.DBParameters{ RootDir: firstRootDir, } boltDriver, err := bolt.GetBoltDriver(params) So(err, ShouldBeNil) repoDB, err := boltdb_wrapper.NewBoltDBWrapper(boltDriver, log) So(err, ShouldBeNil) err = repodb.ParseStorage(repoDB, storeController, log) So(err, ShouldBeNil) scanner := NewScanner(storeController, repoDB, "ghcr.io/project-zot/trivy-db", log) So(scanner.storeController.DefaultStore, ShouldNotBeNil) So(scanner.storeController.SubStore, ShouldNotBeNil) img0 := "test/image0:tag0" img1 := "a/test/image1:tag1" img2 := "b/test/image2:tag2" opts := scanner.getTrivyOptions(img0) So(opts.ScanOptions.Target, ShouldEqual, path.Join(firstStore.RootDir(), img0)) opts = scanner.getTrivyOptions(img1) So(opts.ScanOptions.Target, ShouldEqual, path.Join(secondStore.RootDir(), img1)) opts = scanner.getTrivyOptions(img2) So(opts.ScanOptions.Target, ShouldEqual, path.Join(thirdStore.RootDir(), img2)) generateTestImage(storeController, img0) generateTestImage(storeController, img1) generateTestImage(storeController, img2) // Download DB since DB download on scan is disabled err = scanner.UpdateDB() So(err, ShouldBeNil) // Scanning image in default store cveMap, err := scanner.ScanImage(img0) So(err, ShouldBeNil) So(len(cveMap), ShouldEqual, 0) // Scanning image in substore cveMap, err = scanner.ScanImage(img1) So(err, ShouldBeNil) So(len(cveMap), ShouldEqual, 0) // Scanning image which does not exist cveMap, err = scanner.ScanImage("a/test/image2:tag100") So(err, ShouldNotBeNil) So(len(cveMap), ShouldEqual, 0) // Download the DB to a default store location without permissions err = os.Chmod(firstRootDir, 0o000) So(err, ShouldBeNil) err = scanner.UpdateDB() So(err, ShouldNotBeNil) // Check the download works correctly when permissions allow err = os.Chmod(firstRootDir, 0o777) So(err, ShouldBeNil) err = scanner.UpdateDB() So(err, ShouldBeNil) // Download the DB to a substore location without permissions err = os.Chmod(secondRootDir, 0o000) So(err, ShouldBeNil) err = scanner.UpdateDB() So(err, ShouldNotBeNil) err = os.Chmod(secondRootDir, 0o777) So(err, ShouldBeNil) }) } func TestTrivyLibraryErrors(t *testing.T) { Convey("Test trivy API errors", t, func() { // Create temporary directory rootDir := t.TempDir() err := test.CopyFiles("../../../../../test/data/zot-test", path.Join(rootDir, "zot-test")) So(err, ShouldBeNil) log := log.NewLogger("debug", "") metrics := monitoring.NewMetricsServer(false, log) // Create ImageStore store := local.NewImageStore(rootDir, false, storage.DefaultGCDelay, false, false, log, metrics, nil, nil) storeController := storage.StoreController{} storeController.DefaultStore = store params := bolt.DBParameters{ RootDir: rootDir, } boltDriver, err := bolt.GetBoltDriver(params) So(err, ShouldBeNil) repoDB, err := boltdb_wrapper.NewBoltDBWrapper(boltDriver, log) So(err, ShouldBeNil) err = repodb.ParseStorage(repoDB, storeController, log) So(err, ShouldBeNil) scanner := NewScanner(storeController, repoDB, "ghcr.io/project-zot/trivy-db", log) // Download DB since DB download on scan is disabled err = scanner.UpdateDB() So(err, ShouldBeNil) img := "zot-test:0.0.1" // Scanning image with correct options opts := scanner.getTrivyOptions(img) _, err = scanner.runTrivy(opts) So(err, ShouldBeNil) // Scanning image with incorrect cache options // to trigger runner initialization errors opts.CacheOptions.CacheBackend = "redis://asdf!$%&!*)(" _, err = scanner.runTrivy(opts) So(err, ShouldNotBeNil) // Scanning image with invalid input to trigger a scanner error opts = scanner.getTrivyOptions("nilnonexisting_image:0.0.1") _, err = scanner.runTrivy(opts) So(err, ShouldNotBeNil) // Scanning image with incorrect report options // to trigger report filtering errors opts = scanner.getTrivyOptions(img) opts.ReportOptions.IgnorePolicy = "invalid file path" _, err = scanner.runTrivy(opts) So(err, ShouldNotBeNil) }) } func TestImageScannable(t *testing.T) { rootDir := t.TempDir() params := bolt.DBParameters{ RootDir: rootDir, } boltDriver, err := bolt.GetBoltDriver(params) if err != nil { panic(err) } log := log.NewLogger("debug", "") repoDB, err := boltdb_wrapper.NewBoltDBWrapper(boltDriver, log) if err != nil { panic(err) } // Create test data for the following cases // - Error: RepoMeta not found in DB // - Error: Tag not found in DB // - Error: Digest in RepoMeta is invalid // - Error: ManifestData not found in repodb // - Error: ManifestData cannot be unmarshalled // - Error: ManifestData contains unscannable layer type // - Valid Scannable image // Create repodb data for scannable image timeStamp := time.Date(2008, 1, 1, 12, 0, 0, 0, time.UTC) validConfigBlob, err := json.Marshal(ispec.Image{ Created: &timeStamp, }) if err != nil { panic(err) } validManifestBlob, err := json.Marshal(ispec.Manifest{ Config: ispec.Descriptor{ MediaType: ispec.MediaTypeImageConfig, Size: 0, Digest: godigest.FromBytes(validConfigBlob), }, Layers: []ispec.Descriptor{ { MediaType: ispec.MediaTypeImageLayerGzip, Size: 0, Digest: godigest.NewDigestFromEncoded(godigest.SHA256, "digest"), }, }, }) if err != nil { panic(err) } validRepoMeta := repodb.ManifestData{ ManifestBlob: validManifestBlob, ConfigBlob: validConfigBlob, } digestValidManifest := godigest.FromBytes(validManifestBlob) err = repoDB.SetManifestData(digestValidManifest, validRepoMeta) if err != nil { panic(err) } err = repoDB.SetRepoReference("repo1", "valid", digestValidManifest, ispec.MediaTypeImageManifest) if err != nil { panic(err) } // Create RepoDB data for manifest with unscannable layers manifestBlobUnscannableLayer, err := json.Marshal(ispec.Manifest{ Config: ispec.Descriptor{ MediaType: ispec.MediaTypeImageConfig, Size: 0, Digest: godigest.FromBytes(validConfigBlob), }, Layers: []ispec.Descriptor{ { MediaType: "unscannable_media_type", Size: 0, Digest: godigest.NewDigestFromEncoded(godigest.SHA256, "digest"), }, }, }) if err != nil { panic(err) } repoMetaUnscannableLayer := repodb.ManifestData{ ManifestBlob: manifestBlobUnscannableLayer, ConfigBlob: validConfigBlob, } digestManifestUnscannableLayer := godigest.FromBytes(manifestBlobUnscannableLayer) err = repoDB.SetManifestData(digestManifestUnscannableLayer, repoMetaUnscannableLayer) if err != nil { panic(err) } err = repoDB.SetRepoReference("repo1", "unscannable-layer", digestManifestUnscannableLayer, ispec.MediaTypeImageManifest) if err != nil { panic(err) } // Create RepoDB data for unmarshable manifest unmarshableManifestBlob := []byte("Some string") repoMetaUnmarshable := repodb.ManifestData{ ManifestBlob: unmarshableManifestBlob, ConfigBlob: validConfigBlob, } digestUnmarshableManifest := godigest.FromBytes(unmarshableManifestBlob) err = repoDB.SetManifestData(digestUnmarshableManifest, repoMetaUnmarshable) if err != nil { panic(err) } err = repoDB.SetRepoReference("repo1", "unmarshable", digestUnmarshableManifest, ispec.MediaTypeImageManifest) if err != nil { panic(err) } // Manifest meta cannot be found digestMissingManifest := godigest.FromBytes([]byte("Some other string")) err = repoDB.SetRepoReference("repo1", "missing", digestMissingManifest, ispec.MediaTypeImageManifest) if err != nil { panic(err) } // RepoMeta contains invalid digest err = repoDB.SetRepoReference("repo1", "invalid-digest", "invalid", ispec.MediaTypeImageManifest) if err != nil { panic(err) } // Continue with initializing the objects the scanner depends on metrics := monitoring.NewMetricsServer(false, log) store := local.NewImageStore(rootDir, false, storage.DefaultGCDelay, false, false, log, metrics, nil, nil) storeController := storage.StoreController{} storeController.DefaultStore = store scanner := NewScanner(storeController, repoDB, "ghcr.io/project-zot/trivy-db", log) Convey("Valid image should be scannable", t, func() { result, err := scanner.IsImageFormatScannable("repo1", "valid") So(err, ShouldBeNil) So(result, ShouldBeTrue) }) Convey("Image with layers of unsupported types should be unscannable", t, func() { result, err := scanner.IsImageFormatScannable("repo1", "unscannable-layer") So(err, ShouldNotBeNil) So(result, ShouldBeFalse) }) Convey("Image with unmarshable manifests should be unscannable", t, func() { result, err := scanner.IsImageFormatScannable("repo1", "unmarshable") So(err, ShouldNotBeNil) So(result, ShouldBeFalse) }) Convey("Image with missing manifest meta should be unscannable", t, func() { result, err := scanner.IsImageFormatScannable("repo1", "missing") So(err, ShouldNotBeNil) So(result, ShouldBeFalse) }) Convey("Image with invalid manifest digest should be unscannable", t, func() { result, err := scanner.IsImageFormatScannable("repo1", "invalid-digest") So(err, ShouldNotBeNil) So(result, ShouldBeFalse) }) Convey("Image with unknown tag should be unscannable", t, func() { result, err := scanner.IsImageFormatScannable("repo1", "unknown-tag") So(err, ShouldNotBeNil) So(result, ShouldBeFalse) }) Convey("Image with unknown repo should be unscannable", t, func() { result, err := scanner.IsImageFormatScannable("unknown-repo", "sometag") So(err, ShouldNotBeNil) So(result, ShouldBeFalse) }) } func TestDefaultTrivyDBUrl(t *testing.T) { Convey("Test trivy DB download from default location", t, func() { // Create temporary directory rootDir := t.TempDir() err := test.CopyFiles("../../../../../test/data/zot-test", path.Join(rootDir, "zot-test")) So(err, ShouldBeNil) log := log.NewLogger("debug", "") metrics := monitoring.NewMetricsServer(false, log) // Create ImageStore store := local.NewImageStore(rootDir, false, storage.DefaultGCDelay, false, false, log, metrics, nil, nil) storeController := storage.StoreController{} storeController.DefaultStore = store params := bolt.DBParameters{ RootDir: rootDir, } boltDriver, err := bolt.GetBoltDriver(params) So(err, ShouldBeNil) repoDB, err := boltdb_wrapper.NewBoltDBWrapper(boltDriver, log) So(err, ShouldBeNil) err = repodb.ParseStorage(repoDB, storeController, log) So(err, ShouldBeNil) // Use empty string for DB repository, the default url would be used internally scanner := NewScanner(storeController, repoDB, "", log) // Download DB since DB download on scan is disabled err = scanner.UpdateDB() So(err, ShouldBeNil) img := "zot-test:0.0.1" // Scanning image opts := scanner.getTrivyOptions(img) _, err = scanner.runTrivy(opts) So(err, ShouldBeNil) }) }