ssh

Documentation

Index

• func GetNetworkInterface(s Interface, ip string) string
• func MakePrivateKeySigner(privateKey []byte, passPhrase []byte) (ssh.Signer, error)
• func MakePrivateKeySignerFromFile(key string) (ssh.Signer, error)
• func ParsePublicKeyFromFile(keyFile string) (*rsa.PublicKey, error)
• func Timestamp(s Interface) (int, error)
• type Config
• type Interface
• type SSH
  • func New(c *Config) (*SSH, error)
  • func (s *SSH) CombinedOutput(cmd string) ([]byte, error)
  • func (s *SSH) CopyFile(src, dst string) error
  • func (s *SSH) Exec(cmd string) (stdout string, stderr string, exit int, err error)
  • func (s *SSH) Execf(format string, a ...interface{}) (stdout string, stderr string, exit int, err error)
  • func (s *SSH) LookPath(file string) (string, error)
  • func (s *SSH) Ping() error
  • func (s *SSH) ReadFile(filename string) ([]byte, error)
  • func (s *SSH) Stat(p string) (os.FileInfo, error)
  • func (s *SSH) WriteFile(src io.Reader, dst string) error

Functions

func GetNetworkInterface

func GetNetworkInterface(s Interface, ip string) string

GetNetworkInterface return network interface name by ip

func MakePrivateKeySigner

func MakePrivateKeySigner(privateKey []byte, passPhrase []byte) (ssh.Signer, error)

func MakePrivateKeySignerFromFile

func MakePrivateKeySignerFromFile(key string) (ssh.Signer, error)

func ParsePublicKeyFromFile

func ParsePublicKeyFromFile(keyFile string) (*rsa.PublicKey, error)

func Timestamp

func Timestamp(s Interface) (int, error)

Timestamp returns target node timestamp.

Types

type Config

type Config struct {
	User       string `validate:"required"`
	Host       string `validate:"required"`
	Port       int    `validate:"required"`
	Password   string
	PrivateKey []byte
	PassPhrase []byte
	// 150 seconds is longer than the underlying default TCP backoff delay (127
	// seconds). This timeout is only intended to catch otherwise uncaught hangs.
	DialTimeOut time.Duration
	Retry       int
}

type Interface

type Interface interface {
	Ping() error
	Exec(cmd string) (stdout string, stderr string, exit int, err error)
	Execf(format string, a ...interface{}) (stdout string, stderr string, exit int, err error)
	CombinedOutput(cmd string) ([]byte, error)

	CopyFile(src, dst string) error
	WriteFile(src io.Reader, dst string) error
	ReadFile(filename string) ([]byte, error)
	Stat(p string) (os.FileInfo, error)

	LookPath(file string) (string, error)
}

type SSH

type SSH struct {
	User string
	Host string
	Port int

	Retry int
	// contains filtered or unexported fields
}

func New

func New(c *Config) (*SSH, error)

func (*SSH) CombinedOutput

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

func (*SSH) CopyFile

func (s *SSH) CopyFile(src, dst string) error

func (*SSH) Exec

func (s *SSH) Exec(cmd string) (stdout string, stderr string, exit int, err error)

func (*SSH) Execf

func (s *SSH) Execf(format string, a ...interface{}) (stdout string, stderr string, exit int, err error)

func (*SSH) LookPath

func (s *SSH) LookPath(file string) (string, error)

func (*SSH) Ping

func (s *SSH) Ping() error

func (*SSH) ReadFile

func (s *SSH) ReadFile(filename string) ([]byte, error)

func (*SSH) Stat

func (s *SSH) Stat(p string) (os.FileInfo, error)

func (*SSH) WriteFile

func (s *SSH) WriteFile(src io.Reader, dst string) error