feat(vcs): Allow to replace Git SSH / SCP URLs with HTTPS

Relates to #6698. Note that still #8556 needs to be implemented to make
this configurable for ORT CLI users.

Signed-off-by: Sebastian Schuberth <[email protected]>

Author: sschuberth

plugins/version-control-systems/git/src/funTest/kotlin/GitFunTest.kt

@@ -52,7 +52,7 @@ private const val REPO_PATH_FOR_VERSION = "specs"
 
 @Tags("RequiresExternalTool")
 class GitFunTest : WordSpec({
-    val git = GitFactory().create(PluginConfig.EMPTY)
+    val git = GitFactory().create(PluginConfig(options = mapOf("replaceSshWithHttps" to "true")))
     lateinit var outputDir: File
 
     beforeEach {
@@ -163,6 +163,16 @@ class GitFunTest : WordSpec({
             }
         }
 
+        "apply SSH URL replacements" {
+            val pkg = Package.EMPTY.copy(
+                vcsProcessed = VcsInfo(VcsType.GIT, REPO_URL.replace("https://", "ssh://git@"), REPO_REV)
+            )
+
+            shouldNotThrow<DownloadException> {
+                git.download(pkg, outputDir)
+            }
+        }
+
         "apply URL replacements recursively" {
             val url = "https://github.com/oss-review-toolkit/ort-test-data-git-submodules.git"
             val pkg = Package.EMPTY.copy(vcsProcessed = VcsInfo(VcsType.GIT, url, "git-protocol-submodule-urls"))

plugins/version-control-systems/git/src/main/kotlin/Git.kt

@@ -64,11 +64,6 @@ import org.ossreviewtoolkit.utils.ort.showStackTrace
 import org.semver4j.range.RangeList
 import org.semver4j.range.RangeListFactory
 
-// Replace prefixes of Git submodule repository URLs.
-private val REPOSITORY_URL_PREFIX_REPLACEMENTS = listOf(
-    "git://" to "https://"
-)
-
 object GitCommand : CommandLineTool {
     private val versionRegex = Regex("[Gg]it [Vv]ersion (?<version>[\\d.a-z-]+)(\\s.+)?")
 
@@ -143,6 +138,16 @@ class Git(
     override val priority = 100
     override val latestRevisionNames = listOf("HEAD", "@")
 
+    private val repositoryUrlPrefixReplacements = buildList {
+        // Replace prefixes of Git submodule repository URLs.
+        add("git://" to "https://")
+
+        if (config.replaceSshWithHttps) {
+            add("ssh://git@" to "https://")
+            add("[email protected]:" to "https://github.com/")
+        }
+    }
+
     override fun getVersion() = GitCommand.getVersion()
 
     override fun getDefaultBranchName(url: String): String {
@@ -182,7 +187,7 @@ class Git(
                     gitInfoDir.resolve("sparse-checkout").writeText(globPatterns.joinToString("\n"))
                 }
 
-                REPOSITORY_URL_PREFIX_REPLACEMENTS.groupBy(
+                repositoryUrlPrefixReplacements.groupBy(
                     { it.second }, { it.first }
                 ).forEach { (replacement, prefixes) ->
                     git.repository.config.setStringList("url", replacement, "insteadOf", prefixes)
@@ -321,7 +326,7 @@ class Git(
     private fun updateSubmodules(workingTree: GitWorkingTree) {
         if (!workingTree.getRootPath().resolve(".gitmodules").isFile) return
 
-        val configArgs = REPOSITORY_URL_PREFIX_REPLACEMENTS.flatMap { (prefix, replacement) ->
+        val configArgs = repositoryUrlPrefixReplacements.flatMap { (prefix, replacement) ->
             listOf("-c", "url.$replacement.insteadOf=$prefix")
         }
 

plugins/version-control-systems/git/src/main/kotlin/GitConfig.kt

@@ -32,5 +32,12 @@ data class GitConfig(
 
     /** Whether nested submodules should be updated, or if only top-level submodules should be considered. */
     @OrtPluginOption(defaultValue = "true")
-    val updateNestedSubmodules: Boolean
+    val updateNestedSubmodules: Boolean,
+
+    /**
+     * Whether to force SSH / SCP URLs (which always require authentication) to use HTTPS instead (which might work
+     * without authentication).
+     */
+    @OrtPluginOption(defaultValue = "false")
+    val replaceSshWithHttps: Boolean
 )