Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
added tru detector
DANEE ARQUERO426ee321645f
diff --git a/pkg/detectors/tru/tru.go b/pkg/detectors/tru/tru.gonew file mode 100644index 000000000..f6195e103--- /dev/null+++ b/pkg/detectors/tru/tru.go@@ -0,0 +1,86 @@+package tru++import (+ "context"+ b64 "encoding/base64"+ "fmt"++ // "log"+ "regexp"+ "strings"++ "net/http"++ "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+ keyPat = regexp.MustCompile(detectors.PrefixRegex([]string{"tru"}) + `\b([0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12})\b`)+ secrePat = regexp.MustCompile(detectors.PrefixRegex([]string{"tru"}) + `\b([0-9a-zA-Z.-_]{26})\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{"tru"}+}++// FromData will find and optionally verify Tru 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)+ secretMatches := secrePat.FindAllStringSubmatch(dataStr, -1)++ for _, match := range matches {+ if len(match) != 2 {+ continue+ }+ resMatch := strings.TrimSpace(match[1])+ for _, secretMatch := range secretMatches {+ if len(secretMatch) != 2 {+ continue+ }+ resSecret := strings.TrimSpace(secretMatch[1])++ s1 := detectors.Result{+ DetectorType: detectorspb.DetectorType_Tru,+ Raw: []byte(resMatch),+ }++ if verify {+ data := fmt.Sprintf("%s:%s", resMatch, resSecret)+ baseToken := b64.StdEncoding.EncodeToString([]byte(data))+ payload := strings.NewReader("grant_type=client_credentials")+ req, _ := http.NewRequest("POST", "https://eu.api.tru.id/oauth2/v1/token", payload)+ req.Header.Add("Content-Type", "application/x-www-form-urlencoded")+ req.Header.Add("Authorization", fmt.Sprintf("Basic %s", baseToken))+ res, err := client.Do(req)+ if err == nil {+ defer res.Body.Close()+ if res.StatusCode >= 200 && res.StatusCode < 300 {+ 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+}diff --git a/pkg/detectors/tru/tru_test.go b/pkg/detectors/tru/tru_test.gonew file mode 100644index 000000000..be04b152a--- /dev/null+++ b/pkg/detectors/tru/tru_test.go@@ -0,0 +1,114 @@+package tru++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 TestTru_FromChunk(t *testing.T) {+ ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)+ defer cancel()+ testSecrets, err := common.GetScannersTestSecretsVersion(ctx, 2)+ if err != nil {+ t.Fatalf("could not get test secrets from GCP: %s", err)+ }+ id := testSecrets.MustGetField("TRU_ID")+ secret := testSecrets.MustGetField("TRU_SECRET")+ inactiveID := testSecrets.MustGetField("TRU_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 tru secret %s within tru id %s", secret, id)),+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_Tru,+ Verified: true,+ },+ },+ wantErr: false,+ },+ {+ name: "found, unverified",+ s: Scanner{},+ args: args{+ ctx: context.Background(),+ data: []byte(fmt.Sprintf("You can find a tru secret %s within tru id %s but not valid", secret, inactiveID)), // the secret would satisfy the regex but not pass validation+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_Tru,+ 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("Tru.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("Tru.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)+ }+ })+ }+}