sshclient

Aug 21, 2026

Changes in this version

type Config

+ SQLUseSudo bool

Aug 16, 2026

Changes in this version

+ const MaxApplyBytes

+ var ErrApplyBlocked = errors.New("apply target blocked")

+ var ErrPrecondition = errors.New("apply precondition failed")

+ func ApplyPathBlocked(remotePath string) bool

+ func NormalizeApplySHA256(value string) (string, error)

+ func SHA256Hex(data []byte) string

+ func ValidateApplyPath(remotePath string) error

+ type ApplyOutcome struct

+ AfterSHA256 string

+ BackupPath string

+ BeforeSHA256 string

+ Changed bool

+ Created bool

+ Mode string

+ type ApplyRequest struct

+ Backup bool

+ BackupDir string

+ ExpectSHA256 string

+ Force bool

+ Payload []byte

+ RemotePath string

+ UseSudo bool

type Config

+ ApplyBackupDir string

+ ApplyExpectSHA256 string

+ ApplyNoBackup bool

+ ApplyUseSudo bool

type SSHClient

+ func (c *SSHClient) ApplyRegularFile(req ApplyRequest) (*ApplyOutcome, error)

Aug 15, 2026

Changes in this version

type Config

+ SQLFile string

Aug 15, 2026

Changes in this version

type Config

+ SQLAllowFullTable bool

+ SQLBackupDir string

+ SQLCredCacheTTL time.Duration

+ SQLCredFrom string

+ SQLCredRefresh bool

+ SQLDatabase string

+ SQLDockerContainer string

+ SQLEngine string

+ SQLExplainOnly bool

+ SQLHost string

+ SQLNoBackup bool

+ SQLPasswordKey string

+ SQLPort string

+ SQLRowThreshold int64

+ SQLStatement string

+ SQLUser string

type SSHClient

+ func (c *SSHClient) RunCommandWithInput(command string, stdin []byte) (ExecResult, error)

Aug 13, 2026

Changes in this version

type Config

+ BypassReason string

+ FailureMode string

+ JSONLOutput bool

+ MaxOutputBytes int

+ MaxPayloadBytes int

+ RequestID string

+ RunActionKind string

+ RunAddress string

+ RunAllHosts bool

+ RunConcurrency int

+ RunGroups []string

+ RunIntent string

+ RunTags map[string]string

+ RunTargets []string

+ RunUseSudo bool

+ SSHPasswordKey string

+ ScriptFile string

+ ScriptStdin bool

Aug 12, 2026

Changes in this version

type Config

+ SkillAction string

+ SkillDir string

Aug 12, 2026

Changes in this version

type Config

+ ArgumentError string

+ HostKeyFingerprint string

+ InspectAllowStale bool

+ InspectCacheMode string

+ InspectCapability string

+ InspectMaxAge time.Duration

+ InspectRefresh bool

+ InspectUseSudo bool

+ PluginAction string

+ PluginFixture string

+ PluginID string

+ PluginPlatform string

+ PluginPrivilege string

+ PluginReplace bool

+ PluginRunner string

+ PluginTemplate string

+ ReportedError string

+ ReportedErrorKind string

+ SudoPassword string

type SSHClient

+ func (c *SSHClient) ReadRemoteFile(remotePath string, limit int64, expectedUID string) ([]byte, error)

+ func (c *SSHClient) RemoteHome() (string, error)

+ func (c *SSHClient) RunScript(payload []byte, useSudo bool) (ExecResult, error)

+ func (c *SSHClient) WriteRemoteFileAtomic(remotePath string, data []byte) error

Jul 16, 2026

Changes in this version

type Config

+ HostImportNames string

+ SSHConfigPath string

Jul 2, 2026

Changes in this version

type Config

+ TransferDstHost string

+ TransferDstPath string

+ TransferSrcHost string

+ TransferSrcPath string

type SSHClient

+ func (c *SSHClient) TransferTo(dst *SSHClient, srcPath, dstPath string) (err error)

Jul 1, 2026

Changes in this version

type Config

+ AuditEnabled bool

+ AuditOutput string

+ DryRun bool

Jun 9, 2026

Changes in this version

+ const MaxCaptureBytes

+ var ErrCommandTimeout = errors.New("command execution timed out")

+ var ErrNoExitStatus = errors.New("remote command terminated without exit status")

+ func CommandUsesSudo(command string) bool

+ type AuthMethod string

+ const AuthMethodKey

+ const AuthMethodPassword

+ const AuthMethodPasswordFallback

+ const AuthMethodUnknown

+ type CommandBlockedError struct

+ Command string

+ Reason string

+ func (e *CommandBlockedError) Error() string

type Config

+ AcceptUnknownHost bool

+ AllowInsecureHostKey bool

+ DialTimeout time.Duration

+ HostAction string

+ HostDescription string

+ HostName string

+ HostType string

+ JSONOutput bool

+ KnownHostsPath string

+ Timeout time.Duration

+ UseKeyAuth bool

+ UsePTY bool

+ type ExecResult struct

+ ExitCode int

+ Stderr string

+ StderrTruncated bool

+ Stdout string

+ StdoutTruncated bool

type SSHClient

+ func (c *SSHClient) AuthMethodUsed() AuthMethod

+ func (c *SSHClient) ConnectDirect() error

+ func (c *SSHClient) RunCommand(capture bool) (ExecResult, error)

Nov 13, 2025

Changes in this version

+ const DefaultSSHPort

+ const DefaultSSHUser

+ const DefaultSudoKey

+ const DefaultTimeout

+ const KeyringServiceName

+ const PasswordPromptEnd

+ const SudoPrompt

+ func CloseIgnore(errp *error, c io.Closer, ignore ...error)

+ func GetSudoPassword(key string) (string, error)

+ func ValidateCommand(command string) error

+ type Config struct

+ Command string

+ Force bool

+ Host string

+ KeyPath string

+ LocalPath string

+ Mode string

+ Password string

+ PasswordAction string

+ PasswordKey string

+ PasswordValue string

+ Port string

+ RemotePath string

+ SafetyCheck bool

+ SftpAction string

+ SudoKey string

+ User string

+ type ConnectionPool struct

+ func GetConnectionPool() *ConnectionPool

+ func NewConnectionPool() *ConnectionPool

+ func (p *ConnectionPool) Close()

+ func (p *ConnectionPool) GetConnection(config *Config) (*ssh.Client, error)

+ func (p *ConnectionPool) ReleaseConnection(config *Config)

+ func (p *ConnectionPool) Stats() map[string]interface{}

+ type PooledConnection struct

+ type SSHClient struct

+ func NewSSHClient(config *Config) (*SSHClient, error)

+ func (c *SSHClient) Close() error

+ func (c *SSHClient) Connect() error

+ func (c *SSHClient) ExecuteCommand() (err error)

+ func (c *SSHClient) ExecuteCommandWithOutput() (output string, err error)

+ func (c *SSHClient) ExecuteScript(localScriptPath string) (output string, err error)

+ func (c *SSHClient) ExecuteScriptWithArgs(localScriptPath string, args []string) (output string, err error)

+ func (c *SSHClient) ExecuteSftp() (err error)

+ func (c *SSHClient) ForceClose() error