report

Documentation

Index

• Constants
• func ColumnHeading(scanners types.Scanners, components, availableColumns []string) []string
• func InfraColumns() []string
• func RoleColumns() []string
• func SeparateMisconfigReports(k8sReport Report, scanners types.Scanners, components []string) []reports
• func WorkloadColumns() []string
• type ConsolidatedReport
• type CycloneDXWriter
  • func NewCycloneDXWriter(output io.Writer, format cdx.BOMFileFormat, appVersion string) CycloneDXWriter
  • func (w CycloneDXWriter) Write(component *core.Component) error
• type JSONWriter
  • func (jw JSONWriter) Write(report Report) error
• type Option
• type Report
  • func (r Report) Failed() bool
  • func (r Report) PrintErrors()
• type Resource
  • func CreateResource(artifact *artifacts.Artifact, report types.Report, err error) Resource
• type SummaryWriter
  • func NewSummaryWriter(output io.Writer, requiredSevs []dbTypes.Severity, columnHeading []string) SummaryWriter
  • func (s SummaryWriter) Write(report Report) error
• type TableWriter
  • func (tw TableWriter) Write(report Report) error
• type Writer

Constants

const (
	AllReport     = "all"
	SummaryReport = "summary"
)

const (
	NamespaceColumn         = "Namespace"
	ResourceColumn          = "Resource"
	VulnerabilitiesColumn   = "Vulnerabilities"
	MisconfigurationsColumn = "Misconfigurations"
	SecretsColumn           = "Secrets"
	RbacAssessmentColumn    = "RBAC Assessment"
	InfraAssessmentColumn   = "Kubernetes Infra Assessment"
)

Functions

func ColumnHeading

func ColumnHeading(scanners types.Scanners, components, availableColumns []string) []string

func InfraColumns

func InfraColumns() []string

func RoleColumns

func RoleColumns() []string

func SeparateMisconfigReports

func SeparateMisconfigReports(k8sReport Report, scanners types.Scanners, components []string) []reports

SeparateMisconfigReports returns 3 reports based on scanners and components flags, - misconfiguration report - rbac report - infra checks report

func WorkloadColumns

func WorkloadColumns() []string

Types

type ConsolidatedReport

type ConsolidatedReport struct {
	SchemaVersion int `json:",omitempty"`
	ClusterName   string
	Findings      []Resource `json:",omitempty"`
}

ConsolidatedReport represents a kubernetes scan report with consolidated findings

type CycloneDXWriter

type CycloneDXWriter struct {
	// contains filtered or unexported fields
}

CycloneDXWriter implements types.Writer

func NewCycloneDXWriter

func NewCycloneDXWriter(output io.Writer, format cdx.BOMFileFormat, appVersion string) CycloneDXWriter

NewCycloneDXWriter constract new CycloneDXWriter

func (CycloneDXWriter) Write

func (w CycloneDXWriter) Write(component *core.Component) error

type JSONWriter

type JSONWriter struct {
	Output io.Writer
	Report string
}

func (JSONWriter) Write

func (jw JSONWriter) Write(report Report) error

Write writes the results in JSON format

type Option

type Option struct {
	Format        types.Format
	Report        string
	Output        io.Writer
	Severities    []dbTypes.Severity
	ColumnHeading []string
	Scanners      types.Scanners
	Components    []string
	APIVersion    string
}

type Report

type Report struct {
	SchemaVersion int `json:",omitempty"`
	ClusterName   string
	Resources     []Resource      `json:",omitempty"`
	RootComponent *core.Component `json:"-"`
	// contains filtered or unexported fields
}

Report represents a kubernetes scan report

func (Report) Failed

func (r Report) Failed() bool

Failed returns whether the k8s report includes any vulnerabilities or misconfigurations

func (Report) PrintErrors

func (r Report) PrintErrors()

type Resource

type Resource struct {
	Namespace string `json:",omitempty"`
	Kind      string
	Name      string
	Metadata  types.Metadata `json:",omitempty"`
	Results   types.Results  `json:",omitempty"`
	Error     string         `json:",omitempty"`

	// original report
	Report types.Report `json:"-"`
}

Resource represents a kubernetes resource report

func CreateResource

func CreateResource(artifact *artifacts.Artifact, report types.Report, err error) Resource

type SummaryWriter

type SummaryWriter struct {
	Output           io.Writer
	Severities       []string
	SeverityHeadings []string
	ColumnsHeading   []string
}

func NewSummaryWriter

func NewSummaryWriter(output io.Writer, requiredSevs []dbTypes.Severity, columnHeading []string) SummaryWriter

func (SummaryWriter) Write

func (s SummaryWriter) Write(report Report) error

Write writes the results in a summarized table format

type TableWriter

type TableWriter struct {
	Report        string
	Output        io.Writer
	Severities    []dbTypes.Severity
	ColumnHeading []string
}

func (TableWriter) Write

func (tw TableWriter) Write(report Report) error

type Writer

type Writer interface {
	Write(Report) error
}

Writer defines the result write operation