fix: Use smarter quoting for ProxyCommand in config-ssh #3755
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
johnstcn
reviewed
Aug 30, 2022
cli/configssh.go
Outdated
Comment on lines
530
to
547
| func sshConfigExecEscape(path string) (string, error) { | ||
| // This is unlikely to ever happen, but newlines are allowed on | ||
| // certain filesystems, but cannot be used inside ssh config. | ||
| if strings.ContainsAny(path, "\n") { | ||
| return "", xerrors.Errorf("invalid path: %s", path) | ||
| } | ||
| // In the unlikely even that a path contains quotes, they must be | ||
| // escaped so that they are not interpreted as shell quotes. | ||
| if strings.Contains(path, "\"") { | ||
| path = strings.ReplaceAll(path, "\"", "\\\"") | ||
| } | ||
| // A space or a tab requires quoting, but tabs must not be escaped | ||
| // (\t) since OpenSSH interprets it as a literal \t, not a tab. | ||
| if strings.ContainsAny(path, " \t") { | ||
| path = fmt.Sprintf("\"%s\"", path) | ||
| } | ||
| return path, nil | ||
| } |
There was a problem hiding this comment.
So --- and hear me out here 😳 --- could we test this by creating a hello-world batch or shell script (platform-dependent) under a temp path that contains a space, attempting to execute /bin/bash -c '<path of thing>', and validating that it executes successfully?
There was a problem hiding this comment.
I don't see why not, good idea! In theory, we'd want to test all the shells.. but then again, I think we're unlikely to run into that many edge cases with this unless people do really fringe stuff with their filesystems/folder structures. 😅
There was a problem hiding this comment.
I think testing /bin/sh and/or cmd.exe is all we should do tbh
a5ae539 to
73e6a84
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change takes better into account how OpenSSH executes
ProxyCommands and applies quoting accordingly.This supercedes #3664, which was reverted.
Fixes #2853
Bonus commit:
~/.sshdirectory exists