Skip to content

Find, verify, and analyze leaked credentials

[INS-346] SpectralOps Personal API Key Detector (#4770)

Muneeb Ullah Khan2edd4d326abd
diff --git a/pkg/detectors/spectralops/spectralops.go b/pkg/detectors/spectralops/spectralops.go
new file mode 100644
index 000000000..4133a9b8f
--- /dev/null
+++ b/pkg/detectors/spectralops/spectralops.go
@@ -0,0 +1,131 @@
+package spectralops
+
+import (
+ "context"
+ "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/detector_typepb"
+)
+
+type Scanner struct {
+ client *http.Client
+}
+
+// Compile-time interface check
+var _ detectors.Detector = (*Scanner)(nil)
+
+var (
+ defaultClient = common.SaneHttpClient()
+
+ // SpectralOps Personal API keys:
+ // Format: spu- + 32 lowercase aplhabets or digits
+ spectralTokenPat = regexp.MustCompile(
+ `\b(spu-[a-z0-9]{32})\b`,
+ )
+)
+
+// Keywords used for fast pre-filtering
+func (s Scanner) Keywords() []string {
+ return []string{"spu-"}
+}
+
+func (s Scanner) getClient() *http.Client {
+ if s.client != nil {
+ return s.client
+ }
+ return defaultClient
+}
+
+// FromData scans for SpectralOps API tokens and optionally verifies them
+func (s Scanner) FromData(
+ ctx context.Context,
+ verify bool,
+ data []byte,
+) (results []detectors.Result, err error) {
+
+ dataStr := string(data)
+
+ uniqueTokens := make(map[string]struct{})
+ for _, match := range spectralTokenPat.FindAllStringSubmatch(dataStr, -1) {
+ uniqueTokens[match[1]] = struct{}{}
+ }
+
+ for token := range uniqueTokens {
+ result := detectors.Result{
+ DetectorType: detector_typepb.DetectorType_SpectralOps,
+ Raw: []byte(token),
+ SecretParts: map[string]string{
+ "token": token,
+ },
+ }
+
+ if verify {
+ verified, verificationErr := verifySpectralToken(
+ ctx,
+ s.getClient(),
+ token,
+ )
+ result.SetVerificationError(verificationErr, token)
+ result.Verified = verified
+ }
+
+ results = append(results, result)
+ }
+
+ return
+}
+
+func verifySpectralToken(
+ ctx context.Context,
+ client *http.Client,
+ token string,
+) (bool, error) {
+
+ req, err := http.NewRequestWithContext(
+ ctx,
+ http.MethodGet,
+ "https://get.spectralops.io/api/v1/users",
+ http.NoBody,
+ )
+ if err != nil {
+ return false, err
+ }
+
+ req.Header.Set("Authorization", "Bearer "+token)
+
+ 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, http.StatusForbidden:
+ // Token is invalid or revoked
+ return false, nil
+ default:
+ return false, fmt.Errorf(
+ "unexpected HTTP response status %d",
+ res.StatusCode,
+ )
+ }
+}
+
+func (s Scanner) Type() detector_typepb.DetectorType {
+ return detector_typepb.DetectorType_SpectralOps
+}
+
+func (s Scanner) Description() string {
+ return "SpectralOps is a DevSecOps platform for detecting secrets and misconfigurations. Spectral personal API tokens can be used to access and interact with Spectral services and resources."
+}
diff --git a/pkg/detectors/spectralops/spectralops_integration_test.go b/pkg/detectors/spectralops/spectralops_integration_test.go
new file mode 100644
index 000000000..a6608693b
--- /dev/null
+++ b/pkg/detectors/spectralops/spectralops_integration_test.go
@@ -0,0 +1,175 @@
+//go:build detectors
+// +build detectors
+
+package spectralops
+
+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/detector_typepb"
+)
+
+func TestSpectralOps_FromData(t *testing.T) {
+ ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
+ defer cancel()
+
+ // Secrets are expected to be stored similarly to other detector tests
+ testSecrets, err := common.GetSecret(ctx, "trufflehog-testing", "detectors6")
+ if err != nil {
+ t.Fatalf("could not get test secrets from GCP: %s", err)
+ }
+
+ activeToken := testSecrets.MustGetField("SPECTRALOPS_PERSONAL_TOKEN")
+ inactiveToken := "spu-3f10194ca38240ddb880bab79492384b"
+
+ 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: fmt.Appendf([]byte{}, "Using Spectral API token %s for scan", activeToken),
+ verify: true,
+ },
+ want: []detectors.Result{
+ {
+ DetectorType: detector_typepb.DetectorType_SpectralOps,
+ Verified: true,
+ Raw: []byte(activeToken),
+ },
+ },
+ },
+ {
+ name: "found, real token, verification error due to timeout",
+ s: Scanner{client: common.SaneHttpClientTimeOut(1 * time.Microsecond)},
+ args: args{
+ ctx: context.Background(),
+ data: fmt.Appendf([]byte{}, "Using Spectral API token %s for scan", activeToken),
+ verify: true,
+ },
+ want: []detectors.Result{
+ {
+ DetectorType: detector_typepb.DetectorType_SpectralOps,
+ Verified: false,
+ Raw: []byte(activeToken),
+ },
+ },
+ wantVerificationErr: true,
+ },
+ {
+ name: "found, real token, verification error due to unexpected api surface",
+ s: Scanner{client: common.ConstantResponseHttpClient(500, "{}")},
+ args: args{
+ ctx: context.Background(),
+ data: fmt.Appendf([]byte{}, "Using Spectral API token %s for scan", activeToken),
+ verify: true,
+ },
+ want: []detectors.Result{
+ {
+ DetectorType: detector_typepb.DetectorType_SpectralOps,
+ Verified: false,
+ Raw: []byte(activeToken),
+ },
+ },
+ wantVerificationErr: true,
+ },
+ {
+ name: "found, unverified (inactive token)",
+ s: Scanner{},
+ args: args{
+ ctx: context.Background(),
+ data: fmt.Appendf([]byte{}, "Using Spectral API token %s for scan", inactiveToken),
+ verify: true,
+ },
+ want: []detectors.Result{
+ {
+ DetectorType: detector_typepb.DetectorType_SpectralOps,
+ Verified: false,
+ Raw: []byte(inactiveToken),
+ },
+ },
+ },
+ {
+ name: "not found",
+ s: Scanner{},
+ args: args{
+ ctx: context.Background(),
+ data: []byte("no secrets here"),
+ verify: true,
+ },
+ want: nil,
+ },
+ }
+
+ 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.Fatalf("SpectralOps.FromData() error = %v, wantErr %v", err, tt.wantErr)
+ }
+
+ for i := range got {
+ if len(got[i].Raw) == 0 {
+ t.Fatal("no raw secret present")
+ }
+ if (got[i].VerificationError() != nil) != tt.wantVerificationErr {
+ t.Fatalf(
+ "wantVerificationError = %v, verification error = %v",
+ tt.wantVerificationErr,
+ got[i].VerificationError(),
+ )
+ }
+ }
+
+ ignoreOpts := cmpopts.IgnoreFields(
+ detectors.Result{},
+ "ExtraData",
+ "verificationError",
+ "primarySecret",
+ "SecretParts",
+ )
+
+ if diff := cmp.Diff(got, tt.want, ignoreOpts); diff != "" {
+ t.Errorf("SpectralOps.FromData() %s diff: (-got +want)\n%s", tt.name, diff)
+ }
+ })
+ }
+}
+
+func BenchmarkSpectralOps_FromData(b *testing.B) {
+ ctx := context.Background()
+ s := Scanner{}
+
+ for name, data := range detectors.MustGetBenchmarkData() {
+ b.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/spectralops/spectralops_test.go b/pkg/detectors/spectralops/spectralops_test.go
new file mode 100644
index 000000000..1701fb227
--- /dev/null
+++ b/pkg/detectors/spectralops/spectralops_test.go
@@ -0,0 +1,128 @@
+package spectralops
+
+import (
+ "context"
+ "testing"
+
+ "github.com/google/go-cmp/cmp"
+ "github.com/stretchr/testify/require"
+
+ "github.com/trufflesecurity/trufflehog/v3/pkg/detectors"
+ "github.com/trufflesecurity/trufflehog/v3/pkg/engine/ahocorasick"
+)
+
+func TestSpectralOps_Pattern(t *testing.T) {
+ d := Scanner{}
+ ahoCorasickCore := ahocorasick.NewAhoCorasickCore([]detectors.Detector{d})
+
+ tests := []struct {
+ name string
+ input string
+ want []string
+ }{
+ {
+ name: "valid pattern - basic",
+ input: `
+ [INFO] Running spectral scan
+ [DEBUG] Using token spu-3f10194ca38240ddb880bab79492384b
+ [INFO] Scan complete
+ `,
+ want: []string{
+ "spu-3f10194ca38240ddb880bab79492384b",
+ },
+ },
+ {
+ name: "valid pattern - with keyword spectral nearby",
+ input: `
+ [INFO] spectral initialized
+ [DEBUG] SPECTRAL_API_KEY=spu-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
+ `,
+ want: []string{
+ "spu-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+ },
+ },
+ {
+ name: "valid pattern - multiple tokens",
+ input: `
+ spu-11111111111111111111111111111111
+ spu-22222222222222222222222222222222
+ `,
+ want: []string{
+ "spu-11111111111111111111111111111111",
+ "spu-22222222222222222222222222222222",
+ },
+ },
+ {
+ name: "invalid pattern - uppercase characters",
+ input: `
+ [DEBUG] token=spu-3F10194CA38240DDB880BAB79492384B
+ `,
+ want: nil,
+ },
+ {
+ name: "invalid pattern - too short",
+ input: `
+ [DEBUG] token=spu-1234
+ `,
+ want: nil,
+ },
+ {
+ name: "invalid pattern - invalid token length",
+ input: `
+ [DEBUG] token=spu-3f10194ca38240ddb880bab79492384badwad
+ `,
+ want: nil,
+ },
+ {
+ name: "invalid pattern - keyword only",
+ input: `
+ [INFO] spectral scan started spu-
+ `,
+ want: nil,
+ },
+ }
+
+ for _, test := range tests {
+ t.Run(test.name, func(t *testing.T) {
+ matchedDetectors := ahoCorasickCore.FindDetectorMatches([]byte(test.input))
+ if len(matchedDetectors) == 0 {
+ t.Errorf(
+ "test %q failed: expected keywords %v to be found in the input",
+ test.name,
+ d.Keywords(),
+ )
+ return
+ }
+
+ results, err := d.FromData(context.Background(), false, []byte(test.input))
+ require.NoError(t, err)
+
+ if len(results) != len(test.want) {
+ t.Errorf(
+ "mismatch in result count: expected %d, got %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 a1e2fab37..93b7a2d2d 100644
--- a/pkg/engine/defaults/defaults.go
+++ b/pkg/engine/defaults/defaults.go
@@ -706,6 +706,7 @@ import (
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/sonarcloud"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/sourcegraph"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/sourcegraphcody"
+ "github.com/trufflesecurity/trufflehog/v3/pkg/detectors/spectralops"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/speechtextai"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/splunkobservabilitytoken"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/spoonacular"
@@ -1599,6 +1600,7 @@ func buildDetectorList() []detectors.Detector {
&sourcegraph.Scanner{},
&sourcegraphcody.Scanner{},
// &sparkpost.Scanner{},
+ &spectralops.Scanner{},
&speechtextai.Scanner{},
&splunkobservabilitytoken.Scanner{},
&spoonacular.Scanner{},
diff --git a/pkg/pb/detector_typepb/detector_type.pb.go b/pkg/pb/detector_typepb/detector_type.pb.go
index 6f702e426..25a829693 100644
--- a/pkg/pb/detector_typepb/detector_type.pb.go
+++ b/pkg/pb/detector_typepb/detector_type.pb.go
@@ -1104,6 +1104,7 @@ const (
DetectorType_Cloudinary DetectorType = 1048
DetectorType_Pinecone DetectorType = 1049
DetectorType_GitLabOauth2 DetectorType = 1050
+ DetectorType_SpectralOps DetectorType = 1051
)
// Enum value maps for DetectorType.
@@ -2156,6 +2157,7 @@ var (
1048: "Cloudinary",
1049: "Pinecone",
1050: "GitLabOauth2",
+ 1051: "SpectralOps",
}
DetectorType_value = map[string]int32{
"Alibaba": 0,
@@ -3205,6 +3207,7 @@ var (
"Cloudinary": 1048,
"Pinecone": 1049,
"GitLabOauth2": 1050,
+ "SpectralOps": 1051,
}
)
@@ -3240,7 +3243,7 @@ var File_detector_type_proto protoreflect.FileDescriptor
var file_detector_type_proto_rawDesc = []byte{
0x0a, 0x13, 0x64, 0x65, 0x74, 0x65, 0x63, 0x74, 0x6f, 0x72, 0x5f, 0x74, 0x79, 0x70, 0x65, 0x2e,
0x70, 0x72, 0x6f, 0x74, 0x6f, 0x12, 0x0d, 0x64, 0x65, 0x74, 0x65, 0x63, 0x74, 0x6f, 0x72, 0x5f,
- 0x74, 0x79, 0x70, 0x65, 0x2a, 0xbf, 0x88, 0x01, 0x0a, 0x0c, 0x44, 0x65, 0x74, 0x65, 0x63, 0x74,
+ 0x74, 0x79, 0x70, 0x65, 0x2a, 0xd1, 0x88, 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,
@@ -4332,12 +4335,13 @@ var file_detector_type_proto_rawDesc = []byte{
0x72, 0x10, 0x97, 0x08, 0x12, 0x0f, 0x0a, 0x0a, 0x43, 0x6c, 0x6f, 0x75, 0x64, 0x69, 0x6e, 0x61,
0x72, 0x79, 0x10, 0x98, 0x08, 0x12, 0x0d, 0x0a, 0x08, 0x50, 0x69, 0x6e, 0x65, 0x63, 0x6f, 0x6e,
0x65, 0x10, 0x99, 0x08, 0x12, 0x11, 0x0a, 0x0c, 0x47, 0x69, 0x74, 0x4c, 0x61, 0x62, 0x4f, 0x61,
- 0x75, 0x74, 0x68, 0x32, 0x10, 0x9a, 0x08, 0x42, 0x41, 0x5a, 0x3f, 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, 0x5f, 0x74, 0x79, 0x70, 0x65, 0x70, 0x62, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74,
- 0x6f, 0x33,
+ 0x75, 0x74, 0x68, 0x32, 0x10, 0x9a, 0x08, 0x12, 0x10, 0x0a, 0x0b, 0x53, 0x70, 0x65, 0x63, 0x74,
+ 0x72, 0x61, 0x6c, 0x4f, 0x70, 0x73, 0x10, 0x9b, 0x08, 0x42, 0x41, 0x5a, 0x3f, 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, 0x5f, 0x74, 0x79, 0x70, 0x65, 0x70, 0x62, 0x62, 0x06, 0x70, 0x72,
+ 0x6f, 0x74, 0x6f, 0x33,
}
var (
diff --git a/proto/detector_type.proto b/proto/detector_type.proto
index 7776a1324..0e82a7238 100644
--- a/proto/detector_type.proto
+++ b/proto/detector_type.proto
@@ -1052,4 +1052,5 @@ enum DetectorType {
Cloudinary = 1048;
Pinecone = 1049;
GitLabOauth2 = 1050;
+ SpectralOps = 1051;
}