API reference

Public Swift surface of the SSHKit module, grouped by area. Async signatures are shown. Most throwing async methods have a matching callback overload (callbackQueue: + completion:) — the exceptions are noted on each page. Tiny value types live alongside their owner.

• Client & connection SSHClient, SSHClientConfiguration, SSHConnection, proxy types.
• Commands & shell SSHCommand, SSHCommandResult, SSHShell, plus event enums.
• SFTP & SCP SFTPClient, SFTPFileHandle, SFTPEntry, SFTPAttributes, SFTPFileOpenFlags, SCP extensions.
• Tunneling & forwarding SSHTunnelChannel, SSHPortForward.
• Authentication & credentials SSHAuthentication, prompts, SSHAuthenticationDiscoveryResult, SSHKeychainCredentialStore, SSHPrivateKeyCredential.
• Host trust SSHHostKeyPolicy, SSHHostKeyFingerprint, the SSHHostTrustStore protocol, memory + keychain stores, plus SSHClient.discoverHostKey for first-time fingerprint capture.
• Key generation SSHKeyGenerator, SSHKeyGenerationType, SSHGeneratedKeyPair.
• Algorithms SSHAlgorithmProfile, SSHAlgorithmSnapshot.
• Logging & diagnostics SSHLogLevel, SSHLogEvent, SSHLogHandler, SSHLogRecorder, SSHDiagnosticReport, SSHPortLatencyProbe.
• Errors SSHKitError, SSHKitErrorCode table.