severity

Documentation

Index

• Constants
• func FuncShieldNameSeverity() func(sev string) (string, error)
• func IsEqualString(sev, compSev string) (bool, error)
• func IsHigherString(sev, compSev string) (bool, error)
• func IsLowerString(sev, compSev string) (bool, error)
• func NeedsRemediation(sev string) bool
• func ParseSeveritiesString(sevs []string) ([]string, error)
• func SeveritiesAll() []string
• func SeveritiesAnalyzed() []string
• func SeveritiesFinding() []string
• func SeveritiesHigher(sevs []string, sev string, inclusive bool) ([]string, error)
• func SeveritiesLower(sevs []string, sev string, inclusive bool) ([]string, error)
• func SeverityCountColorHex(sev, sevCutoffIncl string, count int) (string, error)
• type MapBool
  • func NewMapBool(def bool) MapBool
  • func (mb MapBool) AllTrue(strict bool) bool
• type Severity
  • func ParseSeverities(sevs []string) ([]Severity, error)
  • func ParseSeverity(sev string) (string, Severity, error)
  • func (s Severity) IsEqual(sev Severity) bool
  • func (s Severity) IsHigher(sev Severity) bool
  • func (s Severity) IsLower(sev Severity) bool
  • func (s Severity) NeedsRemediation() bool
• type SeverityCountsSet
  • func (sc SeverityCountsSet) WriteShields(sevs []string, fontSize int, sevCutoff string, ...) error
• type SeverityMapCVSS
  • func NewSeverityMapCVSSSeveritiesOnly(severities []string) (SeverityMapCVSS, error)
  • func NewSeverityMapFromFloat32(m map[string]float32) (SeverityMapCVSS, error)
  • func SeverityMapScoreDefault() SeverityMapCVSS
  • func (sm SeverityMapCVSS) SeverityFromScore(score decimal.Decimal) (string, error)
  • func (sm SeverityMapCVSS) SeverityFromScoreFloat32(score float32) (string, error)

Constants

const (
	// Common severities
	SeverityCritical      = "Critical"
	SeverityHigh          = "High"
	SeverityMedium        = "Medium"
	SeverityLow           = "Low"
	SeverityInformational = "Informational"
	SeverityNone          = "None"
	SeverityUnknown       = "Unknown"

	SeverityPlusNeedsRemediation = "Needs Remediation"
)

Functions

func FuncShieldNameSeverity

func FuncShieldNameSeverity() func(sev string) (string, error)

func IsEqualString

func IsEqualString(sev, compSev string) (bool, error)

IsEqualString tests if `sev` is of equal severity to the refererence severity `refSev`.

func IsHigherString

func IsHigherString(sev, compSev string) (bool, error)

IsHigherString tests if `sev` is of higher severity than the refererence severity `refSev`.

func IsLowerString

func IsLowerString(sev, compSev string) (bool, error)

IsLowerString tests if `sev` is of lower severity than the refererence severity `refSev`.

func NeedsRemediation

func NeedsRemediation(sev string) bool

func ParseSeveritiesString

func ParseSeveritiesString(sevs []string) ([]string, error)

func SeveritiesAll

func SeveritiesAll() []string

func SeveritiesAnalyzed

func SeveritiesAnalyzed() []string

func SeveritiesFinding

func SeveritiesFinding() []string

func SeveritiesHigher

func SeveritiesHigher(sevs []string, sev string, inclusive bool) ([]string, error)

SeveritiesHigher returns a subset of the provided severities with elements that with a lower index than the provided severity. The provided severities mus be ranked from high to low.

func SeveritiesLower

func SeveritiesLower(sevs []string, sev string, inclusive bool) ([]string, error)

SeveritiesLower returns a subset of the provided severities with elements that with a higher index than the provided severity. The provided severities mus be ranked from high to low.

func SeverityCountColorHex

func SeverityCountColorHex(sev, sevCutoffIncl string, count int) (string, error)

Types

type MapBool

type MapBool map[string]bool

func NewMapBool

func NewMapBool(def bool) MapBool

func (MapBool) AllTrue

func (mb MapBool) AllTrue(strict bool) bool

AllTrueStrict checks if all severities are true. Strict checks that no additional severities are included in the map.

type Severity

type Severity int

const (
	Critical Severity = iota
	High
	Medium
	Low
	Informational
	None
	Unknown
)

func ParseSeverities

func ParseSeverities(sevs []string) ([]Severity, error)

func ParseSeverity

func ParseSeverity(sev string) (string, Severity, error)

func (Severity) IsEqual

func (s Severity) IsEqual(sev Severity) bool

func (Severity) IsHigher

func (s Severity) IsHigher(sev Severity) bool

func (Severity) IsLower

func (s Severity) IsLower(sev Severity) bool

func (Severity) NeedsRemediation

func (s Severity) NeedsRemediation() bool

type SeverityCountsSet

type SeverityCountsSet struct {
	Histogram *histogram.Histogram
}

func (SeverityCountsSet) WriteShields

func (sc SeverityCountsSet) WriteShields(sevs []string,
	fontSize int,
	sevCutoff string,
	fnFilepath func(sev string) (string, error),
	fnShieldName func(sev string) (string, error),
	perm os.FileMode,
) error

type SeverityMapCVSS

type SeverityMapCVSS map[string]decimal.Decimal

func NewSeverityMapCVSSSeveritiesOnly

func NewSeverityMapCVSSSeveritiesOnly(severities []string) (SeverityMapCVSS, error)

func NewSeverityMapFromFloat32

func NewSeverityMapFromFloat32(m map[string]float32) (SeverityMapCVSS, error)

func SeverityMapScoreDefault

func SeverityMapScoreDefault() SeverityMapCVSS

func (SeverityMapCVSS) SeverityFromScore

func (sm SeverityMapCVSS) SeverityFromScore(score decimal.Decimal) (string, error)

func (SeverityMapCVSS) SeverityFromScoreFloat32

func (sm SeverityMapCVSS) SeverityFromScoreFloat32(score float32) (string, error)