ssh

package module

Go to main page

Versions in this module

v1

v1.2.7

Sep 3, 2026

v1.2.6

Sep 2, 2026

v1.2.5

Sep 1, 2026

v1.2.4

Sep 1, 2026

v1.2.3

Aug 12, 2026

v1.2.2

Jul 8, 2026

v1.2.1

Jul 3, 2026

v1.2.0

May 25, 2026

Changes in this version

+ type ConnectionClosingCallback func(ctx Context, conn *gossh.ServerConn)

+ type NewChannelUnwrapper interface

+ Unwrap func() gossh.NewChannel

type Server

+ ConnectionClosingCallback ConnectionClosingCallback

v1.1.0

Apr 18, 2026

v1.0.0

Apr 18, 2026

Changes in this version

+ const X11DisplayBasePort — darwin/amd64, js/wasm, linux/amd64

+ const X11DisplayHost — darwin/amd64, js/wasm, linux/amd64

+ const X11DisplayOffset — darwin/amd64, js/wasm, linux/amd64

+ var ContextKeyClientVersion = &contextKey

+ var ContextKeyConn = &contextKey

+ var ContextKeyKeepAlive = &contextKey

+ var ContextKeyLocalAddr = &contextKey

+ var ContextKeyPermissions = &contextKey

+ var ContextKeyPublicKey = &contextKey

+ var ContextKeyRemoteAddr = &contextKey

+ var ContextKeyServer = &contextKey

+ var ContextKeyServerVersion = &contextKey

+ var ContextKeySessionID = &contextKey

+ var ContextKeyUser = &contextKey

+ var DefaultChannelHandlers = map[string]ChannelHandler

+ var DefaultRequestHandlers = map[string]RequestHandler

+ var DefaultSubsystemHandlers = map[string]SubsystemHandler

+ var ErrServerClosed = errors.New("ssh: Server closed")

+ func AgentRequested(sess Session) bool

+ func DefaultSessionHandler(srv *Server, conn *gossh.ServerConn, newChan gossh.NewChannel, ctx Context)

+ func DirectStreamLocalHandler(srv *Server, _ *gossh.ServerConn, newChan gossh.NewChannel, ctx Context)

+ func DirectTCPIPHandler(srv *Server, _ *gossh.ServerConn, newChan gossh.NewChannel, ctx Context)

+ func ForwardAgentConnections(l net.Listener, s Session)

+ func ForwardX11Connections(l net.Listener, xauth *os.File, s Session) — darwin/amd64, js/wasm, linux/amd64

+ func Handle(handler Handler)

+ func KeepAliveRequestHandler(ctx Context, _ *Server, _ *gossh.Request) (ok bool, payload []byte)

+ func KeysEqual(ak, bk PublicKey) bool

+ func ListenAndServe(addr string, handler Handler, options ...Option) error

+ func NewAgentListener(dir string) (net.Listener, string, error)

+ func NewX11Forwarder(request X11) (net.Listener, *os.File, error) — darwin/amd64, js/wasm, linux/amd64

+ func Serve(l net.Listener, handler Handler, options ...Option) error

+ func SetAgentRequested(ctx Context)

+ type ChannelHandler func(srv *Server, conn *gossh.ServerConn, newChan gossh.NewChannel, ctx Context)

+ type ConnCallback func(ctx Context, conn net.Conn) net.Conn

+ type ConnectionCompleteCallback func(conn *gossh.ServerConn, err error)

+ type ConnectionFailedCallback func(conn net.Conn, err error)

+ type Context interface

+ ClientVersion func() string

+ KeepAlive func() *SessionKeepAlive

+ LocalAddr func() net.Addr

+ Permissions func() *Permissions

+ RemoteAddr func() net.Addr

+ ServerVersion func() string

+ SessionID func() string

+ SetValue func(key, value interface{})

+ User func() string

+ type ForwardedTCPHandler struct

+ func (h *ForwardedTCPHandler) HandleSSHRequest(ctx Context, srv *Server, req *gossh.Request) (bool, []byte)

+ type ForwardedUnixHandler struct

+ func (h *ForwardedUnixHandler) HandleSSHRequest(ctx Context, srv *Server, req *gossh.Request) (bool, []byte)

+ type Handler func(Session)

+ var DefaultHandler Handler

+ type KeepAliveMetrics struct

+ KeepAliveReplyReceived int

+ RequestHandlerCalled int

+ ServerRequestedKeepAlive int

+ type KeyboardInteractiveHandler func(ctx Context, challenger gossh.KeyboardInteractiveChallenge) bool

+ type LocalPortForwardingCallback func(ctx Context, destinationHost string, destinationPort uint32) bool

+ type LocalUnixForwardingCallback func(ctx Context, socketPath string) bool

+ type Option func(*Server) error

+ func HostKeyFile(filepath string) Option

+ func HostKeyPEM(bytes []byte) Option

+ func KeyboardInteractiveAuth(fn KeyboardInteractiveHandler) Option

+ func NoPty() Option

+ func NoX11Forwarding() Option

+ func PasswordAuth(fn PasswordHandler) Option

+ func PublicKeyAuth(fn PublicKeyHandler) Option

+ func WrapConn(fn ConnCallback) Option

+ type PasswordHandler func(ctx Context, password string) bool

+ type Permissions struct

+ type Pty struct

+ Modes gossh.TerminalModes

+ Term string

+ Window Window

+ type PtyCallback func(ctx Context, pty Pty) bool

+ type PublicKey interface

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

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

+ type PublicKeyHandler func(ctx Context, key PublicKey) bool

+ type RequestHandler func(ctx Context, srv *Server, req *gossh.Request) (ok bool, payload []byte)

+ type ReversePortForwardingCallback func(ctx Context, bindHost string, bindPort uint32) bool

+ type ReverseUnixForwardingCallback func(ctx Context, socketPath string) bool

+ type Server struct

+ Addr string

+ ChannelHandlers map[string]ChannelHandler

+ ClientAliveCountMax int

+ ClientAliveInterval time.Duration

+ ConnCallback ConnCallback

+ ConnectionCompleteCallback ConnectionCompleteCallback

+ ConnectionFailedCallback ConnectionFailedCallback

+ Handler Handler

+ HostSigners []Signer

+ IdleTimeout time.Duration

+ KeyboardInteractiveHandler KeyboardInteractiveHandler

+ LocalPortForwardingCallback LocalPortForwardingCallback

+ LocalUnixForwardingCallback LocalUnixForwardingCallback

+ MaxTimeout time.Duration

+ PasswordHandler PasswordHandler

+ PtyCallback PtyCallback

+ PublicKeyHandler PublicKeyHandler

+ RequestHandlers map[string]RequestHandler

+ ReversePortForwardingCallback ReversePortForwardingCallback

+ ReverseUnixForwardingCallback ReverseUnixForwardingCallback

+ ServerConfigCallback ServerConfigCallback

+ SessionRequestCallback SessionRequestCallback

+ SubsystemHandlers map[string]SubsystemHandler

+ Version string

+ X11ForwardingCallback X11Callback

+ func (srv *Server) AddHostKey(key Signer)

+ func (srv *Server) Close() error

+ func (srv *Server) Handle(fn Handler)

+ func (srv *Server) HandleConn(newConn net.Conn)

+ func (srv *Server) ListenAndServe() error

+ func (srv *Server) Serve(l net.Listener) error

+ func (srv *Server) SetOption(option Option) error

+ func (srv *Server) Shutdown(ctx context.Context) error

+ type ServerConfigCallback func(ctx Context) *gossh.ServerConfig

+ type Session interface

+ Break func(c chan<- bool)

+ Command func() []string

+ Context func() Context

+ DisablePTYEmulation func()

+ Environ func() []string

+ Exit func(code int) error

+ LocalAddr func() net.Addr

+ Permissions func() Permissions

+ Pty func() (Pty, <-chan Window, bool)

+ PublicKey func() PublicKey

+ RawCommand func() string

+ RemoteAddr func() net.Addr

+ Signals func(c chan<- Signal)

+ Subsystem func() string

+ User func() string

+ X11 func() (X11, bool)

+ type SessionKeepAlive struct

+ func NewSessionKeepAlive(clientAliveInterval time.Duration, clientAliveCountMax int) *SessionKeepAlive

+ func (ska *SessionKeepAlive) Close()

+ func (ska *SessionKeepAlive) Metrics() KeepAliveMetrics

+ func (ska *SessionKeepAlive) RequestHandlerCallback()

+ func (ska *SessionKeepAlive) Reset()

+ func (ska *SessionKeepAlive) ServerRequestedKeepAliveCallback()

+ func (ska *SessionKeepAlive) Ticks() <-chan time.Time

+ func (ska *SessionKeepAlive) TimeIsUp() bool

+ type SessionRequestCallback func(sess Session, requestType string) bool

+ 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 Signer interface

+ type SubsystemHandler func(s Session)

+ type Window struct

+ Height int

+ HeightPixels int

+ Width int

+ WidthPixels int

+ type X11 struct

+ AuthData string

+ AuthProtocol string

+ ScreenNumber int

+ SingleConnection bool

+ type X11Callback func(ctx Context, x11 X11) bool

+ type X11ForwardingCallback = X11Callback

+ type XAuthority struct — darwin/amd64, js/wasm, linux/amd64

+ Addr string

+ AddrLen uint16

+ Data string

+ DataLen uint16

+ Family uint16

+ Name string

+ NameLen uint16

+ Number string

+ NumberLen uint16

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL