Build fuzzing tests in CI and fix current fuzzing tests (#396)

* Build fuzzing tests in CI and fix current fuzzing tests

* Build fuzzing tests separately (fix Windows CI)

.github/workflows/ci.yml

@@ -237,3 +237,4 @@ jobs:
           nimble install -y --depsOnly
           nimble test
           nimble build_dcli
+          nimble build_fuzzers

eth.nimble

@@ -90,3 +90,16 @@ task test_discv5_full, "Run discovery v5 and its dependencies tests":
 
 task build_dcli, "Build dcli":
   buildBinary("eth/p2p/discoveryv5/dcli")
+
+import os, strutils
+
+task build_fuzzers, "Build fuzzer test cases":
+  # This file is there to be able to quickly build the fuzzer test cases in
+  # order to avoid bit rot (e.g. for CI). Not for actual fuzzing.
+  # TODO: Building fuzzer test case one by one will make it take a bit longer,
+  # but we cannot import them in one Nim file due to the usage of
+  # `exportc: "AFLmain"` in the fuzzing test template for Windows:
+  # https://github.com/status-im/nim-testutils/blob/master/testutils/fuzzing.nim#L100
+  for file in walkDirRec("tests/fuzzing/"):
+    if file.endsWith("nim"):
+      buildBinary(file)

eth/p2p/blockchain_utils.nim

@@ -6,7 +6,7 @@
 # at your option. This file may not be copied, modified, or distributed except according to those terms.
 
 import
-  eth/common/[eth_types, state_accessors]
+  ../common/[eth_types, state_accessors]
 
 # TODO: Perhaps we can move this to eth-common
 

tests/fuzzing/discovery/fuzz.nim

@@ -1,11 +1,18 @@
 import
-  testutils/fuzzing, chronicles,
-  eth/p2p/[discovery, enode], eth/[keys, rlp],
+  testutils/fuzzing, chronicles, nimcrypto/keccak,
+  ../../../eth/p2p/[discovery, enode], ../../../eth/[keys, rlp],
   ../../p2p/p2p_test_helper
 
 const DefaultListeningPort = 30303
 var targetNode: DiscoveryProtocol
 
+proc packData(payload: openArray[byte], pk: PrivateKey): seq[byte] =
+  let
+    payloadSeq = @payload
+    signature = @(pk.sign(payload).toRaw())
+    msgHash = keccak256.digest(signature & payloadSeq)
+  result = @(msgHash.data) & signature & payloadSeq
+
 init:
   # Set up a discovery node, this is the node we target when fuzzing
   var

tests/fuzzing/discovery/generate.nim

@@ -1,17 +1,13 @@
 import
-  chronos, times, stew/byteutils, stint, chronicles, streams, nimcrypto, os,
-  strformat, strutils, eth/p2p/[discovery, kademlia], eth/[keys, rlp],
-  ../../p2p/p2p_test_helper
+  std/[times, os, strformat, strutils],
+  chronos, stew/byteutils, stint, chronicles, nimcrypto,
+  ../../../eth/p2p/[discovery, kademlia], ../../../eth/[keys, rlp],
+  ../../p2p/p2p_test_helper,
+  ../fuzzing_helpers
 
 template sourceDir: string = currentSourcePath.rsplit(DirSep, 1)[0]
 const inputsDir = &"{sourceDir}{DirSep}generated-input{DirSep}"
 
-proc toFile(data: Bytes, fn: string) =
-  var s = newFileStream(fn, fmWrite)
-  for x in data:
-    s.write(x)
-  s.close()
-
 const EXPIRATION = 3600 * 24 * 365 * 10
 proc expiration(): uint32 = uint32(epochTime() + EXPIRATION)
 
@@ -32,7 +28,7 @@ proc generate() =
 
   # valid data for a Pong packet
   block:
-    let token = keccak256.digest(@[0])
+    let token = keccak256.digest(@[byte 0])
     let payload = rlp.encode((toAddr, token , expiration()))
     let encodedData = @[2.byte] & payload
     debug "Pong", data=byteutils.toHex(encodedData)
@@ -42,9 +38,9 @@ proc generate() =
   # valid data for a FindNode packet
   block:
     var data: array[64, byte]
-    data[32 .. ^1] = peerKey.toPublicKey().tryGet().toNodeId().toByteArrayBE()
+    data[32 .. ^1] = peerKey.toPublicKey().toNodeId().toByteArrayBE()
     let payload = rlp.encode((data, expiration()))
-    let encodedData = @[3.byte] & payload.toSeq()
+    let encodedData = @[3.byte] & @payload
     debug "FindNode", data=byteutils.toHex(encodedData)
 
     encodedData.toFile(inputsDir & "findnode")
@@ -62,11 +58,11 @@ proc generate() =
     type Neighbour = tuple[ip: IpAddress, udpPort, tcpPort: Port, pk: PublicKey]
     var nodes = newSeqOfCap[Neighbour](2)
 
-    nodes.add((n1Addr.ip, n1Addr.udpPort, n1Addr.tcpPort, n1Key.toPublicKey().tryGet()))
-    nodes.add((n2Addr.ip, n2Addr.udpPort, n2Addr.tcpPort, n2Key.toPublicKey().tryGet()))
+    nodes.add((n1Addr.ip, n1Addr.udpPort, n1Addr.tcpPort, n1Key.toPublicKey()))
+    nodes.add((n2Addr.ip, n2Addr.udpPort, n2Addr.tcpPort, n2Key.toPublicKey()))
 
     let payload = rlp.encode((nodes, expiration()))
-    let encodedData = @[4.byte] & payload.toSeq()
+    let encodedData = @[4.byte] & @payload
     debug "Neighbours", data=byteutils.toHex(encodedData)
 
     encodedData.toFile(inputsDir & "neighbours")

tests/fuzzing/discoveryv5/fuzz_decode_message.nim

@@ -1,6 +1,6 @@
 import
-  testutils/fuzzing, stew/byteutils,
-  eth/rlp, eth/p2p/discoveryv5/[encoding, messages]
+  testutils/fuzzing,
+  ../../../eth/rlp, ../../../eth/p2p/discoveryv5/[encoding, messages]
 
 test:
   block:

tests/fuzzing/discoveryv5/fuzz_decode_packet.nim

@@ -1,6 +1,6 @@
 import
-  testutils/fuzzing, stew/shims/net, stew/byteutils,
-  eth/p2p/discoveryv5/[encoding, enr, sessions, node]
+  testutils/fuzzing, stew/shims/net,
+  ../../../eth/p2p/discoveryv5/[encoding, enr, sessions, node]
 
 init:
   const

tests/fuzzing/enr/fuzz_enr.nim

@@ -1,6 +1,6 @@
 import
   testutils/fuzzing, stew/byteutils,
-  eth/rlp, eth/p2p/discoveryv5/enr
+  ../../../eth/rlp, ../../../eth/p2p/discoveryv5/enr
 
 test:
   block:

tests/fuzzing/enr/generate.nim

@@ -1,7 +1,7 @@
 import
   std/[os, strutils, options],
   stew/shims/net,
-  eth/keys, eth/p2p/discoveryv5/enr,
+  ../../../eth/keys, ../../../eth/p2p/discoveryv5/enr,
   ../fuzzing_helpers
 
 template sourceDir: string = currentSourcePath.rsplit(DirSep, 1)[0]
@@ -12,7 +12,7 @@ proc generate() =
     rng = newRng()
     privKey = PrivateKey.random(rng[])
     ip = some(ValidIpAddress.init("127.0.0.1"))
-    port = Port(20301)
+    port = some(Port(20301))
 
   block:
     let record = enr.Record.init(1, privKey, ip, port, port)[]

tests/fuzzing/fuzzing_helpers.nim

@@ -1,5 +1,5 @@
 import
-    std/streams
+  std/streams
 
 proc toFile*(data: seq[byte], fn: string) =
   var s = newFileStream(fn, fmWrite)

tests/fuzzing/rlp/rlp_decode.nim

@@ -1,6 +1,6 @@
 import
   testutils/fuzzing, chronicles,
-  eth/rlp
+  ../../../eth/rlp
 
 type
   TestEnum = enum

tests/fuzzing/rlp/rlp_inspect.nim

@@ -1,6 +1,6 @@
 import
   testutils/fuzzing, chronicles,
-  eth/rlp
+  ../../../eth/rlp
 
 test:
   try:

tests/fuzzing/rlpx/thunk.nim

@@ -1,8 +1,8 @@
 import
   testutils/fuzzing, chronos,
-  eth/p2p, eth/p2p/rlpx, eth/p2p/private/p2p_types,
-  eth/p2p/rlpx_protocols/[whisper_protocol, eth_protocol],
-  ../p2p/p2p_test_helper
+  ../../../eth/p2p, ../../../eth/p2p/rlpx, ../../../eth/p2p/private/p2p_types,
+  ../../../eth/p2p/rlpx_protocols/[whisper_protocol, eth_protocol],
+  ../../p2p/p2p_test_helper
 
 var
   node1: EthereumNode

tests/fuzzing/whisper/encode_decode.nim

@@ -1,13 +1,15 @@
 import
-  options, sequtils, chronicles,
-  eth/p2p/rlpx_protocols/whisper_protocol as whisper,
-  ../fuzztest
+  std/[options, sequtils],
+  chronicles, testutils/fuzzing,
+  ../../../eth/p2p/rlpx_protocols/whisper_protocol as whisper,
+  ../../../eth/keys
 
 test:
   let
+    rng = newRng()
     data = @payload.distribute(2)
     whisperPayload = Payload(payload: data[0], padding: some(data[1]))
-    encoded = whisper.encode(whisperPayload)
+    encoded = whisper.encode(rng[], whisperPayload)
 
     decoded = whisper.decode(encoded.get())