secrets

package
v0.3.4 Latest Latest
Warning

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

Go to latest
Published: Sep 22, 2025 License: Apache-2.0 Imports: 8 Imported by: 0

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

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) Name

func (e Extractor) Name() string

Name of the Extractor.

func (Extractor) Requirements

func (e Extractor) Requirements() *plugin.Capabilities

Requirements of the Extractor.

func (Extractor) Version

func (e Extractor) Version() int

Version 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)

Jump to

Keyboard shortcuts

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