// Copyright (c) 2020 Tailscale Inc & AUTHORS All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. package derp // TODO(crawshaw): send srcKey with packets to clients? // TODO(crawshaw): with predefined serverKey in clients and HMAC on packets we could skip TLS import ( "bufio" "context" crand "crypto/rand" "encoding/json" "errors" "expvar" "fmt" "io" "io/ioutil" "math/big" "net" "os" "strconv" "sync" "time" "golang.org/x/crypto/nacl/box" "golang.org/x/time/rate" "tailscale.com/metrics" "tailscale.com/types/key" "tailscale.com/types/logger" ) var debug, _ = strconv.ParseBool(os.Getenv("DERP_DEBUG_LOGS")) // Server is a DERP server. type Server struct { // BytesPerSecond, if non-zero, specifies how many bytes per // second to cap per-client reads at. BytesPerSecond int privateKey key.Private publicKey key.Public logf logger.Logf // Counters: packetsSent, bytesSent expvar.Int packetsRecv, bytesRecv expvar.Int packetsDropped expvar.Int accepts expvar.Int curClients expvar.Int curHomeClients expvar.Int // ones with preferred unknownFrames expvar.Int mu sync.Mutex closed bool netConns map[net.Conn]chan struct{} // chan is closed when conn closes clients map[key.Public]*sclient clientsEver map[key.Public]bool // never deleted from, for stats; fine for now } // NewServer returns a new DERP server. It doesn't listen on its own. // Connections are given to it via Server.Accept. func NewServer(privateKey key.Private, logf logger.Logf) *Server { s := &Server{ privateKey: privateKey, publicKey: privateKey.Public(), logf: logf, clients: make(map[key.Public]*sclient), clientsEver: make(map[key.Public]bool), netConns: make(map[net.Conn]chan struct{}), } return s } // Close closes the server and waits for the connections to disconnect. func (s *Server) Close() error { s.mu.Lock() wasClosed := s.closed s.closed = true s.mu.Unlock() if wasClosed { return nil } var closedChs []chan struct{} s.mu.Lock() for nc, closed := range s.netConns { nc.Close() closedChs = append(closedChs, closed) } s.mu.Unlock() for _, closed := range closedChs { <-closed } return nil } func (s *Server) isClosed() bool { s.mu.Lock() defer s.mu.Unlock() return s.closed } // Accept adds a new connection to the server and serves it. // // The provided bufio ReadWriter must be already connected to nc. // Accept blocks until the Server is closed or the connection closes // on its own. // // Accept closes nc. func (s *Server) Accept(nc net.Conn, brw *bufio.ReadWriter) { closed := make(chan struct{}) s.accepts.Add(1) s.mu.Lock() s.netConns[nc] = closed s.mu.Unlock() defer func() { nc.Close() close(closed) s.mu.Lock() delete(s.netConns, nc) s.mu.Unlock() }() if err := s.accept(nc, brw); err != nil && !s.isClosed() { s.logf("derp: %s: %v", nc.RemoteAddr(), err) } } // registerClient notes that client c is now authenticated and ready for packets. // If c's public key was already connected with a different connection, the prior one is closed. func (s *Server) registerClient(c *sclient) { s.mu.Lock() defer s.mu.Unlock() old := s.clients[c.key] if old == nil { c.logf("adding connection") } else { old.nc.Close() c.logf("adding connection, replacing %s", old.nc.RemoteAddr()) } s.clients[c.key] = c s.clientsEver[c.key] = true s.curClients.Add(1) } // unregisterClient removes a client from the server. func (s *Server) unregisterClient(c *sclient) { s.mu.Lock() defer s.mu.Unlock() cur := s.clients[c.key] if cur == c { c.logf("removing connection") delete(s.clients, c.key) } s.curClients.Add(-1) if c.preferred { s.curHomeClients.Add(-1) } } func (s *Server) accept(nc net.Conn, brw *bufio.ReadWriter) error { br, bw := brw.Reader, brw.Writer nc.SetDeadline(time.Now().Add(10 * time.Second)) if err := s.sendServerKey(bw); err != nil { return fmt.Errorf("send server key: %v", err) } nc.SetDeadline(time.Now().Add(10 * time.Second)) clientKey, clientInfo, err := s.recvClientKey(br) if err != nil { return fmt.Errorf("receive client key: %v", err) } if err := s.verifyClient(clientKey, clientInfo); err != nil { return fmt.Errorf("client %x rejected: %v", clientKey, err) } lim := rate.Inf if s.BytesPerSecond != 0 { lim = rate.Limit(s.BytesPerSecond) } const burstBytes = 1 << 20 // generous bandwidth delay product? must be over 64k max packet size. limiter := rate.NewLimiter(lim, burstBytes) // At this point we trust the client so we don't time out. nc.SetDeadline(time.Time{}) c := &sclient{ s: s, key: clientKey, nc: nc, br: br, bw: bw, limiter: limiter, logf: logger.WithPrefix(s.logf, fmt.Sprintf("derp client %v/%x: ", nc.RemoteAddr(), clientKey)), } if clientInfo != nil { c.info = *clientInfo } // Once the client is registered, it can start receiving // traffic, but we want to make sure the first thing it // receives after its frameClientInfo is our frameServerInfo, // so acquire the c.mu lock (which guards writing to c.bw) // while we register. c.mu.Lock() s.registerClient(c) err = s.sendServerInfo(bw, clientKey) c.mu.Unlock() if err != nil { return fmt.Errorf("send server info: %v", err) } defer s.unregisterClient(c) return c.run() } func (c *sclient) run() error { s := c.s ctx, cancel := context.WithCancel(context.Background()) defer cancel() go s.sendClientKeepAlives(ctx, c) for { ft, fl, err := readFrameHeader(c.br) if err != nil { return fmt.Errorf("client %x: readFrameHeader: %v", c.key, err) } switch ft { case frameNotePreferred: err = c.handleFrameNotePreferred(ft, fl) case frameSendPacket: err = c.handleFrameSendPacket(ctx, ft, fl) default: err = c.handleUnknownFrame(ctx, ft, fl) } if err != nil { return err } } } func (c *sclient) handleUnknownFrame(ctx context.Context, ft frameType, fl uint32) error { if err := c.limiter.WaitN(ctx, int(fl)); err != nil { return fmt.Errorf("rate limit: %v", err) } _, err := io.CopyN(ioutil.Discard, c.br, int64(fl)) return err } func (c *sclient) handleFrameNotePreferred(ft frameType, fl uint32) error { if fl != 1 { return fmt.Errorf("frameNotePreferred wrong size") } v, err := c.br.ReadByte() if err != nil { return fmt.Errorf("frameNotePreferred ReadByte: %v", err) } c.setPreferred(v != 0) return nil } func (c *sclient) handleFrameSendPacket(ctx context.Context, ft frameType, fl uint32) error { s := c.s dstKey, contents, err := s.recvPacket(ctx, c.br, fl, c.limiter) if err != nil { return fmt.Errorf("client %x: recvPacket: %v", c.key, err) } s.mu.Lock() dst := s.clients[dstKey] s.mu.Unlock() if dst == nil { s.packetsDropped.Add(1) if debug { c.logf("dropping packet for unknown %x", dstKey) } return nil } dst.mu.Lock() err = s.sendPacket(dst.bw, &dst.info, c.key, contents) dst.mu.Unlock() if err != nil { c.logf("write error sending packet to %x: %v", dstKey, err) // If we cannot send to a destination, shut it down. // Let its receive loop do the cleanup. s.mu.Lock() if s.clients[dstKey] == dst { s.clients[dstKey].nc.Close() } s.mu.Unlock() } return err } func (s *Server) sendClientKeepAlives(ctx context.Context, c *sclient) { if err := c.keepAliveLoop(ctx); err != nil { c.logf("keep alive failed: %v", err) } } func (s *Server) verifyClient(clientKey key.Public, info *clientInfo) error { // TODO(crawshaw): implement policy constraints on who can use the DERP server // TODO(bradfitz): ... and at what rate. return nil } func (s *Server) sendServerKey(bw *bufio.Writer) error { buf := make([]byte, 0, len(magic)+len(s.publicKey)) buf = append(buf, magic...) buf = append(buf, s.publicKey[:]...) return writeFrame(bw, frameServerKey, buf) } type serverInfo struct { Version int // `json:"version,omitempty"` } func (s *Server) sendServerInfo(bw *bufio.Writer, clientKey key.Public) error { var nonce [24]byte if _, err := crand.Read(nonce[:]); err != nil { return err } msg, err := json.Marshal(serverInfo{Version: protocolVersion}) if err != nil { return err } msgbox := box.Seal(nil, msg, &nonce, clientKey.B32(), s.privateKey.B32()) if err := writeFrameHeader(bw, frameServerInfo, nonceLen+uint32(len(msgbox))); err != nil { return err } if _, err := bw.Write(nonce[:]); err != nil { return err } if _, err := bw.Write(msgbox); err != nil { return err } return bw.Flush() } // recvClientKey reads the frameClientInfo frame from the client (its // proof of identity) upon its initial connection. It should be // considered especially untrusted at this point. func (s *Server) recvClientKey(br *bufio.Reader) (clientKey key.Public, info *clientInfo, err error) { fl, err := readFrameTypeHeader(br, frameClientInfo) if err != nil { return key.Public{}, nil, err } const minLen = keyLen + nonceLen if fl < minLen { return key.Public{}, nil, errors.New("short client info") } // We don't trust the client at all yet, so limit its input size to limit // things like JSON resource exhausting (http://github.com/golang/go/issues/31789). if fl > 256<<10 { return key.Public{}, nil, errors.New("long client info") } if _, err := io.ReadFull(br, clientKey[:]); err != nil { return key.Public{}, nil, err } var nonce [24]byte if _, err := io.ReadFull(br, nonce[:]); err != nil { return key.Public{}, nil, fmt.Errorf("nonce: %v", err) } msgLen := int(fl - minLen) msgbox := make([]byte, msgLen) if _, err := io.ReadFull(br, msgbox); err != nil { return key.Public{}, nil, fmt.Errorf("msgbox: %v", err) } msg, ok := box.Open(nil, msgbox, &nonce, (*[32]byte)(&clientKey), s.privateKey.B32()) if !ok { return key.Public{}, nil, fmt.Errorf("msgbox: cannot open len=%d with client key %x", msgLen, clientKey[:]) } info = new(clientInfo) if err := json.Unmarshal(msg, info); err != nil { return key.Public{}, nil, fmt.Errorf("msg: %v", err) } return clientKey, info, nil } func (s *Server) sendPacket(bw *bufio.Writer, dstInfo *clientInfo, srcKey key.Public, contents []byte) error { s.packetsSent.Add(1) s.bytesSent.Add(int64(len(contents))) sendSrc := dstInfo.Version >= protocolSrcAddrs pktLen := len(contents) if sendSrc { pktLen += len(srcKey) } if err := writeFrameHeader(bw, frameRecvPacket, uint32(pktLen)); err != nil { return err } if sendSrc { if _, err := bw.Write(srcKey[:]); err != nil { return err } } if _, err := bw.Write(contents); err != nil { return err } return bw.Flush() } func (s *Server) recvPacket(ctx context.Context, br *bufio.Reader, frameLen uint32, limiter *rate.Limiter) (dstKey key.Public, contents []byte, err error) { if frameLen < keyLen { return key.Public{}, nil, errors.New("short send packet frame") } if _, err := io.ReadFull(br, dstKey[:]); err != nil { return key.Public{}, nil, err } packetLen := frameLen - keyLen if packetLen > MaxPacketSize { return key.Public{}, nil, fmt.Errorf("data packet longer (%d) than max of %v", packetLen, MaxPacketSize) } if err := limiter.WaitN(ctx, int(packetLen)); err != nil { return key.Public{}, nil, fmt.Errorf("rate limit: %v", err) } contents = make([]byte, packetLen) if _, err := io.ReadFull(br, contents); err != nil { return key.Public{}, nil, err } s.packetsRecv.Add(1) s.bytesRecv.Add(int64(len(contents))) return dstKey, contents, nil } // sclient is a client connection to the server. // // (The "s" prefix is to more explicitly distinguish it from Client in derp_client.go) type sclient struct { s *Server nc net.Conn key key.Public info clientInfo logf logger.Logf limiter *rate.Limiter keepAliveTimer *time.Timer keepAliveReset chan struct{} preferred bool mu sync.Mutex // mu guards writing to bw br *bufio.Reader bw *bufio.Writer } func (c *sclient) setPreferred(v bool) { if c.preferred == v { return } c.preferred = v if v { c.s.curHomeClients.Add(1) } else { c.s.curHomeClients.Add(-1) } } func (c *sclient) keepAliveLoop(ctx context.Context) error { jitterMs, err := crand.Int(crand.Reader, big.NewInt(5000)) if err != nil { panic(err) } jitter := time.Duration(jitterMs.Int64()) * time.Millisecond c.keepAliveTimer = time.NewTimer(keepAlive + jitter) defer c.keepAliveTimer.Stop() for { select { case <-ctx.Done(): return nil case <-c.keepAliveReset: if c.keepAliveTimer.Stop() { <-c.keepAliveTimer.C } c.keepAliveTimer.Reset(keepAlive + jitter) case <-c.keepAliveTimer.C: c.mu.Lock() err := writeFrame(c.bw, frameKeepAlive, nil) if err == nil { err = c.bw.Flush() } c.mu.Unlock() if err != nil { c.nc.Close() return err } } } } func (s *Server) expVarFunc(f func() interface{}) expvar.Func { return expvar.Func(func() interface{} { s.mu.Lock() defer s.mu.Unlock() return f() }) } // ExpVar returns an expvar variable suitable for registering with expvar.Publish. func (s *Server) ExpVar() expvar.Var { m := new(metrics.Set) m.Set("counter_unique_clients_ever", s.expVarFunc(func() interface{} { return len(s.clientsEver) })) m.Set("gauge_current_connnections", &s.curClients) m.Set("gauge_current_home_connnections", &s.curHomeClients) m.Set("accepts", &s.accepts) m.Set("bytes_received", &s.bytesRecv) m.Set("bytes_sent", &s.bytesSent) m.Set("packets_dropped", &s.packetsDropped) m.Set("packets_sent", &s.packetsSent) m.Set("packets_received", &s.packetsRecv) m.Set("unknown_frames", &s.unknownFrames) return m }