Skip to content

Find, verify, and analyze leaked credentials

Detector-Competition-Feat: Added OpenVPN API Detector (#1940)

Damanpreet Singhb2702b78394a
diff --git a/pkg/detectors/openvpn/openvpn.go b/pkg/detectors/openvpn/openvpn.go
new file mode 100644
index 000000000..7a16304b2
--- /dev/null
+++ b/pkg/detectors/openvpn/openvpn.go
@@ -0,0 +1,109 @@
+package openvpn
+
+import (
+ "context"
+ b64 "encoding/base64"
+ "fmt"
+ "net/http"
+ "regexp"
+ "strings"
+
+ "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 {
+ client *http.Client
+}
+
+// Ensure the Scanner satisfies the interface at compile time.
+var _ detectors.Detector = (*Scanner)(nil)
+
+var (
+ defaultClient = common.SaneHttpClient()
+
+ clientIDPat = regexp.MustCompile(detectors.PrefixRegex([]string{"openvpn"}) + `\b([A-Za-z0-9-]{3,40}\.[A-Za-z0-9-]{3,40})\b`)
+ clientSecretPat = regexp.MustCompile(`\b([a-zA-Z0-9_-]{64,})\b`)
+ domainPat = regexp.MustCompile(`\b(https?://[A-Za-z0-9-]+\.api\.openvpn\.com)\b`)
+
+)
+
+// 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{"openvpn"}
+}
+
+// FromData will find and optionally verify Openvpn 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)
+
+ domainMatches := domainPat.FindAllStringSubmatch(dataStr, -1)
+ clientIdMatches := clientIDPat.FindAllStringSubmatch(dataStr, -1)
+ clientSecretMatches := clientSecretPat.FindAllStringSubmatch(dataStr, -1)
+
+ for _, clientIdMatch := range clientIdMatches {
+ clientIDRes := strings.TrimSpace(clientIdMatch[1])
+ for _, clientSecretMatch := range clientSecretMatches {
+ clientSecretRes := strings.TrimSpace(clientSecretMatch[1])
+ for _, domainMatch := range domainMatches {
+ domainRes := strings.TrimSpace(domainMatch[1])
+
+ s1 := detectors.Result{
+ DetectorType: detectorspb.DetectorType_OpenVpn,
+ Raw: []byte(clientSecretRes),
+ RawV2: []byte(clientIDRes + clientSecretRes),
+ }
+
+ if verify {
+ client := s.client
+ if client == nil {
+ client = defaultClient
+ }
+
+ payload := strings.NewReader("grant_type=client_credentials")
+ // OpenVPN API is in beta, We'll have to update the API endpoint once
+ // Docs: https://openvpn.net/cloud-docs/developer/creating-api-credentials.html
+ req, err := http.NewRequestWithContext(ctx, "POST", domainRes + "/api/beta/oauth/token", payload)
+ if err != nil {
+ continue
+ }
+
+ data := fmt.Sprintf("%s:%s", clientIDRes, clientSecretRes)
+ sEnc := b64.StdEncoding.EncodeToString([]byte(data))
+
+ req.Header.Add("Authorization", fmt.Sprintf("Basic %s", sEnc))
+ req.Header.Add("content-type", "application/x-www-form-urlencoded")
+ res, err := client.Do(req)
+ if err == nil {
+ defer res.Body.Close()
+ if res.StatusCode >= 200 && res.StatusCode < 300 {
+ s1.Verified = true
+ } else if res.StatusCode == 401 {
+ // The secret is determinately not verified (nothing to do)
+ } else {
+ s1.VerificationError = fmt.Errorf("unexpected HTTP response status %d", res.StatusCode)
+ }
+ } else {
+ s1.VerificationError = err
+ }
+ }
+ // This function will check false positives for common test words, but also it will make sure the key appears 'random' enough to be a real key.
+ if detectors.IsKnownFalsePositive(clientSecretRes, detectors.DefaultFalsePositives, true) {
+ continue
+ }
+ results = append(results, s1)
+ }
+ }
+
+
+
+ }
+
+ return results, nil
+}
+
+func (s Scanner) Type() detectorspb.DetectorType {
+ return detectorspb.DetectorType_OpenVpn
+}
diff --git a/pkg/detectors/openvpn/openvpn_test.go b/pkg/detectors/openvpn/openvpn_test.go
new file mode 100644
index 000000000..03a3547bb
--- /dev/null
+++ b/pkg/detectors/openvpn/openvpn_test.go
@@ -0,0 +1,133 @@
+//go:build detectors
+// +build detectors
+
+package openvpn
+
+import (
+ "context"
+ "fmt"
+ "testing"
+ "time"
+
+ "github.com/google/go-cmp/cmp"
+ "github.com/google/go-cmp/cmp/cmpopts"
+
+ "github.com/trufflesecurity/trufflehog/v3/pkg/detectors"
+
+ "github.com/trufflesecurity/trufflehog/v3/pkg/common"
+ "github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb"
+)
+
+func TestOpenvpn_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)
+ }
+
+ domain := testSecrets.MustGetField("OPENVPN_DOMAIN")
+ clientId := testSecrets.MustGetField("OPENVPN_CLIENT_ID")
+ clientSecret := testSecrets.MustGetField("OPENVPN_CLIENT_SECRET")
+ inactiveClientSecret := testSecrets.MustGetField("OPENVPN_CLIENT_SECRET_INACTIVE")
+
+ 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 openvpn secret %s openvpn clientId %s and domain %s within", clientSecret, clientId, domain)),
+ verify: true,
+ },
+ want: []detectors.Result{
+ {
+ DetectorType: detectorspb.DetectorType_OpenVpn,
+ Verified: true,
+ RawV2: []byte(clientId + clientSecret),
+ },
+ },
+ wantErr: false,
+ wantVerificationErr: false,
+ },
+ {
+ name: "found, unverified",
+ s: Scanner{},
+ args: args{
+ ctx: context.Background(),
+ data: []byte(fmt.Sprintf("You can find a openvpn secret %s openvpn clientId %s and domain %s within but not valid", inactiveClientSecret, clientId, domain)), // the secret would satisfy the regex but not pass validation
+ verify: true,
+ },
+ want: []detectors.Result{
+ {
+ DetectorType: detectorspb.DetectorType_OpenVpn,
+ Verified: false,
+ RawV2: []byte(clientId + inactiveClientSecret),
+ },
+ },
+ wantErr: false,
+ wantVerificationErr: 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,
+ wantVerificationErr: 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("Openvpn.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")
+ if diff := cmp.Diff(got, tt.want, ignoreOpts); diff != "" {
+ t.Errorf("Openvpn.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/engine/defaults.go b/pkg/engine/defaults.go
index 66c4552fd..32c3bdb63 100644
--- a/pkg/engine/defaults.go
+++ b/pkg/engine/defaults.go
@@ -5,6 +5,7 @@ import (
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/envoyapikey"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/huggingface"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/ip2location"
+ "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/openvpn"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/ramp"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/salesforce"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/snowflake"
@@ -1560,6 +1561,7 @@ func DefaultDetectors() []detectors.Detector {
&sourcegraphcody.Scanner{},
voiceflow.Scanner{},
ip2location.Scanner{},
+ openvpn.Scanner{},
}
}
diff --git a/pkg/pb/detectorspb/detectors.pb.go b/pkg/pb/detectorspb/detectors.pb.go
index 2d1fa897a..9a8f8bfc3 100644
--- a/pkg/pb/detectorspb/detectors.pb.go
+++ b/pkg/pb/detectorspb/detectors.pb.go
@@ -1015,6 +1015,7 @@ const (
DetectorType_Instamojo DetectorType = 941
DetectorType_PortainerToken DetectorType = 942
DetectorType_Loggly DetectorType = 943
+ DetectorType_OpenVpn DetectorType = 944
)
// Enum value maps for DetectorType.
@@ -1960,6 +1961,7 @@ var (
941: "Instamojo",
942: "PortainerToken",
943: "Loggly",
+ 944: "OpenVpn",
}
DetectorType_value = map[string]int32{
"Alibaba": 0,
@@ -2902,6 +2904,7 @@ var (
"Instamojo": 941,
"PortainerToken": 942,
"Loggly": 943,
+ "OpenVpn": 944,
}
)
@@ -3280,7 +3283,7 @@ var file_detectors_proto_rawDesc = []byte{
0x44, 0x65, 0x63, 0x6f, 0x64, 0x65, 0x72, 0x54, 0x79, 0x70, 0x65, 0x12, 0x0b, 0x0a, 0x07, 0x55,
0x4e, 0x4b, 0x4e, 0x4f, 0x57, 0x4e, 0x10, 0x00, 0x12, 0x09, 0x0a, 0x05, 0x50, 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, 0x2a, 0x95, 0x76, 0x0a, 0x0c, 0x44,
+ 0x09, 0x0a, 0x05, 0x55, 0x54, 0x46, 0x31, 0x36, 0x10, 0x03, 0x2a, 0xa3, 0x76, 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,
@@ -4226,11 +4229,12 @@ var file_detectors_proto_rawDesc = []byte{
0x12, 0x0e, 0x0a, 0x09, 0x49, 0x6e, 0x73, 0x74, 0x61, 0x6d, 0x6f, 0x6a, 0x6f, 0x10, 0xad, 0x07,
0x12, 0x13, 0x0a, 0x0e, 0x50, 0x6f, 0x72, 0x74, 0x61, 0x69, 0x6e, 0x65, 0x72, 0x54, 0x6f, 0x6b,
0x65, 0x6e, 0x10, 0xae, 0x07, 0x12, 0x0b, 0x0a, 0x06, 0x4c, 0x6f, 0x67, 0x67, 0x6c, 0x79, 0x10,
- 0xaf, 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,
+ 0xaf, 0x07, 0x12, 0x0c, 0x0a, 0x07, 0x4f, 0x70, 0x65, 0x6e, 0x56, 0x70, 0x6e, 0x10, 0xb0, 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 52926d61f..af644beb9 100644
--- a/proto/detectors.proto
+++ b/proto/detectors.proto
@@ -952,6 +952,7 @@ enum DetectorType {
Instamojo = 941;
PortainerToken = 942;
Loggly = 943;
+ OpenVpn = 944;
}
message Result {