Documentation
¶
Overview ¶
Package ssh allows to manage SSH connections and send commands through them.
Index ¶
- func CheckPrivateSshConnection(publicHost, privateHost *Host, command string) (string, error)
- func CheckSshCommand(host *Host, command string) (string, error)
- func CheckSshCommandWithRetry(host *Host, command string, retries int, sleepBetweenRetries time.Duration, ...) (string, error)
- func CheckSshConnection(host *Host) error
- func CheckSshConnectionWithRetry(host *Host, retries int, sleepBetweenRetries time.Duration, ...) error
- func Close(closeable Closeable, ignoreErrors ...string)
- func FetchContentsOfFile(host *Host, useSudo bool, filePath string) (string, error)
- func FetchContentsOfFiles(host *Host, useSudo bool, filePaths ...string) (map[string]string, error)
- func NoOpHostKeyCallback(hostname string, remote net.Addr, key ssh.PublicKey) error
- func ScpDirFrom(options ScpDownloadOptions, useSudo bool) error
- func ScpFileFrom(host *Host, remotePath string, localDestination *os.File, useSudo bool) error
- func ScpFileTo(host *Host, mode os.FileMode, remotePath, contents string) error
- type Closeable
- type Host
- type JumpHostSession
- type KeyPair
- type ScpDownloadOptions
- type SshAgent
- type SshConnectionOptions
- type SshSession
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckPrivateSshConnection ¶
CheckPrivateSshConnection attempts to connect to privateHost (which is not addressable from the Internet) via a separate publicHost (which is addressable from the Internet) and then executes "command" on privateHost and returns its output. It is useful for checking that it's possible to SSH from a Bastion Host to a private instance.
func CheckSshCommand ¶
CheckSshCommand checks that you can connect via SSH to the given host and run the given command. Returns the stdout/stderr.
func CheckSshCommandWithRetry ¶
func CheckSshCommandWithRetry(host *Host, command string, retries int, sleepBetweenRetries time.Duration, f ...func(*Host, string) (string, error)) (string, error)
CheckSshCommandWithRetry checks that you can connect via SSH to the given host and run the given command until max retries has been exceeded. It return an error if the command fails after max retries has been exceeded.
func CheckSshConnection ¶
CheckSshConnection checks that you can connect via SSH to the given host and return an error if the connection fails.
func CheckSshConnectionWithRetry ¶
func CheckSshConnectionWithRetry(host *Host, retries int, sleepBetweenRetries time.Duration, f ...func(*Host) error) error
CheckSshConnectionWithRetry attempts to connect via SSH until max retries has been exceeded and returns an error if the connection fails
func FetchContentsOfFile ¶
FetchContentsOfFile connects to the given host via SSH and fetches the contents of the file at the given filePath. If useSudo is true, then the contents will be retrieved using sudo. This method returns the contents of that file.
func FetchContentsOfFiles ¶
FetchContentsOfFiles connects to the given host via SSH and fetches the contents of the files at the given filePaths. If useSudo is true, then the contents will be retrieved using sudo. This method returns a map from file path to contents.
func NoOpHostKeyCallback ¶
NoOpHostKeyCallback is an ssh.HostKeyCallback that does nothing. Only use this when you're sure you don't want to check the host key at all (e.g., only for testing and non-production use cases).
func ScpDirFrom ¶
func ScpDirFrom(options ScpDownloadOptions, useSudo bool) error
ScpDirFrom downloads all the files from remotePath on the given host using SCP and returns an error if the process fails. NOTE: only files within remotePath will be downloaded. This function will not recursively download subdirectories or follow symlinks.
func ScpFileFrom ¶
ScpFileFrom downloads the file from remotePath on the given host using SCP and returns an error if the process fails.
Types ¶
type Host ¶
type Host struct {
Hostname string // host name or ip address
SshUserName string // user name
// set one or more authentication methods,
// the first valid method will be used
SshKeyPair *KeyPair // ssh key pair to use as authentication method (disabled by default)
SshAgent bool // enable authentication using your existing local SSH agent (disabled by default)
OverrideSshAgent *SshAgent // enable an in process `SshAgent` for connections to this host (disabled by default)
Password string // plain text password (blank by default)
CustomPort int // port number to use to connect to the host (port 22 will be used if unset)
}
Host is a remote host.
type JumpHostSession ¶
type JumpHostSession struct {
JumpHostClient *ssh.Client
HostVirtualConnection net.Conn
HostConnection ssh.Conn
}
JumpHostSession is a session with a jump host.
func (*JumpHostSession) Cleanup ¶
func (jumpHost *JumpHostSession) Cleanup()
Cleanup cleans the jump host session up.
type KeyPair ¶
KeyPair is a public and private key pair that can be used for SSH access.
func GenerateRSAKeyPair ¶
GenerateRSAKeyPair generates an RSA key pair and return the public and private keys.
type ScpDownloadOptions ¶
type ScpDownloadOptions struct {
FileNameFilters []string // File names to match. May include bash-style wildcards. E.g., *.log.
MaxFileSizeMB int // Don't grab any files > MaxFileSizeMB
RemoteDir string // Copy from this directory on the remote machine
LocalDir string // Copy RemoteDir to this directory on the local machine
RemoteHost *Host // Connection information for the remote machine
}
type SshAgent ¶
type SshAgent struct {
// contains filtered or unexported fields
}
func NewSshAgent ¶
Create SSH agent, start it in background and returns control back to the main thread You should stop the agent to cleanup files afterwards by calling `defer s.Stop()`
func SshAgentWithKeyPair ¶
Instantiates and returns an in-memory ssh agent with the given KeyPair already added You should stop the agent to cleanup files afterwards by calling `defer sshAgent.Stop()`
func SshAgentWithKeyPairs ¶
SshAgentWithKeyPairs Instantiates and returns an in-memory ssh agent with the given KeyPair(s) already added You should stop the agent to cleanup files afterwards by calling `defer sshAgent.Stop()`
type SshConnectionOptions ¶
type SshConnectionOptions struct {
Username string
Address string
Port int
AuthMethods []ssh.AuthMethod
Command string
JumpHost *SshConnectionOptions
}
SshConnectionOptions are the options for an SSH connection.
func (*SshConnectionOptions) ConnectionString ¶
func (options *SshConnectionOptions) ConnectionString() string
ConnectionString returns the connection string for an SSH connection.
type SshSession ¶
type SshSession struct {
Options *SshConnectionOptions
Client *ssh.Client
Session *ssh.Session
JumpHost *JumpHostSession
Input *func(io.WriteCloser)
}
SshSession is a container object for all resources created by an SSH session. The reason we need this is so that we can do a single defer in a top-level method that calls the Cleanup method to go through and ensure all of these resources are released and cleaned up.
func (*SshSession) Cleanup ¶
func (sshSession *SshSession) Cleanup()
Cleanup cleans up an existing SSH session.