sshutil

package

v0.21.0 Latest Latest Go to latest Published: Mar 16, 2024 License: Apache-2.0 Imports: 22 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/lima-vm/lima

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func CommonOpts(useDotSSH bool) ([]string, error)
func DetectOpenSSHVersion() semver.Version
func Format(w io.Writer, instName string, format FormatT, opts []string) error
func ParseOpenSSHVersion(version []byte) *semver.Version
func SSHArgsFromOpts(opts []string) []string
func SSHOpts(instDir string, useDotSSH, forwardAgent, forwardX11, forwardX11Trusted bool) ([]string, error)
type FormatT
type PubKey
- func DefaultPubKeys(loadDotSSH bool) ([]PubKey, error)

Constants ¶

View Source

const (
	// FormatCmd prints the full ssh command line.
	//
	// ssh -o IdentityFile="/Users/example/.lima/_config/user" -o User=example -o Hostname=127.0.0.1 -o Port=60022 lima-default
	FormatCmd = FormatT("cmd")

	// FormatArgs is similar to FormatCmd but omits "ssh" and the destination address
	//
	// -o IdentityFile="/Users/example/.lima/_config/user" -o User=example -o Hostname=127.0.0.1 -o Port=60022
	FormatArgs = FormatT("args")

	// FormatOptions prints the ssh option key value pairs.
	//
	// IdentityFile="/Users/example/.lima/_config/user"
	// User=example
	// Hostname=127.0.0.1
	// Port=60022
	FormatOptions = FormatT("options")

	// FormatConfig uses the ~/.ssh/config format
	//
	// Host lima-default
	//  IdentityFile "/Users/example/.lima/_config/user "
	//  User example
	//  Hostname 127.0.0.1
	//  Port 60022
	FormatConfig = FormatT("config")
)

Variables ¶

View Source

var Formats = []FormatT{FormatCmd, FormatArgs, FormatOptions, FormatConfig}

Formats is the list of the supported formats.

Functions ¶

func CommonOpts ¶ added in v0.7.2

func CommonOpts(useDotSSH bool) ([]string, error)

CommonOpts returns ssh option key-value pairs like {"IdentityFile=/path/to/id_foo"}. The result may contain different values with the same key.

The result always contains the IdentityFile option. The result never contains the Port option.

func DetectOpenSSHVersion ¶ added in v0.7.4

func DetectOpenSSHVersion() semver.Version

func Format ¶ added in v0.15.0

func Format(w io.Writer, instName string, format FormatT, opts []string) error

Format formats the ssh options.

func ParseOpenSSHVersion ¶ added in v0.7.2

func ParseOpenSSHVersion(version []byte) *semver.Version

func SSHArgsFromOpts ¶ added in v0.7.2

func SSHArgsFromOpts(opts []string) []string

SSHArgsFromOpts returns ssh args from opts. The result always contains {"-F", "/dev/null} in addition to {"-o", "KEY=VALUE", ...}.

func SSHOpts ¶ added in v0.7.2

func SSHOpts(instDir string, useDotSSH, forwardAgent, forwardX11, forwardX11Trusted bool) ([]string, error)

SSHOpts adds the following options to CommonOptions: User, ControlMaster, ControlPath, ControlPersist

Types ¶

type FormatT ¶ added in v0.15.0

type FormatT = string

FormatT specifies the format type.

type PubKey ¶

type PubKey struct {
	Filename string
	Content  string
}

func DefaultPubKeys ¶

func DefaultPubKeys(loadDotSSH bool) ([]PubKey, error)

DefaultPubKeys returns the public key from $LIMA_HOME/_config/user.pub. The key will be created if it does not yet exist.

When loadDotSSH is true, ~/.ssh/*.pub will be appended to make the VM accessible without specifying an identity explicitly.

Source Files ¶

View all Source files

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