Skip to content

Commit

Permalink
Detector-Competition-Feat: Added Replicate API token detector (#2021)
Browse files Browse the repository at this point in the history
* Detector-Competition-Feat: Added Replicate API token detector

* fix fullstory

---------

Co-authored-by: Zachary Rice <zachary.rice@trufflesec.com>
  • Loading branch information
fumblehool and zricethezav authored Nov 7, 2023
1 parent bcde785 commit d066a3f
Show file tree
Hide file tree
Showing 6 changed files with 223 additions and 3 deletions.
2 changes: 1 addition & 1 deletion pkg/detectors/fullstory_v2/fullstory_v2.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ type Scanner struct{}
var _ detectors.Detector = (*Scanner)(nil)
var _ detectors.Versioner = (*Scanner)(nil)

func (Scanner) Version() int { return 1 }
func (Scanner) Version() int { return 2 }

var (
client = common.SaneHttpClient()
Expand Down
85 changes: 85 additions & 0 deletions pkg/detectors/replicate/replicate.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
package replicate

import (
"context"
"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()
keyPat = regexp.MustCompile(`\b(r8_[0-9A-Za-z-_]{37})\b`)
)

func (s Scanner) Keywords() []string {
return []string{"replicate", "r8_"}
}

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 {
if len(match) != 2 {
continue
}
resMatch := strings.TrimSpace(match[1])

s1 := detectors.Result{
DetectorType: detectorspb.DetectorType_Replicate,
Raw: []byte(resMatch),
}

if verify {
client := s.client
if client == nil {
client = defaultClient
}
req, err := http.NewRequestWithContext(ctx, "GET", "https://api.replicate.com/v1/predictions", nil)
if err != nil {
continue
}
req.Header.Add("Authorization", fmt.Sprintf("Token %s", resMatch))
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 !s1.Verified && detectors.IsKnownFalsePositive(resMatch, detectors.DefaultFalsePositives, true) {
continue
}

results = append(results, s1)
}

return results, nil
}

func (s Scanner) Type() detectorspb.DetectorType {
return detectorspb.DetectorType_Replicate
}
128 changes: 128 additions & 0 deletions pkg/detectors/replicate/replicate_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
//go:build detectors
// +build detectors

package replicate

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 TestReplicate_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("REPLICATE")
inactiveSecret := testSecrets.MustGetField("REPLICATE_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 replicate secret %s within", secret)),
verify: true,
},
want: []detectors.Result{
{
DetectorType: detectorspb.DetectorType_Replicate,
Verified: true,
},
},
wantErr: false,
wantVerificationErr: false,
},
{
name: "found, unverified",
s: Scanner{},
args: args{
ctx: context.Background(),
data: []byte(fmt.Sprintf("You can find a replicate 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_Replicate,
Verified: false,
},
},
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("Replicate.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("Replicate.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)
}
}
})
}
}
2 changes: 2 additions & 0 deletions pkg/engine/defaults.go
Original file line number Diff line number Diff line change
Expand Up @@ -549,6 +549,7 @@ import (
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/refiner"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/rentman"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/repairshopr"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/replicate"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/replyio"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/requestfinance"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/restpack"
Expand Down Expand Up @@ -1584,6 +1585,7 @@ func DefaultDetectors() []detectors.Detector {
eventbrite.Scanner{},
&overloop.Scanner{},
ngrok.Scanner{},
replicate.Scanner{},
}

}
Expand Down
8 changes: 6 additions & 2 deletions pkg/pb/detectorspb/detectors.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions proto/detectors.proto
Original file line number Diff line number Diff line change
Expand Up @@ -975,6 +975,7 @@ enum DetectorType {
RequestFinance = 964;
Overloop = 965;
Ngrok = 966;
Replicate = 967;
}

message Result {
Expand Down

0 comments on commit d066a3f

Please sign in to comment.