Updated trufflehog sourcegraph secret format (#2254)

This commit is contained in:
Shivasurya 2024-01-06 11:48:41 -05:00 committed by GitHub
parent 7365dba9c9
commit e5289ac8e4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 5 deletions

View file

@ -22,7 +22,7 @@ var _ detectors.Detector = (*Scanner)(nil)
var ( var (
defaultClient = common.SaneHttpClient() defaultClient = common.SaneHttpClient()
// Make sure that your group is surrounded in boundary characters such as below to reduce false positives. // Make sure that your group is surrounded in boundary characters such as below to reduce false positives.
keyPat = regexp.MustCompile(`\b(sgp_[a-f0-9]{40})\b`) keyPat = regexp.MustCompile(`\b(sgp_(?:[a-fA-F0-9]{16}|local)_[a-fA-F0-9]{40}|sgp_[a-fA-F0-9]{40}|[a-fA-F0-9]{40})\b`)
) )
// Keywords are used for efficiently pre-filtering chunks. // Keywords are used for efficiently pre-filtering chunks.
@ -47,6 +47,9 @@ func (s Scanner) FromData(ctx context.Context, verify bool, data []byte) (result
DetectorType: detectorspb.DetectorType_Sourcegraph, DetectorType: detectorspb.DetectorType_Sourcegraph,
Raw: []byte(resMatch), Raw: []byte(resMatch),
} }
s1.ExtraData = map[string]string{
"rotation_guide": "https://howtorotate.com/docs/tutorials/sourcegraph/",
}
if verify { if verify {
client := s.client client := s.client

View file

@ -25,15 +25,24 @@ func TestSourcegraph_FromChunk(t *testing.T) {
if err != nil { if err != nil {
t.Fatalf("could not get test secrets from GCP: %s", err) t.Fatalf("could not get test secrets from GCP: %s", err)
} }
secret := testSecrets.MustGetField("SOURCEGRAPH")
inactiveSecret := testSecrets.MustGetField("SOURCEGRAPH_INACTIVE") secretV1 := testSecrets.MustGetField("SOURCEGRAPH_V1")
secretV2 := testSecrets.MustGetField("SOURCEGRAPH_V2")
secretV3 := testSecrets.MustGetField("SOURCEGRAPH_V3")
inactiveSecretV1 := testSecrets.MustGetField("SOURCEGRAPH_INACTIVE_V1")
inactiveSecretV2 := testSecrets.MustGetField("SOURCEGRAPH_INACTIVE_V2")
inactiveSecretV3 := testSecrets.MustGetField("SOURCEGRAPH_INACTIVE_V3")
secrets := []string{secretV1, secretV2, secretV3, inactiveSecretV1, inactiveSecretV2, inactiveSecretV3}
type args struct { type args struct {
ctx context.Context ctx context.Context
data []byte data []byte
verify bool verify bool
} }
tests := []struct { for _, secret := range secrets {
tests = append(tests, []struct {
name string name string
s Scanner s Scanner
args args args args
@ -122,6 +131,7 @@ func TestSourcegraph_FromChunk(t *testing.T) {
wantVerificationErr: true, wantVerificationErr: true,
}, },
} }
}
for _, tt := range tests { for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) { t.Run(tt.name, func(t *testing.T) {
got, err := tt.s.FromData(tt.args.ctx, tt.args.verify, tt.args.data) got, err := tt.s.FromData(tt.args.ctx, tt.args.verify, tt.args.data)
@ -137,7 +147,7 @@ func TestSourcegraph_FromChunk(t *testing.T) {
t.Fatalf("wantVerificationError = %v, verification error = %v", tt.wantVerificationErr, got[i].VerificationError()) t.Fatalf("wantVerificationError = %v, verification error = %v", tt.wantVerificationErr, got[i].VerificationError())
} }
} }
ignoreOpts := cmpopts.IgnoreFields(detectors.Result{}, "Raw", "verificationError") ignoreOpts := cmpopts.IgnoreFields(detectors.Result{}, "Raw", "VerificationError", "ExtraData")
if diff := cmp.Diff(got, tt.want, ignoreOpts); diff != "" { if diff := cmp.Diff(got, tt.want, ignoreOpts); diff != "" {
t.Errorf("Sourcegraph.FromData() %s diff: (-got +want)\n%s", tt.name, diff) t.Errorf("Sourcegraph.FromData() %s diff: (-got +want)\n%s", tt.name, diff)
} }