logos-messaging/logos-messaging-nim
1
0
Fork 0
mirror of https://github.com/logos-messaging/logos-messaging-nim.git synced 2026-01-06 16:03:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(rpc): fix out of bound when empty multiadd (#1507)

Browse Source
This commit is contained in:
Alvaro Revuelta 2023-01-26 12:05:25 +01:00 committed by GitHub
parent bf532eea8b
commit 7ea15ecfdb
2 changed files with 37 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
tests/v2/test_jsonrpc_waku.nim
View File

@ -14,6 +14,7 @@ import
libp2p/protocols/pubsub/rpc/message libp2p/protocols/pubsub/rpc/message
import import
../../waku/v1/node/rpc/hexstrings, ../../waku/v1/node/rpc/hexstrings,
../../waku/v2/node/peer_manager/peer_manager,
../../waku/v2/node/waku_node, ../../waku/v2/node/waku_node,
../../waku/v2/node/jsonrpc/[store_api, ../../waku/v2/node/jsonrpc/[store_api,
relay_api, relay_api,
@ -33,7 +34,8 @@ import
../../waku/v2/protocol/waku_filter/client, ../../waku/v2/protocol/waku_filter/client,
../../waku/v2/utils/peers, ../../waku/v2/utils/peers,
../../waku/v2/utils/time, ../../waku/v2/utils/time,
./testlib/common ./testlib/common,
../test_helpers
template sourceDir*: string = currentSourcePath.rsplit(DirSep, 1)[0] template sourceDir*: string = currentSourcePath.rsplit(DirSep, 1)[0]
const sigPath = sourceDir / ParDir / ParDir / "waku" / "v2" / "node" / "jsonrpc" / "jsonrpc_callsigs.nim" const sigPath = sourceDir / ParDir / ParDir / "waku" / "v2" / "node" / "jsonrpc" / "jsonrpc_callsigs.nim"
@ -404,26 +406,14 @@ procSuite "Waku v2 JSON-RPC API":
await allFutures([node1.stop(), node2.stop(), node3.stop()]) await allFutures([node1.stop(), node2.stop(), node3.stop()])
asyncTest "Admin API: get managed peer information": asyncTest "Admin API: get managed peer information":
# Create a couple of nodes # Create 3 nodes and start them with relay
let let nodes = toSeq(0..<3).mapIt(WakuNode.new(generateKey(), ValidIpAddress.init("0.0.0.0"), Port(60220+it*2)))
nodeKey1 = crypto.PrivateKey.random(Secp256k1, rng[])[] await allFutures(nodes.mapIt(it.start()))
node1 = WakuNode.new(nodeKey1, ValidIpAddress.init("0.0.0.0"), Port(60220)) await allFutures(nodes.mapIt(it.mountRelay()))
nodeKey2 = crypto.PrivateKey.random(Secp256k1, rng[])[]
node2 = WakuNode.new(nodeKey2, ValidIpAddress.init("0.0.0.0"), Port(60222))
peerInfo2 = node2.peerInfo
nodeKey3 = crypto.PrivateKey.random(Secp256k1, rng[])[]
node3 = WakuNode.new(nodeKey3, ValidIpAddress.init("0.0.0.0"), Port(60224))
peerInfo3 = node3.peerInfo
await allFutures([node1.start(), node2.start(), node3.start()])
await node1.mountRelay()
await node2.mountRelay()
await node3.mountRelay()
# Dial nodes 2 and 3 from node1 # Dial nodes 2 and 3 from node1
await node1.connectToNodes(@[constructMultiaddrStr(peerInfo2)]) await nodes[0].connectToNodes(@[constructMultiaddrStr(nodes[1].peerInfo)])
await node1.connectToNodes(@[constructMultiaddrStr(peerInfo3)]) await nodes[0].connectToNodes(@[constructMultiaddrStr(nodes[2].peerInfo)])
# RPC server setup # RPC server setup
let let
@ -431,7 +421,7 @@ procSuite "Waku v2 JSON-RPC API":
ta = initTAddress(bindIp, rpcPort) ta = initTAddress(bindIp, rpcPort)
server = newRpcHttpServer([ta]) server = newRpcHttpServer([ta])
installAdminApiHandlers(node1, server) installAdminApiHandlers(nodes[0], server)
server.start() server.start()
let client = newRpcHttpClient() let client = newRpcHttpClient()
@ -443,15 +433,25 @@ procSuite "Waku v2 JSON-RPC API":
response.len == 2 response.len == 2
# Check peer 2 # Check peer 2
response.anyIt(it.protocol == WakuRelayCodec and response.anyIt(it.protocol == WakuRelayCodec and
it.multiaddr == constructMultiaddrStr(peerInfo2)) it.multiaddr == constructMultiaddrStr(nodes[1].peerInfo))
# Check peer 3 # Check peer 3
response.anyIt(it.protocol == WakuRelayCodec and response.anyIt(it.protocol == WakuRelayCodec and
it.multiaddr == constructMultiaddrStr(peerInfo3)) it.multiaddr == constructMultiaddrStr(nodes[2].peerInfo))
# Artificially remove the address from the book
nodes[0].peerManager.peerStore[AddressBook][nodes[1].peerInfo.peerId] = @[]
nodes[0].peerManager.peerStore[AddressBook][nodes[2].peerInfo.peerId] = @[]
# Verify that the returned addresses are empty
let responseEmptyAdd = await client.get_waku_v2_admin_v1_peers()
check:
responseEmptyAdd[0].multiaddr == ""
responseEmptyAdd[1].multiaddr == ""
await server.stop() await server.stop()
await server.closeWait() await server.closeWait()
await allFutures([node1.stop(), node2.stop(), node3.stop()]) await allFutures(nodes.mapIt(it.stop()))
asyncTest "Admin API: get unmanaged peer information": asyncTest "Admin API: get unmanaged peer information":
let let

18
waku/v2/node/jsonrpc/admin_api.nim
View File

@ -30,12 +30,22 @@ proc constructMultiaddrStr*(wireaddr: MultiAddress, peerId: PeerId): string =
proc constructMultiaddrStr*(peerInfo: PeerInfo): string = proc constructMultiaddrStr*(peerInfo: PeerInfo): string =
# Constructs a multiaddress with both location (wire) address and p2p identity # Constructs a multiaddress with both location (wire) address and p2p identity
if peerInfo.listenAddrs.len == 0:
return ""
constructMultiaddrStr(peerInfo.listenAddrs[0], peerInfo.peerId) constructMultiaddrStr(peerInfo.listenAddrs[0], peerInfo.peerId)
proc constructMultiaddrStr*(remotePeerInfo: RemotePeerInfo): string = proc constructMultiaddrStr*(remotePeerInfo: RemotePeerInfo): string =
# Constructs a multiaddress with both location (wire) address and p2p identity # Constructs a multiaddress with both location (wire) address and p2p identity
if remotePeerInfo.addrs.len == 0:
return ""
constructMultiaddrStr(remotePeerInfo.addrs[0], remotePeerInfo.peerId) constructMultiaddrStr(remotePeerInfo.addrs[0], remotePeerInfo.peerId)
proc constructMultiaddrStr*(storedInfo: StoredInfo): string =
# Constructs a multiaddress with both location (wire) address and p2p identity
if storedInfo.addrs.len == 0:
return ""
constructMultiaddrStr(storedInfo.addrs[0], storedInfo.peerId)
proc installAdminApiHandlers*(node: WakuNode, rpcsrv: RpcServer) = proc installAdminApiHandlers*(node: WakuNode, rpcsrv: RpcServer) =
## Admin API version 1 definitions ## Admin API version 1 definitions
@ -65,7 +75,7 @@ proc installAdminApiHandlers*(node: WakuNode, rpcsrv: RpcServer) =
# Map managed peers to WakuPeers and add to return list # Map managed peers to WakuPeers and add to return list
wPeers.insert(node.peerManager.peerStore wPeers.insert(node.peerManager.peerStore
.peers(WakuRelayCodec) .peers(WakuRelayCodec)
.mapIt(WakuPeer(multiaddr: constructMultiaddrStr(toSeq(it.addrs.items)[0], it.peerId), .mapIt(WakuPeer(multiaddr: constructMultiaddrStr(it),
protocol: WakuRelayCodec, protocol: WakuRelayCodec,
connected: it.connectedness == Connectedness.Connected)), connected: it.connectedness == Connectedness.Connected)),
wPeers.len) # Append to the end of the sequence wPeers.len) # Append to the end of the sequence
@ -74,7 +84,7 @@ proc installAdminApiHandlers*(node: WakuNode, rpcsrv: RpcServer) =
# Map WakuFilter peers to WakuPeers and add to return list # Map WakuFilter peers to WakuPeers and add to return list
wPeers.insert(node.peerManager.peerStore wPeers.insert(node.peerManager.peerStore
.peers(WakuFilterCodec) .peers(WakuFilterCodec)
.mapIt(WakuPeer(multiaddr: constructMultiaddrStr(toSeq(it.addrs.items)[0], it.peerId), .mapIt(WakuPeer(multiaddr: constructMultiaddrStr(it),
protocol: WakuFilterCodec, protocol: WakuFilterCodec,
connected: it.connectedness == Connectedness.Connected)), connected: it.connectedness == Connectedness.Connected)),
wPeers.len) # Append to the end of the sequence wPeers.len) # Append to the end of the sequence
@ -83,7 +93,7 @@ proc installAdminApiHandlers*(node: WakuNode, rpcsrv: RpcServer) =
# Map WakuSwap peers to WakuPeers and add to return list # Map WakuSwap peers to WakuPeers and add to return list
wPeers.insert(node.peerManager.peerStore wPeers.insert(node.peerManager.peerStore
.peers(WakuSwapCodec) .peers(WakuSwapCodec)
.mapIt(WakuPeer(multiaddr: constructMultiaddrStr(toSeq(it.addrs.items)[0], it.peerId), .mapIt(WakuPeer(multiaddr: constructMultiaddrStr(it),
protocol: WakuSwapCodec, protocol: WakuSwapCodec,
connected: it.connectedness == Connectedness.Connected)), connected: it.connectedness == Connectedness.Connected)),
wPeers.len) # Append to the end of the sequence wPeers.len) # Append to the end of the sequence
@ -92,7 +102,7 @@ proc installAdminApiHandlers*(node: WakuNode, rpcsrv: RpcServer) =
# Map WakuStore peers to WakuPeers and add to return list # Map WakuStore peers to WakuPeers and add to return list
wPeers.insert(node.peerManager.peerStore wPeers.insert(node.peerManager.peerStore
.peers(WakuStoreCodec) .peers(WakuStoreCodec)
.mapIt(WakuPeer(multiaddr: constructMultiaddrStr(toSeq(it.addrs.items)[0], it.peerId), .mapIt(WakuPeer(multiaddr: constructMultiaddrStr(it),
protocol: WakuStoreCodec, protocol: WakuStoreCodec,
connected: it.connectedness == Connectedness.Connected)), connected: it.connectedness == Connectedness.Connected)),
wPeers.len) # Append to the end of the sequence wPeers.len) # Append to the end of the sequence