Documentation
¶
Overview ¶
Package secrets contains a Scalibr filesystem Extractor that wraps the Veles secret scanning library to find secrets (i.e. credentials) in files on the filesystem.
Index ¶
Constants ¶
View Source
const (
// Name is the unique name of this extractor.
Name = "secrets/veles"
)
Variables ¶
This section is empty.
Functions ¶
func NewWithEngine ¶
func NewWithEngine(e *veles.DetectionEngine) filesystem.Extractor
NewWithEngine creates a new Extractor that uses the specified DetectionEngine.
Types ¶
type Extractor ¶
type Extractor struct {
// contains filtered or unexported fields
}
Extractor extracts secrets from the filesystem using the Veles secret scanning library. Other than most extractors, it adds Secrets to the Inventory, not Packages.
func (Extractor) Extract ¶
func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)
Extract extracts secrets from scan input.
func (Extractor) FileRequired ¶
func (e Extractor) FileRequired(api filesystem.FileAPI) bool
FileRequired returns true, if the file should be checked for secrets.
func (Extractor) Requirements ¶
func (e Extractor) Requirements() *plugin.Capabilities
Requirements of the Extractor.
Directories
¶
Path | Synopsis |
---|---|
Package convert provides a utility function for converting Veles plugins (Detectors and Validators) to SCALIBR core plugins (FilesystemExtractors and Enrichers)
|
Package convert provides a utility function for converting Veles plugins (Detectors and Validators) to SCALIBR core plugins (FilesystemExtractors and Enrichers) |
Click to show internal directories.
Click to hide internal directories.