sshlib

Apr 29, 2026

Changes in this version

type Connect

+ AutoReconnect bool

+ AutoReconnectInterval int

+ AutoReconnectMax int

Apr 16, 2026

Changes in this version

+ func CreateAuthMethodPublicKeyTransient(key, password string) (auth ssh.AuthMethod, err error)

type ControlPersistAuthMethod

+ Transient bool

Apr 14, 2026

Changes in this version

type SFTPFS

+ func (fs *SFTPFS) Chmod(name string, mode os.FileMode) error

+ func (fs *SFTPFS) Chown(name string, uid, gid int) error

+ func (fs *SFTPFS) Chtimes(name string, atime, mtime time.Time) error

+ func (fs *SFTPFS) Lchown(name string, uid, gid int) error

Apr 11, 2026

Changes in this version

type Connect — darwin/amd64, linux/amd64

+ func (c *Connect) FUSEForward(mountpoint, basepoint string) (err error)

+ func (c *Connect) FUSEReverseForward(mountpoint, sharepoint string) (err error)

+ func (c *Connect) SMBForward(address, port, shareName, basepoint string) (err error)

+ func (c *Connect) SMBReverseForward(address, port, shareName, sharepoint string) (err error)

type Connect — js/wasm, windows/amd64

+ func (c *Connect) FUSEForward(mountpoint, basepoint string) error

+ func (c *Connect) FUSEReverseForward(mountpoint, sharepoint string) error

Apr 7, 2026

Changes in this version

type Connect

+ func (c *Connect) LocalForward(localNetwork, localAddr, remoteNetwork, remoteAddr string) (err error)

+ func (c *Connect) OpenSFTP() (*sftp.Client, error)

+ func (c *Connect) RemoteForward(localNetwork, localAddr, remoteNetwork, remoteAddr string) (err error)

+ func (c *Connect) UnixLocalForward(localPath, remotePath string) error

+ func (c *Connect) UnixRemoteForward(localPath, remotePath string) error

Apr 6, 2026

Changes in this version

+ func RequestTtyWithSize(session *ssh.Session, term string, cols, rows int, modes ssh.TerminalModes) error

type Connect

+ func (c *Connect) Dial(network, addr string) (net.Conn, error)

+ func (c *Connect) Listen(network, addr string) (net.Listener, error)

+ func (c *Connect) OpenTerminal(opts TerminalOptions) (*Terminal, error)

+ type Terminal struct

+ Session *ssh.Session

+ Stderr io.Reader

+ Stdin io.WriteCloser

+ Stdout io.Reader

+ func (t *Terminal) Close() error

+ func (t *Terminal) Resize(cols, rows int) error

+ func (t *Terminal) Wait() error

+ type TerminalOptions struct

+ Cols int

+ Command string

+ Modes ssh.TerminalModes

+ Rows int

+ StartShell bool

+ Term string

Mar 26, 2026

Changes in this version

+ func CreateAuthMethodPKCS11WithPrompt(provider, pin string, prompt PromptFunc) (auth []ssh.AuthMethod, err error)

+ func CreateSignerPKCS11WithPrompt(provider, pin string, prompt PromptFunc) (signers []ssh.Signer, err error)

type C11

+ Prompt PromptFunc

type Connect

+ ProxyRoute []ProxyRoute

type ControlPersistAuth

+ Methods []ControlPersistAuthMethod

+ type ControlPersistAuthMethod struct

+ KeyPass string

+ KeyPath string

+ PKCS11PIN string

+ PKCS11Provider string

+ Password string

+ Type string

+ type PromptFunc func(string) (string, error)

+ type ProxyRoute struct

+ Addr string

+ Auth *ControlPersistAuth

+ Command string

+ Password string

+ Port string

+ Type string

+ User string

Mar 21, 2026

Changes in this version

+ const TunnelDeviceAny

type Connect

+ ControlMaster string

+ ControlPath string

+ ControlPersist time.Duration

+ ControlPersistAuth *ControlPersistAuth

+ func (c *Connect) Close() error

+ func (c *Connect) IsControlClient() bool

+ func (c *Connect) SpawnedControlMaster() bool

+ func (c *Connect) Tunnel(localTun, remoteTun int) (*Tunnel, error)

+ func (c *Connect) TunnelWithMode(localTun, remoteTun int, mode TunnelMode) (*Tunnel, error)

+ type ControlPersistAuth struct

+ AuthMethods []ssh.AuthMethod

+ type Tunnel struct

+ LocalID int

+ LocalName string

+ Mode TunnelMode

+ RemoteID int

+ func (t *Tunnel) Close() error

+ func (t *Tunnel) LocalInterface() *net.Interface

+ func (t *Tunnel) Wait() error

+ type TunnelMode uint32

+ const TunnelModeEthernet

+ const TunnelModePointToPoint

+ func (m TunnelMode) String() string

Nov 18, 2024

Changes in this version

type Connect

+ StdoutMutex *sync.Mutex

+ func (c *Connect) VerifyAndAppendNew(hostname string, remote net.Addr, key ssh.PublicKey) (err error)

Sep 9, 2024

Changes in this version

type Connect

+ PtyRelayTty *os.File

+ func (c *Connect) ChangeWinSize(session *ssh.Session)

Aug 13, 2024

Changes in this version

+ func NewChangeOSFS(fs billy.Filesystem) billy.Filesystem

+ func NewChangeSFTPFS(client *sftp.Client, base string) billy.Filesystem

+ type COS struct

+ func (fs COS) Chmod(name string, mode os.FileMode) error

+ func (fs COS) Chown(name string, uid, gid int) error

+ func (fs COS) Chtimes(name string, atime time.Time, mtime time.Time) error

+ func (fs COS) Lchown(name string, uid, gid int) error

+ func (fs COS) Link(path string, link string) error

+ func (fs COS) Mkfifo(path string, mode uint32) error

+ func (fs COS) Mknod(path string, mode uint32, major uint32, minor uint32) error

+ func (fs COS) Socket(path string) error

type Connect

+ func (c *Connect) NFSForward(address, port, basepoint string) (err error)

+ func (c *Connect) NFSReverseForward(address, port, sharepoint string) (err error)

type ContextDialer

+ Dialer proxy.Dialer

+ func (c *ContextDialer) GetDialer() proxy.Dialer

type NetPipe

+ Cmd *exec.Cmd

+ type SFTPFS struct

+ Client *sftp.Client

+ func (fs *SFTPFS) Capabilities() billy.Capability

+ func (fs *SFTPFS) Create(filename string) (billy.File, error)

+ func (fs *SFTPFS) Join(elem ...string) string

+ func (fs *SFTPFS) Lstat(filename string) (os.FileInfo, error)

+ func (fs *SFTPFS) MkdirAll(filename string, perm os.FileMode) error

+ func (fs *SFTPFS) Open(filename string) (billy.File, error)

+ func (fs *SFTPFS) OpenFile(filename string, flag int, perm os.FileMode) (billy.File, error)

+ func (fs *SFTPFS) ReadDir(path string) ([]os.FileInfo, error)

+ func (fs *SFTPFS) Readlink(link string) (string, error)

+ func (fs *SFTPFS) Remove(filename string) error

+ func (fs *SFTPFS) RemoveAll(filename string) error

+ func (fs *SFTPFS) Rename(from, to string) error

+ func (fs *SFTPFS) Stat(filename string) (os.FileInfo, error)

+ func (fs *SFTPFS) Symlink(target, link string) error

+ func (fs *SFTPFS) TempFile(dir, prefix string) (billy.File, error)

Aug 10, 2024

Changes in this version

+ type ContextDialer struct

+ func (c *ContextDialer) Dial(network, addr string) (net.Conn, error)

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

+ type ProxyDialer interface

+ Dial func(network, addr string) (net.Conn, error)

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

Aug 10, 2024

Changes in this version

type NetPipe

+ func (n *NetPipe) DialContext(ctx context.Context, network, addr string) (con net.Conn, err error)

Jul 2, 2024

Changes in this version

type Connect

+ func (c *Connect) HTTPReverseDynamicForward(address, port string) (err error)

Apr 27, 2024

Changes in this version

type Connect

+ DynamicForwardLogger *log.Logger

+ ForwardX11Trusted bool

+ HostKeyCallback ssh.HostKeyCallback

+ func (c *Connect) HTTPDynamicForward(address, port string) (err error)

+ type XAuth struct

+ Display string

+ XAuthorityFilePath string

+ func (x *XAuth) GetXAuthCookie(trusted bool) (cookie string, err error)

+ func (x *XAuth) GetXAuthList() (entries []xAuthEntry, err error)

Mar 10, 2022

Changes in this version

type Connect

+ CheckKnownHosts bool

+ KnownHostsFiles []string

+ OverwriteKnownHosts bool

+ TextAskOverwriteKnownHosts string

+ TextAskWriteKnownHosts string

+ func (c *Connect) TCPReverseDynamicForward(address, port string) (err error)

+ type OverwriteInventory struct

+ Address string

+ Fingerprint string

+ OldKeyText string

+ RemoteAddr string

+ type WriteInventory struct

+ Address string

+ Fingerprint string

+ RemoteAddr string

Mar 8, 2022

Changes in this version

+ func GetStdin() io.ReadCloser

Oct 31, 2021

Changes in this version

type Connect

+ func (c *Connect) SetLogWithRemoveAnsiCode(path string, timestamp bool)

Oct 27, 2020

Changes in this version

+ type C11 struct

+ Ctx *crypto11.Context

+ Label string

+ PIN string

+ func (c *C11) CreateCtx(provider string) (err error)

+ func (c *C11) GetSigner() (signer []crypto11.Signer, err error)

Sep 22, 2019

Changes in this version

+ func CreateSignerAgent(sshAgent interface{}) (signers []ssh.Signer, err error)

+ func CreateSignerPKCS11Prompt(provider, pin string) (signers []ssh.Signer, err error)

+ func CreateSignerPublicKeyData(keyData []byte, password string) (signer ssh.Signer, err error)

+ func CreateSignerPublicKeyPrompt(key, password string) (signer ssh.Signer, err error)

type AgentInterface

+ func ConnectSshAgent() (ag AgentInterface)

type Connect

+ Agent AgentInterface

+ ConnectTimeout int

+ SendKeepAliveInterval int

+ SendKeepAliveMax int

+ Session *ssh.Session

+ Stderr io.Writer

+ Stdout io.Writer

+ func (c *Connect) CmdShell(session *ssh.Session, command string) (err error)

+ func (c *Connect) Command(command string) (err error)

+ func (c *Connect) TCPDynamicForward(address, port string) (err error)

+ func (c *Connect) TCPLocalForward(localAddr, remoteAddr string) (err error)

+ func (c *Connect) TCPRemoteForward(localAddr, remoteAddr string) (err error)

type NetPipe

+ Command string

type PKCS11

+ func (p *PKCS11) GetPIN() (err error)

Jul 16, 2019

Changes in this version

+ func CreateAuthMethodCertificate(cert string, keySigner ssh.Signer) (auth ssh.AuthMethod, err error)

+ func CreateAuthMethodPKCS11(provider, pin string) (auth []ssh.AuthMethod, err error)

+ func CreateAuthMethodPassword(password string) (auth ssh.AuthMethod)

+ func CreateAuthMethodPublicKey(key, password string) (auth ssh.AuthMethod, err error)

+ func CreateSignerCertificate(cert string, keySigner ssh.Signer) (certSigner ssh.Signer, err error)

+ func CreateSignerPKCS11(provider, pin string) (signers []ssh.Signer, err error)

+ func CreateSignerPublicKey(key, password string) (signer ssh.Signer, err error)

+ func RequestTty(session *ssh.Session) (err error)

+ type AgentInterface interface

+ type Connect struct

+ Client *ssh.Client

+ ForwardAgent bool

+ ForwardX11 bool

+ ProxyDialer proxy.Dialer

+ Stdin []byte

+ TTY bool

+ func (c *Connect) AddKeySshAgent(key interface{})

+ func (c *Connect) CheckClientAlive() error

+ func (c *Connect) Cmd(command string, output chan []byte) (err error)

+ func (c *Connect) CmdWriter(command string, output chan []byte, input chan io.Writer) (err error)

+ func (c *Connect) ConnectSshAgent()

+ func (c *Connect) CreateClient(host, user, port string, authMethods []ssh.AuthMethod) (err error)

+ func (c *Connect) CreateSession() (session *ssh.Session, err error)

+ func (c *Connect) ForwardSshAgent(session *ssh.Session) *ssh.Session

+ func (c *Connect) SendKeepAlive(session *ssh.Session)

+ func (c *Connect) SetLog(path string, timestamp bool)

+ func (c *Connect) Shell() (err error)

+ func (c *Connect) TCPForward(localAddr, remoteAddr string) (err error)

+ func (c *Connect) X11Forward(session *ssh.Session) (err error)

+ type NetPipe struct

+ PipeClient net.Conn

+ func (n *NetPipe) Dial(network, addr string) (net.Conn, error)

+ type PKCS11 struct

+ Ctx *pkcs11.Ctx

+ KeyID map[int][]byte

+ Label string

+ PIN string

+ Pkcs11Provider string

+ SessionHandle pkcs11.SessionHandle

+ SlotID uint

+ func (p *PKCS11) CreateCtx() (err error)

+ func (p *PKCS11) GetCryptoSigner() (signers []crypto.Signer, err error)

+ func (p *PKCS11) GetKeyID() (err error)

+ func (p *PKCS11) GetTokenLabel() (err error)

+ func (p *PKCS11) RecreateCtx(pkcs11Provider string) (err error)

+ type Proxy struct

+ Addr string

+ Command string

+ Forwarder proxy.Dialer

+ Password string

+ Port string

+ Type string

+ User string

+ func (p *Proxy) CreateHttpProxyDialer() (proxyDialer proxy.Dialer, err error)

+ func (p *Proxy) CreateProxyCommandProxyDialer() (proxyDialer proxy.Dialer, err error)

+ func (p *Proxy) CreateProxyDialer() (proxyDialer proxy.Dialer, err error)

+ func (p *Proxy) CreateSocks5ProxyDialer() (proxyDialer proxy.Dialer, err error)