file

Documentation

Index

• Variables
• func CleanDigestAlgorithmName(name string) string
• func DigestAlgorithmName(hash crypto.Hash) string
• func GenerateSearchPatterns(basePatterns map[string]string, additionalPatterns map[string]string, ...) (map[string]*regexp.Regexp, error)
• type ContentsCataloger
  • func NewContentsCataloger(globs []string, skipFilesAboveSize int64) (*ContentsCataloger, error)
  • func (i *ContentsCataloger) Catalog(resolver source.FileResolver) (map[source.Coordinates]string, error)
• type Digest
  • func DigestsFromFile(closer io.ReadCloser, hashes []crypto.Hash) ([]Digest, error)
• type DigestsCataloger
  • func NewDigestsCataloger(hashes []crypto.Hash) (*DigestsCataloger, error)
  • func (i *DigestsCataloger) Catalog(resolver source.FileResolver) (map[source.Coordinates][]Digest, error)
• type License
  • func NewLicense(value string) License
• type LicenseEvidence
• type MetadataCataloger
  • func NewMetadataCataloger() *MetadataCataloger
  • func (i *MetadataCataloger) Catalog(resolver source.FileResolver) (map[source.Coordinates]source.FileMetadata, error)
• type SearchResult
  • func (s SearchResult) String() string
• type SecretsCataloger
  • func NewSecretsCataloger(patterns map[string]*regexp.Regexp, revealValues bool, maxFileSize int64) (*SecretsCataloger, error)
  • func (i *SecretsCataloger) Catalog(resolver source.FileResolver) (map[source.Coordinates][]SearchResult, error)
• type SecretsMonitor

Variables

var DefaultSecretsPatterns = map[string]string{
	"aws-access-key":     `(?i)aws_access_key_id["'=:\s]*?(?P<value>(A3T[A-Z0-9]|AKIA|AGPA|AIDA|AROA|AIPA|ANPA|ANVA|ASIA)[A-Z0-9]{16})`,
	"aws-secret-key":     `(?i)aws_secret_access_key["'=:\s]*?(?P<value>[0-9a-zA-Z/+]{40})`,
	"pem-private-key":    `-----BEGIN (\S+ )?PRIVATE KEY(\sBLOCK)?-----((?P<value>(\n.*?)+)-----END (\S+ )?PRIVATE KEY(\sBLOCK)?-----)?`,
	"docker-config-auth": `"auths"((.*\n)*.*?"auth"\s*:\s*"(?P<value>[^"]+)")?`,
	"generic-api-key":    `(?i)api(-|_)?key["'=:\s]*?(?P<value>[A-Z0-9]{20,60})["']?(\s|$)`,
}

Functions

func CleanDigestAlgorithmName

func CleanDigestAlgorithmName(name string) string

func DigestAlgorithmName

func DigestAlgorithmName(hash crypto.Hash) string

func GenerateSearchPatterns

func GenerateSearchPatterns(basePatterns map[string]string, additionalPatterns map[string]string, excludePatternNames []string) (map[string]*regexp.Regexp, error)

GenerateSearchPatterns takes a set of named base patterns, a set of additional named patterns and an name exclusion list and generates a final set of regular expressions (indexed by name). The sets are aggregated roughly as such: (base - excluded) + additional.

Types

type ContentsCataloger

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

func NewContentsCataloger

func NewContentsCataloger(globs []string, skipFilesAboveSize int64) (*ContentsCataloger, error)

func (*ContentsCataloger) Catalog

func (i *ContentsCataloger) Catalog(resolver source.FileResolver) (map[source.Coordinates]string, error)

type Digest

type Digest struct {
	Algorithm string `json:"algorithm"`
	Value     string `json:"value"`
}

func DigestsFromFile

func DigestsFromFile(closer io.ReadCloser, hashes []crypto.Hash) ([]Digest, error)

type DigestsCataloger

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

func NewDigestsCataloger

func NewDigestsCataloger(hashes []crypto.Hash) (*DigestsCataloger, error)

func (*DigestsCataloger) Catalog

func (i *DigestsCataloger) Catalog(resolver source.FileResolver) (map[source.Coordinates][]Digest, error)

type License

type License struct {
	Value           string
	SPDXExpression  string
	Type            license.Type
	LicenseEvidence *LicenseEvidence // evidence from license classifier
}

func NewLicense

func NewLicense(value string) License

type LicenseEvidence

type LicenseEvidence struct {
	Confidence int
	Offset     int
	Extent     int
}

type MetadataCataloger

type MetadataCataloger struct {
}

func NewMetadataCataloger

func NewMetadataCataloger() *MetadataCataloger

func (*MetadataCataloger) Catalog

func (i *MetadataCataloger) Catalog(resolver source.FileResolver) (map[source.Coordinates]source.FileMetadata, error)

type SearchResult

type SearchResult struct {
	Classification string `json:"classification"`
	LineNumber     int64  `json:"lineNumber"`
	LineOffset     int64  `json:"lineOffset"`
	SeekPosition   int64  `json:"seekPosition"`
	Length         int64  `json:"length"`
	Value          string `json:"value,omitempty"`
}

func (SearchResult) String

func (s SearchResult) String() string

type SecretsCataloger

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

func NewSecretsCataloger

func NewSecretsCataloger(patterns map[string]*regexp.Regexp, revealValues bool, maxFileSize int64) (*SecretsCataloger, error)

func (*SecretsCataloger) Catalog

func (i *SecretsCataloger) Catalog(resolver source.FileResolver) (map[source.Coordinates][]SearchResult, error)

type SecretsMonitor

type SecretsMonitor struct {
	progress.Stager
	SecretsDiscovered progress.Monitorable
	progress.Progressable
}