sshconfig

package

v0.4.0 Latest Latest Go to latest Published: Mar 27, 2022 License: BSD-3-Clause Imports: 13 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

Package sshconfig provides a way to work with the ssh user config file.

This section is empty.

This section is empty.

func BackupSSHConfig(path string) error

BackupSSHConfig backs up any SSH config file that currently exists.

func GetHostInfo(db database.DataStore, hostname, host string) ([]string, error)

GetHostInfo returns the information about a SSH entry.

func ImportConf(ctx context.Context, db database.DataStore, env env.Environment) error

ImportConf reads in the current $HOME/.ssh/config and stores the contents in the DB.

func WriteConf(ctx context.Context, db database.DataStore, env env.Environment) error

WriteConf writes out a new SSH config file with information from the DB.

func WriteNewConfig(db database.DataStore, hostname, path string) error

WriteNewConfig writes out a new SSH user config file.

func WriteToDB(db database.DataStore, hostname string, entry *sshcfg.SSHHost) error

WriteToDB writes a host entry to the DB.

type SSHHosts []*sshcfg.SSHHost

SSHHosts is a slice of sshconfig.SSHHost.

func Import(filePath string) (SSHHosts, error)

Import reads in the user's SSH config file from $HOME/.ssh/config and returns it's contents as SSHHosts, or returns an error.