SshTransportConnectionOptions
Defined in: src/protocols/ssh/transport/SshTransportConnection.ts:38
Properties
Section titled “Properties”| Property | Type | Description | Defined in |
|---|---|---|---|
abortSignal? | AbortSignal | AbortSignal that cancels the in-flight connect() call and tears down the socket. | src/protocols/ssh/transport/SshTransportConnection.ts:40 |
algorithms? | SshAlgorithmPreferences | Algorithm preference overrides. Defaults to the library defaults. | src/protocols/ssh/transport/SshTransportConnection.ts:42 |
clientSoftwareVersion? | string | SSH software version string embedded in the identification line. | src/protocols/ssh/transport/SshTransportConnection.ts:44 |
handshakeTimeoutMs? | number | Hard cap (milliseconds) on the SSH identification + key exchange + first NEWKEYS handshake. If exceeded the socket is destroyed and connect() rejects with a TimeoutError. Has no effect once connect() resolves. | src/protocols/ssh/transport/SshTransportConnection.ts:50 |
keepaliveIntervalMs? | number | If set, sends a SSH_MSG_IGNORE packet every keepaliveIntervalMs milliseconds while the transport is connected and idle. This prevents stateful NAT / firewall devices from dropping long-lived idle sessions (e.g. between batches in a transfer queue). The timer is reset on every outbound payload, so active transfers do not generate extra traffic. | src/protocols/ssh/transport/SshTransportConnection.ts:58 |
verifyHostKey? | (input: { algorithmName: string; hostKeyBlob: Buffer; hostKeySha256: Buffer; }) => void | Synchronous host-key policy hook invoked after the signature on the SSH exchange hash is verified. Throw to reject the server’s identity. | src/protocols/ssh/transport/SshTransportConnection.ts:63 |