output

Documentation

Index

• Constants
• Variables
• type CustomFieldConfig
  • func (c *CustomFieldConfig) GetName() string
  • func (c *CustomFieldConfig) SetCompiledRegexp(r *regexp.Regexp)
• type Error
• type Options
• type Part
  • func (p Part) ToString() string
• type Result
  • func (r *Result) HasResponse() bool
• type StandardWriter
  • func (w *StandardWriter) Close() error
  • func (w *StandardWriter) Write(result *Result) error
  • func (w *StandardWriter) WriteErr(errMessage *Error) error
• type Writer
  • func New(options Options) (Writer, error)

Constants

const (
	DefaultResponseDir = "katana_response"
)

Variables

var CustomFieldsMap = make(map[string]CustomFieldConfig)

CustomFieldsMap is the global custom field data instance it is used for parsing the header and body of request

var DefaultFieldConfigData = []CustomFieldConfig{
	{
		Name:  "email",
		Type:  "regex",
		Part:  Response.ToString(),
		Regex: []string{`([a-zA-Z0-9._-]+@[a-zA-Z0-9._-]+\.[a-zA-Z0-9_-]+)`},
	},
}

var FieldNames = []string{
	"url",
	"path",
	"fqdn",
	"rdn",
	"rurl",
	"qurl",
	"qpath",
	"file",
	"ufile",
	"key",
	"value",
	"kv",
	"dir",
	"udir",
}

FieldNames is a list of supported field names

Types

type CustomFieldConfig

type CustomFieldConfig struct {
	Name         string           `yaml:"name,omitempty"`
	Type         string           `yaml:"type,omitempty"`
	Part         string           `yaml:"part,omitempty"`
	Group        int              `yaml:"group,omitempty"`
	Regex        []string         `yaml:"regex,omitempty"`
	CompileRegex []*regexp.Regexp `yaml:"-"`
}

CustomFieldConfig contains suggestions for field filling

func (*CustomFieldConfig) GetName

func (c *CustomFieldConfig) GetName() string

func (*CustomFieldConfig) SetCompiledRegexp

func (c *CustomFieldConfig) SetCompiledRegexp(r *regexp.Regexp)

type Error

type Error struct {
	Timestamp time.Time `json:"timestamp,omitempty"`
	Endpoint  string    `json:"endpoint,omitempty"`
	Source    string    `json:"source,omitempty"`
	Error     string    `json:"error,omitempty"`
}

type Options

type Options struct {
	Colors                bool
	JSON                  bool
	Verbose               bool
	StoreResponse         bool
	OmitRaw               bool
	OmitBody              bool
	OutputFile            string
	Fields                string
	StoreFields           string
	StoreResponseDir      string
	FieldConfig           string
	ErrorLogFile          string
	MatchRegex            []*regexp.Regexp
	FilterRegex           []*regexp.Regexp
	ExtensionValidator    *extensions.Validator
	OutputMatchCondition  string
	OutputFilterCondition string
}

Options contains the configuration options for output writer

type Part

type Part string

const (
	// RequestPart is the part of request
	Header   Part = "header"
	Body     Part = "body"
	Response Part = "response"
)

func (Part) ToString

func (p Part) ToString() string

type Result

type Result struct {
	Timestamp time.Time            `json:"timestamp,omitempty"`
	Request   *navigation.Request  `json:"request,omitempty"`
	Response  *navigation.Response `json:"response,omitempty"`
	Error     string               `json:"error,omitempty"`
}

Result of the crawling

func (*Result) HasResponse

func (r *Result) HasResponse() bool

HasResponse checks if the result has a valid response

type StandardWriter

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

StandardWriter is an standard output writer structure

func (*StandardWriter) Close

func (w *StandardWriter) Close() error

Close closes the output writer

func (*StandardWriter) Write

func (w *StandardWriter) Write(result *Result) error

Write writes the result to file and/or screen.

func (*StandardWriter) WriteErr

func (w *StandardWriter) WriteErr(errMessage *Error) error

type Writer

type Writer interface {
	// Close closes the output writer interface
	Close() error
	// Write writes the event to file and/or screen.
	Write(*Result) error
	WriteErr(*Error) error
}

Writer is an interface which writes output to somewhere for katana events.

func New

func New(options Options) (Writer, error)

New returns a new output writer instance