scanner

Documentation

Index

• Variables
• func ScanSnapshot(ctx context.Context, scanner Scanner, snapshot *hub.SnapshotToScan) (*hub.SnapshotSecurityReport, error)
• type Mock
  • func (m *Mock) Scan(image string) ([]byte, error)
• type Scanner
• type Target
• type TrivyScanner
  • func (s *TrivyScanner) Scan(image string) ([]byte, error)
• type Vulnerability

Variables

var ErrImageNotFound = errors.New("image not found")

ErrImageNotFound represents that the image provided was not found in the repository.

Functions

func ScanSnapshot

func ScanSnapshot(
	ctx context.Context,
	scanner Scanner,
	snapshot *hub.SnapshotToScan,
) (*hub.SnapshotSecurityReport, error)

ScanSnapshot scans the provided package's snapshot for security vulnerabilities returning a report with the results.

Types

type Mock

type Mock struct {
	mock.Mock
}

Mock is a mock implementation of the Scanner interface.

func (*Mock) Scan

func (m *Mock) Scan(image string) ([]byte, error)

Scan implements the Scanner interface.

type Scanner

type Scanner interface {
	Scan(image string) ([]byte, error)
}

Scanner describes the methods a Scanner implementation must provide.

type Target

type Target struct {
	Vulnerabilities []*Vulnerability `json:"Vulnerabilities"`
}

Target represents a target in a security report.

type TrivyScanner

type TrivyScanner struct {
	Ctx context.Context
	URL string
}

TrivyScanner is an implementation of the Scanner interface that uses Trivy.

func (*TrivyScanner) Scan

func (s *TrivyScanner) Scan(image string) ([]byte, error)

Scan implements the Scanner interface.

type Vulnerability

type Vulnerability struct {
	Severity string `json:"Severity"`
}

Vulnerability represents a vulnerability in a security report target.