Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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

tunnel

package module

Go to main page

Versions in this module

v0

v0.2.0

Sep 25, 2025

Changes in this version

+ var ErrClosed = errors.New("tunnel closed")

+ var ErrNoAuth = errors.New("no SSH auth methods configured")

+ var ErrNoHops = errors.New("no hops configured")

type Config

+ HostKeyCB ssh.HostKeyCallback

+ KeepAlive time.Duration

+ KnownHostsPath string

+ Logger *slog.Logger

+ PerHopTimeout time.Duration

+ Signers []ssh.Signer

+ TrackConns bool

+ UseAgent bool

+ type Hop struct

+ HostKeyCallback ssh.HostKeyCallback

+ HostPort string

+ KnownHostsPath string

+ Timeout time.Duration

+ User string

+ func ParseHop(s string) (Hop, error)

+ func ParseHops(hops []string) ([]Hop, error)

+ type Option func(*Config) error

+ func WithAgent() Option

+ func WithConnTracking(enable bool) Option

+ func WithHop(s string) Option

+ func WithHops(hops ...Hop) Option

+ func WithHostKeyCallback(cb ssh.HostKeyCallback) Option

+ func WithKeepAlive(d time.Duration) Option

+ func WithKey(pemBytes []byte, passphrase []byte) Option

+ func WithKeyFile(path string, passphrase []byte) Option

+ func WithKnownHosts(path string) Option

+ func WithLogger(l *slog.Logger) Option

+ func WithPerHopTimeout(d time.Duration) Option

+ func WithSigner(s ssh.Signer) Option

+ func WithoutAgent() Option

type Tunnel

+ func (t *Tunnel) Close() error

+ func (t *Tunnel) DialContext(ctx context.Context, network, addr string) (net.Conn, error)

+ func (t *Tunnel) ListenContext(ctx context.Context, network, laddr string) (net.Listener, error)

+ func (t *Tunnel) LocalForward(ctx context.Context, laddr, raddr string) (net.Listener, error)

v0.1.0

Nov 3, 2023

Changes in this version

+ var ErrClosingHop = errors.New("error closing hop")

+ var ErrConnectAgent = errors.New("failed to connect to ssh-agent")

+ var ErrCreatingConnection = errors.New("error creating connection")

+ var ErrInvalidFormat = errors.New("invalid format")

+ var ErrNoHopsSpecified = errors.New("no hops specified")

+ var ErrOpeningAuthSock = errors.New("error opening ssh-agent socket")

+ var ErrParsingHops = errors.New("error parsing hops")

+ type Config struct

+ Hops []string

+ type Tunnel struct

+ func Create(c Config) (*Tunnel, error)

+ func (t *Tunnel) Dial(n string, addr string) (net.Conn, error)

+ func (t *Tunnel) Listen(n string, addr string) (net.Listener, error)

+ func (t *Tunnel) Shutdown() error