secureshell

type AuthMethod = ssh.AuthMethod

type Channel = ssh.Channel

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

type ClientDialer interface {
	// Dial connects to the address on the named network.
	Dial(network, address string) (net.Conn, error)

	// DialContext connects to the address on the named network using the provided context.
	DialContext(ctx context.Context, network, address string) (net.Conn, error)
}

type ClientSession struct {
	*ssh.Session
}

type HostKeyCallback = ssh.HostKeyCallback

type PseudoTerminal struct {
	// Type is the TERM environment variable (e.g. "vt100").
	Type string

	// Width is the width in characters.
	Width uint32

	// Height is the height in characters.
	Height uint32

	// PixelWidth is the width in pixels.
	PixelWidth uint32

	// PixelHeight is the height in pixels.
	PixelHeight uint32

	// RawModes are the encoded terminal modes.
	RawModes string
}

type PublicKey = ssh.PublicKey

type Server struct {
	// Config is the (template) server configuration.
	// Setting this property is required and it should at least include any of
	// PasswordCallback, PublicKeyCallback, KeyboardInteractiveCallback or NoClientAuth.
	//
	// The value of ServerVersion from the Config is ignored, see Version below.
	Config *ssh.ServerConfig `toml:"config" json:"config"`

	// Addr is the listen address.
	Addr string `json:"addr" toml:"addr"`

	// Keys are the host keys.
	Keys []ssh.Signer `hcl:"-" json:"-" mapstructure:"-" toml:"-" yaml:"-"`

	// KeyFiles are the host key files (optional).
	KeyFiles []string `hcl:"keys" json:"keys" mapstructure:"keys" toml:"keys" yaml:"keys"`

	// KeepaliveInterval is the delay between server initiated keepalive requests.
	KeepaliveInterval time.Duration `hcl:"keepalive" json:"keepalive" mapstructure:"keepalive" toml:"keepalive" yaml:"keepalive"`

	// Version of this server.
	// If no Version is specified, DefaultVersion will be used.
	// Contrary to the ServerVersion in config.ServerConfig, this version does not
	// require the caller to prepend "SSH-2.0-".
	Version string `json:"version" toml:"version"`

	// Banner, if present, is sent to the client after key exchange completed but before authentication.
	// If the Config has a BannerCallback set, it takes precedence over this setting.
	Banner string `json:"banner" toml:"banner"`

	// AcceptCallback is called after accepting a new connection.
	AcceptCallback func(net.Conn) error `hcl:"-" json:"-" mapstructure:"-" toml:"-" yaml:"-"`

	// ConnectCallback is called after accepting a new SSH client.
	ConnectCallback func(ssh.Conn) error `hcl:"-" json:"-" mapstructure:"-" toml:"-" yaml:"-"`

	// DisconnectCallback is called when a connected SSH client connection is lost.
	DisconnectCallback func(ssh.Conn, error) `hcl:"-" json:"-" mapstructure:"-" toml:"-" yaml:"-"`

	// ChannelHandler are the SSH channel handlers.
	//
	// A default handler may be specified with "default".
	ChannelHandler map[string]ServerChannelHandler `hcl:"-" json:"-" mapstructure:"-" toml:"-" yaml:"-"`

	// RequestHandler are the SSH request handlers.
	//
	// A default handler may be specified with "default".
	RequestHandler map[string]ServerRequestHandler `hcl:"-" json:"-" mapstructure:"-" toml:"-" yaml:"-"`

	// SessionHandler is called if a new client session is opened.
	//
	// This handler is used by the DefaultSessionHandler, if it is installed in the
	// RequestHandler map to handle "session" requests.
	SessionHandler func(Session) `hcl:"-" json:"-" mapstructure:"-" toml:"-" yaml:"-"`

	// TunnelHandler is used to establish outbound TCP/IP tunnels.
	// If the callback is not set, tunneling requests will be refused.
	TunnelHandler func(conn ssh.Conn, address string) (net.Conn, error) `hcl:"-" json:"-" mapstructure:"-" toml:"-" yaml:"-"`

	// ReverseTunnelHandler is used to establish reverse TCP/IP tunnels.
	// If the callback is not set, tunneling requests will be refused.
	ReverseTunnelHandler func(conn ssh.Conn, localAddress, remoteAddress string) (net.Listener, error) `hcl:"-" json:"-" mapstructure:"-" toml:"-" yaml:"-"`
	// contains filtered or unexported fields
}

type ServerChannelHandler func(*Server, *ssh.ServerConn, ssh.NewChannel) error

type ServerRequestHandler func(*Server, *ssh.ServerConn, *ssh.Request) (ok bool, payload []byte)

type Session interface {
	// Channel is the underlying transport channel.
	// It provides an io.ReadWriteCloser interface.
	ssh.Channel

	// ConnMetadata holds metadata for the connection.
	ssh.ConnMetadata

	// HandleRequest adds a request handler callback.
	// The handler is ignored if the callback is nil.
	// If the requestType is overlapping with a builtin handler, the builtin
	// handler will stop working.
	// If the handler returns an error, the client connection will be terminated.
	HandleRequest(requestType string, callback SessionRequestHandler)

	// HandleRequests consumes and handles new requests from the passed channel.
	HandleRequests(requests <-chan *ssh.Request) error

	// Args are the arguments supplied to the session.
	Args() []string

	// Getenv retrieves the value of the environment variable named by the key.
	// It returns the value, which will be empty if the variable is not present.
	// To distinguish between an empty value and an unset value, use LookupEnv.
	Getenv(key string) string

	// LookupEnv retrieves the value of the environment variable named by the key.
	// If the variable is present in the environment the value (which may be empty) is returned and the boolean is true.
	// Otherwise the returned value will be empty and the boolean will be false.
	LookupEnv(key string) (string, bool)

	// Setenv sets the value of the environment variable named by the key.
	Setenv(key, value string)

	// Environ returns the environment as key-value map.
	Environ() map[string]string

	// Permissions returned after authenticating the client connection.
	Permissions() *ssh.Permissions

	// PseudoTerminal returns information about the connected pseudo terminal.
	// Also, a channel is returned that will receive window change events.
	// The boolean indicates whether the connected client has requested a pseudo terminal or not.
	PseudoTerminal() (PseudoTerminal, <-chan WindowChange, bool)

	// Exit sends an exit status and then closes the session.
	Exit(code int) error
}

type SessionRequestHandler func(Session, *ssh.Request) error

type WindowChange struct {
	// Width is the width in characters.
	Width uint32

	// Height is the height in characters.
	Height uint32

	// PixelWidth is the width in pixels.
	PixelWidth uint32

	// PixelHeight is the height in pixels.
	PixelHeight uint32
}