ssh

Documentation

Index

• type Client
  • func NewClient(user, host string, port int, opts ...ConnectOpt) (*Client, error)
  • func NewClientWithConnection(user, host string, conn net.Conn, opts ...ConnectOpt) (*Client, error)
  • func (c *Client) Connect(env *Env) error
• type ConnectOpt
  • func ConnectOptOutputPassword(password string) ConnectOpt
  • func ConnectOptOutputPrivateKey(privateKey []byte) ConnectOpt
  • func ConnectOptOutputWriter(out io.Writer) ConnectOpt
• type Env

Types

type Client

type Client struct {
	*ssh.Client
	// contains filtered or unexported fields
}

func NewClient

func NewClient(user, host string, port int, opts ...ConnectOpt) (*Client, error)

NewClient connects via ssh to host with the given user and authenticates with the given connect options.

Call client.Connect() to actually get the ssh session

func NewClientWithConnection

func NewClientWithConnection(user, host string, conn net.Conn, opts ...ConnectOpt) (*Client, error)

NewClientWithConnection connects via ssh to host with the given user and authenticates with the given connect options. a already created net.Conn must be provided. see vpn.Connect howto create such a connection via tailscale VPN

Call client.Connect() to actually get the ssh session

func (*Client) Connect

func (c *Client) Connect(env *Env) error

Connect once a ssh.Client was created, you can connect to it, this call blocks until session is terminated.

type ConnectOpt

type ConnectOpt any

func ConnectOptOutputPassword

func ConnectOptOutputPassword(password string) ConnectOpt

func ConnectOptOutputPrivateKey

func ConnectOptOutputPrivateKey(privateKey []byte) ConnectOpt

func ConnectOptOutputWriter

func ConnectOptOutputWriter(out io.Writer) ConnectOpt

type Env

type Env map[string]string