Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

sshclient

package

Go to main page

Versions in this module

v0

v0.5.0

May 31, 2024

v0.4.0

Nov 12, 2023

v0.3.0

Jan 8, 2023

v0.2.0

Sep 11, 2022

v0.1.0

Sep 1, 2022

Changes in this version

+ const Tcp

+ func NewHostPortAddr(net string, host string, port uint16) net.Addr

+ func ParseBase64PublicKey(publicKey string) (ssh.PublicKey, error)

+ type AuthMethod func() ([]ssh.AuthMethod, error)

+ func Agent() AuthMethod

+ func AgentExplicitIdentities(identities ...string) AuthMethod

+ func Certificate(cert string, privateKey string) AuthMethod

+ func Password(password string) AuthMethod

+ func PrivateKey(privateKey string) AuthMethod

+ type Client struct

+ func New(connectFunc ConnectFunc) *Client

+ func (c *Client) Close() error

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

+ func (c *Client) Connected(ctx context.Context) error

+ type ConnectFunc func(ctx context.Context) (ssh.Conn, <-chan ssh.NewChannel, <-chan *ssh.Request, error)

+ func Connect(opts ...ConnectOption) ConnectFunc

+ func ConnectCustom(netConnectFunc NetConnectFunc, addr net.Addr, clientConfig *ssh.ClientConfig) ConnectFunc

+ func Prepare(opts ...ConnectOption) (ConnectFunc, error)

+ type ConnectMiddleware func(ConnectFunc) ConnectFunc

+ func CircuitBreak() ConnectMiddleware

+ func Retry(backoff retry.Backoff) ConnectMiddleware

+ type ConnectOption func(*connectArgs) error

+ func Addr(addr net.Addr) ConnectOption

+ func Auth(authMethod AuthMethod) ConnectOption

+ func HostKey(hostKeyVerifier HostKeyVerifier) ConnectOption

+ func HostKeyCallback(callback ssh.HostKeyCallback) ConnectOption

+ func Net(netConnectFunc NetConnectFunc) ConnectOption

+ func Timeout(timeout time.Duration) ConnectOption

+ func User(user string) ConnectOption

+ type HostKeyVerifier func() (ssh.HostKeyCallback, error)

+ func StaticHostKey(publicKey string) HostKeyVerifier

+ type NetConnectFunc func(context.Context) (net.Conn, error)

+ func Dial(addr net.Addr, timeout time.Duration) NetConnectFunc

+ func Proxy(proxy *Client, addr net.Addr) NetConnectFunc

+ type NetConnectMiddleware func(NetConnectFunc) NetConnectFunc

+ func NetCircuitBreaker() NetConnectMiddleware

+ func NetRetry(backoff retry.Backoff) NetConnectMiddleware