sshclient

Oct 27, 2026

Changes in this version

type ApplyRequest

+ StageDir string

type Config

+ ApplyStageDir string

+ ROSAction string

type SSHClient

+ func (c *SSHClient) CopyFile(action, localPath, remotePath string) (*SFTPOutcome, error)

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

Sep 28, 2026

Changes in this version

+ func ContainsSudoCommand(command string) bool

Sep 24, 2026

Changes in this version

type ApplyRequest

+ SudoConfigured bool

type Config

+ SQLAllowFullTableBackup bool

+ SudoKeyConfigured bool

Sep 23, 2026

Changes in this version

+ func NonLeadingSudoHint(command string) (string, bool)

+ func SudoPasswordPromptFailure(output string) bool

type Config

+ HelpVerb string

+ PluginSource string

+ PluginTrust bool

+ Quiet bool

+ SQLStatementFile string

+ ShowUsage bool

Sep 16, 2026

Changes in this version

type Config

+ ROSAllowWrite bool

+ ROSBackupName string

+ ROSCleanup bool

+ ROSCompact bool

+ ROSIncludeRemote bool

+ ROSRaw bool

+ ROSRouterOSVersion string

+ ROSSource string

+ ROSTokens []string

type SSHClient

+ func (c *SSHClient) NewSFTPClient() (*sftp.Client, error)

Sep 11, 2026

Changes in this version

type Config

+ TextAroundLine int

+ TextContext int

+ TextHelp bool

+ TextJournal string

+ TextLimit int

+ TextMaxBytes int

+ TextMaxHits int

+ TextMaxScanBytes int64

+ TextOffset int

+ TextPattern string

+ TextPresets []string

+ TextRedact bool

+ TextScan string

+ TextSince string

+ TextTail int

+ TextUntil string

+ TextUseSudo bool

+ type RemoteTextMeta struct

+ Size int64

+ SkipPartial bool

+ StartByte int64

type SSHClient

+ func (c *SSHClient) OpenRemoteText(remotePath string, fromEnd bool, maxBytes int64) (io.ReadCloser, RemoteTextMeta, error)

Sep 7, 2026

Changes in this version

+ const ErrorKindCancelled

+ var ErrApplyVerification = errors.New("apply verification failed")

+ func CommandIsDestructive(command string) bool

+ func RenderSFTPOutcome(out *SFTPOutcome) error

type ApplyOutcome

+ BackupVerified bool

+ ChangeState string

+ CleanupPending []string

+ Executed *bool

+ ExpectSHA256 string

+ GID *uint32

+ PayloadSHA256 string

+ PreconditionSHA256 string

+ PreconditionStatus string

+ ReplaceMethod string

+ UID *uint32

+ Verification string

+ Verified bool

+ type BoundaryError struct

+ Err error

+ Kind string

+ Op string

+ func (e *BoundaryError) Error() string

+ func (e *BoundaryError) ErrorKind() string

+ func (e *BoundaryError) Unwrap() error

+ type CacheDialer struct

+ Cache *JumpCache

+ Context context.Context

+ func (d CacheDialer) Connect(cfg *Config) (*SSHClient, error)

type Config

+ AuditExecutionID string

+ Context context.Context

+ ExecutionID string

+ ExpectPlan string

+ ExpectedKeyFingerprint string

+ GlobalTimeout time.Duration

+ HostAlias string

+ HostTimeout time.Duration

+ JumpChain []*Config

+ KnownHostsData []byte

+ MaxFailures int

+ PlanHash string

+ PreparedPayload []byte

+ Risk string

+ TransferDestination *Config

+ TransferSource *Config

+ Via string

+ ViaSet bool

type ExecResult

+ ExitObserved bool

+ StartAttempted bool

+ Started bool

+ type FileOutcome struct

+ BytesTransferred int64

+ ChangeState string

+ CleanupError string

+ GID *uint32

+ Mode string

+ ModifiedAt string

+ Path string

+ Publication string

+ Published bool

+ SHA256 string

+ Size int64

+ SourcePath string

+ SourceSHA256 string

+ StagingPath string

+ Started bool

+ Type string

+ UID *uint32

+ Verification string

+ VerificationMethod string

+ Verified bool

+ type HopError struct

+ Alias string

+ Err error

+ Role string

+ func (e *HopError) Error() string

+ func (e *HopError) ErrorKind() string

+ func (e *HopError) Unwrap() error

+ type HopIdentity struct

+ Address string

+ Alias string

+ AuthMethod string

+ CloseError string

+ Closed bool

+ HostKeyFingerprint string

+ PeerAddress string

+ Port string

+ Role string

+ User string

+ type JumpCache struct

+ func NewJumpCache() *JumpCache

+ func (c *JumpCache) Close() error

+ type SFTPOutcome struct

+ Action string

+ BytesTransferred int64

+ ChangeState string

+ Completion string

+ DestinationPath string

+ DirectoryAtomic bool

+ Entries []FileOutcome

+ Executed *bool

+ Partial bool

+ Phase string

+ SourcePath string

+ Started bool

+ Verification string

+ VerificationMethod string

+ Verified bool

type SSHClient

+ func (c *SSHClient) ExecuteSftpResult() (out *SFTPOutcome, err error)

+ func (c *SSHClient) Hops() []HopIdentity

+ func (c *SSHClient) HostKeyFingerprint() string

+ func (c *SSHClient) PeerAddress() string

+ func (c *SSHClient) TransferToResult(dst *SSHClient, srcPath, dstPath string) (out *SFTPOutcome, err error)

Sep 1, 2026

Changes in this version

type Config

+ AuditAction string

+ AuditBypassOnly bool

+ AuditErrorKind string

+ AuditExportPath string

+ AuditFilterAct string

+ AuditFilterHost string

+ AuditRunID string

+ AuditSince string

+ AuditUntil string

+ SudoKeySet bool

Aug 28, 2026

Changes in this version

type Config

+ ScriptShell string

type SSHClient

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

Aug 25, 2026

Changes in this version

+ var ErrInvalidBind = errors.New("invalid bind")

+ func ResolveBind(bind, destHost string) (net.Addr, error)

type Config

+ Bind string

+ BindSet bool

Aug 24, 2026

Changes in this version

+ const PrivilegedLoginCommand

+ var ErrLoginNotTTY = errors.New("login requires an interactive terminal (stdin is not a TTY)")

+ var ErrLoginUnsupported = errors.New("interactive login is not supported on this platform")

+ func InteractiveLoginSupported() bool

+ func StdinIsTerminal() bool

type Config

+ LoginLiteralHost bool

+ LoginUseSudo bool

type SSHClient

+ func (c *SSHClient) Login() error

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