runner

Documentation

Index

• Constants
• type ApiOptions
• type BaselineOptions
• type FullOptions
• type Options
  • func (a *Options) ToApiScanArgs(filename string) (args []string)
  • func (a *Options) ToBaselineScanArgs(filename string) (args []string)
  • func (a *Options) ToFullScanArgs(filename string) (args []string)
  • func (a *Options) UnmarshalYAML(yamlFile string) (err error)
• type Params
• type ZapRunner
  • func NewRunner() *ZapRunner
  • func (r *ZapRunner) Run(execution testkube.Execution) (result testkube.ExecutionResult, err error)

Constants

const API = "api"

const BASELINE = "baseline"

const FULL = "full"

Types

type ApiOptions

type ApiOptions struct {
	// target API definition, OpenAPI or SOAP, local file or URL
	Target string `yaml:"target"`
	// openapi, soap, or graphql
	Format string `yaml:"format"`
	// the hostname to override in the (remote) OpenAPI spec
	Hostname string `yaml:"hostname"`
	// safe mode this will skip the active scan and perform a baseline scan
	Safe bool `default:"false" yaml:"safe"`
	// config file or URL to use to INFO, IGNORE or FAIL warnings
	Config string `yaml:"config"`
	// show debug messages
	Debug bool `default:"false" yaml:"debug"`
	// short output format - dont show PASSes or example URLs
	Short bool `default:"false" yaml:"short"`
	// minimum level to show: PASS, IGNORE, INFO, WARN or FAIL
	Level string `default:"PASS" yaml:"level"`
	// context file which will be loaded prior to scanning the target
	Context string `yaml:"context"`
	// username to use for authenticated scans - must be defined in the given context file
	User string `yaml:"user"`
	// delay in seconds to wait for passive scanning
	Delay int `yaml:"delay"`
	// max time in minutes to wait for ZAP to start and the passive scan to run
	Time int `default:"0" yaml:"time"`
	// ZAP command line options
	ZapOptions string `yaml:"zap_options"`
	// fail the scan on WARN issues, default true
	FailOnWarn bool `default:"true" yaml:"fail_on_warn"`
}

type BaselineOptions

type BaselineOptions struct {
	// target URL including the protocol
	Target string `yaml:"target"`
	// config file or URL to use to INFO, IGNORE or FAIL warnings
	Config string `yaml:"config"`
	// show debug messages
	Debug bool `default:"false" yaml:"debug"`
	// short output format - dont show PASSes or example URLs
	Short bool `default:"false" yaml:"short"`
	// minimum level to show: PASS, IGNORE, INFO, WARN or FAIL
	Level string `default:"PASS" yaml:"level"`
	// context file which will be loaded prior to scanning the target
	Context string `yaml:"context"`
	// username to use for authenticated scans - must be defined in the given context file
	User string `yaml:"user"`
	// the number of minutes to spider for (default 1)
	Minutes int `default:"1" yaml:"minutes"`
	// delay in seconds to wait for passive scanning
	Delay int `yaml:"delay"`
	// max time in minutes to wait for ZAP to start and the passive scan to run
	Time int `default:"0" yaml:"time"`
	// use the Ajax spider in addition to the traditional one
	Ajax bool `default:"false" yaml:"ajax"`
	// ZAP command line options
	ZapOptions string `yaml:"zap_options"`
	// fail the scan on WARN issues, default true
	FailOnWarn bool `default:"true" yaml:"fail_on_warn"`
}

type FullOptions

type FullOptions struct {
	// target URL including the protocol
	Target string `yaml:"target"`
	// config file or URL to use to INFO, IGNORE or FAIL warnings
	Config string `yaml:"config"`
	// show debug messages
	Debug bool `default:"false" yaml:"debug"`
	// short output format - dont show PASSes or example URLs
	Short bool `default:"false" yaml:"short"`
	// minimum level to show: PASS, IGNORE, INFO, WARN or FAIL
	Level string `default:"PASS" yaml:"level"`
	// context file which will be loaded prior to scanning the target
	Context string `yaml:"context"`
	// username to use for authenticated scans - must be defined in the given context file
	User string `yaml:"user"`
	// the number of minutes to spider for (default -1, unlimited)
	Minutes int `default:"-1" yaml:"minutes"`
	// delay in seconds to wait for passive scanning
	Delay int `yaml:"delay"`
	// max time in minutes to wait for ZAP to start and the passive scan to run
	Time int `default:"0" yaml:"time"`
	// use the Ajax spider in addition to the traditional one
	Ajax bool `default:"false" yaml:"ajax"`
	// ZAP command line options
	ZapOptions string `yaml:"zap_options"`
	// fail the scan on WARN issues, default true
	FailOnWarn bool `default:"true" yaml:"fail_on_warn"`
}

type Options

type Options struct {
	API      ApiOptions      `yaml:"api"`
	Baseline BaselineOptions `yaml:"baseline"`
	Full     FullOptions     `yaml:"full"`
}

func (*Options) ToApiScanArgs

func (a *Options) ToApiScanArgs(filename string) (args []string)

func (*Options) ToBaselineScanArgs

func (a *Options) ToBaselineScanArgs(filename string) (args []string)

func (*Options) ToFullScanArgs

func (a *Options) ToFullScanArgs(filename string) (args []string)

func (*Options) UnmarshalYAML

func (a *Options) UnmarshalYAML(yamlFile string) (err error)

type Params

type Params struct {
	Datadir string // RUNNER_DATADIR
	Zaphome string // ZAP_HOME
}

type ZapRunner

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

func NewRunner

func NewRunner() *ZapRunner

func (*ZapRunner) Run

func (r *ZapRunner) Run(execution testkube.Execution) (result testkube.ExecutionResult, err error)