report

package

v1.17.1 Latest Latest Go to latest Published: Nov 10, 2025 License: Apache-2.0 Imports: 15 Imported by: 2

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/chainguard-dev/malcontent

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Generate(ctx context.Context, path string, mrs *yarax.ScanResults, c malcontent.Config, ...) (*malcontent.FileReport, error)
func HighestMatchRisk(mrs *yarax.ScanResults) int
func TrimPrefixes(path string, prefixes []string) string
type StringPool
- func NewStringPool(length int) *StringPool
- func (sp *StringPool) Intern(s string) string

Constants ¶

View Source

const (
	INVALID int = iota - 1
	HARMLESS
	LOW
	MEDIUM
	HIGH
	CRITICAL
)

View Source

const NAME string = "malcontent"

Variables ¶

View Source

var Levels = map[string]int{
	"ignore":     INVALID,
	"none":       INVALID,
	"harmless":   HARMLESS,
	"low":        LOW,
	"notable":    MEDIUM,
	"medium":     MEDIUM,
	"suspicious": HIGH,
	"weird":      HIGH,
	"high":       HIGH,
	"crit":       CRITICAL,
	"critical":   CRITICAL,
}

Map to handle RiskLevel -> RiskScore conversions.

View Source

var RiskLevels = map[int]string{
	INVALID:  "NONE",
	HARMLESS: "NONE",
	LOW:      "LOW",
	MEDIUM:   "MEDIUM",
	HIGH:     "HIGH",
	CRITICAL: "CRITICAL",
}

Map to handle RiskScore -> RiskLevel conversions.

Functions ¶

func Generate ¶

func Generate(ctx context.Context, path string, mrs *yarax.ScanResults, c malcontent.Config, expath string, _ *clog.Logger, fc []byte, size int64, checksum string, kind *programkind.FileType, highestRisk int) (*malcontent.FileReport, error)

func HighestMatchRisk ¶ added in v1.10.0

func HighestMatchRisk(mrs *yarax.ScanResults) int

HighestMatchRisk returns the highest risk score from a slice of MatchRules.

func TrimPrefixes ¶ added in v1.5.0

func TrimPrefixes(path string, prefixes []string) string

TrimPrefixes removes the specified prefix from a given path for the purposes of sample test data generation. This function will only be used via the refresh package.

Types ¶

type StringPool ¶ added in v1.8.0

type StringPool struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

StringPool holds data to handle string interning.

func NewStringPool ¶ added in v1.8.0

func NewStringPool(length int) *StringPool

NewStringPool creates a new string pool.

func (*StringPool) Intern ¶ added in v1.8.0

func (sp *StringPool) Intern(s string) string

Intern returns an interned version of the input string.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL