github

Documentation

Index

• func WithVerifierURLs(urls []string, includeDefault bool) func(*Scanner)
• type Scanner
  • func New(opts ...func(*Scanner)) *Scanner
  • func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (results []detectors.Result, err error)
  • func (s Scanner) Keywords() []string
  • func (s Scanner) Type() detectorspb.DetectorType
  • func (s Scanner) Version() int

Functions

func WithVerifierURLs

func WithVerifierURLs(urls []string, includeDefault bool) func(*Scanner)

WithVerifierURLs adds the given URLs to the list of URLs to check for verification of secrets.

Types

type Scanner

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

func New

func New(opts ...func(*Scanner)) *Scanner

New creates a new Scanner with the given options.

func (Scanner) FromData

func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (results []detectors.Result, err error)

FromData will find and optionally verify GitHub secrets in a given set of bytes.

func (Scanner) Keywords

func (s Scanner) Keywords() []string

Keywords are used for efficiently pre-filtering chunks. Use identifiers in the secret preferably, or the provider name.

func (Scanner) Type

func (s Scanner) Type() detectorspb.DetectorType

func (Scanner) Version

func (s Scanner) Version() int