ci

Documentation

Index

• Variables
• func CDX(cdx *cyclonedx.BOM) string
• func GetJoinedSeverities() string
• func IsValidSeverity(severity string) bool
• func MatchTable(matches []Match)
• func Run(ci config.CIConfiguration, cdx *cyclonedx.BOM)
• func TallyTable(tally Tally) string
• func Vex(cdx *cyclonedx.BOM) string
• type Assessment
  • func Evaluate(criteria string, cdx *cyclonedx.BOM) Assessment
• type CIModeConfig
  • func SetupCIMode(ci, quiet bool, failCriteria string) CIModeConfig
• type Match
• type Tally

Variables

var Severities = []string{
	"unknown",
	"negligible",
	"low",
	"medium",
	"high",
	"critical",
}

Functions

func CDX

func CDX(cdx *cyclonedx.BOM) string

func GetJoinedSeverities

func GetJoinedSeverities() string

func IsValidSeverity

func IsValidSeverity(severity string) bool

func MatchTable

func MatchTable(matches []Match)

func Run

func Run(ci config.CIConfiguration, cdx *cyclonedx.BOM)

Run implements CI logic for vulnerability analysis

func TallyTable

func TallyTable(tally Tally) string

func Vex

func Vex(cdx *cyclonedx.BOM) string

Types

type Assessment

type Assessment struct {
	Tally        Tally
	FailCriteria string
	Matches      []Match
	Passed       bool
}

func Evaluate

func Evaluate(criteria string, cdx *cyclonedx.BOM) Assessment

type CIModeConfig

type CIModeConfig struct {
	Quiet        bool
	FailCriteria string
}

CIModeConfig holds CI-related configuration

func SetupCIMode

func SetupCIMode(ci, quiet bool, failCriteria string) CIModeConfig

SetupCIMode configures CI-related settings and returns the configuration

type Match

type Match struct {
	Component     *cyclonedx.Component
	Vulnerability *cyclonedx.Vulnerability
}

type Tally

type Tally struct {
	Unknown    int
	Negligible int
	Low        int
	Medium     int
	High       int
	Critical   int
}