gosh

May 9, 2024

Changes in this version

type Client

+ func (c *Client) WithBannerCallback(callback ssh.BannerCallback) *Client

Sep 1, 2023

Changes in this version

type Client

+ func (c *Client) ReadFile(src string) ([]byte, error)

Aug 31, 2023

Changes in this version

type Client

+ func (c *Client) SetSftpClient(client *sftp.Client)

+ func (c *Client) SftpClient() (*sftp.Client, error)

Aug 29, 2023

Changes in this version

type Options

+ KeyPassphrase string

Feb 19, 2022

Changes in this version

+ var DefaultPort = 22

+ var DefaultProtocol = "tcp"

+ var DefaultTimeout = 20 * time.Second

+ var DefaultUsername = "root"

+ var ErrNilSession = errors.New("could not start with nil session, use SetSession() to set a session")

+ func Agent() (ssh.AuthMethod, error)

+ func AppendKnownHost(fpath, host string, remote net.Addr, key ssh.PublicKey) error

+ func Auth(opts *Options) (ssh.AuthMethod, error)

+ func AutoFixedHostKeyCallback(host string, remote net.Addr, key ssh.PublicKey) error

+ func DefaultHostKeyCallback() (ssh.HostKeyCallback, error)

+ func DefaultKnownHostsPath() (string, error)

+ func GetSigner(sshkey, passphrase string) (signer ssh.Signer, err error)

+ func HasAgent() bool

+ func Key(sshkey string, passphrase string) (ssh.AuthMethod, error)

+ func Password(pass string) ssh.AuthMethod

+ func Ping(addr, user, password, key string) error

+ func VerifyKnownHost(fpath, host string, remote net.Addr, key ssh.PublicKey) (bool, error)

+ type Client struct

+ func New(opts *Options) (*Client, error)

+ func NewDefault(opts *Options) (*Client, error)

+ func NewInsecure(opts *Options) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) CombinedOutput(command string) ([]byte, error)

+ func (c *Client) CombinedOutputContext(ctx context.Context, command string) ([]byte, error)

+ func (c *Client) Command(name string, args ...string) (*Cmd, error)

+ func (c *Client) CommandContext(ctx context.Context, name string, args ...string) (*Cmd, error)

+ func (c *Client) Dial() error

+ func (c *Client) Download(rpath, lpath string) (err error)

+ func (c *Client) NewSftp(opts ...sftp.ClientOption) (*sftp.Client, error)

+ func (c *Client) Ping() error

+ func (c *Client) Upload(lpath, rpath string) (err error)

+ func (c *Client) WithHostKeyCallback(callback ssh.HostKeyCallback) *Client

+ type Cmd struct

+ Args []string

+ Path string

+ func (c *Cmd) CombinedOutput() ([]byte, error)

+ func (c *Cmd) Output() ([]byte, error)

+ func (c *Cmd) OutputPipe(fn LoggingFunc) error

+ func (c *Cmd) Run() error

+ func (c *Cmd) SetSession(session *ssh.Session)

+ func (c *Cmd) Setenv(env []string) (err error)

+ func (c *Cmd) Start() error

+ func (c *Cmd) String() string

+ type LoggingFunc func(line []byte) error

+ type Options struct

+ Addr string

+ Key string

+ Passphrase string

+ Password string

+ Port int

+ Timeout time.Duration

+ UseAgent bool

+ Username string

+ func NewOptions() *Options