Merge pull request #6 from shazow/cleanup

Cleanup

Author: progrium

README.md

@@ -9,9 +9,12 @@ Usage: ./execd [options] <auth-handler> <exec-handler>
   -d=false: debug mode displays handler output
   -e=false: pass environment to handlers
   -k="": pem file of private keys (read from SSH_PRIVATE_KEYS by default)
+  -h="": host ip to listen on
   -p="22": port to listen on
   -s=false: run exec handler via SHELL
 ```
+
+
 #### auth-handler $user $key
 
  * `$user` argument is the name of the user being used to attempt the connection
@@ -21,12 +24,47 @@ auth-handler is the path to an executable that's used for authenticating incomin
 
 Although auth-handler is required, you can still achieve no-auth open access by providing `/usr/bin/true` as auth-handler.
 
+
 #### exec-handler $command...
 
  * `$command...` arguments is the command line that was specified to run by the SSH client
 
 exec-handler is the path to an executable that's used to execute the command provided by the client. The meaning of that is quite flexible. All of the stdout and stderr is returned to the client, including the exit status. If the client provides stdin, that's passed to the exec-handler. Any environment variables provided by the auth-handler output will be available to exec-handler, as well as `$USER` and `$SSH_ORIGINAL_COMMAND` environment variables.
 
+
+## Examples
+
+**These examples bypass all authentication and allow remote execution, *do not* run this in production.**
+
+Echo server (with accept-all auth):
+
+```
+server$ execd $(which true) $(which echo)
+client$ ssh $SERVER "hello world"
+hello world
+```
+
+Echo host's environment to clients (with accept-all auth):
+
+```
+server$ execd -e $(which true) $(env)
+client$ ssh $SERVER
+USER=root
+HOME=/root
+LANG=en_US.UTF-8
+...
+```
+
+Bash server (with accept-all auth):
+
+```
+server$ execd $(which true) $(which bash)
+client$ ssh $SERVER
+bash-4.3$ echo "this is a bash instance running on the server"
+this is a bash instance running on the server
+```
+
+
 ## Credit / History
 
 It started with [gitreceive](https://github.com/progrium/gitreceive), which was then used in [Dokku](https://github.com/progrium/dokku). Then I made a more generalized version of gitreceive, more similar to execd, called [sshcommand](https://github.com/progrium/sshcommand), which eventually replaced gitreceive in Dokku. When I started work on Flynn, the first projects included [gitreceived](https://github.com/flynn/gitreceived) (a standalone daemon version of gitreceive). This was refined by the Flynn community, namely Jonathan Rudenberg. 
@@ -39,4 +77,4 @@ This project was made possible thanks to [DigitalOcean](http://digitalocean.com)
 
 ## License
 
-BSD
+BSD

execd.go

@@ -7,20 +7,17 @@ import (
 	"errors"
 	"flag"
 	"fmt"
-	"io"
 	"io/ioutil"
 	"log"
 	"net"
 	"os"
 	"os/exec"
 	"path/filepath"
 	"strings"
-	"sync"
 	"syscall"
 
-	"code.google.com/p/go.crypto/ssh"
 	"github.com/flynn/go-shlex"
-	"github.com/kr/pty"
+	"golang.org/x/crypto/ssh"
 )
 
 var host = flag.String("h", "", "host ip to listen on")
@@ -50,64 +47,6 @@ func exitStatus(err error) (exitStatusMsg, error) {
 	return exitStatusMsg{0}, nil
 }
 
-func attachCmd(cmd *exec.Cmd, stdout io.Writer, stderr io.Writer, stdin io.Reader) (*sync.WaitGroup, error) {
-	var wg sync.WaitGroup
-	wg.Add(2)
-
-	if stdin != nil {
-		stdinIn, err := cmd.StdinPipe()
-		if err != nil {
-			return nil, err
-		}
-		go func() {
-			io.Copy(stdinIn, stdin)
-			stdinIn.Close()
-			// FIXME: Do we care that this is not part of the WaitGroup?
-		}()
-	}
-
-	stdoutOut, err := cmd.StdoutPipe()
-	if err != nil {
-		return nil, err
-	}
-	go func() {
-		io.Copy(stdout, stdoutOut)
-		wg.Done()
-	}()
-
-	stderrOut, err := cmd.StderrPipe()
-	if err != nil {
-		return nil, err
-	}
-	go func() {
-		io.Copy(stderr, stderrOut)
-		wg.Done()
-	}()
-
-	return &wg, nil
-}
-
-func attachShell(cmd *exec.Cmd, stdout io.Writer, stdin io.Reader) (*os.File, *sync.WaitGroup, error) {
-	var wg sync.WaitGroup
-	wg.Add(2)
-
-	// Note that pty merges stdout and stderr.
-	cmdPty, err := pty.Start(cmd)
-	if err != nil {
-		return nil, nil, err
-	}
-	go func() {
-		io.Copy(stdout, cmdPty)
-		wg.Done()
-	}()
-	go func() {
-		io.Copy(cmdPty, stdin)
-		wg.Done()
-	}()
-
-	return cmdPty, &wg, nil
-}
-
 func addKey(conf *ssh.ServerConfig, block *pem.Block) (err error) {
 	var key interface{}
 	switch block.Type {
@@ -150,16 +89,13 @@ func parseKeys(conf *ssh.ServerConfig, pemData []byte) error {
 }
 
 func handleAuth(handler []string, conn ssh.ConnMetadata, key ssh.PublicKey) (*ssh.Permissions, error) {
+	var output bytes.Buffer
+
 	keydata := string(bytes.TrimSpace(ssh.MarshalAuthorizedKey(key)))
 	cmd := exec.Command(handler[0], append(handler[1:], conn.User(), keydata)...)
-	var output bytes.Buffer
-	done, err := attachCmd(cmd, &output, &output, nil)
-	if err != nil {
-		return nil, err
-	}
-	err = cmd.Run()
-	done.Wait()
-	status, err := exitStatus(err)
+	cmd.Stdout = &output
+	cmd.Stderr = &output
+	status, err := exitStatus(cmd.Run())
 	if err != nil {
 		return nil, err
 	}
@@ -263,131 +199,3 @@ func handleConn(conn net.Conn, conf *ssh.ServerConfig, execHandler []string) {
 		go handleChannel(sshConn, ch, execHandler)
 	}
 }
-
-func handleChannel(conn *ssh.ServerConn, newChan ssh.NewChannel, execHandler []string) {
-	ch, reqs, err := newChan.Accept()
-	if err != nil {
-		log.Println("newChan.Accept failed:", err)
-		return
-	}
-
-	assert := func(at string, err error) bool {
-		if err != nil {
-			log.Printf("%s failed: %s", at, err)
-			ch.Stderr().Write([]byte("Internal error.\n"))
-			return true
-		}
-		return false
-	}
-
-	var stdout, stderr io.Writer
-	if *debug {
-		stdout = io.MultiWriter(ch, os.Stdout)
-		stderr = io.MultiWriter(ch.Stderr(), os.Stdout)
-	} else {
-		stdout = ch
-		stderr = ch.Stderr()
-	}
-
-	var ptyShell *os.File
-
-	for req := range reqs {
-		switch req.Type {
-		case "exec":
-			defer ch.Close()
-
-			if req.WantReply {
-				req.Reply(true, nil)
-			}
-
-			cmdline := string(req.Payload[4:])
-			var cmd *exec.Cmd
-			if *shell {
-				shellcmd := flag.Arg(1) + " " + cmdline
-				cmd = exec.Command(os.Getenv("SHELL"), "-c", shellcmd)
-			} else {
-				cmdargs, err := shlex.Split(cmdline)
-				if assert("shlex.Split", err) {
-					return
-				}
-				cmd = exec.Command(execHandler[0], append(execHandler[1:], cmdargs...)...)
-			}
-			if *env {
-				cmd.Env = os.Environ()
-			} else {
-				cmd.Env = []string{}
-			}
-			if conn.Permissions != nil {
-				// Using Permissions.Extensions as a way to get state from PublicKeyCallback
-				if conn.Permissions.Extensions["environ"] != "" {
-					cmd.Env = append(cmd.Env, strings.Split(conn.Permissions.Extensions["environ"], "\n")...)
-				}
-				cmd.Env = append(cmd.Env, "USER="+conn.Permissions.Extensions["user"])
-			}
-			cmd.Env = append(cmd.Env, "SSH_ORIGINAL_COMMAND="+cmdline)
-			done, err := attachCmd(cmd, stdout, stderr, ch)
-			if assert("attachCmd", err) {
-				return
-			}
-			if assert("cmd.Start", cmd.Start()) {
-				return
-			}
-			done.Wait()
-			status, err := exitStatus(cmd.Wait())
-			if assert("exitStatus", err) {
-				return
-			}
-			_, err = ch.SendRequest("exit-status", false, ssh.Marshal(&status))
-			assert("sendExit", err)
-			return
-		case "pty-req":
-			width, height, okSize := parsePtyRequest(req.Payload)
-
-			var cmd *exec.Cmd
-			if *shell {
-				cmd = exec.Command(os.Getenv("SHELL"))
-			} else {
-				cmd = exec.Command(execHandler[0], execHandler[1:]...)
-			}
-			if *env {
-				cmd.Env = os.Environ()
-			} else {
-				cmd.Env = []string{}
-			}
-			if conn.Permissions != nil {
-				// Using Permissions.Extensions as a way to get state from PublicKeyCallback
-				if conn.Permissions.Extensions["environ"] != "" {
-					cmd.Env = append(cmd.Env, strings.Split(conn.Permissions.Extensions["environ"], "\n")...)
-				}
-				cmd.Env = append(cmd.Env, "USER="+conn.Permissions.Extensions["user"])
-			}
-			ptyShell, _, err := attachShell(cmd, stdout, ch)
-			if assert("attachShell", err) {
-				ch.Close()
-				return
-			}
-			if okSize {
-				setWinsize(ptyShell.Fd(), width, height)
-				req.Reply(true, nil)
-			}
-
-			go func() {
-				status, err := exitStatus(cmd.Wait())
-				if !assert("exitStatus", err) {
-					_, err := ch.SendRequest("exit-status", false, ssh.Marshal(&status))
-					assert("sendExit", err)
-				}
-				ch.Close()
-			}()
-		case "window-change":
-			width, height, okSize := parsePtyRequest(req.Payload)
-			if okSize {
-				setWinsize(ptyShell.Fd(), width, height)
-			}
-		}
-
-		if req.WantReply {
-			req.Reply(true, nil)
-		}
-	}
-}