Skip to content

Find, verify, and analyze leaked credentials

added clickhelp detector

Danee Arquerod7220de3fdf4
diff --git a/pkg/detectors/clickhelp/clickhelp.go b/pkg/detectors/clickhelp/clickhelp.go
new file mode 100644
index 000000000..65880dc40
--- /dev/null
+++ b/pkg/detectors/clickhelp/clickhelp.go
@@ -0,0 +1,95 @@
+package clickhelp
+
+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
+ serverPat = regexp.MustCompile(`\b([0-9A-Za-z]{3,20}.try.clickhelp.co)\b`)
+ emailPat = regexp.MustCompile(`\b([a-zA-Z0-9._-]+@[a-zA-Z0-9._-]+\.[a-z]+)\b`)
+ keyPat = regexp.MustCompile(detectors.PrefixRegex([]string{"clickhelp"}) + `\b([0-9A-Za-z]{24})\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{"clickhelp"}
+}
+
+// FromData will find and optionally verify Clickhelp 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)
+
+ serverMatches := serverPat.FindAllStringSubmatch(dataStr, -1)
+ emailMatches := emailPat.FindAllStringSubmatch(dataStr, -1)
+ keyMatches := keyPat.FindAllStringSubmatch(dataStr, -1)
+
+ for _, match := range serverMatches {
+ if len(match) != 2 {
+ continue
+ }
+ resServer := strings.TrimSpace(match[1])
+
+ for _, emailMatch := range emailMatches {
+ if len(emailMatch) != 2 {
+ continue
+ }
+ resEmail := strings.TrimSpace(emailMatch[1])
+ for _, keyMatch := range keyMatches {
+ if len(keyMatch) != 2 {
+ continue
+ }
+ resKey := strings.TrimSpace(keyMatch[1])
+
+ s1 := detectors.Result{
+ DetectorType: detectorspb.DetectorType_ClickHelp,
+ Raw: []byte(resServer),
+ }
+
+ if verify {
+ data := fmt.Sprintf("%s:%s", resEmail, resKey)
+ sEnc := b64.StdEncoding.EncodeToString([]byte(data))
+ req, _ := http.NewRequest("GET", fmt.Sprintf("https://%s/api/v1/projects", resServer), nil)
+ req.Header.Add("Content-Type", "application/json")
+ 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
+ } 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(resServer, detectors.DefaultFalsePositives, true) {
+ continue
+ }
+ }
+ }
+ }
+
+ results = append(results, s1)
+ }
+ }
+ }
+
+ return detectors.CleanResults(results), nil
+}
diff --git a/pkg/detectors/clickhelp/clickhelp_test.go b/pkg/detectors/clickhelp/clickhelp_test.go
new file mode 100644
index 000000000..6eb6ceec5
--- /dev/null
+++ b/pkg/detectors/clickhelp/clickhelp_test.go
@@ -0,0 +1,115 @@
+package clickhelp
+
+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 TestClickhelp_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)
+ }
+ email := testSecrets.MustGetField("SCANNERS_EMAIL")
+ server := testSecrets.MustGetField("CLICKHELP_SERVER")
+ key := testSecrets.MustGetField("CLICKHELP")
+ inactiveKey := testSecrets.MustGetField("CLICKHELP_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 clickhelp secret %s within clickhelp email %s and clickhelp server %s", key, email, server)),
+ verify: true,
+ },
+ want: []detectors.Result{
+ {
+ DetectorType: detectorspb.DetectorType_ClickHelp,
+ Verified: true,
+ },
+ },
+ wantErr: false,
+ },
+ {
+ name: "found, unverified",
+ s: Scanner{},
+ args: args{
+ ctx: context.Background(),
+ data: []byte(fmt.Sprintf("You can find a clickhelp secret %s within clickhelp email %s and clickhelp server %s but not valid", inactiveKey, email, server)), // the secret would satisfy the regex but not pass validation
+ verify: true,
+ },
+ want: []detectors.Result{
+ {
+ DetectorType: detectorspb.DetectorType_ClickHelp,
+ 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("Clickhelp.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("Clickhelp.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)
+ }
+ })
+ }
+}