engine

Documentation

Overview

Package engine runs Vulcan checks and retrieves the generated reports.

Index

• type Engine
  • func New(cfg config.AgentConfig, checktypeURLs []string) (eng Engine, err error)
  • func NewWithCatalog(cfg config.AgentConfig, catalog checktypes.Catalog) (eng Engine, err error)
  • func (eng Engine) Close() error
  • func (eng Engine) Run(targets []config.Target) (Report, error)
• type Report

Types

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

Engine represents a Lava engine able to run Vulcan checks and retrieve the generated reports.

func New

func New(cfg config.AgentConfig, checktypeURLs []string) (eng Engine, err error)

New returns a new Engine. It retrieves and merges the checktype catalogs from the provided checktype URLs to generate the catalog that will be used to configure the scans.

func NewWithCatalog

func NewWithCatalog(cfg config.AgentConfig, catalog checktypes.Catalog) (eng Engine, err error)

NewWithCatalog returns a new Engine from a provided agent configuration and checktype catalog.

func (Engine) Close

func (eng Engine) Close() error

Close releases the internal resources used by the Lava engine.

func (Engine) Run

func (eng Engine) Run(targets []config.Target) (Report, error)

Run runs vulcan checks and returns the generated report. Before running the scan, it checks that all the provided targets are reachable and returns an error if any of them is not. The check list is based on the configured checktype catalogs and the provided targets. These checks are run by a Vulcan agent, which is configured using the specified configuration.

type Report

type Report map[string]report.Report

Report is a collection of reports returned by Vulcan checks and indexed by check ID.