ssh

package

v2.34.1 Latest Latest Go to latest Published: Apr 1, 2024 License: Apache-2.0 Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/crc-org/crc

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

Variables
func GenerateSSHKey(path string) error
func RemoveCRCHostEntriesFromKnownHosts() error
type Client
- func NewClient(user string, host string, port int, keys ...string) (Client, error)
type KeyPair
- func NewKeyPair() (keyPair *KeyPair, err error)
- func (kp *KeyPair) WriteToFile(privateKeyPath string, publicKeyPath string) error
type NativeClient
- func (client *NativeClient) Close()
- func (client *NativeClient) Run(command string) ([]byte, []byte, error)
type Runner
- func CreateRunner(ip string, port int, privateKeys ...string) (*Runner, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrKeyGeneration     = errors.New("Unable to generate key")
	ErrPrivateKey        = errors.New("Unable to marshal private key")
	ErrPublicKey         = errors.New("Unable to convert public key")
	ErrUnableToWriteFile = errors.New("Unable to write file")
)

Functions ¶

func GenerateSSHKey ¶

func GenerateSSHKey(path string) error

GenerateSSHKey generates SSH keypair based on path of the private key The public key would be generated to the same path with ".pub" added

func RemoveCRCHostEntriesFromKnownHosts ¶

func RemoveCRCHostEntriesFromKnownHosts() error

Types ¶

type Client ¶

type Client interface {
	Run(command string) ([]byte, []byte, error)
	Close()
}

func NewClient ¶

func NewClient(user string, host string, port int, keys ...string) (Client, error)

type KeyPair ¶

type KeyPair struct {
	PrivateKey []byte
	PublicKey  []byte
}

func NewKeyPair ¶

func NewKeyPair() (keyPair *KeyPair, err error)

NewKeyPair generates a new SSH keypair This will return a private & public key encoded as DER.

func (*KeyPair) WriteToFile ¶

func (kp *KeyPair) WriteToFile(privateKeyPath string, publicKeyPath string) error

WriteToFile writes keypair to files

type NativeClient ¶

type NativeClient struct {
	User     string
	Hostname string
	Port     int
	Keys     []string
	// contains filtered or unexported fields
}

func (*NativeClient) Close ¶

func (client *NativeClient) Close()

func (*NativeClient) Run ¶

func (client *NativeClient) Run(command string) ([]byte, []byte, error)

type Runner ¶

type Runner struct {
	// contains filtered or unexported fields
}

func CreateRunner ¶

func CreateRunner(ip string, port int, privateKeys ...string) (*Runner, error)

func (*Runner) Close ¶

func (runner *Runner) Close()

func (*Runner) CopyData ¶

func (runner *Runner) CopyData(data []byte, destFilename string, mode os.FileMode) error

func (*Runner) CopyDataPrivileged ¶

func (runner *Runner) CopyDataPrivileged(data []byte, destFilename string, mode os.FileMode) error

func (*Runner) CopyFile ¶

func (runner *Runner) CopyFile(srcFilename string, destFilename string, mode os.FileMode) error

func (*Runner) CopyFileFromVM ¶

func (runner *Runner) CopyFileFromVM(srcFilename string, destFilename string, mode os.FileMode) error

func (*Runner) Run ¶

func (runner *Runner) Run(cmd string, args ...string) (string, string, error)

func (*Runner) RunPrivate ¶

func (runner *Runner) RunPrivate(cmd string, args ...string) (string, string, error)

func (*Runner) RunPrivileged ¶

func (runner *Runner) RunPrivileged(reason string, cmdAndArgs ...string) (string, string, error)

func (*Runner) WaitForConnectivity ¶

func (runner *Runner) WaitForConnectivity(ctx context.Context, timeout time.Duration) error

Source Files ¶

View all Source files

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