planetscale 0.2.0 → 0.3.3

data/vendor/github.com/planetscale/sql-proxy/proxy/client.go

@@ -1,467 +0,0 @@
-package proxy
-
-import (
-	"context"
-	"crypto/tls"
-	"crypto/x509"
-	"errors"
-	"fmt"
-	"io"
-	"net"
-	"os"
-	"strings"
-	"sync/atomic"
-	"time"
-
-	"go.uber.org/zap"
-)
-
-const (
-	keepAlivePeriod = time.Minute
-)
-
-// Cert represents the client certificate key pair in the root certiciate
-// authority that the client uses to verify server certificates.
-
-type Cert struct {
-	ClientCert tls.Certificate
-	CACert     *x509.Certificate
-	RemoteAddr string
-	Ports      RemotePorts
-}
-
-type RemotePorts struct {
-	Proxy int
-	MySQL int
-}
-
-// CertSource is used
-type CertSource interface {
-	// Cert returns the required certs needed to establish a TLS connection
-	// from the client to the server.
-	Cert(ctx context.Context, org, db, branch string) (*Cert, error)
-}
-
-// Client is responsible for listening to unsecured connections over a TCP
-// localhost port and tunneling them securely over a TLS connection to a remote
-// database instance defined by its PlanetScale unique branch identifier.
-type Client struct {
-	// connectionsCounter is used to enforce the optional maxConnections limit
-	// NOTE: don't move this field, as we need to make sure the fields are
-	// 64-bit aligned
-	connectionsCounter uint64
-
-	remoteAddr     string
-	localAddr      string
-	instance       string
-	maxConnections uint64
-	certSource     CertSource
-
-	log *zap.Logger
-
-	// configCache contains the TLS certificate chache for each indiviual
-	// database
-	configCache *tlsCache
-
-	listener net.Listener
-	// done is closed after a successfull net.Listen bind.
-	done chan struct{}
-}
-
-// Options are the options for creating a new Client.
-type Options struct {
-	// RemoteAddr defines the server address to tunnel local connections. By
-	// default we connect to the remote address given by the CertSource. This
-	// option can be used to over write it.
-	RemoteAddr string
-
-	// LocalAddr defines the address to listen for new connection
-	LocalAddr string
-
-	// Instance defines the remote DB instance to proxy new connection
-	Instance string
-
-	// MaxConnections is the maximum number of connections to establish
-	// before refusing new connections. 0 means no limit.
-	MaxConnections uint64
-
-	// CertSource defines the certificate source to obtain the required TLS
-	// certificates for the client and the remote address of the server to
-	// connect.
-	CertSource CertSource
-
-	// Logger defines which zap.Logger to use. Use it to override the default
-	// Development logger . Useful for tests.
-	Logger *zap.Logger
-}
-
-// NewClient creates a new proxy client instance
-func NewClient(opts Options) (*Client, error) {
-	c := &Client{
-		certSource:  opts.CertSource,
-		localAddr:   opts.LocalAddr,
-		remoteAddr:  opts.RemoteAddr,
-		instance:    opts.Instance,
-		configCache: newtlsCache(),
-		done:        make(chan struct{}),
-	}
-
-	if opts.Logger != nil {
-		c.log = opts.Logger
-	} else {
-		logger, err := zap.NewDevelopment(
-			zap.Fields(zap.String("app", "sql-proxy-client")),
-		)
-		if err != nil {
-			return nil, err
-		}
-		zap.ReplaceGlobals(logger)
-		c.log = logger
-	}
-
-	// cache the certs for the given instance(s)
-	_, _, err := c.clientCerts(context.Background(), opts.Instance)
-	if err != nil {
-		c.log.Error("couldn't retrieve TLS certificate for the client", zap.Error(err))
-	}
-
-	return c, nil
-}
-
-// Conn represents a connection from a client to a specific instance.
-type Conn struct {
-	Instance string
-	Conn     net.Conn
-}
-
-// Run runs the proxy. It listens to the configured localhost address and
-// proxies the connection over a TLS tunnel to the remote DB instance.
-func (c *Client) Run(ctx context.Context) error {
-	c.log.Info("ready for new connections")
-	l, err := c.getListener()
-	if err != nil {
-		return fmt.Errorf("error net.Listen: %w", err)
-	}
-	defer c.log.Sync() // nolint: errcheck
-
-	c.listener = l
-	close(c.done)
-
-	return c.run(ctx, l)
-}
-
-// LocalAddr returns the address of the local listener. This is by default
-// blocking and will only return if the proxy is invoked with the Run() method.
-func (c *Client) LocalAddr() (net.Addr, error) {
-	<-c.done
-
-	if c.listener == nil {
-		return nil, errors.New("listener is not set")
-
-	}
-	return c.listener.Addr(), nil
-}
-
-func (c *Client) getListener() (net.Listener, error) {
-	if strings.HasPrefix(c.localAddr, "unix://") {
-		p := strings.TrimPrefix(c.localAddr, "unix://")
-		if err := os.Remove(p); err != nil && !os.IsNotExist(err) {
-			return nil, fmt.Errorf("failed to remove unix domain socket file %s, error: %s", p, err)
-		}
-		return net.Listen("unix", p)
-	}
-	return net.Listen("tcp", c.localAddr)
-}
-
-// run is an internal function for testing the Client proxy event loop for
-// handling TCP connections
-func (c *Client) run(ctx context.Context, l net.Listener) error {
-	connSrc := make(chan Conn, 1)
-	go func() {
-		if err := c.listen(l, connSrc); err != nil {
-			c.log.Error("listen to local address", zap.Error(err))
-		}
-	}()
-
-	for {
-		select {
-		case <-ctx.Done():
-			termTimeout := time.Second * 1
-			c.log.Info("received context cancellation, waiting until timeout",
-				zap.Duration("timeout", termTimeout))
-
-			err := c.Shutdown(termTimeout)
-			if err != nil {
-				return fmt.Errorf("error during shutdown: %v", err)
-			}
-			return nil
-		case conn := <-connSrc:
-			go func(lc Conn) {
-				// TODO(fatih): detach context from parent
-				err := c.handleConn(ctx, lc.Conn, lc.Instance)
-				if err != nil {
-					c.log.Error("error proxying conns", zap.Error(err))
-				}
-			}(conn)
-		}
-	}
-}
-
-// listen listens to the client's localAddres and sends each incoming
-// connections to the given connSrc channel.
-func (c *Client) listen(l net.Listener, connSrc chan<- Conn) error {
-	c.log.Info("listening remote DB instance",
-		zap.String("local_addr", c.localAddr),
-		zap.String("instance", c.instance),
-	)
-
-	for {
-		start := time.Now()
-		conn, err := l.Accept()
-		if err != nil {
-			if nerr, ok := err.(net.Error); ok && nerr.Temporary() {
-				d := 10*time.Millisecond - time.Since(start)
-				if d > 0 {
-					time.Sleep(d)
-				}
-				continue
-			}
-			l.Close()
-
-			return fmt.Errorf("error in accept for on %v: %w", c.localAddr, err)
-		}
-
-		c.log.Info("new connection", zap.String("conn_addr", l.Addr().String()))
-
-		switch clientConn := conn.(type) {
-		case *net.TCPConn:
-			clientConn.SetKeepAlive(true)                  //nolint: errcheck
-			clientConn.SetKeepAlivePeriod(1 * time.Minute) //nolint: errcheck
-		}
-
-		connSrc <- Conn{
-			Conn:     conn,
-			Instance: c.instance,
-		}
-	}
-}
-
-func (c *Client) handleConn(ctx context.Context, conn net.Conn, instance string) error {
-	log := c.log.With(zap.String("instance", instance))
-	active := atomic.AddUint64(&c.connectionsCounter, 1)
-
-	// Deferred decrement of ConnectionsCounter upon connection closing
-	defer atomic.AddUint64(&c.connectionsCounter, ^uint64(0))
-
-	if c.maxConnections > 0 && active > c.maxConnections {
-		conn.Close()
-		return fmt.Errorf("too many open connections (max %d)", c.maxConnections)
-	}
-
-	cfg, remoteAddr, err := c.clientCerts(ctx, instance)
-	if err != nil {
-		return fmt.Errorf("couldn't retrieve certs for instance: %q: %w", instance, err)
-	}
-
-	// TODO(fatih): implement refreshing certs
-	// go p.refreshCertAfter(instance, timeToRefresh)
-
-	// overwrite the remote address if the user explicitly set it
-	if c.remoteAddr != "" {
-		remoteAddr = c.remoteAddr
-	}
-
-	c.log.Info("connecting to remote server", zap.String("remote_addr", remoteAddr))
-
-	var d net.Dialer
-	remoteConn, err := d.DialContext(ctx, "tcp", remoteAddr)
-	if err != nil {
-		conn.Close()
-		return fmt.Errorf("couldn't connect to %q: %v", remoteAddr, err)
-	}
-
-	type setKeepAliver interface {
-		SetKeepAlive(keepalive bool) error
-		SetKeepAlivePeriod(d time.Duration) error
-	}
-
-	if s, ok := conn.(setKeepAliver); ok {
-		if err := s.SetKeepAlive(true); err != nil {
-			log.Error("couldn't set KeepAlive to true", zap.Error(err))
-		} else if err := s.SetKeepAlivePeriod(keepAlivePeriod); err != nil {
-			log.Error("couldn't set KeepAlivePeriod", zap.Error(err), zap.Duration("keep_alive_period", keepAlivePeriod))
-		}
-	} else {
-		log.Warn("KeepAlive not supported: long-running tcp connections may be killed by the OS.")
-	}
-
-	secureConn := tls.Client(remoteConn, cfg)
-	if err := secureConn.Handshake(); err != nil {
-		secureConn.Close()
-		return fmt.Errorf("couldn't initiate TLS handshake to remote addr: %s", err)
-	}
-
-	// Hasta la vista, baby
-	copyThenClose(
-		secureConn,
-		conn,
-		"remote connection",
-		"local connection on "+conn.LocalAddr().String(),
-	)
-	return nil
-}
-
-// clientCerts returns the TLS configuration needed for the TLS handshake and
-// connection
-func (c *Client) clientCerts(ctx context.Context, instance string) (*tls.Config, string, error) {
-	cacheEntry, err := c.configCache.Get(instance)
-	if err == nil {
-		c.log.Info("using tls.Config from the cache", zap.String("instance", instance))
-		return cacheEntry.cfg, cacheEntry.remoteAddr, nil
-	}
-
-	if err != errConfigNotFound {
-		return nil, "", err // we don't handle non errConfigNotFound errors
-	}
-
-	s := strings.Split(instance, "/")
-	if len(s) != 3 {
-		return nil, "", fmt.Errorf("instance format is malformed, should be in form organization/dbname/branch, have: %q", instance)
-	}
-
-	cert, err := c.certSource.Cert(ctx, s[0], s[1], s[2])
-	if err != nil {
-		return nil, "", fmt.Errorf("couldn't retrieve certs from cert source: %s", err)
-	}
-
-	rootCertPool := x509.NewCertPool()
-	rootCertPool.AddCert(cert.CACert)
-
-	serverName := fmt.Sprintf("%s.%s.%s.%s", s[2], s[1], s[0], cert.RemoteAddr)
-	fullAddr := fmt.Sprintf("%s:%d", serverName, cert.Ports.Proxy)
-
-	cfg := &tls.Config{
-		ServerName:   serverName,
-		Certificates: []tls.Certificate{cert.ClientCert},
-		RootCAs:      rootCertPool,
-		// Set InsecureSkipVerify to skip the default validation we are
-		// replacing. This will not disable VerifyConnection.
-		InsecureSkipVerify: true,
-		VerifyConnection: func(cs tls.ConnectionState) error {
-			// For now, only verify the server's certificate chain.
-			// We don't know yet what the server's FQDN will be.
-			//
-			// 			serverName := cs.ServerName
-			// 			commonName := cs.PeerCertificates[0].Subject.CommonName
-			// 			if commonName != serverName {
-			// 				return fmt.Errorf("invalid certificate name %q, expected %q", commonName, serverName)
-			// 			}
-			opts := x509.VerifyOptions{
-				Roots:         rootCertPool,
-				Intermediates: x509.NewCertPool(),
-			}
-			for _, cert := range cs.PeerCertificates[1:] {
-				opts.Intermediates.AddCert(cert)
-			}
-			_, err := cs.PeerCertificates[0].Verify(opts)
-			return err
-		},
-	}
-
-	c.log.Info("adding tls.Config to the cache", zap.String("instance", instance))
-	c.configCache.Add(instance, cfg, fullAddr)
-	return cfg, fullAddr, nil
-}
-
-// Shutdown waits up to a given amount of time for all active connections to
-// close. Returns an error if there are still active connections after waiting
-// for the whole length of the timeout.
-func (c *Client) Shutdown(timeout time.Duration) error {
-	term, ticker := time.After(timeout), time.NewTicker(100*time.Millisecond)
-	defer ticker.Stop()
-
-	for {
-		select {
-		case <-ticker.C:
-			if atomic.LoadUint64(&c.connectionsCounter) > 0 {
-				continue
-			}
-			c.log.Info("no connections to wait, bailing out")
-		case <-term:
-		}
-		break
-	}
-
-	active := atomic.LoadUint64(&c.connectionsCounter)
-	if active == 0 {
-		return nil
-	}
-	return fmt.Errorf("%d active connections still exist after waiting for %v", active, timeout)
-}
-
-func copyThenClose(remote, local io.ReadWriteCloser, remoteDesc, localDesc string) {
-	firstErr := make(chan error, 1)
-
-	go func() {
-		readErr, err := myCopy(remote, local)
-		select {
-		case firstErr <- err:
-			if readErr && err == io.EOF {
-				zap.L().Info("client closed connection",
-					zap.String("local_desc", localDesc))
-			} else {
-				logError(localDesc, remoteDesc, readErr, err)
-			}
-			remote.Close()
-			local.Close()
-		default:
-		}
-	}()
-
-	readErr, err := myCopy(local, remote)
-	select {
-	case firstErr <- err:
-		if readErr && err == io.EOF {
-			zap.L().Info("instance closed connection",
-				zap.String("remote_desc", remoteDesc))
-		} else {
-			logError(remoteDesc, localDesc, readErr, err)
-		}
-		remote.Close()
-		local.Close()
-	default:
-		// In this case, the other goroutine exited first and already printed its
-		// error (and closed the things).
-	}
-}
-
-func logError(readDesc, writeDesc string, readErr bool, err error) {
-	var desc string
-	if readErr {
-		desc = "reading data from " + readDesc
-	} else {
-		desc = "writing data to " + writeDesc
-	}
-	zap.L().Error("copy error", zap.String("desc", desc), zap.Error(err))
-}
-
-// myCopy is similar to io.Copy, but reports whether the returned error was due
-// to a bad read or write. The returned error will never be nil
-func myCopy(dst io.Writer, src io.Reader) (readErr bool, err error) {
-	buf := make([]byte, 4096)
-	for {
-		n, err := src.Read(buf)
-		if n > 0 {
-			if _, werr := dst.Write(buf[:n]); werr != nil {
-				if err == nil {
-					return false, werr
-				}
-				// Read and write error; just report read error (it happened first).
-				return true, err
-			}
-		}
-		if err != nil {
-			return true, err
-		}
-	}
-}

data/vendor/github.com/planetscale/sql-proxy/proxy/tls_cache.go

@@ -1,73 +0,0 @@
-package proxy
-
-import (
-	"crypto/tls"
-	"errors"
-	"sync"
-	"time"
-)
-
-var errConfigNotFound = errors.New("TLS config not found")
-
-// expireTTL defines the time
-const expireTTL = 10 * time.Minute
-
-type cacheEntry struct {
-	// cfg defines the TLS config we're caching
-	cfg        *tls.Config
-	remoteAddr string
-
-	// added holds the time the cfg was added to the cache
-	added time.Time
-}
-
-type tlsCache struct {
-	// configs holds the TLS config for each remote instance
-	configs   map[string]cacheEntry
-	configsMu sync.Mutex // protects configs
-
-	// nowFn returns the current local time, used during insertion of cache
-	// entries. It's a function so we can use it for tests.
-	nowFn func() time.Time
-}
-
-func newtlsCache() *tlsCache {
-	return &tlsCache{
-		configs: make(map[string]cacheEntry),
-		nowFn:   time.Now,
-	}
-}
-
-// Add adds the given config and remote address for the given instance name
-func (t *tlsCache) Add(instance string, cfg *tls.Config, remoteAddr string) {
-	t.configsMu.Lock()
-	defer t.configsMu.Unlock()
-
-	t.configs[instance] = cacheEntry{
-		cfg:        cfg,
-		remoteAddr: remoteAddr,
-		added:      t.nowFn(),
-	}
-}
-
-// Get retrieves the config for the given instance
-func (t *tlsCache) Get(instance string) (cacheEntry, error) {
-	t.configsMu.Lock()
-	defer t.configsMu.Unlock()
-
-	e, ok := t.configs[instance]
-	if !ok {
-		return cacheEntry{}, errConfigNotFound
-	}
-
-	now := time.Now()
-
-	// delete the config if it's expired. This will trigger the user to request
-	// another TLS config.
-	if e.added.Add(expireTTL).Before(now) {
-		delete(t.configs, instance)
-		return cacheEntry{}, errConfigNotFound
-	}
-
-	return e, nil
-}

data/vendor/go.uber.org/atomic/.codecov.yml

@@ -1,19 +0,0 @@
-coverage:
-  range: 80..100
-  round: down
-  precision: 2
-
-  status:
-    project:                   # measuring the overall project coverage
-      default:                 # context, you can create multiple ones with custom titles
-        enabled: yes           # must be yes|true to enable this status
-        target: 100            # specify the target coverage for each commit status
-                               #   option: "auto" (must increase from parent commit or pull request base)
-                               #   option: "X%" a static target percentage to hit
-        if_not_found: success  # if parent is not found report status as success, error, or failure
-        if_ci_failed: error    # if ci fails report status as success, error, or failure
-
-# Also update COVER_IGNORE_PKGS in the Makefile.
-ignore:
-  - /internal/gen-atomicint/
-  - /internal/gen-valuewrapper/

data/vendor/go.uber.org/atomic/.gitignore

@@ -1,12 +0,0 @@
-/bin
-.DS_Store
-/vendor
-cover.html
-cover.out
-lint.log
-
-# Binaries
-*.test
-
-# Profiling output
-*.prof

data/vendor/go.uber.org/atomic/.travis.yml

@@ -1,27 +0,0 @@
-sudo: false
-language: go
-go_import_path: go.uber.org/atomic
-
-env:
-  global:
-    - GO111MODULE=on
-
-matrix:
-  include:
-  - go: oldstable
-  - go: stable
-    env: LINT=1
-
-cache:
-  directories:
-    - vendor
-
-before_install:
-  - go version
-
-script:
-  - test -z "$LINT" || make lint
-  - make cover
-
-after_success:
-  - bash <(curl -s https://codecov.io/bash)

data/vendor/go.uber.org/atomic/CHANGELOG.md

@@ -1,76 +0,0 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [1.7.0] - 2020-09-14
-### Added
-- Support JSON serialization and deserialization of primitive atomic types.
-- Support Text marshalling and unmarshalling for string atomics.
-
-### Changed
-- Disallow incorrect comparison of atomic values in a non-atomic way.
-
-### Removed
-- Remove dependency on `golang.org/x/{lint, tools}`.
-
-## [1.6.0] - 2020-02-24
-### Changed
-- Drop library dependency on `golang.org/x/{lint, tools}`.
-
-## [1.5.1] - 2019-11-19
-- Fix bug where `Bool.CAS` and `Bool.Toggle` do work correctly together
-  causing `CAS` to fail even though the old value matches.
-
-## [1.5.0] - 2019-10-29
-### Changed
-- With Go modules, only the `go.uber.org/atomic` import path is supported now.
-  If you need to use the old import path, please add a `replace` directive to
-  your `go.mod`.
-
-## [1.4.0] - 2019-05-01
-### Added
- - Add `atomic.Error` type for atomic operations on `error` values.
-
-## [1.3.2] - 2018-05-02
-### Added
-- Add `atomic.Duration` type for atomic operations on `time.Duration` values.
-
-## [1.3.1] - 2017-11-14
-### Fixed
-- Revert optimization for `atomic.String.Store("")` which caused data races.
-
-## [1.3.0] - 2017-11-13
-### Added
-- Add `atomic.Bool.CAS` for compare-and-swap semantics on bools.
-
-### Changed
-- Optimize `atomic.String.Store("")` by avoiding an allocation.
-
-## [1.2.0] - 2017-04-12
-### Added
-- Shadow `atomic.Value` from `sync/atomic`.
-
-## [1.1.0] - 2017-03-10
-### Added
-- Add atomic `Float64` type.
-
-### Changed
-- Support new `go.uber.org/atomic` import path.
-
-## [1.0.0] - 2016-07-18
-
-- Initial release.
-
-[1.7.0]: https://github.com/uber-go/atomic/compare/v1.6.0...v1.7.0
-[1.6.0]: https://github.com/uber-go/atomic/compare/v1.5.1...v1.6.0
-[1.5.1]: https://github.com/uber-go/atomic/compare/v1.5.0...v1.5.1
-[1.5.0]: https://github.com/uber-go/atomic/compare/v1.4.0...v1.5.0
-[1.4.0]: https://github.com/uber-go/atomic/compare/v1.3.2...v1.4.0
-[1.3.2]: https://github.com/uber-go/atomic/compare/v1.3.1...v1.3.2
-[1.3.1]: https://github.com/uber-go/atomic/compare/v1.3.0...v1.3.1
-[1.3.0]: https://github.com/uber-go/atomic/compare/v1.2.0...v1.3.0
-[1.2.0]: https://github.com/uber-go/atomic/compare/v1.1.0...v1.2.0
-[1.1.0]: https://github.com/uber-go/atomic/compare/v1.0.0...v1.1.0
-[1.0.0]: https://github.com/uber-go/atomic/releases/tag/v1.0.0

data/vendor/go.uber.org/atomic/LICENSE.txt

@@ -1,19 +0,0 @@
-Copyright (c) 2016 Uber Technologies, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.