contextargs

Documentation

Overview

Package contextargs implements a generic entity for shared context within workflows

All templates within a workflow shares the same cookiejar and a key-value store with shared items

Index

• func GenerateVariables(ctx *Context) map[string]interface{}
• type Context
  • func GetCopyIfHostOutdated(ctx *Context, url string) *Context
  • func New(ctx context.Context) *Context
  • func NewWithInput(ctx context.Context, input string) *Context
  • func NewWithMetaInput(ctx context.Context, input *MetaInput) *Context
  • func (ctx *Context) Add(key string, v interface{})
  • func (ctx *Context) Clone() *Context
  • func (ctx *Context) Context() context.Context
  • func (ctx *Context) ForEach(f func(string, interface{}))
  • func (ctx *Context) Get(key string) (interface{}, bool)
  • func (ctx *Context) GetAll() map[string]interface{}
  • func (ctx *Context) Has(key string) bool
  • func (ctx *Context) HasArgs() bool
  • func (ctx *Context) Merge(args map[string]interface{})
  • func (ctx *Context) Port() string
  • func (ctx *Context) Set(key string, value interface{})
  • func (ctx *Context) UseNetworkPort(port string, excludePorts string) error
• type MetaInput
  • func NewMetaInput() *MetaInput
  • func (metaInput *MetaInput) Address() string
  • func (metaInput *MetaInput) Clone() *MetaInput
  • func (metaInput *MetaInput) GetScanHash(templateId string) string
  • func (metaInput *MetaInput) ID() string
  • func (metaInput *MetaInput) MarshalBytes() ([]byte, error)
  • func (metaInput *MetaInput) MarshalString() (string, error)
  • func (metaInput *MetaInput) MustMarshalBytes() []byte
  • func (metaInput *MetaInput) MustMarshalString() string
  • func (metaInput *MetaInput) Port() string
  • func (metaInput *MetaInput) PrettyPrint() string
  • func (metaInput *MetaInput) Target() string
  • func (metaInput *MetaInput) URL() (*urlutil.URL, error)
  • func (metaInput *MetaInput) Unmarshal(data string) error

Functions

func GenerateVariables

func GenerateVariables(ctx *Context) map[string]interface{}

GenerateVariables from context args

Types

type Context

type Context struct {

	// Meta is the target for the executor
	MetaInput *MetaInput

	// CookieJar shared within workflow's http templates
	CookieJar *cookiejar.Jar
	// contains filtered or unexported fields
}

Context implements a shared context struct to share information across multiple templates within a workflow

func GetCopyIfHostOutdated

func GetCopyIfHostOutdated(ctx *Context, url string) *Context

GetCopyIfHostOutdated returns a new contextargs if the host is outdated

func New

func New(ctx context.Context) *Context

Create a new contextargs instance

func NewWithInput

func NewWithInput(ctx context.Context, input string) *Context

Create a new contextargs instance with input string

func NewWithMetaInput

func NewWithMetaInput(ctx context.Context, input *MetaInput) *Context

NewWithMetaInput creates a new contextargs instance with meta input

func (*Context) Add

func (ctx *Context) Add(key string, v interface{})

Add the specific key-value pair

func (*Context) Clone

func (ctx *Context) Clone() *Context

func (*Context) Context

func (ctx *Context) Context() context.Context

Context returns the context of the current contextargs

func (*Context) ForEach

func (ctx *Context) ForEach(f func(string, interface{}))

func (*Context) Get

func (ctx *Context) Get(key string) (interface{}, bool)

Get the value with specific key if exists

func (*Context) GetAll

func (ctx *Context) GetAll() map[string]interface{}

func (*Context) Has

func (ctx *Context) Has(key string) bool

Has check if the key exists

func (*Context) HasArgs

func (ctx *Context) HasArgs() bool

func (*Context) Merge

func (ctx *Context) Merge(args map[string]interface{})

Merge the key-value pairs

func (*Context) Port

func (ctx *Context) Port() string

Port returns the port of the target

func (*Context) Set

func (ctx *Context) Set(key string, value interface{})

Set the specific key-value pair

func (*Context) UseNetworkPort

func (ctx *Context) UseNetworkPort(port string, excludePorts string) error

UseNetworkPort updates input with required/default network port for that template but is ignored if input/target contains non-http ports like 80,8080,8081 etc

type MetaInput

type MetaInput struct {
	// Input represent the target
	Input string `json:"input,omitempty"`
	// CustomIP to use for connection
	CustomIP string `json:"customIP,omitempty"`

	// ReqResp is the raw request for the input
	ReqResp *types.RequestResponse `json:"raw-request,omitempty"`
	// contains filtered or unexported fields
}

MetaInput represents a target with metadata (TODO: replace with https://github.com/projectdiscovery/metainput)

func NewMetaInput

func NewMetaInput() *MetaInput

func (*MetaInput) Address

func (metaInput *MetaInput) Address() string

Address return the remote address of target Note: it does not resolve the domain to ip it is meant to be used by hosterrorsCache if invalid metainput is provided then it uses a random ksuid as hostname to avoid skipping valid targets

func (*MetaInput) Clone

func (metaInput *MetaInput) Clone() *MetaInput

func (*MetaInput) GetScanHash

func (metaInput *MetaInput) GetScanHash(templateId string) string

GetScanHash returns a unique hash that represents a scan by hashing (metainput + templateId)

func (*MetaInput) ID

func (metaInput *MetaInput) ID() string

ID returns a unique id/hash for metainput

func (*MetaInput) MarshalBytes

func (metaInput *MetaInput) MarshalBytes() ([]byte, error)

func (*MetaInput) MarshalString

func (metaInput *MetaInput) MarshalString() (string, error)

func (*MetaInput) MustMarshalBytes

func (metaInput *MetaInput) MustMarshalBytes() []byte

func (*MetaInput) MustMarshalString

func (metaInput *MetaInput) MustMarshalString() string

func (*MetaInput) Port

func (metaInput *MetaInput) Port() string

Port returns the port of the target if port is not present then empty string is returned

func (*MetaInput) PrettyPrint

func (metaInput *MetaInput) PrettyPrint() string

func (*MetaInput) Target

func (metaInput *MetaInput) Target() string

Target returns the target of the metainput

func (*MetaInput) URL

func (metaInput *MetaInput) URL() (*urlutil.URL, error)

URL returns request url

func (*MetaInput) Unmarshal

func (metaInput *MetaInput) Unmarshal(data string) error