privatekey

Documentation

Index

• Variables
• func Crack(in []byte) (any, string, error)
• func FingerprintPEMKey(parsedKey any) (string, error)
• func Normalize(in string) string
• func VerifyGitHubUser(ctx context.Context, parsedKey any) (*string, error)
• func VerifyGitLabUser(ctx context.Context, parsedKey any) (*string, error)
• type DriftwoodResult
  • func LookupFingerprint(ctx context.Context, publicKeyFingerprintInHex string) (*DriftwoodResult, error)
• 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
• type VerificationErrors
  • func NewVerificationErrors(capacity int) *VerificationErrors
  • func (e *VerificationErrors) Add(err error)

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 Crack

func Crack(in []byte) (any, string, error)

func FingerprintPEMKey

func FingerprintPEMKey(parsedKey any) (string, error)

func Normalize

func Normalize(in string) string

func VerifyGitHubUser

func VerifyGitHubUser(ctx context.Context, parsedKey any) (*string, error)

func VerifyGitLabUser

func VerifyGitLabUser(ctx context.Context, parsedKey any) (*string, error)

Types

type DriftwoodResult

type DriftwoodResult struct {
	CertificateResults []struct {
		Domains                []string  `json:",omitempty"`
		CertificateFingerprint string    `json:"CertificateFingerprint"`
		ExpirationTimestamp    time.Time `json:"ExpirationTimestamp"`
		IssuerName             string    `json:",omitempty"` // CA information
		SubjectName            string    `json:",omitempty"` // Certificate subject
		IssuerOrganization     []string  `json:",omitempty"` // CA organization(s)
		SubjectOrganization    []string  `json:",omitempty"` // Subject organization(s)
		KeyUsages              []string  `json:",omitempty"` // e.g., ["DigitalSignature", "KeyEncipherment"]
		ExtendedKeyUsages      []string  `json:",omitempty"` // e.g., ["ServerAuth", "ClientAuth"]
		SubjectKeyID           string    `json:",omitempty"` // hex encoded
		AuthorityKeyID         string    `json:",omitempty"` // hex encoded
		SerialNumber           string    `json:",omitempty"` // hex encoded
	} `json:"CertificateResults"`
	GitHubSSHResults []struct {
		Username string `json:"Username"`
	} `json:"GitHubSSHResults"`
}

func LookupFingerprint

func LookupFingerprint(ctx context.Context, publicKeyFingerprintInHex string) (*DriftwoodResult, error)

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

type VerificationErrors

type VerificationErrors struct {
	Errors []string
	// contains filtered or unexported fields
}

func NewVerificationErrors

func NewVerificationErrors(capacity int) *VerificationErrors

func (*VerificationErrors) Add

func (e *VerificationErrors) Add(err error)