Web-based SSH

<h2 id="technology">Technology</h2>
<p>Web-based SSH clients are applications that allow users to access <a href="/facts/Secure_Shell/wjVRw5zv">Secure Shell</a> (SSH) servers through a <a href="/facts/Web_browser/2pfyymLs">web browser</a>. They consist of two main parts: a client-side component, which is typically implemented using <a href="/facts/JavaScript/XhhIIEsl">JavaScript</a> and <a href="/facts/Dynamic_HTML/XrmcmIv5">dynamic HTML</a>, and a server-side or web application component, which is typically implemented on an <a href="/facts/Application_server/wHYtgYK5">application server</a>.
</p><p>The client-side component captures keystrokes, transmits messages to and from the server, and displays the results in the user's web browser. The server-side component processes incoming requests and forwards keyboard events to a secure shell client that communicates with the connected SSH server. Terminal output is either passed to the client, where it is converted into HTML using JavaScript, or it is translated into HTML by the server before it is transmitted to the client.
</p>
<h3>Terminal emulation</h3>
<p>Web-based SSH servers can use either client-side or server-side terminal emulation. 
</p>
<h4>Client-side terminal emulation</h4>
<p>Client-side terminal emulation transmits the raw terminal output from the SSH server directly to the client, which has the advantage of offloading the process of translating terminal output into HTML onto the client. However, it can be limited by the capabilities of JavaScript and can use a significant amount of the client's CPU and memory.
</p><p>An example of a client-side terminal emulator is vt100.js.<a class="footnote-ref" id="fnref:1" href="#fn:1"><sup>1</sup></a>
</p>
<h4>Server-side terminal emulation</h4>
<p>Server-side terminal emulation keeps track of the terminal screen and state in memory and converts it to HTML when a screen update occurs or when the client requests an update. This method has the advantage of keeping the state of the terminal persistent even if the user connects to their existing session from a different web browser, but it can use more CPU and memory on the server.
</p><p>An example of a server-side terminal emulator is terminal.py.<a class="footnote-ref" id="fnref:2" href="#fn:2"><sup>2</sup></a>
</p>
<h2 id="advantages">Advantages</h2>
<p>The main advantages of web-based <a href="/facts/Secure_Shell/wjVRw5zv">SSH</a> can be summarized as follows:
</p>
<ul><li><i>Accessibility</i>: Web-based SSH as described in this article requires no local installation of client software. It is thus possible to access SSH servers through a web browser from anywhere. As communication is based on <a href="/facts/HTTP/TWtvf7JD">HTTP</a> or <a href="/facts/HTTPS/MSWYz4zo">HTTPS</a> it is also possible to access SSH servers from behind a <a href="/facts/Firewall_(computing)/Et2RkJaU">firewall</a> or <a href="/facts/Proxy_server/ArhwQE74">proxy</a> that restricts Internet access to only ports 80 (<a href="/facts/HTTP/TWtvf7JD">HTTP</a>) or 443 (<a href="/facts/HTTPS/MSWYz4zo">HTTPS</a>).</li>
<li><i>Anonymous Access</i>: As SSH access is tunneled through an intermediary <a href="/facts/Application_server/wHYtgYK5">web application server</a> it is this server which actually communicates with the SSH server. This means that the SSH server will only be aware of the <a href="/facts/IP_address/z9V22Sw9">IP address</a> of the web application server, keeping the actual client's IP address hidden.</li>
<li><i>Auditability</i>: Because all communication between the client and the SSH server must pass through the <a href="/facts/Application_server/wHYtgYK5">web application server</a> this communication can be logged.  This prevents a malicious client from deleting logs of their activities. The situation is exactly the same as with traditional SSH server.</li>
<li><i>Resuming Sessions</i>: Some web-based SSH implementations allow the user to resume their SSH sessions after being disconnected.  This is not possible with a traditional SSH client.</li>
<li><i>Embeddable</i>: Web-based SSH implementations can be embedded into any web page allowing them to be integrated into other web-based applications.</li>
<li><i>Unique Features</i>: Many web-based SSH tools have unique features such as the ability to share terminals with other users, can display images within terminals, and other useful capabilities.</li></ul>
<h2 id="important-issues">Important issues</h2>
<p>The following issues have to be considered and are important when using a web-based SSH client:
</p>
<ul><li><i>Security</i>: It is important to make sure that <a href="/facts/HTTPS/MSWYz4zo">HTTPS</a> is used when communicating with the <a href="/facts/Application_Server/wHYtgYK5">web application server</a>. Otherwise all data being sent would be readable by use of simple <a href="/facts/Packet_sniffer/mFQP7gWB">packet sniffers</a> which could reveal sensitive information.</li>
<li><i>Trust</i>: The data being sent to the web application server is decrypted there. This is necessary in order to forward the issued commands to the actual <a href="/facts/Secure_Shell/wjVRw5zv">SSH</a> server. Even though the operators of web-based SSH solutions usually don't log sensitive data the data is theoretically available to them in plain form. It is unlikely that this will cause a security issue when the <a href="/facts/Application_server/wHYtgYK5">web application server</a> and the SSH server are run on the same server or are controlled by the same entity.</li>
<li><i>Tunneling</i>: Unlike most traditional, application based SSH clients, web-based SSH clients are unable to tunnel ("forward") <a href="/facts/Transmission_Control_Protocol/WW4sPrt9">TCP</a> traffic.  For example, running an <a href="/facts/X_Window_System/ac2vRIQL">X</a> session over a web-based SSH session is not possible. However, the lack of ability is caused by implementation issues, and not inherent in some way.<a class="footnote-ref" id="fnref:3" href="#fn:3"><sup>3</sup></a></li></ul>
<h2 id="free-and-open-source-examples">Free and open source examples</h2>
<ul><li>Google's <i>Secure Shell extension for Chrome and Chromium</i><a class="footnote-ref" id="fnref:4" href="#fn:4"><sup>4</sup></a> pairs the JavaScript hterm terminal emulator with <a href="/facts/OpenSSH/2qxJ3Fe7">OpenSSH</a> client code running on <a href="/facts/Native_Client/6dU1aHhp">Native Client</a>.<a class="footnote-ref" id="fnref:5" href="#fn:5"><sup>5</sup></a>  The Secure Shell extension works with non-Google HTTP-to-SSH proxies via proxy hooks, and third-party application <i>nassh-relay</i><a class="footnote-ref" id="fnref:6" href="#fn:6"><sup>6</sup></a> can use those hooks to enable the Secure Shell extension to establish an SSH connection over <a href="/facts/XMLHttpRequest/3FHofhdx">XMLHttpRequest</a> or <a href="/facts/WebSocket/NcQrqpnv">WebSocket</a> transport.</li>
<li><i>shellinabox</i><a class="footnote-ref" id="fnref:7" href="#fn:7"><sup>7</sup></a> operates as a stand-alone service or in conjunction with <a href="/facts/Nginx/AlTYUuTp">nginx</a> to provide <a href="/facts/HTTPS/MSWYz4zo">HTTPS</a> access to a login shell, and is packaged for <a href="/facts/Debian/cBd93qfJ">Debian</a> and <a href="/facts/RedHat/5rhmBLBa">RedHat</a> -derived <a href="/facts/Linux/9FvCKSTq">Linux</a> distributions.</li>
<li><i>webssh</i><a class="footnote-ref" id="fnref:8" href="#fn:8"><sup>8</sup></a> is a similar solution written in Python.</li>
<li><i>Bastillion</i><a class="footnote-ref" id="fnref:9" href="#fn:9"><sup>9</sup></a> is a self hosted, web-based bastion host with auditing and key management capabilities. Users connect to a centralized server over <a href="/facts/HTTPS/MSWYz4zo">HTTPS</a> and SSH connections are proxied through a secure <a href="/facts/WebSocket/NcQrqpnv">WebSocket</a> transport.</li>
<li><i>FireSSH</i> is a browser plug-in that works on Firefox ESR and Waterfox.</li></ul>
<h2 id="see-also">See also</h2>
<ul><li><a href="/facts/Web_shell/XXj1lIe8">Web shell</a></li></ul>

<h2 id="references">References</h2>

<ol>
<li id="fn:1"><p>"Google Code Archive - Long-term storage for Google Code Project Hosting". <a href="https://code.google.com/p/shellinabox/source/browse/demo/vt100.js" target="_blank">https://code.google.com/p/shellinabox/source/browse/demo/vt100.js</a> <a href="#fnref:1" class="footnote-back-ref">↩</a></p></li>
<li id="fn:2"><p>"Terminal.py - A Pure Python Terminal Emulator — Gate One 1.2.0 documentation". <a href="https://liftoff.github.io/GateOne/Developer/terminal.html" target="_blank">https://liftoff.github.io/GateOne/Developer/terminal.html</a> <a href="#fnref:2" class="footnote-back-ref">↩</a></p></li>
<li id="fn:3"><p>jcterm claims to be able to handle port forwarding, such as X11 forwarding <a href="http://www.jcraft.com/jcterm/" target="_blank">http://www.jcraft.com/jcterm/</a> <a href="#fnref:3" class="footnote-back-ref">↩</a></p></li>
<li id="fn:4"><p>"Secure Shell App". <a href="https://chrome.google.com/webstore/detail/iodihamcpbpeioajjeobimgagajmlibd" target="_blank">https://chrome.google.com/webstore/detail/iodihamcpbpeioajjeobimgagajmlibd</a> <a href="#fnref:4" class="footnote-back-ref">↩</a></p></li>
<li id="fn:5"><p>Chromium Secure Shell FAQ <a href="https://chromium.googlesource.com/apps/libapps/+/master/nassh/doc/FAQ.md" target="_blank">https://chromium.googlesource.com/apps/libapps/+/master/nassh/doc/FAQ.md</a> <a href="#fnref:5" class="footnote-back-ref">↩</a></p></li>
<li id="fn:6"><p>nassh-relay GitHub repository <a href="https://github.com/zyclonite/nassh-relay" target="_blank">https://github.com/zyclonite/nassh-relay</a> <a href="#fnref:6" class="footnote-back-ref">↩</a></p></li>
<li id="fn:7"><p>"Shellinabox". GitHub. 28 October 2021. <a href="https://github.com/shellinabox/shellinabox" target="_blank">https://github.com/shellinabox/shellinabox</a> <a href="#fnref:7" class="footnote-back-ref">↩</a></p></li>
<li id="fn:8"><p>"Webssh: Web based SSH client". <a href="https://pypi.org/project/webssh/" target="_blank">https://pypi.org/project/webssh/</a> <a href="#fnref:8" class="footnote-back-ref">↩</a></p></li>
<li id="fn:9"><p>Bastillion - Web-Based SSH Access and Key Management <a href="https://www.bastillion.io" target="_blank">https://www.bastillion.io</a> <a href="#fnref:9" class="footnote-back-ref">↩</a></p></li>
</ol>

Web-based SSH open-in-new

Web-based SSH