server.go 22.9 KB
Newer Older
1
// Copyright 2014 The go-ethereum Authors
2
// This file is part of the go-ethereum library.
3
//
4
// The go-ethereum library is free software: you can redistribute it and/or modify
5 6 7 8
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
9
// The go-ethereum library is distributed in the hope that it will be useful,
10
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 13 14
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
15
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
16

17
// Package p2p implements the Ethereum p2p network protocols.
zelig's avatar
zelig committed
18 19 20
package p2p

import (
21
	"crypto/ecdsa"
22
	"errors"
zelig's avatar
zelig committed
23 24 25 26 27
	"fmt"
	"net"
	"sync"
	"time"

28
	"github.com/ethereum/go-ethereum/logger"
obscuren's avatar
obscuren committed
29
	"github.com/ethereum/go-ethereum/logger/glog"
30
	"github.com/ethereum/go-ethereum/p2p/discover"
31
	"github.com/ethereum/go-ethereum/p2p/discv5"
32
	"github.com/ethereum/go-ethereum/p2p/nat"
zelig's avatar
zelig committed
33 34 35
)

const (
36
	defaultDialTimeout      = 15 * time.Second
37 38
	refreshPeersInterval    = 30 * time.Second
	staticPeerCheckInterval = 15 * time.Second
39

40
	// Maximum number of concurrently handshaking inbound connections.
41
	maxAcceptConns = 50
42

43
	// Maximum number of concurrently dialing outbound connections.
44
	maxActiveDialTasks = 16
45

46 47 48 49 50
	// Maximum time allowed for reading a complete message.
	// This is effectively the amount of time a connection can be idle.
	frameReadTimeout = 30 * time.Second

	// Maximum amount of time allowed for writing a complete message.
51
	frameWriteTimeout = 20 * time.Second
zelig's avatar
zelig committed
52 53
)

54 55
var errServerStopped = errors.New("server stopped")

56
var srvjslog = logger.NewJsonLogger()
zelig's avatar
zelig committed
57

58 59
// Config holds Server options.
type Config struct {
60 61
	// This field must be set to a valid secp256k1 private key.
	PrivateKey *ecdsa.PrivateKey
62 63 64 65 66

	// MaxPeers is the maximum number of peers that can be
	// connected. It must be greater than zero.
	MaxPeers int

67 68 69 70 71
	// MaxPendingPeers is the maximum number of peers that can be pending in the
	// handshake phase, counted separately for inbound and outbound connections.
	// Zero defaults to preset values.
	MaxPendingPeers int

72 73 74 75
	// Discovery specifies whether the peer discovery mechanism should be started
	// or not. Disabling is usually useful for protocol debugging (manual topology).
	Discovery bool

76 77
	DiscoveryV5 bool

78
	// Name sets the node name of this server.
obscuren's avatar
obscuren committed
79
	// Use common.MakeName to create a name that follows existing conventions.
80 81 82 83
	Name string

	// Bootstrap nodes are used to establish connectivity
	// with the rest of the network.
84
	BootstrapNodes []*discover.Node
85

86 87 88
	// Static nodes are used as pre-configured connections which are always
	// maintained and re-connected on disconnects.
	StaticNodes []*discover.Node
89

90 91 92 93
	// Trusted nodes are used as pre-configured connections which are always
	// allowed to connect, even above the peer limit.
	TrustedNodes []*discover.Node

94 95 96
	// NodeDatabase is the path to the database containing the previously seen
	// live nodes in the network.
	NodeDatabase string
97

98 99 100 101 102 103 104 105 106 107 108 109 110
	// Protocols should contain the protocols supported
	// by the server. Matching protocols are launched for
	// each peer.
	Protocols []Protocol

	// If ListenAddr is set to a non-nil address, the server
	// will listen for incoming connections.
	//
	// If the port is zero, the operating system will pick a port. The
	// ListenAddr field will be updated with the actual address when
	// the server is started.
	ListenAddr string

111 112
	ListenAddrV5 string

113 114 115
	// If set to a non-nil value, the given NAT port mapper
	// is used to make the listening port available to the
	// Internet.
116
	NAT nat.Interface
117 118 119 120 121 122 123

	// If Dialer is set to a non-nil value, the given Dialer
	// is used to dial outbound peer connections.
	Dialer *net.Dialer

	// If NoDial is true, the server will not dial any peers.
	NoDial bool
124 125 126 127 128 129
}

// Server manages all peer connections.
type Server struct {
	// Config fields may not be modified while the server is running.
	Config
130

131
	// Hooks for testing. These are useful because we can inhibit
132
	// the whole protocol stack.
133 134 135 136 137
	newTransport func(net.Conn) transport
	newPeerHook  func(*Peer)

	lock    sync.Mutex // protects running
	running bool
zelig's avatar
zelig committed
138

139 140
	ntab         discoverTable
	listener     net.Listener
141
	ourHandshake *protoHandshake
142
	lastLookup   time.Time
143
	DiscV5       *discv5.Network
144

145 146 147 148 149 150
	// These are for Peers, PeerCount (and nothing else).
	peerOp     chan peerOpFunc
	peerOpDone chan struct{}

	quit          chan struct{}
	addstatic     chan *discover.Node
151
	removestatic  chan *discover.Node
152 153 154 155 156 157 158 159 160
	posthandshake chan *conn
	addpeer       chan *conn
	delpeer       chan *Peer
	loopWG        sync.WaitGroup // loop, listenLoop
}

type peerOpFunc func(map[discover.NodeID]*Peer)

type connFlag int
161

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
const (
	dynDialedConn connFlag = 1 << iota
	staticDialedConn
	inboundConn
	trustedConn
)

// conn wraps a network connection with information gathered
// during the two handshakes.
type conn struct {
	fd net.Conn
	transport
	flags connFlag
	cont  chan error      // The run loop uses cont to signal errors to setupConn.
	id    discover.NodeID // valid after the encryption handshake
	caps  []Cap           // valid after the protocol handshake
	name  string          // valid after the protocol handshake
}
180

181 182 183 184 185 186 187 188 189 190 191 192
type transport interface {
	// The two handshakes.
	doEncHandshake(prv *ecdsa.PrivateKey, dialDest *discover.Node) (discover.NodeID, error)
	doProtoHandshake(our *protoHandshake) (*protoHandshake, error)
	// The MsgReadWriter can only be used after the encryption
	// handshake has completed. The code uses conn.id to track this
	// by setting it to a non-nil value after the encryption handshake.
	MsgReadWriter
	// transports must provide Close because we use MsgPipe in some of
	// the tests. Closing the actual network connection doesn't do
	// anything in those tests because NsgPipe doesn't use it.
	close(err error)
zelig's avatar
zelig committed
193 194
}

195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
func (c *conn) String() string {
	s := c.flags.String() + " conn"
	if (c.id != discover.NodeID{}) {
		s += fmt.Sprintf(" %x", c.id[:8])
	}
	s += " " + c.fd.RemoteAddr().String()
	return s
}

func (f connFlag) String() string {
	s := ""
	if f&trustedConn != 0 {
		s += " trusted"
	}
	if f&dynDialedConn != 0 {
		s += " dyn dial"
	}
	if f&staticDialedConn != 0 {
		s += " static dial"
	}
	if f&inboundConn != 0 {
		s += " inbound"
	}
	if s != "" {
		s = s[1:]
	}
	return s
}

func (c *conn) is(f connFlag) bool {
	return c.flags&f != 0
}
zelig's avatar
zelig committed
227

228
// Peers returns all connected peers.
229 230 231 232 233 234 235 236 237
func (srv *Server) Peers() []*Peer {
	var ps []*Peer
	select {
	// Note: We'd love to put this function into a variable but
	// that seems to cause a weird compiler error in some
	// environments.
	case srv.peerOp <- func(peers map[discover.NodeID]*Peer) {
		for _, p := range peers {
			ps = append(ps, p)
zelig's avatar
zelig committed
238
		}
239 240 241
	}:
		<-srv.peerOpDone
	case <-srv.quit:
zelig's avatar
zelig committed
242
	}
243
	return ps
zelig's avatar
zelig committed
244 245
}

246 247
// PeerCount returns the number of connected peers.
func (srv *Server) PeerCount() int {
248 249 250 251 252 253 254
	var count int
	select {
	case srv.peerOp <- func(ps map[discover.NodeID]*Peer) { count = len(ps) }:
		<-srv.peerOpDone
	case <-srv.quit:
	}
	return count
zelig's avatar
zelig committed
255 256
}

257 258 259 260
// AddPeer connects to the given node and maintains the connection until the
// server is shut down. If the connection fails for any reason, the server will
// attempt to reconnect the peer.
func (srv *Server) AddPeer(node *discover.Node) {
261 262 263 264 265 266
	select {
	case srv.addstatic <- node:
	case <-srv.quit:
	}
}

267 268 269 270 271 272 273 274
// RemovePeer disconnects from the given node
func (srv *Server) RemovePeer(node *discover.Node) {
	select {
	case srv.removestatic <- node:
	case <-srv.quit:
	}
}

275 276
// Self returns the local node's endpoint information.
func (srv *Server) Self() *discover.Node {
277 278
	srv.lock.Lock()
	defer srv.lock.Unlock()
279 280

	// If the server's not running, return an empty node
281 282 283
	if !srv.running {
		return &discover.Node{IP: net.ParseIP("0.0.0.0")}
	}
284
	// If the node is running but discovery is off, manually assemble the node infos
285
	if srv.ntab == nil {
286 287 288 289 290
		// Inbound connections disabled, use zero address
		if srv.listener == nil {
			return &discover.Node{IP: net.ParseIP("0.0.0.0"), ID: discover.PubkeyID(&srv.PrivateKey.PublicKey)}
		}
		// Otherwise inject the listener address too
291 292 293 294 295 296 297
		addr := srv.listener.Addr().(*net.TCPAddr)
		return &discover.Node{
			ID:  discover.PubkeyID(&srv.PrivateKey.PublicKey),
			IP:  addr.IP,
			TCP: uint16(addr.Port),
		}
	}
298
	// Otherwise return the live node infos
299 300
	return srv.ntab.Self()
}
301

302 303 304 305 306 307 308 309 310 311 312 313 314 315 316
// Stop terminates the server and all active peer connections.
// It blocks until all active connections have been closed.
func (srv *Server) Stop() {
	srv.lock.Lock()
	defer srv.lock.Unlock()
	if !srv.running {
		return
	}
	srv.running = false
	if srv.listener != nil {
		// this unblocks listener Accept
		srv.listener.Close()
	}
	close(srv.quit)
	srv.loopWG.Wait()
zelig's avatar
zelig committed
317 318
}

319
// Start starts running the server.
320
// Servers can not be re-used after stopping.
321 322 323 324 325 326
func (srv *Server) Start() (err error) {
	srv.lock.Lock()
	defer srv.lock.Unlock()
	if srv.running {
		return errors.New("server already running")
	}
327
	srv.running = true
obscuren's avatar
obscuren committed
328
	glog.V(logger.Info).Infoln("Starting Server")
329

330
	// static fields
331 332
	if srv.PrivateKey == nil {
		return fmt.Errorf("Server.PrivateKey must be set to a non-nil key")
zelig's avatar
zelig committed
333
	}
334 335
	if srv.newTransport == nil {
		srv.newTransport = newRLPX
336
	}
337 338
	if srv.Dialer == nil {
		srv.Dialer = &net.Dialer{Timeout: defaultDialTimeout}
339
	}
340 341 342 343 344
	srv.quit = make(chan struct{})
	srv.addpeer = make(chan *conn)
	srv.delpeer = make(chan *Peer)
	srv.posthandshake = make(chan *conn)
	srv.addstatic = make(chan *discover.Node)
345
	srv.removestatic = make(chan *discover.Node)
346 347
	srv.peerOp = make(chan peerOpFunc)
	srv.peerOpDone = make(chan struct{})
348

349
	// node table
350 351 352 353 354
	if srv.Discovery {
		ntab, err := discover.ListenUDP(srv.PrivateKey, srv.ListenAddr, srv.NAT, srv.NodeDatabase)
		if err != nil {
			return err
		}
355 356 357
		if err := ntab.SetFallbackNodes(srv.BootstrapNodes); err != nil {
			return err
		}
358
		srv.ntab = ntab
359
	}
360

361 362 363 364 365 366 367 368 369 370 371
	if srv.DiscoveryV5 {
		ntab, err := discv5.ListenUDP(srv.PrivateKey, srv.ListenAddrV5, srv.NAT, "") //srv.NodeDatabase)
		if err != nil {
			return err
		}
		if err := ntab.SetFallbackNodes(discv5.BootNodes); err != nil {
			return err
		}
		srv.DiscV5 = ntab
	}

372
	dynPeers := (srv.MaxPeers + 1) / 2
373 374 375 376
	if !srv.Discovery {
		dynPeers = 0
	}
	dialer := newDialState(srv.StaticNodes, srv.ntab, dynPeers)
377

378
	// handshake
379
	srv.ourHandshake = &protoHandshake{Version: baseProtocolVersion, Name: srv.Name, ID: discover.PubkeyID(&srv.PrivateKey.PublicKey)}
380 381 382
	for _, p := range srv.Protocols {
		srv.ourHandshake.Caps = append(srv.ourHandshake.Caps, p.cap())
	}
383 384 385 386 387 388
	// listen/dial
	if srv.ListenAddr != "" {
		if err := srv.startListening(); err != nil {
			return err
		}
	}
389
	if srv.NoDial && srv.ListenAddr == "" {
obscuren's avatar
obscuren committed
390
		glog.V(logger.Warn).Infoln("I will be kind-of useless, neither dialing nor listening.")
391 392
	}

393 394
	srv.loopWG.Add(1)
	go srv.run(dialer)
395 396
	srv.running = true
	return nil
zelig's avatar
zelig committed
397 398
}

399
func (srv *Server) startListening() error {
400
	// Launch the TCP listener.
401 402 403 404
	listener, err := net.Listen("tcp", srv.ListenAddr)
	if err != nil {
		return err
	}
405 406
	laddr := listener.Addr().(*net.TCPAddr)
	srv.ListenAddr = laddr.String()
407
	srv.listener = listener
408
	srv.loopWG.Add(1)
409
	go srv.listenLoop()
410
	// Map the TCP listening port if NAT is configured.
411
	if !laddr.IP.IsLoopback() && srv.NAT != nil {
412
		srv.loopWG.Add(1)
413 414 415 416
		go func() {
			nat.Map(srv.NAT, srv.quit, "tcp", laddr.Port, laddr.Port, "ethereum p2p")
			srv.loopWG.Done()
		}()
417 418 419 420
	}
	return nil
}

421 422 423 424
type dialer interface {
	newTasks(running int, peers map[discover.NodeID]*Peer, now time.Time) []task
	taskDone(task, time.Time)
	addStatic(*discover.Node)
425
	removeStatic(*discover.Node)
426 427 428 429 430
}

func (srv *Server) run(dialstate dialer) {
	defer srv.loopWG.Done()
	var (
431 432
		peers        = make(map[discover.NodeID]*Peer)
		trusted      = make(map[discover.NodeID]bool, len(srv.TrustedNodes))
433
		taskdone     = make(chan task, maxActiveDialTasks)
434 435
		runningTasks []task
		queuedTasks  []task // tasks that can't run yet
436 437 438 439 440 441 442 443
	)
	// Put trusted nodes into a map to speed up checks.
	// Trusted peers are loaded on startup and cannot be
	// modified while the server is running.
	for _, n := range srv.TrustedNodes {
		trusted[n.ID] = true
	}

444
	// removes t from runningTasks
445
	delTask := func(t task) {
446 447 448
		for i := range runningTasks {
			if runningTasks[i] == t {
				runningTasks = append(runningTasks[:i], runningTasks[i+1:]...)
449 450 451
				break
			}
		}
zelig's avatar
zelig committed
452
	}
453 454 455 456 457 458 459 460
	// starts until max number of active tasks is satisfied
	startTasks := func(ts []task) (rest []task) {
		i := 0
		for ; len(runningTasks) < maxActiveDialTasks && i < len(ts); i++ {
			t := ts[i]
			glog.V(logger.Detail).Infoln("new task:", t)
			go func() { t.Do(srv); taskdone <- t }()
			runningTasks = append(runningTasks, t)
461
		}
462 463 464 465 466 467 468 469 470
		return ts[i:]
	}
	scheduleTasks := func() {
		// Start from queue first.
		queuedTasks = append(queuedTasks[:0], startTasks(queuedTasks)...)
		// Query dialer for new tasks and start as many as possible now.
		if len(runningTasks) < maxActiveDialTasks {
			nt := dialstate.newTasks(len(runningTasks)+len(queuedTasks), peers, time.Now())
			queuedTasks = append(queuedTasks, startTasks(nt)...)
471 472 473 474 475
		}
	}

running:
	for {
476
		scheduleTasks()
477

478 479 480 481 482 483 484 485 486 487 488
		select {
		case <-srv.quit:
			// The server was stopped. Run the cleanup logic.
			glog.V(logger.Detail).Infoln("<-quit: spinning down")
			break running
		case n := <-srv.addstatic:
			// This channel is used by AddPeer to add to the
			// ephemeral static peer list. Add it to the dialer,
			// it will keep the node connected.
			glog.V(logger.Detail).Infoln("<-addstatic:", n)
			dialstate.addStatic(n)
489 490 491 492 493 494 495 496 497
		case n := <-srv.removestatic:
			// This channel is used by RemovePeer to send a
			// disconnect request to a peer and begin the
			// stop keeping the node connected
			glog.V(logger.Detail).Infoln("<-removestatic:", n)
			dialstate.removeStatic(n)
			if p, ok := peers[n.ID]; ok {
				p.Disconnect(DiscRequested)
			}
498 499 500 501 502 503 504 505 506
		case op := <-srv.peerOp:
			// This channel is used by Peers and PeerCount.
			op(peers)
			srv.peerOpDone <- struct{}{}
		case t := <-taskdone:
			// A task got done. Tell dialstate about it so it
			// can update its state and remove it from the active
			// tasks list.
			glog.V(logger.Detail).Infoln("<-taskdone:", t)
507
			dialstate.taskDone(t, time.Now())
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
			delTask(t)
		case c := <-srv.posthandshake:
			// A connection has passed the encryption handshake so
			// the remote identity is known (but hasn't been verified yet).
			if trusted[c.id] {
				// Ensure that the trusted flag is set before checking against MaxPeers.
				c.flags |= trustedConn
			}
			glog.V(logger.Detail).Infoln("<-posthandshake:", c)
			// TODO: track in-progress inbound node IDs (pre-Peer) to avoid dialing them.
			c.cont <- srv.encHandshakeChecks(peers, c)
		case c := <-srv.addpeer:
			// At this point the connection is past the protocol handshake.
			// Its capabilities are known and the remote identity is verified.
			glog.V(logger.Detail).Infoln("<-addpeer:", c)
			err := srv.protoHandshakeChecks(peers, c)
			if err != nil {
				glog.V(logger.Detail).Infof("Not adding %v as peer: %v", c, err)
			} else {
				// The handshakes are done and it passed all checks.
				p := newPeer(c, srv.Protocols)
				peers[c.id] = p
				go srv.runPeer(p)
			}
			// The dialer logic relies on the assumption that
			// dial tasks complete after the peer has been added or
			// discarded. Unblock the task last.
			c.cont <- err
		case p := <-srv.delpeer:
			// A peer disconnected.
			glog.V(logger.Detail).Infoln("<-delpeer:", p)
			delete(peers, p.ID())
		}
	}

	// Terminate discovery. If there is a running lookup it will terminate soon.
544 545 546
	if srv.ntab != nil {
		srv.ntab.Close()
	}
547 548 549
	if srv.DiscV5 != nil {
		srv.DiscV5.Close()
	}
550 551 552 553 554 555 556
	// Disconnect all peers.
	for _, p := range peers {
		p.Disconnect(DiscQuitting)
	}
	// Wait for peers to shut down. Pending connections and tasks are
	// not handled here and will terminate soon-ish because srv.quit
	// is closed.
557
	glog.V(logger.Detail).Infof("ignoring %d pending tasks at spindown", len(runningTasks))
558 559 560 561
	for len(peers) > 0 {
		p := <-srv.delpeer
		glog.V(logger.Detail).Infoln("<-delpeer (spindown):", p)
		delete(peers, p.ID())
562
	}
563
}
564

565 566 567 568
func (srv *Server) protoHandshakeChecks(peers map[discover.NodeID]*Peer, c *conn) error {
	// Drop connections with no matching protocols.
	if len(srv.Protocols) > 0 && countMatchingProtocols(srv.Protocols, c.caps) == 0 {
		return DiscUselessPeer
569
	}
570 571 572
	// Repeat the encryption handshake checks because the
	// peer set might have changed between the handshakes.
	return srv.encHandshakeChecks(peers, c)
573
}
zelig's avatar
zelig committed
574

575 576 577 578 579 580
func (srv *Server) encHandshakeChecks(peers map[discover.NodeID]*Peer, c *conn) error {
	switch {
	case !c.is(trustedConn|staticDialedConn) && len(peers) >= srv.MaxPeers:
		return DiscTooManyPeers
	case peers[c.id] != nil:
		return DiscAlreadyConnected
581
	case c.id == srv.Self().ID:
582 583 584
		return DiscSelf
	default:
		return nil
585
	}
586 587
}

588 589 590 591
type tempError interface {
	Temporary() bool
}

592 593
// listenLoop runs in its own goroutine and accepts
// inbound connections.
594
func (srv *Server) listenLoop() {
595
	defer srv.loopWG.Done()
596
	glog.V(logger.Info).Infoln("Listening on", srv.listener.Addr())
597 598 599 600

	// This channel acts as a semaphore limiting
	// active inbound connections that are lingering pre-handshake.
	// If all slots are taken, no further connections are accepted.
601 602 603 604 605 606
	tokens := maxAcceptConns
	if srv.MaxPendingPeers > 0 {
		tokens = srv.MaxPendingPeers
	}
	slots := make(chan struct{}, tokens)
	for i := 0; i < tokens; i++ {
607 608 609
		slots <- struct{}{}
	}

zelig's avatar
zelig committed
610
	for {
611
		// Wait for a handshake slot before accepting.
612
		<-slots
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627

		var (
			fd  net.Conn
			err error
		)
		for {
			fd, err = srv.listener.Accept()
			if tempErr, ok := err.(tempError); ok && tempErr.Temporary() {
				glog.V(logger.Debug).Infof("Temporary read error: %v", err)
				continue
			} else if err != nil {
				glog.V(logger.Debug).Infof("Read error: %v", err)
				return
			}
			break
zelig's avatar
zelig committed
628
		}
629 630
		fd = newMeteredConn(fd, true)
		glog.V(logger.Debug).Infof("Accepted conn %v\n", fd.RemoteAddr())
631

632 633
		// Spawn the handler. It will give the slot back when the connection
		// has been established.
634
		go func() {
635
			srv.setupConn(fd, inboundConn, nil)
636 637
			slots <- struct{}{}
		}()
zelig's avatar
zelig committed
638 639 640
	}
}

641 642 643 644 645 646 647 648 649 650 651 652
// setupConn runs the handshakes and attempts to add the connection
// as a peer. It returns when the connection has been added as a peer
// or the handshakes have failed.
func (srv *Server) setupConn(fd net.Conn, flags connFlag, dialDest *discover.Node) {
	// Prevent leftover pending conns from entering the handshake.
	srv.lock.Lock()
	running := srv.running
	srv.lock.Unlock()
	c := &conn{fd: fd, transport: srv.newTransport(fd), flags: flags, cont: make(chan error)}
	if !running {
		c.close(errServerStopped)
		return
653
	}
654 655 656 657 658 659
	// Run the encryption handshake.
	var err error
	if c.id, err = c.doEncHandshake(srv.PrivateKey, dialDest); err != nil {
		glog.V(logger.Debug).Infof("%v faild enc handshake: %v", c, err)
		c.close(err)
		return
660
	}
661 662 663 664 665
	// For dialed connections, check that the remote public key matches.
	if dialDest != nil && c.id != dialDest.ID {
		c.close(DiscUnexpectedIdentity)
		glog.V(logger.Debug).Infof("%v dialed identity mismatch, want %x", c, dialDest.ID[:8])
		return
zelig's avatar
zelig committed
666
	}
667 668 669
	if err := srv.checkpoint(c, srv.posthandshake); err != nil {
		glog.V(logger.Debug).Infof("%v failed checkpoint posthandshake: %v", c, err)
		c.close(err)
Felix Lange's avatar
Felix Lange committed
670
		return
zelig's avatar
zelig committed
671
	}
672 673
	// Run the protocol handshake
	phs, err := c.doProtoHandshake(srv.ourHandshake)
674
	if err != nil {
675 676
		glog.V(logger.Debug).Infof("%v failed proto handshake: %v", c, err)
		c.close(err)
677 678
		return
	}
679 680 681 682
	if phs.ID != c.id {
		glog.V(logger.Debug).Infof("%v wrong proto handshake identity: %x", c, phs.ID[:8])
		c.close(DiscUnexpectedIdentity)
		return
683
	}
684 685 686 687
	c.caps, c.name = phs.Caps, phs.Name
	if err := srv.checkpoint(c, srv.addpeer); err != nil {
		glog.V(logger.Debug).Infof("%v failed checkpoint addpeer: %v", c, err)
		c.close(err)
688
		return
zelig's avatar
zelig committed
689
	}
690 691
	// If the checks completed successfully, runPeer has now been
	// launched by run.
692
}
693

694 695 696 697 698 699 700
// checkpoint sends the conn to run, which performs the
// post-handshake checks for the stage (posthandshake, addpeer).
func (srv *Server) checkpoint(c *conn, stage chan<- *conn) error {
	select {
	case stage <- c:
	case <-srv.quit:
		return errServerStopped
701
	}
702 703 704 705 706
	select {
	case err := <-c.cont:
		return err
	case <-srv.quit:
		return errServerStopped
707 708 709
	}
}

710 711 712
// runPeer runs in its own goroutine for each peer.
// it waits until the Peer logic returns and removes
// the peer.
713
func (srv *Server) runPeer(p *Peer) {
obscuren's avatar
obscuren committed
714
	glog.V(logger.Debug).Infof("Added %v\n", p)
715
	srvjslog.LogJson(&logger.P2PConnected{
716 717 718
		RemoteId:            p.ID().String(),
		RemoteAddress:       p.RemoteAddr().String(),
		RemoteVersionString: p.Name(),
719 720
		NumConnections:      srv.PeerCount(),
	})
721

722 723 724
	if srv.newPeerHook != nil {
		srv.newPeerHook(p)
	}
725
	discreason := p.run()
726 727 728 729
	// Note: run waits for existing peers to be sent on srv.delpeer
	// before returning, so this send should not select on srv.quit.
	srv.delpeer <- p

obscuren's avatar
obscuren committed
730
	glog.V(logger.Debug).Infof("Removed %v (%v)\n", p, discreason)
731
	srvjslog.LogJson(&logger.P2PDisconnected{
732
		RemoteId:       p.ID().String(),
733 734
		NumConnections: srv.PeerCount(),
	})
zelig's avatar
zelig committed
735
}
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798

// NodeInfo represents a short summary of the information known about the host.
type NodeInfo struct {
	ID    string `json:"id"`    // Unique node identifier (also the encryption key)
	Name  string `json:"name"`  // Name of the node, including client type, version, OS, custom data
	Enode string `json:"enode"` // Enode URL for adding this peer from remote peers
	IP    string `json:"ip"`    // IP address of the node
	Ports struct {
		Discovery int `json:"discovery"` // UDP listening port for discovery protocol
		Listener  int `json:"listener"`  // TCP listening port for RLPx
	} `json:"ports"`
	ListenAddr string                 `json:"listenAddr"`
	Protocols  map[string]interface{} `json:"protocols"`
}

// Info gathers and returns a collection of metadata known about the host.
func (srv *Server) NodeInfo() *NodeInfo {
	node := srv.Self()

	// Gather and assemble the generic node infos
	info := &NodeInfo{
		Name:       srv.Name,
		Enode:      node.String(),
		ID:         node.ID.String(),
		IP:         node.IP.String(),
		ListenAddr: srv.ListenAddr,
		Protocols:  make(map[string]interface{}),
	}
	info.Ports.Discovery = int(node.UDP)
	info.Ports.Listener = int(node.TCP)

	// Gather all the running protocol infos (only once per protocol type)
	for _, proto := range srv.Protocols {
		if _, ok := info.Protocols[proto.Name]; !ok {
			nodeInfo := interface{}("unknown")
			if query := proto.NodeInfo; query != nil {
				nodeInfo = proto.NodeInfo()
			}
			info.Protocols[proto.Name] = nodeInfo
		}
	}
	return info
}

// PeersInfo returns an array of metadata objects describing connected peers.
func (srv *Server) PeersInfo() []*PeerInfo {
	// Gather all the generic and sub-protocol specific infos
	infos := make([]*PeerInfo, 0, srv.PeerCount())
	for _, peer := range srv.Peers() {
		if peer != nil {
			infos = append(infos, peer.Info())
		}
	}
	// Sort the result array alphabetically by node identifier
	for i := 0; i < len(infos); i++ {
		for j := i + 1; j < len(infos); j++ {
			if infos[i].ID > infos[j].ID {
				infos[i], infos[j] = infos[j], infos[i]
			}
		}
	}
	return infos
}