tssh

Documentation

Index

• func NewControlClientConn(c net.Conn) (ssh.Conn, <-chan ssh.NewChannel, <-chan *ssh.Request, error)
• func TsshMain(argv []string) int
• type SshArgs
• type SshClient
  • func SshLogin(args *SshArgs) (SshClient, error)
• type SshSession

Functions

func NewControlClientConn

func NewControlClientConn(c net.Conn) (ssh.Conn, <-chan ssh.NewChannel, <-chan *ssh.Request, error)

NewControlClientConn establishes an SSH connection over an OpenSSH ControlMaster socket c in proxy mode. The Request and NewChannel channels must be serviced or the connection will hang.

func TsshMain

func TsshMain(argv []string) int

TrzMain is the main function of tssh program.

Types

type SshArgs

type SshArgs struct {

	// Destination specifies the remote server to log in to.
	// e.g., alias in ~/.ssh/config, [user@]hostname[:port].
	Destination string

	// IPv4Only forces ssh to use IPv4 addresses only
	IPv4Only bool

	// IPv6Only forces ssh to use IPv6 addresses only
	IPv6Only bool

	// Port to connect to on the remote host
	Port int

	// LoginName specifies the user to log in as on the remote machine
	LoginName string

	// Identity selects the identity (private key) for public key authentication
	Identity []string

	// CipherSpec specifies the cipher for encrypting the session
	CipherSpec string

	// ConfigFile specifies the per-user configuration file
	ConfigFile string

	// ProxyJump specifies the jump hosts separated by comma characters
	ProxyJump string

	// Option gives options in the format used in the configuration file
	Option map[string][]string

	// Debug causes ssh to print debugging messages about its progress
	Debug bool

	// Udp means using UDP protocol ( QUIC / KCP ) connection like mosh
	Udp bool

	// TsshdPath specifies the tsshd absolute path on the server
	TsshdPath string
}

SshArgs specifies the arguments to log in to the remote server.

type SshClient

type SshClient interface {

	// Wait blocks until the connection has shut down.
	Wait() error

	// Close closes the underlying network connection.
	Close() error

	// NewSession opens a new Session for this client.
	NewSession() (SshSession, error)

	// DialTimeout initiates a connection to the addr from the remote host.
	DialTimeout(network, addr string, timeout time.Duration) (net.Conn, error)

	// Listen requests the remote peer open a listening socket on addr.
	Listen(network, addr string) (net.Listener, error)

	// HandleChannelOpen returns a channel on which NewChannel requests
	// for the given type are sent. If the type already is being handled,
	// nil is returned. The channel is closed when the connection is closed.
	HandleChannelOpen(channelType string) <-chan ssh.NewChannel

	// SendRequest sends a global request, and returns the reply.
	SendRequest(name string, wantReply bool, payload []byte) (bool, []byte, error)
}

SshClient implements a traditional SSH client that supports shells, subprocesses, TCP port/streamlocal forwarding and tunneled dialing.

func SshLogin

func SshLogin(args *SshArgs) (SshClient, error)

SshLogin logs in to the remote server and creates a Client.

type SshSession

type SshSession interface {

	// Wait waits for the remote command to exit.
	Wait() error

	// Close closes the underlying network connection.
	Close() error

	// Shell starts a login shell on the remote host.
	Shell() error

	// Run runs cmd on the remote host.
	Run(cmd string) error

	// Start runs cmd on the remote host.
	Start(cmd string) error

	// WindowChange informs the remote host about a terminal window dimension
	// change to height rows and width columns.
	WindowChange(height, width int) error

	// Setenv sets an environment variable that will be applied to any
	// command executed by Shell or Run.
	Setenv(name, value string) error

	// StdinPipe returns a pipe that will be connected to the
	// remote command's standard input when the command starts.
	StdinPipe() (io.WriteCloser, error)

	// StdoutPipe returns a pipe that will be connected to the
	// remote command's standard output when the command starts.
	StdoutPipe() (io.Reader, error)

	// StderrPipe returns a pipe that will be connected to the
	// remote command's standard error when the command starts.
	StderrPipe() (io.Reader, error)

	// Output runs cmd on the remote host and returns its standard output.
	Output(cmd string) ([]byte, error)

	// CombinedOutput runs cmd on the remote host and returns its combined
	// standard output and standard error.
	CombinedOutput(cmd string) ([]byte, error)

	// RequestPty requests the association of a pty with the session on the remote host.
	RequestPty(term string, height, width int, termmodes ssh.TerminalModes) error

	// SendRequest sends an out-of-band channel request on the SSH channel
	// underlying the session.
	SendRequest(name string, wantReply bool, payload []byte) (bool, error)
}

SshSession represents a connection to a remote command or shell.