ssh

package

v1.3.1 Latest Latest Go to latest Published: Mar 17, 2026 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/arm/topo

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func ControlSocketPath(targetHost string) string
func ExecCmd(target Host, command string, stdin []byte, sshArgs ...string) *exec.Cmd
func NewSSHTunnel(targetHost Host, port string, useControlSockets bool) (operation.Operation, operation.Operation, operation.Operation)
func ShellCommand(command string) string
func SplitUserHostPort(raw string) (user, host, port string)
func ValidateBinaryName(bin string) error
type CheckSSHTunnelSecurity
- func NewCheckSSHTunnelSecurity(targetHost Host, 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 Host
- func (h Host) AsURI() string
- func (h Host) IsLocalhost() bool
- func (h Host) IsPlainLocalhost() bool
- func (h Host) Slugify() 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(targetHost Host, 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(targetHost Host) *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 ¶

View Source

const PlainLocalhost = Host("localhost")

View Source

const TunnelPIDPlaceholder = "<ssh tunnel pid>"

Variables ¶

View Source

var BinaryRegex = regexp.MustCompile(`^[A-Za-z0-9_+-]+$`)

Functions ¶

func ControlSocketPath ¶

func ControlSocketPath(targetHost string) string

func ExecCmd ¶

func ExecCmd(target Host, 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(targetHost Host, 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)

func ValidateBinaryName ¶

func ValidateBinaryName(bin string) error

Types ¶

type CheckSSHTunnelSecurity ¶

type CheckSSHTunnelSecurity struct {
	TargetHost Host
	Port       string
}

func NewCheckSSHTunnelSecurity ¶

func NewCheckSSHTunnelSecurity(targetHost Host, 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 Host ¶

type Host string

func (Host) AsURI ¶

func (h Host) AsURI() string

func (Host) IsLocalhost ¶

func (h Host) IsLocalhost() bool

func (Host) IsPlainLocalhost ¶

func (h Host) IsPlainLocalhost() bool

func (Host) Slugify ¶

func (h Host) Slugify() 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 {
	TargetHost        Host
	UseControlSockets bool
	Port              string
	Process           *os.Process
}

func NewSSHTunnelStart ¶

func NewSSHTunnelStart(targetHost Host, 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 {
	TargetHost Host
}

func NewSSHTunnelStop ¶

func NewSSHTunnelStop(targetHost Host) *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

Source Files ¶

View all Source files

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