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

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.

SSH2 vs node-ssh: which should I use?

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.

Can I use SSH agent forwarding with SSH2 on Windows?

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.

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

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.

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

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.

Does SSH2 support Ed25519 encryption keys?

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 — Pure JavaScript SSH2 for Node.js

What is ssh2?

SSH2 is a pure JavaScript implementation of the SSH2 protocol for Node.js, providing both client and server functionality. It allows Node.js applications to establish secure shell connections, execute remote commands, transfer files via SFTP, and create encrypted tunnels without requiring external SSH binaries. The library solves the problem of integrating SSH capabilities directly into JavaScript environments.

Target Audience

Node.js developers who need to automate remote server operations, build deployment tools, create secure file transfer systems, or implement custom SSH servers within their applications.

Value Proposition

Developers choose SSH2 because it's a native JavaScript solution with no external dependencies, offers comprehensive SSH2 protocol support, and provides both client and server capabilities in a single well-maintained package.

SSH2 client and server modules written in pure JavaScript for node.js

Use Cases

Best For

Automating remote server administration tasks from Node.js scripts
Building deployment tools that require secure file transfers via SFTP
Creating custom SSH servers for specialized applications
Implementing secure tunneling and port forwarding in Node.js applications
Developing DevOps tools that need remote command execution
Building monitoring systems that connect to multiple servers via SSH

Not Ideal For

High-performance applications requiring maximum SSH throughput, where native OpenSSH or compiled bindings would be more efficient
Projects deeply integrated with OpenSSH's ecosystem, such as those relying on specific agent features or configuration files not fully replicated
Use cases needing advanced terminal emulation or rich interactive shells beyond basic pseudo-TTY settings provided

Pros & Cons

Pros

Pure JS, No Dependencies

Entirely implemented in JavaScript, eliminating the need for external SSH binaries, which simplifies deployment and reduces system dependencies, as stated in the description and README.

Full Protocol Coverage

Supports both client and server modes, including SFTP, port forwarding, X11, and various authentication methods, with comprehensive API documentation and examples provided.

Flexible Authentication Options

Offers multiple authentication types like password, public key, keyboard-interactive, and agent-based, with examples showing secure implementation using timingSafeEqual.

Built-in Utilities and Agents

Includes utilities for key generation and custom agent protocols (e.g., OpenSSHAgent, PageantAgent), enhancing flexibility for different environments, as detailed in the API.

Cons

Performance Overheads

Being pure JavaScript, it may incur performance penalties compared to native implementations, especially for encryption and data-intensive operations, hinted by the optional cpu-features dependency for optimization.

Steep Learning Curve

The API is low-level and requires a good understanding of SSH protocol details, making it challenging for beginners or simple use cases, as seen in the complex server authentication examples.

Limited Ecosystem Integrations

While feature-complete, it might not seamlessly integrate with all OpenSSH tools or have the same level of community plugins, and strict vendor checks are needed for some extensions.

Frequently Asked Questions

What is ssh2?

Target Audience

Node.js developers who need to automate remote server operations, build deployment tools, create secure file transfer systems, or implement custom SSH servers within their applications.

Value Proposition

Use Cases

Best For

Automating remote server administration tasks from Node.js scripts
Building deployment tools that require secure file transfers via SFTP
Creating custom SSH servers for specialized applications
Implementing secure tunneling and port forwarding in Node.js applications
Developing DevOps tools that need remote command execution
Building monitoring systems that connect to multiple servers via SSH

Not Ideal For

High-performance applications requiring maximum SSH throughput, where native OpenSSH or compiled bindings would be more efficient
Projects deeply integrated with OpenSSH's ecosystem, such as those relying on specific agent features or configuration files not fully replicated
Use cases needing advanced terminal emulation or rich interactive shells beyond basic pseudo-TTY settings provided

Pros & Cons

Pros

Pure JS, No Dependencies

Entirely implemented in JavaScript, eliminating the need for external SSH binaries, which simplifies deployment and reduces system dependencies, as stated in the description and README.

Full Protocol Coverage

Supports both client and server modes, including SFTP, port forwarding, X11, and various authentication methods, with comprehensive API documentation and examples provided.

Flexible Authentication Options

Offers multiple authentication types like password, public key, keyboard-interactive, and agent-based, with examples showing secure implementation using timingSafeEqual.

Built-in Utilities and Agents

Includes utilities for key generation and custom agent protocols (e.g., OpenSSHAgent, PageantAgent), enhancing flexibility for different environments, as detailed in the API.

Cons

Performance Overheads

Steep Learning Curve

The API is low-level and requires a good understanding of SSH protocol details, making it challenging for beginners or simple use cases, as seen in the complex server authentication examples.

Limited Ecosystem Integrations

While feature-complete, it might not seamlessly integrate with all OpenSSH tools or have the same level of community plugins, and strict vendor checks are needed for some extensions.

Frequently Asked Questions

ssh2

What is ssh2?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

ssh2

What is ssh2?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?