Escape slashes in header command

code-asher · code-asher · commit 1ceaa48708e6 · 2023-09-22T02:06:28.000-08:00
diff --git a/src/main/kotlin/com/coder/gateway/sdk/CoderCLIManager.kt b/src/main/kotlin/com/coder/gateway/sdk/CoderCLIManager.kt
@@ -195,13 +195,15 @@ class CoderCLIManager @JvmOverloads constructor(
         }
     }
 
+    var escapeRegex = """(["\\])""".toRegex()
+
     /**
      * Escape a command argument by wrapping it in double quotes and escaping
-     * any double quotes in the argument.  For example, echo "test" becomes
-     * "echo \"test\"".
+     * any slashes and double quotes in the argument.  For example, echo "te\st"
+     *  becomes "echo \"te\\st\"".
      */
     private fun escape(s: String): String {
-        return "\"" + s.replace("\"", "\\\"") + "\""
+        return "\"" + s.replace(escapeRegex, """\\$1""") + "\""
     }
 
     /**
diff --git a/src/test/fixtures/outputs/header-command-windows.conf b/src/test/fixtures/outputs/header-command-windows.conf
@@ -0,0 +1,10 @@
+# --- START CODER JETBRAINS test.coder.invalid
+Host coder-jetbrains--header--test.coder.invalid
+  HostName coder.header
+  ProxyCommand "/tmp/coder-gateway/test.coder.invalid/coder-linux-amd64" --global-config "/tmp/coder-gateway/test.coder.invalid/config" --header-command "C:\\Program Files\\My Header Command\\\"also has quotes\"\\HeaderCommand.exe" ssh --stdio header
+  ConnectTimeout 0
+  StrictHostKeyChecking no
+  UserKnownHostsFile /dev/null
+  LogLevel ERROR
+  SetEnv CODER_SSH_SESSION_TYPE=JetBrains
+# --- END CODER JETBRAINS test.coder.invalid
diff --git a/src/test/groovy/CoderCLIManagerTest.groovy b/src/test/groovy/CoderCLIManagerTest.groovy
@@ -424,6 +424,7 @@ class CoderCLIManagerTest extends Specification {
         ["foo-bar"]    | "no-related-blocks"             | "append-no-related-blocks"        | "no-related-blocks" | null
         ["foo-bar"]    | "no-newline"                    | "append-no-newline"               | "no-blocks"         | null
         ["header"]     | null                            | "header-command"                  | "blank"             | "my-header-command \"test\""
+        ["header"]     | null                            | "header-command-windows"          | "blank"             | $/C:\Program Files\My Header Command\"also has quotes"\HeaderCommand.exe/$
     }
 
     def "fails if config is malformed"() {

Original file line number	Diff line number	Diff line change
`@@ -195,13 +195,15 @@ class CoderCLIManager @JvmOverloads constructor(`
`195`	`195`	`}`
`196`	`196`	`}`
`197`	`197`
	`198`	`+ var escapeRegex = """(["\\])""".toRegex()`
	`199`	`+`
`198`	`200`	`/**`
`199`	`201`	`* Escape a command argument by wrapping it in double quotes and escaping`
`200`		`- * any double quotes in the argument. For example, echo "test" becomes`
`201`		`- * "echo \"test\"".`
	`202`	`+ * any slashes and double quotes in the argument. For example, echo "te\st"`
	`203`	`+ * becomes "echo \"te\\st\"".`
`202`	`204`	`*/`
`203`	`205`	`private fun escape(s: String): String {`
`204`		`- return "\"" + s.replace("\"", "\\\"") + "\""`
	`206`	`+ return "\"" + s.replace(escapeRegex, """\\$1""") + "\""`
`205`	`207`	`}`
`206`	`208`
`207`	`209`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -424,6 +424,7 @@ class CoderCLIManagerTest extends Specification {`
`424`	`424`	`["foo-bar"] \| "no-related-blocks" \| "append-no-related-blocks" \| "no-related-blocks" \| null`
`425`	`425`	`["foo-bar"] \| "no-newline" \| "append-no-newline" \| "no-blocks" \| null`
`426`	`426`	`["header"] \| null \| "header-command" \| "blank" \| "my-header-command \"test\""`
	`427`	`+ ["header"] \| null \| "header-command-windows" \| "blank" \| $/C:\Program Files\My Header Command\"also has quotes"\HeaderCommand.exe/$`
`427`	`428`	`}`
`428`	`429`
`429`	`430`	`def "fails if config is malformed"() {`