feat(server): add version endpoint (#4869)

* feat(server): add version endpoint * fix panic and test * move version.go * move version variable * add docs about endpoints * move testdata * refactor * update build command * refactor
2025-12-12 15:50:15 -08:00 · 2023-08-20 13:12:31 +07:00
parent 63cd41d20d
commit d442176405
20 changed files with 319 additions and 141 deletions
--- a/pkg/version/version.go
+++ b/pkg/version/version.go
@@ -0,0 +1,107 @@
+package version
+
+import (
+	"fmt"
+	"path/filepath"
+
+	"github.com/aquasecurity/trivy-db/pkg/metadata"
+	javadb "github.com/aquasecurity/trivy-java-db/pkg/db"
+	"github.com/aquasecurity/trivy/pkg/log"
+	"github.com/aquasecurity/trivy/pkg/policy"
+)
+
+var (
+	ver = "dev"
+)
+
+func AppVersion() string {
+	return ver
+}
+
+type VersionInfo struct {
+	Version         string             `json:",omitempty"`
+	VulnerabilityDB *metadata.Metadata `json:",omitempty"`
+	JavaDB          *metadata.Metadata `json:",omitempty"`
+	PolicyBundle    *policy.Metadata   `json:",omitempty"`
+}
+
+func formatDBMetadata(title string, meta metadata.Metadata) string {
+	return fmt.Sprintf(`%s:
+  Version: %d
+  UpdatedAt: %s
+  NextUpdate: %s
+  DownloadedAt: %s
+`, title, meta.Version, meta.UpdatedAt.UTC(), meta.NextUpdate.UTC(), meta.DownloadedAt.UTC())
+}
+
+func (v *VersionInfo) String() string {
+	output := fmt.Sprintf("Version: %s\n", v.Version)
+	if v.VulnerabilityDB != nil {
+		output += formatDBMetadata("Vulnerability DB", *v.VulnerabilityDB)
+	}
+	if v.JavaDB != nil {
+		output += formatDBMetadata("Java DB", *v.JavaDB)
+	}
+	if v.PolicyBundle != nil {
+		output += v.PolicyBundle.String()
+	}
+	return output
+}
+
+func NewVersionInfo(cacheDir string) VersionInfo {
+	var dbMeta *metadata.Metadata
+	var javadbMeta *metadata.Metadata
+
+	mc := metadata.NewClient(cacheDir)
+	meta, err := mc.Get()
+	if err != nil {
+		log.Logger.Debugw("Failed to get DB metadata", "error", err)
+	}
+	if !meta.UpdatedAt.IsZero() && !meta.NextUpdate.IsZero() && meta.Version != 0 {
+		dbMeta = &metadata.Metadata{
+			Version:      meta.Version,
+			NextUpdate:   meta.NextUpdate.UTC(),
+			UpdatedAt:    meta.UpdatedAt.UTC(),
+			DownloadedAt: meta.DownloadedAt.UTC(),
+		}
+	}
+
+	mcJava := javadb.NewMetadata(filepath.Join(cacheDir, "java-db"))
+	metaJava, err := mcJava.Get()
+	if err != nil {
+		log.Logger.Debugw("Failed to get Java DB metadata", "error", err)
+	}
+	if !metaJava.UpdatedAt.IsZero() && !metaJava.NextUpdate.IsZero() && metaJava.Version != 0 {
+		javadbMeta = &metadata.Metadata{
+			Version:      metaJava.Version,
+			NextUpdate:   metaJava.NextUpdate.UTC(),
+			UpdatedAt:    metaJava.UpdatedAt.UTC(),
+			DownloadedAt: metaJava.DownloadedAt.UTC(),
+		}
+	}
+
+	var pbMeta *policy.Metadata
+	pc, err := policy.NewClient(cacheDir, false, "")
+	if err != nil {
+		log.Logger.Debugw("Failed to instantiate policy client", "error", err)
+	}
+	if pc != nil && err == nil {
+		pbMetaRaw, err := pc.GetMetadata()
+
+		if err != nil {
+			log.Logger.Debugw("Failed to get policy metadata", "error", err)
+		} else {
+			pbMeta = &policy.Metadata{
+				Digest:       pbMetaRaw.Digest,
+				DownloadedAt: pbMetaRaw.DownloadedAt.UTC(),
+			}
+		}
+	}
+
+	return VersionInfo{
+		Version:         ver,
+		VulnerabilityDB: dbMeta,
+		JavaDB:          javadbMeta,
+		PolicyBundle:    pbMeta,
+	}
+}