Find, verify, and analyze leaked credentials
Go credentialsdevsecopsdynamic-analysisprecommitscanningsecretsecret-managementsecretssecuritysecurity-toolstrufflehogverification
Improve Gitlab default URL handling (#2491)
trufflesteeeve12ff21f245b0
diff --git a/pkg/sources/gitlab/gitlab.go b/pkg/sources/gitlab/gitlab.goindex d459804cd..b6047ad13 100644--- a/pkg/sources/gitlab/gitlab.go+++ b/pkg/sources/gitlab/gitlab.go@@ -29,6 +29,9 @@ import (const SourceType = sourcespb.SourceType_SOURCE_TYPE_GITLAB+// This is the URL for gitlab hosted at gitlab.com+const gitlabBaseURL = "https://gitlab.com/"+type Source struct {name stringsourceID sources.SourceID@@ -87,6 +90,10 @@ func (s *Source) Init(_ context.Context, name string, jobId sources.JobID, sourcs.jobPool = &errgroup.Group{}s.jobPool.SetLimit(concurrency)+ if err := git.CmdCheck(); err != nil {+ return err+ }+var conn sourcespb.GitLaberr := anypb.UnmarshalTo(connection, &conn, proto.UnmarshalOptions{})if err != nil {@@ -95,11 +102,7 @@ func (s *Source) Init(_ context.Context, name string, jobId sources.JobID, sourcs.repos = conn.Repositoriess.ignoreRepos = conn.IgnoreRepos- s.url = conn.Endpoint- if conn.Endpoint != "" && !strings.HasSuffix(s.url, "/") {- s.url = s.url + "/"- }switch cred := conn.GetCredential().(type) {case *sourcespb.GitLab_Token:s.authMethod = "TOKEN"@@ -118,12 +121,7 @@ func (s *Source) Init(_ context.Context, name string, jobId sources.JobID, sourcreturn fmt.Errorf("invalid configuration given for source %q (%s)", name, s.Type().String())}- if len(s.url) == 0 {- // Assuming not custom gitlab url.- s.url = "https://gitlab.com/"- }-- err = git.CmdCheck()+ s.url, err = normalizeGitlabEndpoint(conn.Endpoint)if err != nil {return err}@@ -466,8 +464,8 @@ func (s *Source) getAllProjectRepos(TopLevelOnly: gitlab.Ptr(false),Owned: gitlab.Ptr(false),}- const cloudBaseURL = "https://gitlab.com/"- if s.url != cloudBaseURL {++ if s.url != gitlabBaseURL {listGroupsOptions.AllAvailable = gitlab.Ptr(true)}@@ -653,6 +651,46 @@ func normalizeRepos(repos []string) ([]string, []error) {return validRepos, errs}+// normalizeGitlabEndpoint ensures that if an endpoint is going to gitlab.com, we use https://gitlab.com/ as the endpoint.+// If we see the protocol is http, we error, because this shouldn't be used.+// Otherwise, it ensures we are using https as our protocol, if none was provided.+func normalizeGitlabEndpoint(gitlabEndpoint string) (string, error) {+ if gitlabEndpoint == "" {+ return gitlabBaseURL, nil+ }++ gitlabURL, err := url.Parse(gitlabEndpoint)+ if err != nil {+ return "", err+ }++ // We probably didn't receive a URL with a scheme, which messed up the parsing.+ if gitlabURL.Host == "" {+ gitlabURL, err = url.Parse("https://" + gitlabEndpoint)+ if err != nil {+ return "", err+ }+ }++ // If the host is gitlab.com, this is the cloud version, which has only one valid endpoint.+ if gitlabURL.Host == "gitlab.com" {+ return gitlabBaseURL, nil+ }++ // Beyond here, on-prem gitlab is being used, so we have to mostly leave things as-is.++ if gitlabURL.Scheme != "https" {+ return "", fmt.Errorf("https was not used as URL scheme, but is required. Please use https")+ }++ // The gitlab library wants trailing slashes.+ if !strings.HasSuffix(gitlabURL.Path, "/") {+ gitlabURL.Path = gitlabURL.Path + "/"+ }++ return gitlabURL.String(), nil+}+// Enumerate reports all GitLab repositories to be scanned to the reporter. If// none are configured, it will find all repositories within all projects that// the configured user has access to, while respecting the configured ignorediff --git a/pkg/sources/gitlab/gitlab_test.go b/pkg/sources/gitlab/gitlab_test.goindex 3a63e1369..5a0848fc4 100644--- a/pkg/sources/gitlab/gitlab_test.go+++ b/pkg/sources/gitlab/gitlab_test.go@@ -133,3 +133,57 @@ func Test_scanRepos_SetProgressComplete(t *testing.T) {})}}++func Test_normalizeGitlabEndpoint(t *testing.T) {+ testCases := map[string]struct {+ inputEndpoint string+ outputEndpoint string+ wantErr bool+ }{+ "the cloud url should return the cloud url": {+ inputEndpoint: gitlabBaseURL,+ outputEndpoint: gitlabBaseURL,+ },+ "empty string should return the cloud url": {+ inputEndpoint: "",+ outputEndpoint: gitlabBaseURL,+ },+ "no scheme cloud url should return the cloud url": {+ inputEndpoint: "gitlab.com",+ outputEndpoint: gitlabBaseURL,+ },+ "no scheme cloud url with trailing slash should return the cloud url": {+ inputEndpoint: "gitlab.com/",+ outputEndpoint: gitlabBaseURL,+ },+ "http scheme cloud url with organization should return the cloud url": {+ inputEndpoint: "http://gitlab.com/trufflesec",+ outputEndpoint: gitlabBaseURL,+ },+ // On-prem endpoint testing.+ "on-prem url should be unchanged": {+ inputEndpoint: "https://gitlab.trufflesec.com/",+ outputEndpoint: "https://gitlab.trufflesec.com/",+ },+ "on-prem url without trailing slash should have trailing slash added": {+ inputEndpoint: "https://gitlab.trufflesec.com",+ outputEndpoint: "https://gitlab.trufflesec.com/",+ },+ "on-prem url with http scheme should return an error": {+ inputEndpoint: "http://gitlab.trufflesec.com/",+ wantErr: true,+ },+ "on-prem with gitlab.com should not rewrite to the cloud url": {+ inputEndpoint: "https://gitlab.com.trufflesec.com/",+ outputEndpoint: "https://gitlab.com.trufflesec.com/",+ },+ }++ for name, tc := range testCases {+ t.Run(name, func(t *testing.T) {+ output, err := normalizeGitlabEndpoint(tc.inputEndpoint)+ assert.Equal(t, tc.outputEndpoint, output)+ assert.Equal(t, tc.wantErr, err != nil)+ })+ }+}