options

Documentation

Index

• func GetValidInsertionPoints() []string
• func GetValidScanModes() []string
• func IsValidScanMode(mode string) bool
• type AuditCategories
• type FullScanOptions
• type HistoryItemScanOptions
  • func (o HistoryItemScanOptions) IsScopedInsertionPoint(insertionPoint string) bool
• type ScanMode
  • func GetScanMode(mode string) ScanMode
  • func (sm ScanMode) IsHigherOrEqual(other ScanMode) bool
  • func (sm ScanMode) IsLowerOrEqual(other ScanMode) bool
  • func (sm ScanMode) MaxDiscoveryPathsPerModule() int
  • func (sm ScanMode) String() string

Functions

func GetValidInsertionPoints

func GetValidInsertionPoints() []string

func GetValidScanModes

func GetValidScanModes() []string

func IsValidScanMode

func IsValidScanMode(mode string) bool

Types

type AuditCategories

type AuditCategories struct {
	Discovery  bool `json:"discovery"`
	ServerSide bool `json:"server_side"`
	ClientSide bool `json:"client_side"`
	Passive    bool `json:"passive"`
}

type FullScanOptions

type FullScanOptions struct {
	Title              string              `json:"title" validate:"omitempty,min=1,max=255"`
	StartURLs          []string            `json:"start_urls" validate:"required,dive,url"`
	MaxDepth           int                 `json:"max_depth" validate:"min=0"`
	MaxPagesToCrawl    int                 `json:"max_pages_to_crawl" validate:"min=0"`
	ExcludePatterns    []string            `json:"exclude_patterns"`
	WorkspaceID        uint                `json:"workspace_id" validate:"required,min=0"`
	PagesPoolSize      int                 `json:"pages_pool_size" validate:"min=1,max=100"`
	Headers            map[string][]string `json:"headers" validate:"omitempty"`
	InsertionPoints    []string            `json:"insertion_points" validate:"omitempty,dive,oneof=parameters urlpath body headers cookies json xml"`
	Mode               ScanMode            `json:"mode" validate:"omitempty,oneof=fast smart fuzz"`
	ExperimentalAudits bool                `json:"experimental_audits"`
	AuditCategories    AuditCategories     `json:"audit_categories" validate:"required"`
}

type HistoryItemScanOptions

type HistoryItemScanOptions struct {
	WorkspaceID        uint              `json:"workspace_id" validate:"required,min=0"`
	TaskID             uint              `json:"task_id" validate:"required,min=0"`
	TaskJobID          uint              `json:"task_job_id" validate:"required,min=0"`
	Mode               ScanMode          `json:"mode" validate:"omitempty,oneof=fast smart fuzz"`
	InsertionPoints    []string          `json:"insertion_points" validate:"omitempty,dive,oneof=parameters urlpath body headers cookies json xml"`
	FingerprintTags    []string          `json:"fingerprint_tags" validate:"omitempty,dive"`
	Fingerprints       []lib.Fingerprint `json:"fingerprints" validate:"omitempty,dive"`
	ExperimentalAudits bool              `json:"experimental_audits"`
	AuditCategories    AuditCategories   `json:"audit_categories" validate:"required"`
}

func (HistoryItemScanOptions) IsScopedInsertionPoint

func (o HistoryItemScanOptions) IsScopedInsertionPoint(insertionPoint string) bool

type ScanMode

type ScanMode string

const (
	ScanModeFast  ScanMode = "fast"
	ScanModeSmart ScanMode = "smart"
	ScanModeFuzz  ScanMode = "fuzz"
)

func GetScanMode

func GetScanMode(mode string) ScanMode

func (ScanMode) IsHigherOrEqual

func (sm ScanMode) IsHigherOrEqual(other ScanMode) bool

func (ScanMode) IsLowerOrEqual

func (sm ScanMode) IsLowerOrEqual(other ScanMode) bool

func (ScanMode) MaxDiscoveryPathsPerModule

func (sm ScanMode) MaxDiscoveryPathsPerModule() int

func (ScanMode) String

func (sm ScanMode) String() string