ssh

Documentation

Index

• Constants
• Variables
• func ClassifyStderr(stderr string) error
• func ControlSocketPath(targetHost string) string
• func ExecCmd(target Destination, command string, stdin []byte, sshArgs ...string) *exec.Cmd
• func NewSSHTunnel(targetDest Destination, port string, useControlSockets bool) (operation.Operation, operation.Operation, operation.Operation)
• func ShellCommand(command string) string
• func SplitUserHostPort(raw string) (user, host, port string)
• type CheckSSHTunnelSecurity
  • func NewCheckSSHTunnelSecurity(targetDest Destination, port string) *CheckSSHTunnelSecurity
  • func (ct *CheckSSHTunnelSecurity) Command() *exec.Cmd
  • func (ct *CheckSSHTunnelSecurity) Description() string
  • func (ct *CheckSSHTunnelSecurity) DryRun(w io.Writer) error
  • func (ct *CheckSSHTunnelSecurity) Run(w io.Writer) error
• type Config
  • func NewConfig(dest Destination) Config
  • func NewConfigFromBytes(data []byte) Config
  • func (c Config) ConnectTimeout(fallback time.Duration) time.Duration
• type Destination
  • func NewDestination(destStr string) Destination
  • func (d Destination) AsURI() string
  • func (d Destination) IsLocalhost() bool
  • func (d Destination) IsPlainLocalhost() bool
  • func (d Destination) Slugify() string
  • func (d Destination) String() string
• type SSHTunnelProcessStop
  • func NewSSHTunnelProcessStop(start *SSHTunnelStart) *SSHTunnelProcessStop
  • func (s *SSHTunnelProcessStop) Command() *exec.Cmd
  • func (s *SSHTunnelProcessStop) Description() string
  • func (s *SSHTunnelProcessStop) DryRun(w io.Writer) error
  • func (s *SSHTunnelProcessStop) Run(w io.Writer) error
• type SSHTunnelStart
  • func NewSSHTunnelStart(targetDest Destination, port string, useControlSockets bool) *SSHTunnelStart
  • func (s *SSHTunnelStart) Command() *exec.Cmd
  • func (s *SSHTunnelStart) Description() string
  • func (s *SSHTunnelStart) DryRun(w io.Writer) error
  • func (s *SSHTunnelStart) Run(w io.Writer) error
• type SSHTunnelStop
  • func NewSSHTunnelStop(targetDest Destination) *SSHTunnelStop
  • func (s *SSHTunnelStop) Command() *exec.Cmd
  • func (s *SSHTunnelStop) Description() string
  • func (s *SSHTunnelStop) DryRun(w io.Writer) error
  • func (s *SSHTunnelStop) Run(w io.Writer) error

Constants

const TunnelPIDPlaceholder = "<ssh tunnel pid>"

Variables

var (
	ErrSSH              = errors.New("SSH failed")
	ErrAuthFailed       = fmt.Errorf("%w: authentication failed", ErrSSH)
	ErrConnectionFailed = fmt.Errorf("%w: connection failed", ErrSSH)
)

var PlainLocalhost = Destination{Host: "localhost"}

Functions

func ClassifyStderr

func ClassifyStderr(stderr string) error

ClassifyStderr inspects SSH stderr output and returns a typed error when a known failure pattern is detected, or nil if the output is unrecognised.

func ControlSocketPath

func ControlSocketPath(targetHost string) string

func ExecCmd

func ExecCmd(target Destination, command string, stdin []byte, sshArgs ...string) *exec.Cmd

ExecCmd builds a command to be executed on the target host. If the target is localhost, it will run locally when executed. Pass stdin data as optional parameter, or nil for no stdin.

func NewSSHTunnel

func NewSSHTunnel(targetDest Destination, port string, useControlSockets bool) (operation.Operation, operation.Operation, operation.Operation)

func ShellCommand

func ShellCommand(command string) string

func SplitUserHostPort

func SplitUserHostPort(raw string) (user, host, port string)

Types

type CheckSSHTunnelSecurity

type CheckSSHTunnelSecurity struct {
	TargetDest Destination
	Port       string
}

func NewCheckSSHTunnelSecurity

func NewCheckSSHTunnelSecurity(targetDest Destination, port string) *CheckSSHTunnelSecurity

func (*CheckSSHTunnelSecurity) Command

func (ct *CheckSSHTunnelSecurity) Command() *exec.Cmd

func (*CheckSSHTunnelSecurity) Description

func (ct *CheckSSHTunnelSecurity) Description() string

func (*CheckSSHTunnelSecurity) DryRun

func (ct *CheckSSHTunnelSecurity) DryRun(w io.Writer) error

func (*CheckSSHTunnelSecurity) Run

func (ct *CheckSSHTunnelSecurity) Run(w io.Writer) error

type Config

type Config struct {
	HostName string
	// contains filtered or unexported fields
}

func NewConfig

func NewConfig(dest Destination) Config

func NewConfigFromBytes

func NewConfigFromBytes(data []byte) Config

func (Config) ConnectTimeout

func (c Config) ConnectTimeout(fallback time.Duration) time.Duration

ConnectTimeout returns the user's configured ConnectTimeout if set, otherwise the fallback.

type Destination

type Destination struct {
	User string
	Host string
	Port string
}

func NewDestination

func NewDestination(destStr string) Destination

func (Destination) AsURI

func (d Destination) AsURI() string

func (Destination) IsLocalhost

func (d Destination) IsLocalhost() bool

func (Destination) IsPlainLocalhost

func (d Destination) IsPlainLocalhost() bool

func (Destination) Slugify

func (d Destination) Slugify() string

func (Destination) String

func (d Destination) String() string

type SSHTunnelProcessStop

type SSHTunnelProcessStop struct {
	Start *SSHTunnelStart
}

func NewSSHTunnelProcessStop

func NewSSHTunnelProcessStop(start *SSHTunnelStart) *SSHTunnelProcessStop

func (*SSHTunnelProcessStop) Command

func (s *SSHTunnelProcessStop) Command() *exec.Cmd

func (*SSHTunnelProcessStop) Description

func (s *SSHTunnelProcessStop) Description() string

func (*SSHTunnelProcessStop) DryRun

func (s *SSHTunnelProcessStop) DryRun(w io.Writer) error

func (*SSHTunnelProcessStop) Run

func (s *SSHTunnelProcessStop) Run(w io.Writer) error

type SSHTunnelStart

type SSHTunnelStart struct {
	TargetDest        Destination
	UseControlSockets bool
	Port              string
	Process           *os.Process
}

func NewSSHTunnelStart

func NewSSHTunnelStart(targetDest Destination, port string, useControlSockets bool) *SSHTunnelStart

func (*SSHTunnelStart) Command

func (s *SSHTunnelStart) Command() *exec.Cmd

func (*SSHTunnelStart) Description

func (s *SSHTunnelStart) Description() string

func (*SSHTunnelStart) DryRun

func (s *SSHTunnelStart) DryRun(w io.Writer) error

func (*SSHTunnelStart) Run

func (s *SSHTunnelStart) Run(w io.Writer) error

type SSHTunnelStop

type SSHTunnelStop struct {
	TargetDest Destination
}

func NewSSHTunnelStop

func NewSSHTunnelStop(targetDest Destination) *SSHTunnelStop

func (*SSHTunnelStop) Command

func (s *SSHTunnelStop) Command() *exec.Cmd

func (*SSHTunnelStop) Description

func (s *SSHTunnelStop) Description() string

func (*SSHTunnelStop) DryRun

func (s *SSHTunnelStop) DryRun(w io.Writer) error

func (*SSHTunnelStop) Run

func (s *SSHTunnelStop) Run(w io.Writer) error