report

Documentation

Index

• Constants
• Variables
• func Write(report Report, option Option) error
• type JSONWriter
  • func (jw JSONWriter) Write(report Report) error
• type Metadata
• type MisconfSummary
  • func (s MisconfSummary) Empty() bool
• type Option
• type Report
• type Result
• type ResultClass
• type Results
  • func (results Results) Failed() bool
• type TableWriter
  • func (tw TableWriter) Println(a ...interface{})
  • func (tw TableWriter) Write(report Report) error
• type TemplateWriter
  • func NewTemplateWriter(output io.Writer, outputTemplate string) (*TemplateWriter, error)
  • func (tw TemplateWriter) Write(report Report) error
• type Writer

Constants

const (
	ClassOSPkg   = "os-pkgs"
	ClassLangPkg = "lang-pkgs"
	ClassConfig  = "config"
)

const (
	SchemaVersion = 2
)

Variables

var Now = time.Now

Now returns the current time

Functions

func Write

func Write(report Report, option Option) error

Write writes the result to output, format as passed in argument

Types

type JSONWriter

type JSONWriter struct {
	Output io.Writer
}

JSONWriter implements result Writer

func (JSONWriter) Write

func (jw JSONWriter) Write(report Report) error

Write writes the results in JSON format

type Metadata

type Metadata struct {
	Size int64      `json:",omitempty"`
	OS   *ftypes.OS `json:",omitempty"`

	// Container image
	RepoTags    []string `json:",omitempty"`
	RepoDigests []string `json:",omitempty"`
}

Metadata represents a metadata of artifact

type MisconfSummary

type MisconfSummary struct {
	Successes  int
	Failures   int
	Exceptions int
}

func (MisconfSummary) Empty

func (s MisconfSummary) Empty() bool

type Option

type Option struct {
	Format         string
	Output         io.Writer
	Severities     []dbTypes.Severity
	OutputTemplate string
	Light          bool

	// For misconfigurations
	IncludeNonFailures bool
	Trace              bool
}

type Report

type Report struct {
	SchemaVersion int                 `json:",omitempty"`
	ArtifactName  string              `json:",omitempty"`
	ArtifactType  ftypes.ArtifactType `json:",omitempty"`
	Metadata      Metadata            `json:",omitempty"`
	Results       Results             `json:",omitempty"`
}

Report represents a scan result

type Result

type Result struct {
	Target            string                           `json:"Target"`
	Class             ResultClass                      `json:"Class,omitempty"`
	Type              string                           `json:"Type,omitempty"`
	Packages          []ftypes.Package                 `json:"Packages,omitempty"`
	Vulnerabilities   []types.DetectedVulnerability    `json:"Vulnerabilities,omitempty"`
	MisconfSummary    *MisconfSummary                  `json:"MisconfSummary,omitempty"`
	Misconfigurations []types.DetectedMisconfiguration `json:"Misconfigurations,omitempty"`
}

Result holds a target and detected vulnerabilities

type ResultClass

type ResultClass string

type Results

type Results []Result

Results to hold list of Result

func (Results) Failed

func (results Results) Failed() bool

Failed returns whether the result includes any vulnerabilities or misconfigurations

type TableWriter

type TableWriter struct {
	Severities []dbTypes.Severity
	Output     io.Writer

	// For vulnerabilities
	Light bool

	// For misconfigurations
	IncludeNonFailures bool
	Trace              bool
}

TableWriter implements Writer and output in tabular form

func (TableWriter) Println

func (tw TableWriter) Println(a ...interface{})

func (TableWriter) Write

func (tw TableWriter) Write(report Report) error

Write writes the result on standard output

type TemplateWriter

type TemplateWriter struct {
	Output   io.Writer
	Template *template.Template
}

TemplateWriter write result in custom format defined by user's template

func NewTemplateWriter

func NewTemplateWriter(output io.Writer, outputTemplate string) (*TemplateWriter, error)

NewTemplateWriter is the factory method to return TemplateWriter object

func (TemplateWriter) Write

func (tw TemplateWriter) Write(report Report) error

Write writes result

type Writer

type Writer interface {
	Write(Report) error
}

Writer defines the result write operation