From 1fcff0a807ae847e87f24de0b6e05bda579655cc Mon Sep 17 00:00:00 2001 From: Sahil Silare Date: Tue, 15 Oct 2024 23:38:11 +0530 Subject: [PATCH] [detector] feat: added rootly detector --- pkg/detectors/rootly/rootly.go | 77 +++++++++++ .../rootly/rootly_integration_test.go | 120 ++++++++++++++++++ pkg/detectors/rootly/rootly_test.go | 86 +++++++++++++ pkg/engine/defaults.go | 2 + pkg/pb/detectorspb/detectors.pb.go | 16 ++- proto/detectors.proto | 1 + 6 files changed, 296 insertions(+), 6 deletions(-) create mode 100644 pkg/detectors/rootly/rootly.go create mode 100644 pkg/detectors/rootly/rootly_integration_test.go create mode 100644 pkg/detectors/rootly/rootly_test.go diff --git a/pkg/detectors/rootly/rootly.go b/pkg/detectors/rootly/rootly.go new file mode 100644 index 000000000..7244ea27f --- /dev/null +++ b/pkg/detectors/rootly/rootly.go @@ -0,0 +1,77 @@ +package rootly + +import ( + "context" + "net/http" + "strings" + + regexp "github.com/wasilibs/go-re2" + + "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(`\brootly_[a-f0-9]{64}\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{"rootly"} +} + +// FromData will find and optionally verify Rootly 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) != 1 { + continue + } + resMatch := strings.TrimSpace(match[0]) + + s1 := detectors.Result{ + DetectorType: detectorspb.DetectorType_Rootly, + Raw: []byte(resMatch), + } + + if verify { + req, err := http.NewRequestWithContext(ctx, "GET", "https://api.rootly.com/v1/users/me", nil) + if err != nil { + continue + } + req.Header.Add("Authorization", "Bearer "+resMatch) + res, err := client.Do(req) + if err == nil { + defer res.Body.Close() + if res.StatusCode >= 200 && res.StatusCode < 300 { + s1.Verified = true + } + } + } + + results = append(results, s1) + } + + return results, nil +} + +func (s Scanner) Type() detectorspb.DetectorType { + return detectorspb.DetectorType_Rootly +} + +func (s Scanner) Description() string { + return "Rootly is an incident management platform. Rootly API keys can be used to access and manage incident data and other services." +} diff --git a/pkg/detectors/rootly/rootly_integration_test.go b/pkg/detectors/rootly/rootly_integration_test.go new file mode 100644 index 000000000..3bf76852f --- /dev/null +++ b/pkg/detectors/rootly/rootly_integration_test.go @@ -0,0 +1,120 @@ +//go:build detectors +// +build detectors + +package rootly + +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 TestRootly_FromChunk(t *testing.T) { + ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) + defer cancel() + testSecrets, err := common.GetSecret(ctx, "trufflehog-testing", "detectors1") + if err != nil { + t.Fatalf("could not get test secrets from GCP: %s", err) + } + secret := testSecrets.MustGetField("ROOTLY") + inactiveSecret := testSecrets.MustGetField("ROOTLY_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 rootly secret %s within", secret)), + verify: true, + }, + want: []detectors.Result{ + { + DetectorType: detectorspb.DetectorType_Rootly, + Verified: true, + }, + }, + wantErr: false, + }, + { + name: "found, unverified", + s: Scanner{}, + args: args{ + ctx: context.Background(), + data: []byte(fmt.Sprintf("You can find a rootly 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_Rootly, + 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("Rootly.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("Rootly.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++ { + _, err := s.FromData(ctx, false, data) + if err != nil { + b.Fatal(err) + } + } + }) + } +} diff --git a/pkg/detectors/rootly/rootly_test.go b/pkg/detectors/rootly/rootly_test.go new file mode 100644 index 000000000..04fded66e --- /dev/null +++ b/pkg/detectors/rootly/rootly_test.go @@ -0,0 +1,86 @@ +package rootly + +import ( + "context" + "fmt" + "testing" + + "github.com/google/go-cmp/cmp" + + "github.com/trufflesecurity/trufflehog/v3/pkg/detectors" + "github.com/trufflesecurity/trufflehog/v3/pkg/engine/ahocorasick" +) + +var ( + validPattern = "rootly_a3b9f8c1e2d4f5b6c7d8e9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9" + invalidPattern = "rootly_A$3b9f8c1e2d4f5b6c7d8e9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d" +) + +func TestRootly_Pattern(t *testing.T) { + d := Scanner{} + ahoCorasickCore := ahocorasick.NewAhoCorasickCore([]detectors.Detector{d}) + + tests := []struct { + name string + input string + want []string + }{ + { + name: "valid pattern", + input: fmt.Sprintf("rootly: '%s'", validPattern), + want: []string{validPattern}, + }, + { + name: "valid pattern - key out of prefix range", + input: fmt.Sprintf("rootly keyword is not close to the real key in the data\n = '%s'", validPattern), + want: []string{validPattern}, + }, + { + name: "invalid pattern", + input: fmt.Sprintf("rootly: '%s'", invalidPattern), + want: nil, + }, + } + + for _, test := range tests { + t.Run(test.name, func(t *testing.T) { + matchedDetectors := ahoCorasickCore.FindDetectorMatches([]byte(test.input)) + if len(matchedDetectors) == 0 { + t.Errorf("keywords '%v' not matched by: %s", d.Keywords(), test.input) + return + } + + results, err := d.FromData(context.Background(), false, []byte(test.input)) + if err != nil { + t.Errorf("error = %v", err) + return + } + + if len(results) != len(test.want) { + if len(results) == 0 { + t.Errorf("did not receive result") + } else { + t.Errorf("expected %d results, only received %d", len(test.want), len(results)) + } + return + } + + actual := make(map[string]struct{}, len(results)) + for _, r := range results { + if len(r.RawV2) > 0 { + actual[string(r.RawV2)] = struct{}{} + } else { + actual[string(r.Raw)] = struct{}{} + } + } + expected := make(map[string]struct{}, len(test.want)) + for _, v := range test.want { + expected[v] = struct{}{} + } + + if diff := cmp.Diff(expected, actual); diff != "" { + t.Errorf("%s diff: (-want +got)\n%s", test.name, diff) + } + }) + } +} diff --git a/pkg/engine/defaults.go b/pkg/engine/defaults.go index 96604628c..fea4c0f4b 100644 --- a/pkg/engine/defaults.go +++ b/pkg/engine/defaults.go @@ -587,6 +587,7 @@ import ( "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/rocketreach" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/rockset" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/roninapp" + "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/rootly" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/route4me" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/rownd" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/rubygems" @@ -1642,6 +1643,7 @@ func DefaultDetectors() []detectors.Detector { meraki.Scanner{}, saladcloudapikey.Scanner{}, boxoauth.Scanner{}, + rootly.Scanner{}, } // Automatically initialize all detectors that implement diff --git a/pkg/pb/detectorspb/detectors.pb.go b/pkg/pb/detectorspb/detectors.pb.go index fabebd5db..f54844773 100644 --- a/pkg/pb/detectorspb/detectors.pb.go +++ b/pkg/pb/detectorspb/detectors.pb.go @@ -1105,6 +1105,7 @@ const ( DetectorType_SaladCloudApiKey DetectorType = 1001 DetectorType_Box DetectorType = 1002 DetectorType_BoxOauth DetectorType = 1003 + DetectorType_Rootly DetectorType = 1004 ) // Enum value maps for DetectorType. @@ -2110,6 +2111,7 @@ var ( 1001: "SaladCloudApiKey", 1002: "Box", 1003: "BoxOauth", + 1004: "Rootly", } DetectorType_value = map[string]int32{ "Alibaba": 0, @@ -3112,6 +3114,7 @@ var ( "SaladCloudApiKey": 1001, "Box": 1002, "BoxOauth": 1003, + "Rootly": 1004, } ) @@ -3565,7 +3568,7 @@ var file_detectors_proto_rawDesc = []byte{ 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, 0x12, 0x13, 0x0a, 0x0f, 0x45, 0x53, 0x43, 0x41, 0x50, 0x45, 0x44, 0x5f, 0x55, 0x4e, 0x49, 0x43, 0x4f, 0x44, 0x45, - 0x10, 0x04, 0x2a, 0x93, 0x80, 0x01, 0x0a, 0x0c, 0x44, 0x65, 0x74, 0x65, 0x63, 0x74, 0x6f, 0x72, + 0x10, 0x04, 0x2a, 0xa0, 0x80, 0x01, 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, 0x7a, 0x75, 0x72, 0x65, 0x10, 0x03, 0x12, @@ -4590,11 +4593,12 @@ var file_detectors_proto_rawDesc = []byte{ 0x4d, 0x65, 0x72, 0x61, 0x6b, 0x69, 0x10, 0xe8, 0x07, 0x12, 0x15, 0x0a, 0x10, 0x53, 0x61, 0x6c, 0x61, 0x64, 0x43, 0x6c, 0x6f, 0x75, 0x64, 0x41, 0x70, 0x69, 0x4b, 0x65, 0x79, 0x10, 0xe9, 0x07, 0x12, 0x08, 0x0a, 0x03, 0x42, 0x6f, 0x78, 0x10, 0xea, 0x07, 0x12, 0x0d, 0x0a, 0x08, 0x42, 0x6f, - 0x78, 0x4f, 0x61, 0x75, 0x74, 0x68, 0x10, 0xeb, 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, + 0x78, 0x4f, 0x61, 0x75, 0x74, 0x68, 0x10, 0xeb, 0x07, 0x12, 0x0b, 0x0a, 0x06, 0x52, 0x6f, 0x6f, + 0x74, 0x6c, 0x79, 0x10, 0xec, 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 6f220b09d..de8aaf8ee 100644 --- a/proto/detectors.proto +++ b/proto/detectors.proto @@ -1013,6 +1013,7 @@ enum DetectorType { SaladCloudApiKey = 1001; Box = 1002; BoxOauth = 1003; + Rootly = 1004; } message Result {