Skip to content

Find, verify, and analyze leaked credentials

Update Snyk detector (#2559)

Richard Gomez441d9ff00563
diff --git a/pkg/detectors/snykkey/snykkey.go b/pkg/detectors/snykkey/snykkey.go
index 8e1f09ef1..aaaf5ff09 100644
--- a/pkg/detectors/snykkey/snykkey.go
+++ b/pkg/detectors/snykkey/snykkey.go
@@ -2,26 +2,27 @@ package snykkey
import (
"context"
+ "encoding/json"
"fmt"
- regexp "github.com/wasilibs/go-re2"
+ "io"
"net/http"
"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"
)
-type Scanner struct{}
+type Scanner struct {
+ client *http.Client
+}
// Ensure the Scanner satisfies the interface at compile time.
var _ detectors.Detector = (*Scanner)(nil)
-var (
- client = common.SaneHttpClient()
-
- keyPat = regexp.MustCompile(detectors.PrefixRegex([]string{"snyk"}) + `\b([0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12})\b`)
-)
+var keyPat = regexp.MustCompile(detectors.PrefixRegex([]string{"snyk"}) + `\b([0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12})\b`)
// Keywords are used for efficiently pre-filtering chunks.
// Use identifiers in the secret preferably, or the provider name.
@@ -33,36 +34,26 @@ func (s Scanner) Keywords() []string {
func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (results []detectors.Result, err error) {
dataStr := string(data)
- matches := keyPat.FindAllStringSubmatch(dataStr, -1)
-
- for _, match := range matches {
- if len(match) != 2 {
- continue
- }
- resMatch := strings.TrimSpace(match[1])
+ tokens := make(map[string]struct{})
+ for _, match := range keyPat.FindAllStringSubmatch(dataStr, -1) {
+ tokens[match[1]] = struct{}{}
+ }
+ for token := range tokens {
s1 := detectors.Result{
- DetectorType: detectorspb.DetectorType_SnykKey,
- Raw: []byte(resMatch),
+ DetectorType: s.Type(),
+ Raw: []byte(token),
}
if verify {
- req, err := http.NewRequestWithContext(ctx, "GET", "https://snyk.io/api/v1/user/me", nil)
- if err != nil {
- continue
- }
- req.Header.Add("Authorization", fmt.Sprintf("token %s", resMatch))
- res, err := client.Do(req)
- if err == nil {
- defer res.Body.Close()
- if res.StatusCode >= 200 && res.StatusCode < 300 {
- s1.Verified = true
- } else {
- if detectors.IsKnownFalsePositive(resMatch, detectors.DefaultFalsePositives, true) {
- continue
- }
- }
- }
+ isVerified, extraData, verificationErr := s.doVerification(ctx, token)
+ s1.Verified = isVerified
+ s1.ExtraData = extraData
+ s1.SetVerificationError(verificationErr, token)
+ }
+
+ if !s1.Verified && detectors.IsKnownFalsePositive(token, detectors.DefaultFalsePositives, true) {
+ continue
}
results = append(results, s1)
@@ -71,6 +62,70 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
return results, nil
}
+func (s Scanner) doVerification(ctx context.Context, token string) (bool, map[string]string, error) {
+ client := s.client
+ if client == nil {
+ client = common.SaneHttpClient()
+ }
+
+ req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://snyk.io/api/v1/user/me", nil)
+ if err != nil {
+ return false, nil, err
+ }
+
+ req.Header.Add("Authorization", fmt.Sprintf("token %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()
+ }()
+ if res.StatusCode == http.StatusOK {
+ userDetails := userDetailsResponse{}
+ err := json.NewDecoder(res.Body).Decode(&userDetails)
+ if err != nil {
+ return true, nil, err
+ } else if userDetails.Username == "" {
+ return false, nil, fmt.Errorf("failed to decode JSON response")
+ }
+
+ extraData := map[string]string{
+ "Username": userDetails.Username,
+ "Email": userDetails.Email,
+ }
+
+ // Condense a list of organizations
+ if len(userDetails.Organizations) > 0 {
+ var orgs []string
+ for _, org := range userDetails.Organizations {
+ orgs = append(orgs, org.Name)
+ }
+ extraData["Organizations"] = strings.Join(orgs, ",")
+ }
+ return true, extraData, nil
+ } else if res.StatusCode == http.StatusUnauthorized {
+ // The secret is determinately not verified (nothing to do)
+ return false, nil, nil
+ } else {
+ err = fmt.Errorf("unexpected HTTP response status %d", res.StatusCode)
+ return false, nil, err
+ }
+}
+
+// https://snyk.docs.apiary.io/#reference/users/my-user-details/get-my-details
+type userDetailsResponse struct {
+ Username string `json:"username"`
+ Email string `json:"email"`
+ Organizations []organization `json:"orgs"`
+}
+
+type organization struct {
+ Name string `json:"name"`
+}
+
func (s Scanner) Type() detectorspb.DetectorType {
return detectorspb.DetectorType_SnykKey
}
diff --git a/pkg/detectors/snykkey/snykkey_test.go b/pkg/detectors/snykkey/snykkey_test.go
index 215677bb3..43b41efba 100644
--- a/pkg/detectors/snykkey/snykkey_test.go
+++ b/pkg/detectors/snykkey/snykkey_test.go
@@ -9,13 +9,87 @@ import (
"testing"
"time"
+ "github.com/google/go-cmp/cmp"
"github.com/kylelemons/godebug/pretty"
+
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors"
+ "github.com/trufflesecurity/trufflehog/v3/pkg/engine/ahocorasick"
"github.com/trufflesecurity/trufflehog/v3/pkg/common"
"github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb"
)
+func TestSnyk_Pattern(t *testing.T) {
+ d := Scanner{}
+ ahoCorasickCore := ahocorasick.NewAhoCorasickCore([]detectors.Detector{d})
+ tests := []struct {
+ name string
+ input string
+ want []string
+ }{
+ {
+ name: "typical pattern",
+ input: `set NODE_REQUIRED_VERSION=12.13.1
+set SNYK_API_TOKEN=885953dc-2469-443c-983d-5243d2d54116
+
+set PATH=%PATH%;C:\Program Files\nodejs\;C:\Program Files\Git\cmd`,
+ want: []string{"885953dc-2469-443c-983d-5243d2d54116"},
+ },
+ // https://docs.snyk.io/snyk-api/get-a-projects-sbom-document-endpoint#how-to-generate-the-sbom-for-a-project
+ // {
+ // name: "curl example",
+ // `curl --get \
+ //-H "Authorization: token ccc9ae71-913f-46bd-9d23-03356323400a" \
+ //--data-urlencode "version=2023-03-20" \
+ //--data-urlencode "format=cyclonedx1.4%2Bjson" \
+ //https://api.snyk.io/rest/orgs/1234/projects/1234/sbom`,
+ // },
+ }
+
+ for _, test := range tests {
+ t.Run(test.name, func(t *testing.T) {
+ chunkSpecificDetectors := make(map[ahocorasick.DetectorKey]detectors.Detector, 2)
+ ahoCorasickCore.PopulateMatchingDetectors(test.input, chunkSpecificDetectors)
+ if len(chunkSpecificDetectors) == 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)
+ }
+ })
+ }
+}
+
func TestSnykKey_FromChunk(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
defer cancel()
@@ -50,6 +124,11 @@ func TestSnykKey_FromChunk(t *testing.T) {
{
DetectorType: detectorspb.DetectorType_SnykKey,
Verified: true,
+ ExtraData: map[string]string{
+ "Email": "[email protected]",
+ "Organizations": "rendyplayground",
+ "Username": "rendyplayground",
+ },
},
},
wantErr: false,