feat(cloning): support ssh cloning

Following a user's feedback, we now support SSH cloning with the dedicated option `ssh-cloning`.

Author: pierrelalanne

README.md

@@ -122,6 +122,8 @@ Here is an example of some lines of a `.jsonl` format output:
 
 Note that by default, `src-fingerprint` will exclude forked repositories from the fingerprints computation. **For GitHub provider** archived repositories and public repositories will also be excluded by default. Use flags `--include-forked-repos`, `--include-archived-repos` or `include-public-repos` to change this behavior.
 
+For all the following examples, we assume that the user is able to clone repositories using an HTTP URL with basic authentication. If for any reason this is not possible with the user's organization, `src-fingerprint` supports ssh cloning by using the dedicated option `--ssh-cloning`. Note though that this option is not the standard configuration of the tool but rather a workaround for this type of edge case. Especially, this option may bring some issues in the event of discrepancies in permissions between the token provided for API-based repos listing, and the SSH keys used to clone these repos.
+
 ### GitHub
 
 1. Export all fingerprints from private repositories from a GitHub Org to the default path `./fingerprints.jsonl.gz` with logs:

cmd/src-fingerprint/main.go

@@ -158,6 +158,11 @@ func main() {
 						Value: "-",
 						Usage: "set cloning location for repositories",
 					},
+					&cli.BoolFlag{
+						Name:  "ssh-cloning",
+						Value: false,
+						Usage: "Use ssh to clone repositories. The standard behavior is not guaranteed with this option.",
+					},
 					&cli.StringFlag{
 						Name:  "after",
 						Value: "",
@@ -243,6 +248,7 @@ func collectAction(c *cli.Context) error {
 		BaseURL:              c.String("provider-url"),
 		RepositoryName:       c.String("repo-name"),
 		RespositoryIsPrivate: c.Bool("repo-is-private"),
+		SSHCloning:           c.Bool("ssh-cloning"),
 	}
 
 	defer func() {

provider/bitbucket.go

@@ -177,9 +177,10 @@ func (p *BitbucketProvider) Gather(user string) ([]GitRepository, error) {
 // CloneRepository clones a Github repository given the token. The token must have the `read_repository` rights.
 func (p *BitbucketProvider) CloneRepository(cloner cloner.Cloner,
 	repository GitRepository) (string, error) {
-	authURL := repository.GetHTTPUrl()
-	// If token doesn't exist, don't try to basic auth
-	if p.token != "" {
+	authURL := repository.GetSSHUrl()
+	// If token doesn't exist or if SSH cloning was specified, don't try to basic auth
+	if p.token != "" && !p.options.SSHCloning {
+		authURL = repository.GetHTTPUrl()
 		authURL = strings.Replace(authURL,
 			"https://", fmt.Sprintf("https://%s:%s@",
 				p.transport.user, url.QueryEscape(p.token)), 1)

provider/github.go

@@ -183,9 +183,10 @@ func (p *GitHubProvider) Gather(user string) ([]GitRepository, error) {
 // CloneRepository clones a Github repository given the token. The token must have the `read_repository` rights.
 func (p *GitHubProvider) CloneRepository(cloner cloner.Cloner,
 	repository GitRepository) (string, error) {
-	url := repository.GetHTTPUrl()
-	// If token doesn't exist, don't try to basic auth
-	if p.token != "" {
+	url := repository.GetSSHUrl()
+	// If token doesn't exist or if SSH cloning was specified, don't try to basic auth
+	if p.token != "" && !p.options.SSHCloning {
+		url = repository.GetHTTPUrl()
 		url = strings.Replace(url, "https://", fmt.Sprintf("https://x-access-token:%s@", p.token), 1)
 	}
 

provider/gitlab.go

@@ -244,9 +244,10 @@ func (p *GitLabProvider) collectFromGroup(repositories []GitRepository,
 func (p *GitLabProvider) CloneRepository(
 	cloner cloner.Cloner,
 	repository GitRepository) (string, error) {
-	url := repository.GetHTTPUrl()
-	// If token doesn't exist, don't try to basic auth
-	if p.token != "" {
+	url := repository.GetSSHUrl()
+	// If token doesn't exist or if SSH cloning was specified, don't try to basic auth
+	if p.token != "" && !p.options.SSHCloning {
+		url = repository.GetHTTPUrl()
 		url = strings.Replace(url, "https://", fmt.Sprintf("https://%s:%s@", p.token, p.token), 1)
 	}
 

provider/provider.go

@@ -49,6 +49,8 @@ type Options struct {
 	IncludePublicRepos bool
 	// Repository private status to display in the output if the provider is 'repository'
 	RespositoryIsPrivate bool
+	// Use SSH to clone repositories.
+	SSHCloning bool
 	// BaseURL is the base URL of the API
 	BaseURL string
 	// Repository name to display in the output if the provider is 'repository'