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

ssh

package

Go to main page

Versions in this module

v1

v1.1.13

Dec 18, 2023

v1.1.12

Nov 27, 2023

v1.1.11

Nov 6, 2023

v1.1.10

Sep 19, 2023

v1.1.9

Apr 25, 2023

v1.1.8

Apr 12, 2023

v1.1.7

Mar 1, 2023

v1.1.6

Feb 27, 2023

v1.1.5

Feb 1, 2023

v1.1.4

Jan 30, 2023

v1.1.3

Jan 24, 2023

v1.1.2

Jan 24, 2023

v1.1.1

Jan 18, 2023

v1.1.0

Jan 12, 2023

v1.0.5

Jan 12, 2023

v1.0.4

Jan 11, 2023

v1.0.3

Jan 6, 2023

v1.0.2

Dec 9, 2022

v1.0.1

Oct 11, 2022

v1.0.0

Sep 22, 2022

Changes in this version

+ const CS7

+ const CS8

+ const CertAlgoDSAv01

+ const CertAlgoECDSA256v01

+ const CertAlgoECDSA384v01

+ const CertAlgoECDSA521v01

+ const CertAlgoED25519v01

+ const CertAlgoRSASHA256v01

+ const CertAlgoRSASHA512v01

+ const CertAlgoRSAv01

+ const CertAlgoSKECDSA256v01

+ const CertAlgoSKED25519v01

+ const CertSigAlgoRSASHA2256v01

+ const CertSigAlgoRSASHA2512v01

+ const CertSigAlgoRSAv01

+ const CertTimeInfinity

+ const ECHO

+ const ECHOCTL

+ const ECHOE

+ const ECHOK

+ const ECHOKE

+ const ECHONL

+ const HostCert

+ const ICANON

+ const ICRNL

+ const IEXTEN

+ const IGNCR

+ const IGNPAR

+ const IMAXBEL

+ const INLCR

+ const INPCK

+ const ISIG

+ const ISTRIP

+ const IUCLC

+ const IUTF8

+ const IXANY

+ const IXOFF

+ const IXON

+ const KeyAlgoDSA

+ const KeyAlgoECDSA256

+ const KeyAlgoECDSA384

+ const KeyAlgoECDSA521

+ const KeyAlgoED25519

+ const KeyAlgoRSA

+ const KeyAlgoRSASHA256

+ const KeyAlgoRSASHA512

+ const KeyAlgoSKECDSA256

+ const KeyAlgoSKED25519

+ const NOFLSH

+ const OCRNL

+ const OLCUC

+ const ONLCR

+ const ONLRET

+ const ONOCR

+ const OPOST

+ const PARENB

+ const PARMRK

+ const PARODD

+ const PENDIN

+ const SigAlgoRSA

+ const SigAlgoRSASHA2256

+ const SigAlgoRSASHA2512

+ const TOSTOP

+ const TTY_OP_ISPEED

+ const TTY_OP_OSPEED

+ const UserCert

+ const VDISCARD

+ const VDSUSP

+ const VEOF

+ const VEOL

+ const VEOL2

+ const VERASE

+ const VFLUSH

+ const VINTR

+ const VKILL

+ const VLNEXT

+ const VQUIT

+ const VREPRINT

+ const VSTART

+ const VSTATUS

+ const VSTOP

+ const VSUSP

+ const VSWTCH

+ const VWERASE

+ const XCASE

+ var ErrNoAuth = errors.New("ssh: no auth passed yet")

+ var SupportedHostKeyAlgos = []string

+ func Clients(t *HandshakeTransport, kex KexAlgorithm, magics *HandshakeMagics) (*kexResult, error)

+ func DiscardRequests(in <-chan *Request)

+ func FingerprintLegacyMD5(pubKey PublicKey) string

+ func FingerprintSHA256(pubKey PublicKey) string

+ func Marshal(msg interface{}) []byte

+ func MarshalAuthorizedKey(key PublicKey) []byte

+ func NewTransport(rwc io.ReadWriteCloser, rand io.Reader, isClient bool) *transport

+ func ParseDSAPrivateKey(der []byte) (*dsa.PrivateKey, error)

+ func ParseRawPrivateKey(pemBytes []byte) (interface{}, error)

+ func ParseRawPrivateKeyWithPassphrase(pemBytes, passphrase []byte) (interface{}, error)

+ func PushPacket(t *handshakeTransport, p []byte) error

+ func Unmarshal(data []byte, out interface{}) error

+ type AlgorithmSigner interface

+ SignWithAlgorithm func(rand io.Reader, data []byte, algorithm string) (*Signature, error)

+ type Algorithms struct

+ HostKey string

+ Kex string

+ func FindAgreedAlgorithms(isClient bool, clientKexInit, serverKexInit *KexInitMsg) (algs *Algorithms, err error)

+ type AuthMethod interface

+ func GSSAPIWithMICAuthMethod(gssAPIClient GSSAPIClient, target string) AuthMethod

+ func KeyboardInteractive(challenge KeyboardInteractiveChallenge) AuthMethod

+ func Password(secret string) AuthMethod

+ func PasswordCallback(prompt func() (secret string, err error)) AuthMethod

+ func PublicKeys(signers ...Signer) AuthMethod

+ func PublicKeysCallback(getSigners func() (signers []Signer, err error)) AuthMethod

+ func RetryableAuthMethod(auth AuthMethod, maxTries int) AuthMethod

+ type BannerCallback func(message string) error

+ func BannerDisplayStderr() BannerCallback

+ type CertChecker struct

+ Clock func() time.Time

+ HostKeyFallback HostKeyCallback

+ IsHostAuthority func(auth PublicKey, address string) bool

+ IsRevoked func(cert *Certificate) bool

+ IsUserAuthority func(auth PublicKey) bool

+ SupportedCriticalOptions []string

+ UserKeyFallback func(conn ConnMetadata, key PublicKey) (*Permissions, error)

+ func (c *CertChecker) Authenticate(conn ConnMetadata, pubKey PublicKey) (*Permissions, error)

+ func (c *CertChecker) CheckCert(principal string, cert *Certificate) error

+ func (c *CertChecker) CheckHostKey(addr string, remote net.Addr, key PublicKey) error

+ type Certificate struct

+ CertType uint32

+ Key PublicKey

+ KeyId string

+ Nonce []byte

+ Reserved []byte

+ Serial uint64

+ Signature *Signature

+ SignatureKey PublicKey

+ ValidAfter uint64

+ ValidBefore uint64

+ ValidPrincipals []string

+ func (c *Certificate) Marshal() []byte

+ func (c *Certificate) SignCert(rand io.Reader, authority Signer) error

+ func (c *Certificate) Type() string

+ func (c *Certificate) Verify(data []byte, sig *Signature) error

+ type Channel interface

+ Close func() error

+ CloseWrite func() error

+ Read func(data []byte) (int, error)

+ SendRequest func(name string, wantReply bool, payload []byte) (bool, error)

+ Stderr func() io.ReadWriter

+ Write func(data []byte) (int, error)

+ type Client struct

+ func Dial(network, addr string, config *ClientConfig) (*Client, error)

+ func NewClient(c Conn, chans <-chan NewChannel, reqs <-chan *Request) *Client

+ func (c *Client) Dial(n, addr string) (net.Conn, error)

+ func (c *Client) DialTCP(n string, laddr, raddr *net.TCPAddr) (net.Conn, error)

+ func (c *Client) HandleChannelOpen(channelType string) <-chan NewChannel

+ func (c *Client) Listen(n, addr string) (net.Listener, error)

+ func (c *Client) ListenTCP(laddr *net.TCPAddr) (net.Listener, error)

+ func (c *Client) ListenUnix(socketPath string) (net.Listener, error)

+ func (c *Client) NewSession() (*Session, error)

+ type ClientConfig struct

+ Auth []AuthMethod

+ BannerCallback BannerCallback

+ ClientVersion string

+ HostKeyAlgorithms []string

+ HostKeyCallback HostKeyCallback

+ Timeout time.Duration

+ User string

+ type Config struct

+ Ciphers []string

+ KeyExchanges []string

+ MACs []string

+ Rand io.Reader

+ RekeyThreshold uint64

+ func (c *Config) SetDefaults()

+ type Conn interface

+ Close func() error

+ OpenChannel func(name string, data []byte) (Channel, <-chan *Request, error)

+ SendRequest func(name string, wantReply bool, payload []byte) (bool, []byte, error)

+ Wait func() error

+ func NewClientConn(c net.Conn, addr string, config *ClientConfig) (Conn, <-chan NewChannel, <-chan *Request, error)

+ type ConnMetadata interface

+ ClientVersion func() []byte

+ LocalAddr func() net.Addr

+ RemoteAddr func() net.Addr

+ ServerVersion func() []byte

+ SessionID func() []byte

+ User func() string

+ type CryptoPublicKey interface

+ CryptoPublicKey func() crypto.PublicKey

+ type ExitError struct

+ func (e *ExitError) Error() string

+ type ExitMissingError struct

+ func (e *ExitMissingError) Error() string

+ type GSSAPIClient interface

+ DeleteSecContext func() error

+ GetMIC func(micFiled []byte) ([]byte, error)

+ InitSecContext func(target string, token []byte, isGSSDelegCreds bool) (outputToken []byte, needContinue bool, err error)

+ type GSSAPIServer interface

+ AcceptSecContext func(token []byte) (outputToken []byte, srcName string, needContinue bool, err error)

+ DeleteSecContext func() error

+ VerifyMIC func(micField []byte, micToken []byte) error

+ type GSSAPIWithMICConfig struct

+ AllowLogin func(conn ConnMetadata, srcName string) (*Permissions, error)

+ Server GSSAPIServer

+ type HandshakeMagics struct

+ ClientKexInit []byte

+ ClientVersion []byte

+ ServerKexInit []byte

+ ServerVersion []byte

+ type HandshakeTransport struct

+ Algorithms *Algorithms

+ ClientVersion []byte

+ Config *Config

+ HandshakeTransport *handshakeTransport

+ ServerVersion []byte

+ SessionID []byte

+ func NewHandshakeTransport(onn keyingTransport, config *Config, clientVersion, serverVersion []byte) *HandshakeTransport

+ func (t *HandshakeTransport) Close() error

+ type HostKeyCallback func(hostname string, remote net.Addr, key PublicKey) error

+ func FixedHostKey(key PublicKey) HostKeyCallback

+ func InsecureIgnoreHostKey() HostKeyCallback

+ type KexAlgorithm interface

+ func GetKex(kex string) KexAlgorithm

+ type KexInitMsg struct

+ CiphersClientServer []string

+ CiphersServerClient []string

+ CompressionClientServer []string

+ CompressionServerClient []string

+ Cookie [16]byte

+ FirstKexFollows bool

+ KexAlgos []string

+ LanguagesClientServer []string

+ LanguagesServerClient []string

+ MACsClientServer []string

+ MACsServerClient []string

+ Reserved uint32

+ ServerHostKeyAlgos []string

+ type KeyboardInteractiveChallenge func(name, instruction string, questions []string, echos []bool) (answers []string, err error)

+ type NewChannel interface

+ Accept func() (Channel, <-chan *Request, error)

+ ChannelType func() string

+ ExtraData func() []byte

+ Reject func(reason RejectionReason, message string) error

+ type OpenChannelError struct

+ Message string

+ Reason RejectionReason

+ func (e *OpenChannelError) Error() string

+ type PassphraseMissingError struct

+ PublicKey PublicKey

+ func (*PassphraseMissingError) Error() string

+ type Permissions struct

+ CriticalOptions map[string]string

+ Extensions map[string]string

+ type PublicKey interface

+ Marshal func() []byte

+ Type func() string

+ Verify func(data []byte, sig *Signature) error

+ func NewPublicKey(key interface{}) (PublicKey, error)

+ func ParseAuthorizedKey(in []byte) (out PublicKey, comment string, options []string, rest []byte, err error)

+ func ParseKnownHosts(in []byte) (marker string, hosts []string, pubKey PublicKey, comment string, rest []byte, ...)

+ func ParsePublicKey(in []byte) (out PublicKey, err error)

+ type RejectionReason uint32

+ const ConnectionFailed

+ const Prohibited

+ const ResourceShortage

+ const UnknownChannelType

+ func (r RejectionReason) String() string

+ type Request struct

+ Payload []byte

+ Type string

+ WantReply bool

+ func (r *Request) Reply(ok bool, payload []byte) error

+ type ServerAuthError struct

+ Errors []error

+ func (l ServerAuthError) Error() string

+ type ServerConfig struct

+ AuthLogCallback func(conn ConnMetadata, method string, err error)

+ BannerCallback func(conn ConnMetadata) string

+ GSSAPIWithMICConfig *GSSAPIWithMICConfig

+ KeyboardInteractiveCallback func(conn ConnMetadata, client KeyboardInteractiveChallenge) (*Permissions, error)

+ MaxAuthTries int

+ NoClientAuth bool

+ PasswordCallback func(conn ConnMetadata, password []byte) (*Permissions, error)

+ PublicKeyCallback func(conn ConnMetadata, key PublicKey) (*Permissions, error)

+ ServerVersion string

+ func (s *ServerConfig) AddHostKey(key Signer)

+ type ServerConn struct

+ Permissions *Permissions

+ func NewServerConn(c net.Conn, config *ServerConfig) (*ServerConn, <-chan NewChannel, <-chan *Request, error)

+ type Session struct

+ Stderr io.Writer

+ Stdin io.Reader

+ Stdout io.Writer

+ func (s *Session) Close() error

+ func (s *Session) CombinedOutput(cmd string) ([]byte, error)

+ func (s *Session) Output(cmd string) ([]byte, error)

+ func (s *Session) RequestPty(term string, h, w int, termmodes TerminalModes) error

+ func (s *Session) RequestSubsystem(subsystem string) error

+ func (s *Session) Run(cmd string) error

+ func (s *Session) SendRequest(name string, wantReply bool, payload []byte) (bool, error)

+ func (s *Session) Setenv(name, value string) error

+ func (s *Session) Shell() error

+ func (s *Session) Signal(sig Signal) error

+ func (s *Session) Start(cmd string) error

+ func (s *Session) StderrPipe() (io.Reader, error)

+ func (s *Session) StdinPipe() (io.WriteCloser, error)

+ func (s *Session) StdoutPipe() (io.Reader, error)

+ func (s *Session) Wait() error

+ func (s *Session) WindowChange(h, w int) error

+ type Signal string

+ const SIGABRT

+ const SIGALRM

+ const SIGFPE

+ const SIGHUP

+ const SIGILL

+ const SIGINT

+ const SIGKILL

+ const SIGPIPE

+ const SIGQUIT

+ const SIGSEGV

+ const SIGTERM

+ const SIGUSR1

+ const SIGUSR2

+ type Signature struct

+ Blob []byte

+ Format string

+ Rest []byte

+ type Signer interface

+ PublicKey func() PublicKey

+ Sign func(rand io.Reader, data []byte) (*Signature, error)

+ func NewCertSigner(cert *Certificate, signer Signer) (Signer, error)

+ func NewSignerFromKey(key interface{}) (Signer, error)

+ func NewSignerFromSigner(signer crypto.Signer) (Signer, error)

+ func ParsePrivateKey(pemBytes []byte) (Signer, error)

+ func ParsePrivateKeyWithPassphrase(pemBytes, passphrase []byte) (Signer, error)

+ type TerminalModes map[uint8]uint32

+ type Waitmsg struct

+ func (w Waitmsg) ExitStatus() int

+ func (w Waitmsg) Lang() string

+ func (w Waitmsg) Msg() string

+ func (w Waitmsg) Signal() string

+ func (w Waitmsg) String() string