Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
added kraken detector
Valerie Galefaa66ed7ec60
diff --git a/pkg/detectors/kraken/kraken.go b/pkg/detectors/kraken/kraken.gonew file mode 100644index 000000000..f18d2bd32--- /dev/null+++ b/pkg/detectors/kraken/kraken.go@@ -0,0 +1,120 @@+package kraken++import (+ "context"+ "io"+ "time"++ // "log"+ "regexp"+ "strconv"+ "strings"++ "net/http"+ "net/url"++ "crypto/hmac"+ "crypto/sha256"+ "crypto/sha512"+ "encoding/base64"++ "github.com/trufflesecurity/trufflehog/pkg/common"+ "github.com/trufflesecurity/trufflehog/pkg/detectors"+ "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 (+ client = common.SaneHttpClient()++ //Make sure that your group is surrounded in boundry characters such as below to reduce false positives+ //Bounds have been removed because there are some cases that tokens have trailing frontslash(/) or plus sign (+)+ keyPat = regexp.MustCompile(detectors.PrefixRegex([]string{"kraken"}) + `\b([0-9A-Za-z\/\+=]{56}[ "'\r\n]{1})`)+ privKeyPat = regexp.MustCompile(detectors.PrefixRegex([]string{"kraken"}) + `\b([0-9A-Za-z\/\+=]{86,88}[ "'\r\n]{1})`)+)++// 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{"kraken"}+}++// FromData will find and optionally verify Kraken 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 := keyPat.FindAllStringSubmatch(dataStr, -1)+ privKeyMatches := privKeyPat.FindAllStringSubmatch(dataStr, -1)++ for _, match := range matches {+ if len(match) != 2 {+ continue+ }+ resMatch := strings.TrimSpace(match[1])++ for _, privKeyMatch := range privKeyMatches {+ if len(privKeyMatch) != 2 {+ continue+ }+ resPrivKeyMatch := strings.TrimSpace(privKeyMatch[1])++ s1 := detectors.Result{+ DetectorType: detectorspb.DetectorType_Kraken,+ Raw: []byte(resMatch),+ }++ if verify {++ //Increasing 64-bit integer, for each request that is made with a particular API key.+ apiNonce := strconv.FormatInt(time.Now().Unix(), 10)++ payload := url.Values{}+ payload.Add("nonce", apiNonce)++ b64DecodedSecret, _ := base64.StdEncoding.DecodeString(resPrivKeyMatch)+ signature := getKrakenSignature("/0/private/Balance", payload, b64DecodedSecret)++ req, _ := http.NewRequest("POST", "https://api.kraken.com/0/private/Balance", strings.NewReader(payload.Encode()))+ req.Header.Add("Content-Type", "application/x-www-form-urlencoded")+ req.Header.Add("API-Key", resMatch)+ req.Header.Add("API-Sign", signature)++ res, err := client.Do(req)+ if err == nil {+ defer res.Body.Close()+ out, _ := io.ReadAll(res.Body)+ if !strings.Contains(string(out), "Invalid key") {+ s1.Verified = true+ } else {+ // This function will check false positives for common test words, but also it will make sure the key appears 'random' enough to be a real key+ if detectors.IsKnownFalsePositive(resMatch, detectors.DefaultFalsePositives, true) {+ continue+ }+ }+ }+ }++ results = append(results, s1)+ }++ }++ return detectors.CleanResults(results), nil+}++//Code from https://docs.kraken.com/rest/#section/Authentication/Headers-and-Signature+func getKrakenSignature(url_path string, values url.Values, secret []byte) string {++ sha := sha256.New()+ sha.Write([]byte(values.Get("nonce") + values.Encode()))+ shasum := sha.Sum(nil)++ mac := hmac.New(sha512.New, secret)+ mac.Write(append([]byte(url_path), shasum...))+ macsum := mac.Sum(nil)+ return base64.StdEncoding.EncodeToString(macsum)+}diff --git a/pkg/detectors/kraken/kraken_test.go b/pkg/detectors/kraken/kraken_test.gonew file mode 100644index 000000000..a2df32932--- /dev/null+++ b/pkg/detectors/kraken/kraken_test.go@@ -0,0 +1,115 @@+package kraken++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 TestKraken_FromChunk(t *testing.T) {+ ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)+ defer cancel()+ testSecrets, err := common.GetScannersTestSecrets(ctx)+ if err != nil {+ t.Fatalf("could not get test secrets from GCP: %s", err)+ }+ secret := testSecrets.MustGetField("KRAKEN")+ inactiveSecret := testSecrets.MustGetField("KRAKEN_INACTIVE")+ private := testSecrets.MustGetField("KRAKEN_PRIVATE")+ inactivePrivate := testSecrets.MustGetField("KRAKEN_PRIVATE_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 kraken secret %s with kraken private key %s within", secret, private)),+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_Kraken,+ Verified: true,+ },+ },+ wantErr: false,+ },+ {+ name: "found, unverified",+ s: Scanner{},+ args: args{+ ctx: context.Background(),+ data: []byte(fmt.Sprintf("You can find a kraken secret %s with kraken private key %s within but not valid", inactiveSecret, inactivePrivate)), // the secret would satisfy the regex but not pass validation+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_Kraken,+ 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("Kraken.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("Kraken.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)+ }+ })+ }+}