How to create web based terminal using xterm.js to ssh into a system on local network
I came across this awesome library xterm.js which is also the base for Visual Studio Code's terminal. I have a very general question.
I want to access a machine(ssh into a machine ) on a local network through a web based terminal(which is out of network, may be on a aws server). I was able to do this in a local network successfully but I could not reach to a conclusion to do it from Internet-->local network .
As an example - An aws server running the application on ip 22.214.171.124 which has a GUI with a button to open terminal. I want to open terminal of a local machine which is in a local network somewhere behind some public ip on local ip 192.168.1.7.
Can the above example be achieved using some sort of solutions where i can use xterm.js so that I don't have to go for building a web based terminal? What are the major security concerns I should keep in mind while exposing the terminals this way ?
I was thinking in line with using a fixed intermediate server between AWS and local network ip and use some sort of reverse ssh tunnel process to do this but I am not sure if this is the right way or could there be a more simple/better way to achieve this.
I know digital ocean, google cloud , they all do this but they have to connect to a computer which has public ip while I have a machine in a local network. I don't really want to configure router to do any kind of setup .
After few research here is working code.
Following Libraries you need understand how its work.
This library is used for transmit package from client to server.
This library is used for terminal view.
This is main library. which is used for establishment connection with your remote server.
Step 1 : Install this 3 library in your project folder
Setp 2 : Start from node side create a server.js file for open socket
Step 3 : Connection client socket to node server ( both are in local machine )
Tricky logic is just how to use socket and ssh2
on emit of socket you need to trigger ssh command using ssh2 library. on on response of ssh2 ( from server ) you need to transmit socket package to client that's it
Don't writing more here is the example code
This like have following files & folders
server.js package.json src/ xtream/
first you need to config your server IP , user and password or cert file on server.js. and just hit node server.js
P.S : Don't forget to run npm install
Let me know if you have any question !
After some research later I came across this service : https://tmate.io/ which does the job perfectly. Though if you need a web-based terminal of tmate you have to use their ssh servers as a reverse proxy which ideally I was not comfortable with. However, they provide tmate-server which can be used to host your own reverse proxy server but lacks web UI. But to build a system where you have to access a client behind NAT over ssh on web, below are the steps.
- Install and configure tmate-server on some cloud machine.
- Install tmate on the client side and configure to connect to a cloud machine.
- Create a nodejs application using xterm.js(easy because of WebSocket based communication) which connects to your tmate-server and pass commands to the respective client. (Beware of security issues of exposing this application, since you will be passing Linux commands ).
- Depending on your use case you might need a small wrapper around tmate client on client-side to start/stop it automatically or via some UI/manual action.
Note: I wrote a small wrapper on client-side as well to start/stop and pass on the required information to an API server (written in nodejs) which then pass on the information to another API which connects the browser to the respective client session. Since we had written this application it included authentication as well as command restrictions of what can be run on terminal. You can customize it a lot.