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
- API
  
  Reference documentation for the pkg.go.dev API
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

sshconfig

package

Go to main page

Versions in this module

v2

v2.2.1

Sep 21, 2026

v2.2.0

Sep 9, 2026

v2.1.1

Jul 28, 2026

v2.1.0

Jul 6, 2026

v2.0.1

Jul 5, 2026

v2.0.0

Jul 1, 2026

Changes in this version

+ var ErrEmptySlice = errors.New("empty slice is not a valid value")

+ var ErrInvalidObject = errors.New("invalid object")

+ var ErrNotImplemented = errors.New("not implemented")

+ var ErrSyntax = errors.New("syntax error")

+ func Dump(obj any) (string, error)

+ type Config struct

+ AddKeysToAgent options.AddKeysToAgentOption

+ AddressFamily string

+ AppleMultiPath options.BooleanOption

+ BatchMode options.BooleanOption

+ BindAddress string

+ BindInterface string

+ CASignatureAlgorithms []string

+ CanonicalDomains []string

+ CanonicalizeFallbackLocal options.BooleanOption

+ CanonicalizeHostname options.CanonicalizeHostnameOption

+ CanonicalizeMaxDots int

+ CanonicalizePermittedCNAMEs []string

+ CertificateFile []string

+ ChannelTimeout map[string]time.Duration

+ CheckHostIP options.BooleanOption

+ Ciphers []string

+ ClearAllForwardings options.BooleanOption

+ Compression options.BooleanOption

+ ConnectTimeout time.Duration

+ ConnectionAttempts int

+ ControlMaster options.ControlMasterOption

+ ControlPath string

+ ControlPersist options.ControlPersistOption

+ DynamicForward []string

+ EnableEscapeCommandline options.BooleanOption

+ EnableSSHKeysign options.BooleanOption

+ EscapeChar options.EscapeCharOption

+ ExitOnForwardFailure options.BooleanOption

+ FingerprintHash options.FingerprintHashOption

+ ForkAfterAuthentication options.BooleanOption

+ ForwardAgent options.ForwardAgentOption

+ ForwardX11 options.BooleanOption

+ ForwardX11Timeout time.Duration

+ ForwardX11Trusted options.BooleanOption

+ GSSAPIAuthentication options.BooleanOption

+ GSSAPIDelegateCredentials options.BooleanOption

+ GatewayPorts options.BooleanOption

+ GlobalKnownHostsFile []string

+ HashKnownHosts options.BooleanOption

+ Host string

+ HostKeyAlgorithms []string

+ HostKeyAlias string

+ HostbasedAcceptedAlgorithms []string

+ HostbasedAuthentication options.BooleanOption

+ Hostname string

+ IPQoS []string

+ IdentitiesOnly options.BooleanOption

+ IdentityAgent options.IdentityAgentOption

+ IdentityFile []string

+ IgnoreUnknown []string

+ KbdInteractiveAuthentication options.BooleanOption

+ KbdInteractiveDevices []string

+ KexAlgorithms []string

+ KnownHostsCommand string

+ LocalCommand string

+ LocalForward map[string]string

+ LogLevel string

+ LogVerbose []string

+ MACs []string

+ NoHostAuthenticationForLocalhost options.BooleanOption

+ NumberOfPasswordPrompts *int

+ ObscureKeystrokeTiming options.ObscureKeystrokeTimingOption

+ PKCS11Provider string

+ PasswordAuthentication options.BooleanOption

+ PermitLocalCommand options.BooleanOption

+ PermitRemoteOpen []string

+ Port int

+ PreferredAuthentications []string

+ ProxyCommand string

+ ProxyJump []string

+ ProxyUseFdpass options.BooleanOption

+ PubkeyAcceptedAlgorithms []string

+ PubkeyAuthentication options.PubkeyAuthenticationOption

+ RekeyLimit options.RekeyLimitOption

+ RemoteCommand string

+ RemoteForward map[string]string

+ RequestTTY options.RequestTTYOption

+ RequiredRSASize *int

+ RevokedHostKeys string

+ SecurityKeyProvider string

+ SendEnv []string

+ ServerAliveCountMax *int

+ ServerAliveInterval time.Duration

+ SessionType string

+ SetEnv map[string]string

+ SmartcardDevice string

+ StdinNull options.BooleanOption

+ StreamLocalBindMask *uint

+ StreamLocalBindUnlink options.BooleanOption

+ StrictHostKeyChecking options.StrictHostKeyCheckingOption

+ SyslogFacility string

+ TCPKeepAlive options.BooleanOption

+ Tag string

+ Tunnel options.TunnelOption

+ TunnelDevice string

+ UpdateHostKeys options.UpdateHostKeysOption

+ UseKeychain options.BooleanOption

+ User string

+ UserKnownHostsFile []string

+ VerifyHostKeyDNS options.VerifyHostKeyDNSOption

+ VisualHostKey options.BooleanOption

+ XAuthLocation string

+ func ConfigFor(host string, opts ...ParserOption) (*Config, error)

+ type OptionArguments map[string]any

+ func (o OptionArguments) ApplyTo(setter *Setter) error

+ func (o OptionArguments) Copy() OptionArguments

+ func (o OptionArguments) IsSet(key string) bool

+ func (o OptionArguments) Set(key string, value any)

+ func (o OptionArguments) SetIfUnset(key string, value any)

+ func (o OptionArguments) ToArgs() []string

+ type Parser struct

+ func NewParser(r io.Reader, opts ...ParserOption) (*Parser, error)

+ func (p *Parser) Apply(obj any, host string) error

+ func (p *Parser) Reset()

+ type ParserOption func(*parserOptions)

+ func WithExecutor(e executor) ParserOption

+ func WithGlobalConfigPath(path string) ParserOption

+ func WithGlobalConfigReader(r io.Reader) ParserOption

+ func WithNoFinalize() ParserOption

+ func WithStrict() ParserOption

+ func WithUserConfigPath(path string) ParserOption

+ func WithUserConfigReader(r io.Reader) ParserOption

+ func WithUserHome(home string) ParserOption

+ type Setter struct

+ ErrorOnUnknownFields bool

+ OriginalHost string

+ func NewSetter(obj any) (*Setter, error)

+ func (s *Setter) CanonicalizeHostname() error

+ func (s *Setter) ExpandSlice(key string) ([]string, error)

+ func (s *Setter) ExpandString(key string) (string, error)

+ func (s *Setter) Finalize() error

+ func (s *Setter) HostChanged() bool

+ func (s *Setter) Reset(key string) error

+ func (s *Setter) Set(key string, values ...string) error

v2.0.0-rc.1

Jul 1, 2026

v2.0.0-beta.2

Jun 9, 2026

v2.0.0-beta.1

Jun 3, 2026

v2.0.0-alpha.3

Aug 7, 2024

v2.0.0-alpha.2

May 7, 2024