Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
[Feature] Added Detector for the Photoroom API (#4414)
Nabeel Alamb231e11b16a8
diff --git a/pkg/detectors/photoroom/photoroom.go b/pkg/detectors/photoroom/photoroom.gonew file mode 100644index 000000000..0603881f2--- /dev/null+++ b/pkg/detectors/photoroom/photoroom.go@@ -0,0 +1,102 @@+package photoroom++import (+ "context"+ "fmt"+ "io"+ "net/http"++ 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 {+ client *http.Client+}++// Ensure the Scanner satisfies the interface at compile time.+var _ detectors.Detector = (*Scanner)(nil)++var (+ defaultClient = 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{"photoroom"}) + `\b(?:sandbox_)?(sk_pr_[a-zA-Z0-9]{1,64}_[a-fA-F0-9]{40})\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{"photoroom"}+}++// FromData will find and optionally verify Photoroom 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_Photoroom,+ Raw: []byte(match),+ }++ if verify {+ client := s.client+ if client == nil {+ client = defaultClient+ }++ isVerified, verificationErr := verifyMatch(ctx, client, match)+ s1.Verified = isVerified+ s1.SetVerificationError(verificationErr, match)+ }++ results = append(results, s1)+ }++ return+}++func verifyMatch(ctx context.Context, client *http.Client, key string) (bool, error) {+ // API Reference: https://www.photoroom.com/api/docs/reference/611c03dbcec67-account-details+ url := "https://image-api.photoroom.com/v1/account"+ req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, http.NoBody)+ if err != nil {+ return false, err+ }+ req.Header.Set("x-api-key", key)++ res, err := client.Do(req)+ if err != nil {+ return false, err+ }+ defer func() {+ _, _ = io.Copy(io.Discard, res.Body)+ _ = res.Body.Close()+ }()++ switch res.StatusCode {+ case http.StatusOK:+ return true, nil+ case http.StatusForbidden:+ // The secret is determinately not verified (nothing to do)+ return false, nil+ default:+ return false, fmt.Errorf("unexpected HTTP response status %d", res.StatusCode)+ }+}++func (s Scanner) Type() detectorspb.DetectorType {+ return detectorspb.DetectorType_Photoroom+}++func (s Scanner) Description() string {+ return "Photoroom is an AI photo editing platform that provides a suite of tools and services for creating and enhancing images. Photoroom API keys can be used to access these services."+}diff --git a/pkg/detectors/photoroom/photoroom_integration_test.go b/pkg/detectors/photoroom/photoroom_integration_test.gonew file mode 100644index 000000000..01ff689ba--- /dev/null+++ b/pkg/detectors/photoroom/photoroom_integration_test.go@@ -0,0 +1,161 @@+//go:build detectors+// +build detectors++package photoroom++import (+ "context"+ "fmt"+ "testing"+ "time"++ "github.com/google/go-cmp/cmp"+ "github.com/google/go-cmp/cmp/cmpopts"++ "github.com/trufflesecurity/trufflehog/v3/pkg/common"+ "github.com/trufflesecurity/trufflehog/v3/pkg/detectors"+ "github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb"+)++func TestPhotoroom_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("PHOTOROOM")+ inactiveSecret := testSecrets.MustGetField("PHOTOROOM_INACTIVE")++ type args struct {+ ctx context.Context+ data []byte+ verify bool+ }+ tests := []struct {+ name string+ s Scanner+ args args+ want []detectors.Result+ wantErr bool+ wantVerificationErr bool+ }{+ {+ name: "found, verified",+ s: Scanner{},+ args: args{+ ctx: context.Background(),+ data: []byte(fmt.Sprintf("You can find a photoroom secret %s within", secret)),+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_Photoroom,+ Verified: true,+ },+ },+ wantErr: false,+ wantVerificationErr: false,+ },+ {+ name: "found, unverified",+ s: Scanner{},+ args: args{+ ctx: context.Background(),+ data: []byte(fmt.Sprintf("You can find a photoroom 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_Photoroom,+ Verified: false,+ },+ },+ wantErr: false,+ wantVerificationErr: 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,+ wantVerificationErr: false,+ },+ {+ name: "found, would be verified if not for timeout",+ s: Scanner{client: common.SaneHttpClientTimeOut(1 * time.Microsecond)},+ args: args{+ ctx: context.Background(),+ data: []byte(fmt.Sprintf("You can find a photoroom secret %s within", secret)),+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_Photoroom,+ Verified: false,+ },+ },+ wantErr: false,+ wantVerificationErr: true,+ },+ {+ name: "found, verified but unexpected api surface",+ s: Scanner{client: common.ConstantResponseHttpClient(404, "")},+ args: args{+ ctx: context.Background(),+ data: []byte(fmt.Sprintf("You can find a photoroom secret %s within", secret)),+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_Photoroom,+ Verified: false,+ },+ },+ wantErr: false,+ wantVerificationErr: true,+ },+ }+ for _, tt := range tests {+ t.Run(tt.name, func(t *testing.T) {+ got, err := tt.s.FromData(tt.args.ctx, tt.args.verify, tt.args.data)+ if (err != nil) != tt.wantErr {+ t.Errorf("Photoroom.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])+ }+ if (got[i].VerificationError() != nil) != tt.wantVerificationErr {+ t.Fatalf("wantVerificationError = %v, verification error = %v", tt.wantVerificationErr, got[i].VerificationError())+ }+ }+ ignoreOpts := cmpopts.IgnoreFields(detectors.Result{}, "Raw", "verificationError", "primarySecret")+ if diff := cmp.Diff(got, tt.want, ignoreOpts); diff != "" {+ t.Errorf("Photoroom.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/photoroom/photoroom_test.go b/pkg/detectors/photoroom/photoroom_test.gonew file mode 100644index 000000000..73062aadf--- /dev/null+++ b/pkg/detectors/photoroom/photoroom_test.go@@ -0,0 +1,111 @@+package photoroom++import (+ "context"+ "testing"++ "github.com/google/go-cmp/cmp"+ "github.com/stretchr/testify/require"++ "github.com/trufflesecurity/trufflehog/v3/pkg/detectors"+ "github.com/trufflesecurity/trufflehog/v3/pkg/engine/ahocorasick"+)++func TestPhotoroom_Pattern(t *testing.T) {+ d := Scanner{}+ ahoCorasickCore := ahocorasick.NewAhoCorasickCore([]detectors.Detector{d})+ tests := []struct {+ name string+ input string+ want []string+ }{+ {+ name: "valid pattern",+ input: `+ [INFO] Sending request to the photoroom API+ [DEBUG] Using Key=sk_pr_mykey_fa02df705055df9e4d159fe3bad0cf3bb8cd1dc2+ [INFO] Response received: 200 OK+ `,+ want: []string{"sk_pr_mykey_fa02df705055df9e4d159fe3bad0cf3bb8cd1dc2"},+ },+ {+ name: "valid sandbox pattern",+ input: `+ [INFO] Sending request to the photoroom API+ [DEBUG] Using Key=sandbox_sk_pr_mykey_fa02df705055df9e4d159fe3bad0cf3bb8cd1dc2+ [INFO] Response received: 200 OK+ `,+ want: []string{"sk_pr_mykey_fa02df705055df9e4d159fe3bad0cf3bb8cd1dc2"},+ },+ {+ name: "valid pattern - xml",+ input: `+ <com.cloudbees.plugins.credentials.impl.StringCredentialsImpl>+ <scope>GLOBAL</scope>+ <id>{photoroom}</id>+ <secret>{photoroom AQAAABAAA sk_pr_mykey_fa02df705055df9e4d159fe3bad0cf3bb8cd1dc2}</secret>+ <description>configuration for production</description>+ <creationDate>2023-05-18T14:32:10Z</creationDate>+ <owner>jenkins-admin</owner>+ </com.cloudbees.plugins.credentials.impl.StringCredentialsImpl>+ `,+ want: []string{"sk_pr_mykey_fa02df705055df9e4d159fe3bad0cf3bb8cd1dc2"},+ },+ {+ name: "finds all matches",+ input: `+ [INFO] Sending request to the photoroom API+ [DEBUG] Using Key=sk_pr_mykey_fa02df705055df9e4d159fe3bad0cf3bb8cd1dc2+ [ERROR] Response received 401 UnAuthorized+ [DEBUG] Using photoroom Key=sk_pr_mykey2_509b8c07454aca248a0a381b46e07f467b84c77d+ [INFO] Response received: 200 OK+ `,+ want: []string{"sk_pr_mykey_fa02df705055df9e4d159fe3bad0cf3bb8cd1dc2", "sk_pr_mykey2_509b8c07454aca248a0a381b46e07f467b84c77d"},+ },+ {+ name: "invalid pattern",+ input: `+ [INFO] Sending request to the photoroom API+ [DEBUG] Using Key=sk_pr_my_key_fa02df705055df9e4d159fe3bad0cf3bb8cd1dc2+ [ERROR] Response received: 401 UnAuthorized+ `,+ want: []string{},+ },+ }++ for _, test := range tests {+ t.Run(test.name, func(t *testing.T) {+ matchedDetectors := ahoCorasickCore.FindDetectorMatches([]byte(test.input))+ if len(matchedDetectors) == 0 {+ t.Errorf("test %q failed: expected keywords %v to be found in the input", test.name, d.Keywords())+ return+ }++ results, err := d.FromData(context.Background(), false, []byte(test.input))+ require.NoError(t, err)++ if len(results) != len(test.want) {+ t.Errorf("mismatch in result count: expected %d, got %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.goindex df3aa207b..45c03b957 100644--- a/pkg/engine/defaults/defaults.go+++ b/pkg/engine/defaults/defaults.go@@ -547,6 +547,7 @@ import ("github.com/trufflesecurity/trufflehog/v3/pkg/detectors/peopledatalabs""github.com/trufflesecurity/trufflehog/v3/pkg/detectors/pepipost""github.com/trufflesecurity/trufflehog/v3/pkg/detectors/percy"+ "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/photoroom""github.com/trufflesecurity/trufflehog/v3/pkg/detectors/phraseaccesstoken""github.com/trufflesecurity/trufflehog/v3/pkg/detectors/pinata""github.com/trufflesecurity/trufflehog/v3/pkg/detectors/pipedream"@@ -1423,6 +1424,7 @@ func buildDetectorList() []detectors.Detector {&peopledatalabs.Scanner{},&pepipost.Scanner{},&percy.Scanner{},+ &photoroom.Scanner{},&phraseaccesstoken.Scanner{},&pinata.Scanner{},&pipedream.Scanner{},diff --git a/pkg/pb/detectorspb/detectors.pb.go b/pkg/pb/detectorspb/detectors.pb.goindex 8eedc3086..af94bc51a 100644--- a/pkg/pb/detectorspb/detectors.pb.go+++ b/pkg/pb/detectorspb/detectors.pb.go@@ -1144,6 +1144,7 @@ const (DetectorType_Rootly DetectorType = 1035DetectorType_HashiCorpVaultAuth DetectorType = 1036DetectorType_PhraseAccessToken DetectorType = 1037+ DetectorType_Photoroom DetectorType = 1038)// Enum value maps for DetectorType.@@ -2183,6 +2184,7 @@ var (1035: "Rootly",1036: "HashiCorpVaultAuth",1037: "PhraseAccessToken",+ 1038: "Photoroom",}DetectorType_value = map[string]int32{"Alibaba": 0,@@ -3219,6 +3221,7 @@ var ("Rootly": 1035,"HashiCorpVaultAuth": 1036,"PhraseAccessToken": 1037,+ "Photoroom": 1038,})@@ -3672,7 +3675,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, 0xab, 0x86, 0x01, 0x0a, 0x0c, 0x44, 0x65, 0x74, 0x65, 0x63, 0x74, 0x6f, 0x72,+ 0x10, 0x04, 0x2a, 0xbb, 0x86, 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,@@ -4747,6 +4750,7 @@ var file_detectors_proto_rawDesc = []byte{0x12, 0x17, 0x0a, 0x12, 0x48, 0x61, 0x73, 0x68, 0x69, 0x43, 0x6f, 0x72, 0x70, 0x56, 0x61, 0x75,0x6c, 0x74, 0x41, 0x75, 0x74, 0x68, 0x10, 0x8c, 0x08, 0x12, 0x16, 0x0a, 0x11, 0x50, 0x68, 0x72,0x61, 0x73, 0x65, 0x41, 0x63, 0x63, 0x65, 0x73, 0x73, 0x54, 0x6f, 0x6b, 0x65, 0x6e, 0x10, 0x8d,+ 0x08, 0x12, 0x0e, 0x0a, 0x09, 0x50, 0x68, 0x6f, 0x74, 0x6f, 0x72, 0x6f, 0x6f, 0x6d, 0x10, 0x8e,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,diff --git a/proto/detectors.proto b/proto/detectors.protoindex 0b99b96d4..0c1ea05ee 100644--- a/proto/detectors.proto+++ b/proto/detectors.proto@@ -1047,6 +1047,7 @@ enum DetectorType {Rootly = 1035;HashiCorpVaultAuth = 1036;PhraseAccessToken = 1037;+ Photoroom = 1038;}message Result {