ssh

package
v0.81.0-rc.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 19, 2026 License: Apache-2.0 Imports: 18 Imported by: 0

Documentation

Index

Constants

View Source
const (
	KnownHostsEnvVar  = "SSH_KNOWN_HOSTS"
	DefaultGitSSHUser = "git" // Default SSH user for Git servers
	DefaultGitSSHPort = 22    // Default SSH port for Git servers
)
View Source
const (
	SocketAgentSocketEnvVar = "SSH_AUTH_SOCK"
)

Variables

View Source
var (
	KnownHostsFilePath = filepath.Join(os.TempDir(), "known_hosts")
)
View Source
var SocketAgentSocketPath = filepath.Join(os.TempDir(), "ssh_agent.sock")

Functions

func AddKeyToAgent

func AddKeyToAgent(privateKey []byte, keyPassphrase string) error

AddKeyToAgent adds a private key to the SSH agent running at the socket specified.

func AddToKnownHosts added in v0.67.1

func AddToKnownHosts(url string) error

AddToKnownHosts adds the host from the SSH URL to the known_hosts file.

func IsHostKeyMismatchError added in v0.78.0

func IsHostKeyMismatchError(err error) bool

IsHostKeyMismatchError returns true when an SSH operation failed due to host key mismatch.

func RefreshKnownHost added in v0.78.0

func RefreshKnownHost(url string) error

RefreshKnownHost replaces the known_hosts entry for the given SSH URL and fetches the current server key.

func StartSSHAgent

func StartSSHAgent(ctx context.Context, socketPath string) error

StartSSHAgent starts an SSH agent that listens on a Unix domain socket at the specified path. If no path is provided, it defaults to SocketAgentSocketPath. The function runs until the provided context is canceled.

Types

This section is empty.

Jump to

Keyboard shortcuts

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