Question 1

How to transfer files using SFTP with SSH2 in Node.js?

Accepted Answer

After connecting, use the sftp() method to get an SFTP instance, then call methods like readdir or createReadStream for operations. The README includes an example showing directory listing and file management via SFTP.

Question 2

SSH2 vs node-ssh: which should I use?

Accepted Answer

SSH2 is a lower-level, comprehensive implementation suitable for custom SSH clients/servers with full protocol control, while node-ssh is a higher-level wrapper focused on ease of use for common tasks like remote command execution. Choose based on your need for control versus simplicity.

Question 3

Can I use SSH agent forwarding with SSH2 on Windows?

Accepted Answer

Yes, set the agent config to 'pageant' for Pageant or specify a path for Cygwin sockets, as mentioned in the client configuration options. The library includes PageantAgent and CygwinAgent classes for this purpose.

Question 4

How to create a custom SSH server that accepts public key authentication?

Accepted Answer

Implement a Server instance, handle the 'authentication' event, parse the client's public key using utils.parseKey(), and verify it against allowed keys before calling accept() or reject(), as demonstrated in the server examples with timing-safe comparisons.

Question 5

What's the performance impact of using pure JavaScript for SSH?

Accepted Answer

SSH2 is optimized but may be slower than native SSH for CPU-heavy tasks like encryption; optional dependencies like cpu-features can improve cipher selection, but for high-throughput scenarios, consider testing against native alternatives.

Question 6

Does SSH2 support Ed25519 encryption keys?

Accepted Answer

Yes, Ed25519 key support requires Node.js v12.0.0 or newer, and SSH2 includes utilities like generateKeyPair for creating such keys, as noted in the requirements and key generation examples.

ssh2

What is ssh2?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions