scan

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 30, 2026 License: MIT Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterLegacyCheckIDAlias added in v0.10.0

func RegisterLegacyCheckIDAlias(newID string, oldIDs ...string)

RegisterLegacyCheckIDAlias records that newID was previously known as one or more oldIDs, so shouldAddScan keeps matching the old IDs after a check is renamed or split. Intended to be called from a check package's init().

Types

type OperationScan added in v0.4.6

type OperationScan struct {
	Operation *operation.Operation
	CheckID   string
	CheckName string
}

type Scan

type Scan struct {
	*ScanOptions

	Operations      operation.Operations
	OperationsScans []OperationScan
	// contains filtered or unexported fields
}

func NewScan added in v0.3.0

func NewScan(operations operation.Operations, opts *ScanOptions) (*Scan, error)

func (*Scan) AddCheck added in v0.10.0

func (s *Scan) AddCheck(check harnessx.Check, def *checkdef.CheckDef) *Scan

AddCheck registers check with the scan. def supplies the CVSS/CWE/OWASP/ CAPEC classification used to build a reportx.Finding when the check reports a vulnerability; pass nil for checks that never do (e.g. pure data-provider checks other checks depend on).

check is always registered with the harnessx engine, even when it doesn't match --scans/--exclude-scans: Execute lets the engine decide the final run set via RunOption, which keeps a check's dependencies intact even if they wouldn't otherwise match the filter (see runOptions). OperationsScans — used for progress reporting — still only counts checks that match, plus internal (data-provider) checks, which are never user-selectable.

func (*Scan) Execute

func (s *Scan) Execute(ctx context.Context, scanCallback func(operationScan *OperationScan)) (*reportx.Report, []error, error)

func (*Scan) GetOperationsScans added in v0.4.6

func (s *Scan) GetOperationsScans() []OperationScan

type ScanOptions added in v0.8.1

type ScanOptions struct {
	IncludeScans []string
	ExcludeScans []string

	// MinSeverity, when set, restricts the scan to checks whose static
	// CVSS score (from their CheckDef) is >= *MinSeverity — checks that
	// can never reach the severity threshold don't run at all. A
	// dependency of a kept check still runs regardless of its own score.
	MinSeverity *float64

	// Title names the report (e.g. "cURL Scan", "OpenAPI Scan"). Defaults to
	// "Scan" when empty.
	Title string
	// ToolVersion is recorded in the report metadata.
	ToolVersion string
}

Directories

Path Synopsis
broken_authentication
jwt
jwt/jwtcheck
Package jwtcheck holds what vulnapi's JWT delegation to jwtop needs that jwtop itself has no concept of: deciding whether a resource's security scheme is a JWT bearer token worth scanning, and pulling the *operation.Operation back out of a harnessx.Resource.
Package jwtcheck holds what vulnapi's JWT delegation to jwtop needs that jwtop itself has no concept of: deciding whether a resource's security scheme is a JWT bearer token worth scanning, and pulling the *operation.Operation back out of a harnessx.Resource.
graphql
misconfiguration

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL