From 537aacc56ee6f1e549c87ec53db1ec25ff4bb40a Mon Sep 17 00:00:00 2001 From: Roxanne Tampus Date: Sat, 14 May 2022 11:25:22 +0800 Subject: [PATCH 1/5] added braintreepayments detector --- .../braintreepayments/braintreepayments.go | 99 +++++++++++++++ .../braintreepayments_test.go | 117 ++++++++++++++++++ 2 files changed, 216 insertions(+) create mode 100644 pkg/detectors/braintreepayments/braintreepayments.go create mode 100644 pkg/detectors/braintreepayments/braintreepayments_test.go diff --git a/pkg/detectors/braintreepayments/braintreepayments.go b/pkg/detectors/braintreepayments/braintreepayments.go new file mode 100644 index 000000000000..7f8c0aa30bb2 --- /dev/null +++ b/pkg/detectors/braintreepayments/braintreepayments.go @@ -0,0 +1,99 @@ +package braintreepayments + +import ( + "context" + "io/ioutil" + "net/http" + "regexp" + "strings" + + "github.com/trufflesecurity/trufflehog/v3/pkg/common" + "github.com/trufflesecurity/trufflehog/v3/pkg/detectors" + "github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb" +) + +type Scanner struct{} + +// Ensure the Scanner satisfies the interface at compile time +var _ detectors.Detector = (*Scanner)(nil) + +var ( + client = common.SaneHttpClient() + + //Make sure that your group is surrounded in boundry characters such as below to reduce false positives + keyPat = regexp.MustCompile(detectors.PrefixRegex([]string{"braintreepayments"}) + `\b([0-9a-f]{32})\b`) + idPat = regexp.MustCompile(detectors.PrefixRegex([]string{"braintreepayments"}) + `\b([0-9a-z]{16})\b`) +) + +// Keywords are used for efficiently pre-filtering chunks. +// Use identifiers in the secret preferably, or the provider name. +func (s Scanner) Keywords() []string { + return []string{"braintreepayments"} +} + +// FromData will find and optionally verify BraintreePayments 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) + idMatches := idPat.FindAllStringSubmatch(dataStr, -1) + + for _, match := range matches { + if len(match) != 2 { + continue + } + resMatch := strings.TrimSpace(match[1]) + + for _, idMatch := range idMatches { + if len(idMatch) != 2 { + continue + } + + resIdMatch := strings.TrimSpace(idMatch[1]) + + s1 := detectors.Result{ + DetectorType: detectorspb.DetectorType_BraintreePayments, + Raw: []byte(resMatch), + } + + if verify { + payload := strings.NewReader(`{"query": "query { ping }"}`) + req, err := http.NewRequestWithContext(ctx, "POST", "https://payments.sandbox.braintree-api.com/graphql", payload) + if err != nil { + continue + } + req.Header.Add("Content-Type", "application/json") + req.Header.Add("Braintree-Version", "2019-01-01") + req.SetBasicAuth(resIdMatch, resMatch) + res, err := client.Do(req) + if err == nil { + bodyBytes, err := ioutil.ReadAll(res.Body) + if err != nil { + continue + } + + bodyString := string(bodyBytes) + errorResponse := strings.Contains(bodyString, `"errorType":"developer_error"`) + + defer res.Body.Close() + if res.StatusCode >= 200 && res.StatusCode < 300 { + if errorResponse { + s1.Verified = false + } else { + s1.Verified = true + } + } else { + //This function will check false positives for common test words, but also it will make sure the key appears 'random' enough to be a real key + if detectors.IsKnownFalsePositive(resMatch, detectors.DefaultFalsePositives, true) { + continue + } + } + } + } + + results = append(results, s1) + } + } + + return detectors.CleanResults(results), nil +} diff --git a/pkg/detectors/braintreepayments/braintreepayments_test.go b/pkg/detectors/braintreepayments/braintreepayments_test.go new file mode 100644 index 000000000000..a4dc26e2a21d --- /dev/null +++ b/pkg/detectors/braintreepayments/braintreepayments_test.go @@ -0,0 +1,117 @@ +package braintreepayments + +import ( + "context" + "fmt" + "testing" + "time" + + "github.com/kylelemons/godebug/pretty" + "github.com/trufflesecurity/trufflehog/v3/pkg/detectors" + + "github.com/trufflesecurity/trufflehog/v3/pkg/common" + "github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb" +) + +func TestBraintreePayments_FromChunk(t *testing.T) { + ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) + defer cancel() + testSecrets, err := common.GetSecret(ctx, "trufflehog-testing", "detectors3") + if err != nil { + t.Fatalf("could not get test secrets from GCP: %s", err) + } + secret := testSecrets.MustGetField("BRAINTREEPAYMENTS") + id := testSecrets.MustGetField("BRAINTREEPAYMENTS_USER") + inactiveSecret := testSecrets.MustGetField("BRAINTREEPAYMENTS_INACTIVE") + + type args struct { + ctx context.Context + data []byte + verify bool + } + tests := []struct { + name string + s Scanner + args args + want []detectors.Result + wantErr bool + }{ + { + name: "found, verified", + s: Scanner{}, + args: args{ + ctx: context.Background(), + data: []byte(fmt.Sprintf("You can find a braintreepayments secret %s within braintreepayments %s", secret, id)), + verify: true, + }, + want: []detectors.Result{ + { + DetectorType: detectorspb.DetectorType_BraintreePayments, + Verified: true, + }, + }, + wantErr: false, + }, + { + name: "found, unverified", + s: Scanner{}, + args: args{ + ctx: context.Background(), + data: []byte(fmt.Sprintf("You can find a braintreepayments secret %s within braintreepayments %s but not valid", inactiveSecret, id)), // the secret would satisfy the regex but not pass validation + verify: true, + }, + want: []detectors.Result{ + { + DetectorType: detectorspb.DetectorType_BraintreePayments, + Verified: false, + }, + }, + wantErr: false, + }, + { + name: "not found", + s: Scanner{}, + args: args{ + ctx: context.Background(), + data: []byte("You cannot find the secret within"), + verify: true, + }, + want: nil, + wantErr: false, + }, + } + 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) + if (err != nil) != tt.wantErr { + t.Errorf("BraintreePayments.FromData() error = %v, wantErr %v", err, tt.wantErr) + return + } + for i := range got { + if len(got[i].Raw) == 0 { + t.Fatalf("no raw secret present: \n %+v", got[i]) + } + got[i].Raw = nil + } + if diff := pretty.Compare(got, tt.want); diff != "" { + t.Errorf("BraintreePayments.FromData() %s diff: (-got +want)\n%s", tt.name, diff) + } + }) + } +} + +func BenchmarkFromData(benchmark *testing.B) { + ctx := context.Background() + s := Scanner{} + for name, data := range detectors.MustGetBenchmarkData() { + benchmark.Run(name, func(b *testing.B) { + for n := 0; n < b.N; n++ { + _, err := s.FromData(ctx, false, data) + if err != nil { + b.Fatal(err) + } + } + }) + } +} From 48ccc36b2f397f4a9e43669a2c1d895dc05881ff Mon Sep 17 00:00:00 2001 From: Roxanne Tampus Date: Tue, 17 May 2022 22:12:40 +0800 Subject: [PATCH 2/5] updated condition based on suggestion --- pkg/detectors/braintreepayments/braintreepayments.go | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/pkg/detectors/braintreepayments/braintreepayments.go b/pkg/detectors/braintreepayments/braintreepayments.go index 7f8c0aa30bb2..f5dfe9235eb3 100644 --- a/pkg/detectors/braintreepayments/braintreepayments.go +++ b/pkg/detectors/braintreepayments/braintreepayments.go @@ -76,12 +76,8 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result errorResponse := strings.Contains(bodyString, `"errorType":"developer_error"`) defer res.Body.Close() - if res.StatusCode >= 200 && res.StatusCode < 300 { - if errorResponse { - s1.Verified = false - } else { - s1.Verified = true - } + if res.StatusCode >= 200 && res.StatusCode < 300 && !errorResponse { + s1.Verified = true } else { //This function will check false positives for common test words, but also it will make sure the key appears 'random' enough to be a real key if detectors.IsKnownFalsePositive(resMatch, detectors.DefaultFalsePositives, true) { From 5bf2e6573115487a59eccdd68b47c56869144427 Mon Sep 17 00:00:00 2001 From: Roxanne Tampus Date: Thu, 19 May 2022 10:22:38 +0800 Subject: [PATCH 3/5] enhancements --- pkg/detectors/braintreepayments/braintreepayments.go | 6 +++--- pkg/detectors/braintreepayments/braintreepayments_test.go | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/pkg/detectors/braintreepayments/braintreepayments.go b/pkg/detectors/braintreepayments/braintreepayments.go index f5dfe9235eb3..4c9e7d4f7092 100644 --- a/pkg/detectors/braintreepayments/braintreepayments.go +++ b/pkg/detectors/braintreepayments/braintreepayments.go @@ -21,14 +21,14 @@ var ( client = common.SaneHttpClient() //Make sure that your group is surrounded in boundry characters such as below to reduce false positives - keyPat = regexp.MustCompile(detectors.PrefixRegex([]string{"braintreepayments"}) + `\b([0-9a-f]{32})\b`) - idPat = regexp.MustCompile(detectors.PrefixRegex([]string{"braintreepayments"}) + `\b([0-9a-z]{16})\b`) + keyPat = regexp.MustCompile(detectors.PrefixRegex([]string{"braintree"}) + `\b([0-9a-f]{32})\b`) + idPat = regexp.MustCompile(detectors.PrefixRegex([]string{"braintree"}) + `\b([0-9a-z]{16})\b`) ) // Keywords are used for efficiently pre-filtering chunks. // Use identifiers in the secret preferably, or the provider name. func (s Scanner) Keywords() []string { - return []string{"braintreepayments"} + return []string{"braintree"} } // FromData will find and optionally verify BraintreePayments secrets in a given set of bytes. diff --git a/pkg/detectors/braintreepayments/braintreepayments_test.go b/pkg/detectors/braintreepayments/braintreepayments_test.go index a4dc26e2a21d..59f28dedcb63 100644 --- a/pkg/detectors/braintreepayments/braintreepayments_test.go +++ b/pkg/detectors/braintreepayments/braintreepayments_test.go @@ -41,7 +41,7 @@ func TestBraintreePayments_FromChunk(t *testing.T) { s: Scanner{}, args: args{ ctx: context.Background(), - data: []byte(fmt.Sprintf("You can find a braintreepayments secret %s within braintreepayments %s", secret, id)), + data: []byte(fmt.Sprintf("You can find a braintreepayments secret %s within braintree %s", secret, id)), verify: true, }, want: []detectors.Result{ @@ -57,7 +57,7 @@ func TestBraintreePayments_FromChunk(t *testing.T) { s: Scanner{}, args: args{ ctx: context.Background(), - data: []byte(fmt.Sprintf("You can find a braintreepayments secret %s within braintreepayments %s but not valid", inactiveSecret, id)), // the secret would satisfy the regex but not pass validation + data: []byte(fmt.Sprintf("You can find a braintreepayments secret %s within braintree %s but not valid", inactiveSecret, id)), // the secret would satisfy the regex but not pass validation verify: true, }, want: []detectors.Result{ From 85dab54f1e36d789c1f32b37e2f3dbcb5bf0f7a2 Mon Sep 17 00:00:00 2001 From: Roxanne Tampus Date: Thu, 19 May 2022 23:28:13 +0800 Subject: [PATCH 4/5] enhancement --- pkg/detectors/braintreepayments/braintreepayments_test.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pkg/detectors/braintreepayments/braintreepayments_test.go b/pkg/detectors/braintreepayments/braintreepayments_test.go index 59f28dedcb63..d1a02fe6c4e5 100644 --- a/pkg/detectors/braintreepayments/braintreepayments_test.go +++ b/pkg/detectors/braintreepayments/braintreepayments_test.go @@ -41,7 +41,7 @@ func TestBraintreePayments_FromChunk(t *testing.T) { s: Scanner{}, args: args{ ctx: context.Background(), - data: []byte(fmt.Sprintf("You can find a braintreepayments secret %s within braintree %s", secret, id)), + data: []byte(fmt.Sprintf("You can find a braintree secret %s within braintree %s", secret, id)), verify: true, }, want: []detectors.Result{ @@ -57,7 +57,7 @@ func TestBraintreePayments_FromChunk(t *testing.T) { s: Scanner{}, args: args{ ctx: context.Background(), - data: []byte(fmt.Sprintf("You can find a braintreepayments secret %s within braintree %s but not valid", inactiveSecret, id)), // the secret would satisfy the regex but not pass validation + data: []byte(fmt.Sprintf("You can find a braintree secret %s within braintree %s but not valid", inactiveSecret, id)), // the secret would satisfy the regex but not pass validation verify: true, }, want: []detectors.Result{ From fd98dd274c4ad3fb9eff38e4dfe7116949e5f529 Mon Sep 17 00:00:00 2001 From: Roxanne Tampus Date: Tue, 24 May 2022 10:07:47 +0800 Subject: [PATCH 5/5] enhancement for valid response --- pkg/detectors/braintreepayments/braintreepayments.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pkg/detectors/braintreepayments/braintreepayments.go b/pkg/detectors/braintreepayments/braintreepayments.go index 4c9e7d4f7092..d68bab96b1ca 100644 --- a/pkg/detectors/braintreepayments/braintreepayments.go +++ b/pkg/detectors/braintreepayments/braintreepayments.go @@ -73,10 +73,10 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result } bodyString := string(bodyBytes) - errorResponse := strings.Contains(bodyString, `"errorType":"developer_error"`) + validResponse := strings.Contains(bodyString, `"data":{`) defer res.Body.Close() - if res.StatusCode >= 200 && res.StatusCode < 300 && !errorResponse { + if res.StatusCode >= 200 && res.StatusCode < 300 && validResponse { s1.Verified = true } else { //This function will check false positives for common test words, but also it will make sure the key appears 'random' enough to be a real key