types

Documentation

Index

• type Config
• type LynisConfig
• type Misconfiguration
• type ScannerResult
  • func (sr ScannerResult) GetError() error
• type ScannersConfig
  • func (ScannersConfig) IsConfig()
• type Severity

Types

type Config

type Config struct {
	Enabled         bool           `json:"enabled" yaml:"enabled" mapstructure:"enabled"`
	ScannersList    []string       `yaml:"scanners_list" mapstructure:"scanners_list"`
	StripInputPaths bool           `yaml:"strip_input_paths" mapstructure:"strip_input_paths"`
	Inputs          []types.Input  `yaml:"inputs" mapstructure:"inputs"`
	ScannersConfig  ScannersConfig `yaml:"scanners_config" mapstructure:"scanners_config"`
}

type LynisConfig

type LynisConfig struct {
	BinaryPath string `yaml:"binary_path" mapstructure:"binary_path"`
}

type Misconfiguration

type Misconfiguration struct {
	// Path which was scanned to find this Misconfiguration, might be "/",
	// "partitionX/" or "/home/Dockerfile"
	//
	// This might just be the scanner input if the tool scans it as a whole
	// or it can be a specific file if the scanner performs some
	// sub-discovery like trivy.
	ScannedPath string `json:"ScannedPath"`

	// Information about the test that was run to detect this specific
	// misconfiguration, this is specific to each Scanner.
	TestCategory    string `json:"TestCategory"`
	TestID          string `json:"TestID"`
	TestDescription string `json:"TestDescription"`

	// Information about this specific misconfiguration hit
	Severity    Severity `json:"Severity"`
	Message     string   `json:"Message"`
	Remediation string   `json:"Remediation"`
}

type ScannerResult

type ScannerResult struct {
	ScannerName       string
	Misconfigurations []Misconfiguration
	Error             error
}

func (ScannerResult) GetError

func (sr ScannerResult) GetError() error

type ScannersConfig

type ScannersConfig struct {
	Lynis LynisConfig `yaml:"lynis" mapstructure:"lynis"`
}

Add scanner specific configurations here, where the key is the scanner name, and the value is the scanner specific configuration.

For example if the scanner name is "lynis":

Lynis LynisConfig `yaml:"lynis" mapstructure:"lynis"`

func (ScannersConfig) IsConfig

func (ScannersConfig) IsConfig()

type Severity

type Severity string

const (
	HighSeverity   Severity = "HighSeverity"
	MediumSeverity Severity = "MediumSeverity"
	LowSeverity    Severity = "LowSeverity"
)