Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
added auth0managementapitoken detector
Jonee Ryan Ty0d120d9940ba
diff --git a/pkg/detectors/auth0managementapitoken/auth0managementapitoken.go b/pkg/detectors/auth0managementapitoken/auth0managementapitoken.gonew file mode 100644index 000000000..f892aaebf--- /dev/null+++ b/pkg/detectors/auth0managementapitoken/auth0managementapitoken.go@@ -0,0 +1,91 @@+package auth0managementapitoken++import (+ "context"+ "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()++ // long jwt token but note this is default 8640000 seconds = 24 hours but could be set to maximum 2592000 seconds = 720 hours = 30 days+ // at https://manage.auth0.com/dashboard/us/dev-63memjo3/apis/management/explorer+ managementApiTokenPat = regexp.MustCompile(detectors.PrefixRegex([]string{"auth0"}) + `\b(ey[a-zA-Z0-9._-]+)\b`)+ domainPat = regexp.MustCompile(`([a-zA-Z0-9\-]{2,16}\.[a-zA-Z0-9_-]{2,3}\.auth0.com)`) // could be part of url+)++// 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{"auth0"}+}++// FromData will find and optionally verify Auth0ManagementApiToken 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)++ managementApiTokenMatches := managementApiTokenPat.FindAllStringSubmatch(dataStr, -1)+ domainMatches := domainPat.FindAllStringSubmatch(dataStr, -1)++ for _, managementApiTokenMatch := range managementApiTokenMatches {+ if len(managementApiTokenMatch) != 2 {+ continue+ }+ managementApiTokenRes := strings.TrimSpace(managementApiTokenMatch[1])+ if len(managementApiTokenRes) < 2000 || len(managementApiTokenRes) > 5000 {+ continue+ }++ for _, domainMatch := range domainMatches {+ if len(domainMatch) != 2 {+ continue+ }+ domainRes := strings.TrimSpace(domainMatch[1])++ s1 := detectors.Result{+ DetectorType: detectorspb.DetectorType_Auth0ManagementApiToken,+ Redacted: domainRes,+ Raw: []byte(managementApiTokenRes),+ }++ if verify {+ /*+ curl -H "Authorization: Bearer $token" https://domain/api/v2/users+ */++ req, _ := http.NewRequest("GET", "https://"+domainRes+"/api/v2/users", nil)+ req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", managementApiTokenRes))+ 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(managementApiTokenRes, detectors.DefaultFalsePositives, true) {+ continue+ }+ }+ }+ }++ results = append(results, s1)+ }+ }++ return detectors.CleanResults(results), nil+}diff --git a/pkg/detectors/auth0managementapitoken/auth0managementapitoken_test.go b/pkg/detectors/auth0managementapitoken/auth0managementapitoken_test.gonew file mode 100644index 000000000..97586c913--- /dev/null+++ b/pkg/detectors/auth0managementapitoken/auth0managementapitoken_test.go@@ -0,0 +1,118 @@+package auth0managementapitoken++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 TestAuth0ManagementApiToken_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)+ }++ // use 2592000 for 30 days, this is the maximum allowed+ managementApiToken := testSecrets.MustGetField("AUTH0_MANAGEMENT_APITOKEN")+ inactiveManagementApiToken := testSecrets.MustGetField("AUTH0_MANAGEMENT_APITOKEN_INACTIVE")+ domain := testSecrets.MustGetField("AUTH0_MANAGEMENT_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 auth0 secret %s domain %s", managementApiToken, domain)),+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_Auth0ManagementApiToken,+ Redacted: domain,+ Verified: true,+ },+ },+ wantErr: false,+ },+ {+ name: "found, unverified",+ s: Scanner{},+ args: args{+ ctx: context.Background(),+ data: []byte(fmt.Sprintf("You can find a auth0 secret %s domain https://%s/oauth/token within but not valid", inactiveManagementApiToken, domain)), // the secret would satisfy the regex but not pass validation+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_Auth0ManagementApiToken,+ Redacted: domain,+ 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("Auth0ManagementApiToken.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("Auth0ManagementApiToken.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)+ }+ })+ }+}