Verify rsync protocol version match prior to proceeding.

stephenwithav · stephenwithav · commit f745670a6c04 · 2020-07-01T19:23:22.000-04:00
`sync.Version()` proceeds with a warning that there may be a version
mismatch if it timesout.

`syncCmd.version` assumes rsync is present in the path.

`wsep.RemoteExecer` isn't available publicly on GitHub, so I took a
best guess with it and `wsep.ExitError`.
diff --git a/cmd/coder/sync.go b/cmd/coder/sync.go
@@ -1,7 +1,12 @@
 package main
 
 import (
+	"bufio"
+	"errors"
+	"fmt"
+	"log"
 	"os"
+	"os/exec"
 	"path/filepath"
 	"strings"
 
@@ -29,6 +34,32 @@ func (cmd *syncCmd) RegisterFlags(fl *pflag.FlagSet) {
 	fl.BoolVarP(&cmd.init, "init", "i", false, "do initial transfer and exit")
 }
 
+// See https://lxadm.com/Rsync_exit_codes#List_of_standard_rsync_exit_codes.
+var IncompatRsync = errors.New("rsync: exit status 2")
+var StreamErrRsync = errors.New("rsync: exit status 12")
+
+// Returns local rsync protocol version as a string.
+func (s *syncCmd) version() string {
+	cmd := exec.Command("rsync", "--version")
+	stdout, err := cmd.StdoutPipe()
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	if err := cmd.Start(); err != nil {
+		log.Fatal(err)
+	}
+
+	r := bufio.NewReader(stdout)
+	if err := cmd.Wait(); err != nil {
+		log.Fatal(err)
+	}
+
+	versionString := strings.Split(r.ReadLine(), "protocol version ")
+
+	return versionString[1]
+}
+
 func (cmd *syncCmd) Run(fl *pflag.FlagSet) {
 	var (
 		local  = fl.Arg(0)
@@ -71,6 +102,16 @@ func (cmd *syncCmd) Run(fl *pflag.FlagSet) {
 		LocalDir:  absLocal,
 		Client:    entClient,
 	}
+
+	localVersion := s.version()
+	remoteVersion, rsyncErr := sync.Version()
+
+	if rsyncErr != nil {
+		flog.Info("Unable to determine remote rsync version.  Proceeding cautiously.")
+	} else if localVersion != remoteVersion {
+		flog.Fatal(fmt.Sprintf("rsync protocol mismatch. local is %s; remote is %s.", localVersion, remoteVersion))
+	}
+
 	for err == nil || err == sync.ErrRestartSync {
 		err = s.Run()
 	}
diff --git a/internal/sync/sync.go b/internal/sync/sync.go
@@ -1,6 +1,7 @@
 package sync
 
 import (
+	"bufio"
 	"context"
 	"errors"
 	"fmt"
@@ -10,6 +11,7 @@ import (
 	"os/exec"
 	"path"
 	"path/filepath"
+	"strings"
 	"sync"
 	"sync/atomic"
 	"time"
@@ -261,6 +263,41 @@ const (
 	maxAcceptableDispatch = time.Millisecond * 50
 )
 
+// Returns remote protocol version as a string.
+// Or, an error if one exists.
+func (s Sync) Version() (string, error) {
+	conn, err := s.Client.DialWsep(ctx, s.Env)
+	if err != nil {
+		return "", err
+	}
+	defer conn.Close(websocket.CloseNormalClosure, "")
+
+	ctx, cancel := context.WithTimeout(context.Background(), time.Minute)
+	defer cancel()
+
+	execer := wsep.RemoteExecer(conn)
+	process, err := execer.Start(ctx, wsep.Command{
+		Command: "rsync",
+		Args:    []string{"--version"},
+	})
+	if err != nil {
+		return "", err
+	}
+	r := bufio.NewReader(process.Stdout())
+
+	err = process.Wait()
+	if code, ok := err.(wsep.ExitError); ok {
+		return "", err
+	}
+	if err != nil {
+		return "", err
+	}
+
+	versionString := strings.Split(r.ReadLine(), "protocol version ")
+
+	return versionString[1], nil
+}
+
 // Run starts the sync synchronously.
 // Use this command to debug what wasn't sync'd correctly:
 // rsync -e "coder sh" -nicr ~/Projects/cdr/coder-cli/. ammar:/home/coder/coder-cli/
