Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
[analyze] Add Analyzer for Mailgun (#3206)
Abdul Basit57e58123f1ef
diff --git a/pkg/analyzer/analyzers/mailgun/expected_output.json b/pkg/analyzer/analyzers/mailgun/expected_output.jsonnew file mode 100644index 000000000..5ed074c14--- /dev/null+++ b/pkg/analyzer/analyzers/mailgun/expected_output.json@@ -0,0 +1,25 @@+{+ "AnalyzerType": 8,+ "Bindings": [+ {+ "Resource": {+ "Name": "sandbox19e49763d44e498e850589ea7d54bd82.mailgun.org",+ "FullyQualifiedName": "mailgun/6478cb31d026c112819856cd/sandbox19e49763d44e498e850589ea7d54bd82.mailgun.org",+ "Type": "domain",+ "Metadata": {+ "created_at": "Thu, 01 Jun 2023 16:45:37 GMT",+ "is_disabled": false,+ "state": "active",+ "type": "sandbox"+ },+ "Parent": null+ },+ "Permission": {+ "Value": "full_access",+ "Parent": null+ }+ }+ ],+ "UnboundedResources": null,+ "Metadata": null+ }\ No newline at end of filediff --git a/pkg/analyzer/analyzers/mailgun/mailgun.go b/pkg/analyzer/analyzers/mailgun/mailgun.goindex 4ccb7f5e3..62dcabf42 100644--- a/pkg/analyzer/analyzers/mailgun/mailgun.go+++ b/pkg/analyzer/analyzers/mailgun/mailgun.go@@ -1,7 +1,9 @@+//go:generate generate_permissions permissions.yaml permissions.go mailgunpackage mailgunimport ("encoding/json"+ "errors""fmt""net/http""os"@@ -24,14 +26,50 @@ type Analyzer struct {func (Analyzer) Type() analyzerpb.AnalyzerType { return analyzerpb.AnalyzerType_Mailgun }func (a Analyzer) Analyze(_ context.Context, credInfo map[string]string) (*analyzers.AnalyzerResult, error) {- _, err := AnalyzePermissions(a.Cfg, credInfo["key"])+ key, ok := credInfo["key"]+ if !ok {+ return nil, errors.New("key not found in credentialInfo")+ }++ info, err := AnalyzePermissions(a.Cfg, key)if err != nil {return nil, err}- return nil, fmt.Errorf("not implemented")+ return secretInfoToAnalyzerResult(info), nil+}++func secretInfoToAnalyzerResult(info *DomainsJSON) *analyzers.AnalyzerResult {+ if info == nil {+ return nil+ }+ result := analyzers.AnalyzerResult{+ AnalyzerType: analyzerpb.AnalyzerType_Mailgun,+ Bindings: make([]analyzers.Binding, len(info.Items)),+ }++ for idx, domain := range info.Items {+ result.Bindings[idx] = analyzers.Binding{+ Resource: analyzers.Resource{+ Name: domain.URL,+ FullyQualifiedName: "mailgun/" + domain.ID + "/" + domain.URL,+ Type: "domain",+ Metadata: map[string]any{+ "created_at": domain.CreatedAt,+ "type": domain.Type,+ "state": domain.State,+ "is_disabled": domain.IsDisabled,+ },+ },+ Permission: analyzers.Permission{+ Value: PermissionStrings[FullAccess],+ },+ }+ }+ return &result}type Domain struct {+ ID string `json:"id"`URL string `json:"name"`IsDisabled bool `json:"is_disabled"`Type string `json:"type"`diff --git a/pkg/analyzer/analyzers/mailgun/mailgun_test.go b/pkg/analyzer/analyzers/mailgun/mailgun_test.gonew file mode 100644index 000000000..faec9e7a2--- /dev/null+++ b/pkg/analyzer/analyzers/mailgun/mailgun_test.go@@ -0,0 +1,100 @@+package mailgun++import (+ _ "embed"+ "encoding/json"+ "sort"+ "testing"+ "time"++ "github.com/trufflesecurity/trufflehog/v3/pkg/analyzer/analyzers"+ "github.com/trufflesecurity/trufflehog/v3/pkg/analyzer/config"+ "github.com/trufflesecurity/trufflehog/v3/pkg/common"+ "github.com/trufflesecurity/trufflehog/v3/pkg/context"+)++//go:embed expected_output.json+var expectedOutput []byte++func TestAnalyzer_Analyze(t *testing.T) {+ ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)+ defer cancel()+ testSecrets, err := common.GetSecret(ctx, "trufflehog-testing", "detectors5")+ if err != nil {+ t.Fatalf("could not get test secrets from GCP: %s", err)+ }++ tests := []struct {+ name string+ key string+ want string // JSON string+ wantErr bool+ }{+ {+ name: "valid Mailgun key",+ key: testSecrets.MustGetField("NEW_MAILGUN_TOKEN_ACTIVE"),+ want: string(expectedOutput),+ wantErr: false,+ },+ }++ for _, tt := range tests {+ t.Run(tt.name, func(t *testing.T) {+ a := Analyzer{Cfg: &config.Config{}}+ got, err := a.Analyze(ctx, map[string]string{"key": tt.key})+ if (err != nil) != tt.wantErr {+ t.Errorf("Analyzer.Analyze() error = %v, wantErr %v", err, tt.wantErr)+ return+ }++ // bindings need to be in the same order to be comparable+ sortBindings(got.Bindings)++ // Marshal the actual result to JSON+ gotJSON, err := json.Marshal(got)+ if err != nil {+ t.Fatalf("could not marshal got to JSON: %s", err)+ }++ // Parse the expected JSON string+ var wantObj analyzers.AnalyzerResult+ if err := json.Unmarshal([]byte(tt.want), &wantObj); err != nil {+ t.Fatalf("could not unmarshal want JSON string: %s", err)+ }++ // bindings need to be in the same order to be comparable+ sortBindings(wantObj.Bindings)++ // Marshal the expected result to JSON (to normalize)+ wantJSON, err := json.Marshal(wantObj)+ if err != nil {+ t.Fatalf("could not marshal want to JSON: %s", err)+ }++ // Compare the JSON strings+ if string(gotJSON) != string(wantJSON) {+ // Pretty-print both JSON strings for easier comparison+ var gotIndented, wantIndented []byte+ gotIndented, err = json.MarshalIndent(got, "", " ")+ if err != nil {+ t.Fatalf("could not marshal got to indented JSON: %s", err)+ }+ wantIndented, err = json.MarshalIndent(wantObj, "", " ")+ if err != nil {+ t.Fatalf("could not marshal want to indented JSON: %s", err)+ }+ t.Errorf("Analyzer.Analyze() = %s, want %s", gotIndented, wantIndented)+ }+ })+ }+}++// Helper function to sort bindings+func sortBindings(bindings []analyzers.Binding) {+ sort.SliceStable(bindings, func(i, j int) bool {+ if bindings[i].Resource.Name == bindings[j].Resource.Name {+ return bindings[i].Permission.Value < bindings[j].Permission.Value+ }+ return bindings[i].Resource.Name < bindings[j].Resource.Name+ })+}diff --git a/pkg/analyzer/analyzers/mailgun/permissions.go b/pkg/analyzer/analyzers/mailgun/permissions.gonew file mode 100644index 000000000..0c4808f05--- /dev/null+++ b/pkg/analyzer/analyzers/mailgun/permissions.go@@ -0,0 +1,71 @@+// Code generated by go generate; DO NOT EDIT.+package mailgun++import "errors"++type Permission int++const (+ Invalid Permission = iota+ Read Permission = iota+ Write Permission = iota+ FullAccess Permission = iota+)++var (+ PermissionStrings = map[Permission]string{+ Read: "read",+ Write: "write",+ FullAccess: "full_access",+ }++ StringToPermission = map[string]Permission{+ "read": Read,+ "write": Write,+ "full_access": FullAccess,+ }++ PermissionIDs = map[Permission]int{+ Read: 1,+ Write: 2,+ FullAccess: 3,+ }++ IdToPermission = map[int]Permission{+ 1: Read,+ 2: Write,+ 3: FullAccess,+ }+)++// ToString converts a Permission enum to its string representation+func (p Permission) ToString() (string, error) {+ if str, ok := PermissionStrings[p]; ok {+ return str, nil+ }+ return "", errors.New("invalid permission")+}++// ToID converts a Permission enum to its ID+func (p Permission) ToID() (int, error) {+ if id, ok := PermissionIDs[p]; ok {+ return id, nil+ }+ return 0, errors.New("invalid permission")+}++// PermissionFromString converts a string representation to its Permission enum+func PermissionFromString(s string) (Permission, error) {+ if p, ok := StringToPermission[s]; ok {+ return p, nil+ }+ return 0, errors.New("invalid permission string")+}++// PermissionFromID converts an ID to its Permission enum+func PermissionFromID(id int) (Permission, error) {+ if p, ok := IdToPermission[id]; ok {+ return p, nil+ }+ return 0, errors.New("invalid permission ID")+}diff --git a/pkg/analyzer/analyzers/mailgun/permissions.yaml b/pkg/analyzer/analyzers/mailgun/permissions.yamlnew file mode 100644index 000000000..7a87b27d1--- /dev/null+++ b/pkg/analyzer/analyzers/mailgun/permissions.yaml@@ -0,0 +1,4 @@+permissions:+ - read+ - write+ - full_accessdiff --git a/pkg/detectors/mailgun/mailgun.go b/pkg/detectors/mailgun/mailgun.goindex 3d0f9e30a..c6dabde53 100644--- a/pkg/detectors/mailgun/mailgun.go+++ b/pkg/detectors/mailgun/mailgun.go@@ -3,16 +3,17 @@ package mailgunimport ("context""fmt"- regexp "github.com/wasilibs/go-re2""net/http""strings"+ regexp "github.com/wasilibs/go-re2"+"github.com/trufflesecurity/trufflehog/v3/pkg/common""github.com/trufflesecurity/trufflehog/v3/pkg/detectors""github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb")-type Scanner struct{+type Scanner struct {detectors.DefaultMultiPartCredentialProvider}@@ -72,6 +73,7 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (results1.Verified = true}}+ s1.AnalysisInfo = map[string]string{"key": resMatch}}diff --git a/pkg/detectors/mailgun/mailgun_test.go b/pkg/detectors/mailgun/mailgun_test.goindex aaa3d0b05..0b887ce2c 100644--- a/pkg/detectors/mailgun/mailgun_test.go+++ b/pkg/detectors/mailgun/mailgun_test.go@@ -129,6 +129,7 @@ func TestMailgun_FromChunk(t *testing.T) {t.Fatalf("no raw secret present: \n %+v", got[i])}got[i].Raw = nil+ got[i].AnalysisInfo = nil}if diff := pretty.Compare(got, tt.want); diff != "" {t.Errorf("Mailgun.FromData() %s diff: (-got +want)\n%s", tt.name, diff)