From b18f3d95966592d6364c9d11ca4fc42ca91ded23 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Damian=20=C5=9Anie=C5=BCek?= Date: Tue, 29 Apr 2025 09:38:12 +0200 Subject: [PATCH] feat: langfuse support (#4079) * feat: langfuse support * Code review fixes * Add PrefixRegex --------- Co-authored-by: Damian Sniezek --- pkg/detectors/langfuse/langfuse.go | 106 +++++++++++ .../langfuse/langfuse_integration_test.go | 164 ++++++++++++++++++ pkg/detectors/langfuse/langfuse_test.go | 85 +++++++++ pkg/engine/defaults/defaults.go | 2 + pkg/pb/detectorspb/detectors.pb.go | 18 +- proto/detectors.proto | 1 + 6 files changed, 369 insertions(+), 7 deletions(-) create mode 100755 pkg/detectors/langfuse/langfuse.go create mode 100644 pkg/detectors/langfuse/langfuse_integration_test.go create mode 100755 pkg/detectors/langfuse/langfuse_test.go diff --git a/pkg/detectors/langfuse/langfuse.go b/pkg/detectors/langfuse/langfuse.go new file mode 100755 index 000000000..a0067cd48 --- /dev/null +++ b/pkg/detectors/langfuse/langfuse.go @@ -0,0 +1,106 @@ +package langfuse + +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() + publicKey = regexp.MustCompile(detectors.PrefixRegex([]string{"langfuse"}) + `\b(pk-lf-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})\b`) + secretKey = regexp.MustCompile(detectors.PrefixRegex([]string{"langfuse"}) + `\b(sk-lf-[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})\b`) +) + +func (s Scanner) Keywords() []string { + return []string{"pk-lf-", "sk-lf-"} +} + +// FromData will find and optionally verify Langfuse 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) + + publicKeyMatches := make(map[string]struct{}) + for _, match := range publicKey.FindAllStringSubmatch(dataStr, -1) { + publicKeyMatches[match[1]] = struct{}{} + } + + secretKeyMatches := make(map[string]struct{}) + for _, match := range secretKey.FindAllStringSubmatch(dataStr, -1) { + secretKeyMatches[match[1]] = struct{}{} + } + + for pkMatch := range publicKeyMatches { + for skMatch := range secretKeyMatches { + s1 := detectors.Result{ + DetectorType: detectorspb.DetectorType_Langfuse, + Raw: []byte(skMatch), + } + + if verify { + client := s.client + if client == nil { + client = defaultClient + } + + isVerified, verificationErr := verifyMatch(ctx, client, pkMatch, skMatch) + s1.Verified = isVerified + if verificationErr != nil { + s1.SetVerificationError(verificationErr, pkMatch) + } + } + + results = append(results, s1) + } + } + + return results, nil +} + +func verifyMatch(ctx context.Context, client *http.Client, pkMatch string, skMatch string) (bool, error) { + req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://cloud.langfuse.com/api/public/projects", nil) + if err != nil { + return false, err + } + + req.SetBasicAuth(pkMatch, skMatch) + 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.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_Langfuse +} + +func (s Scanner) Description() string { + return "Langfuse is a platform for building and scaling AI applications. Langfuse API keys can be used to access these services." +} diff --git a/pkg/detectors/langfuse/langfuse_integration_test.go b/pkg/detectors/langfuse/langfuse_integration_test.go new file mode 100644 index 000000000..d462b178c --- /dev/null +++ b/pkg/detectors/langfuse/langfuse_integration_test.go @@ -0,0 +1,164 @@ +//go:build detectors +// +build detectors + +package langfuse + +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 TestLangfuse_FromChunk(t *testing.T) { + ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) + defer cancel() + testSecrets, err := common.GetSecret(ctx, "trufflehog-testing", "detectors5") + if err != nil { + t.Fatalf("could not get test secrets from GCP: %s", err) + } + publicKey := testSecrets.MustGetField("LANGFUSE_PUBLIC_KEY") + secretKey := testSecrets.MustGetField("LANGFUSE_SECRET_KEY") + inactivePublicKey := testSecrets.MustGetField("LANGFUSE_INACTIVE_PUBLIC_KEY") + inactiveSecretKey := testSecrets.MustGetField("LANGFUSE_INACTIVE_SECRET_KEY") + + + 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 langfuse public key %s and langfuse secret key %s within", publicKey, secretKey)), + verify: true, + }, + want: []detectors.Result{ + { + DetectorType: detectorspb.DetectorType_Langfuse, + Verified: true, + }, + }, + wantErr: false, + wantVerificationErr: false, + }, + { + name: "found, unverified", + s: Scanner{}, + args: args{ + ctx: context.Background(), + data: []byte(fmt.Sprintf("You can find a langfuse public key %s and langfuse secret key %s within but not valid", inactivePublicKey, inactiveSecretKey)), + verify: true, + }, + want: []detectors.Result{ + { + DetectorType: detectorspb.DetectorType_Langfuse, + 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 langfuse public key %s and langfuse secret key %s within", publicKey, secretKey)), + verify: true, + }, + want: []detectors.Result{ + { + DetectorType: detectorspb.DetectorType_Langfuse, + 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 langfuse public key %s and langfuse secret key %s within", publicKey, secretKey)), + verify: true, + }, + want: []detectors.Result{ + { + DetectorType: detectorspb.DetectorType_Langfuse, + 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("Langfuse.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") + if diff := cmp.Diff(got, tt.want, ignoreOpts); diff != "" { + t.Errorf("Langfuse.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/langfuse/langfuse_test.go b/pkg/detectors/langfuse/langfuse_test.go new file mode 100755 index 000000000..418195f46 --- /dev/null +++ b/pkg/detectors/langfuse/langfuse_test.go @@ -0,0 +1,85 @@ +package langfuse + +import ( + "context" + "github.com/google/go-cmp/cmp" + "github.com/trufflesecurity/trufflehog/v3/pkg/detectors" + "github.com/trufflesecurity/trufflehog/v3/pkg/engine/ahocorasick" + "testing" +) + +func TestLangfuse_Pattern(t *testing.T) { + d := Scanner{} + ahoCorasickCore := ahocorasick.NewAhoCorasickCore([]detectors.Detector{d}) + tests := []struct { + name string + input string + want []string + }{ + { + name: "typical pattern", + input: `langfuse_public_key = pk-lf-00000000-0000-0000-0000-000000000000 + langfuse_secret_key = sk-lf-00000000-0000-0000-0000-000000000000`, + want: []string{"sk-lf-00000000-0000-0000-0000-000000000000"}, + }, + { + name: "finds all matches", + input: `langfuse_public_key1 = pk-lf-00000000-0000-0000-0000-000000000000 + langfuse_secret_key1 = sk-lf-00000000-0000-0000-0000-000000000000 + langfuse_public_key2 = pk-lf-11111111-1111-1111-1111-111111111111 + langfuse_secret_key2 = sk-lf-11111111-1111-1111-1111-111111111111`, + want: []string{"sk-lf-00000000-0000-0000-0000-000000000000", + "sk-lf-11111111-1111-1111-1111-111111111111", + "sk-lf-11111111-1111-1111-1111-111111111111", + "sk-lf-00000000-0000-0000-0000-000000000000"}, + }, + { + name: "invalid pattern", + input: `langfuse_public_key1 = pk-lf-invalid + langfuse_secret_key1 = sk-lf-invalid`, + 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("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 09ba04066..d1edf0bbe 100644 --- a/pkg/engine/defaults/defaults.go +++ b/pkg/engine/defaults/defaults.go @@ -399,6 +399,7 @@ import ( "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/kraken" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/kucoin" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/kylas" + "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/langfuse" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/languagelayer" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/larksuite" "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/larksuiteapikey" @@ -1247,6 +1248,7 @@ func buildDetectorList() []detectors.Detector { &kraken.Scanner{}, &kucoin.Scanner{}, &kylas.Scanner{}, + &langfuse.Scanner{}, &languagelayer.Scanner{}, &larksuite.Scanner{}, &larksuiteapikey.Scanner{}, diff --git a/pkg/pb/detectorspb/detectors.pb.go b/pkg/pb/detectorspb/detectors.pb.go index 073eef97b..1d9c9c8e7 100644 --- a/pkg/pb/detectorspb/detectors.pb.go +++ b/pkg/pb/detectorspb/detectors.pb.go @@ -1125,6 +1125,7 @@ const ( DetectorType_AzureApiManagementRepositoryKey DetectorType = 1018 DetectorType_AzureAPIManagementSubscriptionKey DetectorType = 1019 DetectorType_Harness DetectorType = 1020 + DetectorType_Langfuse DetectorType = 1021 ) // Enum value maps for DetectorType. @@ -2147,6 +2148,7 @@ var ( 1018: "AzureApiManagementRepositoryKey", 1019: "AzureAPIManagementSubscriptionKey", 1020: "Harness", + 1021: "Langfuse", } DetectorType_value = map[string]int32{ "Alibaba": 0, @@ -3166,6 +3168,7 @@ var ( "AzureApiManagementRepositoryKey": 1018, "AzureAPIManagementSubscriptionKey": 1019, "Harness": 1020, + "Langfuse": 1021, } ) @@ -3619,7 +3622,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, 0xa9, 0x83, 0x01, 0x0a, 0x0c, 0x44, 0x65, 0x74, 0x65, 0x63, 0x74, 0x6f, 0x72, + 0x10, 0x04, 0x2a, 0xb8, 0x83, 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, @@ -4669,12 +4672,13 @@ var file_detectors_proto_rawDesc = []byte{ 0x6f, 0x72, 0x79, 0x4b, 0x65, 0x79, 0x10, 0xfa, 0x07, 0x12, 0x26, 0x0a, 0x21, 0x41, 0x7a, 0x75, 0x72, 0x65, 0x41, 0x50, 0x49, 0x4d, 0x61, 0x6e, 0x61, 0x67, 0x65, 0x6d, 0x65, 0x6e, 0x74, 0x53, 0x75, 0x62, 0x73, 0x63, 0x72, 0x69, 0x70, 0x74, 0x69, 0x6f, 0x6e, 0x4b, 0x65, 0x79, 0x10, 0xfb, - 0x07, 0x12, 0x0c, 0x0a, 0x07, 0x48, 0x61, 0x72, 0x6e, 0x65, 0x73, 0x73, 0x10, 0xfc, 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, + 0x07, 0x12, 0x0c, 0x0a, 0x07, 0x48, 0x61, 0x72, 0x6e, 0x65, 0x73, 0x73, 0x10, 0xfc, 0x07, 0x12, + 0x0d, 0x0a, 0x08, 0x4c, 0x61, 0x6e, 0x67, 0x66, 0x75, 0x73, 0x65, 0x10, 0xfd, 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 d7c8ed015..832c6266b 100644 --- a/proto/detectors.proto +++ b/proto/detectors.proto @@ -1030,6 +1030,7 @@ enum DetectorType { AzureApiManagementRepositoryKey = 1018; AzureAPIManagementSubscriptionKey = 1019; Harness = 1020; + Langfuse = 1021; } message Result {