ssh2-streams

const { SSH2Stream, utils, constants } = require('ssh2-streams'); const net = require('net'); // This quickstart demonstrates how to initialize an SSH2Stream and set up // basic event listeners to observe the SSH protocol negotiation. // In a real-world scenario, you would pipe a connected net.Socket instance // to this SSH2Stream to process the raw SSH protocol bytes. // ssh2-streams itself does not handle the network connection. const stream = new SSH2Stream(); // Listen for the initial SSH protocol header from the remote party stream.on('header', (headerInfo) => { console.log('SSH Header Received:', headerInfo); console.log(`Remote software: ${headerInfo.versions.software}`); // A real client would send its own header back: stream.write(Buffer.from('SSH-2.0-MyClient\r\n')); }); // This event is crucial for host key verification in client implementations. // The default behavior is to auto-allow any host key if no handler is present. stream.on('fingerprint', (hostKeyBuffer, callback) => { const finger = utils.fingerprint(hostKeyBuffer); console.log('Received Host Key Fingerprint:', finger); // In a production client, you'd compare 'finger' to known_hosts. // For this example, we unconditionally accept the host key. callback(true); }); // Event for when new encryption keys have been exchanged stream.on('NEWKEYS', () => { console.log('New encryption keys have been successfully exchanged.'); // After NEWKEYS, authentication can begin. }); // Handle general errors that might occur within the stream processing stream.on('error', (err) => { console.error('SSHStream encountered an error:', err.message); }); // Listen for a disconnect message from the remote party stream.on('DISCONNECT', (reason, reasonCode, description) => { console.warn(`Disconnected by remote: [${reasonCode}] ${reason} - ${description}`); }); console.log('SSH2Stream initialized. Attach a net.Socket to this stream to start protocol communication.'); console.log('Example of using utilities: SHA256 fingerprint for a dummy key:', utils.fingerprint(Buffer.from('-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAs...-----END PUBLIC KEY-----'))); console.log('Example protocol constant:', `Disconnect Reason: ${constants.DISCONNECT_REASON_CODE_NAMES[constants.DISCONNECT_REASON.HOST_NOT_ALLOWED_TO_CONNECT]}`); // To make this quickstart runnable, you would pipe a connected net.Socket to the stream: /* const clientSocket = net.connect(22, 'localhost', () => { clientSocket.pipe(stream).pipe(clientSocket); // stream.write(...) would send data over the SSH protocol. }); */