pkg/report/table/table.go - main - githubmirror/trivy

pkg/report/table/table.go
209 строк5 KB
Matthieu MOREL
chore: enable staticcheck (#8815)
07 май 2025, 09:15
07 май 2025, 09:153b1426a
package table

import (
	"bytes"
	"context"
	"fmt"
	"io"
	"os"
	"runtime"
	"slices"
	"strings"

	"github.com/fatih/color"

	"github.com/aquasecurity/table"
	"github.com/aquasecurity/tml"
	dbTypes "github.com/aquasecurity/trivy-db/pkg/types"
	ftypes "github.com/aquasecurity/trivy/pkg/fanal/types"
	"github.com/aquasecurity/trivy/pkg/types"
)

var (
	SeverityColor = []func(a ...any) string{
		color.New(color.FgCyan).SprintFunc(),   // UNKNOWN
		color.New(color.FgBlue).SprintFunc(),   // LOW
		color.New(color.FgYellow).SprintFunc(), // MEDIUM
		color.New(color.FgHiRed).SprintFunc(),  // HIGH
		color.New(color.FgRed).SprintFunc(),    // CRITICAL
	}
)

// Writer implements Writer and output in tabular form
type Writer struct {
	// Use one buffer for all renderers
	buf *bytes.Buffer

	summaryRenderer       *summaryRenderer
	vulnerabilityRenderer Renderer
	misconfigRenderer     Renderer
	secretRenderer        Renderer
	pkgLicenseRenderer    Renderer
	fileLicenseRenderer   Renderer

	options Options
}

type Options struct {
	Scanners   types.Scanners
	Severities []dbTypes.Severity
	Output     io.Writer

	// Show dependency origin tree
	Tree bool

	// Show suppressed findings
	ShowSuppressed bool

	// Show/hide summary/detailed tables
	TableModes []types.TableMode

	// For misconfigurations
	IncludeNonFailures bool
	Trace              bool
	RenderCause        []ftypes.ConfigType

	// For licenses
	LicenseRiskThreshold int
	IgnoredLicenses      []string
}

func NewWriter(options Options) *Writer {
	buf := bytes.NewBuffer([]byte{})
	isTerminal := IsOutputToTerminal(options.Output)
	return &Writer{
		buf: buf,

		summaryRenderer:       NewSummaryRenderer(buf, isTerminal, options.Scanners),
		vulnerabilityRenderer: NewVulnerabilityRenderer(buf, isTerminal, options.Tree, options.ShowSuppressed, options.Severities),
		misconfigRenderer:     NewMisconfigRenderer(buf, options.Severities, options.Trace, options.IncludeNonFailures, isTerminal, options.RenderCause),
		secretRenderer:        NewSecretRenderer(buf, isTerminal, options.Severities),
		pkgLicenseRenderer:    NewPkgLicenseRenderer(buf, isTerminal, options.Severities),
		fileLicenseRenderer:   NewFileLicenseRenderer(buf, isTerminal, options.Severities),
		options:               options,
	}
}

type Renderer interface {
	Render(result types.Result)
}

// Write writes the result on standard output
func (tw *Writer) Write(_ context.Context, report types.Report) error {
	if slices.Contains(tw.options.TableModes, types.Summary) {
		tw.summaryRenderer.Render(report)
	}

	if slices.Contains(tw.options.TableModes, types.Detailed) {
		for _, result := range report.Results {
			// Not display a table of custom resources
			if result.Class == types.ClassCustom {
				continue
			}
			tw.render(result)
		}
	}

	tw.flush()
	return nil
}

func (tw *Writer) flush() {
	_, _ = fmt.Fprint(tw.options.Output, tw.buf.String())
	tw.buf.Reset()
}

func (tw *Writer) render(result types.Result) {
	if result.IsEmpty() && result.Class != types.ClassOSPkg {
		return
	}

	switch result.Class {
	// vulnerability
	case types.ClassOSPkg, types.ClassLangPkg:
		tw.vulnerabilityRenderer.Render(result)
	// misconfiguration
	case types.ClassConfig:
		tw.misconfigRenderer.Render(result)
	// secret
	case types.ClassSecret:
		tw.secretRenderer.Render(result)
	// package license
	case types.ClassLicense:
		tw.pkgLicenseRenderer.Render(result)
	// file license
	case types.ClassLicenseFile:
		tw.fileLicenseRenderer.Render(result)
	default:
		return
	}
}

func newTableWriter(output io.Writer, isTerminal bool) *table.Table {
	tableWriter := table.New(output)
	if isTerminal { // use ansi output if we're not piping elsewhere
		tableWriter.SetHeaderStyle(table.StyleBold)
		tableWriter.SetLineStyle(table.StyleDim)
	}
	tableWriter.SetBorders(true)
	tableWriter.SetAutoMerge(true)
	tableWriter.SetRowLines(true)

	return tableWriter
}

func summarize(specifiedSeverities []dbTypes.Severity, severityCount map[string]int) (int, []string) {
	var total int
	var severities []string
	for _, sev := range specifiedSeverities {
		severities = append(severities, sev.String())
	}

	var summaries []string
	for _, severity := range dbTypes.SeverityNames {
		if !slices.Contains(severities, severity) {
			continue
		}
		count := severityCount[severity]
		r := fmt.Sprintf("%s: %d", severity, count)
		summaries = append(summaries, r)
		total += count
	}

	return total, summaries
}

func IsOutputToTerminal(output io.Writer) bool {
	if runtime.GOOS == "windows" {
		// if its windows, we don't support formatting
		return false
	}

	if output != os.Stdout {
		return false
	}
	o, err := os.Stdout.Stat()
	if err != nil {
		return false
	}
	return (o.Mode() & os.ModeCharDevice) == os.ModeCharDevice
}

func RenderTarget(w io.Writer, target string, isTerminal bool) {
	if isTerminal {
		// nolint
		_ = tml.Fprintf(w, "\n<underline><bold>%s</bold></underline>\n\n", target)
	} else {
		_, _ = fmt.Fprintf(w, "\n%s\n", target)
		_, _ = fmt.Fprintf(w, "%s\n", strings.Repeat("=", len(target)))
	}
}

func ColorizeSeverity(value, severity string) string {
	for i, name := range dbTypes.SeverityNames {
		if severity == name {
			return SeverityColor[i](value)
		}
	}
	return color.New(color.FgBlue).SprintFunc()(severity)
}