config

Documentation

Index

• type Config
  • func (c *Config) ShouldIgnore(vulnID string) (bool, IgnoreEntry)
  • func (c *Config) ShouldIgnorePackageVersion(name, version, ecosystem string) (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

Types

type Config

type Config struct {
	IgnoredVulns      []IgnoreEntry          `toml:"IgnoredVulns"`
	PackageOverrides  []PackageOverrideEntry `toml:"PackageOverrides"`
	LoadPath          string                 `toml:"LoadPath"`
	GoVersionOverride string                 `toml:"GoVersionOverride"`
}

func (*Config) ShouldIgnore

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

func (*Config) ShouldIgnorePackageVersion

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

func (*Config) ShouldOverridePackageVersionLicense

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

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
}

func (*ConfigManager) Get

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

Attempts to get the config

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

type IgnoreEntry

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

type License

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

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"`
	Ignore         bool      `toml:"ignore"`
	License        License   `toml:"license"`
	EffectiveUntil time.Time `toml:"effectiveUntil"`
	Reason         string    `toml:"reason"`
}