module

Documentation

Index

• Variables
• type Checker
  • func (c *Checker) Check(path string) (map[string]internal.CheckResult, error)
• type ModParser
  • func NewModParser(ctx context.Context) *ModParser
  • func (v *ModParser) Parse(path string) ([]PackageResult, error)
• type PackageResult
• type Scanner
  • func (c *Scanner) Scan(path string) (map[string]internal.VulnerabilityResult, error)
• type Updater
  • func (u *Updater) Update(path string) (map[string]internal.CheckResult, error)

Variables

var ErrModuleIgnored = errors.New("module ignored")

ErrModuleIgnored is returned when a module is ignored for version check.

var ErrNoVersionAvailable = errors.New("no version available")

ErrNoVersionAvailable is returned when no version found for a module.

Types

type Checker

type Checker struct {
	Ctx context.Context
}

Checker is exported

func (*Checker) Check

func (c *Checker) Check(path string) (map[string]internal.CheckResult, error)

Check is exported.

type ModParser

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

ModParser parses go.mod.

func NewModParser

func NewModParser(ctx context.Context) *ModParser

NewModParser creates a new ModParser.

func (*ModParser) Parse

func (v *ModParser) Parse(path string) ([]PackageResult, error)

Parse is exported

type PackageResult

type PackageResult struct {
	Path              string
	LocalVersion      *semver.Version
	AvailableVersions []*semver.Version
	Dir               string
}

PackageResult contains module specific information.

type Scanner

type Scanner struct {
	Ctx context.Context
}

Scanner is exported.

func (*Scanner) Scan

func (c *Scanner) Scan(path string) (map[string]internal.VulnerabilityResult, error)

Scan is exported.

type Updater

type Updater struct {
	Ctx context.Context
}

Updater is exported

func (*Updater) Update

func (u *Updater) Update(path string) (map[string]internal.CheckResult, error)

Update is exported