Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
(fix) Indeterminate verification issue in Clickup detector (#4047)
Abdul Basitb9ab7019bd66
diff --git a/pkg/detectors/clickuppersonaltoken/clickuppersonaltoken.go b/pkg/detectors/clickuppersonaltoken/clickuppersonaltoken.goindex 4502e09ac..1f5907bf0 100644--- a/pkg/detectors/clickuppersonaltoken/clickuppersonaltoken.go+++ b/pkg/detectors/clickuppersonaltoken/clickuppersonaltoken.go@@ -2,6 +2,8 @@ package clickuppersonaltokenimport ("context"+ "fmt"+ "io""net/http""strings"@@ -12,16 +14,18 @@ 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()+ defaultClient = common.SaneHttpClient()// Make sure that your group is surrounded in boundary characters such as below to reduce false positives.- keyPat = regexp.MustCompile(`\b(pk_[0-9]{7,8}_[0-9A-Z]{32})\b`)+ keyPat = regexp.MustCompile(detectors.PrefixRegex([]string{"clickup"}) + `\b(pk_[0-9]{7,9}_[0-9A-Z]{32})\b`))// Keywords are used for efficiently pre-filtering chunks.@@ -34,29 +38,25 @@ func (s Scanner) Keywords() []string {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 {- resMatch := strings.TrimSpace(match[1])+ uniqueMatches := make(map[string]struct{})+ for _, match := range keyPat.FindAllStringSubmatch(dataStr, -1) {+ uniqueMatches[strings.TrimSpace(match[1])] = struct{}{}+ }+ for resMatch := range uniqueMatches {s1 := detectors.Result{DetectorType: detectorspb.DetectorType_ClickupPersonalToken,Raw: []byte(resMatch),}if verify {- req, err := http.NewRequestWithContext(ctx, "GET", "https://api.clickup.com/api/v2/user", nil)- if err != nil {- continue- }- req.Header.Add("Authorization", 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.client+ if client == nil {+ client = defaultClient}+ isVerified, err := verifyToken(ctx, client, resMatch)+ s1.Verified = isVerified+ s1.SetVerificationError(err, resMatch)}results = append(results, s1)@@ -72,3 +72,28 @@ func (s Scanner) Type() detectorspb.DetectorType {func (s Scanner) Description() string {return "ClickUp is a project management tool. Personal tokens can be used to access and modify data within ClickUp on behalf of a user."}++func verifyToken(ctx context.Context, client *http.Client, token string) (bool, error) {+ req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://api.clickup.com/api/v2/user", nil)+ if err != nil {+ return false, err+ }+ req.Header.Add("Authorization", token)+ res, err := client.Do(req)+ if err != nil {+ return false, err+ }+ defer func() {+ _, _ = io.Copy(io.Discard, res.Body)+ _ = res.Body.Close()+ }()++ switch res.StatusCode {+ case http.StatusOK:+ return true, nil+ case http.StatusUnauthorized:+ return false, nil+ default:+ return false, fmt.Errorf("unexpected status code %d", res.StatusCode)+ }+}diff --git a/pkg/detectors/clickuppersonaltoken/clickuppersonaltoken_integration_test.go b/pkg/detectors/clickuppersonaltoken/clickuppersonaltoken_integration_test.goindex 8c8bd60f7..2be96fda4 100644--- a/pkg/detectors/clickuppersonaltoken/clickuppersonaltoken_integration_test.go+++ b/pkg/detectors/clickuppersonaltoken/clickuppersonaltoken_integration_test.go@@ -9,7 +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/detectors""github.com/trufflesecurity/trufflehog/v3/pkg/common"@@ -32,11 +33,12 @@ func TestClickupPersonalToken_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",@@ -52,7 +54,8 @@ func TestClickupPersonalToken_FromChunk(t *testing.T) {Verified: true,},},- wantErr: false,+ wantErr: false,+ wantVerificationErr: false,},{name: "found, unverified",@@ -68,7 +71,8 @@ func TestClickupPersonalToken_FromChunk(t *testing.T) {Verified: false,},},- wantErr: false,+ wantErr: false,+ wantVerificationErr: false,},{name: "not found",@@ -78,14 +82,31 @@ func TestClickupPersonalToken_FromChunk(t *testing.T) {data: []byte("You cannot find the secret within"),verify: true,},- want: nil,- wantErr: false,+ want: nil,+ wantErr: false,+ wantVerificationErr: false,+ },+ {+ name: "found verifiable secret, verification failed due to unexpected API response",+ s: Scanner{client: common.ConstantResponseHttpClient(404, "")},+ args: args{+ ctx: context.Background(),+ data: []byte(fmt.Sprintf("You can find a clickuppersonaltoken secret %s within but not valid", inactiveSecret)), // the secret would satisfy the regex but not pass validation+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_ClickupPersonalToken,+ Verified: false,+ },+ },+ wantErr: false,+ wantVerificationErr: true,},}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("ClickupPersonalToken.FromData() error = %v, wantErr %v", err, tt.wantErr)return@@ -94,9 +115,15 @@ func TestClickupPersonalToken_FromChunk(t *testing.T) {if len(got[i].Raw) == 0 {t.Fatalf("no raw secret present: \n %+v", got[i])}++ if (got[i].VerificationError() != nil) != tt.wantVerificationErr {+ t.Fatalf("wantVerificationError = %v, verification error = %v", tt.wantVerificationErr, got[i].VerificationError())+ }got[i].Raw = nil}- 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("ClickupPersonalToken.FromData() %s diff: (-got +want)\n%s", tt.name, diff)}})