Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

When using a subshell, add some help messages to minimise confusion and improve DX #1136

Merged
merged 1 commit into from
Feb 16, 2023
Merged

When using a subshell, add some help messages to minimise confusion and improve DX #1136

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 28 additions & 8 deletions cli/exec.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,6 @@ func ConfigureExecCommand(app *kingpin.Application, a *AwsVault) {
StringVar(&input.ProfileName)

cmd.Arg("cmd", "Command to execute, defaults to $SHELL").
Default(os.Getenv("SHELL")).
StringVar(&input.Command)

cmd.Arg("args", "Command arguments").
Expand Down Expand Up @@ -200,14 +199,15 @@ func updateEnvForAwsVault(env environ, profileName string, region string) enviro
}

func execEc2Server(input ExecCommandInput, config *vault.Config, credsProvider aws.CredentialsProvider) error {
fmt.Fprintf(os.Stderr, "aws-vault: Starting an EC2 credential server.\n")
if err := server.StartEc2CredentialsServer(context.TODO(), credsProvider, config.Region); err != nil {
return fmt.Errorf("Failed to start credential server: %w", err)
}

env := environ(os.Environ())
env = updateEnvForAwsVault(env, input.ProfileName, config.Region)

return execCmd(input.Command, input.Args, env)
return doRunCmd(input.Command, input.Args, env)
}

func execEcsServer(input ExecCommandInput, config *vault.Config, credsProvider aws.CredentialsProvider) error {
Expand All @@ -228,7 +228,9 @@ func execEcsServer(input ExecCommandInput, config *vault.Config, credsProvider a
env.Set("AWS_CONTAINER_CREDENTIALS_FULL_URI", ecsServer.BaseURL())
env.Set("AWS_CONTAINER_AUTHORIZATION_TOKEN", ecsServer.AuthToken())

return execCmd(input.Command, input.Args, env)
fmt.Fprintf(os.Stderr, "aws-vault: Starting an ECS credential server; your app's AWS sdk must support AWS_CONTAINER_CREDENTIALS_FULL_URI.\n")

return doRunCmd(input.Command, input.Args, env)
}

func execCredentialHelper(input ExecCommandInput, credsProvider aws.CredentialsProvider) error {
Expand Down Expand Up @@ -293,10 +295,10 @@ func execEnvironment(input ExecCommandInput, config *vault.Config, credsProvider
}

if !supportsExecSyscall() {
return execCmd(input.Command, input.Args, env)
return doRunCmd(input.Command, input.Args, env)
}

return execSyscall(input.Command, input.Args, env)
return doExecSyscall(input.Command, input.Args, env)
}

// environ is a slice of strings representing the environment, in the form "key=value".
Expand All @@ -319,8 +321,21 @@ func (e *environ) Set(key, val string) {
*e = append(*e, key+"="+val)
}

func execCmd(command string, args []string, env []string) error {
log.Printf("Starting child process: %s %s", command, strings.Join(args, " "))
func getDefaultShell() string {
command := os.Getenv("SHELL")
if command == "" {
command = "/bin/sh"
}
return command
}

func doRunCmd(command string, args []string, env []string) error {
if command == "" {
command = getDefaultShell()
fmt.Fprintf(os.Stderr, "aws-vault: Starting a subshell %s\n", command)
}

log.Printf("Starting subprocess: %s %s", command, strings.Join(args, " "))

cmd := osexec.Command(command, args...)
cmd.Stdin = os.Stdin
Expand Down Expand Up @@ -356,7 +371,12 @@ func supportsExecSyscall() bool {
return runtime.GOOS == "linux" || runtime.GOOS == "darwin" || runtime.GOOS == "freebsd" || runtime.GOOS == "openbsd"
}

func execSyscall(command string, args []string, env []string) error {
func doExecSyscall(command string, args []string, env []string) error {
if command == "" {
command = getDefaultShell()
fmt.Fprintf(os.Stderr, "aws-vault: Starting a subshell %s\n", command)
}

log.Printf("Exec command %s %s", command, strings.Join(args, " "))

argv0, err := osexec.LookPath(command)
Expand Down