Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
add support for account api token (#4495)
Mustansirf9dd66072919
diff --git a/pkg/detectors/postmark/postmark.go b/pkg/detectors/postmark/postmark.goindex 333855d12..4848fb123 100644--- a/pkg/detectors/postmark/postmark.go+++ b/pkg/detectors/postmark/postmark.go@@ -2,10 +2,14 @@ package postmarkimport ("context"- regexp "github.com/wasilibs/go-re2"+ "errors"+ "fmt"+ "io""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"@@ -43,20 +47,10 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result}if verify {- req, err := http.NewRequestWithContext(ctx, "GET", "https://api.postmarkapp.com/deliverystats", nil)- if err != nil {- continue- }- req.Header.Add("Accept", "application/json")- req.Header.Add("Content-Type", "application/json")- req.Header.Add("X-Postmark-Server-Token", resMatch)- res, err := client.Do(req)- if err == nil {- defer res.Body.Close()- if res.StatusCode >= 200 && res.StatusCode < 300 {- s1.Verified = true- }- }+ valid, extraData, err := verifyKey(ctx, client, resMatch)+ s1.Verified = valid+ s1.ExtraData = extraData+ s1.SetVerificationError(err)}results = append(results, s1)@@ -65,6 +59,87 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (resultreturn results, nil}+// verifyKey verifies a Postmark key by making requests to the Postmark API.+// It tries both server and account API key verification.+func verifyKey(ctx context.Context, client *http.Client, key string) (bool, map[string]string, error) {+ errs := make([]error, 0, 2)++ // Try verifying as server API key first+ valid, err := verifyServerAPIKey(ctx, client, key)+ if valid {+ // If valid as server API key, return immediately+ return true, map[string]string{"type": "server"}, nil+ }+ if err != nil {+ errs = append(errs, err)+ }++ // Try verifying as account API key next+ valid, err = verifyAccountAPIKey(ctx, client, key)+ if valid {+ // If valid as account API key, return immediately+ return true, map[string]string{"type": "account"}, nil+ }+ if err != nil {+ errs = append(errs, err)+ }+ if len(errs) > 0 {+ // If there were errors during verification, return them+ return false, nil, errors.Join(errs...)+ }+ return false, nil, nil+}++// verifyServerAPIKey verifies a Postmark server API key by making a request to the Postmark API.+func verifyServerAPIKey(ctx context.Context, client *http.Client, key string) (bool, error) {+ return verifyKeyWithOptions(+ ctx,+ client,+ key,+ "/deliverystats",+ "X-Postmark-Server-Token",+ )+}++// verifyAccountAPIKey verifies a Postmark account API key by making a request to the Postmark API.+func verifyAccountAPIKey(ctx context.Context, client *http.Client, key string) (bool, error) {+ return verifyKeyWithOptions(+ ctx,+ client,+ key,+ "/domains?count=10&offset=0",+ "X-Postmark-Account-Token",+ )+}++// verifyKeyWithOptions is a generic function to verify a Postmark key with given endpoint and header.+func verifyKeyWithOptions(ctx context.Context, client *http.Client, key, endpoint, authHeader string) (bool, error) {+ req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://api.postmarkapp.com"+endpoint, nil)+ if err != nil {+ return false, err+ }+ req.Header.Add("Accept", "application/json")+ req.Header.Add("Content-Type", "application/json")+ req.Header.Add(authHeader, key)+ res, err := client.Do(req)+ if err != nil {+ return false, err+ }+ defer func() {+ _, _ = io.Copy(io.Discard, res.Body)+ _ = res.Body.Close()+ }()++ switch res.StatusCode {+ case http.StatusOK:+ return true, nil+ case http.StatusUnauthorized:+ return false, nil+ default:+ return false, fmt.Errorf("unexpected status code: %d", res.StatusCode)+ }+}+func (s Scanner) Type() detectorspb.DetectorType {return detectorspb.DetectorType_Postmark}diff --git a/pkg/detectors/postmark/postmark_integration_test.go b/pkg/detectors/postmark/postmark_integration_test.goindex a9c984c7c..e666222f0 100644--- a/pkg/detectors/postmark/postmark_integration_test.go+++ b/pkg/detectors/postmark/postmark_integration_test.go@@ -23,7 +23,8 @@ func TestPostmark_FromChunk(t *testing.T) {if err != nil {t.Fatalf("could not get test secrets from GCP: %s", err)}- secret := testSecrets.MustGetField("POSTMARK_TOKEN")+ secretServerApi := testSecrets.MustGetField("POSTMARK_TOKEN")+ secretAccountApi := testSecrets.MustGetField("POSTMARK_ACCOUNT_API_TOKEN")inactiveSecret := testSecrets.MustGetField("POSTMARK_INACTIVE")type args struct {@@ -39,17 +40,35 @@ func TestPostmark_FromChunk(t *testing.T) {wantErr bool}{{- name: "found, verified",+ name: "found server api key, verified",s: Scanner{},args: args{ctx: context.Background(),- data: []byte(fmt.Sprintf("You can find a postmark secret %s within", secret)),+ data: []byte(fmt.Sprintf("You can find a postmark secret %s within", secretServerApi)),verify: true,},want: []detectors.Result{{DetectorType: detectorspb.DetectorType_Postmark,Verified: true,+ ExtraData: map[string]string{"type": "server"},+ },+ },+ wantErr: false,+ },+ {+ name: "found account api key, verified",+ s: Scanner{},+ args: args{+ ctx: context.Background(),+ data: []byte(fmt.Sprintf("You can find a postmark secret %s within", secretAccountApi)),+ verify: true,+ },+ want: []detectors.Result{+ {+ DetectorType: detectorspb.DetectorType_Postmark,+ Verified: true,+ ExtraData: map[string]string{"type": "account"},},},wantErr: false,