Environment variables sent before each session starts, including SFTP. Servers may ignore variables not allowed by their policy (OpenSSH AcceptEnv). Names and values use UTF-8 and must not contain NUL. Only supplied variables are sent.

host

var host: String

Hostname for TCP connections. Used with default KtorTcpTransport. Ignored if transportFactory is set explicitly.

hostKeyAlgorithms

var hostKeyAlgorithms: String

hostKeyVerifier

var hostKeyVerifier: HostKeyVerifier?

Host key verifier.

ipVersion

var ipVersion: IpVersion

IP version preference for the default TCP transport. Ignored if transportFactory is set explicitly.

keepAliveIntervalMs

var keepAliveIntervalMs: Long

Send an SSH_MSG_IGNORE heartbeat every N milliseconds to keep the connection alive across NAT/VPN/firewall idle timeouts.

kexAlgorithms

var kexAlgorithms: String

macAlgorithms

var macAlgorithms: String

obscureKeystrokeTimingIntervalMs

var obscureKeystrokeTimingIntervalMs: Long

Quantize outbound keystroke packet timing to this interval (milliseconds) to mask inter-keystroke timing patterns. Requires a PTY session and server support for ping@openssh.com. Set to 0 to disable.

port

var port: Int

Port for TCP connections. Used with default KtorTcpTransport. Ignored if transportFactory is set explicitly.

preferPasswordAuth

var preferPasswordAuth: Boolean

When true, prefer password over keyboard-interactive when both are available. By default, keyboard-interactive is preferred.

rekeyBytesLimit

var rekeyBytesLimit: Long

Re-key after this many wire bytes (sent or received). Default: 1 GB.

rekeyIntervalMs

var rekeyIntervalMs: Long

Re-key after this many milliseconds. Default: 1 hour.

sessionWindowSize

var sessionWindowSize: Int

Receive window, in bytes, for shells, commands and manually opened subsystems. SFTP channels opened by SshClient.openSftp use sftpWindowSize. A channel moves at most one window of data per network round trip, so a larger window speeds up bulk transfers on slower links. Each channel may buffer up to this much unread data. Default: 2 MiB. Reduce this for sessions with tighter memory limits.

sftpWindowSize

var sftpWindowSize: Int

Receive window, in bytes, for channels opened by SshClient.openSftp. Default: 8 MiB, to sustain bulk downloads on higher-latency links. Each channel may buffer up to this much unread data; reduce this for tighter memory limits.

transportFactory

var transportFactory: TransportFactory?

Custom transport factory. If not set, uses KtorTcpTransportFactory with host, port, and ipVersion.

Functions

build

fun build(): SshClientConfig