impl: support for ssh wildcard config

- resolves #46
- it is configurable in the Coder's plugin setting page

Author: fioan89

src/main/kotlin/com/coder/toolbox/cli/CoderCLIManager.kt

@@ -112,6 +112,7 @@ fun ensureCLI(
 data class Features(
     val disableAutostart: Boolean = false,
     val reportWorkspaceUsage: Boolean = false,
+    val wildcardSsh: Boolean = false,
 )
 
 /**
@@ -282,7 +283,37 @@ class CoderCLIManager(
             } else {
                 ""
             }
-        val blockContent =
+        val options = """
+            ConnectTimeout 0
+            StrictHostKeyChecking no
+            UserKnownHostsFile /dev/null
+            LogLevel ERROR
+            SetEnv CODER_SSH_SESSION_TYPE=JetBrains
+        """.trimIndent()
+
+        val blockContent = if (settings.isSshWildcardConfigEnabled && feats.wildcardSsh) {
+            startBlock + System.lineSeparator() +
+                    """
+                    Host ${getWildcardHost(deploymentURL)}--*
+                      ProxyCommand ${proxyArgs.joinToString(" ")} --ssh-host-prefix ${getWildcardHost(deploymentURL)}-- %h
+                    """.trimIndent()
+                        .plus("\n" + options.prependIndent("  "))
+                        .plus(extraConfig)
+                        .plus("\n\n")
+                        .plus(
+                            """
+                            Host ${getWildcardHost(deploymentURL)}-bg--*
+                              ProxyCommand ${backgroundProxyArgs.joinToString(" ")} --ssh-host-prefix ${
+                                getWildcardHost(
+                                    deploymentURL
+                                )
+                            }-bg-- %h
+                            """.trimIndent()
+                                .plus("\n" + options.prependIndent("  "))
+                                .plus(extraConfig),
+                        ).replace("\n", System.lineSeparator()) +
+                    System.lineSeparator() + endBlock
+        } else {
             workspaceNames.joinToString(
                 System.lineSeparator(),
                 startBlock + System.lineSeparator(),
@@ -291,28 +322,21 @@ class CoderCLIManager(
                     """
                     Host ${getHostName(deploymentURL, it)}
                       ProxyCommand ${proxyArgs.joinToString(" ")} $it
-                      ConnectTimeout 0
-                      StrictHostKeyChecking no
-                      UserKnownHostsFile /dev/null
-                      LogLevel ERROR
-                      SetEnv CODER_SSH_SESSION_TYPE=JetBrains
                     """.trimIndent()
+                        .plus("\n" + options.prependIndent("  "))
                         .plus(extraConfig)
                         .plus("\n")
                         .plus(
                             """
                             Host ${getBackgroundHostName(deploymentURL, it)}
                               ProxyCommand ${backgroundProxyArgs.joinToString(" ")} $it
-                              ConnectTimeout 0
-                              StrictHostKeyChecking no
-                              UserKnownHostsFile /dev/null
-                              LogLevel ERROR
-                              SetEnv CODER_SSH_SESSION_TYPE=JetBrains
                             """.trimIndent()
+                                .plus("\n" + options.prependIndent("  "))
                                 .plus(extraConfig),
                         ).replace("\n", System.lineSeparator())
                 },
             )
+        }
 
         if (contents == null) {
             logger.info("No existing SSH config to modify")
@@ -475,13 +499,16 @@ class CoderCLIManager(
                 Features(
                     disableAutostart = version >= SemVer(2, 5, 0),
                     reportWorkspaceUsage = version >= SemVer(2, 13, 0),
+                    version >= SemVer(2, 19, 0),
                 )
             }
         }
 
     companion object {
         private val tokenRegex = "--token [^ ]+".toRegex()
 
+        fun getWildcardHost(url: URL): String = "coder-jetbrains-toolbox--${url.safeHost()}"
+
         @JvmStatic
         fun getHostName(
             url: URL,

src/main/kotlin/com/coder/toolbox/settings/CoderSettings.kt

@@ -86,6 +86,8 @@ data class CoderSettings(
      */
     val disableAutostart: Boolean,
 
+    val isSshWildcardConfigEnabled: Boolean,
+
     /**
      * The location of the SSH config.  Defaults to ~/.ssh/config.
      */

src/main/kotlin/com/coder/toolbox/store/CoderSettingsStore.kt

@@ -37,7 +37,7 @@ class CoderSettingsStore(
             altHostname = store[TLS_ALTERNATE_HOSTNAME]
         ),
         disableAutostart = store[DISABLE_AUTOSTART]?.toBooleanStrictOrNull() ?: (getOS() == OS.MAC),
-
+        isSshWildcardConfigEnabled = store[ENABLE_SSH_WILDCARD_CONFIG]?.toBooleanStrictOrNull() ?: false,
         sshConfigPath = store[SSH_CONFIG_PATH].takeUnless { it.isNullOrEmpty() }
             ?: Path.of(System.getProperty("user.home")).resolve(".ssh/config").normalize().toString(),
         sshLogDirectory = store[SSH_LOG_DIR],
@@ -124,6 +124,11 @@ class CoderSettingsStore(
         store[DISABLE_AUTOSTART] = shouldDisableAutostart.toString()
     }
 
+    fun updateEnableSshWildcardConfig(enable: Boolean) {
+        backingSettings = backingSettings.copy(isSshWildcardConfigEnabled = enable)
+        store[ENABLE_SSH_WILDCARD_CONFIG] = enable.toString()
+    }
+
     fun updateSshLogDir(path: String) {
         backingSettings = backingSettings.copy(sshLogDirectory = path)
         store[SSH_LOG_DIR] = path

src/main/kotlin/com/coder/toolbox/store/StoreKeys.kt

@@ -30,6 +30,8 @@ internal const val TLS_ALTERNATE_HOSTNAME = "tlsAlternateHostname"
 
 internal const val DISABLE_AUTOSTART = "disableAutostart"
 
+internal const val ENABLE_SSH_WILDCARD_CONFIG = "enableSshWildcardConfig"
+
 internal const val SSH_CONFIG_PATH = "sshConfigPath"
 
 internal const val SSH_LOG_DIR = "sshLogDir"

src/main/kotlin/com/coder/toolbox/views/CoderSettingsPage.kt

@@ -45,6 +45,9 @@ class CoderSettingsPage(context: CoderToolboxContext) : CoderPage(context, conte
         TextField(context.i18n.ptrl("TLS alternate hostname"), settings.tls.altHostname ?: "", TextType.General)
     private val disableAutostartField =
         CheckboxField(settings.disableAutostart, context.i18n.ptrl("Disable autostart"))
+
+    private val enableSshWildCardConfig =
+        CheckboxField(settings.isSshWildcardConfigEnabled, context.i18n.ptrl("Enable SSH wildcard config"))
     private val sshExtraArgs =
         TextField(context.i18n.ptrl("Extra SSH options"), settings.sshConfigOptions ?: "", TextType.General)
     private val sshLogDirField =
@@ -64,6 +67,7 @@ class CoderSettingsPage(context: CoderToolboxContext) : CoderPage(context, conte
             tlsCAPathField,
             tlsAlternateHostnameField,
             disableAutostartField,
+            enableSshWildCardConfig,
             sshLogDirField,
             sshExtraArgs,
         )
@@ -83,6 +87,7 @@ class CoderSettingsPage(context: CoderToolboxContext) : CoderPage(context, conte
                 context.settingsStore.updateCAPath(tlsCAPathField.textState.value)
                 context.settingsStore.updateAltHostname(tlsAlternateHostnameField.textState.value)
                 context.settingsStore.updateDisableAutostart(disableAutostartField.checkedState.value)
+                context.settingsStore.updateEnableSshWildcardConfig(enableSshWildCardConfig.checkedState.value)
                 context.settingsStore.updateSshLogDir(sshLogDirField.textState.value)
                 context.settingsStore.updateSshConfigOptions(sshExtraArgs.textState.value)
             }