138 lines
4.1 KiB
Go
138 lines
4.1 KiB
Go
package twilioapikey
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"maps"
|
|
"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/detector_typepb"
|
|
)
|
|
|
|
type Scanner struct {
|
|
detectors.DefaultMultiPartCredentialProvider
|
|
client *http.Client
|
|
}
|
|
|
|
// Ensure the Scanner satisfies the interface at compile time.
|
|
var _ detectors.Detector = (*Scanner)(nil)
|
|
|
|
var (
|
|
defaultClient = detectors.NewClientWithDedup(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)
|
|
|
|
uniqueAPIKeys := make(map[string]struct{})
|
|
for _, k := range apiKeyPat.FindAllString(dataStr, -1) {
|
|
uniqueAPIKeys[k] = struct{}{}
|
|
}
|
|
uniqueSecrets := make(map[string]struct{})
|
|
for _, s := range secretPat.FindAllString(dataStr, -1) {
|
|
uniqueSecrets[s] = struct{}{}
|
|
}
|
|
|
|
for apiKey := range uniqueAPIKeys {
|
|
for secret := range uniqueSecrets {
|
|
s1 := detectors.Result{
|
|
DetectorType: detector_typepb.DetectorType_Twilio,
|
|
Raw: []byte(apiKey),
|
|
RawV2: []byte(apiKey + secret),
|
|
Redacted: secret[:5] + "...",
|
|
ExtraData: make(map[string]string),
|
|
SecretParts: map[string]string{"key": apiKey, "sid": secret},
|
|
}
|
|
|
|
if verify {
|
|
extraData, isVerified, verificationErr := verifyTwilioAPIKey(ctx, s.getClient(), apiKey, secret)
|
|
s1.Verified = isVerified
|
|
s1.SetVerificationError(verificationErr)
|
|
|
|
maps.Copy(s1.ExtraData, extraData)
|
|
}
|
|
|
|
results = append(results, s1)
|
|
}
|
|
}
|
|
|
|
return results, nil
|
|
}
|
|
|
|
func (s Scanner) Type() detector_typepb.DetectorType {
|
|
return detector_typepb.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, err
|
|
}
|
|
|
|
req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
|
|
req.Header.Add("Accept", "*/*")
|
|
req.SetBasicAuth(apiKey, secret)
|
|
|
|
resp, err := detectors.DoWithDedup(client, detector_typepb.DetectorType_TwilioApiKey, apiKey+secret, req)
|
|
if err != nil {
|
|
return nil, false, err
|
|
}
|
|
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)
|
|
}
|
|
}
|