refactor(gradle)!: Split out authentication utilities to a new module

sschuberth · sschuberth · commit fe47add76abd · 2026-06-02T15:29:37.000+02:00
This allows for more fine-granular dependency management.

BREAKING CHANGE: Programmatic users might need to depend on
`authorization-utils` instead of / in addition to `ort-utils` now.

Signed-off-by: Sebastian Schuberth &lt;sebastian@doubleopen.io&gt;
diff --git a/plugins/package-managers/conan/build.gradle.kts b/plugins/package-managers/conan/build.gradle.kts
@@ -34,6 +34,7 @@ dependencies {
     implementation(libs.kotlinx.serialization.yaml)
     implementation(libs.semver4j)
     implementation(projects.downloader)
+    implementation(projects.utils.authenticationUtils)
     implementation(projects.utils.commonUtils)
     implementation(projects.utils.ortUtils)
 
diff --git a/plugins/package-managers/conan/src/main/kotlin/Conan.kt b/plugins/package-managers/conan/src/main/kotlin/Conan.kt
@@ -55,6 +55,7 @@ import org.ossreviewtoolkit.model.config.Includes
 import org.ossreviewtoolkit.plugins.api.OrtPlugin
 import org.ossreviewtoolkit.plugins.api.OrtPluginOption
 import org.ossreviewtoolkit.plugins.api.PluginDescriptor
+import org.ossreviewtoolkit.utils.authentication.requestPasswordAuthentication
 import org.ossreviewtoolkit.utils.common.CommandLineTool
 import org.ossreviewtoolkit.utils.common.alsoIfNull
 import org.ossreviewtoolkit.utils.common.div
@@ -64,7 +65,6 @@ import org.ossreviewtoolkit.utils.common.stashFiles
 import org.ossreviewtoolkit.utils.common.toUri
 import org.ossreviewtoolkit.utils.ort.ORT_CONFIG_FILENAME
 import org.ossreviewtoolkit.utils.ort.createOrtTempDir
-import org.ossreviewtoolkit.utils.ort.requestPasswordAuthentication
 
 import org.semver4j.range.RangeList
 import org.semver4j.range.RangeListFactory
diff --git a/plugins/package-managers/maven/build.gradle.kts b/plugins/package-managers/maven/build.gradle.kts
@@ -37,6 +37,7 @@ dependencies {
     implementation(libs.kotlinx.serialization.json)
     implementation(libs.maven.embedder)
     implementation(projects.downloader)
+    implementation(projects.utils.authenticationUtils)
     implementation(projects.utils.commonUtils)
 
     funTestImplementation(testFixtures(projects.analyzer))
diff --git a/plugins/package-managers/maven/src/main/kotlin/utils/MavenSupport.kt b/plugins/package-managers/maven/src/main/kotlin/utils/MavenSupport.kt
@@ -89,12 +89,12 @@ import org.ossreviewtoolkit.model.RemoteArtifact
 import org.ossreviewtoolkit.model.fromYaml
 import org.ossreviewtoolkit.model.toYaml
 import org.ossreviewtoolkit.plugins.packagemanagers.maven.PACKAGE_TYPE
+import org.ossreviewtoolkit.utils.authentication.OrtAuthenticator
+import org.ossreviewtoolkit.utils.authentication.OrtProxySelector
 import org.ossreviewtoolkit.utils.common.collectMessages
 import org.ossreviewtoolkit.utils.common.div
 import org.ossreviewtoolkit.utils.common.gibibytes
 import org.ossreviewtoolkit.utils.common.searchUpwardFor
-import org.ossreviewtoolkit.utils.ort.OrtAuthenticator
-import org.ossreviewtoolkit.utils.ort.OrtProxySelector
 import org.ossreviewtoolkit.utils.ort.downloadText
 import org.ossreviewtoolkit.utils.ort.okHttpClient
 import org.ossreviewtoolkit.utils.ort.ortDataDirectory
diff --git a/plugins/package-managers/spdx-document-file/build.gradle.kts b/plugins/package-managers/spdx-document-file/build.gradle.kts
@@ -30,6 +30,7 @@ dependencies {
     implementation(jacksonLibs.jacksonDatabind)
     implementation(libs.okhttp)
     implementation(projects.downloader)
+    implementation(projects.utils.authenticationUtils)
     implementation(projects.utils.commonUtils)
     implementation(projects.utils.ortUtils)
     implementation(projects.utils.spdxDocumentUtils)
diff --git a/plugins/package-managers/spdx-document-file/src/main/kotlin/utils/SpdxResolvedDocument.kt b/plugins/package-managers/spdx-document-file/src/main/kotlin/utils/SpdxResolvedDocument.kt
@@ -32,13 +32,13 @@ import org.ossreviewtoolkit.model.Severity
 import org.ossreviewtoolkit.model.createAndLogIssue
 import org.ossreviewtoolkit.plugins.packagemanagers.spdx.SpdxDocumentFile
 import org.ossreviewtoolkit.plugins.packagemanagers.spdx.SpdxDocumentFileFactory
+import org.ossreviewtoolkit.utils.authentication.requestPasswordAuthentication
 import org.ossreviewtoolkit.utils.common.collectMessages
 import org.ossreviewtoolkit.utils.common.safeDeleteRecursively
 import org.ossreviewtoolkit.utils.ort.OkHttpClientHelper
 import org.ossreviewtoolkit.utils.ort.addBasicAuthorization
 import org.ossreviewtoolkit.utils.ort.createOrtTempDir
 import org.ossreviewtoolkit.utils.ort.downloadFile
-import org.ossreviewtoolkit.utils.ort.requestPasswordAuthentication
 import org.ossreviewtoolkit.utils.spdxdocument.model.SpdxDocument
 import org.ossreviewtoolkit.utils.spdxdocument.model.SpdxExternalDocumentReference
 import org.ossreviewtoolkit.utils.spdxdocument.model.SpdxPackage
diff --git a/plugins/scanners/fossid/build.gradle.kts b/plugins/scanners/fossid/build.gradle.kts
@@ -30,6 +30,7 @@ dependencies {
     implementation(libs.kotlinx.coroutines)
     implementation(libs.packageurl)
     implementation(projects.downloader)
+    implementation(projects.utils.authenticationUtils)
     implementation(projects.utils.commonUtils)
     implementation(projects.utils.ortUtils)
     implementation(projects.utils.spdxUtils)
diff --git a/plugins/scanners/fossid/src/main/kotlin/FossIdUrlProvider.kt b/plugins/scanners/fossid/src/main/kotlin/FossIdUrlProvider.kt
@@ -24,10 +24,10 @@ import java.net.PasswordAuthentication
 
 import org.apache.logging.log4j.kotlin.logger
 
+import org.ossreviewtoolkit.utils.authentication.requestPasswordAuthentication
 import org.ossreviewtoolkit.utils.common.percentEncode
 import org.ossreviewtoolkit.utils.common.replaceCredentialsInUri
 import org.ossreviewtoolkit.utils.common.toUri
-import org.ossreviewtoolkit.utils.ort.requestPasswordAuthentication
 
 /**
  * An internal helper class that generates the URLs used by [FossId] to check out the repositories to be scanned.
diff --git a/plugins/scanners/fossid/src/test/kotlin/FossIdUrlProviderTest.kt b/plugins/scanners/fossid/src/test/kotlin/FossIdUrlProviderTest.kt
@@ -29,8 +29,8 @@ import io.mockk.unmockkAll
 import java.net.PasswordAuthentication
 import java.net.URI
 
+import org.ossreviewtoolkit.utils.authentication.requestPasswordAuthentication
 import org.ossreviewtoolkit.utils.common.replaceCredentialsInUri
-import org.ossreviewtoolkit.utils.ort.requestPasswordAuthentication
 
 class FossIdUrlProviderTest : StringSpec({
     afterTest {
@@ -137,7 +137,7 @@ private fun mockAuthenticator(
     port: Int = PORT,
     authentication: PasswordAuthentication? = AUTHENTICATION
 ) {
-    mockkStatic("org.ossreviewtoolkit.utils.ort.AuthenticationUtilsKt")
+    mockkStatic("org.ossreviewtoolkit.utils.authentication.AuthenticationUtilsKt")
     every { requestPasswordAuthentication(any()) } answers {
         val uri = firstArg<URI>()
         authentication.takeIf { uri.host == host && uri.port == port && uri.scheme == "https" && uri.userInfo == null }
diff --git a/plugins/version-control-systems/git/build.gradle.kts b/plugins/version-control-systems/git/build.gradle.kts
@@ -39,6 +39,7 @@ dependencies {
     implementation(libs.kotlinx.serialization.core)
     implementation(libs.kotlinx.serialization.xml)
     implementation(libs.semver4j)
+    implementation(projects.utils.authenticationUtils)
     implementation(projects.utils.commonUtils)
     implementation(projects.utils.ortUtils)
 
diff --git a/plugins/version-control-systems/git/src/main/kotlin/Git.kt b/plugins/version-control-systems/git/src/main/kotlin/Git.kt
@@ -50,13 +50,13 @@ import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.VcsType
 import org.ossreviewtoolkit.plugins.api.OrtPlugin
 import org.ossreviewtoolkit.plugins.api.PluginDescriptor
+import org.ossreviewtoolkit.utils.authentication.requestPasswordAuthentication
 import org.ossreviewtoolkit.utils.common.CommandLineTool
 import org.ossreviewtoolkit.utils.common.Os
 import org.ossreviewtoolkit.utils.common.collectMessages
 import org.ossreviewtoolkit.utils.common.safeMkdirs
 import org.ossreviewtoolkit.utils.common.toUri
 import org.ossreviewtoolkit.utils.common.withoutPrefix
-import org.ossreviewtoolkit.utils.ort.requestPasswordAuthentication
 import org.ossreviewtoolkit.utils.ort.showStackTrace
 
 import org.semver4j.range.RangeList
diff --git a/plugins/version-control-systems/git/src/test/kotlin/GitTest.kt b/plugins/version-control-systems/git/src/test/kotlin/GitTest.kt
@@ -41,7 +41,7 @@ import org.eclipse.jgit.transport.CredentialsProvider
 import org.eclipse.jgit.transport.URIish
 
 import org.ossreviewtoolkit.plugins.api.PluginConfig
-import org.ossreviewtoolkit.utils.ort.requestPasswordAuthentication
+import org.ossreviewtoolkit.utils.authentication.requestPasswordAuthentication
 
 class GitTest : WordSpec({
     var originalCredentialsProvider: CredentialsProvider? = null
@@ -176,7 +176,7 @@ private val testUriAsUrl = URI.create(testUri.toString()).toURL()
  * Mocks the utility function to query password authentication for the test URI. Return the [result] provided.
  */
 private fun mockAuthentication(result: PasswordAuthentication?) {
-    mockkStatic("org.ossreviewtoolkit.utils.ort.AuthenticationUtilsKt")
+    mockkStatic("org.ossreviewtoolkit.utils.authentication.AuthenticationUtilsKt")
 
     every {
         requestPasswordAuthentication(testUri.host, testUri.port, testUri.scheme, testUriAsUrl)
diff --git a/plugins/version-control-systems/subversion/build.gradle.kts b/plugins/version-control-systems/subversion/build.gradle.kts
@@ -33,6 +33,7 @@ dependencies {
             .because("it is included in JGit's sshd-osgi dependency")
     }
 
+    implementation(projects.utils.authenticationUtils)
     implementation(projects.utils.commonUtils)
     implementation(projects.utils.ortUtils)
 
diff --git a/plugins/version-control-systems/subversion/src/main/kotlin/Subversion.kt b/plugins/version-control-systems/subversion/src/main/kotlin/Subversion.kt
@@ -34,11 +34,11 @@ import org.ossreviewtoolkit.model.VcsInfo
 import org.ossreviewtoolkit.model.VcsType
 import org.ossreviewtoolkit.plugins.api.OrtPlugin
 import org.ossreviewtoolkit.plugins.api.PluginDescriptor
+import org.ossreviewtoolkit.utils.authentication.OrtAuthenticator
+import org.ossreviewtoolkit.utils.authentication.OrtProxySelector
+import org.ossreviewtoolkit.utils.authentication.requestPasswordAuthentication
 import org.ossreviewtoolkit.utils.common.collectMessages
 import org.ossreviewtoolkit.utils.common.div
-import org.ossreviewtoolkit.utils.ort.OrtAuthenticator
-import org.ossreviewtoolkit.utils.ort.OrtProxySelector
-import org.ossreviewtoolkit.utils.ort.requestPasswordAuthentication
 import org.ossreviewtoolkit.utils.ort.showStackTrace
 
 import org.tmatesoft.svn.core.SVNDepth
diff --git a/utils/authentication/build.gradle.kts b/utils/authentication/build.gradle.kts
@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2017 The ORT Project Copyright Holders <https://github.com/oss-review-toolkit/ort/blob/main/NOTICE>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * License-Filename: LICENSE
+ */
+
+plugins {
+    // Apply precompiled plugins.
+    id("ort-library-conventions")
+}
+
+dependencies {
+    implementation(libs.log4j.api.kotlin)
+    implementation(projects.utils.commonUtils)
+
+    testImplementation(libs.mockk)
+}
diff --git a/utils/authentication/src/main/kotlin/AuthenticationUtils.kt b/utils/authentication/src/main/kotlin/AuthenticationUtils.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.utils.ort
+package org.ossreviewtoolkit.utils.authentication
 
 import java.net.Authenticator
 import java.net.PasswordAuthentication
diff --git a/utils/authentication/src/main/kotlin/EnvVarAuthenticator.kt b/utils/authentication/src/main/kotlin/EnvVarAuthenticator.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.utils.ort
+package org.ossreviewtoolkit.utils.authentication
 
 import java.net.Authenticator
 import java.net.PasswordAuthentication
diff --git a/utils/authentication/src/main/kotlin/NetRcAuthenticator.kt b/utils/authentication/src/main/kotlin/NetRcAuthenticator.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.utils.ort
+package org.ossreviewtoolkit.utils.authentication
 
 import java.io.File
 import java.lang.invoke.MethodHandles
diff --git a/utils/authentication/src/main/kotlin/OrtAuthenticator.kt b/utils/authentication/src/main/kotlin/OrtAuthenticator.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.utils.ort
+package org.ossreviewtoolkit.utils.authentication
 
 import java.net.Authenticator
 import java.net.InetSocketAddress
diff --git a/utils/authentication/src/main/kotlin/OrtProxySelector.kt b/utils/authentication/src/main/kotlin/OrtProxySelector.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.utils.ort
+package org.ossreviewtoolkit.utils.authentication
 
 import java.io.IOException
 import java.net.InetSocketAddress
diff --git a/utils/authentication/src/main/kotlin/UserInfoAuthenticator.kt b/utils/authentication/src/main/kotlin/UserInfoAuthenticator.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.utils.ort
+package org.ossreviewtoolkit.utils.authentication
 
 import java.net.Authenticator
 import java.net.PasswordAuthentication
diff --git a/utils/authentication/src/test/kotlin/AuthenticationUtilsTest.kt b/utils/authentication/src/test/kotlin/AuthenticationUtilsTest.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.utils.ort
+package org.ossreviewtoolkit.utils.authentication
 
 import io.kotest.core.spec.style.WordSpec
 import io.kotest.matchers.nulls.shouldNotBeNull
diff --git a/utils/authentication/src/test/kotlin/EnvVarAuthenticatorTest.kt b/utils/authentication/src/test/kotlin/EnvVarAuthenticatorTest.kt
@@ -17,16 +17,16 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.utils.ort
+package org.ossreviewtoolkit.utils.authentication
 
 import io.kotest.core.spec.style.StringSpec
 import io.kotest.matchers.nulls.beNull
 import io.kotest.matchers.nulls.shouldNotBeNull
 import io.kotest.matchers.should
 import io.kotest.matchers.shouldBe
 
-import org.ossreviewtoolkit.utils.ort.EnvVarAuthenticator.Companion.ORT_HTTP_PASSWORD_ENV_NAME
-import org.ossreviewtoolkit.utils.ort.EnvVarAuthenticator.Companion.ORT_HTTP_USERNAME_ENV_NAME
+import org.ossreviewtoolkit.utils.authentication.EnvVarAuthenticator.Companion.ORT_HTTP_PASSWORD_ENV_NAME
+import org.ossreviewtoolkit.utils.authentication.EnvVarAuthenticator.Companion.ORT_HTTP_USERNAME_ENV_NAME
 
 class EnvVarAuthenticatorTest : StringSpec({
     "Setting the username alone does not return authentication" {
diff --git a/utils/authentication/src/test/kotlin/NetRcAuthenticatorTest.kt b/utils/authentication/src/test/kotlin/NetRcAuthenticatorTest.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.utils.ort
+package org.ossreviewtoolkit.utils.authentication
 
 import io.kotest.core.TestConfiguration
 import io.kotest.core.spec.style.WordSpec
diff --git a/utils/authentication/src/test/kotlin/OrtProxySelectorTest.kt b/utils/authentication/src/test/kotlin/OrtProxySelectorTest.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.utils.ort
+package org.ossreviewtoolkit.utils.authentication
 
 import io.kotest.core.spec.style.WordSpec
 import io.kotest.matchers.shouldBe
diff --git a/utils/ort/build.gradle.kts b/utils/ort/build.gradle.kts
@@ -40,6 +40,7 @@ dependencies {
     implementation(libs.awsS3)
     implementation(libs.xz)
     implementation(projects.clients.foojayClient)
+    implementation(projects.utils.authenticationUtils)
     implementation(projects.utils.commonUtils)
     implementation(projects.utils.spdxUtils)
 
diff --git a/utils/ort/src/main/kotlin/OkHttpClientHelper.kt b/utils/ort/src/main/kotlin/OkHttpClientHelper.kt
@@ -50,6 +50,9 @@ import okio.sink
 import org.apache.logging.log4j.kotlin.logger
 import org.apache.logging.log4j.kotlin.loggerOf
 
+import org.ossreviewtoolkit.utils.authentication.OrtAuthenticator
+import org.ossreviewtoolkit.utils.authentication.OrtProxySelector
+import org.ossreviewtoolkit.utils.authentication.requestPasswordAuthentication
 import org.ossreviewtoolkit.utils.common.ArchiveType
 import org.ossreviewtoolkit.utils.common.collectMessages
 import org.ossreviewtoolkit.utils.common.div
diff --git a/utils/ort/src/test/kotlin/OkHttpClientHelperTest.kt b/utils/ort/src/test/kotlin/OkHttpClientHelperTest.kt
@@ -54,6 +54,8 @@ import okhttp3.Route
 
 import okio.BufferedSource
 
+import org.ossreviewtoolkit.utils.authentication.requestPasswordAuthentication
+
 class OkHttpClientHelperTest : WordSpec({
     afterTest {
         unmockkAll()
diff --git a/utils/test/build.gradle.kts b/utils/test/build.gradle.kts
@@ -41,6 +41,7 @@ dependencies {
     implementation(libs.kotest.extensions.testcontainers)
     implementation(libs.testcontainers.postgresql)
     implementation(projects.downloader)
+    implementation(projects.utils.authenticationUtils)
     implementation(projects.utils.commonUtils)
     implementation(projects.utils.ortUtils)
 
diff --git a/utils/test/src/main/kotlin/ProjectConfig.kt b/utils/test/src/main/kotlin/ProjectConfig.kt
@@ -23,8 +23,8 @@ import io.kotest.core.config.AbstractProjectConfig
 import io.kotest.core.spec.SpecExecutionOrder
 import io.kotest.extensions.junitxml.JunitXmlReporter
 
+import org.ossreviewtoolkit.utils.authentication.OrtProxySelector
 import org.ossreviewtoolkit.utils.common.Os
-import org.ossreviewtoolkit.utils.ort.OrtProxySelector
 
 class ProjectConfig : AbstractProjectConfig() {
     override val specExecutionOrder = SpecExecutionOrder.Annotated
