cmd

Documentation

Index

• Constants
• func AllowSSH(args []string, spaceFactory space.SpaceFactory) error
• func DisableSSH(args []string, appFactory app.AppFactory) error
• func DisallowSSH(args []string, spaceFactory space.SpaceFactory) error
• func EnableSSH(args []string, appFactory app.AppFactory) error
• func SSHAllowed(args []string, spaceFactory space.SpaceFactory, output io.Writer) error
• func SSHEnabled(args []string, appFactory app.AppFactory, output io.Writer) error
• type ListenerFactory
  • func DefaultListenerFactory() ListenerFactory
• type SecureClient
• type SecureDialer
  • func DefaultSecureDialer() SecureDialer
• type SecureSession
• type SecureShell
  • func NewSecureShell(secureDialer SecureDialer, terminalHelper terminal.TerminalHelper, ...) SecureShell

Constants

const AllowSSHUsage = "cf allow-space-ssh SPACE_NAME"

const DisableSSHUsage = "cf disable-ssh APP_NAME"

const DisallowSSHUsage = "cf disallow-space-ssh SPACE_NAME"

const EnableSSHUsage = "cf enable-ssh APP_NAME"

const SSHAllowedUsage = "cf space-ssh-allowed SPACE_NAME"

const SSHEnabledUsage = "cf ssh-enabled APP_NAME"

Functions

func AllowSSH

func AllowSSH(args []string, spaceFactory space.SpaceFactory) error

func DisableSSH

func DisableSSH(args []string, appFactory app.AppFactory) error

func DisallowSSH

func DisallowSSH(args []string, spaceFactory space.SpaceFactory) error

func EnableSSH

func EnableSSH(args []string, appFactory app.AppFactory) error

func SSHAllowed

func SSHAllowed(args []string, spaceFactory space.SpaceFactory, output io.Writer) error

func SSHEnabled

func SSHEnabled(args []string, appFactory app.AppFactory, output io.Writer) error

Types

type ListenerFactory

type ListenerFactory interface {
	Listen(network, address string) (net.Listener, error)
}

func DefaultListenerFactory

func DefaultListenerFactory() ListenerFactory

type SecureClient

type SecureClient interface {
	NewSession() (SecureSession, error)
	Conn() ssh.Conn
	Dial(network, address string) (net.Conn, error)
	Wait() error
	Close() error
}

type SecureDialer

type SecureDialer interface {
	Dial(network, address string, config *ssh.ClientConfig) (SecureClient, error)
}

func DefaultSecureDialer

func DefaultSecureDialer() SecureDialer

type SecureSession

type SecureSession interface {
	RequestPty(term string, height, width int, termModes ssh.TerminalModes) error
	SendRequest(name string, wantReply bool, payload []byte) (bool, error)
	StdinPipe() (io.WriteCloser, error)
	StdoutPipe() (io.Reader, error)
	StderrPipe() (io.Reader, error)
	Start(command string) error
	Shell() error
	Wait() error
	Close() error
}

type SecureShell

type SecureShell interface {
	Connect(opts *options.SSHOptions) error
	InteractiveSession() error
	LocalPortForward() error
	Wait() error
	Close() error
}

func NewSecureShell

func NewSecureShell(
	secureDialer SecureDialer,
	terminalHelper terminal.TerminalHelper,
	listenerFactory ListenerFactory,
	keepAliveInterval time.Duration,
	appFactory app.AppFactory,
	infoFactory info.InfoFactory,
	credFactory credential.CredentialFactory,
) SecureShell