Skip to content

Find, verify, and analyze leaked credentials

added spotifykey detector

marlon pamisa816c3bd00111
diff --git a/pkg/detectors/spotifykey/spotifykey.go b/pkg/detectors/spotifykey/spotifykey.go
new file mode 100644
index 000000000..c3dcdb8e0
--- /dev/null
+++ b/pkg/detectors/spotifykey/spotifykey.go
@@ -0,0 +1,75 @@
+package spotifykey
+
+import (
+ "context"
+
+ "regexp"
+ "strings"
+
+ "github.com/trufflesecurity/trufflehog/pkg/detectors"
+
+ "golang.org/x/oauth2/clientcredentials"
+
+ "github.com/trufflesecurity/trufflehog/pkg/pb/detectorspb"
+)
+
+type Scanner struct{}
+
+// Ensure the Scanner satisfies the interface at compile time
+var _ detectors.Detector = (*Scanner)(nil)
+
+var (
+ //Make sure that your group is surrounded in boundry characters such as below to reduce false positives
+ secretPat = regexp.MustCompile(detectors.PrefixRegex([]string{"key", "secret"}) + `\b([A-Za-z0-9]{32})\b`)
+ idPat = regexp.MustCompile(detectors.PrefixRegex([]string{"id"}) + `\b([A-Za-z0-9]{32})\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{"spotify"}
+}
+
+// FromData will find and optionally verify SpotifyKey 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 := secretPat.FindAllStringSubmatch(dataStr, -1)
+ idMatches := idPat.FindAllStringSubmatch(dataStr, -1)
+
+ for _, match := range matches {
+ if len(match) != 2 {
+ continue
+ }
+ resMatch := strings.TrimSpace(match[1])
+ for _, idMatch := range idMatches {
+ if len(idMatch) != 2 {
+ continue
+ }
+ idresMatch := strings.TrimSpace(idMatch[1])
+ s1 := detectors.Result{
+ DetectorType: detectorspb.DetectorType_SpotifyKey,
+ Raw: []byte(resMatch),
+ }
+
+ if verify {
+ config := &clientcredentials.Config{
+ ClientID: idresMatch,
+ ClientSecret: resMatch,
+ TokenURL: "https://accounts.spotify.com/api/token",
+ }
+ token, err := config.Token(context.Background())
+ if err == nil {
+ if token.Type() == "Bearer" {
+ s1.Verified = true
+ }
+ }
+ }
+
+ results = append(results, s1)
+ }
+
+ }
+
+ return detectors.CleanResults(results), nil
+}
diff --git a/pkg/detectors/spotifykey/spotifykey_test.go b/pkg/detectors/spotifykey/spotifykey_test.go
new file mode 100644
index 000000000..dca79f10e
--- /dev/null
+++ b/pkg/detectors/spotifykey/spotifykey_test.go
@@ -0,0 +1,114 @@
+package spotifykey
+
+import (
+ "context"
+ "fmt"
+ "testing"
+ "time"
+
+ "github.com/kylelemons/godebug/pretty"
+ "github.com/trufflesecurity/trufflehog/pkg/detectors"
+
+ "github.com/trufflesecurity/trufflehog/pkg/common"
+ "github.com/trufflesecurity/trufflehog/pkg/pb/detectorspb"
+)
+
+func TestSpotifyKey_FromChunk(t *testing.T) {
+ ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
+ defer cancel()
+ testSecrets, err := common.GetScannersTestSecretsVersion(ctx, 3)
+ if err != nil {
+ t.Fatalf("could not get test secrets from GCP: %s", err)
+ }
+ clientID := testSecrets.MustGetField("SPOTIFY_CLIENTID")
+ clientSecret := testSecrets.MustGetField("SPOTIFY_CLIENT_SECRET")
+ inactiveClientSecret := testSecrets.MustGetField("SPOTIFY_CLIENT_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 spotifyKey secret %s within spotifyId %s", clientSecret, clientID)),
+ verify: true,
+ },
+ want: []detectors.Result{
+ {
+ DetectorType: detectorspb.DetectorType_SpotifyKey,
+ Verified: true,
+ },
+ },
+ wantErr: false,
+ },
+ {
+ name: "found, unverified",
+ s: Scanner{},
+ args: args{
+ ctx: context.Background(),
+ data: []byte(fmt.Sprintf("You can find a spotifyKey secret %s within spotifyId %s but not valid", inactiveClientSecret, clientID)), // the secret would satisfy the regex but not pass validation
+ verify: true,
+ },
+ want: []detectors.Result{
+ {
+ DetectorType: detectorspb.DetectorType_SpotifyKey,
+ 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("SpotifyKey.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("SpotifyKey.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) {
+ for n := 0; n < b.N; n++ {
+ s.FromData(ctx, false, data)
+ }
+ })
+ }
+}