remediation

Documentation

Index

• func ComputeRelaxPatches(ctx context.Context, cl client.ResolutionClient, ...) ([]resolution.ResolutionDiff, error)
• type InPlacePatch
• type InPlaceResult
  • func ComputeInPlacePatches(ctx context.Context, cl client.ResolutionClient, graph *resolve.Graph, ...) (InPlaceResult, error)
  • func (r InPlaceResult) VulnCount() VulnCount
• type RemediationOptions
  • func (opts RemediationOptions) MatchVuln(v resolution.ResolutionVuln) bool
• type VulnCount
  • func (vc VulnCount) Total() int

Functions

func ComputeRelaxPatches

func ComputeRelaxPatches(ctx context.Context, cl client.ResolutionClient, result *resolution.ResolutionResult, opts RemediationOptions) ([]resolution.ResolutionDiff, error)

ComputeRelaxPatches attempts to resolve each vulnerability found in result independently, returning the list of unique possible patches

Types

type InPlacePatch

type InPlacePatch struct {
	lf.DependencyPatch
	ResolvedVulns []resolution.ResolutionVuln
}

type InPlaceResult

type InPlaceResult struct {
	Patches   []InPlacePatch
	Unfixable []resolution.ResolutionVuln
}

func ComputeInPlacePatches

func ComputeInPlacePatches(ctx context.Context, cl client.ResolutionClient, graph *resolve.Graph, opts RemediationOptions) (InPlaceResult, error)

ComputeInPlacePatches finds all possible targeting version changes that would fix vulnerabilities in a resolved graph. TODO: Check for introduced vulnerabilities

func (InPlaceResult) VulnCount

func (r InPlaceResult) VulnCount() VulnCount

type RemediationOptions

type RemediationOptions struct {
	IgnoreVulns   []string // Vulnerability IDs to ignore
	ExplicitVulns []string // If set, only consider these vulnerability IDs & ignore all others

	DevDeps     bool    // Whether to consider vulnerabilities in dev dependencies
	MinSeverity float64 // Minimum vulnerability CVSS score to consider
	MaxDepth    int     // Maximum depth of dependency to consider vulnerabilities for (e.g. 1 for direct only)

	AvoidPkgs  []string // Names of dependencies to avoid upgrading
	AllowMajor bool     // Whether to allow changes to major versions of direct dependencies
}

func (RemediationOptions) MatchVuln

func (opts RemediationOptions) MatchVuln(v resolution.ResolutionVuln) bool

type VulnCount

type VulnCount struct {
	Direct     int
	Transitive int

	// Note: These are metrics that overlap with Direct/Transitive, and with each other.
	Unfixable int
	Dev       int
}

func (VulnCount) Total

func (vc VulnCount) Total() int