bannerbear detector v2 added

Author: shahzadhaider1

pkg/detectors/bannerbear/bannerbear.go renamed to pkg/detectors/bannerbear/v1/bannerbear.go

@@ -16,8 +16,11 @@ import (
 
 type Scanner struct{}
 
+func (s Scanner) Version() int { return 1 }
+
 // Ensure the Scanner satisfies the interface at compile time.
 var _ detectors.Detector = (*Scanner)(nil)
+var _ detectors.Versioner = (*Scanner)(nil)
 
 var (
 	client = common.SaneHttpClient()
@@ -44,6 +47,9 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
 		s1 := detectors.Result{
 			DetectorType: detectorspb.DetectorType_Bannerbear,
 			Raw:          []byte(resMatch),
+			ExtraData: map[string]string{
+				"version": fmt.Sprintf("%d", s.Version()),
+			},
 		}
 
 		if verify {
@@ -77,7 +83,7 @@ func verifyBannerBear(ctx context.Context, client *http.Client, key string) (boo
 
 	resp, err := client.Do(req)
 	if err != nil {
-		return false, nil
+		return false, err
 	}
 
 	defer func() {

pkg/detectors/bannerbear/bannerbear_integration_test.go renamed to pkg/detectors/bannerbear/v1/bannerbear_integration_test.go

@@ -50,6 +50,9 @@ func TestBannerbear_FromChunk(t *testing.T) {
 				{
 					DetectorType: detectorspb.DetectorType_Bannerbear,
 					Verified:     true,
+					ExtraData: map[string]string{
+						"version": fmt.Sprintf("%d", 1),
+					},
 				},
 			},
 			wantErr: false,
@@ -66,6 +69,9 @@ func TestBannerbear_FromChunk(t *testing.T) {
 				{
 					DetectorType: detectorspb.DetectorType_Bannerbear,
 					Verified:     false,
+					ExtraData: map[string]string{
+						"version": fmt.Sprintf("%d", 1),
+					},
 				},
 			},
 			wantErr: false,

pkg/detectors/bannerbear/bannerbear_test.go renamed to pkg/detectors/bannerbear/v1/bannerbear_test.go

@@ -0,0 +1,121 @@
+package bannerbear
+
+import (
+	"bytes"
+	"context"
+	"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"
+)
+
+type Scanner struct{}
+
+func (s Scanner) Version() int { return 2 }
+
+// Ensure the Scanner satisfies the interface at compile time.
+var _ detectors.Detector = (*Scanner)(nil)
+var _ detectors.Versioner = (*Scanner)(nil)
+
+var (
+	client = common.SaneHttpClient()
+
+	// Make sure that your group is surrounded in boundary characters such as below to reduce false positives.
+	keyPat = regexp.MustCompile(`\b(bb_(?:pr|ma)_[a-f0-9]{30})\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{"bannerbear", "bb_pr_", "bb_ma_"}
+}
+
+// FromData will find and optionally verify Bannerbear 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)
+
+	matches := keyPat.FindAllStringSubmatch(dataStr, -1)
+
+	for _, match := range matches {
+		resMatch := strings.TrimSpace(match[1])
+
+		s1 := detectors.Result{
+			DetectorType: detectorspb.DetectorType_Bannerbear,
+			Raw:          []byte(resMatch),
+		}
+
+		if verify {
+			isVerified, extraData, verificationErr := s.verifyBannerBear(ctx, client, resMatch)
+			s1.Verified = isVerified
+			s1.ExtraData = extraData
+			s1.SetVerificationError(verificationErr, resMatch)
+		}
+
+		results = append(results, s1)
+	}
+
+	return results, nil
+}
+
+func (s Scanner) Type() detectorspb.DetectorType {
+	return detectorspb.DetectorType_Bannerbear
+}
+
+func (s Scanner) Description() string {
+	return "Bannerbear is an API for generating dynamic images, videos, and GIFs. Bannerbear API keys can be used to access and manipulate these resources."
+}
+
+// docs: https://developers.bannerbear.com/
+func (s Scanner) verifyBannerBear(ctx context.Context, client *http.Client, key string) (bool, map[string]string, error) {
+	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.bannerbear.com/v2/auth", http.NoBody)
+	if err != nil {
+		return false, nil, err
+	}
+
+	req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", key))
+
+	resp, err := client.Do(req)
+	if err != nil {
+		return false, nil, err
+	}
+
+	defer func() {
+		_, _ = io.Copy(io.Discard, resp.Body)
+		_ = resp.Body.Close()
+	}()
+
+	extraData := map[string]string{"version": fmt.Sprintf("%d", s.Version())}
+
+	switch resp.StatusCode {
+	case http.StatusOK:
+		extraData["key_type"] = "Project API Key"
+		return true, extraData, nil
+	case http.StatusBadRequest:
+		bodyBytes, err := io.ReadAll(resp.Body)
+		if err != nil {
+			return false, extraData, err
+		}
+
+		// According to Bannerbear API docs (https://developers.bannerbear.com/#authentication), the /auth endpoint
+		// expects us to add a project_id parameter to the payload, when using a Full Access Master API Key.
+		// otherwise, it returns a 400 Bad Request with "Error: When using a Master API Key you must set a project_id parameter"
+		// Also, when we use a Master API Key with limited access, it returns a 400 Bad Request with "Error: this Master Key is Limited Access only"
+		validResponse := bytes.Contains(bodyBytes, []byte("When using a Master API Key")) || bytes.Contains(bodyBytes, []byte("Master Key is Limited Access"))
+		if validResponse {
+			extraData["key_type"] = "Master API Key"
+			return true, extraData, nil
+		} else {
+			return false, extraData, fmt.Errorf("bad request: %s, body: %s", resp.Status, string(bodyBytes))
+		}
+	case http.StatusUnauthorized:
+		return false, extraData, nil
+	default:
+		return false, extraData, fmt.Errorf("unexpected status code: %d", resp.StatusCode)
+	}
+}

pkg/detectors/bannerbear/v2/bannerbear.go

@@ -0,0 +1,127 @@
+//go:build detectors
+// +build detectors
+
+package bannerbear
+
+import (
+	"context"
+	"fmt"
+	"testing"
+	"time"
+
+	"github.com/kylelemons/godebug/pretty"
+	"github.com/trufflesecurity/trufflehog/v3/pkg/detectors"
+
+	"github.com/trufflesecurity/trufflehog/v3/pkg/common"
+	"github.com/trufflesecurity/trufflehog/v3/pkg/pb/detectorspb"
+)
+
+func TestBannerbear_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("BANNERBEARV2")
+	inactiveSecret := testSecrets.MustGetField("BANNERBEARV2_INACTIVE")
+
+	type args struct {
+		ctx    context.Context
+		data   []byte
+		verify bool
+	}
+	tests := []struct {
+		name    string
+		s       Scanner
+		args    args
+		want    []detectors.Result
+		wantErr bool
+	}{
+		{
+			name: "found, verified",
+			s:    Scanner{},
+			args: args{
+				ctx:    context.Background(),
+				data:   []byte(fmt.Sprintf("You can find a bannerbear secret %s within", secret)),
+				verify: true,
+			},
+			want: []detectors.Result{
+				{
+					DetectorType: detectorspb.DetectorType_Bannerbear,
+					Verified:     true,
+					ExtraData: map[string]string{
+						"version":  fmt.Sprintf("%d", 2),
+						"key_type": "Project API Key",
+					},
+				},
+			},
+			wantErr: false,
+		},
+		{
+			name: "found, unverified",
+			s:    Scanner{},
+			args: args{
+				ctx:    context.Background(),
+				data:   []byte(fmt.Sprintf("You can find a bannerbear secret %s within but not valid", inactiveSecret)), // the secret would satisfy the regex but not pass validation
+				verify: true,
+			},
+			want: []detectors.Result{
+				{
+					DetectorType: detectorspb.DetectorType_Bannerbear,
+					Verified:     false,
+					ExtraData: map[string]string{
+						"version": fmt.Sprintf("%d", 2),
+					},
+				},
+			},
+			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) {
+			s := Scanner{}
+			got, err := s.FromData(tt.args.ctx, tt.args.verify, tt.args.data)
+			if (err != nil) != tt.wantErr {
+				t.Errorf("Bannerbear.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])
+				}
+				got[i].Raw = nil
+			}
+			if diff := pretty.Compare(got, tt.want); diff != "" {
+				t.Errorf("Bannerbear.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)
+				}
+			}
+		})
+	}
+}

pkg/detectors/bannerbear/v2/bannerbear_integration_test.go

@@ -0,0 +1,81 @@
+package bannerbear
+
+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"
+)
+
+func TestBannerBear_Pattern(t *testing.T) {
+	d := Scanner{}
+	ahoCorasickCore := ahocorasick.NewAhoCorasickCore([]detectors.Detector{d})
+
+	tests := []struct {
+		name  string
+		input string
+		want  []string
+	}{
+		{
+			name:  "valid pattern",
+			input: fmt.Sprintf("bannerbear credentials: bb_pr_abcdc2b40ef44abcd8cbf3739aabcd"),
+			want:  []string{"bb_pr_abcdc2b40ef44abcd8cbf3739aabcd"},
+		},
+		{
+			name:  "valid pattern - complex",
+			input: fmt.Sprintf("bannerbear credentials: ajahf ajkahfkjah fka bb_pr_abcdc2b40ef44abcd8cbf3739aacba adlkajflaihflahdljajfla"),
+			want:  []string{"bb_pr_abcdc2b40ef44abcd8cbf3739aacba"},
+		},
+		{
+			name:  "invalid pattern",
+			input: fmt.Sprintf("bannerbear credentials: bb_abcdc2b40ef44abcd8cbf3739aabcdef1"),
+			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("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)
+			}
+		})
+	}
+}