Help us shape the future of Go! Take the 2026 Go Developer Survey

scanner

package
v1.4.0 Latest Latest
Warning

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

Go to latest
Published: Oct 19, 2026 License: AGPL-3.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var AppendPipeleekRules = rules.AppendPipeleekRules
View Source
var DetectFileHits = artifact.DetectFileHits
View Source
var DetectHits = engine.DetectHits
View Source
var DetectHitsWithOptions = engine.DetectHitsWithOptions
View Source
var HandleArchiveArtifact = artifact.HandleArchiveArtifact
View Source
var InitRules = rules.InitRules

Functions

This section is empty.

Types

type BaseScanner

type BaseScanner interface {
	// Scan performs a scan based on the configured options and returns any error encountered.
	Scan() error
}

BaseScanner defines the minimal interface that all platform-specific scanners must implement. This provides a common contract for scanning operations across different CI/CD platforms.

type DetectionOptions added in v1.3.0

type DetectionOptions = engine.DetectionOptions

type DetectionResult

type DetectionResult = types.DetectionResult

type Finding

type Finding = types.Finding

type PatternElement

type PatternElement = types.PatternElement

type PatternPattern

type PatternPattern = types.PatternPattern

type ScannerWithStatus

type ScannerWithStatus interface {
	BaseScanner

	// GetStatus returns a human-readable status string describing the current scan state.
	GetStatus() string
}

ScannerWithStatus extends BaseScanner with methods for monitoring scan progress. Implement this interface for scanners that need to report their status.

type SecretsPatterns

type SecretsPatterns = types.SecretsPatterns

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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