ConnectBot SSH Library/org.connectbot.sshlib/SshClient

SshClient

High-level async SSH client API.

This is the main entry point for establishing SSH connections. All methods are suspend functions for use with Kotlin coroutines.

Usage with TCP (default):

val client = SshClient("example.com", hostKeyVerifier = myVerifier)
if (client.connect() is ConnectResult.Success) {
    if (client.authenticatePassword("user", "password") is AuthResult.Success) {
        val session = client.openSession()
        session?.requestPty()
        session?.requestShell()
        // read/write
        session?.close()
    }
    client.disconnect()
}

Usage with custom transport:

val config = SshClientConfig {
    transportFactory = MyCustomTransportFactory()
}
val client = SshClient(config)
client.connect()
// ...

For blocking Java compatibility, use org.connectbot.sshlib.blocking.BlockingSshClient.

Types

Companion

object Companion

Properties

connectionInfo

val connectionInfo: ConnectionInfo?

Negotiated algorithm details for the current connection.

disconnectedFlow

val disconnectedFlow: SharedFlow<Throwable?>

Emits when the connection drops unexpectedly.

isAuthenticated

val isAuthenticated: Boolean

Check if connected and authenticated.

Functions

authenticate

suspend fun authenticate(username: String, handler: AuthHandler): AuthResult

Authenticate using the strategy-based AuthHandler flow.

authenticateKeyboardInteractive

suspend fun authenticateKeyboardInteractive(username: String, callback: KeyboardInteractiveCallback): AuthResult

Authenticate using keyboard-interactive authentication (RFC 4256).

authenticatePassword

suspend fun authenticatePassword(username: String, password: String): AuthResult

Authenticate using password authentication.

authenticatePublicKey

suspend fun authenticatePublicKey(username: String, privateKeyData: ByteArray, passphrase: String? = null): AuthResult

suspend fun authenticatePublicKey(username: String, privateKeyData: String, passphrase: String? = null): AuthResult

Authenticate using public key authentication (RFC 4252 §7).

connect

suspend fun connect(): ConnectResult

Connect to the SSH server and perform key exchange.

disconnect

suspend fun disconnect()

Disconnect from the SSH server.

dynamicPortForward

suspend fun dynamicPortForward(bindAddress: InetSocketAddress, authenticator: Socks5Authenticator? = null): PortForwarder?

Start dynamic (SOCKS5) port forwarding.

suspend fun dynamicPortForward(bindPort: Int, authenticator: Socks5Authenticator? = null): PortForwarder?

Start dynamic (SOCKS5) port forwarding bound to localhost.

enableAgentForwarding

fun enableAgentForwarding(provider: AgentProvider)

Enable SSH agent forwarding with the provided agent.

forwardStream

suspend fun forwardStream(readChannel: ByteReadChannel, writeChannel: ByteWriteChannel, remoteHost: String, remotePort: Int, originAddr: String = LOCALHOST, originPort: Int = 0): StreamForwarder?

Forward a pair of streams through an SSH direct-tcpip channel.

isPrivateKeyEncrypted