package
2.0.0-alpha.3
Repository: https://github.com/k0sproject/rig.git
Documentation: pkg.go.dev

# Packages

Package agent provides a client implementation for the SSH agent.
Package hostkey implements a callback for the ssh.ClientConfig.HostKeyCallback.

# Functions

DefaultPasswordCallback is a default implementation for PasswordCallback.
NewConnection creates a new SSH connection.
NewOptions creates a new Options struct with the given options applied.
ParseSSHPrivateKey is a convenience utility to parses a private key and return []ssh.AuthMethod to be used in SSH{} AuthMethods field.
WithKeepAlive sets the keep-alive interval option.
WithLogger sets the logger option.

# Variables

ConfigParser is an instance of rig/v2/sshconfig.Parser - it is exported here for weird design decisions made in rig v0.x and will be removed in rig v2 final.
ErrChecksumMismatch is returned when the checksum of an uploaded file does not match expectation.

# Structs

Config describes an SSH connection's configuration.
Connection describes an SSH connection.
Options for the SSH client.

# Type aliases

Option is a function that sets some option on the Options struct.
PasswordCallback is a function that is called when a passphrase is needed to decrypt a private key.