detections

type Detection struct {
	// Type is the DetectionType of this secret, or rather
	// how this secret was detected
	Type DetectionType `json:"type"`
	// Name is the name of the secret, i.e. what does
	// the secret itself belong to/represent
	// i.e. AWS Access Token, GitLab API Key
	Name string `json:"name"`
	// Location is the line in the docker file or
	// filesystem path where the secret was found
	Location string `json:"location"`
	// Value is the actual value of the secret
	Value string `json:"value"`
	// Source is the SecretSource of where the secret originated from.
	Source SecretSource `json:"source"`
}

type DetectionType = string

type Detector interface {
	// EvalBuildArgs will attempt to detect any
	// secrets in the given build arguments of an image.
	// It will return a list of Detection representing the
	// detected secrets found
	EvalBuildArgs([]image.BuildArg) []Detection
	// EvalEnvVars will attempt to detect any
	// secrets in the given environment variables of an image.
	// It will return a list of Detection representing the
	// detected secrets found
	EvalEnvVars([]image.EnvVar) []Detection
}

type Pattern struct {
	// Expression is a regular expression for matching a secret.
	// must be compatible with RE2 Syntax
	// TODO(add link to RE2 syntax)
	Expression string
	// Name is a human-readable name of the secret the expression
	// searches for (i.e. AWS Secret Key, OAuth token, etc.)
	Name string
}

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

type SecretSource = string