config

Documentation

Index

• Variables
• func Init() error
• type CollectConfig
• type FileSize
  • func (f *FileSize) Set(val string) error
  • func (f FileSize) String() string
  • func (f *FileSize) Type() string
  • func (f *FileSize) UnmarshalText(text []byte) error
• type GlobalConfig
• type ScannerConfig
• type StringSlice
  • func (s *StringSlice) Set(val string) (err error)
  • func (s *StringSlice) String() string
  • func (s StringSlice) Type() string
  • func (s *StringSlice) UnmarshalText(text []byte) error
• type UIConfig

Variables

var FlagSet *pflag.FlagSet

var Fs afero.Fs

Fs is the "filesystem" in which configuration and rules are found. This can be provided through a ZIP file appended to the binary.

Functions

func Init

func Init() error

Types

type CollectConfig

type CollectConfig struct {
	Disabled bool     `yaml:"disabled"`
	File     string   `yaml:"file"`
	Password string   `yaml:"password"`
	MaxSize  FileSize `yaml:"max-size"`
}

type FileSize

type FileSize int64

func (*FileSize) Set

func (f *FileSize) Set(val string) error

func (FileSize) String

func (f FileSize) String() string

func (*FileSize) Type

func (f *FileSize) Type() string

func (*FileSize) UnmarshalText

func (f *FileSize) UnmarshalText(text []byte) error

type GlobalConfig

type GlobalConfig struct {
	MaxFileSize        FileSize                 `yaml:"max-file-size"`
	Paths              StringSlice              `yaml:"paths"`
	ProcIgnoreNames    StringSlice              `yaml:"proc-ignore-names"`
	ReportTargets      StringSlice              `yaml:"report"`
	EvidenceCollection CollectConfig            `yaml:"evidence-collector"`
	Hostname           string                   `yaml:"hostname"`
	HighPriority       bool                     `yaml:"high-priority"`
	UI                 UIConfig                 `yaml:"ui"`
	RulesetMarker      string                   `yaml:"ruleset-marker"`
	SystemScanners     map[string]ScannerConfig `yaml:"system"`
	FileScanners       map[string]ScannerConfig `yaml:"file"`
	ProcScanners       map[string]ScannerConfig `yaml:"proc"`
}

var Global GlobalConfig

type ScannerConfig

type ScannerConfig struct {
	Disabled bool      `yaml:"disabled"`
	Config   yaml.Node `yaml:"config"`
}

type StringSlice

type StringSlice []string

StringSlice is a simpler version of the type backing pflag.StringSlice etc. whose Set method has "append" semantics.

func (*StringSlice) Set

func (s *StringSlice) Set(val string) (err error)

func (*StringSlice) String

func (s *StringSlice) String() string

func (StringSlice) Type

func (s StringSlice) Type() string

func (*StringSlice) UnmarshalText

func (s *StringSlice) UnmarshalText(text []byte) error

type UIConfig

type UIConfig struct {
	PromptOnExit bool `yaml:"prompt-on-exit"`
}