Merge pull request #236 from kevinbarbour/feat/clientKeyFile

Add client SFTP Key file support and fix docs

Author: adamdecaf

docs/config.md

@@ -244,7 +244,8 @@ ACHGateway:
         Hostname: <host>
         Username: <string>
         [ Password: <secret> ]
-        [ ClientPrivateKey: <filename> ]
+        [ ClientPrivateKey: <string> ]
+        [ ClientPrivateKeyFile: <filename> ]
         [ HostPublicKey: <filename> ]
         [ DialTimeout: <duration> | default = 10s ]
         [ MaxConnectionsPerFile: <number> | default = 1 ]

internal/service/model_upload.go

@@ -136,9 +136,10 @@ type SFTP struct {
 	Hostname string
 	Username string
 
-	Password         string
-	ClientPrivateKey string
-	HostPublicKey    string
+	Password             string
+	ClientPrivateKey     string
+	ClientPrivateKeyFile string
+	HostPublicKey        string
 
 	DialTimeout           time.Duration
 	MaxConnectionsPerFile int
@@ -154,9 +155,10 @@ func (cfg *SFTP) MarshalJSON() ([]byte, error) {
 		Hostname string
 		Username string
 
-		Password         string
-		ClientPrivateKey string
-		HostPublicKey    string
+		Password             string
+		ClientPrivateKey     string
+		ClientPrivateKeyFile string
+		HostPublicKey        string
 
 		DialTimeout           time.Duration
 		MaxConnectionsPerFile int
@@ -168,9 +170,10 @@ func (cfg *SFTP) MarshalJSON() ([]byte, error) {
 		Hostname: cfg.Hostname,
 		Username: cfg.Username,
 
-		Password:         mask.Password(cfg.Password),
-		ClientPrivateKey: cfg.ClientPrivateKey,
-		HostPublicKey:    cfg.HostPublicKey,
+		Password:             mask.Password(cfg.Password),
+		ClientPrivateKey:     cfg.ClientPrivateKey,
+		ClientPrivateKeyFile: cfg.ClientPrivateKeyFile,
+		HostPublicKey:        cfg.HostPublicKey,
 
 		DialTimeout:           cfg.DialTimeout,
 		MaxConnectionsPerFile: cfg.MaxConnectionsPerFile,
@@ -207,6 +210,7 @@ func (cfg *SFTP) String() string {
 	buf.WriteString(fmt.Sprintf("Username=%s, ", cfg.Username))
 	buf.WriteString(fmt.Sprintf("Password=%s, ", mask.Password(cfg.Password)))
 	buf.WriteString(fmt.Sprintf("ClientPrivateKey:%v, ", cfg.ClientPrivateKey != ""))
+	buf.WriteString(fmt.Sprintf("ClientPrivateKeyFile:%v, ", cfg.ClientPrivateKeyFile != ""))
 	buf.WriteString(fmt.Sprintf("HostPublicKey:%v}, ", cfg.HostPublicKey != ""))
 	return buf.String()
 }

internal/upload/sftp.go

@@ -8,6 +8,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"os"
 	"path/filepath"
 	"strings"
 
@@ -34,12 +35,22 @@ func newSFTPTransferAgent(logger log.Logger, cfg *service.UploadAgent) (*SFTPTra
 		return nil, fmt.Errorf("sftp: %s is not whitelisted: %v", cfg.SFTP.Hostname, err)
 	}
 
+	clientPrivateKey := cfg.SFTP.ClientPrivateKey
+
+	if clientPrivateKey == "" && cfg.SFTP.ClientPrivateKeyFile != "" {
+		key, err := os.ReadFile(cfg.SFTP.ClientPrivateKeyFile)
+		if err != nil {
+			return nil, fmt.Errorf("sftp: unable to read private key file %s: %v", cfg.SFTP.ClientPrivateKeyFile, err)
+		}
+		clientPrivateKey = string(key)
+	}
+
 	client, err := go_sftp.NewClient(logger, &go_sftp.ClientConfig{
 		Hostname: cfg.SFTP.Hostname,
 		Username: cfg.SFTP.Username,
 		Password: cfg.SFTP.Password,
 
-		ClientPrivateKey: cfg.SFTP.ClientPrivateKey,
+		ClientPrivateKey: clientPrivateKey,
 		HostPublicKey:    cfg.SFTP.HostPublicKey,
 
 		Timeout:        cfg.SFTP.DialTimeout,