fix: class cast exception when handling Failed verification result & signature download on Windows (#158)

fioan89 · web-flow · commit 1f23762d4db3 · 2025-07-23T01:56:36.000+03:00
Verification result was improperly cast to download result when
signature verification failed to run.
I discovered this issue while porting the signature verifications to
Coder Gateway plugin.

Additionally the signature for windows CLI follows the format:
coder-windows-amd64.exe.asc
Currently it is coded to coder-windows-amd64.asc which means the plugin
always fail to find any signature for windows CLI
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+### Fixed
+
+- fix class cast exception during signature verification
+- the correct CLI signature for Windows is now downloaded
+
 ## 0.5.1 - 2025-07-21
 
 ### Added
diff --git a/gradle.properties b/gradle.properties
@@ -1,3 +1,3 @@
-version=0.5.1
+version=0.5.2
 group=com.coder.toolbox
 name=coder-toolbox
diff --git a/src/main/kotlin/com/coder/toolbox/cli/CoderCLIManager.kt b/src/main/kotlin/com/coder/toolbox/cli/CoderCLIManager.kt
@@ -277,8 +277,8 @@ class CoderCLIManager(
             }
 
             else -> {
-                UnsignedBinaryExecutionDeniedException((result as Failed).error.message)
-                val failure = result as DownloadResult.Failed
+                val failure = result as Failed
+                UnsignedBinaryExecutionDeniedException(result.error.message)
                 context.logger.error(failure.error, "Failed to verify signature for ${cliResult.dst}")
             }
         }
@@ -467,7 +467,7 @@ class CoderCLIManager(
      */
     private fun writeSSHConfig(contents: String?) {
         if (contents != null) {
-            if (!context.settingsStore.sshConfigPath.isNullOrBlank()) {
+            if (context.settingsStore.sshConfigPath.isNotBlank()) {
                 val sshConfPath = Path.of(context.settingsStore.sshConfigPath)
                 sshConfPath.parent.toFile().mkdirs()
                 sshConfPath.toFile().writeText(contents)
@@ -492,9 +492,9 @@ class CoderCLIManager(
                 throw MissingVersionException("No version found in output")
             }
             return SemVer.parse(json.version)
-        } catch (exception: JsonDataException) {
+        } catch (_: JsonDataException) {
             throw MissingVersionException("No version found in output")
-        } catch (exception: EOFException) {
+        } catch (_: EOFException) {
             throw MissingVersionException("No version found in output")
         }
     }
@@ -532,7 +532,7 @@ class CoderCLIManager(
         val buildVersion =
             try {
                 SemVer.parse(rawBuildVersion)
-            } catch (e: InvalidVersionException) {
+            } catch (_: InvalidVersionException) {
                 context.logger.info("Got invalid build version: $rawBuildVersion")
                 return null
             }
diff --git a/src/main/kotlin/com/coder/toolbox/store/CoderSettingsStore.kt b/src/main/kotlin/com/coder/toolbox/store/CoderSettingsStore.kt
@@ -250,42 +250,17 @@ class CoderSettingsStore(
     /**
      * Return the name of the binary (with extension) for the provided OS and architecture.
      */
-    private fun getCoderCLIForOS(
-        os: OS?,
-        arch: Arch?,
-    ): String {
+    private fun getCoderCLIForOS(os: OS?, arch: Arch?): String {
         logger.debug("Resolving binary for $os $arch")
-        return buildCoderFileName(os, arch)
-    }
-
-    /**
-     * Return the name of the signature file (.asc) for the provided OS and architecture.
-     */
-    private fun getCoderSignatureForOS(
-        os: OS?,
-        arch: Arch?,
-    ): String {
-        logger.debug("Resolving signature for $os $arch")
-        return buildCoderFileName(os, arch, true)
-    }
-
-    /**
-     * Build the coder file name based on OS, architecture, and whether it's a signature file.
-     */
-    private fun buildCoderFileName(
-        os: OS?,
-        arch: Arch?,
-        isSignature: Boolean = false
-    ): String {
-        if (os == null) {
-            logger.error("Could not resolve client OS and architecture, defaulting to WINDOWS AMD64")
-            return if (isSignature) "coder-windows-amd64.asc" else "coder-windows-amd64.exe"
-        }
 
-        val osName = when (os) {
-            OS.WINDOWS -> "windows"
-            OS.LINUX -> "linux"
-            OS.MAC -> "darwin"
+        val (osName, extension) = when (os) {
+            OS.WINDOWS -> "windows" to ".exe"
+            OS.LINUX -> "linux" to ""
+            OS.MAC -> "darwin" to ""
+            null -> {
+                logger.error("Could not resolve client OS and architecture, defaulting to WINDOWS AMD64")
+                return "coder-windows-amd64.exe"
+            }
         }
 
         val archName = when (arch) {
@@ -295,14 +270,17 @@ class CoderSettingsStore(
             else -> "amd64" // default fallback
         }
 
-        val extension = if (isSignature) ".asc" else when (os) {
-            OS.WINDOWS -> ".exe"
-            OS.LINUX, OS.MAC -> ""
-        }
-
         return "coder-$osName-$archName$extension"
     }
 
+    /**
+     * Return the name of the signature file (.asc) for the provided OS and architecture.
+     */
+    private fun getCoderSignatureForOS(os: OS?, arch: Arch?): String {
+        logger.debug("Resolving signature for $os $arch")
+        return "${getCoderCLIForOS(os, arch)}.asc"
+    }
+
     /**
      * Append the host to the path.  For example, foo/bar could become
      * foo/bar/dev.coder.com-8080.
diff --git a/src/test/kotlin/com/coder/toolbox/store/CoderSettingsStoreTest.kt b/src/test/kotlin/com/coder/toolbox/store/CoderSettingsStoreTest.kt
@@ -35,15 +35,11 @@ class CoderSettingsStoreTest {
 
     @Test
     fun `Default CLI and signature for Windows AMD64`() =
-        assertBinaryAndSignature("Windows 10", "amd64", "coder-windows-amd64.exe", "coder-windows-amd64.asc")
+        assertBinaryAndSignature("Windows 10", "amd64", "coder-windows-amd64.exe", "coder-windows-amd64.exe.asc")
 
     @Test
     fun `Default CLI and signature for Windows ARM64`() =
-        assertBinaryAndSignature("Windows 10", "aarch64", "coder-windows-arm64.exe", "coder-windows-arm64.asc")
-
-    @Test
-    fun `Default CLI and signature for Windows ARMV7`() =
-        assertBinaryAndSignature("Windows 10", "armv7l", "coder-windows-armv7.exe", "coder-windows-armv7.asc")
+        assertBinaryAndSignature("Windows 10", "aarch64", "coder-windows-arm64.exe", "coder-windows-arm64.exe.asc")
 
     @Test
     fun `Default CLI and signature for Linux AMD64`() =
@@ -65,13 +61,9 @@ class CoderSettingsStoreTest {
     fun `Default CLI and signature for Mac ARM64`() =
         assertBinaryAndSignature("Mac OS X", "aarch64", "coder-darwin-arm64", "coder-darwin-arm64.asc")
 
-    @Test
-    fun `Default CLI and signature for Mac ARMV7`() =
-        assertBinaryAndSignature("Mac OS X", "armv7l", "coder-darwin-armv7", "coder-darwin-armv7.asc")
-
     @Test
     fun `Default CLI and signature for unknown OS and Arch`() =
-        assertBinaryAndSignature(null, null, "coder-windows-amd64.exe", "coder-windows-amd64.asc")
+        assertBinaryAndSignature(null, null, "coder-windows-amd64.exe", "coder-windows-amd64.exe.asc")
 
     @Test
     fun `Default CLI and signature for unknown Arch fallback on Linux`() =

Original file line number	Diff line number	Diff line change
`@@ -277,8 +277,8 @@ class CoderCLIManager(`
`277`	`277`	`}`
`278`	`278`
`279`	`279`	`else -> {`
`280`		`- UnsignedBinaryExecutionDeniedException((result as Failed).error.message)`
`281`		`- val failure = result as DownloadResult.Failed`
	`280`	`+ val failure = result as Failed`
	`281`	`+ UnsignedBinaryExecutionDeniedException(result.error.message)`
`282`	`282`	`context.logger.error(failure.error, "Failed to verify signature for ${cliResult.dst}")`
`283`	`283`	`}`
`284`	`284`	`}`
`@@ -467,7 +467,7 @@ class CoderCLIManager(`
`467`	`467`	`*/`
`468`	`468`	`private fun writeSSHConfig(contents: String?) {`
`469`	`469`	`if (contents != null) {`
`470`		`- if (!context.settingsStore.sshConfigPath.isNullOrBlank()) {`
	`470`	`+ if (context.settingsStore.sshConfigPath.isNotBlank()) {`
`471`	`471`	`val sshConfPath = Path.of(context.settingsStore.sshConfigPath)`
`472`	`472`	`sshConfPath.parent.toFile().mkdirs()`
`473`	`473`	`sshConfPath.toFile().writeText(contents)`
`@@ -492,9 +492,9 @@ class CoderCLIManager(`
`492`	`492`	`throw MissingVersionException("No version found in output")`
`493`	`493`	`}`
`494`	`494`	`return SemVer.parse(json.version)`
`495`		`- } catch (exception: JsonDataException) {`
	`495`	`+ } catch (_: JsonDataException) {`
`496`	`496`	`throw MissingVersionException("No version found in output")`
`497`		`- } catch (exception: EOFException) {`
	`497`	`+ } catch (_: EOFException) {`
`498`	`498`	`throw MissingVersionException("No version found in output")`
`499`	`499`	`}`
`500`	`500`	`}`
`@@ -532,7 +532,7 @@ class CoderCLIManager(`
`532`	`532`	`val buildVersion =`
`533`	`533`	`try {`
`534`	`534`	`SemVer.parse(rawBuildVersion)`
`535`		`- } catch (e: InvalidVersionException) {`
	`535`	`+ } catch (_: InvalidVersionException) {`
`536`	`536`	`context.logger.info("Got invalid build version: $rawBuildVersion")`
`537`	`537`	`return null`
`538`	`538`	`}`