Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
added zendeskapi detector
marlon pamisaf070742d60f8
diff --git a/pkg/detectors/zendeskapi/zendeskapi.go b/pkg/detectors/zendeskapi/zendeskapi.gonew file mode 100644index 000000000..47ea3c3a8--- /dev/null+++ b/pkg/detectors/zendeskapi/zendeskapi.go@@ -0,0 +1,96 @@+package zendeskapi++import (+ "context"+ "fmt"++ // "log"+ b64 "encoding/base64"+ "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()++ token = regexp.MustCompile(detectors.PrefixRegex([]string{"zendesk"}) + `([A-Za-z0-9_-]{40})`)+ email = regexp.MustCompile(`\b([a-zA-Z-0-9-]{5,16}\@[a-zA-Z-0-9]{4,16}\.[a-zA-Z-0-9]{3,6})\b`)+ domain = regexp.MustCompile(`\b([a-zA-Z-0-9]{3,16}\.zendesk\.com)\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{"zendesk"}+}++// FromData will find and optionally verify ZendeskApi 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)++ tokens := token.FindAllStringSubmatch(dataStr, -1)+ domains := domain.FindAllStringSubmatch(dataStr, -1)+ emails := email.FindAllStringSubmatch(dataStr, -1)++ for _, token := range tokens {+ if len(token) != 2 {+ continue+ }+ resMatch := strings.TrimSpace(token[1])++ var resDomain string+ for _, domain := range domains {+ if len(domain) != 2 {+ continue+ }+ resDomain = strings.TrimSpace(domain[1])++ for _, email := range emails {+ if len(email) != 2 {+ continue+ }+ resEmail := strings.TrimSpace(email[1])++ if detectors.IsKnownFalsePositive(resMatch, detectors.DefaultFalsePositives, true) {+ continue+ }++ s1 := detectors.Result{+ DetectorType: detectorspb.DetectorType_ZendeskApi,+ Raw: []byte(resMatch),+ }++ if verify {+ data := fmt.Sprintf("%s/token:%s", resEmail, resMatch)+ sEnc := b64.StdEncoding.EncodeToString([]byte(data))+ req, _ := http.NewRequest("GET", "https://"+resDomain+"/api/v2/users.json", nil)+ req.Header.Add("Authorization", fmt.Sprintf("Basic %s", sEnc))+ res, err := client.Do(req)+ if err == nil {+ defer res.Body.Close()+ if res.StatusCode >= 200 && res.StatusCode < 300 {+ s1.Verified = true+ }+ }+ }++ results = append(results, s1)++ }+ }++ }++ return detectors.CleanResults(results), nil+}diff --git a/pkg/detectors/zendeskapi/zendeskapi_test.go b/pkg/detectors/zendeskapi/zendeskapi_test.gonew file mode 100644index 000000000..f79c37843--- /dev/null+++ b/pkg/detectors/zendeskapi/zendeskapi_test.go@@ -0,0 +1,112 @@+package zendeskapi++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 TestZendeskApi_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)+ }+ token := testSecrets.MustGetField("ZENDESKAPI_TOKEN")+ inactiveSecret := testSecrets.MustGetField("ZENDESKAPI_INACTIVE")+ email := testSecrets.MustGetField("ZENDESK_EMAIL")+ domain := testSecrets.MustGetField("ZENDESK_DOMAIN")++ 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 zendesk secret %s within zendesk %s with zendesk %s", token, email, domain)),+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_ZendeskApi,+ Verified: true,+ },+ },+ wantErr: false,+ },+ {+ name: "found, unverified",+ s: Scanner{},+ args: args{+ ctx: context.Background(),+ data: []byte(fmt.Sprintf("You can find a zendeskapi secret %s within zendesk %s but not zendesk %s valid", inactiveSecret, email, domain)), // the secret would satisfy the regex but not pass validation+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_ZendeskApi,+ 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("ZendeskApi.FromData() error = %v, wantErr %v", err, tt.wantErr)+ return+ }+ for i := range got {+ got[i].Raw = nil+ }+ if diff := pretty.Compare(got, tt.want); diff != "" {+ t.Errorf("ZendeskApi.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)+ }+ })+ }+}