config

Documentation

Overview

Deprecated: this is now private and should not be used outside the scanner

Index

• type Config
  • func (c *Config) ShouldIgnore(vulnID string) (bool, IgnoreEntry)
  • func (c *Config) ShouldIgnorePackage(pkg models.PackageVulns) (bool, PackageOverrideEntry)
  • func (c *Config) ShouldIgnorePackageVersion(name, version, ecosystem string) (bool, PackageOverrideEntry)
  • func (c *Config) ShouldIgnorePackageVulnerabilities(pkg models.PackageVulns) bool
  • func (c *Config) ShouldOverridePackageLicense(pkg models.PackageVulns) (bool, PackageOverrideEntry)
  • func (c *Config) ShouldOverridePackageVersionLicense(name, version, ecosystem string) (bool, PackageOverrideEntry)
• type ConfigManager
  • func (c *ConfigManager) Get(r reporter.Reporter, targetPath string) Config
  • func (c *ConfigManager) UseOverride(configPath string) error
• type IgnoreEntry
• type License
• type PackageOverrideEntry
• type Vulnerability

Types

type Config

type Config struct {
	IgnoredVulns      []IgnoreEntry          `toml:"IgnoredVulns"`
	PackageOverrides  []PackageOverrideEntry `toml:"PackageOverrides"`
	GoVersionOverride string                 `toml:"GoVersionOverride"`
	// The path to config file that this config was loaded from,
	// set by the scanner after having successfully parsed the file
	LoadPath string `toml:"-"`
}

Deprecated: this is now private and should not be used outside the scanner

func (*Config) ShouldIgnore

func (c *Config) ShouldIgnore(vulnID string) (bool, IgnoreEntry)

Deprecated: this is now private and should not be used outside the scanner

func (*Config) ShouldIgnorePackage

func (c *Config) ShouldIgnorePackage(pkg models.PackageVulns) (bool, PackageOverrideEntry)

ShouldIgnorePackage determines if the given package should be ignored based on override entries in the config

Deprecated: this is now private and should not be used outside the scanner

func (*Config) ShouldIgnorePackageVersion

func (c *Config) ShouldIgnorePackageVersion(name, version, ecosystem string) (bool, PackageOverrideEntry)

Deprecated: Use ShouldIgnorePackage instead

func (*Config) ShouldIgnorePackageVulnerabilities

func (c *Config) ShouldIgnorePackageVulnerabilities(pkg models.PackageVulns) bool

ShouldIgnorePackageVulnerabilities determines if the given package should have its vulnerabilities ignored based on override entries in the config

Deprecated: this is now private and should not be used outside the scanner

func (*Config) ShouldOverridePackageLicense

func (c *Config) ShouldOverridePackageLicense(pkg models.PackageVulns) (bool, PackageOverrideEntry)

ShouldOverridePackageLicense determines if the given package should have its license ignored or changed based on override entries in the config

Deprecated: this is now private and should not be used outside the scanner

func (*Config) ShouldOverridePackageVersionLicense

func (c *Config) ShouldOverridePackageVersionLicense(name, version, ecosystem string) (bool, PackageOverrideEntry)

Deprecated: Use ShouldOverridePackageLicense instead

type ConfigManager

type ConfigManager struct {
	// Override to replace all other configs
	OverrideConfig *Config
	// Config to use if no config file is found alongside manifests
	DefaultConfig Config
	// Cache to store loaded configs
	ConfigMap map[string]Config
}

Ignore stuttering as that would be a breaking change TODO: V2 rename?

Deprecated: this is now private and should not be used outside the scanner

func (*ConfigManager) Get

func (c *ConfigManager) Get(r reporter.Reporter, targetPath string) Config

Attempts to get the config

Deprecated: this is now private and should not be used outside the scanner

func (*ConfigManager) UseOverride

func (c *ConfigManager) UseOverride(configPath string) error

Sets the override config by reading the config file at configPath. Will return an error if loading the config file fails

Deprecated: this is now private and should not be used outside the scanner

type IgnoreEntry

type IgnoreEntry struct {
	ID          string    `toml:"id"`
	IgnoreUntil time.Time `toml:"ignoreUntil"`
	Reason      string    `toml:"reason"`
}

Deprecated: this is now private and should not be used outside the scanner

type License

type License struct {
	Override []string `toml:"override"`
	Ignore   bool     `toml:"ignore"`
}

Deprecated: this is now private and should not be used outside the scanner

type PackageOverrideEntry

type PackageOverrideEntry struct {
	Name string `toml:"name"`
	// If the version is empty, the entry applies to all versions.
	Version        string        `toml:"version"`
	Ecosystem      string        `toml:"ecosystem"`
	Group          string        `toml:"group"`
	Ignore         bool          `toml:"ignore"`
	Vulnerability  Vulnerability `toml:"vulnerability"`
	License        License       `toml:"license"`
	EffectiveUntil time.Time     `toml:"effectiveUntil"`
	Reason         string        `toml:"reason"`
}

Deprecated: this is now private and should not be used outside the scanner

type Vulnerability

type Vulnerability struct {
	Ignore bool `toml:"ignore"`
}

Deprecated: this is now private and should not be used outside the scanner