sshbox

May 30, 2022

Changes in this version

+ func WithSeparator(separator []byte) commanderSessionOptions

May 24, 2022

Changes in this version

+ func DefaultSanitizePromptLine(line []byte) []byte

+ func WithSanitizePromptLine(sanitizePromptLine func(line []byte) []byte) commanderSessionOptions

May 20, 2022

Changes in this version

type Emitter

+ func (em *Emitter) EmitClosedSsh()

+ func (em *Emitter) OffClosedSsh(events ...<-chan emitter.Event)

+ func (em *Emitter) OnClosedSsh() <-chan emitter.Event

type Gateways

+ func (g Gateways) Close()

type SSHBox

+ func (t *SSHBox) Close()

+ type SShInGateways struct

+ func NewSShInGateways(sshConf *SSHConf, gatewaysConf []*SSHConf) (*SShInGateways, error)

+ func (S *SShInGateways) Close()

+ func (S *SShInGateways) SSHBox() *SSHBox

May 13, 2022

Changes in this version

+ func WithErrorMatcher(errorMatcher func(content []byte) bool) commanderSessionOptions

+ func WithPromptMatcher(promptMatcher func(line []byte) bool) commanderSessionOptions

+ func WithSessionOptions(opts ...SSHSessionOptions) commanderSessionOptions

+ func WithSubSystem(subsystem string) commanderSessionOptions

type InteractiveSSH

+ func (c *InteractiveSSH) InteractiveSessionSubSystem(subsystem string, terminalRequest TTYRequest, sessOpts ...SSHSessionOptions) error

+ func (c *InteractiveSSH) InteractiveSubSystem(subsystem string, sessOpts ...SSHSessionOptions) error

May 12, 2022

Changes in this version

+ func DefaultErrorMatcher(content []byte) bool

+ func DefaultPromptMatcher(line []byte) bool

+ type TerminalError struct

+ func IsTerminalError(err error) (*TerminalError, bool)

+ func (e TerminalError) Error() string

May 11, 2022

Changes in this version

+ func DefaultMatcher(line []byte) bool

+ func MakeSessionNoTerminal(client *ssh.Client, opts ...SSHSessionOptions) (*ssh.Session, error)

+ type CommanderSSH struct

+ func NewCommanderSSH(sshBox *SSHBox) *CommanderSSH

+ func (c *CommanderSSH) CombinedOutput(cmd string, opts ...SSHSessionOptions) ([]byte, error)

+ func (c *CommanderSSH) Run(cmd string, opts ...SSHSessionOptions) (stdout []byte, stderr []byte, err error)

+ type CommanderSession struct

+ func NewCommanderSession(client *ssh.Client, matcher ExpectPromptMatcher, opts ...SSHSessionOptions) (*CommanderSession, error)

+ func (c *CommanderSession) Close() error

+ func (c *CommanderSession) Run(cmd string) ([]byte, error)

+ func (c *CommanderSession) SetMatcher(matcher ExpectPromptMatcher)

+ type ExpectPromptMatcher func(line []byte) bool

+ type SSHSessionOptions func(session *ssh.Session) error

+ func SetSubsystem(subsystem string) SSHSessionOptions

May 21, 2021

Changes in this version

+ func SetLogger(newLogger *logrus.Logger)

type SSHConf

+ Host string

+ func (c *SSHConf) String() string

type TunnelTarget

+ func (c *TunnelTarget) String() string

Sep 21, 2020

Changes in this version

+ func NameResolverFactoryTunnels(dnsservers []string) func(sshBox *SSHBox) (NameResolver, error)

Sep 21, 2020

Changes in this version

type SSHBox

+ func (t *SSHBox) SetNameResolverFactory(nrf NameResolverFactory)

Sep 21, 2020

Changes in this version

type SSHBox

+ func (t *SSHBox) HandleRTunnelClient(client net.Conn, target *TunnelTarget)

+ func (t *SSHBox) HandleTunnelClient(client net.Conn, target *TunnelTarget)

Sep 21, 2020

Changes in this version

+ func HandleRTunnelClient(client net.Conn, target *TunnelTarget)

+ func HandleTunnelClient(client net.Conn, sshClient *ssh.Client, target *TunnelTarget)

Sep 21, 2020

Changes in this version

+ func DefaultSshClientFactory(conf SSHConf) (*ssh.Client, error)

+ func NewNameResolverSimple(servers []string) *nameResolverSimple

+ func OptNameResolverFactory(nameResolverFactory NameResolverFactory) func(box *SSHBox) error

+ func OptSSHClientFactory(factory SshClientFactory) func(box *SSHBox) error

+ func OptSocksConf(conf *socks5.Config) func(box *SSHBox) error

+ type DnsConfig struct

+ Attempts int

+ Err error

+ Lookup []string

+ Ndots int

+ Rotate bool

+ Search []string

+ Servers []string

+ Timeout int

+ UnknownOpt bool

+ func DnsConfFromSSH(sshBox *SSHBox) (*DnsConfig, error)

+ type Emitter struct

+ func NewEmitter() *Emitter

+ func (em *Emitter) EmitStopSocks()

+ func (em *Emitter) EmitStopSsh()

+ func (em *Emitter) EmitStopTunnels()

+ func (em *Emitter) ListenersStartTunnels() []<-chan emitter.Event

+ func (em *Emitter) ListenersStopSocks() []<-chan emitter.Event

+ func (em *Emitter) ListenersStopSsh() []<-chan emitter.Event

+ func (em *Emitter) ListenersStopTunnels() []<-chan emitter.Event

+ func (em *Emitter) OffStartTunnels(events ...<-chan emitter.Event)

+ func (em *Emitter) OffStopSocks(events ...<-chan emitter.Event)

+ func (em *Emitter) OffStopSsh(events ...<-chan emitter.Event)

+ func (em *Emitter) OffStopTunnels(events ...<-chan emitter.Event)

+ func (em *Emitter) OnStartTunnels() <-chan emitter.Event

+ func (em *Emitter) OnStopSocks() <-chan emitter.Event

+ func (em *Emitter) OnStopSsh() <-chan emitter.Event

+ func (em *Emitter) OnStopTunnels() <-chan emitter.Event

+ func (em *Emitter) ToError(evt emitter.Event) error

+ type ErrLoad struct

+ func (e ErrLoad) Error() string

+ type GatewayInfo struct

+ LocalPort int

+ RemoteHost string

+ RemotePort int

+ SrcSSHUri string

+ type Gateways struct

+ func NewGateways(gateways []*SSHConf) *Gateways

+ func (g Gateways) RunGateways(sshUri string) (string, error)

+ type InteractiveSSH struct

+ func NewInteractiveSSH(sshBox *SSHBox) *InteractiveSSH

+ func (c *InteractiveSSH) Interactive() error

+ func (c *InteractiveSSH) InteractiveSession(commands []string, terminalRequest TTYRequest) error

+ func (c *InteractiveSSH) RunCmd(cmd []string) error

+ func (c *InteractiveSSH) Stop() error

+ type NameResolver interface

+ Resolve func(ctx netctx.Context, name string) (context.Context, net.IP, error)

+ func NameResolverFactorySSH(sshBox *SSHBox) (NameResolver, error)

+ type NameResolverFactory func(sshBox *SSHBox) (NameResolver, error)

+ type PublicKeys struct

+ Signer ssh.Signer

+ User string

+ func NewPublicKeys(pemBytes []byte, password string) (*PublicKeys, error)

+ func NewPublicKeysFromFile(pemFile, password string) (*PublicKeys, error)

+ type SSHBox struct

+ func NewSSHBox(config SSHConf, opts ...SSHBoxOptions) (*SSHBox, error)

+ func (t *SSHBox) SSHClient() *ssh.Client

+ func (t *SSHBox) StartSocksServer(port int, network string) error

+ func (t *SSHBox) StartTunnels(tunnelTargets []*TunnelTarget) error

+ func (t *SSHBox) StopSSH()

+ func (t *SSHBox) StopSocksServer()

+ func (t *SSHBox) StopTunnelsServer()

+ func (t SSHBox) Emitter() *Emitter

+ type SSHBoxOptions func(sshBox *SSHBox) error

+ type SSHConf struct

+ HostKeyFingerprint string

+ NoSSHAgent bool

+ Passphrase string

+ Password string

+ PrivateKey string

+ SSHAuthSock *string

+ SSHUri string

+ User string

+ func (c *SSHConf) CheckAndFill() error

+ type SshClientFactory func(conf SSHConf) (*ssh.Client, error)

+ type TTYRequest int

+ const RequestTTYAuto

+ const RequestTTYForce

+ const RequestTTYNo

+ const RequestTTYYes

+ type TunnelTarget struct

+ LocalPort int

+ Network string

+ RemoteHost string

+ RemotePort int

+ Reverse bool

+ func DNSServerToTunnel(dnsservers []string) ([]*TunnelTarget, error)

+ func (c *TunnelTarget) CheckAndFill() error

+ type TunnelTargets []*TunnelTarget