fix: Avoid double escaping of ProxyCommand on Windows (coder#3664)

mafredri · web-flow · commit 123fe0131eac · 2022-08-24T19:12:40.000+03:00
Fixes coder#2853
diff --git a/cli/configssh.go b/cli/configssh.go
@@ -280,10 +280,16 @@ func configSSH() *cobra.Command {
 						"\tLogLevel ERROR",
 					)
 					if !skipProxyCommand {
+						// In SSH configs, strings inside "" are interpreted literally and there
+						// is no need to e.g. escape backslashes (common on Windows platforms).
+						// We will escape the quotes, though.
+						escapedBinaryFile := strings.ReplaceAll(binaryFile, "\"", "\\\"")
 						if !wireguard {
-							configOptions = append(configOptions, fmt.Sprintf("\tProxyCommand %q --global-config %q ssh --stdio %s", binaryFile, root, hostname))
+							//nolint:gocritic // We don't want to use %q here, see above.
+							configOptions = append(configOptions, fmt.Sprintf("\tProxyCommand \"%s\" --global-config \"%s\" ssh --stdio %s", escapedBinaryFile, root, hostname))
 						} else {
-							configOptions = append(configOptions, fmt.Sprintf("\tProxyCommand %q --global-config %q ssh --wireguard --stdio %s", binaryFile, root, hostname))
+							//nolint:gocritic // We don't want to use %q here, see above.
+							configOptions = append(configOptions, fmt.Sprintf("\tProxyCommand \"%s\" --global-config \"%s\" ssh --wireguard --stdio %s", escapedBinaryFile, root, hostname))
 						}
 					}
 

Original file line number	Diff line number	Diff line change
`@@ -280,10 +280,16 @@ func configSSH() *cobra.Command {`
`280`	`280`	`"\tLogLevel ERROR",`
`281`	`281`	`)`
`282`	`282`	`if !skipProxyCommand {`
	`283`	`+ // In SSH configs, strings inside "" are interpreted literally and there`
	`284`	`+ // is no need to e.g. escape backslashes (common on Windows platforms).`
	`285`	`+ // We will escape the quotes, though.`
	`286`	`+ escapedBinaryFile := strings.ReplaceAll(binaryFile, "\"", "\\\"")`
`283`	`287`	`if !wireguard {`
`284`		`- configOptions = append(configOptions, fmt.Sprintf("\tProxyCommand %q --global-config %q ssh --stdio %s", binaryFile, root, hostname))`
	`288`	`+ //nolint:gocritic // We don't want to use %q here, see above.`
	`289`	`+ configOptions = append(configOptions, fmt.Sprintf("\tProxyCommand \"%s\" --global-config \"%s\" ssh --stdio %s", escapedBinaryFile, root, hostname))`
`285`	`290`	`} else {`
`286`		`- configOptions = append(configOptions, fmt.Sprintf("\tProxyCommand %q --global-config %q ssh --wireguard --stdio %s", binaryFile, root, hostname))`
	`291`	`+ //nolint:gocritic // We don't want to use %q here, see above.`
	`292`	`+ configOptions = append(configOptions, fmt.Sprintf("\tProxyCommand \"%s\" --global-config \"%s\" ssh --wireguard --stdio %s", escapedBinaryFile, root, hostname))`
`287`	`293`	`}`
`288`	`294`	`}`
`289`	`295`