boringproxy/client.go

package boringproxy

import (
	"context"
	"crypto/tls"
	"encoding/json"
	"errors"
	"fmt"
	"github.com/caddyserver/certmagic"
	"golang.org/x/crypto/ssh"
	"io"
	"io/ioutil"
	"log"
	"net"
	"net/http"
	"strings"
	"sync"
	"time"
)

type Client struct {
	httpClient       *http.Client
	tunnels          map[string]Tunnel
	previousEtag     string
	server           string
	token            string
	clientName       string
	user             string
	cancelFuncs      map[string]context.CancelFunc
	cancelFuncsMutex *sync.Mutex
	certConfig       *certmagic.Config
}

type ClientConfig struct {
	ServerAddr string
	Token      string
	ClientName string
	User       string
	CertDir    string
	AcmeEmail  string
	DnsServer  string
}

func NewClient(config *ClientConfig) *Client {

	if config.DnsServer != "" {
		net.DefaultResolver = &net.Resolver{
			PreferGo: true,
			Dial: func(ctx context.Context, network, address string) (net.Conn, error) {
				d := net.Dialer{
					Timeout: time.Millisecond * time.Duration(10000),
				}
				return d.DialContext(ctx, "udp", fmt.Sprintf("%s:53", config.DnsServer))
			},
		}
	}

	// Use random unprivileged port for ACME challenges. This is necessary
	// because of the way certmagic works, in that if it fails to bind
	// HTTPSPort (443 by default) and doesn't detect anything else binding
	// it, it fails. Obviously the boringproxy client is likely to be
	// running on a machine where 443 isn't bound, so we need a different
	// port to hack around this. See here for more details:
	// https://github.com/caddyserver/certmagic/issues/111
	var err error
	certmagic.HTTPSPort, err = randomOpenPort()
	if err != nil {
		log.Fatal("Failed get random port for TLS challenges")
	}

	certmagic.DefaultACME.DisableHTTPChallenge = true

	if config.CertDir != "" {
		certmagic.Default.Storage = &certmagic.FileStorage{config.CertDir}
	}

	if config.AcmeEmail != "" {
		certmagic.DefaultACME.Email = config.AcmeEmail
	}

	certConfig := certmagic.NewDefault()

	httpClient := &http.Client{}
	tunnels := make(map[string]Tunnel)
	cancelFuncs := make(map[string]context.CancelFunc)
	cancelFuncsMutex := &sync.Mutex{}

	return &Client{
		httpClient:       httpClient,
		tunnels:          tunnels,
		previousEtag:     "",
		server:           config.ServerAddr,
		token:            config.Token,
		clientName:       config.ClientName,
		user:             config.User,
		cancelFuncs:      cancelFuncs,
		cancelFuncsMutex: cancelFuncsMutex,
		certConfig:       certConfig,
	}
}

func (c *Client) RunPuppetClient() {

	url := fmt.Sprintf("https://%s/api/users/%s/clients/%s", c.server, c.user, c.clientName)
	clientReq, err := http.NewRequest("PUT", url, nil)
	if err != nil {
		log.Fatal("Failed to PUT client")
	}
	if len(c.token) > 0 {
		clientReq.Header.Add("Authorization", "bearer "+c.token)
	}
	resp, err := c.httpClient.Do(clientReq)
	if err != nil {
		log.Fatal("Failed to PUT client")
	}
	defer resp.Body.Close()

	if resp.StatusCode != 200 {
		log.Fatal("Failed to PUT client")
	}

	for {
		err := c.PollTunnels()
		if err != nil {
			log.Print(err)
		}
		time.Sleep(2 * time.Second)
	}
}

func (c *Client) PollTunnels() error {

	//log.Println("PollTunnels")

	url := fmt.Sprintf("https://%s/api/tunnels?client-name=%s", c.server, c.clientName)

	listenReq, err := http.NewRequest("GET", url, nil)
	if err != nil {
		return err
	}

	if len(c.token) > 0 {
		listenReq.Header.Add("Authorization", "bearer "+c.token)
	}

	resp, err := c.httpClient.Do(listenReq)
	if err != nil {
		return err
	}
	defer resp.Body.Close()

	if resp.StatusCode != 200 {
		return errors.New("Failed to listen (not 200 status)")
	}

	etag := resp.Header["Etag"][0]

	if etag != c.previousEtag {

		body, err := ioutil.ReadAll(resp.Body)

		tunnels := make(map[string]Tunnel)

		err = json.Unmarshal(body, &tunnels)
		if err != nil {
			return err
		}

		c.SyncTunnels(tunnels)

		c.previousEtag = etag
	}

	return nil
}

func (c *Client) SyncTunnels(serverTunnels map[string]Tunnel) {
	log.Println("SyncTunnels")

	// update tunnels to match server
	for k, newTun := range serverTunnels {

		tun, exists := c.tunnels[k]
		if !exists {
			log.Println("New tunnel", k)
			c.tunnels[k] = newTun
			cancel := c.BoreTunnel(newTun)

			c.cancelFuncsMutex.Lock()
			c.cancelFuncs[k] = cancel
			c.cancelFuncsMutex.Unlock()

		} else if newTun != tun {
			log.Println("Restart tunnel", k)

			c.cancelFuncsMutex.Lock()
			c.cancelFuncs[k]()
			c.cancelFuncsMutex.Unlock()

			cancel := c.BoreTunnel(newTun)

			c.cancelFuncsMutex.Lock()
			c.cancelFuncs[k] = cancel
			c.cancelFuncsMutex.Unlock()
		}
	}

	// delete any tunnels that no longer exist on server
	for k, _ := range c.tunnels {
		_, exists := serverTunnels[k]
		if !exists {
			log.Println("Kill tunnel", k)
			c.cancelFuncsMutex.Lock()
			c.cancelFuncs[k]()
			delete(c.cancelFuncs, k)
			c.cancelFuncsMutex.Unlock()
			delete(c.tunnels, k)
		}
	}
}

func (c *Client) BoreTunnel(tunnel Tunnel) context.CancelFunc {

	log.Println("BoreTunnel", tunnel.Domain)

	ctx, cancelFunc := context.WithCancel(context.Background())

	go func() {
		signer, err := ssh.ParsePrivateKey([]byte(tunnel.TunnelPrivateKey))
		if err != nil {
			log.Fatalf("unable to parse private key: %v", err)
		}

		//var hostKey ssh.PublicKey

		config := &ssh.ClientConfig{
			User: tunnel.Username,
			Auth: []ssh.AuthMethod{
				ssh.PublicKeys(signer),
			},
			//HostKeyCallback: ssh.FixedHostKey(hostKey),
			HostKeyCallback: ssh.InsecureIgnoreHostKey(),
		}

		sshHost := fmt.Sprintf("%s:%d", tunnel.ServerAddress, tunnel.ServerPort)
		client, err := ssh.Dial("tcp", sshHost, config)
		if err != nil {
			log.Fatal("Failed to dial: ", err)
		}
		//defer client.Close()

		bindAddr := "127.0.0.1"
		if tunnel.AllowExternalTcp {
			bindAddr = "0.0.0.0"
		}
		tunnelAddr := fmt.Sprintf("%s:%d", bindAddr, tunnel.TunnelPort)
		listener, err := client.Listen("tcp", tunnelAddr)
		if err != nil {
			log.Fatal("unable to register tcp forward: ", err)
		}
		//defer listener.Close()

		if tunnel.TlsTermination == "client" {

			tlsConfig := &tls.Config{
				GetCertificate: c.certConfig.GetCertificate,
				NextProtos:     []string{"h2", "acme-tls/1"},
			}
			tlsListener := tls.NewListener(listener, tlsConfig)

			httpMux := http.NewServeMux()

			httpMux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
				proxyRequest(w, r, tunnel, c.httpClient, tunnel.ClientPort)
			})

			httpServer := &http.Server{
				Handler: httpMux,
			}

			// TODO: It seems inefficient to make a separate HTTP server for each TLS-passthrough tunnel,
			// but the code is much simpler. The only alternative I've thought of so far involves storing
			// all the tunnels in a mutexed map and retrieving them from a single HTTP server, same as the
			// boringproxy server does.
			go httpServer.Serve(tlsListener)

			// TODO: There's still quite a bit of duplication with what the server does. Could we
			// encapsulate it into a type?
			err = c.certConfig.ManageSync([]string{tunnel.Domain})
			if err != nil {
				log.Println("CertMagic error at startup")
				log.Println(err)
			}

		} else {

			go func() {
				for {
					conn, err := listener.Accept()
					if err != nil {
						// TODO: Currently assuming an error means the
						// tunnel was manually deleted, but there
						// could be other errors that we should be
						// attempting to recover from rather than
						// breaking.
						break
						//continue
					}
					go c.handleConnection(conn, tunnel.ClientAddress, tunnel.ClientPort)
				}
			}()
		}

		<-ctx.Done()
		listener.Close()
		client.Close()
	}()

	return cancelFunc
}

func (c *Client) handleConnection(conn net.Conn, upstreamAddr string, port int) {

	defer conn.Close()

	useTls := false
	addr := upstreamAddr

	if strings.HasPrefix(upstreamAddr, "https://") {
		addr = upstreamAddr[len("https://"):]
		useTls = true
	}

	var upstreamConn net.Conn
	var err error

	if useTls {
		tlsConfig := &tls.Config{
			InsecureSkipVerify: true,
		}
		upstreamConn, err = tls.Dial("tcp", fmt.Sprintf("%s:%d", addr, port), tlsConfig)
	} else {
		upstreamConn, err = net.Dial("tcp", fmt.Sprintf("%s:%d", addr, port))
	}

	if err != nil {
		log.Print(err)
		return
	}

	defer upstreamConn.Close()

	var wg sync.WaitGroup
	wg.Add(2)

	// Copy request to upstream
	go func() {
		_, err := io.Copy(upstreamConn, conn)
		if err != nil {
			log.Println(err.Error())
		}

		if c, ok := upstreamConn.(*net.TCPConn); ok {
			c.CloseWrite()
		} else if c, ok := upstreamConn.(*tls.Conn); ok {
			c.CloseWrite()
		}

		wg.Done()
	}()

	// Copy response to downstream
	go func() {
		_, err := io.Copy(conn, upstreamConn)
		//conn.(*net.TCPConn).CloseWrite()
		if err != nil {
			log.Println(err.Error())
		}
		// TODO: I added this to fix a bug where the copy to
		// upstreamConn was never closing, even though the copy to
		// conn was. It seems related to persistent connections going
		// idle and upstream closing the connection. I'm a bit worried
		// this might not be thread safe.
		conn.Close()
		wg.Done()
	}()

	wg.Wait()
}