add usage example and fix readme

Author: forest

README.md

@@ -7,14 +7,16 @@ It is intended to be used to make it easier for non-tech-savvy people to host we
 
 This repository only includes the application that does the tunneling part.  It does not include any other management or automation tools.
 
+See the usage example folder for a basic test.
+
 ![Diagram](readme/Diagram.png)
 
 ### How it is intended to be used:
 
 1. An automated tool creates a cloud instance and installs and configures the tunnel server on it. 
-1. An automated tool installs the tunnel client on the self-hoster's server computer.
-1. The tunnel client connects to the tunnel server on the Tunnel Control Port. This connection will use TLS Client Authentication. This connection will be held open and re-created if dropped. 
+1. An automated tool installs the tunnel client on the self-hoster's server computer. 
 1. An automated tool calls the `PUT /tunnels` api on the tunnel server's Management Port, and sends a JSON file describing which ports should be opened on the tunnel server, which client they should be tunneled to, and which ports on the client they should be tunneled to, as well as whether or not the HAProxy "PROXY" protocol should be used. This connection will also use TLS Client Authentication.
+1. The tunnel client connects to the tunnel server on the Tunnel Control Port. This connection will use TLS Client Authentication. This connection will be held open and re-created if dropped.
 1. An internet user connects to the tunnel server on one of the ports defined in the JSON. The internet user's request is tunneled through the original connection from the tunnel client, and then proxied to the web server software running on the self-hoster's server computer.
 
 ### Why did you set it up this way?
@@ -31,4 +33,8 @@ I have a few requirements for this system.
 1. Simplicity and Laser-like focus on "opaque" usage of TCP/TLS. Removed HTTP/WebSocket/Virtual Hosts code.
 1. Added support for HAProxy "PROXY" protocol. 
 1. Added support for Port mappings between front end and back end.
-1. Fixed various bugs related to connection lifecycle.
+1. Fixed various bugs related to connection lifecycle.
+
+### Issues
+
+Unfortunately right now the tunnels config has to put set 1st before the client can connect. I'll probably fix this later.

go.mod

@@ -1,6 +1,7 @@
 module git.sequentialread.com/forest/tunnel
 
 require (
+	github.com/armon/go-proxyproto v0.0.0-20180202201750-5b7edb60ff5f
 	github.com/cenkalti/backoff v2.1.0+incompatible
 	github.com/gorilla/websocket v1.4.0
 	github.com/hashicorp/yamux v0.0.0-20181012175058-2f1d1f20f75d

go.sum

@@ -1,5 +1,7 @@
 git.sequentialread.com/forest/tunnel v0.0.0-20170601195443-35a8b95662bf h1:2flo/nnhfe3sSxQ/MHlK7KoY54tQ1pAvMzkh0ZOxyH4=
 git.sequentialread.com/forest/tunnel v0.0.0-20170601195443-35a8b95662bf/go.mod h1:i+PvDDsWjggoCQOO8bGJJKRB9qfxmHk5yzIEA/h8dzg=
+github.com/armon/go-proxyproto v0.0.0-20180202201750-5b7edb60ff5f h1:SaJ6yqg936TshyeFZqQE+N+9hYkIeL9AMr7S4voCl10=
+github.com/armon/go-proxyproto v0.0.0-20180202201750-5b7edb60ff5f/go.mod h1:QmP9hvJ91BbJmGVGSbutW19IC0Q9phDCLGaomwTJbgU=
 github.com/cenkalti/backoff v2.1.0+incompatible h1:FIRvWBZrzS4YC7NT5cOuZjexzFvIr+Dbi6aD1cZaNBk=
 github.com/cenkalti/backoff v2.1.0+incompatible/go.mod h1:90ReRw6GdpyfrHakVjL/QHaoyV4aDUVVkXQJJJ3NXXM=
 github.com/gorilla/websocket v1.4.0 h1:WDFjx/TMzVgy9VdMMQi2K2Emtwi2QcUQsztZ/zLaH/Q=

usage-example/client-config.json

@@ -0,0 +1,7 @@
+{
+    "DebugLog": false,
+	"ClientIdentifier": "TestClient1",
+	"ServerHost": "localhost",
+	"ServerTunnelControlPort": 9056,
+	"ServerManagementPort":  9057
+}

usage-example/listener.go

@@ -0,0 +1,53 @@
+package main
+
+import (
+	"fmt"
+	"net"
+
+	proxyproto "github.com/armon/go-proxyproto"
+)
+
+func main() {
+	// Create a listener
+	tcpListener, err := net.Listen("tcp", ":9001")
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Print("Listener: I am listening on port 9001\n")
+
+	// Wrap listener in a proxyproto listener
+	proxyListener := &proxyproto.Listener{Listener: tcpListener}
+	for {
+		conn, err := proxyListener.Accept()
+		if err != nil {
+			panic(err)
+		}
+		go acceptConnection(conn)
+
+	}
+
+}
+
+func acceptConnection(conn net.Conn) {
+	fmt.Printf("Listener: Someone connected from: %s\r\n", conn.RemoteAddr().String())
+	buffer := make([]byte, 4096, 4096)
+	bytesRead := 0
+	var err error
+	for done := false; !done; done = bytesRead > 0 {
+		bytesRead, err = conn.Read(buffer)
+		if err != nil {
+			panic(err)
+		}
+	}
+
+	fmt.Printf("Listener: read %d bytes\n", bytesRead)
+	fmt.Printf("Listener: the sender sent: %s\n", string(buffer[:bytesRead]))
+	fmt.Print("Listener: I am going to respond with \"asd\"\n")
+	conn.Write([]byte("asd"))
+	err = conn.Close()
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println("Listener: conn.Close()")
+}

usage-example/run-test.sh

@@ -0,0 +1,58 @@
+#!/bin/bash -e
+
+touch test.log
+
+tail -f  test.log &
+TAIL_PID=$!
+
+go build -o ./tunnel ../main.go
+go build -o ./sender sender.go
+go build -o ./listener listener.go
+
+# Start the server
+# tunnel mux port: 9056
+# management port: 9057
+./tunnel -mode server -configFile server-config.json 2>&1  >> test.log  &
+SERVER_PID=$!
+
+# Start the "listener" test app 
+# It listens on port 9001.  This would be your web  application server.
+./listener  2>&1 >> test.log &
+LISTENER_PID=$!
+
+sleep 1
+
+# Post the tunnels config to the management port of the tunnel server
+# this would be done by the automation tool
+echo "tunnel configuration:"
+curl -s -X PUT -H "Content-Type: application/json" -d @tunnels.json localhost:9057/tunnels 2>&1 >> test.log 
+echo ""
+echo ""
+
+# Start the client 
+# Client Identifier: TestClient1
+./tunnel -mode client -configFile client-config.json 2>&1 >> test.log &
+CLIENT_PID=$!
+
+sleep 1
+
+# Start the "sender" test app 
+# It listens on port 9001.  This would be your end user who wants to use the web application.
+./sender 2>&1  >> test.log  &
+SENDER_PID=$!
+
+sleep 1
+
+echo "Wait 3 seconds then exit. "  >> test.log
+
+sleep 3
+
+kill -TERM $SERVER_PID
+kill -TERM $CLIENT_PID
+kill -TERM $LISTENER_PID
+kill -TERM $TAIL_PID
+
+rm test.log
+rm tunnel
+rm sender 
+rm listener

usage-example/sender.go

@@ -0,0 +1,35 @@
+package main
+
+import (
+	"fmt"
+	"net"
+)
+
+func main() {
+
+	fmt.Println("Sender: I am dialing localhost:9000")
+
+	conn, err := net.Dial("tcp", "localhost:9000")
+	if err != nil {
+		panic(err)
+	}
+	sent, err := conn.Write([]byte("Hello ! Hello! \n"))
+	if err != nil {
+		panic(err)
+	}
+	fmt.Printf("Sender: sent %d bytes\n", sent)
+
+	buffer := make([]byte, 4096, 4096)
+	bytesRead := 0
+	for done := false; !done; done = bytesRead > 0 {
+		bytesRead, err = conn.Read(buffer)
+		if err != nil {
+			panic(err)
+		}
+	}
+
+	fmt.Printf("Sender: read %d bytes\n", bytesRead)
+	fmt.Printf("Sender: Response from listener was: %s\n", string(buffer[:bytesRead]))
+
+	//conn.Close()
+}

usage-example/server-config.json

@@ -0,0 +1,6 @@
+
+{
+    "DebugLog": false,
+	"TunnelControlPort": 9056,
+	"ManagementPort":  9057
+}

usage-example/tunnels.json

@@ -0,0 +1,8 @@
+[
+    {
+        "ClientIdentifier": "TestClient1",
+        "FrontEndListenPort": 9000,
+        "BackEndPort": 9001,
+        "ProxyProtocol": true
+    }
+]