From 11a04de789380fe383d1cde771737ccb45f4b1c0 Mon Sep 17 00:00:00 2001 From: marlon pamisa Date: Tue, 18 Jan 2022 22:19:13 -0800 Subject: [PATCH] added shortcut detector --- pkg/detectors/shortcut/shortcut.go | 79 +++++++++++++++++ pkg/detectors/shortcut/shortcut_test.go | 113 ++++++++++++++++++++++++ 2 files changed, 192 insertions(+) create mode 100644 pkg/detectors/shortcut/shortcut.go create mode 100644 pkg/detectors/shortcut/shortcut_test.go diff --git a/pkg/detectors/shortcut/shortcut.go b/pkg/detectors/shortcut/shortcut.go new file mode 100644 index 000000000..33bb82134 --- /dev/null +++ b/pkg/detectors/shortcut/shortcut.go @@ -0,0 +1,79 @@ +package shortcut + +import ( + "context" + "io/ioutil" + + // "log" + "regexp" + "strings" + + "net/http" + + "github.com/trufflesecurity/trufflehog/pkg/common" + "github.com/trufflesecurity/trufflehog/pkg/detectors" + "github.com/trufflesecurity/trufflehog/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{"shortcut"}) + `\b([0-9a-f-]{36})\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{"shortcut"} +} + +// FromData will find and optionally verify Shortcut 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 { + if len(match) != 2 { + continue + } + resMatch := strings.TrimSpace(match[1]) + + s1 := detectors.Result{ + DetectorType: detectorspb.DetectorType_Shortcut, + Raw: []byte(resMatch), + } + + if verify { + req, _ := http.NewRequest("GET", "https://api.app.shortcut.com/api/v3/categories", nil) + req.Header.Add("Content-Type", "application/json") + req.Header.Add("Shortcut-Token", resMatch) + res, err := client.Do(req) + if err == nil { + defer res.Body.Close() + bodyBytes, _ := ioutil.ReadAll(res.Body) + body := string(bodyBytes) + + if !strings.Contains(body, "Unauthorized") { + s1.Verified = true + } else { + // if detectors.IsKnownFalsePositive(resMatch, detectors.DefaultFalsePositives, true) { + // continue + // } + } + + } + + } + + results = append(results, s1) + } + + return detectors.CleanResults(results), nil +} diff --git a/pkg/detectors/shortcut/shortcut_test.go b/pkg/detectors/shortcut/shortcut_test.go new file mode 100644 index 000000000..2b159b6d0 --- /dev/null +++ b/pkg/detectors/shortcut/shortcut_test.go @@ -0,0 +1,113 @@ +package shortcut + +import ( + "context" + "fmt" + "testing" + "time" + + "github.com/kylelemons/godebug/pretty" + + "github.com/trufflesecurity/trufflehog/pkg/common" + "github.com/trufflesecurity/trufflehog/pkg/detectors" + "github.com/trufflesecurity/trufflehog/pkg/pb/detectorspb" +) + +func TestShortcut_FromChunk(t *testing.T) { + ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) + defer cancel() + testSecrets, err := common.GetScannersTestSecretsVersion(ctx, 2) + if err != nil { + t.Fatalf("could not get test secrets from GCP: %s", err) + } + secret := testSecrets.MustGetField("SHORTCUT") + inactiveSecret := testSecrets.MustGetField("SHORTCUT_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 shortcut secret %s within", secret)), + verify: true, + }, + want: []detectors.Result{ + { + DetectorType: detectorspb.DetectorType_Shortcut, + Verified: true, + }, + }, + wantErr: false, + }, + { + name: "found, unverified", + s: Scanner{}, + args: args{ + ctx: context.Background(), + data: []byte(fmt.Sprintf("You can find a shortcut 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_Shortcut, + 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("Shortcut.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("Shortcut.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++ { + s.FromData(ctx, false, data) + } + }) + } +}