scan

Documentation

Index

• Constants
• Variables
• type Finding
  • func FilterWithAdvisories(result *Result, advisoryCfgs *configs.Index[v2.Document], ...) ([]*Finding, error)
• type Package
• type Result
  • func APKSBOM(r io.Reader, localDBFilePath string) (*Result, error)
• type TargetAPK
  • func (t TargetAPK) Origin() string
• type Vulnerability

Constants

const (
	AdvisoriesSetResolved = "resolved"
	AdvisoriesSetAll      = "all"
)

Variables

var ValidAdvisoriesSets = []string{AdvisoriesSetResolved, AdvisoriesSetAll}

Types

type Finding

type Finding struct {
	Package       Package
	Vulnerability Vulnerability
}

Finding represents a vulnerability finding for a single package.

func FilterWithAdvisories

func FilterWithAdvisories(result *Result, advisoryCfgs *configs.Index[v2.Document], advisoryFilterSet string) ([]*Finding, error)

FilterWithAdvisories filters the findings in the result based on the advisories for the target APK.

type Package

type Package struct {
	ID       string
	Name     string
	Version  string
	Type     string
	Location string
}

type Result

type Result struct {
	TargetAPK TargetAPK
	Findings  []*Finding
}

func APKSBOM

func APKSBOM(r io.Reader, localDBFilePath string) (*Result, error)

APKSBOM scans an SBOM of an APK for vulnerabilities.

type TargetAPK

type TargetAPK struct {
	Name              string
	Version           string
	OriginPackageName string
}

func (TargetAPK) Origin

func (t TargetAPK) Origin() string

Origin returns the name of the origin package, if the package's metadata indicates an origin package. Otherwise, it returns the package name.

type Vulnerability

type Vulnerability struct {
	ID           string
	Severity     string
	Aliases      []string
	FixedVersion string
}