Mirrors/trufflehog
2
0
Fork 0
mirror of https://github.com/trufflesecurity/trufflehog.git synced 2024-11-10 07:04:24 +00:00
Code Issues Projects Releases Packages Wiki Activity

Remove onwater detector (#3088)

Browse source
This commit is contained in:
trufflesteeeve 2024-07-22 17:00:32 -04:00 committed by GitHub
parent 5b64e1e5a1
commit c01428d107
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 530 additions and 723 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

72
pkg/detectors/onwaterio/onwaterio.go
View file

@ -1,72 +0,0 @@
package onwaterio
import (
"context"
"fmt"
regexp "github.com/wasilibs/go-re2"
"net/http"
"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{}
// Ensure the Scanner satisfies the interface at compile time.
var _ detectors.Detector = (*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(detectors.PrefixRegex([]string{"onwater"}) + `\b([a-zA-Z0-9_-]{20})\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{"onwater"}
}
// FromData will find and optionally verify OnWaterIO 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 {
if len(match) != 2 {
continue
}
resMatch := strings.TrimSpace(match[1])
s1 := detectors.Result{
DetectorType: detectorspb.DetectorType_OnWaterIO,
Raw: []byte(resMatch),
}
if verify {
req, err := http.NewRequestWithContext(ctx, "GET", fmt.Sprintf("https://api.onwater.io/api/v1/results/23.92323,-66.3?access_token=%s", resMatch), nil)
if err != nil {
continue
}
res, err := client.Do(req)
if err == nil {
defer res.Body.Close()
if res.StatusCode >= 200 && res.StatusCode < 300 {
s1.Verified = true
}
}
}
results = append(results, s1)
}
return results, nil
}
func (s Scanner) Type() detectorspb.DetectorType {
return detectorspb.DetectorType_OnWaterIO
}

120
pkg/detectors/onwaterio/onwaterio_test.go
View file

@ -1,120 +0,0 @@
//go:build detectors
// +build detectors
package onwaterio
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 TestOnWaterIO_FromChunk(t *testing.T) {
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
defer cancel()
testSecrets, err := common.GetSecret(ctx, "trufflehog-testing", "detectors1")
if err != nil {
t.Fatalf("could not get test secrets from GCP: %s", err)
}
secret := testSecrets.MustGetField("ONWATERIO")
inactiveSecret := testSecrets.MustGetField("ONWATERIO_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 onwater secret %s within", secret)),
verify: true,
},
want: []detectors.Result{
{
DetectorType: detectorspb.DetectorType_OnWaterIO,
Verified: true,
},
},
wantErr: false,
},
{
name: "found, unverified",
s: Scanner{},
args: args{
ctx: context.Background(),
data: []byte(fmt.Sprintf("You can find a onwater 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_OnWaterIO,
Verified: false,
},
},
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("OnWaterIO.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("OnWaterIO.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
pkg/engine/defaults.go
View file

@ -481,7 +481,6 @@ import (
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/onepagecrm"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/onesignal"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/onfleet"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/onwaterio"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/oopspam"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/openai"
"github.com/trufflesecurity/trufflehog/v3/pkg/detectors/opencagedata"
@ -1184,7 +1183,6 @@ func DefaultDetectors() []detectors.Detector {
pastebin.Scanner{},
vatlayer.Scanner{},
verifier.Scanner{},
onwaterio.Scanner{},
graphhopper.Scanner{},
scraperapi.Scanner{},
ritekit.Scanner{},

1057
pkg/pb/detectorspb/detectors.pb.go
View file

File diff suppressed because it is too large Load diff

2
proto/detectors.proto
View file

@ -500,7 +500,7 @@ enum DetectorType {
Ipify = 488 [deprecated = true];
LanguageLayer = 489;
Lob = 490;
OnWaterIO = 491;
OnWaterIO = 491 [deprecated = true];
Pastebin = 492;
PdfLayer = 493;
Pixabay = 494;