Documentation
¶
Overview ¶
Package engine contains the core scanning logic for Redactyl. It traverses target files, runs detectors, and returns structured findings. This package is internal; external consumers should use the stable facade in pkg/core.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CountTargets ¶
func DetectorIDs ¶
func DetectorIDs() []string
DetectorIDs returns the list of available Gitleaks detector IDs. This is a representative list of common Gitleaks rules for UI purposes. The actual detection is performed by Gitleaks with its full rule set.
Types ¶
type Config ¶
type Config struct {
Root string
IncludeGlobs string
ExcludeGlobs string
MaxBytes int64
ScanStaged bool
HistoryCommits int
BaseBranch string
Threads int
EnableDetectors string
DisableDetectors string
MinConfidence float64
DryRun bool
NoColor bool
DefaultExcludes bool
NoCache bool
Progress func()
// Deep artifact scanning (optional)
ScanArchives bool
ScanContainers bool
ScanIaC bool
ScanHelm bool // Scan Helm charts
ScanK8s bool // Scan Kubernetes manifests
RegistryImages []string // Remote registry images to scan (e.g. gcr.io/proj/img:tag)
MaxArchiveBytes int64
MaxEntries int
MaxDepth int
ScanTimeBudget time.Duration
GlobalArtifactBudget time.Duration
// Gitleaks configuration (for scanner integration)
GitleaksConfig config.GitleaksConfig
}
Config controls scanning behavior including scope, performance, and filters.
type DeepStats ¶
type DeepStats struct {
AbortedByBytes int
AbortedByEntries int
AbortedByDepth int
AbortedByTime int
}
DeepStats summarizes artifact scanning abort reasons.
Click to show internal directories.
Click to hide internal directories.