From eb0c0fa99fcca6dd37892a33e0f8fc7b39c65ae2 Mon Sep 17 00:00:00 2001 From: Damanpreet Singh Date: Fri, 27 Oct 2023 08:47:41 +0530 Subject: [PATCH] Detector-Competition-Feat: Add Metabase Session Secret Detector (#1902) Co-authored-by: Ahrav Dutta --- pkg/detectors/metabase/metabase.go | 88 +++++++++++++++++ pkg/detectors/metabase/metabase_test.go | 123 ++++++++++++++++++++++++ pkg/engine/defaults.go | 2 + pkg/pb/detectorspb/detectors.pb.go | 16 +-- proto/detectors.proto | 1 + 5 files changed, 224 insertions(+), 6 deletions(-) create mode 100644 pkg/detectors/metabase/metabase.go create mode 100644 pkg/detectors/metabase/metabase_test.go diff --git a/pkg/detectors/metabase/metabase.go b/pkg/detectors/metabase/metabase.go new file mode 100644 index 000000000000..ce4e314da0fc --- /dev/null +++ b/pkg/detectors/metabase/metabase.go @@ -0,0 +1,88 @@ +package metabase + +import ( + "context" + "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 boundary characters such as below to reduce false positives. + keyPat = regexp.MustCompile(detectors.PrefixRegex([]string{"metabase"}) + `\b([a-zA-Z0-9-]{36})\b`) + + baseURL = regexp.MustCompile(detectors.PrefixRegex([]string{"metabase"}) + `\b(https?:\/\/[-a-zA-Z0-9@:%._\+~#=]{7,256})\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{"metabase"} +} + +// FromData will find and optionally verify Metabase 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) + urlMatches := baseURL.FindAllStringSubmatch(dataStr, -1) + + for _, match := range matches { + if len(match) != 2 { + continue + } + resMatch := strings.TrimSpace(match[1]) + + for _, urlMatch := range urlMatches { + if len(urlMatch) != 2 { + continue + } + resURLMatch := strings.TrimSpace(urlMatch[1]) + + s1 := detectors.Result{ + DetectorType: detectorspb.DetectorType_Metabase, + Raw: []byte(resMatch), + RawV2: []byte(resMatch + resURLMatch), + } + + if verify { + req, err := http.NewRequestWithContext(ctx, "GET", resURLMatch+"/api/user/current", nil) + if err != nil { + continue + } + req.Header.Add("X-Metabase-Session", resMatch) + res, err := client.Do(req) + if err == nil { + defer res.Body.Close() + if res.StatusCode >= 200 && res.StatusCode < 300 { + 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 results, nil +} + +func (s Scanner) Type() detectorspb.DetectorType { + return detectorspb.DetectorType_Metabase +} diff --git a/pkg/detectors/metabase/metabase_test.go b/pkg/detectors/metabase/metabase_test.go new file mode 100644 index 000000000000..d81385a4f6e4 --- /dev/null +++ b/pkg/detectors/metabase/metabase_test.go @@ -0,0 +1,123 @@ +//go:build detectors +// +build detectors + +package metabase + +import ( + "context" + "fmt" + "testing" + "time" + + "github.com/kylelemons/godebug/pretty" + + "github.com/trufflesecurity/trufflehog/v3/pkg/common" + "github.com/trufflesecurity/trufflehog/v3/pkg/detectors" + "github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb" +) + +func TestMetabase_FromChunk(t *testing.T) { + ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) + defer cancel() + testSecrets, err := common.GetSecret(ctx, "trufflehog-testing", "detectors2") + if err != nil { + t.Fatalf("could not get test secrets from GCP: %s", err) + } + secret := testSecrets.MustGetField("METABASE_SESSION_TOKEN") + inactiveSecret := testSecrets.MustGetField("INACTIVE_METABASE_SESSION_TOKEN") + localUrl := testSecrets.MustGetField("METABASE_URL") + + 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 metabase secret %s with metabase url %s", secret, localUrl)), + verify: true, + }, + want: []detectors.Result{ + { + DetectorType: detectorspb.DetectorType_Metabase, + Verified: true, + }, + }, + wantErr: false, + }, + { + name: "found, unverified", + s: Scanner{}, + args: args{ + ctx: context.Background(), + data: []byte(fmt.Sprintf("You can find a metabase secret %s within but not valid with metabase url %s", inactiveSecret, localUrl)), // the secret would satisfy the regex but not pass validation + verify: true, + }, + want: []detectors.Result{ + { + DetectorType: detectorspb.DetectorType_Metabase, + 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("Metabase.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 len(got[i].RawV2) == 0 { + t.Fatalf("no RawV2 secret present: \n %+v", got[i]) + } + got[i].RawV2 = nil + } + if diff := pretty.Compare(got, tt.want); diff != "" { + t.Errorf("Metabase.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) { + b.ResetTimer() + for n := 0; n < b.N; n++ { + s.FromData(ctx, false, data) + } + }) + } +} diff --git a/pkg/engine/defaults.go b/pkg/engine/defaults.go index f0f1bd370d49..702ec11f8c2c 100644 --- a/pkg/engine/defaults.go +++ b/pkg/engine/defaults.go @@ -407,6 +407,7 @@ import ( "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/mesibo" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/messagebird" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/metaapi" + "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/metabase" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/metrilo" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/microsoftteamswebhook" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/mindmeister" @@ -1552,6 +1553,7 @@ func DefaultDetectors() []detectors.Detector { ip2location.Scanner{}, vagrantcloudpersonaltoken.Scanner{}, openvpn.Scanner{}, + &metabase.Scanner{}, appoptics.Scanner{}, zerotier.Scanner{}, betterstack.Scanner{}, diff --git a/pkg/pb/detectorspb/detectors.pb.go b/pkg/pb/detectorspb/detectors.pb.go index f16900407c1f..fa60eea7ca70 100644 --- a/pkg/pb/detectorspb/detectors.pb.go +++ b/pkg/pb/detectorspb/detectors.pb.go @@ -1027,6 +1027,7 @@ const ( DetectorType_BetterStack DetectorType = 947 DetectorType_ZeroTier DetectorType = 948 DetectorType_AppOptics DetectorType = 949 + DetectorType_Metabase DetectorType = 950 ) // Enum value maps for DetectorType. @@ -1978,6 +1979,7 @@ var ( 947: "BetterStack", 948: "ZeroTier", 949: "AppOptics", + 950: "Metabase", } DetectorType_value = map[string]int32{ "Alibaba": 0, @@ -2926,6 +2928,7 @@ var ( "BetterStack": 947, "ZeroTier": 948, "AppOptics": 949, + "Metabase": 950, } ) @@ -3304,7 +3307,7 @@ var file_detectors_proto_rawDesc = []byte{ 0x44, 0x65, 0x63, 0x6f, 0x64, 0x65, 0x72, 0x54, 0x79, 0x70, 0x65, 0x12, 0x0b, 0x0a, 0x07, 0x55, 0x4e, 0x4b, 0x4e, 0x4f, 0x57, 0x4e, 0x10, 0x00, 0x12, 0x09, 0x0a, 0x05, 0x50, 0x4c, 0x41, 0x49, 0x4e, 0x10, 0x01, 0x12, 0x0a, 0x0a, 0x06, 0x42, 0x41, 0x53, 0x45, 0x36, 0x34, 0x10, 0x02, 0x12, - 0x09, 0x0a, 0x05, 0x55, 0x54, 0x46, 0x31, 0x36, 0x10, 0x03, 0x2a, 0x9c, 0x77, 0x0a, 0x0c, 0x44, + 0x09, 0x0a, 0x05, 0x55, 0x54, 0x46, 0x31, 0x36, 0x10, 0x03, 0x2a, 0xab, 0x77, 0x0a, 0x0c, 0x44, 0x65, 0x74, 0x65, 0x63, 0x74, 0x6f, 0x72, 0x54, 0x79, 0x70, 0x65, 0x12, 0x0b, 0x0a, 0x07, 0x41, 0x6c, 0x69, 0x62, 0x61, 0x62, 0x61, 0x10, 0x00, 0x12, 0x08, 0x0a, 0x04, 0x41, 0x4d, 0x51, 0x50, 0x10, 0x01, 0x12, 0x07, 0x0a, 0x03, 0x41, 0x57, 0x53, 0x10, 0x02, 0x12, 0x09, 0x0a, 0x05, 0x41, @@ -4258,11 +4261,12 @@ var file_detectors_proto_rawDesc = []byte{ 0x54, 0x6f, 0x6b, 0x65, 0x6e, 0x10, 0xb2, 0x07, 0x12, 0x10, 0x0a, 0x0b, 0x42, 0x65, 0x74, 0x74, 0x65, 0x72, 0x53, 0x74, 0x61, 0x63, 0x6b, 0x10, 0xb3, 0x07, 0x12, 0x0d, 0x0a, 0x08, 0x5a, 0x65, 0x72, 0x6f, 0x54, 0x69, 0x65, 0x72, 0x10, 0xb4, 0x07, 0x12, 0x0e, 0x0a, 0x09, 0x41, 0x70, 0x70, - 0x4f, 0x70, 0x74, 0x69, 0x63, 0x73, 0x10, 0xb5, 0x07, 0x42, 0x3d, 0x5a, 0x3b, 0x67, 0x69, 0x74, - 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x74, 0x72, 0x75, 0x66, 0x66, 0x6c, 0x65, 0x73, - 0x65, 0x63, 0x75, 0x72, 0x69, 0x74, 0x79, 0x2f, 0x74, 0x72, 0x75, 0x66, 0x66, 0x6c, 0x65, 0x68, - 0x6f, 0x67, 0x2f, 0x76, 0x33, 0x2f, 0x70, 0x6b, 0x67, 0x2f, 0x70, 0x62, 0x2f, 0x64, 0x65, 0x74, - 0x65, 0x63, 0x74, 0x6f, 0x72, 0x73, 0x70, 0x62, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, + 0x4f, 0x70, 0x74, 0x69, 0x63, 0x73, 0x10, 0xb5, 0x07, 0x12, 0x0d, 0x0a, 0x08, 0x4d, 0x65, 0x74, + 0x61, 0x62, 0x61, 0x73, 0x65, 0x10, 0xb6, 0x07, 0x42, 0x3d, 0x5a, 0x3b, 0x67, 0x69, 0x74, 0x68, + 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x74, 0x72, 0x75, 0x66, 0x66, 0x6c, 0x65, 0x73, 0x65, + 0x63, 0x75, 0x72, 0x69, 0x74, 0x79, 0x2f, 0x74, 0x72, 0x75, 0x66, 0x66, 0x6c, 0x65, 0x68, 0x6f, + 0x67, 0x2f, 0x76, 0x33, 0x2f, 0x70, 0x6b, 0x67, 0x2f, 0x70, 0x62, 0x2f, 0x64, 0x65, 0x74, 0x65, + 0x63, 0x74, 0x6f, 0x72, 0x73, 0x70, 0x62, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, } var ( diff --git a/proto/detectors.proto b/proto/detectors.proto index d5ab4f1f8986..39c8d554c7a4 100644 --- a/proto/detectors.proto +++ b/proto/detectors.proto @@ -958,6 +958,7 @@ enum DetectorType { BetterStack = 947; ZeroTier = 948; AppOptics = 949; + Metabase = 950; } message Result {