[v11] Add file transfer support to Connect (#17209)

gravitational · Oct 10, 2022 · 7e300d0 · 7e300d0
1 parent 5dc1f28
commit 7e300d0
Show file tree

Hide file tree

Showing 11 changed files with 1,531 additions and 469 deletions.
diff --git a/lib/client/api.go b/lib/client/api.go
@@ -2335,7 +2335,9 @@ func (tc *TeleportClient) SFTP(ctx context.Context, args []string, port int, opt
 	}
 
 	if !quiet {
-		config.cfg.ProgressWriter = tc.Stdout
+		config.cfg.ProgressWriter = func(fileInfo os.FileInfo) io.Writer {
+			return sftp.NewProgressBar(fileInfo.Size(), fileInfo.Name(), tc.Stdout)
+		}
 	}
 
 	return trace.Wrap(tc.TransferFiles(ctx, config.hostLogin, config.addr, config.cfg))

diff --git a/lib/sshutils/sftp/sftp.go b/lib/sshutils/sftp/sftp.go
@@ -63,9 +63,9 @@ type Config struct {
 	// SSH session
 	getHomeDir homeDirRetriever
 
-	// ProgressWriter is a writer for printing the progress
+	// ProgressWriter is a callback to return a writer for printing the progress
 	// (used only on the client)
-	ProgressWriter io.Writer
+	ProgressWriter func(fileInfo os.FileInfo) io.Writer
 	// Log optionally specifies the logger
 	Log log.FieldLogger
 }
@@ -394,8 +394,7 @@ func (c *Config) transferFile(ctx context.Context, dstPath, srcPath string, srcF
 	}
 	// if a progress writer was set, write file transfer progress
 	if c.ProgressWriter != nil {
-		progressBar := newProgressBar(srcFileInfo.Size(), srcFileInfo.Name(), c.ProgressWriter)
-		writer = io.MultiWriter(canceler, dstFile, progressBar)
+		writer = io.MultiWriter(canceler, dstFile, c.ProgressWriter(srcFileInfo))
 	} else {
 		writer = io.MultiWriter(canceler, dstFile)
 	}
@@ -448,8 +447,8 @@ func (c *cancelWriter) Write(b []byte) (int, error) {
 	return len(b), nil
 }
 
-// newProgressBar returns a new progress bar that writes to writer.
-func newProgressBar(size int64, desc string, writer io.Writer) *progressbar.ProgressBar {
+// NewProgressBar returns a new progress bar that writes to writer.
+func NewProgressBar(size int64, desc string, writer io.Writer) *progressbar.ProgressBar {
 	// this is necessary because progressbar.DefaultBytes doesn't allow
 	// the caller to specify a writer
 	return progressbar.NewOptions64(

diff --git a/lib/teleterm/api/proto/v1/service.proto b/lib/teleterm/api/proto/v1/service.proto
@@ -91,6 +91,8 @@ service TerminalService {
   rpc LoginPasswordless(stream LoginPasswordlessRequest) returns (stream LoginPasswordlessResponse);
   // ClusterLogin logs out a user from cluster
   rpc Logout(LogoutRequest) returns (EmptyResponse);
+  // TransferFile sends a request to download/upload a file
+  rpc TransferFile(FileTransferRequest) returns (stream FileTransferProgress);
 }
 
 // RemoveClusterRequest describes RemoveClusterRequest
@@ -165,6 +167,29 @@ message LoginPasswordlessRequest {
   }
 }
 
+message FileTransferRequest {
+  string cluster_uri = 1;
+  string login = 2;
+  string hostname = 3;
+  // source path of the transferred file
+  string source = 4;
+  // destination path of the transferred file
+  string destination = 5;
+  // indicates whether the file is uploaded/downloaded
+  FileTransferDirection direction = 6;
+}
+
+// FileTransferDirection describes directions of a file transfer
+enum FileTransferDirection {
+  FILE_TRANSFER_DIRECTION_UNSPECIFIED = 0;
+  FILE_TRANSFER_DIRECTION_DOWNLOAD = 1;
+  FILE_TRANSFER_DIRECTION_UPLOAD = 2;
+}
+
+message FileTransferProgress {
+  uint32 percentage = 1;
+}
+
 // LoginRequest describes cluster login request
 message LoginRequest {
   // cluster_uri is the cluster uri