common

Documentation

Index

• Constants
• Variables
• func AddStringSliceItem(item string, slice *[]string)
• func BuildRegex(pattern string, specialChar string, length int) string
• func BuildRegexJWT(firstRange, secondRange, thirdRange string) string
• func IsDone(ctx context.Context) bool
• func PinnedCertPool() *x509.CertPool
• func PinnedRetryableHttpClient() *http.Client
• func RangeValidation(rangeInput string) bool
• func Recover(ctx context.Context)
• func RecoverWithExit(ctx context.Context)
• func RemoveStringSliceItem(item string, slice *[]string)
• func RetryableHttpClient() *http.Client
• func RetryableHttpClientTimeout(timeOutSeconds int64) *http.Client
• func SaneHttpClient() *http.Client
• func SaneHttpClientTimeOut(timeOutSeconds int64) *http.Client
• func SkipFile(filename string) bool
• func ToUpperCase(input string) string
• type CustomTransport
  • func NewCustomTransport(T http.RoundTripper) *CustomTransport
  • func (t *CustomTransport) RoundTrip(req *http.Request) (*http.Response, error)
• type Filter
  • func FilterEmpty() *Filter
  • func FilterFromFiles(includeFilterPath, excludeFilterPath string) (*Filter, error)
  • func (filter *Filter) Pass(object string) bool
• type FilterRuleSet
  • func FilterRulesFromFile(source string) (*FilterRuleSet, error)
  • func (rules *FilterRuleSet) Matches(object string) bool
• type Secret
  • func GetSecret(ctx context.Context, gcpProject, name string) (secret *Secret, err error)
  • func GetSecretFromEnv(filename string) (secret *Secret, err error)
  • func GetTestSecret(ctx context.Context) (secret *Secret, err error)
  • func (s *Secret) MustGetField(name string) string

Constants

const (
	// MetricsNamespace is the namespace for all metrics.
	MetricsNamespace = "trufflehog"
	// MetricsSubsystem is the subsystem for all metrics.
	MetricsSubsystem = "scanner"
)

const AlphaNumPattern = "0-9a-zA-Z"

const DefaultResponseTimeout = 5 * time.Second

const EmailPattern = `` /* 456-byte string literal not displayed */

const HexPattern = "0-9a-f"

const RegexPattern = "0-9a-z"

const SubDomainPattern = `\b([A-Za-z0-9](?:[A-Za-z0-9\-]{0,61}[A-Za-z0-9])?)\b`

const UUIDPattern = `\b([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})\b`

const UUIDPatternUpperCase = `\b([0-9A-Z]{8}-[0-9A-Z]{4}-[0-9A-Z]{4}-[0-9A-Z]{4}-[0-9A-Z]{12})\b`

Variables

var (
	KB, MB, GB, TB, PB = 1e3, 1e6, 1e9, 1e12, 1e15
	IgnoredExtensions  = []string{"mp4", "avi", "mpeg", "mpg", "mov", "wmv", "m4p", "swf", "mp2", "flv", "vob", "webm", "hdv", "3gp", "ogg", "mp3", "wav", "flac", "webp"}
)

Functions

func AddStringSliceItem

func AddStringSliceItem(item string, slice *[]string)

func BuildRegex

func BuildRegex(pattern string, specialChar string, length int) string

Custom Regex functions

func BuildRegexJWT

func BuildRegexJWT(firstRange, secondRange, thirdRange string) string

func IsDone

func IsDone(ctx context.Context) bool

func PinnedCertPool

func PinnedCertPool() *x509.CertPool

func PinnedRetryableHttpClient

func PinnedRetryableHttpClient() *http.Client

func RangeValidation

func RangeValidation(rangeInput string) bool

func Recover

func Recover(ctx context.Context)

Recover handles panics and reports to Sentry.

func RecoverWithExit

func RecoverWithExit(ctx context.Context)

RecoverWithExit handles panics and reports to Sentry before exiting.

func RemoveStringSliceItem

func RemoveStringSliceItem(item string, slice *[]string)

func RetryableHttpClient

func RetryableHttpClient() *http.Client

func RetryableHttpClientTimeout

func RetryableHttpClientTimeout(timeOutSeconds int64) *http.Client

func SaneHttpClient

func SaneHttpClient() *http.Client

func SaneHttpClientTimeOut

func SaneHttpClientTimeOut(timeOutSeconds int64) *http.Client

SaneHttpClientTimeOut adds a custom timeout for some scanners

func SkipFile

func SkipFile(filename string) bool

func ToUpperCase

func ToUpperCase(input string) string

Types

type CustomTransport

type CustomTransport struct {
	T http.RoundTripper
}

func NewCustomTransport

func NewCustomTransport(T http.RoundTripper) *CustomTransport

func (*CustomTransport) RoundTrip

func (t *CustomTransport) RoundTrip(req *http.Request) (*http.Response, error)

type Filter

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

func FilterEmpty

func FilterEmpty() *Filter

FilterEmpty returns a Filter that always passes.

func FilterFromFiles

func FilterFromFiles(includeFilterPath, excludeFilterPath string) (*Filter, error)

FilterFromFiles creates a Filter using the rules in the provided include and exclude files.

func (*Filter) Pass

func (filter *Filter) Pass(object string) bool

Pass returns true if the include FilterRuleSet matches the pattern and the exclude FilterRuleSet does not match.

type FilterRuleSet

type FilterRuleSet []regexp.Regexp

func FilterRulesFromFile

func FilterRulesFromFile(source string) (*FilterRuleSet, error)

FilterRulesFromFile loads the list of regular expression filter rules in `source` and creates a FilterRuleSet.

func (*FilterRuleSet) Matches

func (rules *FilterRuleSet) Matches(object string) bool

Matches will return true if any of the regular expressions in the FilterRuleSet match the pattern.

type Secret

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

func GetSecret

func GetSecret(ctx context.Context, gcpProject, name string) (secret *Secret, err error)

func GetSecretFromEnv

func GetSecretFromEnv(filename string) (secret *Secret, err error)

func GetTestSecret

func GetTestSecret(ctx context.Context) (secret *Secret, err error)

func (*Secret) MustGetField

func (s *Secret) MustGetField(name string) string