Skip to content
Fast and secure tunnels over HTTP/2
Branch: master
Clone or download
antwal and mmatczuk Fixed .check-fmt, .check-lint, ifne not working on OSX
Fixed .check-static for skip errors
Latest commit 5491fa1 Apr 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
benchmark move to go-http-tunnel Feb 15, 2017
cmd Allow ECDSA server Jan 18, 2019
id id: removal of unused constructors Nov 25, 2017
log log: removal of log-to flags Nov 28, 2017
proto license change Nov 24, 2017
testdata renaming Sep 27, 2017
tunnelmock license change Nov 24, 2017
vendor Updated Deps Apr 15, 2019
.editorconfig .editorconfig: tab=8 Oct 16, 2017
.gitignore Fixed golint, Added DS_Store to git ignore Apr 15, 2019
.travis.yml Changed travis.yml Go version to 1.x Oct 14, 2017
Gopkg.lock Updated Deps Apr 15, 2019
Gopkg.toml Updated Deps Apr 15, 2019
LICENSE license change Nov 24, 2017
Makefile Fixed .check-fmt, .check-lint, ifne not working on OSX Apr 15, 2019
README.md Updated to fix markdown - single space added after ### Apr 3, 2019
auth.go license change Nov 24, 2017
auth_test.go license change Nov 24, 2017
backoff.go license change Nov 24, 2017
client.go tunnel: removal of panics Nov 25, 2017
client_test.go tunnel: removal of panics Nov 25, 2017
doc.go license change Nov 24, 2017
errors.go license change Nov 24, 2017
httpproxy.go tunnel: removal of panics Nov 25, 2017
integration_test.go integration test: enable auto subscribe Nov 25, 2017
keepalive.go license change Nov 24, 2017
keepalive_windows.go license change Nov 24, 2017
pool.go pool: rename connPool.listener to free Nov 25, 2017
proxy.go license change Nov 24, 2017
registry.go registry: log subscribe/unsubscribe messages only when the action act… Nov 25, 2017
server.go keepalive: server listen keepalive fix plus log message fixes Nov 28, 2017
tcpproxy.go keepalive: server listen keepalive fix plus log message fixes Nov 28, 2017
tunnel.go license change Nov 24, 2017
utils.go license change Nov 24, 2017

README.md

Go HTTP tunnel GoDoc Go Report Card Build Status Github All Releases

Go HTTP tunnel is a reverse tunnel based on HTTP/2. It enables you to share your localhost when you don't have a public IP.

Features:

  • HTTP proxy with basic authentication
  • TCP proxy
  • Client auto reconnect
  • Client management and eviction
  • Easy to use CLI

Common use cases:

  • Hosting a game server from home
  • Developing webhook integrations
  • Managing IoT devices

Installation

Build the latest version.

$ go get -u github.com/mmatczuk/go-http-tunnel/cmd/...

Alternatively download the latest release.

Running

There are two executables:

  • tunneld - the tunnel server, to be run on publicly available host like AWS or GCE
  • tunnel - the tunnel client, to be run on your local machine or in your private network

To get help on the command parameters run tunneld -h or tunnel -h.

Tunnel requires TLS certificates for both client and server.

$ openssl req -x509 -nodes -newkey rsa:2048 -sha256 -keyout client.key -out client.crt
$ openssl req -x509 -nodes -newkey rsa:2048 -sha256 -keyout server.key -out server.crt

Run client:

  • Install tunnel binary
  • Make .tunnel directory in your project directory
  • Copy client.key, client.crt to .tunnel
  • Create configuration file tunnel.yml in .tunnel
  • Start all tunnels
$ tunnel -config ./tunnel/tunnel.yml start-all

Run server:

  • Install tunneld binary
  • Make .tunneld directory
  • Copy server.key, server.crt to .tunneld
  • Start tunnel server
$ tunneld -tlsCrt .tunneld/server.crt -tlsKey .tunneld/server.key

This will run HTTP server on port 80 and HTTPS (HTTP/2) server on port 443. If you want to use HTTPS it's recommended to get a properly signed certificate to avoid security warnings.

Run Server as a Service on Ubuntu using Systemd:

  • After completing the steps above successfully, create a new file for your service (you can name it whatever you want, just replace the name below with your chosen name).
$ vim tunneld.service
  • Add the following configuration to the file
[Unit]
Description=Go-Http-Tunnel Service
After=network.target
After=network-online.target

[Service]
ExecStart=/path/to/your/tunneld -tlsCrt /path/to/your/folder/.tunneld/server.crt -tlsKey /path/to/your/folder/.tunneld/server.key
TimeoutSec=30
Restart=on-failure
RestartSec=30

[Install]
WantedBy=multi-user.target
  • Save and exit this file.
  • Move this new file to /etc/systemd/system/
$ sudo mv tunneld.service /etc/systemd/system/
  • Change the file permission to allow it to run.
$ sudo chmod u+x /etc/systemd/system/tunneld.service
  • Start the new service and make sure you don't get any errors, and that your client is able to connect.
$ sudo systemctl start tunneld.service
  • You can stop the service with:
$ sudo systemctl stop tunneld.service
  • Finally, if you want the service to start automatically when the server is rebooted, you need to enable it.
$ sudo systemctl enable tunneld.service

There are many more options for systemd services, and this is by not means an exhaustive configuration file.

Configuration

The tunnel client tunnel requires configuration file, by default it will try reading tunnel.yml in your current working directory. If you want to specify other file use -config flag.

Sample configuration that exposes:

  • localhost:8080 as webui.my-tunnel-host.com
  • host in private network for ssh connections

looks like this

    server_addr: SERVER_IP:5223
    tunnels:
      webui:
        proto: http
        addr: localhost:8080
        auth: user:password
        host: webui.my-tunnel-host.com
      ssh:
        proto: tcp
        addr: 192.168.0.5:22
        remote_addr: 0.0.0.0:22

Configuration options:

  • server_addr: server TCP address, i.e. 54.12.12.45:5223
  • tls_crt: path to client TLS certificate, default: client.crt in the config file directory
  • tls_key: path to client TLS certificate key, default: client.key in the config file directory
  • root_ca: path to trusted root certificate authority pool file, if empty any server certificate is accepted
  • tunnels / [name]
    • proto: tunnel protocol, http or tcp
    • addr: forward traffic to this local port number or network address, for proto=http this can be full URL i.e. https://machine/sub/path/?plus=params, supports URL schemes http and https
    • auth: (proto=http) (optional) basic authentication credentials to enforce on tunneled requests, format user:password
    • host: (proto=http) hostname to request (requires reserved name and DNS CNAME)
    • remote_addr: (proto=tcp) bind the remote TCP address
  • backoff
    • interval: how long client would wait before redialing the server if connection was lost, exponential backoff initial interval, default: 500ms
    • multiplier: interval multiplier if reconnect failed, default: 1.5
    • max_interval: maximal time client would wait before redialing the server, default: 1m
    • max_time: maximal time client would try to reconnect to the server if connection was lost, set 0 to never stop trying, default: 15m

How it works

A client opens TLS connection to a server. The server accepts connections from known clients only. The client is recognized by its TLS certificate ID. The server is publicly available and proxies incoming connections to the client. Then the connection is further proxied in the client's network.

The tunnel is based HTTP/2 for speed and security. There is a single TCP connection between client and server and all the proxied connections are multiplexed using HTTP/2.

Donation

If this project help you reduce time to develop, you can give me a cup of coffee.

paypal

A GitHub star is always appreciated!

License

Copyright (C) 2017 Michał Matczuk

This project is distributed under the AGPL-3 license. See the LICENSE file for details. If you need an enterprice license contact me directly.

You can’t perform that action at this time.