boronine/h2tunnel: Simple ngrok alternative for Node.js

A CLI tool and Node.js library for a popular “tunneling” workflow, similar to the proprietary ngrok
or the openssh-based ssh -L solution. All in less than 700 LOC
with no dependencies.

This workflow allows exposing your localhost development server to the internet. This requires a server component
hosted on a public IP address, and a client component running on your local machine. The client establishes a tunnel
to the server, and the server proxies requests through this tunnel to your local machine.

1. The client initiates a TLS connection to the server and starts listening for HTTP2 sessions on it
2. The server takes the newly created TLS socket and initiates an HTTP2 session through it
3. The server starts accepting HTTP1 requests, converting them into HTTP2 requests, and fowarding them to the client
4. The client receives these HTTP2 requests and converts them back into HTTP1 requests to feed them into the local server

Converting between HTTP1 and HTTP2 is necessary to take advantage of HTTP2’s multiplexing capabilities. This feature of
the protocol allows simultaneous requests to be processed on a single TCP connection.

For authentication we use a self-signed TLS certificate + private key pair. This pair is used by both the client and
the server, and both are configured to reject anything else. This way, the pair effectively becomes a shared password.

Generate h2tunnel.key and h2tunnel.crt files using openssl command:

openssl req -x509 -newkey ec -pkeyopt ec_paramgen_curve:secp384r1 -days 3650 -nodes -keyout h2tunnel.key -out h2tunnel.crt -subj "/CN=example.com"

On your server (example.com), we will be listening for tunnel connections on port 15001, and providing an HTTP proxy
on port 80. Make sure these are open in your firewall.

Use any port for --mux-listen-port, h2tunnel will run an HTTP2 multiplexer on this port bound to 127.0.0.1,
it will not be exposed to the internet even if your firewall allows it.

sudo h2tunnel server \
  --crt h2tunnel.crt \
  --key h2tunnel.key \
  --tunnel-listen-ip 0.0.0.0 \
  --tunnel-listen-port 15001 \
  --proxy-listen-ip 0.0.0.0 \
  --proxy-listen-port 80 \
  --mux-listen-port=15002

On your local machine, we will connect to the tunnel and forward a local HTTP server on port 8000.

Use any port for --demux-listen-port, h2tunnel will run an HTTP2 demultiplexer on it.

python3 -m http.server # runs on port 8000
h2tunnel client \
  --crt h2tunnel.crt \
  --key h2tunnel.key \
  --tunnel-host=example.com \
  --tunnel-port=15001 \
  --local-http-port=8000 \
  --demux-listen-port=15004

This is the same as the previous example, but with an extra layer: a Caddy reverse proxy
that will auto-provision TLS certificates for your domain. This is useful if you want to expose an HTTPS server.

The client command line is the same as before, but for the server we will use a docker compose setup.

Specify your domain in the .env file:

TUNNEL_DOMAIN=example.com

Push the necessary files to the server:

scp .env Caddyfile Dockerfile docker-compose.yml h2tunnel.crt h2tunnel.key example.com:/home/myuser

Start the server:

You can integrate h2tunnel into your own Node.js application by importing the TunnelServer and TunnelClient classes.

import {TunnelClient} from "h2tunnel";

const client = new TunnelClient({
    logger: (line) => console.log(line), // optional
    key: `-----BEGIN PRIVATE KEY----- ...`,
    cert: `-----BEGIN CERTIFICATE----- ...`,
    demuxListenPort: 15004,
    localHttpPort: 8000,
    tunnelHost: `mysite.example.com`,
    tunnelPort: 15001,
});

// Start the client
client.start();

// Stop the client
await client.stop();

import {TunnelServer} from "h2tunnel";

const server = new TunnelServer({
    logger: (line) => console.log(line), // optional
    tunnelListenIp: "0.0.0.0",
    tunnelListenPort: 15001,
    key: `-----BEGIN PRIVATE KEY----- ...`,
    cert: `-----BEGIN CERTIFICATE----- ...`,
    proxyListenPort: 80,
    proxyListenIp: "0.0.0.0",
    muxListenPort: 15002,
});

// Start the server
server.start();

// Stop the server
await server.stop();