Another easy simple ssh lib for forwarding ports, command execution and interactive shell support.
Has in-built support for bastion hosts (also known as jump hosts).
$ npm install node-ssh-forwardor
$ yarn add node-ssh-forwardSetting up the initial ssh connection (using a bastion host)
import { SSHConnection } from 'node-ssh-forward'
const sshConnection = new SSHConnection({
endHost: 'example.com',
bastionHost: 'my-bastion-host.com'
})$ ssh -L 9000:imgur.com:80 example.comconst sshConnection = new SSHConnection({
endHost: 'example.com',
})
await sshConnection.forward({
fromPort: 9000,
toPort: 80,
toHost: 'imgur.com'
})$ ssh -L 9000:localhost:80 -J your-jump-host.com example.comconst sshConnection = new SSHConnection({
endHost: 'example.com',
bastionHost: 'your-jump-host.com'
})
await sshConnection.forward({
fromPort: 9000,
toPort: 80,
})const sshConnection = new SSHConnection({
endHost: 'example.com',
bastionHost: 'your-jump-host.com'
})
await sshConnection.executeCommand('uptime')Options are an object with following properties:
username(optional): The username used for your ssh connection (equivalent to-loption). If not set, it first looks for anSSH_USERNAMEenvironment variable. If that is not set, it fallbacks toUSERenvironment variable.password(optional): Provide a password to authenticate with username and password, not private key. Also seeskipAutoPrivateKey.privateKey(optional): Can be astringorBufferthat contains a private key. If not set, it fallbacks to~/.ssh/id_rsaskipAutoPrivateKey(optional): Don't try and read~/.ssh/id_rsaif no private key is providedagentForward(optional): Is abooleanwhich uses thessh-agentfor connection (defaults tofalse). If set defaults to the value of env.SSH_AUTH_SOCK (all platforms), thenpageanton Windows if no SSH_AUTH_SOCK is present.agentSocket(optional): Provide your own path to the SSH Agent Socket you want to use. Useful if your app doesn't have access to ENV directly.endHost(required): The host you want to end up on (connect to)endPort(optional): Port number of the server. Needed in case the server runs on a custom port (defaults to22)bastionHost(optional): You can specify a bastion host if you wantpassphrase(optional): You can specify the passphrase when you have an encrypted private key. If you don't specify the passphrase and you use an encrypted private key, you get prompted in the command line.noReadline(optional): Don't prompt for private key passphrases using readline (eg if this is not run in an interactive session)
Executes a command on the server. Promise will resolve after the command has been executed.
Starts an interactive shell session. Will resolve when then client has logged out from the server.
Established port-forwarding. Promise resolves after the forwarding has been established. Forwarding can be stopped by calling connection.shutdown()
Possible options for forwardOptions:
fromPort(required): Specifies the port on your local computertoPort(required): The port onendHost(specified in the SSHConnection options).toHost(optional): You can specify an additionaltoHostwhen you want to forward a port from a different server than yourendHost.
Closes all connections.
- Add your wanted feature to the implementation in
./src - Add test in
./test/test.ts - Run the test with
./test/test.sh
- host based authentication
- Better documentation
- Debug logging
- Ability to pass an additional string to the
forwardthat specifies when the promise is resolved and the forwarding is stopped
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent