github.com/authcall/reference-optimistic-geth@v0.0.0-20220816224302-06313bfeb8d2/p2p/discover/v5wire/encoding_test.go (about) 1 // Copyright 2020 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 // it under the terms of the GNU Lesser General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 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 // GNU Lesser General Public License for more details. 13 // 14 // 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 v5wire 18 19 import ( 20 "bytes" 21 "crypto/ecdsa" 22 "encoding/hex" 23 "errors" 24 "flag" 25 "fmt" 26 "net" 27 "os" 28 "path/filepath" 29 "strings" 30 "testing" 31 32 "github.com/davecgh/go-spew/spew" 33 "github.com/ethereum/go-ethereum/common/hexutil" 34 "github.com/ethereum/go-ethereum/common/mclock" 35 "github.com/ethereum/go-ethereum/crypto" 36 "github.com/ethereum/go-ethereum/p2p/enode" 37 ) 38 39 // To regenerate discv5 test vectors, run 40 // 41 // go test -run TestVectors -write-test-vectors 42 // 43 var writeTestVectorsFlag = flag.Bool("write-test-vectors", false, "Overwrite discv5 test vectors in testdata/") 44 45 var ( 46 testKeyA, _ = crypto.HexToECDSA("eef77acb6c6a6eebc5b363a475ac583ec7eccdb42b6481424c60f59aa326547f") 47 testKeyB, _ = crypto.HexToECDSA("66fb62bfbd66b9177a138c1e5cddbe4f7c30c343e94e68df8769459cb1cde628") 48 testEphKey, _ = crypto.HexToECDSA("0288ef00023598499cb6c940146d050d2b1fb914198c327f76aad590bead68b6") 49 testIDnonce = [16]byte{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16} 50 ) 51 52 // This test checks that the minPacketSize and randomPacketMsgSize constants are well-defined. 53 func TestMinSizes(t *testing.T) { 54 var ( 55 gcmTagSize = 16 56 emptyMsg = sizeofMessageAuthData + gcmTagSize 57 ) 58 t.Log("static header size", sizeofStaticPacketData) 59 t.Log("whoareyou size", sizeofStaticPacketData+sizeofWhoareyouAuthData) 60 t.Log("empty msg size", sizeofStaticPacketData+emptyMsg) 61 if want := emptyMsg; minMessageSize != want { 62 t.Fatalf("wrong minMessageSize %d, want %d", minMessageSize, want) 63 } 64 if sizeofMessageAuthData+randomPacketMsgSize < minMessageSize { 65 t.Fatalf("randomPacketMsgSize %d too small", randomPacketMsgSize) 66 } 67 } 68 69 // This test checks the basic handshake flow where A talks to B and A has no secrets. 70 func TestHandshake(t *testing.T) { 71 t.Parallel() 72 net := newHandshakeTest() 73 defer net.close() 74 75 // A -> B RANDOM PACKET 76 packet, _ := net.nodeA.encode(t, net.nodeB, &Findnode{}) 77 resp := net.nodeB.expectDecode(t, UnknownPacket, packet) 78 79 // A <- B WHOAREYOU 80 challenge := &Whoareyou{ 81 Nonce: resp.(*Unknown).Nonce, 82 IDNonce: testIDnonce, 83 RecordSeq: 0, 84 } 85 whoareyou, _ := net.nodeB.encode(t, net.nodeA, challenge) 86 net.nodeA.expectDecode(t, WhoareyouPacket, whoareyou) 87 88 // A -> B FINDNODE (handshake packet) 89 findnode, _ := net.nodeA.encodeWithChallenge(t, net.nodeB, challenge, &Findnode{}) 90 net.nodeB.expectDecode(t, FindnodeMsg, findnode) 91 if len(net.nodeB.c.sc.handshakes) > 0 { 92 t.Fatalf("node B didn't remove handshake from challenge map") 93 } 94 95 // A <- B NODES 96 nodes, _ := net.nodeB.encode(t, net.nodeA, &Nodes{Total: 1}) 97 net.nodeA.expectDecode(t, NodesMsg, nodes) 98 } 99 100 // This test checks that handshake attempts are removed within the timeout. 101 func TestHandshake_timeout(t *testing.T) { 102 t.Parallel() 103 net := newHandshakeTest() 104 defer net.close() 105 106 // A -> B RANDOM PACKET 107 packet, _ := net.nodeA.encode(t, net.nodeB, &Findnode{}) 108 resp := net.nodeB.expectDecode(t, UnknownPacket, packet) 109 110 // A <- B WHOAREYOU 111 challenge := &Whoareyou{ 112 Nonce: resp.(*Unknown).Nonce, 113 IDNonce: testIDnonce, 114 RecordSeq: 0, 115 } 116 whoareyou, _ := net.nodeB.encode(t, net.nodeA, challenge) 117 net.nodeA.expectDecode(t, WhoareyouPacket, whoareyou) 118 119 // A -> B FINDNODE (handshake packet) after timeout 120 net.clock.Run(handshakeTimeout + 1) 121 findnode, _ := net.nodeA.encodeWithChallenge(t, net.nodeB, challenge, &Findnode{}) 122 net.nodeB.expectDecodeErr(t, errUnexpectedHandshake, findnode) 123 } 124 125 // This test checks handshake behavior when no record is sent in the auth response. 126 func TestHandshake_norecord(t *testing.T) { 127 t.Parallel() 128 net := newHandshakeTest() 129 defer net.close() 130 131 // A -> B RANDOM PACKET 132 packet, _ := net.nodeA.encode(t, net.nodeB, &Findnode{}) 133 resp := net.nodeB.expectDecode(t, UnknownPacket, packet) 134 135 // A <- B WHOAREYOU 136 nodeA := net.nodeA.n() 137 if nodeA.Seq() == 0 { 138 t.Fatal("need non-zero sequence number") 139 } 140 challenge := &Whoareyou{ 141 Nonce: resp.(*Unknown).Nonce, 142 IDNonce: testIDnonce, 143 RecordSeq: nodeA.Seq(), 144 Node: nodeA, 145 } 146 whoareyou, _ := net.nodeB.encode(t, net.nodeA, challenge) 147 net.nodeA.expectDecode(t, WhoareyouPacket, whoareyou) 148 149 // A -> B FINDNODE 150 findnode, _ := net.nodeA.encodeWithChallenge(t, net.nodeB, challenge, &Findnode{}) 151 net.nodeB.expectDecode(t, FindnodeMsg, findnode) 152 153 // A <- B NODES 154 nodes, _ := net.nodeB.encode(t, net.nodeA, &Nodes{Total: 1}) 155 net.nodeA.expectDecode(t, NodesMsg, nodes) 156 } 157 158 // In this test, A tries to send FINDNODE with existing secrets but B doesn't know 159 // anything about A. 160 func TestHandshake_rekey(t *testing.T) { 161 t.Parallel() 162 net := newHandshakeTest() 163 defer net.close() 164 165 session := &session{ 166 readKey: []byte("BBBBBBBBBBBBBBBB"), 167 writeKey: []byte("AAAAAAAAAAAAAAAA"), 168 } 169 net.nodeA.c.sc.storeNewSession(net.nodeB.id(), net.nodeB.addr(), session) 170 171 // A -> B FINDNODE (encrypted with zero keys) 172 findnode, authTag := net.nodeA.encode(t, net.nodeB, &Findnode{}) 173 net.nodeB.expectDecode(t, UnknownPacket, findnode) 174 175 // A <- B WHOAREYOU 176 challenge := &Whoareyou{Nonce: authTag, IDNonce: testIDnonce} 177 whoareyou, _ := net.nodeB.encode(t, net.nodeA, challenge) 178 net.nodeA.expectDecode(t, WhoareyouPacket, whoareyou) 179 180 // Check that new keys haven't been stored yet. 181 sa := net.nodeA.c.sc.session(net.nodeB.id(), net.nodeB.addr()) 182 if !bytes.Equal(sa.writeKey, session.writeKey) || !bytes.Equal(sa.readKey, session.readKey) { 183 t.Fatal("node A stored keys too early") 184 } 185 if s := net.nodeB.c.sc.session(net.nodeA.id(), net.nodeA.addr()); s != nil { 186 t.Fatal("node B stored keys too early") 187 } 188 189 // A -> B FINDNODE encrypted with new keys 190 findnode, _ = net.nodeA.encodeWithChallenge(t, net.nodeB, challenge, &Findnode{}) 191 net.nodeB.expectDecode(t, FindnodeMsg, findnode) 192 193 // A <- B NODES 194 nodes, _ := net.nodeB.encode(t, net.nodeA, &Nodes{Total: 1}) 195 net.nodeA.expectDecode(t, NodesMsg, nodes) 196 } 197 198 // In this test A and B have different keys before the handshake. 199 func TestHandshake_rekey2(t *testing.T) { 200 t.Parallel() 201 net := newHandshakeTest() 202 defer net.close() 203 204 initKeysA := &session{ 205 readKey: []byte("BBBBBBBBBBBBBBBB"), 206 writeKey: []byte("AAAAAAAAAAAAAAAA"), 207 } 208 initKeysB := &session{ 209 readKey: []byte("CCCCCCCCCCCCCCCC"), 210 writeKey: []byte("DDDDDDDDDDDDDDDD"), 211 } 212 net.nodeA.c.sc.storeNewSession(net.nodeB.id(), net.nodeB.addr(), initKeysA) 213 net.nodeB.c.sc.storeNewSession(net.nodeA.id(), net.nodeA.addr(), initKeysB) 214 215 // A -> B FINDNODE encrypted with initKeysA 216 findnode, authTag := net.nodeA.encode(t, net.nodeB, &Findnode{Distances: []uint{3}}) 217 net.nodeB.expectDecode(t, UnknownPacket, findnode) 218 219 // A <- B WHOAREYOU 220 challenge := &Whoareyou{Nonce: authTag, IDNonce: testIDnonce} 221 whoareyou, _ := net.nodeB.encode(t, net.nodeA, challenge) 222 net.nodeA.expectDecode(t, WhoareyouPacket, whoareyou) 223 224 // A -> B FINDNODE (handshake packet) 225 findnode, _ = net.nodeA.encodeWithChallenge(t, net.nodeB, challenge, &Findnode{}) 226 net.nodeB.expectDecode(t, FindnodeMsg, findnode) 227 228 // A <- B NODES 229 nodes, _ := net.nodeB.encode(t, net.nodeA, &Nodes{Total: 1}) 230 net.nodeA.expectDecode(t, NodesMsg, nodes) 231 } 232 233 func TestHandshake_BadHandshakeAttack(t *testing.T) { 234 t.Parallel() 235 net := newHandshakeTest() 236 defer net.close() 237 238 // A -> B RANDOM PACKET 239 packet, _ := net.nodeA.encode(t, net.nodeB, &Findnode{}) 240 resp := net.nodeB.expectDecode(t, UnknownPacket, packet) 241 242 // A <- B WHOAREYOU 243 challenge := &Whoareyou{ 244 Nonce: resp.(*Unknown).Nonce, 245 IDNonce: testIDnonce, 246 RecordSeq: 0, 247 } 248 whoareyou, _ := net.nodeB.encode(t, net.nodeA, challenge) 249 net.nodeA.expectDecode(t, WhoareyouPacket, whoareyou) 250 251 // A -> B FINDNODE 252 incorrect_challenge := &Whoareyou{ 253 IDNonce: [16]byte{5, 6, 7, 8, 9, 6, 11, 12}, 254 RecordSeq: challenge.RecordSeq, 255 Node: challenge.Node, 256 sent: challenge.sent, 257 } 258 incorrect_findnode, _ := net.nodeA.encodeWithChallenge(t, net.nodeB, incorrect_challenge, &Findnode{}) 259 incorrect_findnode2 := make([]byte, len(incorrect_findnode)) 260 copy(incorrect_findnode2, incorrect_findnode) 261 262 net.nodeB.expectDecodeErr(t, errInvalidNonceSig, incorrect_findnode) 263 264 // Reject new findnode as previous handshake is now deleted. 265 net.nodeB.expectDecodeErr(t, errUnexpectedHandshake, incorrect_findnode2) 266 267 // The findnode packet is again rejected even with a valid challenge this time. 268 findnode, _ := net.nodeA.encodeWithChallenge(t, net.nodeB, challenge, &Findnode{}) 269 net.nodeB.expectDecodeErr(t, errUnexpectedHandshake, findnode) 270 } 271 272 // This test checks some malformed packets. 273 func TestDecodeErrorsV5(t *testing.T) { 274 t.Parallel() 275 net := newHandshakeTest() 276 defer net.close() 277 278 net.nodeA.expectDecodeErr(t, errTooShort, []byte{}) 279 // TODO some more tests would be nice :) 280 // - check invalid authdata sizes 281 // - check invalid handshake data sizes 282 } 283 284 // This test checks that all test vectors can be decoded. 285 func TestTestVectorsV5(t *testing.T) { 286 var ( 287 idA = enode.PubkeyToIDV4(&testKeyA.PublicKey) 288 idB = enode.PubkeyToIDV4(&testKeyB.PublicKey) 289 addr = "127.0.0.1" 290 session = &session{ 291 writeKey: hexutil.MustDecode("0x00000000000000000000000000000000"), 292 readKey: hexutil.MustDecode("0x01010101010101010101010101010101"), 293 } 294 challenge0A, challenge1A, challenge0B Whoareyou 295 ) 296 297 // Create challenge packets. 298 c := Whoareyou{ 299 Nonce: Nonce{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12}, 300 IDNonce: testIDnonce, 301 } 302 challenge0A, challenge1A, challenge0B = c, c, c 303 challenge1A.RecordSeq = 1 304 net := newHandshakeTest() 305 challenge0A.Node = net.nodeA.n() 306 challenge0B.Node = net.nodeB.n() 307 challenge1A.Node = net.nodeA.n() 308 net.close() 309 310 type testVectorTest struct { 311 name string // test vector name 312 packet Packet // the packet to be encoded 313 challenge *Whoareyou // handshake challenge passed to encoder 314 prep func(*handshakeTest) // called before encode/decode 315 } 316 tests := []testVectorTest{ 317 { 318 name: "v5.1-whoareyou", 319 packet: &challenge0B, 320 }, 321 { 322 name: "v5.1-ping-message", 323 packet: &Ping{ 324 ReqID: []byte{0, 0, 0, 1}, 325 ENRSeq: 2, 326 }, 327 prep: func(net *handshakeTest) { 328 net.nodeA.c.sc.storeNewSession(idB, addr, session) 329 net.nodeB.c.sc.storeNewSession(idA, addr, session.keysFlipped()) 330 }, 331 }, 332 { 333 name: "v5.1-ping-handshake-enr", 334 packet: &Ping{ 335 ReqID: []byte{0, 0, 0, 1}, 336 ENRSeq: 1, 337 }, 338 challenge: &challenge0A, 339 prep: func(net *handshakeTest) { 340 // Update challenge.Header.AuthData. 341 net.nodeA.c.Encode(idB, "", &challenge0A, nil) 342 net.nodeB.c.sc.storeSentHandshake(idA, addr, &challenge0A) 343 }, 344 }, 345 { 346 name: "v5.1-ping-handshake", 347 packet: &Ping{ 348 ReqID: []byte{0, 0, 0, 1}, 349 ENRSeq: 1, 350 }, 351 challenge: &challenge1A, 352 prep: func(net *handshakeTest) { 353 // Update challenge data. 354 net.nodeA.c.Encode(idB, "", &challenge1A, nil) 355 net.nodeB.c.sc.storeSentHandshake(idA, addr, &challenge1A) 356 }, 357 }, 358 } 359 360 for _, test := range tests { 361 test := test 362 t.Run(test.name, func(t *testing.T) { 363 net := newHandshakeTest() 364 defer net.close() 365 366 // Override all random inputs. 367 net.nodeA.c.sc.nonceGen = func(counter uint32) (Nonce, error) { 368 return Nonce{0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF}, nil 369 } 370 net.nodeA.c.sc.maskingIVGen = func(buf []byte) error { 371 return nil // all zero 372 } 373 net.nodeA.c.sc.ephemeralKeyGen = func() (*ecdsa.PrivateKey, error) { 374 return testEphKey, nil 375 } 376 377 // Prime the codec for encoding/decoding. 378 if test.prep != nil { 379 test.prep(net) 380 } 381 382 file := filepath.Join("testdata", test.name+".txt") 383 if *writeTestVectorsFlag { 384 // Encode the packet. 385 d, nonce := net.nodeA.encodeWithChallenge(t, net.nodeB, test.challenge, test.packet) 386 comment := testVectorComment(net, test.packet, test.challenge, nonce) 387 writeTestVector(file, comment, d) 388 } 389 enc := hexFile(file) 390 net.nodeB.expectDecode(t, test.packet.Kind(), enc) 391 }) 392 } 393 } 394 395 // testVectorComment creates the commentary for discv5 test vector files. 396 func testVectorComment(net *handshakeTest, p Packet, challenge *Whoareyou, nonce Nonce) string { 397 o := new(strings.Builder) 398 printWhoareyou := func(p *Whoareyou) { 399 fmt.Fprintf(o, "whoareyou.challenge-data = %#x\n", p.ChallengeData) 400 fmt.Fprintf(o, "whoareyou.request-nonce = %#x\n", p.Nonce[:]) 401 fmt.Fprintf(o, "whoareyou.id-nonce = %#x\n", p.IDNonce[:]) 402 fmt.Fprintf(o, "whoareyou.enr-seq = %d\n", p.RecordSeq) 403 } 404 405 fmt.Fprintf(o, "src-node-id = %#x\n", net.nodeA.id().Bytes()) 406 fmt.Fprintf(o, "dest-node-id = %#x\n", net.nodeB.id().Bytes()) 407 switch p := p.(type) { 408 case *Whoareyou: 409 // WHOAREYOU packet. 410 printWhoareyou(p) 411 case *Ping: 412 fmt.Fprintf(o, "nonce = %#x\n", nonce[:]) 413 fmt.Fprintf(o, "read-key = %#x\n", net.nodeA.c.sc.session(net.nodeB.id(), net.nodeB.addr()).writeKey) 414 fmt.Fprintf(o, "ping.req-id = %#x\n", p.ReqID) 415 fmt.Fprintf(o, "ping.enr-seq = %d\n", p.ENRSeq) 416 if challenge != nil { 417 // Handshake message packet. 418 fmt.Fprint(o, "\nhandshake inputs:\n\n") 419 printWhoareyou(challenge) 420 fmt.Fprintf(o, "ephemeral-key = %#x\n", testEphKey.D.Bytes()) 421 fmt.Fprintf(o, "ephemeral-pubkey = %#x\n", crypto.CompressPubkey(&testEphKey.PublicKey)) 422 } 423 default: 424 panic(fmt.Errorf("unhandled packet type %T", p)) 425 } 426 return o.String() 427 } 428 429 // This benchmark checks performance of handshake packet decoding. 430 func BenchmarkV5_DecodeHandshakePingSecp256k1(b *testing.B) { 431 net := newHandshakeTest() 432 defer net.close() 433 434 var ( 435 idA = net.nodeA.id() 436 challenge = &Whoareyou{Node: net.nodeB.n()} 437 message = &Ping{ReqID: []byte("reqid")} 438 ) 439 enc, _, err := net.nodeA.c.Encode(net.nodeB.id(), "", message, challenge) 440 if err != nil { 441 b.Fatal("can't encode handshake packet") 442 } 443 challenge.Node = nil // force ENR signature verification in decoder 444 b.ResetTimer() 445 446 input := make([]byte, len(enc)) 447 for i := 0; i < b.N; i++ { 448 copy(input, enc) 449 net.nodeB.c.sc.storeSentHandshake(idA, "", challenge) 450 _, _, _, err := net.nodeB.c.Decode(input, "") 451 if err != nil { 452 b.Fatal(err) 453 } 454 } 455 } 456 457 // This benchmark checks how long it takes to decode an encrypted ping packet. 458 func BenchmarkV5_DecodePing(b *testing.B) { 459 net := newHandshakeTest() 460 defer net.close() 461 462 session := &session{ 463 readKey: []byte{233, 203, 93, 195, 86, 47, 177, 186, 227, 43, 2, 141, 244, 230, 120, 17}, 464 writeKey: []byte{79, 145, 252, 171, 167, 216, 252, 161, 208, 190, 176, 106, 214, 39, 178, 134}, 465 } 466 net.nodeA.c.sc.storeNewSession(net.nodeB.id(), net.nodeB.addr(), session) 467 net.nodeB.c.sc.storeNewSession(net.nodeA.id(), net.nodeA.addr(), session.keysFlipped()) 468 addrB := net.nodeA.addr() 469 ping := &Ping{ReqID: []byte("reqid"), ENRSeq: 5} 470 enc, _, err := net.nodeA.c.Encode(net.nodeB.id(), addrB, ping, nil) 471 if err != nil { 472 b.Fatalf("can't encode: %v", err) 473 } 474 b.ResetTimer() 475 476 input := make([]byte, len(enc)) 477 for i := 0; i < b.N; i++ { 478 copy(input, enc) 479 _, _, packet, _ := net.nodeB.c.Decode(input, addrB) 480 if _, ok := packet.(*Ping); !ok { 481 b.Fatalf("wrong packet type %T", packet) 482 } 483 } 484 } 485 486 var pp = spew.NewDefaultConfig() 487 488 type handshakeTest struct { 489 nodeA, nodeB handshakeTestNode 490 clock mclock.Simulated 491 } 492 493 type handshakeTestNode struct { 494 ln *enode.LocalNode 495 c *Codec 496 } 497 498 func newHandshakeTest() *handshakeTest { 499 t := new(handshakeTest) 500 t.nodeA.init(testKeyA, net.IP{127, 0, 0, 1}, &t.clock) 501 t.nodeB.init(testKeyB, net.IP{127, 0, 0, 1}, &t.clock) 502 return t 503 } 504 505 func (t *handshakeTest) close() { 506 t.nodeA.ln.Database().Close() 507 t.nodeB.ln.Database().Close() 508 } 509 510 func (n *handshakeTestNode) init(key *ecdsa.PrivateKey, ip net.IP, clock mclock.Clock) { 511 db, _ := enode.OpenDB("") 512 n.ln = enode.NewLocalNode(db, key) 513 n.ln.SetStaticIP(ip) 514 n.c = NewCodec(n.ln, key, clock) 515 } 516 517 func (n *handshakeTestNode) encode(t testing.TB, to handshakeTestNode, p Packet) ([]byte, Nonce) { 518 t.Helper() 519 return n.encodeWithChallenge(t, to, nil, p) 520 } 521 522 func (n *handshakeTestNode) encodeWithChallenge(t testing.TB, to handshakeTestNode, c *Whoareyou, p Packet) ([]byte, Nonce) { 523 t.Helper() 524 525 // Copy challenge and add destination node. This avoids sharing 'c' among the two codecs. 526 var challenge *Whoareyou 527 if c != nil { 528 challengeCopy := *c 529 challenge = &challengeCopy 530 challenge.Node = to.n() 531 } 532 // Encode to destination. 533 enc, nonce, err := n.c.Encode(to.id(), to.addr(), p, challenge) 534 if err != nil { 535 t.Fatal(fmt.Errorf("(%s) %v", n.ln.ID().TerminalString(), err)) 536 } 537 t.Logf("(%s) -> (%s) %s\n%s", n.ln.ID().TerminalString(), to.id().TerminalString(), p.Name(), hex.Dump(enc)) 538 return enc, nonce 539 } 540 541 func (n *handshakeTestNode) expectDecode(t *testing.T, ptype byte, p []byte) Packet { 542 t.Helper() 543 544 dec, err := n.decode(p) 545 if err != nil { 546 t.Fatal(fmt.Errorf("(%s) %v", n.ln.ID().TerminalString(), err)) 547 } 548 t.Logf("(%s) %#v", n.ln.ID().TerminalString(), pp.NewFormatter(dec)) 549 if dec.Kind() != ptype { 550 t.Fatalf("expected packet type %d, got %d", ptype, dec.Kind()) 551 } 552 return dec 553 } 554 555 func (n *handshakeTestNode) expectDecodeErr(t *testing.T, wantErr error, p []byte) { 556 t.Helper() 557 if _, err := n.decode(p); !errors.Is(err, wantErr) { 558 t.Fatal(fmt.Errorf("(%s) got err %q, want %q", n.ln.ID().TerminalString(), err, wantErr)) 559 } 560 } 561 562 func (n *handshakeTestNode) decode(input []byte) (Packet, error) { 563 _, _, p, err := n.c.Decode(input, "127.0.0.1") 564 return p, err 565 } 566 567 func (n *handshakeTestNode) n() *enode.Node { 568 return n.ln.Node() 569 } 570 571 func (n *handshakeTestNode) addr() string { 572 return n.ln.Node().IP().String() 573 } 574 575 func (n *handshakeTestNode) id() enode.ID { 576 return n.ln.ID() 577 } 578 579 // hexFile reads the given file and decodes the hex data contained in it. 580 // Whitespace and any lines beginning with the # character are ignored. 581 func hexFile(file string) []byte { 582 fileContent, err := os.ReadFile(file) 583 if err != nil { 584 panic(err) 585 } 586 587 // Gather hex data, ignore comments. 588 var text []byte 589 for _, line := range bytes.Split(fileContent, []byte("\n")) { 590 line = bytes.TrimSpace(line) 591 if len(line) > 0 && line[0] == '#' { 592 continue 593 } 594 text = append(text, line...) 595 } 596 597 // Parse the hex. 598 if bytes.HasPrefix(text, []byte("0x")) { 599 text = text[2:] 600 } 601 data := make([]byte, hex.DecodedLen(len(text))) 602 if _, err := hex.Decode(data, text); err != nil { 603 panic("invalid hex in " + file) 604 } 605 return data 606 } 607 608 // writeTestVector writes a test vector file with the given commentary and binary data. 609 func writeTestVector(file, comment string, data []byte) { 610 fd, err := os.OpenFile(file, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0644) 611 if err != nil { 612 panic(err) 613 } 614 defer fd.Close() 615 616 if len(comment) > 0 { 617 for _, line := range strings.Split(strings.TrimSpace(comment), "\n") { 618 fmt.Fprintf(fd, "# %s\n", line) 619 } 620 fmt.Fprintln(fd) 621 } 622 for len(data) > 0 { 623 var chunk []byte 624 if len(data) < 32 { 625 chunk = data 626 } else { 627 chunk = data[:32] 628 } 629 data = data[len(chunk):] 630 fmt.Fprintf(fd, "%x\n", chunk) 631 } 632 }