* Populate SecretParts on single-part detectors
Adds SecretParts: map[string]string{"key": <secret>} to every detector
package that constructs detectors.Result with a single captured secret
value. This is the single-part half of the SecretParts migration (the
linter's common case, ~695 packages).
* Populate SecretParts on multi-part detectors
85 lines
2.4 KiB
Go
85 lines
2.4 KiB
Go
package spotifykey
|
|
|
|
import (
|
|
"context"
|
|
"golang.org/x/oauth2"
|
|
|
|
regexp "github.com/wasilibs/go-re2"
|
|
"strings"
|
|
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/common"
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors"
|
|
|
|
"golang.org/x/oauth2/clientcredentials"
|
|
|
|
"github.com/trufflesecurity/trufflehog/v3/pkg/pb/detector_typepb"
|
|
)
|
|
|
|
type Scanner struct {
|
|
detectors.DefaultMultiPartCredentialProvider
|
|
}
|
|
|
|
// Ensure the Scanner satisfies the interface at compile time.
|
|
var _ detectors.Detector = (*Scanner)(nil)
|
|
|
|
var (
|
|
// Make sure that your group is surrounded in boundary 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) {
|
|
ctx = context.WithValue(ctx, oauth2.HTTPClient, common.SaneHttpClient())
|
|
|
|
dataStr := string(data)
|
|
|
|
matches := secretPat.FindAllStringSubmatch(dataStr, -1)
|
|
idMatches := idPat.FindAllStringSubmatch(dataStr, -1)
|
|
|
|
for _, match := range matches {
|
|
resMatch := strings.TrimSpace(match[1])
|
|
for _, idMatch := range idMatches {
|
|
idresMatch := strings.TrimSpace(idMatch[1])
|
|
s1 := detectors.Result{
|
|
DetectorType: detector_typepb.DetectorType_SpotifyKey,
|
|
Raw: []byte(resMatch),
|
|
SecretParts: map[string]string{"key": resMatch},
|
|
}
|
|
|
|
if verify {
|
|
config := &clientcredentials.Config{
|
|
ClientID: idresMatch,
|
|
ClientSecret: resMatch,
|
|
TokenURL: "https://accounts.spotify.com/api/token",
|
|
}
|
|
token, err := config.Token(ctx)
|
|
if err == nil {
|
|
if token.Type() == "Bearer" {
|
|
s1.Verified = true
|
|
}
|
|
}
|
|
}
|
|
|
|
results = append(results, s1)
|
|
}
|
|
|
|
}
|
|
|
|
return results, nil
|
|
}
|
|
|
|
func (s Scanner) Type() detector_typepb.DetectorType {
|
|
return detector_typepb.DetectorType_SpotifyKey
|
|
}
|
|
|
|
func (s Scanner) Description() string {
|
|
return "Spotify API keys can be used to access and modify data within Spotify's services."
|
|
}
|