Welcome to IPWorks SSH, a comprehensive suite of Secure Shell (SSH)-enabled client communications components supporting strong encryption and advanced cryptography. Developers can easily build SSH 2.0 secured applications with such features as secure file transfer, secure remote login, and secure tunneling. The toolkit includes support for encryption algorithms, such as AES GCM, ChaCha20-Poly1305, and many more, as well as ECDH (elliptic-curve Diffie-Hellman) SSH key exchange algorithms.

Getting Started

IPWorks SSH 2024 is delivered as a module which must first be installed prior to use. To install the module run the following command:

npm install ipworksssh-24.0.tar.gz

The module should now be installed and available for use. To use the module in your application first reference the package like so: const ipworksssh = require("@nsoftware/ipworksssh"); Instances of the classes listed below can then be created in code.

Included Classes

CertMgr The CertMgr component is used to create, read, and manage certificates.
SCP The SCP component can be used to transfer files to and from Secure Shell (SSH) servers using the Secure Copy Protocol (SCP).
SExec The SExec component is used to remotely execute a command on a Secure Shell (SSH) server.
SFTPClient The SFTPClient component can be used to transfer files to and from Secure File Transfer Protocol (SFTP) servers.
SFTPServer The SFTPServer component is used to create a Secure File Transfer Protocol (SFTP) server.
SSHClient The SSHClient component implements a fully functional, open-ended Secure Shell (SSH) client.
SShell The SShell component is used to open a shell connection to a Secure Shell (SSH) server.
SSHReverseTunnel The SSHReverseTunnel component provides a simple way to establish a reverse tunnel with a Secure Shell (SSH) host.
SSHServer The SSHServer component is used to create Secure Shell (SSH) servers. The component handles multiple simultaneous connections on the same Transmission Control Protocol (TCP)/IP port (service port). It is designed to balance the load between connections for a fast, powerful server.
SSHTunnel The SSHTunnel component can be used to tunnel data through a Secure Shell (SSH) server to a remote location.

Additional Information

You will always find the latest information about IPWorks SSH at our web site: We offer free, fully-functional 30-day trials for all of our products, and our technical support staff are happy to answer any questions you may have during your evaluation.

Please direct all technical questions to To help support technicians assist you as quickly as possible, please provide a detailed and accurate description of your problem, the results you expected, and the results that you received while using our product. For questions about licensing and pricing, and all other general inquiries, please contact

Thank You!

Thank you for choosing IPWorks SSH for your development needs. We realize that you have a choice among development tools, and that by choosing us you are counting on us to be a key component in your business. We work around the clock to provide you with ongoing enhancements, support, and innovative products; and we will always do our best to exceed your expectations!