imagescan

package

v3.0.9 Latest Latest Go to latest Published: May 1, 2024 License: Apache-2.0 Imports: 22 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package imagescan provides a service to scan images for vulnerabilities and helpers to set it up.

At the moment, the package uses Grype as the engine that scans images.

This section is empty.

This section is empty.

func ExceedsSeverityThreshold(scanResults *models.PresenterConfig, severity vulnerability.Severity) bool

ExceedsSeverityThreshold returns true if vulnerabilities in the scan results exceed the severity threshold, false otherwise.

Values equal to the threshold are considered failing, too.

func NewDefaultDBConfig() (db.Config, bool)

func NewVulnerabilityDB(cfg db.Config, update bool) (*store.Store, *db.Status, *db.Closer, error)

func ParseSeverity(severity string) vulnerability.Severity

ParseSeverity returns a Grype severity given a severity string

Used as a thin wrapper for ease of access from one image scan package

type RegistryCredentials struct {
	Username string
	Password string
}

func (c RegistryCredentials) IsEmpty() bool

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

Service is a facade for image scanning functionality.

It performs image scanning and everything needed in between.

func NewScanService(dbCfg db.Config) Service

func (s *Service) Scan(ctx context.Context, userInput string, creds RegistryCredentials) (*models.PresenterConfig, error)