2015-07-06 19:54:22 -05:00
|
|
|
// Copyright 2014 The go-ethereum Authors
|
2015-07-22 11:48:40 -05:00
|
|
|
// This file is part of the go-ethereum library.
|
2015-07-06 19:54:22 -05:00
|
|
|
//
|
2015-07-23 11:35:11 -05:00
|
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
2015-07-06 19:54:22 -05:00
|
|
|
// 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.
|
|
|
|
//
|
2015-07-22 11:48:40 -05:00
|
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
2015-07-06 19:54:22 -05:00
|
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2015-07-22 11:48:40 -05:00
|
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
2015-07-06 19:54:22 -05:00
|
|
|
// GNU Lesser General Public License for more details.
|
|
|
|
//
|
|
|
|
// You should have received a copy of the GNU Lesser General Public License
|
2015-07-22 11:48:40 -05:00
|
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
2015-07-06 19:54:22 -05:00
|
|
|
|
2014-10-23 10:57:54 -05:00
|
|
|
package p2p
|
|
|
|
|
|
|
|
import (
|
2014-11-04 06:21:44 -06:00
|
|
|
"bytes"
|
2014-12-12 04:39:07 -06:00
|
|
|
"errors"
|
2015-01-05 10:10:42 -06:00
|
|
|
"fmt"
|
2014-11-04 06:21:44 -06:00
|
|
|
"io"
|
|
|
|
"io/ioutil"
|
2014-12-12 04:39:07 -06:00
|
|
|
"sync/atomic"
|
2015-02-04 20:07:58 -06:00
|
|
|
"time"
|
2014-11-04 06:21:44 -06:00
|
|
|
|
2017-09-25 03:08:07 -05:00
|
|
|
"github.com/ethereum/go-ethereum/event"
|
all: new p2p node representation (#17643)
Package p2p/enode provides a generalized representation of p2p nodes
which can contain arbitrary information in key/value pairs. It is also
the new home for the node database. The "v4" identity scheme is also
moved here from p2p/enr to remove the dependency on Ethereum crypto from
that package.
Record signature handling is changed significantly. The identity scheme
registry is removed and acceptable schemes must be passed to any method
that needs identity. This means records must now be validated explicitly
after decoding.
The enode API is designed to make signature handling easy and safe: most
APIs around the codebase work with enode.Node, which is a wrapper around
a valid record. Going from enr.Record to enode.Node requires a valid
signature.
* p2p/discover: port to p2p/enode
This ports the discovery code to the new node representation in
p2p/enode. The wire protocol is unchanged, this can be considered a
refactoring change. The Kademlia table can now deal with nodes using an
arbitrary identity scheme. This requires a few incompatible API changes:
- Table.Lookup is not available anymore. It used to take a public key
as argument because v4 protocol requires one. Its replacement is
LookupRandom.
- Table.Resolve takes *enode.Node instead of NodeID. This is also for
v4 protocol compatibility because nodes cannot be looked up by ID
alone.
- Types Node and NodeID are gone. Further commits in the series will be
fixes all over the the codebase to deal with those removals.
* p2p: port to p2p/enode and discovery changes
This adapts package p2p to the changes in p2p/discover. All uses of
discover.Node and discover.NodeID are replaced by their equivalents from
p2p/enode.
New API is added to retrieve the enode.Node instance of a peer. The
behavior of Server.Self with discovery disabled is improved. It now
tries much harder to report a working IP address, falling back to
127.0.0.1 if no suitable address can be determined through other means.
These changes were needed for tests of other packages later in the
series.
* p2p/simulations, p2p/testing: port to p2p/enode
No surprises here, mostly replacements of discover.Node, discover.NodeID
with their new equivalents. The 'interesting' API changes are:
- testing.ProtocolSession tracks complete nodes, not just their IDs.
- adapters.NodeConfig has a new method to create a complete node.
These changes were needed to make swarm tests work.
Note that the NodeID change makes the code incompatible with old
simulation snapshots.
* whisper/whisperv5, whisper/whisperv6: port to p2p/enode
This port was easy because whisper uses []byte for node IDs and
URL strings in the API.
* eth: port to p2p/enode
Again, easy to port because eth uses strings for node IDs and doesn't
care about node information in any way.
* les: port to p2p/enode
Apart from replacing discover.NodeID with enode.ID, most changes are in
the server pool code. It now deals with complete nodes instead
of (Pubkey, IP, Port) triples. The database format is unchanged for now,
but we should probably change it to use the node database later.
* node: port to p2p/enode
This change simply replaces discover.Node and discover.NodeID with their
new equivalents.
* swarm/network: port to p2p/enode
Swarm has its own node address representation, BzzAddr, containing both
an overlay address (the hash of a secp256k1 public key) and an underlay
address (enode:// URL).
There are no changes to the BzzAddr format in this commit, but certain
operations such as creating a BzzAddr from a node ID are now impossible
because node IDs aren't public keys anymore.
Most swarm-related changes in the series remove uses of
NewAddrFromNodeID, replacing it with NewAddr which takes a complete node
as argument. ToOverlayAddr is removed because we can just use the node
ID directly.
2018-09-24 17:59:00 -05:00
|
|
|
"github.com/ethereum/go-ethereum/p2p/enode"
|
2014-11-24 12:02:48 -06:00
|
|
|
"github.com/ethereum/go-ethereum/rlp"
|
2014-10-23 10:57:54 -05:00
|
|
|
)
|
|
|
|
|
2014-11-04 06:21:44 -06:00
|
|
|
// Msg defines the structure of a p2p message.
|
|
|
|
//
|
|
|
|
// Note that a Msg can only be sent once since the Payload reader is
|
|
|
|
// consumed during sending. It is not possible to create a Msg and
|
|
|
|
// send it any number of times. If you want to reuse an encoded
|
|
|
|
// structure, encode the payload into a byte array and create a
|
|
|
|
// separate Msg with a bytes.Reader as Payload for each send.
|
2014-10-23 10:57:54 -05:00
|
|
|
type Msg struct {
|
2015-04-29 15:49:58 -05:00
|
|
|
Code uint64
|
2019-09-27 09:41:47 -05:00
|
|
|
Size uint32 // Size of the raw payload
|
2015-04-29 15:49:58 -05:00
|
|
|
Payload io.Reader
|
|
|
|
ReceivedAt time.Time
|
2019-09-27 09:41:47 -05:00
|
|
|
|
|
|
|
meterCap Cap // Protocol name and version for egress metering
|
|
|
|
meterCode uint64 // Message within protocol for egress metering
|
|
|
|
meterSize uint32 // Compressed message size for ingress metering
|
2014-10-23 10:57:54 -05:00
|
|
|
}
|
|
|
|
|
2015-03-19 09:11:02 -05:00
|
|
|
// Decode parses the RLP content of a message into
|
2014-11-25 05:25:31 -06:00
|
|
|
// the given value, which must be a pointer.
|
|
|
|
//
|
|
|
|
// For the decoding rules, please see package rlp.
|
|
|
|
func (msg Msg) Decode(val interface{}) error {
|
2015-03-23 09:08:29 -05:00
|
|
|
s := rlp.NewStream(msg.Payload, uint64(msg.Size))
|
|
|
|
if err := s.Decode(val); err != nil {
|
2015-03-20 06:52:03 -05:00
|
|
|
return newPeerError(errInvalidMsg, "(code %x) (size %d) %v", msg.Code, msg.Size, err)
|
2015-01-05 10:10:42 -06:00
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func (msg Msg) String() string {
|
|
|
|
return fmt.Sprintf("msg #%v (%v bytes)", msg.Code, msg.Size)
|
2014-11-25 05:25:31 -06:00
|
|
|
}
|
|
|
|
|
2014-11-04 06:21:44 -06:00
|
|
|
// Discard reads any remaining payload data into a black hole.
|
|
|
|
func (msg Msg) Discard() error {
|
|
|
|
_, err := io.Copy(ioutil.Discard, msg.Payload)
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2021-02-18 10:54:29 -06:00
|
|
|
func (msg Msg) Time() time.Time {
|
|
|
|
return msg.ReceivedAt
|
|
|
|
}
|
|
|
|
|
2014-11-21 14:48:49 -06:00
|
|
|
type MsgReader interface {
|
|
|
|
ReadMsg() (Msg, error)
|
|
|
|
}
|
|
|
|
|
|
|
|
type MsgWriter interface {
|
2015-01-06 04:35:09 -06:00
|
|
|
// WriteMsg sends a message. It will block until the message's
|
|
|
|
// Payload has been consumed by the other end.
|
|
|
|
//
|
2015-02-04 20:07:58 -06:00
|
|
|
// Note that messages can be sent only once because their
|
|
|
|
// payload reader is drained.
|
2014-11-21 14:48:49 -06:00
|
|
|
WriteMsg(Msg) error
|
|
|
|
}
|
|
|
|
|
|
|
|
// MsgReadWriter provides reading and writing of encoded messages.
|
2015-02-04 20:07:58 -06:00
|
|
|
// Implementations should ensure that ReadMsg and WriteMsg can be
|
|
|
|
// called simultaneously from multiple goroutines.
|
2014-11-21 14:48:49 -06:00
|
|
|
type MsgReadWriter interface {
|
|
|
|
MsgReader
|
|
|
|
MsgWriter
|
|
|
|
}
|
|
|
|
|
2015-03-19 09:11:02 -05:00
|
|
|
// Send writes an RLP-encoded message with the given code.
|
|
|
|
// data should encode as an RLP list.
|
|
|
|
func Send(w MsgWriter, msgcode uint64, data interface{}) error {
|
|
|
|
size, r, err := rlp.EncodeToReader(data)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
return w.WriteMsg(Msg{Code: msgcode, Size: uint32(size), Payload: r})
|
|
|
|
}
|
|
|
|
|
|
|
|
// SendItems writes an RLP with the given code and data elements.
|
|
|
|
// For a call such as:
|
|
|
|
//
|
|
|
|
// SendItems(w, code, e1, e2, e3)
|
|
|
|
//
|
|
|
|
// the message payload will be an RLP list containing the items:
|
|
|
|
//
|
|
|
|
// [e1, e2, e3]
|
|
|
|
//
|
|
|
|
func SendItems(w MsgWriter, msgcode uint64, elems ...interface{}) error {
|
|
|
|
return Send(w, msgcode, elems)
|
2015-01-06 04:35:09 -06:00
|
|
|
}
|
|
|
|
|
2015-02-04 20:07:58 -06:00
|
|
|
// eofSignal wraps a reader with eof signaling. the eof channel is
|
|
|
|
// closed when the wrapped reader returns an error or when count bytes
|
|
|
|
// have been read.
|
|
|
|
type eofSignal struct {
|
|
|
|
wrapped io.Reader
|
|
|
|
count uint32 // number of bytes left
|
|
|
|
eof chan<- struct{}
|
|
|
|
}
|
|
|
|
|
|
|
|
// note: when using eofSignal to detect whether a message payload
|
|
|
|
// has been read, Read might not be called for zero sized messages.
|
|
|
|
func (r *eofSignal) Read(buf []byte) (int, error) {
|
|
|
|
if r.count == 0 {
|
|
|
|
if r.eof != nil {
|
|
|
|
r.eof <- struct{}{}
|
|
|
|
r.eof = nil
|
|
|
|
}
|
|
|
|
return 0, io.EOF
|
|
|
|
}
|
|
|
|
|
|
|
|
max := len(buf)
|
|
|
|
if int(r.count) < len(buf) {
|
|
|
|
max = int(r.count)
|
|
|
|
}
|
|
|
|
n, err := r.wrapped.Read(buf[:max])
|
|
|
|
r.count -= uint32(n)
|
|
|
|
if (err != nil || r.count == 0) && r.eof != nil {
|
|
|
|
r.eof <- struct{}{} // tell Peer that msg has been consumed
|
|
|
|
r.eof = nil
|
|
|
|
}
|
|
|
|
return n, err
|
|
|
|
}
|
|
|
|
|
2014-12-12 04:39:07 -06:00
|
|
|
// MsgPipe creates a message pipe. Reads on one end are matched
|
|
|
|
// with writes on the other. The pipe is full-duplex, both ends
|
|
|
|
// implement MsgReadWriter.
|
|
|
|
func MsgPipe() (*MsgPipeRW, *MsgPipeRW) {
|
|
|
|
var (
|
|
|
|
c1, c2 = make(chan Msg), make(chan Msg)
|
|
|
|
closing = make(chan struct{})
|
|
|
|
closed = new(int32)
|
|
|
|
rw1 = &MsgPipeRW{c1, c2, closing, closed}
|
|
|
|
rw2 = &MsgPipeRW{c2, c1, closing, closed}
|
|
|
|
)
|
|
|
|
return rw1, rw2
|
|
|
|
}
|
|
|
|
|
|
|
|
// ErrPipeClosed is returned from pipe operations after the
|
|
|
|
// pipe has been closed.
|
|
|
|
var ErrPipeClosed = errors.New("p2p: read or write on closed message pipe")
|
|
|
|
|
|
|
|
// MsgPipeRW is an endpoint of a MsgReadWriter pipe.
|
|
|
|
type MsgPipeRW struct {
|
|
|
|
w chan<- Msg
|
|
|
|
r <-chan Msg
|
|
|
|
closing chan struct{}
|
|
|
|
closed *int32
|
|
|
|
}
|
|
|
|
|
all: on-chain oracle checkpoint syncing (#19543)
* all: implement simple checkpoint syncing
cmd, les, node: remove callback mechanism
cmd, node: remove callback definition
les: simplify the registrar
les: expose checkpoint rpc services in the light client
les, light: don't store untrusted receipt
cmd, contracts, les: discard stale checkpoint
cmd, contracts/registrar: loose restriction of registeration
cmd, contracts: add replay-protection
all: off-chain multi-signature contract
params: deploy checkpoint contract for rinkeby
cmd/registrar: add raw signing mode for registrar
cmd/registrar, contracts/registrar, les: fixed messages
* cmd/registrar, contracts/registrar: fix lints
* accounts/abi/bind, les: address comments
* cmd, contracts, les, light, params: minor checkpoint sync cleanups
* cmd, eth, les, light: move checkpoint config to config file
* cmd, eth, les, params: address comments
* eth, les, params: address comments
* cmd: polish up the checkpoint admin CLI
* cmd, contracts, params: deploy new version contract
* cmd/checkpoint-admin: add another flag for clef mode signing
* cmd, contracts, les: rename and regen checkpoint oracle with abigen
2019-06-28 02:34:02 -05:00
|
|
|
// WriteMsg sends a message on the pipe.
|
2014-12-12 04:39:07 -06:00
|
|
|
// It blocks until the receiver has consumed the message payload.
|
|
|
|
func (p *MsgPipeRW) WriteMsg(msg Msg) error {
|
|
|
|
if atomic.LoadInt32(p.closed) == 0 {
|
|
|
|
consumed := make(chan struct{}, 1)
|
2015-02-04 20:07:58 -06:00
|
|
|
msg.Payload = &eofSignal{msg.Payload, msg.Size, consumed}
|
2014-12-12 04:39:07 -06:00
|
|
|
select {
|
|
|
|
case p.w <- msg:
|
|
|
|
if msg.Size > 0 {
|
|
|
|
// wait for payload read or discard
|
2015-03-19 09:16:06 -05:00
|
|
|
select {
|
|
|
|
case <-consumed:
|
|
|
|
case <-p.closing:
|
|
|
|
}
|
2014-12-12 04:39:07 -06:00
|
|
|
}
|
|
|
|
return nil
|
|
|
|
case <-p.closing:
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return ErrPipeClosed
|
|
|
|
}
|
|
|
|
|
|
|
|
// ReadMsg returns a message sent on the other end of the pipe.
|
|
|
|
func (p *MsgPipeRW) ReadMsg() (Msg, error) {
|
|
|
|
if atomic.LoadInt32(p.closed) == 0 {
|
|
|
|
select {
|
|
|
|
case msg := <-p.r:
|
|
|
|
return msg, nil
|
|
|
|
case <-p.closing:
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return Msg{}, ErrPipeClosed
|
|
|
|
}
|
|
|
|
|
|
|
|
// Close unblocks any pending ReadMsg and WriteMsg calls on both ends
|
2015-03-19 09:16:06 -05:00
|
|
|
// of the pipe. They will return ErrPipeClosed. Close also
|
|
|
|
// interrupts any reads from a message payload.
|
2014-12-12 04:39:07 -06:00
|
|
|
func (p *MsgPipeRW) Close() error {
|
|
|
|
if atomic.AddInt32(p.closed, 1) != 1 {
|
|
|
|
// someone else is already closing
|
|
|
|
atomic.StoreInt32(p.closed, 1) // avoid overflow
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
close(p.closing)
|
|
|
|
return nil
|
|
|
|
}
|
2015-03-19 09:08:04 -05:00
|
|
|
|
|
|
|
// ExpectMsg reads a message from r and verifies that its
|
|
|
|
// code and encoded RLP content match the provided values.
|
|
|
|
// If content is nil, the payload is discarded and not verified.
|
|
|
|
func ExpectMsg(r MsgReader, code uint64, content interface{}) error {
|
|
|
|
msg, err := r.ReadMsg()
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if msg.Code != code {
|
|
|
|
return fmt.Errorf("message code mismatch: got %d, expected %d", msg.Code, code)
|
|
|
|
}
|
|
|
|
if content == nil {
|
|
|
|
return msg.Discard()
|
2018-05-03 03:33:39 -05:00
|
|
|
}
|
|
|
|
contentEnc, err := rlp.EncodeToBytes(content)
|
|
|
|
if err != nil {
|
|
|
|
panic("content encode error: " + err.Error())
|
|
|
|
}
|
|
|
|
if int(msg.Size) != len(contentEnc) {
|
|
|
|
return fmt.Errorf("message size mismatch: got %d, want %d", msg.Size, len(contentEnc))
|
|
|
|
}
|
|
|
|
actualContent, err := ioutil.ReadAll(msg.Payload)
|
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if !bytes.Equal(actualContent, contentEnc) {
|
|
|
|
return fmt.Errorf("message payload mismatch:\ngot: %x\nwant: %x", actualContent, contentEnc)
|
2015-03-19 09:08:04 -05:00
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
2017-09-25 03:08:07 -05:00
|
|
|
|
|
|
|
// msgEventer wraps a MsgReadWriter and sends events whenever a message is sent
|
|
|
|
// or received
|
|
|
|
type msgEventer struct {
|
|
|
|
MsgReadWriter
|
|
|
|
|
2019-07-05 13:27:13 -05:00
|
|
|
feed *event.Feed
|
|
|
|
peerID enode.ID
|
|
|
|
Protocol string
|
|
|
|
localAddress string
|
|
|
|
remoteAddress string
|
2017-09-25 03:08:07 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
// newMsgEventer returns a msgEventer which sends message events to the given
|
|
|
|
// feed
|
2019-07-05 13:27:13 -05:00
|
|
|
func newMsgEventer(rw MsgReadWriter, feed *event.Feed, peerID enode.ID, proto, remote, local string) *msgEventer {
|
2017-09-25 03:08:07 -05:00
|
|
|
return &msgEventer{
|
|
|
|
MsgReadWriter: rw,
|
|
|
|
feed: feed,
|
|
|
|
peerID: peerID,
|
|
|
|
Protocol: proto,
|
2019-07-05 13:27:13 -05:00
|
|
|
remoteAddress: remote,
|
|
|
|
localAddress: local,
|
2017-09-25 03:08:07 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// ReadMsg reads a message from the underlying MsgReadWriter and emits a
|
|
|
|
// "message received" event
|
2018-05-08 06:08:43 -05:00
|
|
|
func (ev *msgEventer) ReadMsg() (Msg, error) {
|
|
|
|
msg, err := ev.MsgReadWriter.ReadMsg()
|
2017-09-25 03:08:07 -05:00
|
|
|
if err != nil {
|
|
|
|
return msg, err
|
|
|
|
}
|
2018-05-08 06:08:43 -05:00
|
|
|
ev.feed.Send(&PeerEvent{
|
2019-07-05 13:27:13 -05:00
|
|
|
Type: PeerEventTypeMsgRecv,
|
|
|
|
Peer: ev.peerID,
|
|
|
|
Protocol: ev.Protocol,
|
|
|
|
MsgCode: &msg.Code,
|
|
|
|
MsgSize: &msg.Size,
|
|
|
|
LocalAddress: ev.localAddress,
|
|
|
|
RemoteAddress: ev.remoteAddress,
|
2017-09-25 03:08:07 -05:00
|
|
|
})
|
|
|
|
return msg, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// WriteMsg writes a message to the underlying MsgReadWriter and emits a
|
|
|
|
// "message sent" event
|
2018-05-08 06:08:43 -05:00
|
|
|
func (ev *msgEventer) WriteMsg(msg Msg) error {
|
|
|
|
err := ev.MsgReadWriter.WriteMsg(msg)
|
2017-09-25 03:08:07 -05:00
|
|
|
if err != nil {
|
|
|
|
return err
|
|
|
|
}
|
2018-05-08 06:08:43 -05:00
|
|
|
ev.feed.Send(&PeerEvent{
|
2019-07-05 13:27:13 -05:00
|
|
|
Type: PeerEventTypeMsgSend,
|
|
|
|
Peer: ev.peerID,
|
|
|
|
Protocol: ev.Protocol,
|
|
|
|
MsgCode: &msg.Code,
|
|
|
|
MsgSize: &msg.Size,
|
|
|
|
LocalAddress: ev.localAddress,
|
|
|
|
RemoteAddress: ev.remoteAddress,
|
2017-09-25 03:08:07 -05:00
|
|
|
})
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// Close closes the underlying MsgReadWriter if it implements the io.Closer
|
|
|
|
// interface
|
2018-05-08 06:08:43 -05:00
|
|
|
func (ev *msgEventer) Close() error {
|
|
|
|
if v, ok := ev.MsgReadWriter.(io.Closer); ok {
|
2017-09-25 03:08:07 -05:00
|
|
|
return v.Close()
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|