sftp

Documentation

Index

• Constants
• func NewSSHClient(config *SSHConfig) (*ssh.Client, error)
• type Client
• type FileManager
  • func NewFileManager(sshClient *ssh.Client) (FileManager, error)
• type SSHConfig

Constants

const (
	// PasswordAuth indicates password-based authentication
	PasswordAuth = "passwordAuth"
	// KeyAuth indicates key-based authentication
	KeyAuth = "keyAuth"
)

Functions

func NewSSHClient

func NewSSHClient(config *SSHConfig) (*ssh.Client, error)

NewSSHClient establishes an SSH connection and returns an SSH client

Types

type Client

type Client interface {
	OpenFile(path string, f int) (io.ReadWriteCloser, error)
	Remove(path string) error
	MkdirAll(path string) error
}

type FileManager

type FileManager interface {
	Upload(localFilePath, remoteDir string) error
	Download(remoteFilePath, localDir string) error
	Delete(remoteFilePath string) error
}

FileManager is an interface for managing files on a remote server

func NewFileManager

func NewFileManager(sshClient *ssh.Client) (FileManager, error)

type SSHConfig

type SSHConfig struct {
	HostName    string
	Port        int
	User        string
	AuthMethod  string
	PrivateKey  string
	Password    string // Password for password-based authentication
	DialTimeout time.Duration
}

SSHConfig represents the configuration for SSH connection