Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
added trelloapikey detector
marlon pamisac3c185f07ed8
diff --git a/pkg/detectors/trelloapikey/trelloapikey.go b/pkg/detectors/trelloapikey/trelloapikey.gonew file mode 100644index 000000000..b39663614--- /dev/null+++ b/pkg/detectors/trelloapikey/trelloapikey.go@@ -0,0 +1,77 @@+package trelloapikey++import (+ "context"+ // "log"+ "net/http"+ "regexp"+ "strings"++ "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()+ tokenPat = regexp.MustCompile(`\b([a-zA-Z-0-9]{64})\b`)+ keyPat = regexp.MustCompile(detectors.PrefixRegex([]string{"trello"}) + `\b([a-zA-Z-0-9]{32})\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{"trello"}+}++// FromData will find and optionally verify TrelloApiKey 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)+ tokenMatches := tokenPat.FindAllStringSubmatch(dataStr, -1)++ for i, match := range matches {+ if i == 0 {+ resMatch := strings.TrimSpace(match[1])+ for _, tokenMatch := range tokenMatches {+ if len(tokenMatch) != 2 {+ continue+ }++ token := strings.TrimSpace(tokenMatch[1])++ s1 := detectors.Result{+ DetectorType: detectorspb.DetectorType_TrelloApiKey,+ Redacted: resMatch,+ Raw: []byte(resMatch),+ }++ if verify {+ req, _ := http.NewRequest("GET", "https://api.trello.com/1/members/me?key="+resMatch+"&token="+token, nil)+ 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+ }+ }+ }+ }+ results = append(results, s1)++ }+ }++ }++ return detectors.CleanResults(results), nil+}diff --git a/pkg/detectors/trelloapikey/trelloapikey_test.go b/pkg/detectors/trelloapikey/trelloapikey_test.gonew file mode 100644index 000000000..2eb55b0bc--- /dev/null+++ b/pkg/detectors/trelloapikey/trelloapikey_test.go@@ -0,0 +1,116 @@+package trelloapikey++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 TestTrelloApiKey_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("TRELLOAPIKEY_TOKEN")+ apiKey := testSecrets.MustGetField("TRELLO_API_KEY")+ inactiveApiKey := testSecrets.MustGetField("TRELLO_API_KEY_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 trello secret within https://api.trello.com/1/members/me?key=%s&token=%s", apiKey, token)),+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_TrelloApiKey,+ Redacted: apiKey,+ Verified: true,+ },+ },+ wantErr: false,+ },+ {+ name: "found, unverified",+ s: Scanner{},+ args: args{+ ctx: context.Background(),+ data: []byte(fmt.Sprintf("You can find a trello secret within https://api.trello.com/1/members/me?key=%s&token=%s but unverified", inactiveApiKey, token)),+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_TrelloApiKey,+ Redacted: "6abe2cb200b2edy1666avq5325476dfp",+ 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("TrelloApiKey.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("TrelloApiKey.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)+ }+ })+ }+}