Skip to content
This repository was archived by the owner on Aug 30, 2024. It is now read-only.

fix: Escape shell arguments #227

Merged
merged 1 commit into from
Jan 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion internal/cmd/shell.go
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,46 @@ coder sh front-end-dev cat ~/config.json`,
}
}

// shellEscape escapes an argument so that we can pass it 'sh -c'
// and have it do the right thing.
//
// Use this to ensure that the result of a command running in
// the development environment behaves the same as the command
// running via "coder sh".
//
// For example:
//
// $ coder sh env
// $ go run ~/test.go 1 2 "3 4" '"abc def" \\abc' 5 6 "7 8 9"
//
// should produce the same output as:
//
// $ coder sh go run ~/test.go 1 2 "3 4" '"abc def" \\abc' 5 6 "7 8 9"
func shellEscape(arg string) string {
r := strings.NewReplacer(`\`, `\\`, `"`, `\"`, `'`, `\'`, ` `, `\ `)
return r.Replace(arg)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think eventually we should be relying on shlex (or similar) to be parsing and escaping shell commands from strings into arg arrays, and avoid rolling our own for things like this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tychoish Agree, I did a quick search bit didn't find any good ones. Happy to switch over now, or we can do it later, WDYT?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/google/shlex is functional.

I think this might also solve the %q question in the other PR

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tychoish Oh yeah, that looks much better. Looks like there were a few cases that I missed.

I don't think this will work for #226 because we need the shell to interpret the subshell calls for getent/etc, but I will give it a try

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm it looks like shlex is for parsing shell expressions, how do I use it to escape things?

}

func shell(cmd *cobra.Command, cmdArgs []string) error {
ctx := cmd.Context()

var command string
var args []string
if len(cmdArgs) > 1 {
var escapedArgs strings.Builder

for i, arg := range cmdArgs[1:] {
escapedArgs.WriteString(shellEscape(arg))

// Add spaces between arguments, except the last argument
if i < len(cmdArgs)-2 {
escapedArgs.WriteByte(' ')
}
}

command = "/bin/sh"
args = []string{"-c"}
args = append(args, strings.Join(cmdArgs[1:], " "))
args = append(args, escapedArgs.String())
} else {
// Bring user into shell if no command is specified.
shell := "$(getent passwd $(id -u) | cut -d: -f 7)"
Expand Down
41 changes: 41 additions & 0 deletions internal/cmd/shell_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
package cmd

import "testing"

func TestShellEscape(t *testing.T) {
t.Parallel()

tests := []struct {
Name string
Input string
Escaped string
}{
{
Name: "single space",
Input: "hello world",
Escaped: `hello\ world`,
},
{
Name: "multiple spaces",
Input: "test message hello world",
Escaped: `test\ message\ hello\ \ world`,
},
{
Name: "mixed quotes",
Input: `"''"`,
Escaped: `\"\'\'\"`,
},
{
Name: "mixed escaped quotes",
Input: `"'\"\"'"`,
Escaped: `\"\'\\\"\\\"\'\"`,
},
}

for _, test := range tests {
if e, a := test.Escaped, shellEscape(test.Input); e != a {
t.Fatalf("test %q failed; expected: %q, got %q (input: %q)",
test.Name, test.Escaped, a, test.Input)
}
}
}