//go:build detectors // +build detectors package gitlab 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 TestGitlab_FromChunk(t *testing.T) { ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) defer cancel() testSecrets, err := common.GetSecret(ctx, "trufflehog-testing", "detectors4") if err != nil { t.Fatalf("could not get test secrets from GCP: %s", err) } secret := testSecrets.MustGetField("GITLAB") secretInactive := testSecrets.MustGetField("GITLAB_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", s: Scanner{}, args: args{ ctx: context.Background(), data: []byte(fmt.Sprintf("You can find a gitlab super secret %s within", secret)), verify: true, }, want: []detectors.Result{ { DetectorType: detector_typepb.DetectorType_Gitlab, Verified: true, ExtraData: map[string]string{ "rotation_guide": "https://howtorotate.com/docs/tutorials/gitlab/", "version": "1", }, }, }, wantErr: false, }, { name: "found only secret phrase", s: Scanner{}, args: args{ ctx: context.Background(), data: []byte(fmt.Sprintf("gitlab %s", secret)), verify: true, }, want: []detectors.Result{ { DetectorType: detector_typepb.DetectorType_Gitlab, Verified: true, ExtraData: map[string]string{ "rotation_guide": "https://howtorotate.com/docs/tutorials/gitlab/", "version": "1", }, }, }, wantErr: false, }, { name: "found, unverified", s: Scanner{}, args: args{ ctx: context.Background(), data: []byte(fmt.Sprintf("You can find a gitlab secret %s within", secretInactive)), verify: true, }, want: []detectors.Result{ { DetectorType: detector_typepb.DetectorType_Gitlab, Verified: false, ExtraData: map[string]string{ "rotation_guide": "https://howtorotate.com/docs/tutorials/gitlab/", "version": "1", }, }, }, wantErr: false, }, { name: "found, would be verified but for timeout", s: Scanner{client: common.SaneHttpClientTimeOut(1 * time.Microsecond)}, args: args{ ctx: context.Background(), data: []byte(fmt.Sprintf("You can find a gitlab super secret %s within", secret)), verify: true, }, want: []detectors.Result{ { DetectorType: detector_typepb.DetectorType_Gitlab, Verified: false, ExtraData: map[string]string{ "rotation_guide": "https://howtorotate.com/docs/tutorials/gitlab/", "version": "1", }, }, }, wantErr: false, wantVerificationErr: true, }, { name: "found and valid but unexpected api response", s: Scanner{client: common.ConstantResponseHttpClient(500, "")}, args: args{ ctx: context.Background(), data: []byte(fmt.Sprintf("You can find a gitlab super secret %s within", secret)), verify: true, }, want: []detectors.Result{ { DetectorType: detector_typepb.DetectorType_Gitlab, Verified: false, ExtraData: map[string]string{ "rotation_guide": "https://howtorotate.com/docs/tutorials/gitlab/", "version": "1", }, }, }, wantErr: false, wantVerificationErr: true, }, { name: "found, good key but wrong scope", s: Scanner{client: common.ConstantResponseHttpClient(403, "")}, args: args{ ctx: context.Background(), data: []byte(fmt.Sprintf("You can find a gitlab super secret %s within", secret)), verify: true, }, want: []detectors.Result{ { DetectorType: detector_typepb.DetectorType_Gitlab, Verified: true, ExtraData: map[string]string{ "rotation_guide": "https://howtorotate.com/docs/tutorials/gitlab/", "version": "1", }, }, }, 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) { tt.s.SetCloudEndpoint("https://gitlab.com") tt.s.UseCloudEndpoint(true) got, err := tt.s.FromData(tt.args.ctx, tt.args.verify, tt.args.data) if (err != nil) != tt.wantErr { t.Errorf("Gitlab.FromData() error = %v, wantErr %v", err, tt.wantErr) return } 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()) } got[i].SecretParts = nil } opts := cmpopts.IgnoreFields(detectors.Result{}, "Raw", "RawV2", "verificationError", "primarySecret") if diff := cmp.Diff(got, tt.want, opts); diff != "" { t.Errorf("Gitlab.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) } } }) } } // This test ensures gitlab v1 detector does not work on gitlab v2 secrets func TestGitlab_FromChunk_WithV2Secrets(t *testing.T) { ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) defer cancel() testSecrets, err := common.GetSecret(ctx, "trufflehog-testing", "detectors4") if err != nil { t.Fatalf("could not get test secrets from GCP: %s", err) } secret := testSecrets.MustGetField("GITLABV2") secretInactive := testSecrets.MustGetField("GITLABV2_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: "verified secret, not found", s: Scanner{}, args: args{ ctx: context.Background(), data: []byte(fmt.Sprintf("You can find a gitlab secret %s within", secret)), verify: true, }, want: nil, wantErr: false, }, { name: "unverified secret, not found", s: Scanner{}, args: args{ ctx: context.Background(), data: []byte(fmt.Sprintf("You can find a gitlab secret %s within", secretInactive)), verify: true, }, want: nil, 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) { got, err := tt.s.FromData(tt.args.ctx, tt.args.verify, tt.args.data) if (err != nil) != tt.wantErr { t.Errorf("Gitlab.FromData() error = %v, wantErr %v", err, tt.wantErr) return } 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()) } got[i].SecretParts = nil } opts := cmpopts.IgnoreFields(detectors.Result{}, "Raw", "RawV2", "verificationError") if diff := cmp.Diff(got, tt.want, opts); diff != "" { t.Errorf("Gitlab.FromData() %s diff: (-got +want)\n%s", tt.name, diff) } }) } } // This test ensures gitlab v1 detector does not work on gitlab v3 secrets func TestGitlab_FromChunk_WithV3Secrets(t *testing.T) { ctx, cancel := context.WithTimeout(context.Background(), time.Second*5) defer cancel() testSecrets, err := common.GetSecret(ctx, "trufflehog-testing", "detectors6") if err != nil { t.Fatalf("could not get test secrets from GCP: %s", err) } secret := testSecrets.MustGetField("GITLABV3") secretInactive := testSecrets.MustGetField("GITLABV3_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: "verified v3 secret, not found", s: Scanner{}, args: args{ ctx: context.Background(), data: []byte(fmt.Sprintf("You can find a gitlab super secret %s within", secret)), verify: true, }, want: nil, wantErr: false, }, { name: "verified v3 secret, not found", s: Scanner{}, args: args{ ctx: context.Background(), data: []byte(fmt.Sprintf("gitlab %s", secret)), verify: true, }, want: nil, wantErr: false, }, { name: "unverified v3 secret, not found", s: Scanner{}, args: args{ ctx: context.Background(), data: []byte(fmt.Sprintf("You can find a gitlab secret %s within", secretInactive)), verify: true, }, want: nil, 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) { tt.s.SetCloudEndpoint("https://gitlab.com") tt.s.UseCloudEndpoint(true) got, err := tt.s.FromData(tt.args.ctx, tt.args.verify, tt.args.data) if (err != nil) != tt.wantErr { t.Errorf("Gitlab.FromData() error = %v, wantErr %v", err, tt.wantErr) return } 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()) } got[i].SecretParts = nil } opts := cmpopts.IgnoreFields(detectors.Result{}, "Raw", "RawV2", "verificationError", "primarySecret") if diff := cmp.Diff(got, tt.want, opts); diff != "" { t.Errorf("Gitlab.FromData() %s diff: (-got +want)\n%s", tt.name, diff) } }) } } func BenchmarkV2FromData(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) } } }) } }