aboutsummaryrefslogtreecommitdiffstats
path: root/p2p/discover/udp.go
blob: 1213c12c82e34f8acd722878577e58a8e77abe80 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
package discover

import (
    "bytes"
    "crypto/ecdsa"
    "errors"
    "fmt"
    "net"
    "time"

    "github.com/ethereum/go-ethereum/crypto"
    "github.com/ethereum/go-ethereum/logger"
    "github.com/ethereum/go-ethereum/logger/glog"
    "github.com/ethereum/go-ethereum/p2p/nat"
    "github.com/ethereum/go-ethereum/rlp"
)

const Version = 4

// Errors
var (
    errPacketTooSmall   = errors.New("too small")
    errBadHash          = errors.New("bad hash")
    errExpired          = errors.New("expired")
    errBadVersion       = errors.New("version mismatch")
    errUnsolicitedReply = errors.New("unsolicited reply")
    errUnknownNode      = errors.New("unknown node")
    errTimeout          = errors.New("RPC timeout")
    errClosed           = errors.New("socket closed")
)

// Timeouts
const (
    respTimeout = 500 * time.Millisecond
    sendTimeout = 500 * time.Millisecond
    expiration  = 20 * time.Second

    refreshInterval = 1 * time.Hour
)

// RPC packet types
const (
    pingPacket = iota + 1 // zero is 'reserved'
    pongPacket
    findnodePacket
    neighborsPacket
)

// RPC request structures
type (
    ping struct {
        Version    uint
        From, To   rpcEndpoint
        Expiration uint64
    }

    // pong is the reply to ping.
    pong struct {
        // This field should mirror the UDP envelope address
        // of the ping packet, which provides a way to discover the
        // the external address (after NAT).
        To rpcEndpoint

        ReplyTok   []byte // This contains the hash of the ping packet.
        Expiration uint64 // Absolute timestamp at which the packet becomes invalid.
    }

    // findnode is a query for nodes close to the given target.
    findnode struct {
        Target     NodeID // doesn't need to be an actual public key
        Expiration uint64
    }

    // reply to findnode
    neighbors struct {
        Nodes      []rpcNode
        Expiration uint64
    }

    rpcNode struct {
        IP  net.IP // len 4 for IPv4 or 16 for IPv6
        UDP uint16 // for discovery protocol
        TCP uint16 // for RLPx protocol
        ID  NodeID
    }

    rpcEndpoint struct {
        IP  net.IP // len 4 for IPv4 or 16 for IPv6
        UDP uint16 // for discovery protocol
        TCP uint16 // for RLPx protocol
    }
)

func makeEndpoint(addr *net.UDPAddr, tcpPort uint16) rpcEndpoint {
    ip := addr.IP.To4()
    if ip == nil {
        ip = addr.IP.To16()
    }
    return rpcEndpoint{IP: ip, UDP: uint16(addr.Port), TCP: tcpPort}
}

func nodeFromRPC(rn rpcNode) (n *Node, valid bool) {
    // TODO: don't accept localhost, LAN addresses from internet hosts
    // TODO: check public key is on secp256k1 curve
    if rn.IP.IsMulticast() || rn.IP.IsUnspecified() || rn.UDP == 0 {
        return nil, false
    }
    return newNode(rn.ID, rn.IP, rn.UDP, rn.TCP), true
}

func nodeToRPC(n *Node) rpcNode {
    return rpcNode{ID: n.ID, IP: n.IP, UDP: n.UDP, TCP: n.TCP}
}

type packet interface {
    handle(t *udp, from *net.UDPAddr, fromID NodeID, mac []byte) error
}

type conn interface {
    ReadFromUDP(b []byte) (n int, addr *net.UDPAddr, err error)
    WriteToUDP(b []byte, addr *net.UDPAddr) (n int, err error)
    Close() error
    LocalAddr() net.Addr
}

// udp implements the RPC protocol.
type udp struct {
    conn        conn
    priv        *ecdsa.PrivateKey
    ourEndpoint rpcEndpoint

    addpending chan *pending
    gotreply   chan reply

    closing chan struct{}
    nat     nat.Interface

    *Table
}

// pending represents a pending reply.
//
// some implementations of the protocol wish to send more than one
// reply packet to findnode. in general, any neighbors packet cannot
// be matched up with a specific findnode packet.
//
// our implementation handles this by storing a callback function for
// each pending reply. incoming packets from a node are dispatched
// to all the callback functions for that node.
type pending struct {
    // these fields must match in the reply.
    from  NodeID
    ptype byte

    // time when the request must complete
    deadline time.Time

    // callback is called when a matching reply arrives. if it returns
    // true, the callback is removed from the pending reply queue.
    // if it returns false, the reply is considered incomplete and
    // the callback will be invoked again for the next matching reply.
    callback func(resp interface{}) (done bool)

    // errc receives nil when the callback indicates completion or an
    // error if no further reply is received within the timeout.
    errc chan<- error
}

type reply struct {
    from  NodeID
    ptype byte
    data  interface{}
    // loop indicates whether there was
    // a matching request by sending on this channel.
    matched chan<- bool
}

// ListenUDP returns a new table that listens for UDP packets on laddr.
func ListenUDP(priv *ecdsa.PrivateKey, laddr string, natm nat.Interface, nodeDBPath string) (*Table, error) {
    addr, err := net.ResolveUDPAddr("udp", laddr)
    if err != nil {
        return nil, err
    }
    conn, err := net.ListenUDP("udp", addr)
    if err != nil {
        return nil, err
    }
    tab, _ := newUDP(priv, conn, natm, nodeDBPath)
    glog.V(logger.Info).Infoln("Listening,", tab.self)
    return tab, nil
}

func newUDP(priv *ecdsa.PrivateKey, c conn, natm nat.Interface, nodeDBPath string) (*Table, *udp) {
    udp := &udp{
        conn:       c,
        priv:       priv,
        closing:    make(chan struct{}),
        gotreply:   make(chan reply),
        addpending: make(chan *pending),
    }
    realaddr := c.LocalAddr().(*net.UDPAddr)
    if natm != nil {
        if !realaddr.IP.IsLoopback() {
            go nat.Map(natm, udp.closing, "udp", realaddr.Port, realaddr.Port, "ethereum discovery")
        }
        // TODO: react to external IP changes over time.
        if ext, err := natm.ExternalIP(); err == nil {
            realaddr = &net.UDPAddr{IP: ext, Port: realaddr.Port}
        }
    }
    // TODO: separate TCP port
    udp.ourEndpoint = makeEndpoint(realaddr, uint16(realaddr.Port))
    udp.Table = newTable(udp, PubkeyID(&priv.PublicKey), realaddr, nodeDBPath)
    go udp.loop()
    go udp.readLoop()
    return udp.Table, udp
}

func (t *udp) close() {
    close(t.closing)
    t.conn.Close()
    // TODO: wait for the loops to end.
}

// ping sends a ping message to the given node and waits for a reply.
func (t *udp) ping(toid NodeID, toaddr *net.UDPAddr) error {
    // TODO: maybe check for ReplyTo field in callback to measure RTT
    errc := t.pending(toid, pongPacket, func(interface{}) bool { return true })
    t.send(toaddr, pingPacket, ping{
        Version:    Version,
        From:       t.ourEndpoint,
        To:         makeEndpoint(toaddr, 0), // TODO: maybe use known TCP port from DB
        Expiration: uint64(time.Now().Add(expiration).Unix()),
    })
    return <-errc
}

func (t *udp) waitping(from NodeID) error {
    return <-t.pending(from, pingPacket, func(interface{}) bool { return true })
}

// findnode sends a findnode request to the given node and waits until
// the node has sent up to k neighbors.
func (t *udp) findnode(toid NodeID, toaddr *net.UDPAddr, target NodeID) ([]*Node, error) {
    nodes := make([]*Node, 0, bucketSize)
    nreceived := 0
    errc := t.pending(toid, neighborsPacket, func(r interface{}) bool {
        reply := r.(*neighbors)
        for _, rn := range reply.Nodes {
            nreceived++
            if n, valid := nodeFromRPC(rn); valid {
                nodes = append(nodes, n)
            }
        }
        return nreceived >= bucketSize
    })
    t.send(toaddr, findnodePacket, findnode{
        Target:     target,
        Expiration: uint64(time.Now().Add(expiration).Unix()),
    })
    err := <-errc
    return nodes, err
}

// pending adds a reply callback to the pending reply queue.
// see the documentation of type pending for a detailed explanation.
func (t *udp) pending(id NodeID, ptype byte, callback func(interface{}) bool) <-chan error {
    ch := make(chan error, 1)
    p := &pending{from: id, ptype: ptype, callback: callback, errc: ch}
    select {
    case t.addpending <- p:
        // loop will handle it
    case <-t.closing:
        ch <- errClosed
    }
    return ch
}

func (t *udp) handleReply(from NodeID, ptype byte, req packet) bool {
    matched := make(chan bool)
    select {
    case t.gotreply <- reply{from, ptype, req, matched}:
        // loop will handle it
        return <-matched
    case <-t.closing:
        return false
    }
}

// loop runs in its own goroutin. it keeps track of
// the refresh timer and the pending reply queue.
func (t *udp) loop() {
    var (
        pending      []*pending
        nextDeadline time.Time
        timeout      = time.NewTimer(0)
        refresh      = time.NewTicker(refreshInterval)
    )
    <-timeout.C // ignore first timeout
    defer refresh.Stop()
    defer timeout.Stop()

    rearmTimeout := func() {
        now := time.Now()
        if len(pending) == 0 || now.Before(nextDeadline) {
            return
        }
        nextDeadline = pending[0].deadline
        timeout.Reset(nextDeadline.Sub(now))
    }

    for {
        select {
        case <-refresh.C:
            go t.refresh()

        case <-t.closing:
            for _, p := range pending {
                p.errc <- errClosed
            }
            pending = nil
            return

        case p := <-t.addpending:
            p.deadline = time.Now().Add(respTimeout)
            pending = append(pending, p)
            rearmTimeout()

        case r := <-t.gotreply:
            var matched bool
            for i := 0; i < len(pending); i++ {
                if p := pending[i]; p.from == r.from && p.ptype == r.ptype {
                    matched = true
                    if p.callback(r.data) {
                        // callback indicates the request is done, remove it.
                        p.errc <- nil
                        copy(pending[i:], pending[i+1:])
                        pending = pending[:len(pending)-1]
                        i--
                    }
                }
            }
            r.matched <- matched

        case now := <-timeout.C:
            // notify and remove callbacks whose deadline is in the past.
            i := 0
            for ; i < len(pending) && now.After(pending[i].deadline); i++ {
                pending[i].errc <- errTimeout
            }
            if i > 0 {
                copy(pending, pending[i:])
                pending = pending[:len(pending)-i]
            }
            rearmTimeout()
        }
    }
}

const (
    macSize  = 256 / 8
    sigSize  = 520 / 8
    headSize = macSize + sigSize // space of packet frame data
)

var headSpace = make([]byte, headSize)

func (t *udp) send(toaddr *net.UDPAddr, ptype byte, req interface{}) error {
    packet, err := encodePacket(t.priv, ptype, req)
    if err != nil {
        return err
    }
    glog.V(logger.Detail).Infof(">>> %v %T\n", toaddr, req)
    if _, err = t.conn.WriteToUDP(packet, toaddr); err != nil {
        glog.V(logger.Detail).Infoln("UDP send failed:", err)
    }
    return err
}

func encodePacket(priv *ecdsa.PrivateKey, ptype byte, req interface{}) ([]byte, error) {
    b := new(bytes.Buffer)
    b.Write(headSpace)
    b.WriteByte(ptype)
    if err := rlp.Encode(b, req); err != nil {
        glog.V(logger.Error).Infoln("error encoding packet:", err)
        return nil, err
    }
    packet := b.Bytes()
    sig, err := crypto.Sign(crypto.Sha3(packet[headSize:]), priv)
    if err != nil {
        glog.V(logger.Error).Infoln("could not sign packet:", err)
        return nil, err
    }
    copy(packet[macSize:], sig)
    // add the hash to the front. Note: this doesn't protect the
    // packet in any way. Our public key will be part of this hash in
    // The future.
    copy(packet, crypto.Sha3(packet[macSize:]))
    return packet, nil
}

// readLoop runs in its own goroutine. it handles incoming UDP packets.
func (t *udp) readLoop() {
    defer t.conn.Close()
    buf := make([]byte, 4096) // TODO: good buffer size
    for {
        nbytes, from, err := t.conn.ReadFromUDP(buf)
        if err != nil {
            return
        }
        t.handlePacket(from, buf[:nbytes])
    }
}

func (t *udp) handlePacket(from *net.UDPAddr, buf []byte) error {
    packet, fromID, hash, err := decodePacket(buf)
    if err != nil {
        glog.V(logger.Debug).Infof("Bad packet from %v: %v\n", from, err)
        return err
    }
    status := "ok"
    if err = packet.handle(t, from, fromID, hash); err != nil {
        status = err.Error()
    }
    glog.V(logger.Detail).Infof("<<< %v %T: %s\n", from, packet, status)
    return err
}

func decodePacket(buf []byte) (packet, NodeID, []byte, error) {
    if len(buf) < headSize+1 {
        return nil, NodeID{}, nil, errPacketTooSmall
    }
    hash, sig, sigdata := buf[:macSize], buf[macSize:headSize], buf[headSize:]
    shouldhash := crypto.Sha3(buf[macSize:])
    if !bytes.Equal(hash, shouldhash) {
        return nil, NodeID{}, nil, errBadHash
    }
    fromID, err := recoverNodeID(crypto.Sha3(buf[headSize:]), sig)
    if err != nil {
        return nil, NodeID{}, hash, err
    }
    var req packet
    switch ptype := sigdata[0]; ptype {
    case pingPacket:
        req = new(ping)
    case pongPacket:
        req = new(pong)
    case findnodePacket:
        req = new(findnode)
    case neighborsPacket:
        req = new(neighbors)
    default:
        return nil, fromID, hash, fmt.Errorf("unknown type: %d", ptype)
    }
    err = rlp.DecodeBytes(sigdata[1:], req)
    return req, fromID, hash, err
}

func (req *ping) handle(t *udp, from *net.UDPAddr, fromID NodeID, mac []byte) error {
    if expired(req.Expiration) {
        return errExpired
    }
    if req.Version != Version {
        return errBadVersion
    }
    t.send(from, pongPacket, pong{
        To:         makeEndpoint(from, req.From.TCP),
        ReplyTok:   mac,
        Expiration: uint64(time.Now().Add(expiration).Unix()),
    })
    if !t.handleReply(fromID, pingPacket, req) {
        // Note: we're ignoring the provided IP address right now
        go t.bond(true, fromID, from, req.From.TCP)
    }
    return nil
}

func (req *pong) handle(t *udp, from *net.UDPAddr, fromID NodeID, mac []byte) error {
    if expired(req.Expiration) {
        return errExpired
    }
    if !t.handleReply(fromID, pongPacket, req) {
        return errUnsolicitedReply
    }
    return nil
}

func (req *findnode) handle(t *udp, from *net.UDPAddr, fromID NodeID, mac []byte) error {
    if expired(req.Expiration) {
        return errExpired
    }
    if t.db.node(fromID) == nil {
        // No bond exists, we don't process the packet. This prevents
        // an attack vector where the discovery protocol could be used
        // to amplify traffic in a DDOS attack. A malicious actor
        // would send a findnode request with the IP address and UDP
        // port of the target as the source address. The recipient of
        // the findnode packet would then send a neighbors packet
        // (which is a much bigger packet than findnode) to the victim.
        return errUnknownNode
    }
    target := crypto.Sha3Hash(req.Target[:])
    t.mutex.Lock()
    closest := t.closest(target, bucketSize).entries
    t.mutex.Unlock()

    // TODO: this conversion could use a cached version of the slice
    closestrpc := make([]rpcNode, len(closest))
    for i, n := range closest {
        closestrpc[i] = nodeToRPC(n)
    }
    t.send(from, neighborsPacket, neighbors{
        Nodes:      closestrpc,
        Expiration: uint64(time.Now().Add(expiration).Unix()),
    })
    return nil
}

func (req *neighbors) handle(t *udp, from *net.UDPAddr, fromID NodeID, mac []byte) error {
    if expired(req.Expiration) {
        return errExpired
    }
    if !t.handleReply(fromID, neighborsPacket, req) {
        return errUnsolicitedReply
    }
    return nil
}

func expired(ts uint64) bool {
    return time.Unix(int64(ts), 0).Before(time.Now())
}