sshutils

Nov 29, 2024

Changes in this version

+ var SSHClientConfigTimeout = 3 * time.Second

+ var SSHDialTimeout = 3 * time.Second

+ type MockSFTPClient struct

+ func NewMockSFTPClient() *MockSFTPClient

type MockSSHClient

+ func (m *MockSSHClient) GetClient() *ssh.Client

type MockSSHConfig

+ func (m *MockSSHConfig) GetHost() string

+ func (m *MockSSHConfig) GetPort() int

+ func (m *MockSSHConfig) GetPrivateKeyMaterial() []byte

+ func (m *MockSSHConfig) GetSSHClient() *ssh.Client

+ func (m *MockSSHConfig) GetSSHClienter() SSHClienter

+ func (m *MockSSHConfig) GetSSHDial() SSHDialer

+ func (m *MockSSHConfig) GetUser() string

+ func (m *MockSSHConfig) SetSSHClienter(clienter SSHClienter)

+ func (m *MockSSHConfig) SetSSHDial(dialer SSHDialer)

+ func (m *MockSSHConfig) SetValidateSSHConnection(callback func() error)

type MockSSHDialer

+ func (m *MockSSHDialer) DialContext(ctx context.Context, network, addr string, config *ssh.ClientConfig) (SSHClienter, error)

+ type SFTPClient interface

+ Chmod func(path string, mode os.FileMode) error

+ Close func() error

+ Create func(path string) (SFTPFile, error)

+ MkdirAll func(path string) error

+ type SFTPClientCreator func(client *ssh.Client) (SFTPClient, error)

+ type SFTPFile interface

type SSHClient

+ func (cl *SSHClient) GetClient() *ssh.Client

type SSHClientWrapper

+ func (w *SSHClientWrapper) GetClient() *ssh.Client

type SSHClienter

+ GetClient func() *ssh.Client

type SSHConfig

+ ValidateSSHConnectionFunc func() error

+ func (c *SSHConfig) GetHost() string

+ func (c *SSHConfig) GetPort() int

+ func (c *SSHConfig) GetPrivateKeyMaterial() []byte

+ func (c *SSHConfig) GetSSHClient() *ssh.Client

+ func (c *SSHConfig) GetSSHClienter() SSHClienter

+ func (c *SSHConfig) GetSSHDial() SSHDialer

+ func (c *SSHConfig) GetUser() string

+ func (c *SSHConfig) SetSSHClienter(client SSHClienter)

+ func (c *SSHConfig) SetSSHDial(dialer SSHDialer)

+ func (c *SSHConfig) SetValidateSSHConnection(fn func() error)

type SSHConfiger

+ GetHost func() string

+ GetPort func() int

+ GetPrivateKeyMaterial func() []byte

+ GetSSHClient func() *ssh.Client

+ GetSSHClienter func() SSHClienter

+ GetSSHDial func() SSHDialer

+ GetUser func() string

+ SetSSHClienter func(client SSHClienter)

+ SetSSHDial func(dialer SSHDialer)

+ SetValidateSSHConnection func(func() error)

type SSHDial

+ func (d *SSHDial) DialContext(ctx context.Context, network, addr string, config *ssh.ClientConfig) (SSHClienter, error)

type SSHDialer

+ DialContext func(ctx context.Context, network, addr string, config *ssh.ClientConfig) (SSHClienter, error)

+ type SSHError struct

+ Cmd string

+ Err error

+ Output string

+ func (e *SSHError) Error() string

Oct 16, 2024

Changes in this version

type MockSSHClient

+ func (m *MockSSHClient) IsConnected() bool

type SSHClient

+ func (cl *SSHClient) IsConnected() bool

type SSHClientWrapper

+ func (w *SSHClientWrapper) IsConnected() bool

type SSHClienter

+ IsConnected func() bool

Oct 13, 2024

Changes in this version

+ func ExportRsaPrivateKeyAsPemStr(privkey *rsa.PrivateKey) string

+ func ExportRsaPublicKeyAsPemStr(pubkey *rsa.PublicKey) (string, error)

+ func GenerateRsaKeyPair() (*rsa.PrivateKey, *rsa.PublicKey)

+ func ParseRsaPrivateKeyFromPemStr(privPEM string) (*rsa.PrivateKey, error)

+ func ParseRsaPublicKeyFromPemStr(pubPEM string) (*rsa.PublicKey, error)

Oct 2, 2024

Changes in this version

+ const DefaultRetryCount

+ const DefaultRetryDelay

+ const DefaultSSHPort

+ var MockSSHKeyReader = func(path string) ([]byte, error)

+ var NewSSHConfigFunc = NewSSHConfig

+ var NullCallback = func(int64, int64)

+ var SSHDialerFunc = NewSSHDial

+ var SSHKeyReader = func(path string) ([]byte, error)

+ var SSHRetryAttempts = 5

+ var SSHRetryDelay = 10 * time.Second

+ var SSHTimeOut = 1 * time.Minute

+ var TimeInBetweenSSHRetries = 2 * time.Second

+ func ExtractSSHKeyPaths() (string, string, string, string, error)

+ func GetAggregateSSHTimeout() time.Duration

+ func GetHostKeyCallback(host string) (ssh.HostKeyCallback, error)

+ func GetTypedMockClient(t *testing.T, log *logger.Logger) (*MockSSHClient, SSHConfiger)

+ func NewMockSSHClient(dialer SSHDialer) (*MockSSHClient, SSHConfiger)

+ func ReadPrivateKey(path string) ([]byte, error)

+ func ReadPublicKey(path string) ([]byte, error)

+ func ValidateSSHKeysFromPath(publicKeyPath, privateKeyPath string) error

+ func ValidateSSHPublicKey(key string) error

+ type ExecuteCommandExpectation struct

+ Cmd string

+ CmdMatcher func(string) bool

+ Error error

+ Output interface{}

+ ProgressCallback interface{}

+ Times int

+ type Expectation struct

+ Error error

+ Times int

+ type ExpectedSSHBehavior struct

+ ExecuteCommandExpectations []ExecuteCommandExpectation

+ InstallSystemdServiceExpectation *Expectation

+ PushFileExpectations []PushFileExpectation

+ RestartServiceExpectation *Expectation

+ type MockSSHClient struct

+ Dialer SSHDialer

+ Session SSHSessioner

+ func (m *MockSSHClient) Close() error

+ func (m *MockSSHClient) NewSession() (SSHSessioner, error)

+ func (m *MockSSHClient) PushFile(ctx context.Context, remotePath string, content []byte, executable bool) error

+ type MockSSHConfig struct

+ func NewMockSSHConfigWithBehavior(behavior ExpectedSSHBehavior) *MockSSHConfig

+ func (m *MockSSHConfig) Close() error

+ func (m *MockSSHConfig) Connect() (SSHClienter, error)

+ func (m *MockSSHConfig) ExecuteCommand(ctx context.Context, cmd string) (string, error)

+ func (m *MockSSHConfig) ExecuteCommandWithCallback(ctx context.Context, cmd string, progressCallback func(string)) (string, error)

+ func (m *MockSSHConfig) GetLastOutput() string

+ func (m *MockSSHConfig) InstallSystemdService(ctx context.Context, serviceName string, serviceContent string) error

+ func (m *MockSSHConfig) PushFile(ctx context.Context, dst string, fileContents []byte, executable bool) error

+ func (m *MockSSHConfig) PushFileWithCallback(ctx context.Context, dst string, fileContents []byte, executable bool, ...) error

+ func (m *MockSSHConfig) RestartService(ctx context.Context, serviceName string) error

+ func (m *MockSSHConfig) SetSSHClient(sshclient SSHClienter)

+ func (m *MockSSHConfig) StartService(ctx context.Context, serviceName string) error

+ func (m *MockSSHConfig) WaitForSSH(ctx context.Context, retries int, retryDelay time.Duration) error

+ type MockSSHDialer struct

+ func NewMockSSHDialer() *MockSSHDialer

+ func (m *MockSSHDialer) Dial(network, addr string, config *ssh.ClientConfig) (SSHClienter, error)

+ type MockSSHSession struct

+ func NewMockSSHSession() *MockSSHSession

+ func (m *MockSSHSession) Close() error

+ func (m *MockSSHSession) CombinedOutput(cmd string) ([]byte, error)

+ func (m *MockSSHSession) Run(cmd string) error

+ func (m *MockSSHSession) Start(cmd string) error

+ func (m *MockSSHSession) StderrPipe() (io.Reader, error)

+ func (m *MockSSHSession) StdinPipe() (io.WriteCloser, error)

+ func (m *MockSSHSession) StdoutPipe() (io.Reader, error)

+ func (m *MockSSHSession) Wait() error

+ type MockSessioner interface

+ Close func() error

+ CombinedOutput func(cmd string) ([]byte, error)

+ Run func(cmd string) error

+ Start func(cmd string) error

+ StdinPipe func() (io.WriteCloser, error)

+ Wait func() error

+ type MockWriteCloser struct

+ func (m *MockWriteCloser) Close() error

+ func (m *MockWriteCloser) Write(p []byte) (n int, err error)

+ type PushFileExpectation struct

+ Dst string

+ Error error

+ Executable bool

+ FileContents []byte

+ ProgressCallback interface{}

+ Times int

+ type SFTPClienter interface

+ Close func() error

+ Create func(path string) (io.WriteCloser, error)

+ Open func(path string) (io.ReadCloser, error)

+ type SFTPDialFunc func(conn *ssh.Client) (SFTPClienter, error)

+ type SSHClient struct

+ Client SSHClienter

+ Dialer SSHDialer

+ SSHClientConfig *ssh.ClientConfig

+ func (cl *SSHClient) Close() error

+ func (cl *SSHClient) NewSession() (SSHSessioner, error)

+ type SSHClientWrapper struct

+ func (w *SSHClientWrapper) Close() error

+ func (w *SSHClientWrapper) NewSession() (SSHSessioner, error)

+ type SSHClienter interface

+ Close func() error

+ NewSession func() (SSHSessioner, error)

+ type SSHConfig struct

+ ClientConfig *ssh.ClientConfig

+ Host string

+ InsecureIgnoreHostKey bool

+ Logger *logger.Logger

+ Port int

+ PrivateKeyMaterial []byte

+ SSHClient SSHClienter

+ SSHDial SSHDialer

+ SSHPrivateKeyPath string

+ SSHPrivateKeyReader func(path string) ([]byte, error)

+ SSHPublicKeyReader func(path string) ([]byte, error)

+ Timeout time.Duration

+ User string

+ func (c *SSHConfig) Connect() (SSHClienter, error)

+ func (c *SSHConfig) ExecuteCommand(ctx context.Context, command string) (string, error)

+ func (c *SSHConfig) ExecuteCommandWithCallback(ctx context.Context, command string, callback func(string)) (string, error)

+ func (c *SSHConfig) InstallSystemdService(ctx context.Context, serviceName, serviceContent string) error

+ func (c *SSHConfig) NewSession() (SSHSessioner, error)

+ func (c *SSHConfig) PushFile(ctx context.Context, remotePath string, content []byte, executable bool) error

+ func (c *SSHConfig) PushFileWithCallback(ctx context.Context, remotePath string, content []byte, executable bool, ...) error

+ func (c *SSHConfig) RestartService(ctx context.Context, serviceName string) error

+ func (c *SSHConfig) SetSSHClient(client SSHClienter)

+ func (c *SSHConfig) StartService(ctx context.Context, serviceName string) error

+ func (c *SSHConfig) WaitForSSH(ctx context.Context, retry int, timeout time.Duration) error

+ type SSHConfiger interface

+ Connect func() (SSHClienter, error)

+ ExecuteCommand func(ctx context.Context, command string) (string, error)

+ ExecuteCommandWithCallback func(ctx context.Context, command string, callback func(string)) (string, error)

+ InstallSystemdService func(ctx context.Context, serviceName, serviceContent string) error

+ PushFile func(ctx context.Context, remotePath string, content []byte, executable bool) error

+ PushFileWithCallback func(ctx context.Context, remotePath string, content []byte, executable bool, ...) error

+ RestartService func(ctx context.Context, serviceName string) error

+ SetSSHClient func(client SSHClienter)

+ StartService func(ctx context.Context, serviceName string) error

+ WaitForSSH func(ctx context.Context, retry int, timeout time.Duration) error

+ func NewSSHConfig(host string, port int, user string, sshPrivateKeyPath string) (SSHConfiger, error)

+ type SSHDial struct

+ DialCreator func(network, addr string, config *ssh.ClientConfig) (SSHClienter, error)

+ func (d *SSHDial) Dial(network, addr string, config *ssh.ClientConfig) (SSHClienter, error)

+ type SSHDialer interface

+ Dial func(network, addr string, config *ssh.ClientConfig) (SSHClienter, error)

+ func NewSSHDial(host string, port int, config *ssh.ClientConfig) SSHDialer

+ type SSHSessionWrapper struct

+ Session *ssh.Session

+ func (s *SSHSessionWrapper) Close() error

+ func (s *SSHSessionWrapper) CombinedOutput(cmd string) ([]byte, error)

+ func (s *SSHSessionWrapper) Run(cmd string) error

+ func (s *SSHSessionWrapper) Signal(sig ssh.Signal) error

+ func (s *SSHSessionWrapper) Start(cmd string) error

+ func (s *SSHSessionWrapper) StderrPipe() (io.Reader, error)

+ func (s *SSHSessionWrapper) StdinPipe() (io.WriteCloser, error)

+ func (s *SSHSessionWrapper) StdoutPipe() (io.Reader, error)

+ func (s *SSHSessionWrapper) Wait() error

+ type SSHSessioner interface

+ Close func() error

+ CombinedOutput func(cmd string) ([]byte, error)

+ Run func(cmd string) error

+ Start func(cmd string) error

+ StderrPipe func() (io.Reader, error)

+ StdinPipe func() (io.WriteCloser, error)

+ StdoutPipe func() (io.Reader, error)

+ Wait func() error