ssh

Documentation

Index

• Variables
• func AddPrivateKeysToAgent(ctx context.Context, log log.Logger) error
• func ConfigFromKeyBytes(keyBytes []byte) (*ssh.ClientConfig, error)
• func ConfigureSSHConfig(configPath, context, workspace, user string, log log.Logger) error
• func FindPrivateKeys() ([]string, error)
• func GetDevPodHostKey() (string, error)
• func GetDevPodKeysDir() string
• func GetDevPodPrivateKeyRaw() ([]byte, error)
• func GetDevPodPublicKey() (string, error)
• func GetHostKey(context, workspaceID string) (string, error)
• func GetHostKeyBase(dir string) (string, error)
• func GetPrivateKeyRaw(context, workspaceID string) ([]byte, error)
• func GetPrivateKeyRawBase(dir string) ([]byte, error)
• func GetPublicKey(context, workspaceID string) (string, error)
• func GetPublicKeyBase(dir string) (string, error)
• func GetUser(workspace string) (string, error)
• func NewSSHClient(user, addr string, keyBytes []byte) (*ssh.Client, error)
• func NewSSHPassClient(user, addr, password string) (*ssh.Client, error)
• func PortForward(ctx context.Context, client *ssh.Client, ...) error
• func RemoveFromConfig(workspace string, log log.Logger) error
• func Run(ctx context.Context, client *ssh.Client, command string, stdin io.Reader, ...) error
• func StdioClient(reader io.Reader, writer io.WriteCloser, exitOnClose bool) (*ssh.Client, error)
• func StdioClientFromKeyBytesWithUser(keyBytes []byte, reader io.Reader, writer io.WriteCloser, user string, ...) (*ssh.Client, error)
• func StdioClientWithUser(reader io.Reader, writer io.WriteCloser, user string, exitOnClose bool) (*ssh.Client, error)
• func WatchWindowSize(ctx context.Context) <-chan os.Signal
• type DevPodSSHEntry

Variables

var (
	MarkerStartPrefix = "# DevPod Start "
	MarkerEndPrefix   = "# DevPod End "
)

var (
	DevPodSSHHostKeyFile    = "id_devpod_rsa_host"
	DevPodSSHPrivateKeyFile = "id_devpod_rsa"
	DevPodSSHPublicKeyFile  = "id_devpod_rsa.pub"
)

Functions

func AddPrivateKeysToAgent

func AddPrivateKeysToAgent(ctx context.Context, log log.Logger) error

func ConfigFromKeyBytes

func ConfigFromKeyBytes(keyBytes []byte) (*ssh.ClientConfig, error)

func ConfigureSSHConfig

func ConfigureSSHConfig(configPath, context, workspace, user string, log log.Logger) error

func FindPrivateKeys

func FindPrivateKeys() ([]string, error)

func GetDevPodHostKey

func GetDevPodHostKey() (string, error)

func GetDevPodKeysDir

func GetDevPodKeysDir() string

func GetDevPodPrivateKeyRaw

func GetDevPodPrivateKeyRaw() ([]byte, error)

func GetDevPodPublicKey

func GetDevPodPublicKey() (string, error)

func GetHostKey

func GetHostKey(context, workspaceID string) (string, error)

func GetHostKeyBase

func GetHostKeyBase(dir string) (string, error)

func GetPrivateKeyRaw

func GetPrivateKeyRaw(context, workspaceID string) ([]byte, error)

func GetPrivateKeyRawBase

func GetPrivateKeyRawBase(dir string) ([]byte, error)

func GetPublicKey

func GetPublicKey(context, workspaceID string) (string, error)

func GetPublicKeyBase

func GetPublicKeyBase(dir string) (string, error)

func GetUser

func GetUser(workspace string) (string, error)

func NewSSHClient

func NewSSHClient(user, addr string, keyBytes []byte) (*ssh.Client, error)

func NewSSHPassClient

func NewSSHPassClient(user, addr, password string) (*ssh.Client, error)

func PortForward

func PortForward(ctx context.Context, client *ssh.Client, localNetwork, localAddr, remoteNetwork, remoteAddr string, exitAfterTimeout time.Duration, log log.Logger) error

func RemoveFromConfig

func RemoveFromConfig(workspace string, log log.Logger) error

func Run

func Run(ctx context.Context, client *ssh.Client, command string, stdin io.Reader, stdout io.Writer, stderr io.Writer) error

func StdioClient

func StdioClient(reader io.Reader, writer io.WriteCloser, exitOnClose bool) (*ssh.Client, error)

func StdioClientFromKeyBytesWithUser

func StdioClientFromKeyBytesWithUser(keyBytes []byte, reader io.Reader, writer io.WriteCloser, user string, exitOnClose bool) (*ssh.Client, error)

func StdioClientWithUser

func StdioClientWithUser(reader io.Reader, writer io.WriteCloser, user string, exitOnClose bool) (*ssh.Client, error)

func WatchWindowSize

func WatchWindowSize(ctx context.Context) <-chan os.Signal

Types

type DevPodSSHEntry

type DevPodSSHEntry struct {
	Host      string
	User      string
	Workspace string
}