Add registered clients feature

README.md

@@ -79,37 +79,175 @@ Sample configuration that exposes:
 looks like this
 
 ```yaml
-    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
+server_addr: SERVER_IP:5223
+tunnels:
+  webui:
+    proto: http
+    local_addr: localhost:8080
+    auth: user:password
+    host: webui.my-tunnel-host.com
+  ssh:
+    proto: tcp
+    local_addr: 192.168.0.5:22
+    remote_addr: 0.0.0.0:22
 ```
 
 Configuration options:
 
+* `name`: set the client name (not required).
+* `description`: set the client name (not required). 
 * `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`
+    * `local_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
+    * `disabled`: if set to `true` this tunnel has be ignored.
 * `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`
 
+## Client Registration
+
+### Client
+
+Configuration file `tunnel.yaml`:
+
+```yaml
+registered: true
+server_addr: SERVER_IP:5223
+tunnels:
+  webui:
+    proto: http
+    local_addr: localhost:8080
+    auth: user:password
+  ssh:
+    proto: tcp
+    local_addr: 192.168.0.5:22
+```
+
+Configuration options:
+
+* `registered`: registered client. Set as `true`.
+* `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`
+    * `local_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`
+    * `disabled`: if set to `true` this tunnel has be ignored.
+* `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`
+
+### Server
+
+Create registered clients database structure if not exists:
+
+```bash
+$ mkdir registered_clients
+```
+
+On client, get ID: `$ tunnel id`
+
+Registered **Client DIR** `registered_clients/CLIENT_ID`.
+
+Configure client (file `config.yaml`).
+Example `registered_clients/SS2KPSV-5KG2URM-WYUEDLY-FBDAD7A-MUUVTDX-TL7KL45-2PQEQAD-IN4LVAH/config.yaml`:
+
+```yaml
+connections: 4
+tunnels:
+  webui:
+    proto: http
+    host: mps.dea.ufv.br
+  ssh:
+    proto: tcp
+    remote_addr: 127.0.0.1:2222
+```
+
+Configuration options:
+* `disabled`: if set to `true` block this client. Or create empty file `disabled` on client dir. 
+Example: `$ touch registered_clients/CLIENT_ID/disabled`. 
+* `connections`: number of connections in addition to the main connection. Default is `0`.
+*  `tunnels / [name]`
+    * `proto`: tunnel protocol, `http` or `tcp`
+    * `host`: (`proto=http`) hostname to request (requires reserved name and DNS CNAME)
+    * `remote_addr`: (`proto=tcp`) bind the remote TCP address
+    * `disabled`: if set to `true` this tunnel has be ignored.
+
+### Run
+
+Server:
+```bash
+$ tunneld -registeredClientsDB registered_clients
+```
+
+Client:
+```bash
+$ tunnel start-all
+```
+
+### Embeded
+
+#### tunnel
+Example for embed `tunnel` in your code.
+
+```go
+package main
+
+import "github.com/mmatczuk/go-http-tunnel/cli/tunnel"
+
+func tunnelClient() {
+	options, err := tunnel.ParseArgs(false, "mycmd", "start-all")
+	if err != nil {
+		panic(err)
+	}
+	tunnel.MainConfigOptions(&tunnel.ClientConfig{
+		ServerAddr: "domain.com:2000",
+		Tunnels: map[string]*tunnel.Tunnel{
+			"main": {
+				Protocol:   "tcp",
+				LocalAddr:  "localhost:5000",
+				RemoteAddr: "domain.com:5000",
+			},
+		},
+	}, options)
+}
+
+func main() {
+	go tunnelClient()
+
+	// ... my system code
+}
+```
+
+#### tunneld
+
+Example for embed `tunneld` in your code.
+
+```go
+package main
+
+import "github.com/mmatczuk/go-http-tunnel/cli/tunneld"
+
+func main() {
+	go tunneld.MainArgs("mycmd", "-log-level", "3", "-httpAddr", ":19000", "-httpsAddr", ":19001")
+
+	// ... my system code
+}
+```
+
 ## 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.

cmd/tunnel/config.go → cli/tunnel/config.go

@@ -2,11 +2,12 @@
 // Use of this source code is governed by an AGPL-style
 // license that can be found in the LICENSE file.
 
-package main
+package tunnel
 
 import (
 	"fmt"
 	"io/ioutil"
+	"os"
 	"path/filepath"
 	"time"
 
@@ -21,6 +22,7 @@ const (
 	DefaultBackoffMultiplier  = 1.5
 	DefaultBackoffMaxInterval = 60 * time.Second
 	DefaultBackoffMaxTime     = 15 * time.Minute
+	ConfigFileSTDIN           = "-"
 )
 
 // BackoffConfig defines behavior of staggering reconnection retries.
@@ -34,14 +36,15 @@ type BackoffConfig struct {
 // Tunnel defines a tunnel.
 type Tunnel struct {
 	Protocol   string `yaml:"proto,omitempty"`
-	Addr       string `yaml:"addr,omitempty"`
+	LocalAddr  string `yaml:"local_addr,omitempty"`
 	Auth       string `yaml:"auth,omitempty"`
 	Host       string `yaml:"host,omitempty"`
 	RemoteAddr string `yaml:"remote_addr,omitempty"`
 }
 
 // ClientConfig is a tunnel client configuration.
 type ClientConfig struct {
+	Registered bool               `yaml:"registered"`
 	ServerAddr string             `yaml:"server_addr"`
 	TLSCrt     string             `yaml:"tls_crt"`
 	TLSKey     string             `yaml:"tls_key"`
@@ -50,10 +53,20 @@ type ClientConfig struct {
 	Tunnels    map[string]*Tunnel `yaml:"tunnels"`
 }
 
-func loadClientConfigFromFile(file string) (*ClientConfig, error) {
-	buf, err := ioutil.ReadFile(file)
-	if err != nil {
-		return nil, fmt.Errorf("failed to read file %q: %s", file, err)
+func LoadClientConfigFromFile(file string) (*ClientConfig, error) {
+	var (
+		buf []byte
+		err error
+	)
+	if file == ConfigFileSTDIN {
+		if buf, err = ioutil.ReadAll(os.Stdin); err != nil {
+			return nil, fmt.Errorf("failed to read config from STDIN: ", err)
+		}
+		file = "STDIN"
+	} else {
+		if buf, err = ioutil.ReadFile(file); err != nil {
+			return nil, fmt.Errorf("failed to read file %q: %s", file, err)
+		}
 	}
 
 	c := ClientConfig{
@@ -81,11 +94,11 @@ func loadClientConfigFromFile(file string) (*ClientConfig, error) {
 	for name, t := range c.Tunnels {
 		switch t.Protocol {
 		case proto.HTTP:
-			if err := validateHTTP(t); err != nil {
+			if err := validateHTTP(c.Registered, t); err != nil {
 				return nil, fmt.Errorf("%s %s", name, err)
 			}
 		case proto.TCP, proto.TCP4, proto.TCP6:
-			if err := validateTCP(t); err != nil {
+			if err := validateTCP(c.Registered, t); err != nil {
 				return nil, fmt.Errorf("%s %s", name, err)
 			}
 		default:
@@ -96,15 +109,15 @@ func loadClientConfigFromFile(file string) (*ClientConfig, error) {
 	return &c, nil
 }
 
-func validateHTTP(t *Tunnel) error {
+func validateHTTP(registered bool, t *Tunnel) error {
 	var err error
-	if t.Host == "" {
+	if !registered && t.Host == "" {
 		return fmt.Errorf("host: missing")
 	}
-	if t.Addr == "" {
+	if t.LocalAddr == "" {
 		return fmt.Errorf("addr: missing")
 	}
-	if t.Addr, err = normalizeURL(t.Addr); err != nil {
+	if t.LocalAddr, err = normalizeURL(t.LocalAddr); err != nil {
 		return fmt.Errorf("addr: %s", err)
 	}
 
@@ -117,15 +130,17 @@ func validateHTTP(t *Tunnel) error {
 	return nil
 }
 
-func validateTCP(t *Tunnel) error {
+func validateTCP(registered bool, t *Tunnel) error {
 	var err error
-	if t.RemoteAddr, err = normalizeAddress(t.RemoteAddr); err != nil {
-		return fmt.Errorf("remote_addr: %s", err)
+	if !registered {
+		if t.RemoteAddr, err = normalizeAddress(t.RemoteAddr); err != nil {
+			return fmt.Errorf("remote_addr: %s", err)
+		}
 	}
-	if t.Addr == "" {
+	if t.LocalAddr == "" {
 		return fmt.Errorf("addr: missing")
 	}
-	if t.Addr, err = normalizeAddress(t.Addr); err != nil {
+	if t.LocalAddr, err = normalizeAddress(t.LocalAddr); err != nil {
 		return fmt.Errorf("addr: %s", err)
 	}
 

cmd/tunnel/normalize.go → cli/tunnel/normalize.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by an AGPL-style
 // license that can be found in the LICENSE file.
 
-package main
+package tunnel
 
 import (
 	"fmt"

cmd/tunnel/normalize_test.go → cli/tunnel/normalize_test.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by an AGPL-style
 // license that can be found in the LICENSE file.
 
-package main
+package tunnel
 
 import (
 	"strings"