tmplexec

README

tmplexec

tmplexec also known as template executer executes template it is different from protocols package which only contains logic within the scope of one protocol. tmplexec is resposible for executing Template with defined logic. with introduction of multi protocol and flow templates (deprecated package protocols/common/executer) did not seem appropriate/helpful anymore as it is outside of protocol scope and deals with execution of template which can contain 1 requests , or multiple requests of same protocol or multiple requests of different protocols. tmplexec is responsible for executing template and handling all logic related to it.

Engine/Backends

Currently there are 3 engines for template execution

• Generic => executes request[s] of same/one protocol
• MultiProtocol => executes requests of multiple protocols with shared logic between protocol requests see multiprotocol
• Flow => executes requests of one or multiple protocol requests as specified by template in javascript (aka flow) flow

Documentation

Index

• type TemplateEngine
• type TemplateExecuter
  • func NewTemplateExecuter(requests []protocols.Request, options *protocols.ExecutorOptions) (*TemplateExecuter, error)
  • func (e *TemplateExecuter) Compile() error
  • func (e *TemplateExecuter) Execute(ctx *scan.ScanContext) (bool, error)
  • func (e *TemplateExecuter) ExecuteWithResults(ctx *scan.ScanContext) ([]*output.ResultEvent, error)
  • func (e *TemplateExecuter) Requests() int

Types

type TemplateEngine

type TemplateEngine interface {
	// Note: below methods only need to implement extra / engine specific functionality
	// basic request compilation , callbacks , cli output callback etc are handled by `TemplateExecuter` and no need to do it again
	// Extra Compilation (if any)
	Compile() error

	// ExecuteWithResults executes the template and returns results
	ExecuteWithResults(ctx *scan.ScanContext) error

	// Name returns name of template engine
	Name() string
}

TemplateEngine is a template executor with different functionality Ex: 1. generic => executes all protocol requests one after another (Done) 2. flow => executes protocol requests based on how they are defined in flow (Done) 3. multiprotocol => executes multiple protocols in parallel (Done)

type TemplateExecuter

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

TemplateExecutor is an executor for a template

func NewTemplateExecuter

func NewTemplateExecuter(requests []protocols.Request, options *protocols.ExecutorOptions) (*TemplateExecuter, error)

NewTemplateExecuter creates a new request TemplateExecuter for list of requests

func (*TemplateExecuter) Compile

func (e *TemplateExecuter) Compile() error

Compile compiles the execution generators preparing any requests possible.

func (*TemplateExecuter) Execute

func (e *TemplateExecuter) Execute(ctx *scan.ScanContext) (bool, error)

Execute executes the protocol group and returns true or false if results were found.

func (*TemplateExecuter) ExecuteWithResults

func (e *TemplateExecuter) ExecuteWithResults(ctx *scan.ScanContext) ([]*output.ResultEvent, error)

ExecuteWithResults executes the protocol requests and returns results instead of writing them.

func (*TemplateExecuter) Requests

func (e *TemplateExecuter) Requests() int

Requests returns the total number of requests the rule will perform