properly escape . in host -> ssh conversion (#421)

bcpeinhardt · web-flow · commit b8645dbcf87c · 2025-01-17T15:38:50.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Fix bug where checking for overridden properties incorrectly converted host name pattern to regular expression.
+
 ## [v1.3.9](https://github.com/coder/vscode-coder/releases/tag/v1.3.9) (2024-12-12)
 
 - Only show a login failure dialog for explicit logins (and not autologins).
diff --git a/src/sshSupport.test.ts b/src/sshSupport.test.ts
@@ -68,3 +68,39 @@ Host coder-v?code--*
     ProxyCommand: '/tmp/coder --header="X-BAR=foo" coder.dev',
   })
 })
+
+it("properly escapes meaningful regex characters", () => {
+  const properties = computeSSHProperties(
+    "coder-vscode.dev.coder.com--matalfi--dogfood",
+    `Host *
+  StrictHostKeyChecking yes
+
+# ------------START-CODER-----------
+# This section is managed by coder. DO NOT EDIT.
+#
+# You should not hand-edit this section unless you are removing it, all
+# changes will be lost when running "coder config-ssh".
+#
+Host coder.*
+        StrictHostKeyChecking=no
+        UserKnownHostsFile=/dev/null
+        ProxyCommand /usr/local/bin/coder --global-config "/Users/matifali/Library/Application Support/coderv2" ssh --stdio --ssh-host-prefix coder. %h
+# ------------END-CODER------------
+
+# --- START CODER VSCODE dev.coder.com ---
+Host coder-vscode.dev.coder.com--*
+  StrictHostKeyChecking no
+  UserKnownHostsFile=/dev/null
+  ProxyCommand "/Users/matifali/Library/Application Support/Code/User/globalStorage/coder.coder-remote/dev.coder.com/bin/coder-darwin-arm64" vscodessh --network-info-dir "/Users/matifali/Library/Application Support/Code/User/globalStorage/coder.coder-remote/net" --session-token-file "/Users/matifali/Library/Application Support/Code/User/globalStorage/coder.coder-remote/dev.coder.com/session" --url-file "/Users/matifali/Library/Application Support/Code/User/globalStorage/coder.coder-remote/dev.coder.com/url" %h
+# --- END CODER VSCODE dev.coder.com ---%
+
+`,
+  )
+
+  expect(properties).toEqual({
+    StrictHostKeyChecking: "yes",
+    ProxyCommand:
+      '"/Users/matifali/Library/Application Support/Code/User/globalStorage/coder.coder-remote/dev.coder.com/bin/coder-darwin-arm64" vscodessh --network-info-dir "/Users/matifali/Library/Application Support/Code/User/globalStorage/coder.coder-remote/net" --session-token-file "/Users/matifali/Library/Application Support/Code/User/globalStorage/coder.coder-remote/dev.coder.com/session" --url-file "/Users/matifali/Library/Application Support/Code/User/globalStorage/coder.coder-remote/dev.coder.com/url" %h',
+    UserKnownHostsFile: "/dev/null",
+  })
+})
diff --git a/src/sshSupport.ts b/src/sshSupport.ts
@@ -85,8 +85,11 @@ export function computeSSHProperties(host: string, config: string): Record<strin
     if (!config) {
       return
     }
+
     // In OpenSSH * matches any number of characters and ? matches exactly one.
-    if (!new RegExp("^" + config?.Host.replace(/\*/g, ".*").replace(/\?/g, ".") + "$").test(host)) {
+    if (
+      !new RegExp("^" + config?.Host.replace(/\./g, "\\.").replace(/\*/g, ".*").replace(/\?/g, ".") + "$").test(host)
+    ) {
       return
     }
     Object.assign(merged, config.properties)

Original file line number	Diff line number	Diff line change
`@@ -85,8 +85,11 @@ export function computeSSHProperties(host: string, config: string): Record<strin`
`85`	`85`	`if (!config) {`
`86`	`86`	`return`
`87`	`87`	`}`
	`88`	`+`
`88`	`89`	`// In OpenSSH * matches any number of characters and ? matches exactly one.`
`89`		`- if (!new RegExp("^" + config?.Host.replace(/\/g, ".").replace(/\?/g, ".") + "$").test(host)) {`
	`90`	`+ if (`
	`91`	`+ !new RegExp("^" + config?.Host.replace(/\./g, "\\.").replace(/\/g, ".").replace(/\?/g, ".") + "$").test(host)`
	`92`	`+ ) {`
`90`	`93`	`return`
`91`	`94`	`}`
`92`	`95`	`Object.assign(merged, config.properties)`