chore: support Multiline SSH commands interpreted as single lines (#160)

https://github.com/appleboy/ssh-action/issues/75

go.mod

@@ -3,8 +3,9 @@ module github.com/appleboy/drone-ssh
 go 1.14
 
 require (
-	github.com/appleboy/easyssh-proxy v1.3.5
+	github.com/appleboy/easyssh-proxy v1.3.7
 	github.com/joho/godotenv v1.3.0
-	github.com/stretchr/testify v1.3.0
+	github.com/stretchr/testify v1.6.1
 	github.com/urfave/cli v1.22.4
+	golang.org/x/crypto v0.0.0-20200728195943-123391ffb6de
 )

go.sum

@@ -1,10 +1,8 @@
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
 github.com/ScaleFT/sshkeys v0.0.0-20181112160850-82451a803681 h1:JS2rl38kZmHgWa0xINSaSYH0Whtvem64/4+Ef0+Y5pE=
 github.com/ScaleFT/sshkeys v0.0.0-20181112160850-82451a803681/go.mod h1:WfDateMPQ/55dPbZRp5Zxrux5WiEaHsjk9puUhz0KgY=
-github.com/appleboy/easyssh-proxy v1.3.4 h1:yNgzsJ9qaDNGzQILDXEK4boioJMmUUaTUsxYtCTSGqo=
+github.com/appleboy/easyssh-proxy v1.3.7 h1:4XsChI8PuAd6jwTIKvTCH97vWmknvMJGxYi0PLiULG8=
-github.com/appleboy/easyssh-proxy v1.3.4/go.mod h1:Kk57I3w7OCafOjp5kgZFvxk2fO8Tca5CriBTOsbSbjY=
+github.com/appleboy/easyssh-proxy v1.3.7/go.mod h1:Kk57I3w7OCafOjp5kgZFvxk2fO8Tca5CriBTOsbSbjY=
-github.com/appleboy/easyssh-proxy v1.3.5 h1:EGTCbqAVRcGKHQMFSxz30lQmb+0nXL+jUiCrg/FjHQM=
-github.com/appleboy/easyssh-proxy v1.3.5/go.mod h1:Kk57I3w7OCafOjp5kgZFvxk2fO8Tca5CriBTOsbSbjY=
 github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d h1:U+s90UTSYgptZMwQh2aRr3LuazLJIa+Pg3Kc1ylSYVY=
 github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
 github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
@@ -19,18 +17,27 @@ github.com/russross/blackfriday/v2 v2.0.1 h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0
 github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo=
 github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
+github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
+github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/urfave/cli v1.22.4 h1:u7tSpNPPswAFymm8IehJhy4uJMlUuU/GmqSkvJ1InXA=
 github.com/urfave/cli v1.22.4/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60NtXRu0=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20191227163750-53104e6ec876 h1:sKJQZMuxjOAR/Uo2LBfU90onWEf1dF4C+0hPJCc9Mpc=
 golang.org/x/crypto v0.0.0-20191227163750-53104e6ec876/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
+golang.org/x/crypto v0.0.0-20200728195943-123391ffb6de h1:ikNHVSjEfnvz6sxdSPCaPt572qowuyMDMJLLm3Db3ig=
+golang.org/x/crypto v0.0.0-20200728195943-123391ffb6de/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d h1:+R4KGOnez64A81RvjARKc4UT5/tI9ujCIVX+P5KiHuI=
 golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

main.go

@@ -7,7 +7,6 @@ import (
 
 	"github.com/appleboy/easyssh-proxy"
 	"github.com/joho/godotenv"
-	_ "github.com/joho/godotenv/autoload"
 	"github.com/urfave/cli"
 )
 
@@ -19,7 +18,11 @@ func main() {
 	if filename, found := os.LookupEnv("PLUGIN_ENV_FILE"); found {
 		_ = godotenv.Load(filename)
 	}
-	defaultCiphers := cli.StringSlice{"aes128-ctr", "aes192-ctr", "aes256-ctr", "aes128-gcm@openssh.com", "arcfour256", "arcfour128", "aes128-cbc", "3des-cbc"}
+
+	if _, err := os.Stat("/run/drone/env"); err == nil {
+		godotenv.Overload("/run/drone/env")
+	}
+
 	app := cli.NewApp()
 	app.Name = "Drone SSH"
 	app.Usage = "Executing remote ssh commands"
@@ -63,11 +66,15 @@ func main() {
 			Name:   "ciphers",
 			Usage:  "The allowed cipher algorithms. If unspecified then a sensible",
 			EnvVar: "PLUGIN_CIPHERS,SSH_CIPHERS,CIPHERS,INPUT_CIPHERS",
-			Value:  &defaultCiphers,
+		},
+		cli.BoolFlag{
+			Name:   "useInsecureCipher",
+			Usage:  "include more ciphers with use_insecure_cipher",
+			EnvVar: "PLUGIN_USE_INSECURE_CIPHER,SSH_USE_INSECURE_CIPHER,USE_INSECURE_CIPHER,INPUT_USE_INSECURE_CIPHER",
 		},
 		cli.StringFlag{
 			Name:   "fingerprint",
-			Usage:  "fingerprint as unpadded base64 encoded sha256 hash.",
+			Usage:  "fingerprint SHA256 of the host public key, default is to skip verification",
 			EnvVar: "PLUGIN_FINGERPRINT,SSH_FINGERPRINT,FINGERPRINT,INPUT_FINGERPRINT",
 		},
 		cli.StringSliceFlag{
@@ -160,11 +167,15 @@ func main() {
 			Name:   "proxy.ciphers",
 			Usage:  "The allowed cipher algorithms. If unspecified then a sensible",
 			EnvVar: "PLUGIN_PROXY_CIPHERS,SSH_PROXY_CIPHERS,PROXY_CIPHERS,INPUT_PROXY_CIPHERS",
-			Value:  &defaultCiphers,
+		},
+		cli.BoolFlag{
+			Name:   "proxy.useInsecureCipher",
+			Usage:  "include more ciphers with use_insecure_cipher",
+			EnvVar: "PLUGIN_PROXY_USE_INSECURE_CIPHER,SSH_PROXY_USE_INSECURE_CIPHER,PROXY_USE_INSECURE_CIPHER,INPUT_PROXY_USE_INSECURE_CIPHER",
 		},
 		cli.StringFlag{
 			Name:   "proxy.fingerprint",
-			Usage:  "fingerprint as unpadded base64 encoded sha256 hash.",
+			Usage:  "fingerprint SHA256 of the host public key, default is to skip verification",
 			EnvVar: "PLUGIN_PROXY_FINGERPRINT,SSH_PROXY_FINGERPRINT,PROXY_FINGERPRINT,INPUT_PROXY_FINGERPRINT",
 		},
 		cli.StringSliceFlag{
@@ -224,33 +235,35 @@ func run(c *cli.Context) error {
 	}
 	plugin := Plugin{
 		Config: Config{
-			Key:            c.String("ssh-key"),
+			Key:               c.String("ssh-key"),
-			KeyPath:        c.String("key-path"),
+			KeyPath:           c.String("key-path"),
-			Username:       c.String("user"),
+			Username:          c.String("user"),
-			Password:       c.String("password"),
+			Password:          c.String("password"),
-			Passphrase:     c.String("ssh-passphrase"),
+			Passphrase:        c.String("ssh-passphrase"),
-			Fingerprint:    c.String("fingerprint"),
+			Fingerprint:       c.String("fingerprint"),
-			Host:           c.StringSlice("host"),
+			Host:              c.StringSlice("host"),
-			Port:           c.Int("port"),
+			Port:              c.Int("port"),
-			Timeout:        c.Duration("timeout"),
+			Timeout:           c.Duration("timeout"),
-			CommandTimeout: c.Duration("command.timeout"),
+			CommandTimeout:    c.Duration("command.timeout"),
-			Script:         scripts,
+			Script:            scripts,
-			ScriptStop:     c.Bool("script.stop"),
+			ScriptStop:        c.Bool("script.stop"),
-			Envs:           c.StringSlice("envs"),
+			Envs:              c.StringSlice("envs"),
-			Debug:          c.Bool("debug"),
+			Debug:             c.Bool("debug"),
-			Sync:           c.Bool("sync"),
+			Sync:              c.Bool("sync"),
-			Ciphers:        c.StringSlice("ciphers"),
+			Ciphers:           c.StringSlice("ciphers"),
+			UseInsecureCipher: c.Bool("useInsecureCipher"),
 			Proxy: easyssh.DefaultConfig{
-				Key:         c.String("proxy.ssh-key"),
+				Key:               c.String("proxy.ssh-key"),
-				KeyPath:     c.String("proxy.key-path"),
+				KeyPath:           c.String("proxy.key-path"),
-				User:        c.String("proxy.username"),
+				User:              c.String("proxy.username"),
-				Password:    c.String("proxy.password"),
+				Password:          c.String("proxy.password"),
-				Passphrase:  c.String("proxy.ssh-passphrase"),
+				Passphrase:        c.String("proxy.ssh-passphrase"),
-				Fingerprint: c.String("proxy.fingerprint"),
+				Fingerprint:       c.String("proxy.fingerprint"),
-				Server:      c.String("proxy.host"),
+				Server:            c.String("proxy.host"),
-				Port:        c.String("proxy.port"),
+				Port:              c.String("proxy.port"),
-				Timeout:     c.Duration("proxy.timeout"),
+				Timeout:           c.Duration("proxy.timeout"),
-				Ciphers:     c.StringSlice("proxy.ciphers"),
+				Ciphers:           c.StringSlice("proxy.ciphers"),
+				UseInsecureCipher: c.Bool("proxy.useInsecureCipher"),
 			},
 		},
 		Writer: os.Stdout,

plugin.go

@@ -23,23 +23,24 @@ var (
 type (
 	// Config for the plugin.
 	Config struct {
-		Key            string
+		Key               string
-		Passphrase     string
+		Passphrase        string
-		KeyPath        string
+		KeyPath           string
-		Username       string
+		Username          string
-		Password       string
+		Password          string
-		Host           []string
+		Host              []string
-		Port           int
+		Port              int
-		Fingerprint    string
+		Fingerprint       string
-		Timeout        time.Duration
+		Timeout           time.Duration
-		CommandTimeout time.Duration
+		CommandTimeout    time.Duration
-		Script         []string
+		Script            []string
-		ScriptStop     bool
+		ScriptStop        bool
-		Envs           []string
+		Envs              []string
-		Proxy          easyssh.DefaultConfig
+		Proxy             easyssh.DefaultConfig
-		Debug          bool
+		Debug             bool
-		Sync           bool
+		Sync              bool
-		Ciphers        []string
+		Ciphers           []string
+		UseInsecureCipher bool
 	}
 
 	// Plugin structure
@@ -56,27 +57,29 @@ func escapeArg(arg string) string {
 func (p Plugin) exec(host string, wg *sync.WaitGroup, errChannel chan error) {
 	// Create MakeConfig instance with remote username, server address and path to private key.
 	ssh := &easyssh.MakeConfig{
-		Server:      host,
+		Server:            host,
-		User:        p.Config.Username,
+		User:              p.Config.Username,
-		Password:    p.Config.Password,
+		Password:          p.Config.Password,
-		Port:        strconv.Itoa(p.Config.Port),
+		Port:              strconv.Itoa(p.Config.Port),
-		Key:         p.Config.Key,
+		Key:               p.Config.Key,
-		KeyPath:     p.Config.KeyPath,
+		KeyPath:           p.Config.KeyPath,
-		Passphrase:  p.Config.Passphrase,
+		Passphrase:        p.Config.Passphrase,
-		Timeout:     p.Config.Timeout,
+		Timeout:           p.Config.Timeout,
-		Ciphers:     p.Config.Ciphers,
+		Ciphers:           p.Config.Ciphers,
-		Fingerprint: p.Config.Fingerprint,
+		Fingerprint:       p.Config.Fingerprint,
+		UseInsecureCipher: p.Config.UseInsecureCipher,
 		Proxy: easyssh.DefaultConfig{
-			Server:      p.Config.Proxy.Server,
+			Server:            p.Config.Proxy.Server,
-			User:        p.Config.Proxy.User,
+			User:              p.Config.Proxy.User,
-			Password:    p.Config.Proxy.Password,
+			Password:          p.Config.Proxy.Password,
-			Port:        p.Config.Proxy.Port,
+			Port:              p.Config.Proxy.Port,
-			Key:         p.Config.Proxy.Key,
+			Key:               p.Config.Proxy.Key,
-			KeyPath:     p.Config.Proxy.KeyPath,
+			KeyPath:           p.Config.Proxy.KeyPath,
-			Passphrase:  p.Config.Proxy.Passphrase,
+			Passphrase:        p.Config.Proxy.Passphrase,
-			Timeout:     p.Config.Proxy.Timeout,
+			Timeout:           p.Config.Proxy.Timeout,
-			Ciphers:     p.Config.Proxy.Ciphers,
+			Ciphers:           p.Config.Proxy.Ciphers,
-			Fingerprint: p.Config.Proxy.Fingerprint,
+			Fingerprint:       p.Config.Proxy.Fingerprint,
+			UseInsecureCipher: p.Config.Proxy.UseInsecureCipher,
 		},
 	}
 
@@ -204,11 +207,12 @@ func (p Plugin) scriptCommands() []string {
 	commands := make([]string, 0)
 
 	for _, cmd := range scripts {
+		cmd = strings.TrimSpace(cmd)
 		if strings.TrimSpace(cmd) == "" {
 			continue
 		}
 		commands = append(commands, cmd)
-		if p.Config.ScriptStop {
+		if p.Config.ScriptStop && cmd[(len(cmd)-1):] != "\\" {
 			commands = append(commands, "DRONE_SSH_PREV_COMMAND_EXIT_CODE=$? ; if [ $DRONE_SSH_PREV_COMMAND_EXIT_CODE -ne 0 ]; then exit $DRONE_SSH_PREV_COMMAND_EXIT_CODE; fi;")
 		}
 	}

plugin_test.go

@@ -646,6 +646,17 @@ func TestPlugin_scriptCommands(t *testing.T) {
 			},
 			want: []string{"mkdir a", "DRONE_SSH_PREV_COMMAND_EXIT_CODE=$? ; if [ $DRONE_SSH_PREV_COMMAND_EXIT_CODE -ne 0 ]; then exit $DRONE_SSH_PREV_COMMAND_EXIT_CODE; fi;", "mkdir c", "DRONE_SSH_PREV_COMMAND_EXIT_CODE=$? ; if [ $DRONE_SSH_PREV_COMMAND_EXIT_CODE -ne 0 ]; then exit $DRONE_SSH_PREV_COMMAND_EXIT_CODE; fi;", "mkdir b", "DRONE_SSH_PREV_COMMAND_EXIT_CODE=$? ; if [ $DRONE_SSH_PREV_COMMAND_EXIT_CODE -ne 0 ]; then exit $DRONE_SSH_PREV_COMMAND_EXIT_CODE; fi;"},
 		},
+		// See: https://github.com/appleboy/ssh-action/issues/75#issuecomment-668314271
+		{
+			name: "Multiline SSH commands interpreted as single lines",
+			fields: fields{
+				Config: Config{
+					Script:     []string{"ls \\ ", "-lah", "mkdir a"},
+					ScriptStop: true,
+				},
+			},
+			want: []string{"ls \\", "-lah", "DRONE_SSH_PREV_COMMAND_EXIT_CODE=$? ; if [ $DRONE_SSH_PREV_COMMAND_EXIT_CODE -ne 0 ]; then exit $DRONE_SSH_PREV_COMMAND_EXIT_CODE; fi;", "mkdir a", "DRONE_SSH_PREV_COMMAND_EXIT_CODE=$? ; if [ $DRONE_SSH_PREV_COMMAND_EXIT_CODE -ne 0 ]; then exit $DRONE_SSH_PREV_COMMAND_EXIT_CODE; fi;"},
+		},
 		{
 			name: "trim space",
 			fields: fields{
@@ -669,3 +680,38 @@ func TestPlugin_scriptCommands(t *testing.T) {
 		})
 	}
 }
+
+func TestUseInsecureCipher(t *testing.T) {
+	var (
+		buffer   bytes.Buffer
+		expected = `
+			======CMD======
+			mkdir a/b/c
+			mkdir d/e/f
+			======END======
+			err: mkdir: can't create directory 'a/b/c': No such file or directory
+			err: mkdir: can't create directory 'd/e/f': No such file or directory
+		`
+	)
+
+	plugin := Plugin{
+		Config: Config{
+			Host:     []string{"localhost"},
+			Username: "drone-scp",
+			Port:     22,
+			KeyPath:  "./tests/.ssh/id_rsa",
+			Script: []string{
+				"mkdir a/b/c",
+				"mkdir d/e/f",
+			},
+			CommandTimeout:    10 * time.Second,
+			UseInsecureCipher: true,
+		},
+		Writer: &buffer,
+	}
+
+	err := plugin.Exec()
+	assert.NotNil(t, err)
+
+	assert.Equal(t, unindent(expected), unindent(buffer.String()))
+}