Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
Add new detector for Twitch OAuth Access Tokens (#3756)
julia cwiekf726d02330db
diff --git a/pkg/detectors/twitch/twitch.go b/pkg/detectors/twitch/twitch.goindex b31513d1c..8ae73211b 100644--- a/pkg/detectors/twitch/twitch.go+++ b/pkg/detectors/twitch/twitch.go@@ -3,12 +3,13 @@ package twitchimport ("context""fmt"- regexp "github.com/wasilibs/go-re2""net/http""net/url""strconv""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"@@ -117,5 +118,5 @@ func (s Scanner) Type() detectorspb.DetectorType {}func (s Scanner) Description() string {- return "Twitch is a live streaming service. Twitch API keys can be used to access and modify data on the Twitch platform."+ return "Twitch is a live streaming service. Twitch client credentials can be used to access and modify data on the Twitch platform."}diff --git a/pkg/detectors/twitchaccesstoken/twitchaccesstoken.go b/pkg/detectors/twitchaccesstoken/twitchaccesstoken.gonew file mode 100644index 000000000..baa8de4a6--- /dev/null+++ b/pkg/detectors/twitchaccesstoken/twitchaccesstoken.go@@ -0,0 +1,102 @@+package twitchaccesstoken++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(`\b([0-9a-z]{30})\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{"twitch"}+}++// FromData will find and optionally verify Twitchaccesstoken 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_TwitchAccessToken,+ Raw: []byte(match),+ }++ if verify {+ client := s.client+ if client == nil {+ client = defaultClient+ }++ isVerified, extraData, verificationErr := verifyMatch(ctx, client, match)+ s1.Verified = isVerified+ s1.ExtraData = extraData+ s1.SetVerificationError(verificationErr, match)+ }++ results = append(results, s1)+ }++ return+}++func verifyMatch(ctx context.Context, client *http.Client, token string) (bool, map[string]string, error) {+ req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://id.twitch.tv/oauth2/validate", nil)+ if err != nil {+ return false, nil, nil+ }++ req.Header.Add("Authorization", fmt.Sprintf("OAuth %s", token))+ res, err := client.Do(req)+ if err != nil {+ return false, nil, err+ }+ defer func() {+ _, _ = io.Copy(io.Discard, res.Body)+ _ = res.Body.Close()+ }()++ switch res.StatusCode {+ case http.StatusOK:+ // If the endpoint returns useful information, we can return it as a map.+ return true, nil, nil+ case http.StatusUnauthorized:+ // The secret is determinately not verified (nothing to do)+ return false, nil, nil+ default:+ return false, nil, fmt.Errorf("unexpected HTTP response status %d", res.StatusCode)+ }+}++func (s Scanner) Type() detectorspb.DetectorType {+ return detectorspb.DetectorType_TwitchAccessToken+}++func (s Scanner) Description() string {+ return "Twitch is a live streaming service. Twitch access tokens can be used to access and modify data on the Twitch platform."+}diff --git a/pkg/detectors/twitchaccesstoken/twitchaccesstoken_integration_test.go b/pkg/detectors/twitchaccesstoken/twitchaccesstoken_integration_test.gonew file mode 100644index 000000000..819d6d985--- /dev/null+++ b/pkg/detectors/twitchaccesstoken/twitchaccesstoken_integration_test.go@@ -0,0 +1,161 @@+//go:build detectors+// +build detectors++package twitchaccesstoken++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 TestTwitchaccesstoken_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)+ }+ secret := testSecrets.MustGetField("TWITCHACCESSTOKEN")+ inactiveSecret := testSecrets.MustGetField("TWITCHACCESSTOKEN_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 twitchaccesstoken secret %s within", secret)),+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_TwitchAccessToken,+ Verified: true,+ },+ },+ wantErr: false,+ wantVerificationErr: false,+ },+ {+ name: "found, unverified",+ s: Scanner{},+ args: args{+ ctx: context.Background(),+ data: []byte(fmt.Sprintf("You can find a twitchaccesstoken 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_TwitchAccessToken,+ 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 twitchaccesstoken secret %s within", secret)),+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_TwitchAccessToken,+ 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 twitchaccesstoken secret %s within", secret)),+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_TwitchAccessToken,+ 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("Twitchaccesstoken.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("Twitchaccesstoken.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/twitchaccesstoken/twitchaccesstoken_test.go b/pkg/detectors/twitchaccesstoken/twitchaccesstoken_test.gonew file mode 100644index 000000000..696d54710--- /dev/null+++ b/pkg/detectors/twitchaccesstoken/twitchaccesstoken_test.go@@ -0,0 +1,88 @@+package twitchaccesstoken++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 TestTwitchaccesstoken_Pattern(t *testing.T) {+ d := Scanner{}+ ahoCorasickCore := ahocorasick.NewAhoCorasickCore([]detectors.Detector{d})+ tests := []struct {+ name string+ input string+ want []string+ }{+ {+ name: "typical pattern",+ input: "twitchaccesstoken_token = 'abc123def456ghi789jkl012mno345'",+ want: []string{"abc123def456ghi789jkl012mno345"},+ },+ {+ name: "env variable pattern",+ input: "'twitch_access_token': 'abc123def456ghi789jkl012mno345'",+ want: []string{"abc123def456ghi789jkl012mno345"},+ },+ {+ name: "get request pattern",+ input: "curl -X GET 'https://id.twitch.tv/oauth2/validate' -H 'Authorization: OAuth xbc123def456ghi789jkl012mno345'",+ want: []string{"xbc123def456ghi789jkl012mno345"},+ },+ {+ name: "finds all matches",+ input: "twitchaccesstoken_token1 = 'z9y8x7w6v5u4t3s2r1q0p9o8n7m6l5' twitchaccesstoken_token2 = '123abc456def789ghi012jkl345mno'",+ want: []string{"z9y8x7w6v5u4t3s2r1q0p9o8n7m6l5", "123abc456def789ghi012jkl345mno"},+ },+ {+ name: "invald pattern",+ input: "twitchaccesstoken_token = '1a2b3c4d'",+ 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.goindex a020f8a7c..75ce9fdd9 100644--- a/pkg/engine/defaults/defaults.go+++ b/pkg/engine/defaults/defaults.go@@ -739,6 +739,7 @@ import ("github.com/trufflesecurity/trufflehog/v3/pkg/detectors/twilio""github.com/trufflesecurity/trufflehog/v3/pkg/detectors/twist""github.com/trufflesecurity/trufflehog/v3/pkg/detectors/twitch"+ "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/twitchaccesstoken"twitterv1 "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/twitter/v1"twitterv2 "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/twitter/v2""github.com/trufflesecurity/trufflehog/v3/pkg/detectors/twitterconsumerkey"@@ -1583,6 +1584,7 @@ func buildDetectorList() []detectors.Detector {&twilio.Scanner{},&twist.Scanner{},&twitch.Scanner{},+ &twitchaccesstoken.Scanner{},&twitterconsumerkey.Scanner{},&twitterv1.Scanner{},&twitterv2.Scanner{},diff --git a/pkg/pb/detectorspb/detectors.pb.go b/pkg/pb/detectorspb/detectors.pb.goindex fad00c669..33d0e1bff 100644--- a/pkg/pb/detectorspb/detectors.pb.go+++ b/pkg/pb/detectorspb/detectors.pb.go@@ -1112,6 +1112,7 @@ const (DetectorType_AzureOpenAI DetectorType = 1007DetectorType_GoDaddy DetectorType = 1008DetectorType_Flexport DetectorType = 1009+ DetectorType_TwitchAccessToken DetectorType = 1010)// Enum value maps for DetectorType.@@ -2123,6 +2124,7 @@ var (1007: "AzureOpenAI",1008: "GoDaddy",1009: "Flexport",+ 1010: "TwitchAccessToken",}DetectorType_value = map[string]int32{"Alibaba": 0,@@ -3131,6 +3133,7 @@ var ("AzureOpenAI": 1007,"GoDaddy": 1008,"Flexport": 1009,+ "TwitchAccessToken": 1010,})@@ -3584,7 +3587,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, 0xfc, 0x80, 0x01, 0x0a, 0x0c, 0x44, 0x65, 0x74, 0x65, 0x63, 0x74, 0x6f, 0x72,+ 0x10, 0x04, 0x2a, 0x94, 0x81, 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,@@ -4616,11 +4619,13 @@ var file_detectors_proto_rawDesc = []byte{0x10, 0xee, 0x07, 0x12, 0x10, 0x0a, 0x0b, 0x41, 0x7a, 0x75, 0x72, 0x65, 0x4f, 0x70, 0x65, 0x6e,0x41, 0x49, 0x10, 0xef, 0x07, 0x12, 0x0c, 0x0a, 0x07, 0x47, 0x6f, 0x44, 0x61, 0x64, 0x64, 0x79,0x10, 0xf0, 0x07, 0x12, 0x0d, 0x0a, 0x08, 0x46, 0x6c, 0x65, 0x78, 0x70, 0x6f, 0x72, 0x74, 0x10,- 0xf1, 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,+ 0xf1, 0x07, 0x12, 0x16, 0x0a, 0x11, 0x54, 0x77, 0x69, 0x74, 0x63, 0x68, 0x41, 0x63, 0x63, 0x65,+ 0x73, 0x73, 0x54, 0x6f, 0x6b, 0x65, 0x6e, 0x10, 0xf2, 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.protoindex 10f290043..0572e9222 100644--- a/proto/detectors.proto+++ b/proto/detectors.proto@@ -1019,6 +1019,7 @@ enum DetectorType {AzureOpenAI = 1007;GoDaddy = 1008;Flexport = 1009;+ TwitchAccessToken = 1010;}message Result {