Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
update pagerdutyapikey detector to tri-state verification (#1836)
āh̳̕mͭͭͨͩ̐e̘ͬ́͋ͬ̊̓͂df8f0c984fbe7
diff --git a/pkg/detectors/pagerdutyapikey/pagerdutyapikey.go b/pkg/detectors/pagerdutyapikey/pagerdutyapikey.goindex e454cff40..6122bd5ee 100644--- a/pkg/detectors/pagerdutyapikey/pagerdutyapikey.go+++ b/pkg/detectors/pagerdutyapikey/pagerdutyapikey.go@@ -12,14 +12,17 @@ import ("github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb")-type Scanner struct{}+type Scanner struct {+ client *http.Client+}// Ensure the Scanner satisfies the interface at compile time.var _ detectors.Detector = (*Scanner)(nil)-var (- client = common.SaneHttpClient()+const verifyURL = "https://api.pagerduty.com/users"+var (+ defaultClient = common.SaneHttpClient()// Make sure that your group is surrounded in boundary characters such as below to reduce false positives.keyPat = regexp.MustCompile(detectors.PrefixRegex([]string{"pagerduty", "pd"}) + `\b([a-zA-Z0-9_+-]{20})\b`))@@ -33,7 +36,6 @@ func (s Scanner) Keywords() []string {// FromData will find and optionally verify PagerDutyApiKey secrets in a given set of bytes.func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (results []detectors.Result, err error) {dataStr := string(data)-matches := keyPat.FindAllStringSubmatch(dataStr, -1)for _, match := range matches {@@ -48,34 +50,52 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result}if verify {- req, err := http.NewRequestWithContext(ctx, "GET", "https://api.pagerduty.com/users", nil)- if err != nil {- continue- }- req.Header.Add("Accept", "application/vnd.pagerduty+json;version=2")- req.Header.Add("Content-Type", "application/json")- req.Header.Add("Authorization", fmt.Sprintf("Token %s", resMatch))- res, err := client.Do(req)- if err == nil {- defer res.Body.Close()- if res.StatusCode >= 200 && res.StatusCode < 300 {- s1.Verified = true- }- }+ client := s.getClient()+ isVerified, verificationErr := verifyPagerdutyapikey(ctx, client, resMatch)+ s1.Verified = isVerified+ s1.VerificationError = verificationErr}- if !s1.Verified {- if detectors.IsKnownFalsePositive(string(s1.Raw), detectors.DefaultFalsePositives, true) {- continue- }+ if !s1.Verified && detectors.IsKnownFalsePositive(string(s1.Raw), detectors.DefaultFalsePositives, true) {+ continue}-results = append(results, s1)}return results, nil}+func (s Scanner) getClient() *http.Client {+ if s.client != nil {+ return s.client+ }+ return defaultClient+}++func verifyPagerdutyapikey(ctx context.Context, client *http.Client, token string) (bool, error) {+ req, err := http.NewRequestWithContext(ctx, http.MethodGet, verifyURL, nil)+ if err != nil {+ return false, err+ }+ req.Header.Add("Accept", "application/vnd.pagerduty+json;version=2")+ req.Header.Add("Content-Type", "application/json")+ req.Header.Add("Authorization", fmt.Sprintf("Token %s", token))+ res, err := client.Do(req)+ if err != nil {+ return false, err+ }+ defer res.Body.Close()++ switch res.StatusCode {+ case http.StatusOK:+ return true, nil+ case http.StatusUnauthorized:+ return false, nil+ default:+ return false, fmt.Errorf("unexpected HTTP response status %d", res.StatusCode)+ }+}+func (s Scanner) Type() detectorspb.DetectorType {return detectorspb.DetectorType_PagerDutyApiKey}diff --git a/pkg/detectors/pagerdutyapikey/pagerdutyapikey_test.go b/pkg/detectors/pagerdutyapikey/pagerdutyapikey_test.goindex 7b93c3a08..5f16180ed 100644--- a/pkg/detectors/pagerdutyapikey/pagerdutyapikey_test.go+++ b/pkg/detectors/pagerdutyapikey/pagerdutyapikey_test.go@@ -9,8 +9,8 @@ import ("testing""time"- "github.com/kylelemons/godebug/pretty"-+ "github.com/google/go-cmp/cmp"+ "github.com/google/go-cmp/cmp/cmpopts""github.com/trufflesecurity/trufflehog/v3/pkg/common""github.com/trufflesecurity/trufflehog/v3/pkg/detectors""github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb"@@ -32,11 +32,12 @@ func TestPagerDutyApiKey_FromChunk(t *testing.T) {verify bool}tests := []struct {- name string- s Scanner- args args- want []detectors.Result- wantErr bool+ name string+ s Scanner+ args args+ want []detectors.Result+ wantErr bool+ wantVerificationErr bool}{{name: "found, verified",@@ -54,6 +55,40 @@ func TestPagerDutyApiKey_FromChunk(t *testing.T) {},wantErr: false,},+ {+ name: "found, would be verified if not for timeout",+ s: Scanner{client: common.SaneHttpClientTimeOut(1 * time.Microsecond)},+ args: args{+ ctx: context.Background(),+ data: []byte(fmt.Sprintf("You can find a pagerdutyapikey secret %s within", secret)),+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_PagerDutyApiKey,+ Verified: false,+ },+ },+ wantErr: false,+ wantVerificationErr: true,+ },+ {+ name: "found, verified but unexpected api surface",+ s: Scanner{client: common.ConstantResponseHttpClient(404, "")},+ args: args{+ ctx: context.Background(),+ data: []byte(fmt.Sprintf("You can find a pagerdutyapikey secret %s within", secret)),+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_PagerDutyApiKey,+ Verified: false,+ },+ },+ wantErr: false,+ wantVerificationErr: true,+ },{name: "found, unverified",s: Scanner{},@@ -84,8 +119,7 @@ func TestPagerDutyApiKey_FromChunk(t *testing.T) {}for _, tt := range tests {t.Run(tt.name, func(t *testing.T) {- s := Scanner{}- got, err := s.FromData(tt.args.ctx, tt.args.verify, tt.args.data)+ got, err := tt.s.FromData(tt.args.ctx, tt.args.verify, tt.args.data)if (err != nil) != tt.wantErr {t.Errorf("PagerDutyApiKey.FromData() error = %v, wantErr %v", err, tt.wantErr)return@@ -94,9 +128,12 @@ func TestPagerDutyApiKey_FromChunk(t *testing.T) {if len(got[i].Raw) == 0 {t.Fatalf("no raw secret present: \n %+v", got[i])}- got[i].Raw = nil+ if (got[i].VerificationError != nil) != tt.wantVerificationErr {+ t.Errorf("PagerDutyApiKey.FromData() verificationError = %v, wantVerificationErr %v", got[i].VerificationError, tt.wantVerificationErr)+ }}- if diff := pretty.Compare(got, tt.want); diff != "" {+ ignoreOpts := cmpopts.IgnoreFields(detectors.Result{}, "Raw", "VerificationError")+ if diff := cmp.Diff(got, tt.want, ignoreOpts); diff != "" {t.Errorf("PagerDutyApiKey.FromData() %s diff: (-got +want)\n%s", tt.name, diff)}})