config

Documentation

Index

• Variables
• func Load(path, keyPass string) error
• type Config
  • func (c Config) ValidateOnConfigtest() bool
  • func (c Config) ValidateOnPrepare() bool
  • func (c Config) ValidateOnReport() bool
  • func (c Config) ValidateOnScan() bool
  • func (c Config) ValidateOnTui() bool
• type Container
• type Containers
• type Distro
  • func (l Distro) MajorVersion() (ver int, err error)
  • func (l Distro) String() string
• type JSONLoader
  • func (c JSONLoader) Load(path, sudoPass, keyPass string) (err error)
• type Loader
• type SMTPConf
  • func (c *SMTPConf) Validate() (errs []error)
• type ServerInfo
  • func (s ServerInfo) GetServerName() string
  • func (s ServerInfo) IsContainer() bool
  • func (s *ServerInfo) SetContainer(d Container)
• type SlackConf
  • func (c *SlackConf) Validate() (errs []error)
• type TOMLLoader
  • func (c TOMLLoader) Load(pathToToml, keyPass string) error

Variables

var (
	// Colors has ansi color list
	Colors = []string{
		"\033[32m",
		"\033[33m",
		"\033[36m",
		"\033[35m",
		"\033[31m",
		"\033[34m",
	}
	// ResetColor is reset color
	ResetColor = "\033[0m"
)

Functions

func Load

func Load(path, keyPass string) error

Load loads configuration

Types

type Config

type Config struct {
	Debug    bool
	DebugSQL bool
	Lang     string

	EMail   SMTPConf
	Slack   SlackConf
	Default ServerInfo
	Servers map[string]ServerInfo

	CvssScoreOver      float64
	IgnoreUnscoredCves bool

	SSHExternal    bool
	ContainersOnly bool
	SkipBroken     bool

	HTTPProxy  string `valid:"url"`
	LogDir     string
	ResultsDir string

	CveDBType   string
	CveDBPath   string
	CveDBURL    string
	CacheDBPath string

	FormatXML         bool
	FormatJSON        bool
	FormatOneEMail    bool
	FormatOneLineText bool
	FormatShortText   bool
	FormatFullText    bool

	GZIP bool

	AwsProfile string
	AwsRegion  string
	S3Bucket   string

	AzureAccount   string
	AzureKey       string
	AzureContainer string

	Pipe bool
	Diff bool
}

Config is struct of Configuration

var Conf Config

Conf has Configuration

func (Config) ValidateOnConfigtest

func (c Config) ValidateOnConfigtest() bool

ValidateOnConfigtest validates

func (Config) ValidateOnPrepare

func (c Config) ValidateOnPrepare() bool

ValidateOnPrepare validates configuration

func (Config) ValidateOnReport

func (c Config) ValidateOnReport() bool

ValidateOnReport validates configuration

func (Config) ValidateOnScan

func (c Config) ValidateOnScan() bool

ValidateOnScan validates configuration

func (Config) ValidateOnTui

func (c Config) ValidateOnTui() bool

ValidateOnTui validates configuration

type Container

type Container struct {
	ContainerID string
	Name        string
	Image       string
}

Container has Container information.

type Containers

type Containers struct {
	Type     string
	Includes []string
	Excludes []string
}

Containers has Containers information.

type Distro

type Distro struct {
	Family  string
	Release string
}

Distro has distribution info

func (Distro) MajorVersion

func (l Distro) MajorVersion() (ver int, err error)

MajorVersion returns Major version

func (Distro) String

func (l Distro) String() string

type JSONLoader

type JSONLoader struct {
}

JSONLoader loads configuration

func (JSONLoader) Load

func (c JSONLoader) Load(path, sudoPass, keyPass string) (err error)

Load load the configuraiton JSON file specified by path arg.

type Loader

type Loader interface {
	Load(string, string) error
}

Loader is interface of concrete loader

type SMTPConf

type SMTPConf struct {
	SMTPAddr string
	SMTPPort string `valid:"port"`

	User          string
	Password      string
	From          string
	To            []string
	Cc            []string
	SubjectPrefix string

	UseThisTime bool
}

SMTPConf is smtp config

func (*SMTPConf) Validate

func (c *SMTPConf) Validate() (errs []error)

Validate SMTP configuration

type ServerInfo

type ServerInfo struct {
	ServerName  string
	User        string
	Host        string
	Port        string
	KeyPath     string
	KeyPassword string

	CpeNames               []string
	DependencyCheckXMLPath string

	// Container Names or IDs
	Containers Containers

	IgnoreCves []string

	// Optional key-value set that will be outputted to JSON
	Optional [][]interface{}

	// For CentOS, RHEL, Amazon
	Enablerepo string

	// used internal
	LogMsgAnsiColor string // DebugLog Color
	Container       Container
	Distro          Distro
}

ServerInfo has SSH Info, additional CPE packages to scan.

func (ServerInfo) GetServerName

func (s ServerInfo) GetServerName() string

GetServerName returns ServerName if this serverInfo is about host. If this serverInfo is abount a container, returns containerID@ServerName

func (ServerInfo) IsContainer

func (s ServerInfo) IsContainer() bool

IsContainer returns whether this ServerInfo is about container

func (*ServerInfo) SetContainer

func (s *ServerInfo) SetContainer(d Container)

SetContainer set container

type SlackConf

type SlackConf struct {
	HookURL   string `valid:"url"`
	Channel   string `json:"channel"`
	IconEmoji string `json:"icon_emoji"`
	AuthUser  string `json:"username"`

	NotifyUsers []string
	Text        string `json:"text"`

	UseThisTime bool
}

SlackConf is slack config

func (*SlackConf) Validate

func (c *SlackConf) Validate() (errs []error)

Validate validates configuration

type TOMLLoader

type TOMLLoader struct {
}

TOMLLoader loads config

func (TOMLLoader) Load

func (c TOMLLoader) Load(pathToToml, keyPass string) error

Load load the configuraiton TOML file specified by path arg.