ConnectBot SSH Library/org.connectbot.sshlib.blocking/BlockingSshClient

BlockingSshClient

Blocking wrapper for SshClient for Java compatibility.

This class wraps the async SshClient with blocking calls using runBlocking. For Kotlin code, prefer using SshClient directly with coroutines.

Usage from Java:

BlockingSshClient client = new BlockingSshClient("example.com", 22, myHostKeyVerifier);
try {
    client.connect();
    client.authenticatePassword("user", "password");
    SshSession session = client.openSession();
    // ...
    session.close();
    client.disconnect();
} catch (SshException e) {
    // handle connection or auth failure
}

With custom transport:

BlockingSshClient client = new BlockingSshClient(myTransportFactory, myHostKeyVerifier);

Constructors

BlockingSshClient

@JvmOverloads

constructor(host: String, port: Int = 22, hostKeyVerifier: HostKeyVerifier, clientVersion: String = "SSH-2.0-CBSSH_1.0")

Create a blocking SSH client for TCP connection.

constructor(config: SshClientConfig)

Create a blocking SSH client from configuration.

constructor(transportFactory: TransportFactory, hostKeyVerifier: HostKeyVerifier, clientVersion: String = "SSH-2.0-CBSSH_1.0")

Create a blocking SSH client with custom transport factory.

Properties

disconnectedFlow

val disconnectedFlow: SharedFlow<Throwable?>

Emits when the connection drops unexpectedly.

isAuthenticated

val isAuthenticated: Boolean

Check if connected and authenticated.

Functions

authenticate

fun authenticate(username: String, handler: AuthHandler)

Authenticate using the strategy-based AuthHandler flow.

authenticateKeyboardInteractive

fun authenticateKeyboardInteractive(username: String, callback: KeyboardInteractiveCallback)

Authenticate using keyboard-interactive authentication (RFC 4256).

authenticatePassword

fun authenticatePassword(username: String, password: String)

Authenticate using password authentication.

authenticatePublicKey

@JvmOverloads

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

@JvmOverloads

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

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

connect

fun connect()

Connect to the SSH server and perform key exchange.

disconnect

fun disconnect()

Disconnect from the SSH server.

dynamicPortForward

@JvmOverloads

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

Start dynamic (SOCKS5) port forwarding.

@JvmOverloads

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

@JvmOverloads

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

Forward Ktor byte channels through an SSH direct-tcpip channel.

localPortForward

fun localPortForward(bindAddress: InetSocketAddress, remoteHost: String, remotePort: Int): PortForwarder?

Start local port forwarding.

fun localPortForward(bindPort: Int, remoteHost: String, remotePort: Int): PortForwarder?

Start local port forwarding bound to localhost.

openDirectTcpipTransport

@JvmOverloads

fun openDirectTcpipTransport(remoteHost: String, remotePort: Int, originAddr: String = "127.0.0.1", originPort: Int = 0): TransportFactory?

Create a org.connectbot.sshlib.transport.TransportFactory that tunnels through this SSH connection.

openSession

fun openSession(): SshSession?

Open a session channel (RFC 4254 section 6.1).

openSftp

fun openSftp(): SftpClient

Open an SFTP session for file transfer (blocking wrapper).

ping

fun ping(): PingResult

Send an SSH ping to the server and return the result.

remotePortForward

fun remotePortForward(remoteBindAddress: String, remoteBindPort: Int, localHost: String, localPort: Int): PortForwarder?

Start remote port forwarding.