analysis

Documentation

Index

• func DefaultFormatter(findings []Finding) (string, error)
• func JSONFormatter(findings []Finding) (string, error)
• type Finding
  • func Dynamic(img image.Image, detector secrets.Detector) ([]Finding, error)
  • func Static(img image.Image, detector secrets.Detector) (findings []Finding, err error)
  • func (f Finding) String() string
• type Formatter
• type Source

Functions

func DefaultFormatter

func DefaultFormatter(findings []Finding) (string, error)

func JSONFormatter

func JSONFormatter(findings []Finding) (string, error)

Types

type Finding

type Finding struct {
	Secret string       `json:"secret,omitempty"`
	Rule   secrets.Rule `json:"rule"`
	Source Source       `json:"source"`
	Path   string       `json:"path,omitempty"`
}

func Dynamic

func Dynamic(img image.Image, detector secrets.Detector) ([]Finding, error)

func Static

func Static(img image.Image, detector secrets.Detector) (findings []Finding, err error)

func (Finding) String

func (f Finding) String() string

type Formatter

type Formatter func([]Finding) (string, error)

type Source

type Source string

const (
	BuildArgument Source = "build-arg"
	EnvVar        Source = "env-var"
	File          Source = "file"
)