rules

README

rules

import "github.com/brittonhayes/pillager/pkg/rules"

Package rules enables the parsing of Gitleaks rulesets.

Index

• Constants
• Variables
• type Loader
  • func NewLoader(opts ...LoaderOption) *Loader
  • func (l *Loader) Load() config.Config
  • func (l *Loader) WithStrict() LoaderOption
• type LoaderOption
  • func FromFile(file string) LoaderOption

Constants

ErrReadConfig is the custom error message used if an error is encountered reading the gitleaks config.

const ErrReadConfig = "Failed to read gitleaks config"

Variables

These strings contain default configs. They are initialized at compile time via go:embed.

var (
    //go:embed rules_simple.toml
    RulesDefault string

    //go:embed rules_strict.toml
    RulesStrict string
)

type Loader

Loader represents a gitleaks config loader.

type Loader struct {
    // contains filtered or unexported fields
}

func NewLoader

func NewLoader(opts ...LoaderOption) *Loader

NewLoader creates a Loader instance.

func (*Loader) Load

func (l *Loader) Load() config.Config

Load parses the gitleaks configuration.

func (*Loader) WithStrict

func (l *Loader) WithStrict() LoaderOption

WithStrict enables more strict pillager scanning.

type LoaderOption

LoaderOption sets a parameter for the gitleaks config loader.

type LoaderOption func(*Loader)

func FromFile

func FromFile(file string) LoaderOption

FromFile decodes a gitleaks config from a local file.

Generated by gomarkdoc

Documentation

Overview

Package rules enables the parsing of Gitleaks rulesets.

Index

• Constants
• Variables
• type Loader
  • func NewLoader(opts ...LoaderOption) *Loader
  • func (l *Loader) Load() config.Config
  • func (l *Loader) WithStrict() LoaderOption
• type LoaderOption
  • func WithFile(file string) LoaderOption

Constants

const ErrReadConfig = "Failed to read gitleaks config"

ErrReadConfig is the custom error message used if an error is encountered reading the gitleaks config.

Variables

var (
	RulesDefault = config.DefaultConfig

	//go:embed rules_strict.toml
	RulesStrict string
)

These strings contain default configs. They are initialized at compile time via go:embed.

Types

type Loader

type Loader struct {
	// contains filtered or unexported fields
}

Loader represents a gitleaks config loader.

func NewLoader

func NewLoader(opts ...LoaderOption) *Loader

NewLoader creates a Loader instance.

func (*Loader) Load

func (l *Loader) Load() config.Config

Load parses the gitleaks configuration.

func (*Loader) WithStrict

func (l *Loader) WithStrict() LoaderOption

WithStrict enables more strict pillager scanning.

type LoaderOption

type LoaderOption func(*Loader)

LoaderOption sets a parameter for the gitleaks config loader.

func WithFile

func WithFile(file string) LoaderOption

WithFile decodes a gitleaks config from a local file.