Skip to content

Find, verify, and analyze leaked credentials

Added new detector for Twilio APIKey (#3803)

Kashif Khanbd64a8359308
diff --git a/pkg/detectors/twilioapikey/twilioapikey.go b/pkg/detectors/twilioapikey/twilioapikey.go
new file mode 100644
index 000000000..4a73e11d7
--- /dev/null
+++ b/pkg/detectors/twilioapikey/twilioapikey.go
@@ -0,0 +1,135 @@
+package twilioapikey
+
+import (
+ "context"
+ "encoding/json"
+ "fmt"
+ "io"
+ "net/http"
+
+ 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 {
+ detectors.DefaultMultiPartCredentialProvider
+ client *http.Client
+}
+
+// Ensure the Scanner satisfies the interface at compile time.
+var _ detectors.Detector = (*Scanner)(nil)
+
+var (
+ defaultClient = common.SaneHttpClient()
+ apiKeyPat = regexp.MustCompile(`\bSK[a-zA-Z0-9]{32}\b`)
+ secretPat = regexp.MustCompile(`\b[0-9a-zA-Z]{32}\b`)
+)
+
+type serviceResponse struct {
+ Services []struct {
+ FriendlyName string `json:"friendly_name"` // friendly name of a service
+ SID string `json:"sid"` // object id of service
+ AccountSID string `json:"account_sid"` // account sid
+ } `json:"services"`
+}
+
+func (s Scanner) getClient() *http.Client {
+ if s.client != nil {
+ return s.client
+ }
+
+ return defaultClient
+}
+
+// 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{"twilio"}
+}
+
+// FromData will find and optionally verify Twilio 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)
+
+ apiKeyMatches := apiKeyPat.FindAllString(dataStr, -1)
+ secretMatches := secretPat.FindAllString(dataStr, -1)
+
+ for _, apiKey := range apiKeyMatches {
+ for _, secret := range secretMatches {
+ s1 := detectors.Result{
+ DetectorType: detectorspb.DetectorType_Twilio,
+ Raw: []byte(apiKey),
+ RawV2: []byte(apiKey + secret),
+ Redacted: secret,
+ ExtraData: make(map[string]string),
+ }
+
+ if verify {
+ extraData, isVerified, verificationErr := verifyTwilioAPIKey(ctx, s.getClient(), apiKey, secret)
+ s1.Verified = isVerified
+ s1.SetVerificationError(verificationErr)
+
+ for key, value := range extraData {
+ s1.ExtraData[key] = value
+ }
+
+ if s1.Verified {
+ s1.AnalysisInfo = map[string]string{"key": apiKey, "sid": secret}
+ }
+ }
+
+ results = append(results, s1)
+ }
+ }
+
+ return results, nil
+}
+
+func (s Scanner) Type() detectorspb.DetectorType {
+ return detectorspb.DetectorType_TwilioApiKey
+}
+
+func (s Scanner) Description() string {
+ return "Twilio is a cloud communications platform that allows software developers to programmatically make and receive phone calls, send and receive text messages, and perform other communication functions using its web service APIs."
+}
+
+func verifyTwilioAPIKey(ctx context.Context, client *http.Client, apiKey, secret string) (map[string]string, bool, error) {
+ req, err := http.NewRequestWithContext(ctx, "GET", "https://verify.twilio.com/v2/Services", nil)
+ if err != nil {
+ return nil, false, nil
+ }
+
+ req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
+ req.Header.Add("Accept", "*/*")
+ req.SetBasicAuth(apiKey, secret)
+
+ resp, err := client.Do(req)
+ if err != nil {
+ return nil, false, nil
+ }
+ defer func() {
+ _, _ = io.Copy(io.Discard, resp.Body)
+ _ = resp.Body.Close()
+ }()
+
+ switch resp.StatusCode {
+ case http.StatusOK:
+ extraData := make(map[string]string)
+ var serviceResponse serviceResponse
+
+ if err := json.NewDecoder(resp.Body).Decode(&serviceResponse); err == nil && len(serviceResponse.Services) > 0 { // no error in parsing and have at least one service
+ service := serviceResponse.Services[0]
+ extraData["friendly_name"] = service.FriendlyName
+ extraData["account_sid"] = service.AccountSID
+ }
+
+ return extraData, true, nil
+ case http.StatusUnauthorized, http.StatusForbidden:
+ return nil, false, nil
+ default:
+ return nil, false, fmt.Errorf("unexpected HTTP response status %d", resp.StatusCode)
+ }
+}
diff --git a/pkg/detectors/twilioapikey/twilioapikey_integration_test.go b/pkg/detectors/twilioapikey/twilioapikey_integration_test.go
new file mode 100644
index 000000000..0f506bd7d
--- /dev/null
+++ b/pkg/detectors/twilioapikey/twilioapikey_integration_test.go
@@ -0,0 +1,135 @@
+//go:build detectors
+// +build detectors
+
+package twilioapikey
+
+import (
+ "context"
+ "fmt"
+ "testing"
+ "time"
+
+ "github.com/google/go-cmp/cmp"
+ "github.com/google/go-cmp/cmp/cmpopts"
+
+ "github.com/trufflesecurity/trufflehog/v3/pkg/common"
+ "github.com/trufflesecurity/trufflehog/v3/pkg/detectors"
+ "github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb"
+)
+
+func TestTwilioAPIKey_FromChunk(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)
+ }
+
+ secret := testSecrets.MustGetField("TWILLIO_SECRET")
+ secretInactive := testSecrets.MustGetField("TWILLIO_SECRET_INACTIVE")
+ apiKey := testSecrets.MustGetField("TWILLIO_APIKEY")
+
+ type args struct {
+ ctx context.Context
+ data []byte
+ verify bool
+ }
+ tests := []struct {
+ name string
+ s Scanner
+ args args
+ want []detectors.Result
+ wantErr bool
+ wantVerificationErr bool
+ }{
+ {
+ name: "found, verified",
+ s: Scanner{},
+ args: args{
+ ctx: context.Background(),
+ data: []byte(fmt.Sprintf("You can find a twillio secret %s within awsId %s", secret, apiKey)),
+ verify: true,
+ },
+ want: []detectors.Result{
+ {
+ DetectorType: detectorspb.DetectorType_Twilio,
+ Verified: true,
+ Redacted: secret,
+ RawV2: []byte(apiKey + secret),
+ ExtraData: map[string]string{
+ "account_sid": "ACa5b6165773490f33f226d71e7ffacff5",
+ "friendly_name": "MyServiceName",
+ },
+ },
+ },
+ wantErr: false,
+ },
+ {
+ name: "found, not verified",
+ s: Scanner{},
+ args: args{
+ ctx: context.Background(),
+ data: []byte(fmt.Sprintf("You can find a twillio secret %s within awsId %s", secretInactive, apiKey)),
+ verify: true,
+ },
+ want: []detectors.Result{
+ {
+ DetectorType: detectorspb.DetectorType_Twilio,
+ Verified: false,
+ Redacted: secretInactive,
+ RawV2: []byte(apiKey + secretInactive),
+ ExtraData: map[string]string{},
+ },
+ },
+ 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) {
+ got, err := tt.s.FromData(tt.args.ctx, tt.args.verify, tt.args.data)
+ if (err != nil) != tt.wantErr {
+ t.Errorf("Twilio.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])
+ }
+ if (got[i].VerificationError() != nil) != tt.wantVerificationErr {
+ t.Fatalf("wantVerificationError = %v, verification error = %v", tt.wantVerificationErr, got[i].VerificationError())
+ }
+ }
+ ignoreOpts := cmpopts.IgnoreFields(detectors.Result{}, "Raw", "verificationError", "AnalysisInfo")
+ if diff := cmp.Diff(got, tt.want, ignoreOpts); diff != "" {
+ t.Errorf("Twilio.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) {
+ b.ResetTimer()
+ for n := 0; n < b.N; n++ {
+ _, err := s.FromData(ctx, false, data)
+ if err != nil {
+ b.Fatal(err)
+ }
+ }
+ })
+ }
+}
diff --git a/pkg/detectors/twilioapikey/twilioapikey_test.go b/pkg/detectors/twilioapikey/twilioapikey_test.go
new file mode 100644
index 000000000..0af8521ea
--- /dev/null
+++ b/pkg/detectors/twilioapikey/twilioapikey_test.go
@@ -0,0 +1,83 @@
+package twilioapikey
+
+import (
+ "context"
+ "fmt"
+ "testing"
+
+ "github.com/google/go-cmp/cmp"
+
+ "github.com/trufflesecurity/trufflehog/v3/pkg/detectors"
+ "github.com/trufflesecurity/trufflehog/v3/pkg/engine/ahocorasick"
+)
+
+var (
+ validAPIKey = "SKbddcfb88fake8f7c4d9aefake7de1fc5"
+ invalidAPIKey = "SK_bddcfb88fake8f7c4d9aefake7de1fc"
+ validSecret = "k7JXtY3WBtUqthisisfakeZDqVcjZxYI"
+ invalidSecret = "k6JXtY3WBtU$thisisfakeZDqVcjZxYI"
+ keyword = "twilio"
+)
+
+func TestTwilioAPIKey_Pattern(t *testing.T) {
+ d := Scanner{}
+ ahoCorasickCore := ahocorasick.NewAhoCorasickCore([]detectors.Detector{d})
+ tests := []struct {
+ name string
+ input string
+ want []string
+ }{
+ {
+ name: "valid pattern - with keyword twilio",
+ input: fmt.Sprintf("%s token - '%s'\n%s token - '%s'\n", keyword, validAPIKey, keyword, validSecret),
+ want: []string{validAPIKey + validSecret},
+ },
+ {
+ name: "invalid pattern",
+ input: fmt.Sprintf("%s token - '%s'\n%s token - '%s'\n", keyword, invalidAPIKey, keyword, invalidSecret),
+ want: []string{},
+ },
+ }
+
+ for _, test := range tests {
+ t.Run(test.name, func(t *testing.T) {
+ matchedDetectors := ahoCorasickCore.FindDetectorMatches([]byte(test.input))
+ if len(matchedDetectors) == 0 {
+ t.Errorf("keywords '%v' not matched by: %s", d.Keywords(), test.input)
+ return
+ }
+
+ results, err := d.FromData(context.Background(), false, []byte(test.input))
+ if err != nil {
+ t.Errorf("error = %v", err)
+ return
+ }
+
+ if len(results) != len(test.want) {
+ if len(results) == 0 {
+ t.Errorf("did not receive result")
+ } else {
+ t.Errorf("expected %d results, only received %d", len(test.want), len(results))
+ }
+ return
+ }
+
+ actual := make(map[string]struct{}, len(results))
+ for _, r := range results {
+ if len(r.RawV2) > 0 {
+ actual[string(r.RawV2)] = struct{}{}
+ } else {
+ actual[string(r.Raw)] = struct{}{}
+ }
+ }
+ expected := make(map[string]struct{}, len(test.want))
+ for _, v := range test.want {
+ expected[v] = struct{}{}
+ }
+
+ if diff := cmp.Diff(expected, actual); diff != "" {
+ t.Errorf("%s diff: (-want +got)\n%s", test.name, diff)
+ }
+ })
+ }
+}
diff --git a/pkg/engine/defaults/defaults.go b/pkg/engine/defaults/defaults.go
index 75ce9fdd9..e7c265179 100644
--- a/pkg/engine/defaults/defaults.go
+++ b/pkg/engine/defaults/defaults.go
@@ -737,6 +737,7 @@ import (
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/trufflehogenterprise"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/twelvedata"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/twilio"
+ "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/twilioapikey"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/twist"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/twitch"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/twitchaccesstoken"
@@ -1582,6 +1583,7 @@ func buildDetectorList() []detectors.Detector {
&trufflehogenterprise.Scanner{},
&twelvedata.Scanner{},
&twilio.Scanner{},
+ &twilioapikey.Scanner{},
&twist.Scanner{},
&twitch.Scanner{},
&twitchaccesstoken.Scanner{},
diff --git a/pkg/pb/detectorspb/detectors.pb.go b/pkg/pb/detectorspb/detectors.pb.go
index 33d0e1bff..5bda5a012 100644
--- a/pkg/pb/detectorspb/detectors.pb.go
+++ b/pkg/pb/detectorspb/detectors.pb.go
@@ -1113,6 +1113,7 @@ const (
DetectorType_GoDaddy DetectorType = 1008
DetectorType_Flexport DetectorType = 1009
DetectorType_TwitchAccessToken DetectorType = 1010
+ DetectorType_TwilioApiKey DetectorType = 1011
)
// Enum value maps for DetectorType.
@@ -2125,6 +2126,7 @@ var (
1008: "GoDaddy",
1009: "Flexport",
1010: "TwitchAccessToken",
+ 1011: "TwilioApiKey",
}
DetectorType_value = map[string]int32{
"Alibaba": 0,
@@ -3134,6 +3136,7 @@ var (
"GoDaddy": 1008,
"Flexport": 1009,
"TwitchAccessToken": 1010,
+ "TwilioApiKey": 1011,
}
)
@@ -3587,7 +3590,7 @@ var file_detectors_proto_rawDesc = []byte{
0x4c, 0x41, 0x49, 0x4e, 0x10, 0x01, 0x12, 0x0a, 0x0a, 0x06, 0x42, 0x41, 0x53, 0x45, 0x36, 0x34,
0x10, 0x02, 0x12, 0x09, 0x0a, 0x05, 0x55, 0x54, 0x46, 0x31, 0x36, 0x10, 0x03, 0x12, 0x13, 0x0a,
0x0f, 0x45, 0x53, 0x43, 0x41, 0x50, 0x45, 0x44, 0x5f, 0x55, 0x4e, 0x49, 0x43, 0x4f, 0x44, 0x45,
- 0x10, 0x04, 0x2a, 0x94, 0x81, 0x01, 0x0a, 0x0c, 0x44, 0x65, 0x74, 0x65, 0x63, 0x74, 0x6f, 0x72,
+ 0x10, 0x04, 0x2a, 0xa7, 0x81, 0x01, 0x0a, 0x0c, 0x44, 0x65, 0x74, 0x65, 0x63, 0x74, 0x6f, 0x72,
0x54, 0x79, 0x70, 0x65, 0x12, 0x0b, 0x0a, 0x07, 0x41, 0x6c, 0x69, 0x62, 0x61, 0x62, 0x61, 0x10,
0x00, 0x12, 0x08, 0x0a, 0x04, 0x41, 0x4d, 0x51, 0x50, 0x10, 0x01, 0x12, 0x07, 0x0a, 0x03, 0x41,
0x57, 0x53, 0x10, 0x02, 0x12, 0x09, 0x0a, 0x05, 0x41, 0x7a, 0x75, 0x72, 0x65, 0x10, 0x03, 0x12,
@@ -4620,12 +4623,13 @@ var file_detectors_proto_rawDesc = []byte{
0x41, 0x49, 0x10, 0xef, 0x07, 0x12, 0x0c, 0x0a, 0x07, 0x47, 0x6f, 0x44, 0x61, 0x64, 0x64, 0x79,
0x10, 0xf0, 0x07, 0x12, 0x0d, 0x0a, 0x08, 0x46, 0x6c, 0x65, 0x78, 0x70, 0x6f, 0x72, 0x74, 0x10,
0xf1, 0x07, 0x12, 0x16, 0x0a, 0x11, 0x54, 0x77, 0x69, 0x74, 0x63, 0x68, 0x41, 0x63, 0x63, 0x65,
- 0x73, 0x73, 0x54, 0x6f, 0x6b, 0x65, 0x6e, 0x10, 0xf2, 0x07, 0x42, 0x3d, 0x5a, 0x3b, 0x67, 0x69,
- 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x74, 0x72, 0x75, 0x66, 0x66, 0x6c, 0x65,
- 0x73, 0x65, 0x63, 0x75, 0x72, 0x69, 0x74, 0x79, 0x2f, 0x74, 0x72, 0x75, 0x66, 0x66, 0x6c, 0x65,
- 0x68, 0x6f, 0x67, 0x2f, 0x76, 0x33, 0x2f, 0x70, 0x6b, 0x67, 0x2f, 0x70, 0x62, 0x2f, 0x64, 0x65,
- 0x74, 0x65, 0x63, 0x74, 0x6f, 0x72, 0x73, 0x70, 0x62, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f,
- 0x33,
+ 0x73, 0x73, 0x54, 0x6f, 0x6b, 0x65, 0x6e, 0x10, 0xf2, 0x07, 0x12, 0x11, 0x0a, 0x0c, 0x54, 0x77,
+ 0x69, 0x6c, 0x69, 0x6f, 0x41, 0x70, 0x69, 0x4b, 0x65, 0x79, 0x10, 0xf3, 0x07, 0x42, 0x3d, 0x5a,
+ 0x3b, 0x67, 0x69, 0x74, 0x68, 0x75, 0x62, 0x2e, 0x63, 0x6f, 0x6d, 0x2f, 0x74, 0x72, 0x75, 0x66,
+ 0x66, 0x6c, 0x65, 0x73, 0x65, 0x63, 0x75, 0x72, 0x69, 0x74, 0x79, 0x2f, 0x74, 0x72, 0x75, 0x66,
+ 0x66, 0x6c, 0x65, 0x68, 0x6f, 0x67, 0x2f, 0x76, 0x33, 0x2f, 0x70, 0x6b, 0x67, 0x2f, 0x70, 0x62,
+ 0x2f, 0x64, 0x65, 0x74, 0x65, 0x63, 0x74, 0x6f, 0x72, 0x73, 0x70, 0x62, 0x62, 0x06, 0x70, 0x72,
+ 0x6f, 0x74, 0x6f, 0x33,
}
var (
diff --git a/proto/detectors.proto b/proto/detectors.proto
index 0572e9222..0eb3136bd 100644
--- a/proto/detectors.proto
+++ b/proto/detectors.proto
@@ -1020,6 +1020,7 @@ enum DetectorType {
GoDaddy = 1008;
Flexport = 1009;
TwitchAccessToken = 1010;
+ TwilioApiKey = 1011;
}
message Result {