add v6 search command

Signed-off-by: Alex Goodman <[email protected]>

cmd/grype/cli/commands/db_search_vuln.go

@@ -0,0 +1,228 @@
+package commands
+
+import (
+	"encoding/json"
+	"errors"
+	"fmt"
+	"io"
+	"sort"
+	"strings"
+
+	"github.com/hashicorp/go-multierror"
+	"github.com/olekukonko/tablewriter"
+	"github.com/scylladb/go-set/strset"
+	"github.com/spf13/cobra"
+
+	"github.com/anchore/clio"
+	"github.com/anchore/grype/cmd/grype/cli/commands/internal/dbsearch"
+	"github.com/anchore/grype/cmd/grype/cli/options"
+	v6 "github.com/anchore/grype/grype/db/v6"
+	"github.com/anchore/grype/grype/db/v6/distribution"
+	"github.com/anchore/grype/grype/db/v6/installation"
+	"github.com/anchore/grype/internal/bus"
+)
+
+type dbSearchVulnerabilityOptions struct {
+	Format        options.DBSearchFormat          `yaml:",inline" mapstructure:",squash"`
+	Vulnerability options.DBSearchVulnerabilities `yaml:",inline" mapstructure:",squash"`
+	Bounds        options.DBSearchBounds          `yaml:",inline" mapstructure:",squash"`
+
+	DBOptions `yaml:",inline" mapstructure:",squash"`
+}
+
+func DBSearchVulnerabilities(app clio.Application) *cobra.Command {
+	opts := &dbSearchVulnerabilityOptions{
+		Format: options.DBSearchFormat{
+			Output: tableOutputFormat,
+			Allowable: []string{
+				tableOutputFormat,
+				jsonOutputFormat,
+			},
+		},
+		Vulnerability: options.DBSearchVulnerabilities{
+			UseVulnIDFlag: false, // we input this through the args
+		},
+		Bounds: options.DBSearchBounds{
+			RecordLimit: 1000,
+		},
+		DBOptions: *dbOptionsDefault(app.ID()),
+	}
+
+	return app.SetupCommand(&cobra.Command{
+		Use:     "vuln ID...",
+		Aliases: []string{"vulnerability", "vulnerabilities", "vulns"},
+		Short:   "Search for vulnerabilities within the DB (supports DB schema v6+ only)",
+		Args: func(_ *cobra.Command, args []string) error {
+			if len(args) == 0 {
+				return fmt.Errorf("must specify at least one vulnerability ID")
+			}
+			opts.Vulnerability.VulnerabilityIDs = args
+			return nil
+		},
+		RunE: func(_ *cobra.Command, _ []string) (err error) {
+			if !opts.Experimental.DBv6 {
+				return errors.New("this command only supports the v6+ database schemas")
+			}
+			return runDBSearchVulnerabilities(*opts)
+		},
+	}, opts)
+}
+
+func runDBSearchVulnerabilities(opts dbSearchVulnerabilityOptions) error {
+	client, err := distribution.NewClient(opts.DB.ToClientConfig())
+	if err != nil {
+		return fmt.Errorf("unable to create distribution client: %w", err)
+	}
+
+	c, err := installation.NewCurator(opts.DB.ToCuratorConfig(), client)
+	if err != nil {
+		return fmt.Errorf("unable to create curator: %w", err)
+	}
+
+	reader, err := c.Reader()
+	if err != nil {
+		return fmt.Errorf("unable to get providers: %w", err)
+	}
+
+	if err := validateProvidersFilter(reader, opts.Vulnerability.Providers); err != nil {
+		return err
+	}
+
+	rows, err := dbsearch.Vulnerabilities(reader, dbsearch.VulnerabilitiesOptions{
+		Vulnerability: opts.Vulnerability.Specs,
+		RecordLimit:   opts.Bounds.RecordLimit,
+	})
+	if err != nil {
+		return err
+	}
+
+	if len(rows) == 0 {
+		return errors.New("no vulnerabilities found")
+	}
+
+	sb := &strings.Builder{}
+	err = presentDBSearchVulnerabilities(opts.Format.Output, rows, sb)
+	bus.Report(sb.String())
+	return err
+}
+
+func validateProvidersFilter(reader v6.Reader, providers []string) error {
+	if len(providers) == 0 {
+		return nil
+	}
+	availableProviders, err := reader.AllProviders()
+	if err != nil {
+		return fmt.Errorf("unable to get providers: %w", err)
+	}
+	activeProviders := strset.New()
+	for _, p := range availableProviders {
+		activeProviders.Add(p.ID)
+	}
+
+	provSet := strset.New(providers...)
+
+	diff := strset.Difference(provSet, activeProviders)
+	diffList := diff.List()
+	sort.Strings(diffList)
+	var errs error
+	for _, p := range diffList {
+		errs = multierror.Append(errs, fmt.Errorf("provider not found: %q", p))
+	}
+
+	return errs
+}
+
+func presentDBSearchVulnerabilities(outputFormat string, structuredRows []dbsearch.VulnerabilityRow, output io.Writer) error {
+	if len(structuredRows) == 0 {
+		// TODO: show a message that no results were found?
+		return nil
+	}
+
+	switch outputFormat {
+	case tableOutputFormat:
+		rows := renderDBSearchVulnerabilitiesTableRows(structuredRows)
+
+		table := tablewriter.NewWriter(output)
+		commonTableWriterOptions(table)
+
+		table.SetHeader([]string{"ID", "Provider", "Published", "Severity", "Reference"})
+		table.AppendBulk(rows)
+		table.Render()
+	case jsonOutputFormat:
+		enc := json.NewEncoder(output)
+		enc.SetEscapeHTML(false)
+		enc.SetIndent("", " ")
+		if err := enc.Encode(structuredRows); err != nil {
+			return fmt.Errorf("failed to encode diff information: %+v", err)
+		}
+	default:
+		return fmt.Errorf("unsupported output format: %s", outputFormat)
+	}
+	return nil
+}
+
+func renderDBSearchVulnerabilitiesTableRows(structuredRows []dbsearch.VulnerabilityRow) [][]string {
+	type row struct {
+		Vuln                    string
+		ProviderWithoutVersions string
+		PublishedDate           string
+		Severity                string
+		Reference               string
+	}
+
+	versionsByRow := make(map[row][]string)
+	for _, rr := range structuredRows {
+		// get the first severity value (which is ranked highest)
+		var sev string
+		if len(rr.Severities) > 0 {
+			sev = fmt.Sprintf("%s", rr.Severities[0].Value)
+		}
+
+		prov := rr.Provider
+		var versions []string
+		for _, os := range rr.OperatingSystems {
+			versions = append(versions, os.Version)
+		}
+
+		var published string
+		if rr.PublishedDate != nil && !rr.PublishedDate.IsZero() {
+			published = rr.PublishedDate.Format("2006-01-02")
+		}
+
+		var ref string
+		if len(rr.References) > 0 {
+			ref = rr.References[0].URL
+		}
+
+		r := row{
+			Vuln:                    rr.ID,
+			ProviderWithoutVersions: prov,
+			PublishedDate:           published,
+			Severity:                sev,
+			Reference:               ref,
+		}
+		versionsByRow[r] = append(versionsByRow[r], versions...)
+	}
+
+	var rows [][]string
+	for r, versions := range versionsByRow {
+		prov := r.ProviderWithoutVersions
+		if len(versions) > 0 {
+			sort.Strings(versions)
+			prov = fmt.Sprintf("%s (%s)", r.ProviderWithoutVersions, strings.Join(versions, ", "))
+		}
+		rows = append(rows, []string{r.Vuln, prov, r.PublishedDate, r.Severity, r.Reference})
+	}
+
+	// sort rows by each column
+	sort.Slice(rows, func(i, j int) bool {
+		for k := range rows[i] {
+			if rows[i][k] != rows[j][k] {
+				return rows[i][k] < rows[j][k]
+			}
+		}
+		return false
+	})
+
+	return rows
+}