wormhole

wormhole lets you expose your locally running web server via a public URL. Written in Rust. Built completely with async-io on top of tokio.

1. Usage Instructions
2. How does it work?
3. Self-hosting

Usage

```shell script

Store the authentication key

wormhole auth --key

Start tunneling traffic to :8000

wormhole start -p 8000 ```

How does it work?

Server

The wormhole server both the operates control server (via port 5000, using websockets) and accepts raw TCP streams (via port 8080).

1. New clients connect over websockets to establish the client-tunnel.
2. When a new raw TCP stream connects, the wormhole server reads the incoming bytes and writes it to the client-tunnel
3. When incoming data is received from the client-tunnel, the control server writes those bytes into the TCP stream.

Client

The wormhole client establishes a websocket connections to the wormhole server to establish the remote-tunnel, and then:

1. Reads TCP bytes from the remote-tunnel
2. Opens a new local TCP stream to the locally running server (specified as a program argument)
3. Writes the TCP bytes from to the local stream
4. Reads TCP bytes from the local stream
5. Writes the outgoing TCP bytes bacl into the remote-tunnel

Caveats

This implementation does not support multiple running servers (i.e. centralized coordination). Therefore, if you deploy multiple instances of the server, it will only work if the client connects to the same instance as the remote TCP stream.

Host it yourself

1. Compile the server for the musl target. See the musl_build.sh for a way to do this trivially with Docker!
2. See Dockerfile for a simple alpine based image that runs that server binary.
3. Deploy the image where-ever you want.
4. Don't forget to set env's ALLOWED_HOSTS and SECRET_KEY (see below how they're used).

Testing Locally

```shell script

Expects TCP traffic on 8080 and control websockets on 5000

ALLOWEDHOSTS="mytunnelhost.com" SECRETKEY="SECRETKEY" cargo run --bin wormholeserver

Run a local wormhole pointing to your local wormhole_server

WEBSOCKETHOST=localhost:5000 TLSOFF=1 cargo run --bin wormhole -- -s "" -k "" -p 8000

Test it out!

Remember 8080 is our local wormhole_server TCP server

curl -H '.mytunnelhost.com' "http://localhost:8080/some_path?with=somequery" ```