From 2f1baea40da850cf64656bb98e0e91935ccc7b0d Mon Sep 17 00:00:00 2001 From: Sahil Silare <32628578+sahil9001@users.noreply.github.com> Date: Fri, 1 Aug 2025 19:54:45 +0530 Subject: [PATCH] [detector] feat: added rootly detector (#3414) * [detector] feat: added rootly detector * [wip]feat: detector rootly * feat: added correct rootly detector * feat: added correct unit tests * feat: added correct unit tests * feat: added correct unit tests * feat: added correct unit test * feat: added `VerificationError` abstraction Signed-off-by: Sahil Silare * feat: addressed review comments Signed-off-by: Sahil Silare * Changed verification URL modified status code handling and added comments fixed GCP cred access in integration tests * Refactor HTTP request in Rootly detector to use http.MethodGet and http.NoBody for improved clarity and consistency. * Incorporated feedback * fixed missing bracket --------- Signed-off-by: Sahil Silare Co-authored-by: Aman Ullah Co-authored-by: Shahzad Haider <76992801+shahzadhaider1@users.noreply.github.com> --- pkg/detectors/rootly/rootly.go | 92 ++++++++++++++ .../rootly/rootly_integration_test.go | 120 ++++++++++++++++++ pkg/detectors/rootly/rootly_test.go | 80 ++++++++++++ pkg/engine/defaults/defaults.go | 2 + pkg/pb/detectorspb/detectors.pb.go | 16 ++- proto/detectors.proto | 1 + 6 files changed, 305 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..93fd7f339 --- /dev/null +++ b/pkg/detectors/rootly/rootly.go @@ -0,0 +1,92 @@ +package rootly + +import ( + "context" + "net/http" + + "fmt" + + "github.com/trufflesecurity/trufflehog/v3/pkg/common" + "github.com/trufflesecurity/trufflehog/v3/pkg/detectors" + "github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb" + regexp "github.com/wasilibs/go-re2" +) + +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(`\b(rootly_[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) + uniqueMatches := make(map[string]struct{}) + for _, match := range keyPat.FindAllStringSubmatch(dataStr, -1) { + uniqueMatches[match[1]] = struct{}{} + } + + for match := range uniqueMatches { + s1 := detectors.Result{ + DetectorType: detectorspb.DetectorType_Rootly, + Raw: []byte(match), + } + + if verify { + isVerified, verificationErr := verifyMatch(ctx, client, match) + s1.Verified = isVerified + s1.SetVerificationError(verificationErr, match) + } + + results = append(results, s1) + } + + return results, nil +} + +func verifyMatch(ctx context.Context, client *http.Client, token string) (bool, error) { + + // this endpoint returns 200 if results exist and 404 if incidents do not exist or that token is not authorized + // considering both 200 and 404 as positive results i.e. the token is valid + // /user/me endpoint does not verify Team and Global API Keys returning 422 error. (There are 3 types of API keys in Rootly, Global, Team and Personal) + req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://api.rootly.com/v1/incidents", http.NoBody) + if err != nil { + return false, err + } + req.Header.Add("Authorization", "Bearer "+token) + res, err := client.Do(req) + + if err != nil { + return false, err + } + defer res.Body.Close() + + switch res.StatusCode { + case http.StatusOK, http.StatusNotFound: + return true, nil + case http.StatusUnauthorized: + return false, nil + default: + return false, fmt.Errorf("unexpected HTTP response status %d", res.StatusCode) + } +} + +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..08152c358 --- /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", "detectors6") + 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..49cdf94f7 --- /dev/null +++ b/pkg/detectors/rootly/rootly_test.go @@ -0,0 +1,80 @@ +package rootly + +import ( + "context" + "testing" + + "github.com/google/go-cmp/cmp" + + "github.com/trufflesecurity/trufflehog/v3/pkg/detectors" + "github.com/trufflesecurity/trufflehog/v3/pkg/engine/ahocorasick" +) + +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: "rootly_7f1e8738d7d6b540bc52e1bc24c6e2c109dc44642f9e5d583be7e5d04f8bd282", + want: []string{"rootly_7f1e8738d7d6b540bc52e1bc24c6e2c109dc44642f9e5d583be7e5d04f8bd282"}, + }, + { + name: "valid pattern - key out of prefix range", + input: "rootly keyword is not close to the real key in the data ='rootly_7f1e8738d7d6b540bc52e1bc24c6e2c109dc44642f9e5d583be7e5d04f8bd282'", + want: []string{"rootly_7f1e8738d7d6b540bc52e1bc24c6e2c109dc44642f9e5d583be7e5d04f8bd282"}, + }, + { + name: "invalid pattern", + input: "rootly_A$3b9f8c1e2d4f5b6c7d8e9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d", + 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/defaults.go b/pkg/engine/defaults/defaults.go index fb8215ed7..638ebd21a 100644 --- a/pkg/engine/defaults/defaults.go +++ b/pkg/engine/defaults/defaults.go @@ -613,6 +613,7 @@ import ( "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/roaring" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/robinhoodcrypto" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/rocketreach" + "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" @@ -1486,6 +1487,7 @@ func buildDetectorList() []detectors.Detector { &robinhoodcrypto.Scanner{}, &rocketreach.Scanner{}, // &rockset.Scanner{}, + &rootly.Scanner{}, &route4me.Scanner{}, &rownd.Scanner{}, &rubygems.Scanner{}, diff --git a/pkg/pb/detectorspb/detectors.pb.go b/pkg/pb/detectorspb/detectors.pb.go index 0dd854692..d39878604 100644 --- a/pkg/pb/detectorspb/detectors.pb.go +++ b/pkg/pb/detectorspb/detectors.pb.go @@ -1141,6 +1141,7 @@ const ( DetectorType_AnypointOAuth2 DetectorType = 1032 DetectorType_WebexBot DetectorType = 1033 DetectorType_TableauPersonalAccessToken DetectorType = 1034 + DetectorType_Rootly DetectorType = 1035 ) // Enum value maps for DetectorType. @@ -2177,6 +2178,7 @@ var ( 1032: "AnypointOAuth2", 1033: "WebexBot", 1034: "TableauPersonalAccessToken", + 1035: "Rootly", } DetectorType_value = map[string]int32{ "Alibaba": 0, @@ -3210,6 +3212,7 @@ var ( "AnypointOAuth2": 1032, "WebexBot": 1033, "TableauPersonalAccessToken": 1034, + "Rootly": 1035, } ) @@ -3663,7 +3666,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, 0xec, 0x85, 0x01, 0x0a, 0x0c, 0x44, 0x65, 0x74, 0x65, 0x63, 0x74, 0x6f, 0x72, + 0x10, 0x04, 0x2a, 0xf9, 0x85, 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, @@ -4734,11 +4737,12 @@ var file_detectors_proto_rawDesc = []byte{ 0x88, 0x08, 0x12, 0x0d, 0x0a, 0x08, 0x57, 0x65, 0x62, 0x65, 0x78, 0x42, 0x6f, 0x74, 0x10, 0x89, 0x08, 0x12, 0x1f, 0x0a, 0x1a, 0x54, 0x61, 0x62, 0x6c, 0x65, 0x61, 0x75, 0x50, 0x65, 0x72, 0x73, 0x6f, 0x6e, 0x61, 0x6c, 0x41, 0x63, 0x63, 0x65, 0x73, 0x73, 0x54, 0x6f, 0x6b, 0x65, 0x6e, 0x10, - 0x8a, 0x08, 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, + 0x8a, 0x08, 0x12, 0x0b, 0x0a, 0x06, 0x52, 0x6f, 0x6f, 0x74, 0x6c, 0x79, 0x10, 0x8b, 0x08, 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 55703b1de..32b9fb73a 100644 --- a/proto/detectors.proto +++ b/proto/detectors.proto @@ -1044,6 +1044,7 @@ enum DetectorType { AnypointOAuth2 = 1032; WebexBot = 1033; TableauPersonalAccessToken = 1034; + Rootly = 1035; } message Result {