lib

Documentation

Index

• func GoConnect(ctx context.Context, sshParams params.SSHParams, terminal bool, ...) error
• func GoConnectAuth(ctx context.Context, sshParams params.SSHParams, terminal bool, ...) error
• func NativeConnect(ctx context.Context, sshParams params.SSHParams, terminal, verbose bool, ...) error
• func SFTPClient(gparams params.SSHParams, methods []ssh.AuthMethod, l *zap.SugaredLogger) (*sftp.Client, error)
• func SFTPGet(ctx context.Context, srcs []string, gparams params.SSHParams, ...) error
• func SFTPGetAuth(ctx context.Context, srcs []string, gparams params.SSHParams, ...) error
• func SFTPList(ctx context.Context, gparams params.SSHParams, ...) error
• func SFTPListAuth(ctx context.Context, gparams params.SSHParams, auth []ssh.AuthMethod, ...) error
• func SFTPPut(ctx context.Context, sources []Source, remotePath string, ...) error
• func SFTPPutAuth(ctx context.Context, sources []Source, remotePath string, ...) error
• func ScpGet(ctx context.Context, srcs []string, gparams params.SSHParams, ...) error
• func ScpGetAuth(ctx context.Context, srcs []string, gparams params.SSHParams, ...) error
• func ScpPut(ctx context.Context, sources []Source, remotePath string, ...) error
• func ScpPutAuth(ctx context.Context, sources []Source, remotePath string, ...) error
• type Callback
• type Source
  • func MakeSource(filename string) (Source, error)
• type UploadDirSource
  • func (s *UploadDirSource) Close() error
  • func (s *UploadDirSource) IsSource()
• type UploadFileSource
  • func (s *UploadFileSource) Close() error
  • func (s *UploadFileSource) IsSource()

Functions

func GoConnect

func GoConnect(ctx context.Context, sshParams params.SSHParams, terminal bool, privkey, cert *memguard.LockedBuffer, env map[string]string, l *zap.SugaredLogger) error

func GoConnectAuth

func GoConnectAuth(ctx context.Context, sshParams params.SSHParams, terminal bool, auth []ssh.AuthMethod, env map[string]string, l *zap.SugaredLogger) error

func NativeConnect

func NativeConnect(ctx context.Context, sshParams params.SSHParams, terminal, verbose bool, priv *memguard.LockedBuffer, pub *crypto.PublicKey, cert *memguard.LockedBuffer, env map[string]string, l *zap.SugaredLogger) error

func SFTPClient

func SFTPClient(gparams params.SSHParams, methods []ssh.AuthMethod, l *zap.SugaredLogger) (*sftp.Client, error)

func SFTPGet

func SFTPGet(ctx context.Context, srcs []string, gparams params.SSHParams, privkey, cert *memguard.LockedBuffer, cb Callback, l *zap.SugaredLogger) error

func SFTPGetAuth

func SFTPGetAuth(ctx context.Context, srcs []string, gparams params.SSHParams, auth []ssh.AuthMethod, cb Callback, l *zap.SugaredLogger) error

func SFTPList

func SFTPList(ctx context.Context, gparams params.SSHParams, privkey, cert *memguard.LockedBuffer, l *zap.SugaredLogger, cb remoteops.ListCallback) error

func SFTPListAuth

func SFTPListAuth(ctx context.Context, gparams params.SSHParams, auth []ssh.AuthMethod, l *zap.SugaredLogger, cb remoteops.ListCallback) error

func SFTPPut

func SFTPPut(ctx context.Context, sources []Source, remotePath string, gparams params.SSHParams, privkey, cert *memguard.LockedBuffer, l *zap.SugaredLogger) error

func SFTPPutAuth

func SFTPPutAuth(ctx context.Context, sources []Source, remotePath string, gparams params.SSHParams, auth []ssh.AuthMethod, l *zap.SugaredLogger) error

func ScpGet

func ScpGet(ctx context.Context, srcs []string, gparams params.SSHParams, privkey, cert *memguard.LockedBuffer, cb Callback, l *zap.SugaredLogger) error

func ScpGetAuth

func ScpGetAuth(ctx context.Context, srcs []string, gparams params.SSHParams, auth []ssh.AuthMethod, cb Callback, l *zap.SugaredLogger) error

func ScpPut

func ScpPut(ctx context.Context, sources []Source, remotePath string, gparams params.SSHParams, privkey, cert *memguard.LockedBuffer, l *zap.SugaredLogger) error

func ScpPutAuth

func ScpPutAuth(ctx context.Context, sources []Source, remotePath string, gparams params.SSHParams, auth []ssh.AuthMethod, l *zap.SugaredLogger) error

Types

type Callback

type Callback func(isDir, endOfDir bool, name string, perms os.FileMode, mtime, atime time.Time, content io.Reader) error

Callback is a function type that is used by ScpGet to return the remote SSH directories and files.

type Source

type Source interface {
	IsSource()
	Close() error
}

func MakeSource

func MakeSource(filename string) (Source, error)

TODO: support globs

type UploadDirSource

type UploadDirSource struct {
	Path string
}

func (*UploadDirSource) Close

func (s *UploadDirSource) Close() error

func (*UploadDirSource) IsSource

func (s *UploadDirSource) IsSource()

type UploadFileSource

type UploadFileSource struct {
	Name        string
	Reader      io.Reader
	Size        int64
	Permissions os.FileMode
	CloseFunc   func() error
}

func (*UploadFileSource) Close

func (s *UploadFileSource) Close() error

func (*UploadFileSource) IsSource

func (s *UploadFileSource) IsSource()