ssh

Sep 9, 2026

Changes in this version

type Config

+ IgnoreSSHConfig bool

type Option

+ func WithoutSSHConfig() Option

type Options

+ IgnoreSSHConfig bool

Jul 1, 2026

Changes in this version

+ var ConfigParser *sshconfig.Parser

+ var ErrChecksumMismatch = errors.New("checksum mismatch")

+ func DefaultPasswordCallback() (string, error)

+ func ParseSSHPrivateKey(key []byte, callback PasswordCallback) ([]ssh.AuthMethod, error)

+ type Config struct

+ Address string

+ AuthMethods []ssh.AuthMethod

+ Bastion *Config

+ KeyPath *string

+ PasswordCallback PasswordCallback

+ Port int

+ SSHConfigOptions sshconfig.OptionArguments

+ User string

+ func (c *Config) Connection() (protocol.Connection, error)

+ func (c *Config) SetDefaults()

+ func (c *Config) String() string

+ func (c *Config) Validate() error

+ type Connection struct

+ func NewConnection(cfg Config, opts ...Option) (*Connection, error)

+ func (c *Connection) Connect(ctx context.Context) error

+ func (c *Connection) Dial(network, address string) (net.Conn, error)

+ func (c *Connection) Disconnect()

+ func (c *Connection) ExecInteractive(ctx context.Context, cmd string, stdin io.Reader, stdout, stderr io.Writer) error

+ func (c *Connection) IPAddress() string

+ func (c *Connection) IsConnected() bool

+ func (c *Connection) IsWindows() bool

+ func (c *Connection) Protocol() string

+ func (c *Connection) ProtocolName() string

+ func (c *Connection) SetDefaults(ctx context.Context)

+ func (c *Connection) StartProcess(ctx context.Context, cmd string, stdin io.Reader, stdout, stderr io.Writer) (protocol.Waiter, error)

+ func (c *Connection) String() string

+ type Option func(*Options)

+ func WithKeepAlive(d time.Duration) Option

+ func WithLogger(l log.Logger) Option

+ type Options struct

+ KeepAliveInterval *time.Duration

+ func NewOptions(opts ...Option) *Options

+ type PasswordCallback func() (secret string, err error)