privatekey

Documentation

Index

• Variables
• func FingerprintPEMKey(parsedKey any) (string, error)
• type DriftwoodResult
• type Scanner
  • func (s Scanner) Description() string
  • func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (results []detectors.Result, err error)
  • func (s Scanner) IsFalsePositive(_ detectors.Result) (bool, string)
  • func (s Scanner) Keywords() []string
  • func (s Scanner) MaxSecretSize() int64
  • func (s Scanner) Type() detectorspb.DetectorType

Variables

var (
	ErrNotSupported = errors.New("key type not supported")
	ErrEncryptedKey = errors.New("key is encrypted")
)

var (
	ErrUncrackable = errors.New("unable to crack encryption")
)

Functions

func FingerprintPEMKey

func FingerprintPEMKey(parsedKey any) (string, error)

Types

type DriftwoodResult

type DriftwoodResult struct {
	CertificateResults []struct {
		CertificateFingerprint string    `json:"CertificateFingerprint"`
		ExpirationTimestamp    time.Time `json:"ExpirationTimestamp"`
	} `json:"CertificateResults"`
	GitHubSSHResults []struct {
		Username string `json:"Username"`
	} `json:"GitHubSSHResults"`
}

type Scanner

type Scanner struct {
	IncludeExpired bool
}

func (Scanner) Description

func (s Scanner) Description() string

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 Privatekey secrets in a given set of bytes.

func (Scanner) IsFalsePositive

func (s Scanner) IsFalsePositive(_ detectors.Result) (bool, string)

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) MaxSecretSize

func (s Scanner) MaxSecretSize() int64

ProvideMaxSecretSize returns the maximum size of a secret that this detector can find.

func (Scanner) Type

func (s Scanner) Type() detectorspb.DetectorType