Skip to content

Commit 81eacfb

Browse files
fioan89fioan89
committed
fix: provide the correct ssh host when wildcard ssh config is enabled
- Toolbox calls the Coder environment to get SSH connection information. In this particular case for wildcard SSH connections the hostname is a bit different. - this patch computes the correct hostname depending on whether wildcard ssh config is enabled or not.
1 parent fd860d1 commit 81eacfb

22 files changed

+68
-55
lines changed

‎src/main/kotlin/com/coder/toolbox/CoderRemoteEnvironment.kt‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,12 @@ class CoderRemoteEnvironment(
123123
* have to do is provide it a host name.
124124
*/
125125
override suspend
126-
fun getContentsView(): EnvironmentContentsView = EnvironmentView(client.url, workspace, agent)
126+
fun getContentsView(): EnvironmentContentsView = EnvironmentView(
127+
context.settingsStore.readOnly(),
128+
client.url,
129+
workspace,
130+
agent
131+
)
127132

128133
override val connectionRequest: MutableStateFlow<Boolean>? = MutableStateFlow(false)
129134

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

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ import com.coder.toolbox.CoderToolboxContext
44
import com.coder.toolbox.cli.ex.MissingVersionException
55
import com.coder.toolbox.cli.ex.ResponseException
66
import com.coder.toolbox.cli.ex.SSHConfigFormatException
7+
import com.coder.toolbox.sdk.v2.models.Workspace
8+
import com.coder.toolbox.sdk.v2.models.WorkspaceAgent
79
import com.coder.toolbox.settings.CoderSettings
810
import com.coder.toolbox.util.CoderHostnameVerifier
911
import com.coder.toolbox.util.InvalidVersionException
@@ -294,17 +296,17 @@ class CoderCLIManager(
294296
val blockContent = if (settings.isSshWildcardConfigEnabled && feats.wildcardSsh) {
295297
startBlock + System.lineSeparator() +
296298
"""
297-
Host ${getWildcardHost(deploymentURL)}--*
298-
ProxyCommand ${proxyArgs.joinToString(" ")} --ssh-host-prefix ${getWildcardHost(deploymentURL)}-- %h
299+
Host ${getHostnamePrefix(deploymentURL)}--*
300+
ProxyCommand ${proxyArgs.joinToString(" ")} --ssh-host-prefix ${getHostnamePrefix(deploymentURL)}-- %h
299301
""".trimIndent()
300302
.plus("\n" + options.prependIndent(" "))
301303
.plus(extraConfig)
302304
.plus("\n\n")
303305
.plus(
304306
"""
305-
Host ${getWildcardHost(deploymentURL)}-bg--*
307+
Host ${getHostnamePrefix(deploymentURL)}-bg--*
306308
ProxyCommand ${backgroundProxyArgs.joinToString(" ")} --ssh-host-prefix ${
307-
getWildcardHost(
309+
getHostnamePrefix(
308310
deploymentURL
309311
)
310312
}-bg-- %h
@@ -507,23 +509,22 @@ class CoderCLIManager(
507509
companion object {
508510
private val tokenRegex = "--token [^ ]+".toRegex()
509511

510-
fun getWildcardHost(url: URL): String = "coder-jetbrains-toolbox--${url.safeHost()}"
512+
fun getHostnamePrefix(url: URL): String = "coder-jetbrains-toolbox-${url.safeHost()}"
513+
514+
fun getWildcardHostname(url: URL, workspace: Workspace, agent: WorkspaceAgent): String =
515+
"${getHostnamePrefix(url)}-bg--${workspace.name}.${agent.name}"
516+
517+
fun getHostname(url: URL, workspace: Workspace, agent: WorkspaceAgent) =
518+
getHostName(url, "${workspace.name}.${agent.name}")
511519

512-
@JvmStatic
513520
fun getHostName(
514521
url: URL,
515522
workspaceName: String,
516-
): String = "coder-jetbrains-toolbox--$workspaceName--${url.safeHost()}"
523+
): String = "coder-jetbrains-toolbox-$workspaceName--${url.safeHost()}"
517524

518-
@JvmStatic
519525
fun getBackgroundHostName(
520526
url: URL,
521527
workspaceName: String,
522528
): String = getHostName(url, workspaceName) + "--bg"
523-
524-
@JvmStatic
525-
fun getBackgroundHostName(
526-
hostname: String,
527-
): String = hostname + "--bg"
528529
}
529530
}

‎src/main/kotlin/com/coder/toolbox/views/EnvironmentView.kt‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ package com.coder.toolbox.views
33
import com.coder.toolbox.cli.CoderCLIManager
44
import com.coder.toolbox.sdk.v2.models.Workspace
55
import com.coder.toolbox.sdk.v2.models.WorkspaceAgent
6+
import com.coder.toolbox.settings.CoderSettings
67
import com.jetbrains.toolbox.api.remoteDev.environments.SshEnvironmentContentsView
78
import com.jetbrains.toolbox.api.remoteDev.ssh.SshConnectionInfo
89
import java.net.URL
@@ -16,6 +17,7 @@ import java.net.URL
1617
* SSH must be configured before this will work.
1718
*/
1819
class EnvironmentView(
20+
private val settings: CoderSettings,
1921
private val url: URL,
2022
private val workspace: Workspace,
2123
private val agent: WorkspaceAgent,
@@ -24,7 +26,7 @@ class EnvironmentView(
2426
/**
2527
* The host name generated by the cli manager for this workspace.
2628
*/
27-
override val host: String = CoderCLIManager.getHostName(url, "${workspace.name}.${agent.name}")
29+
override val host: String = resolveHost()
2830

2931
/**
3032
* The port is ignored by the Coder proxy command.
@@ -37,4 +39,9 @@ class EnvironmentView(
3739
override val userName: String? = "coder"
3840

3941
}
42+
43+
private fun resolveHost(): String =
44+
if (settings.isSshWildcardConfigEnabled)
45+
CoderCLIManager.getWildcardHostname(url, workspace, agent)
46+
else CoderCLIManager.getHostname(url, workspace, agent)
4047
}

‎src/test/resources/fixtures/outputs/append-blank-newlines.conf‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33

44

55
# --- START CODER JETBRAINS TOOLBOX test.coder.invalid
6-
Host coder-jetbrains-toolbox--foo-bar--test.coder.invalid
6+
Host coder-jetbrains-toolbox-foo-bar--test.coder.invalid
77
ProxyCommand /tmp/coder-toolbox/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-toolbox/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --usage-app=jetbrains foo-bar
88
ConnectTimeout 0
99
StrictHostKeyChecking no
1010
UserKnownHostsFile /dev/null
1111
LogLevel ERROR
1212
SetEnv CODER_SSH_SESSION_TYPE=JetBrains
13-
Host coder-jetbrains-toolbox--foo-bar--test.coder.invalid--bg
13+
Host coder-jetbrains-toolbox-foo-bar--test.coder.invalid--bg
1414
ProxyCommand /tmp/coder-toolbox/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-toolbox/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --usage-app=disable foo-bar
1515
ConnectTimeout 0
1616
StrictHostKeyChecking no

‎src/test/resources/fixtures/outputs/append-blank.conf‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# --- START CODER JETBRAINS TOOLBOX test.coder.invalid
2-
Host coder-jetbrains-toolbox--foo-bar--test.coder.invalid
2+
Host coder-jetbrains-toolbox-foo-bar--test.coder.invalid
33
ProxyCommand /tmp/coder-toolbox/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-toolbox/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --usage-app=jetbrains foo-bar
44
ConnectTimeout 0
55
StrictHostKeyChecking no
66
UserKnownHostsFile /dev/null
77
LogLevel ERROR
88
SetEnv CODER_SSH_SESSION_TYPE=JetBrains
9-
Host coder-jetbrains-toolbox--foo-bar--test.coder.invalid--bg
9+
Host coder-jetbrains-toolbox-foo-bar--test.coder.invalid--bg
1010
ProxyCommand /tmp/coder-toolbox/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-toolbox/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --usage-app=disable foo-bar
1111
ConnectTimeout 0
1212
StrictHostKeyChecking no

‎src/test/resources/fixtures/outputs/append-no-blocks.conf‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ Host test2
44
Port 443
55

66
# --- START CODER JETBRAINS TOOLBOX test.coder.invalid
7-
Host coder-jetbrains-toolbox--foo-bar--test.coder.invalid
7+
Host coder-jetbrains-toolbox-foo-bar--test.coder.invalid
88
ProxyCommand /tmp/coder-toolbox/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-toolbox/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --usage-app=jetbrains foo-bar
99
ConnectTimeout 0
1010
StrictHostKeyChecking no
1111
UserKnownHostsFile /dev/null
1212
LogLevel ERROR
1313
SetEnv CODER_SSH_SESSION_TYPE=JetBrains
14-
Host coder-jetbrains-toolbox--foo-bar--test.coder.invalid--bg
14+
Host coder-jetbrains-toolbox-foo-bar--test.coder.invalid--bg
1515
ProxyCommand /tmp/coder-toolbox/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-toolbox/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --usage-app=disable foo-bar
1616
ConnectTimeout 0
1717
StrictHostKeyChecking no

‎src/test/resources/fixtures/outputs/append-no-newline.conf‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ Host test
33
Host test2
44
Port 443
55
# --- START CODER JETBRAINS TOOLBOX test.coder.invalid
6-
Host coder-jetbrains-toolbox--foo-bar--test.coder.invalid
6+
Host coder-jetbrains-toolbox-foo-bar--test.coder.invalid
77
ProxyCommand /tmp/coder-toolbox/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-toolbox/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --usage-app=jetbrains foo-bar
88
ConnectTimeout 0
99
StrictHostKeyChecking no
1010
UserKnownHostsFile /dev/null
1111
LogLevel ERROR
1212
SetEnv CODER_SSH_SESSION_TYPE=JetBrains
13-
Host coder-jetbrains-toolbox--foo-bar--test.coder.invalid--bg
13+
Host coder-jetbrains-toolbox-foo-bar--test.coder.invalid--bg
1414
ProxyCommand /tmp/coder-toolbox/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-toolbox/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --usage-app=disable foo-bar
1515
ConnectTimeout 0
1616
StrictHostKeyChecking no

‎src/test/resources/fixtures/outputs/append-no-related-blocks.conf‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ some jetbrains config
1010
# --- END CODER JETBRAINS TOOLBOX test.coder.unrelated
1111

1212
# --- START CODER JETBRAINS TOOLBOX test.coder.invalid
13-
Host coder-jetbrains-toolbox--foo-bar--test.coder.invalid
13+
Host coder-jetbrains-toolbox-foo-bar--test.coder.invalid
1414
ProxyCommand /tmp/coder-toolbox/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-toolbox/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --usage-app=jetbrains foo-bar
1515
ConnectTimeout 0
1616
StrictHostKeyChecking no
1717
UserKnownHostsFile /dev/null
1818
LogLevel ERROR
1919
SetEnv CODER_SSH_SESSION_TYPE=JetBrains
20-
Host coder-jetbrains-toolbox--foo-bar--test.coder.invalid--bg
20+
Host coder-jetbrains-toolbox-foo-bar--test.coder.invalid--bg
2121
ProxyCommand /tmp/coder-toolbox/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-toolbox/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --usage-app=disable foo-bar
2222
ConnectTimeout 0
2323
StrictHostKeyChecking no

‎src/test/resources/fixtures/outputs/disable-autostart.conf‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# --- START CODER JETBRAINS TOOLBOX test.coder.invalid
2-
Host coder-jetbrains-toolbox--foo--test.coder.invalid
2+
Host coder-jetbrains-toolbox-foo--test.coder.invalid
33
ProxyCommand /tmp/coder-toolbox/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-toolbox/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --disable-autostart --usage-app=jetbrains foo
44
ConnectTimeout 0
55
StrictHostKeyChecking no
66
UserKnownHostsFile /dev/null
77
LogLevel ERROR
88
SetEnv CODER_SSH_SESSION_TYPE=JetBrains
9-
Host coder-jetbrains-toolbox--foo--test.coder.invalid--bg
9+
Host coder-jetbrains-toolbox-foo--test.coder.invalid--bg
1010
ProxyCommand /tmp/coder-toolbox/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-toolbox/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --disable-autostart --usage-app=disable foo
1111
ConnectTimeout 0
1212
StrictHostKeyChecking no

‎src/test/resources/fixtures/outputs/extra-config.conf‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# --- START CODER JETBRAINS TOOLBOX test.coder.invalid
2-
Host coder-jetbrains-toolbox--extra--test.coder.invalid
2+
Host coder-jetbrains-toolbox-extra--test.coder.invalid
33
ProxyCommand /tmp/coder-toolbox/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-toolbox/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --usage-app=jetbrains extra
44
ConnectTimeout 0
55
StrictHostKeyChecking no
@@ -8,7 +8,7 @@ Host coder-jetbrains-toolbox--extra--test.coder.invalid
88
SetEnv CODER_SSH_SESSION_TYPE=JetBrains
99
ServerAliveInterval 5
1010
ServerAliveCountMax 3
11-
Host coder-jetbrains-toolbox--extra--test.coder.invalid--bg
11+
Host coder-jetbrains-toolbox-extra--test.coder.invalid--bg
1212
ProxyCommand /tmp/coder-toolbox/test.coder.invalid/coder-linux-amd64 --global-config /tmp/coder-toolbox/test.coder.invalid/config --url https://test.coder.invalid ssh --stdio --usage-app=disable extra
1313
ConnectTimeout 0
1414
StrictHostKeyChecking no

0 commit comments

Comments
 (0)