internal

Documentation

Index

• Variables
• func ForceOverwriteTrufflehogConfig(configFilePath string, config Config) error
• func HandleScannerConfig(logger hclog.Logger, excludePaths []string, targetFolder string, ...) error
• func JsonToPlainReport(filePath string) (string, error)
• func JsonToSarifReport(filePath string) (string, error)
• func SaveConfig(path string, config Config) error
• func WrapDecodeFailure(err error) error
• func WriteDefaultTrufflehogConfigIfMissing(logger hclog.Logger, configFilePath string) error
• type Config
  • func DefaultConfig() Config
  • func LoadConfig(path string) (Config, error)
• type Exclude
• type Trufflehog3Issue
• type Trufflehog3Report
  • func (report Trufflehog3Report) Deduplicate() Trufflehog3Report
  • func (report Trufflehog3Report) Render() string
• type Trufflehog3Rule

Variables

var ErrDecodeFailure = errors.New("failed to decode .trufflehog3.yml configuration file")

Functions

func ForceOverwriteTrufflehogConfig

func ForceOverwriteTrufflehogConfig(configFilePath string, config Config) error

ForceOverwriteTrufflehogConfig forcefully overwrites the existing configuration with the provided configuration.

func HandleScannerConfig

func HandleScannerConfig(logger hclog.Logger, excludePaths []string, targetFolder string, writeDefaultIfMissing bool, forceOverwrite bool) error

HandleScannerConfig processes the scanner configuration, including writing default configs or overwriting existing ones.

func JsonToPlainReport

func JsonToPlainReport(filePath string) (string, error)

JsonToPlainReport converts a Trufflehog3 JSON report to a plain text format.

func JsonToSarifReport

func JsonToSarifReport(filePath string) (string, error)

JsonToSarifReport converts a Trufflehog3 JSON report to SARIF format.

func SaveConfig

func SaveConfig(path string, config Config) error

SaveConfig saves the YAML configuration to the specified file.

func WrapDecodeFailure

func WrapDecodeFailure(err error) error

WrapDecodeFailure adds context to ErrDecodeFailure

func WriteDefaultTrufflehogConfigIfMissing

func WriteDefaultTrufflehogConfigIfMissing(logger hclog.Logger, configFilePath string) error

WriteDefaultTrufflehogConfigIfMissing writes the default configuration if the file is missing.

Types

type Config

type Config struct {
	Exclude        []*Exclude `yaml:"exclude"`
	Severity       string     `yaml:"severity,omitempty"`
	IgnoreNoSecret bool       `yaml:"ignore_nosecret,omitempty"`
	NoEntropy      bool       `yaml:"no_entropy,omitempty"`
	NoPattern      bool       `yaml:"no_pattern,omitempty"`
	Branch         string     `yaml:"branch,omitempty"`
	Depth          int        `yaml:"depth,omitempty"`
	Since          string     `yaml:"since,omitempty"`
	NoCurrent      bool       `yaml:"no_current,omitempty"`
	NoHistory      bool       `yaml:"no_history,omitempty"`
	Context        int        `yaml:"context,omitempty"`
}

Config represents the entire YAML configuration.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default configuration for Trufflehog3. TODO: move fetching default from a file

func LoadConfig

func LoadConfig(path string) (Config, error)

LoadConfig loads the YAML configuration from the specified file.

type Exclude

type Exclude struct {
	Message string   `yaml:"message"`
	Paths   []string `yaml:"paths,omitempty"`
	Pattern string   `yaml:"pattern,omitempty"`
	ID      string   `yaml:"id,omitempty"`
}

Exclude represents each exclusion rule in the configuration.

type Trufflehog3Issue

type Trufflehog3Issue struct {
	Rule   *Trufflehog3Rule `json:"rule"`
	Path   string           `json:"path"`
	Line   string           `json:"line"`
	Secret string           `json:"secret"`
	ID     string           `json:"id,omitempty"`
	Branch string           `json:"branch,omitempty"`
	Commit string           `json:"commit,omitempty"`
	Author string           `json:"author,omitempty"`
	Date   string           `json:"date,omitempty"`
}

Trufflehog3Issue represents a single issue found by Trufflehog3.

type Trufflehog3Report

type Trufflehog3Report []*Trufflehog3Issue

Trufflehog3Report represents a collection of Trufflehog3 issues.

func (Trufflehog3Report) Deduplicate

func (report Trufflehog3Report) Deduplicate() Trufflehog3Report

Deduplicate removes duplicate issues from the report.

func (Trufflehog3Report) Render

func (report Trufflehog3Report) Render() string

Render produces a human-readable report of the Trufflehog3 issues.

type Trufflehog3Rule

type Trufflehog3Rule struct {
	ID       string `json:"id"`
	Message  string `json:"message"`
	Pattern  string `json:"pattern"`
	Severity string `json:"severity"`
}

Trufflehog3Rule represents the rule that triggered an issue.