from __future__ import annotations from typing import Awaitable, Callable from pysphinx.sphinx import ( ProcessedFinalHopPacket, ProcessedForwardHopPacket, SphinxPacket, ) from framework import Framework, Queue from protocol.config import GlobalConfig, NodeConfig from protocol.connection import SimplexConnection from protocol.error import PeeringDegreeReached from protocol.gossip import Gossip from protocol.nomssip import Nomssip, NomssipConfig from protocol.sphinx import SphinxPacketBuilder class Node: """ This represents any node in the network, which: - generates/gossips mix messages (Sphinx packets) - performs cryptographic mix (unwrapping Sphinx packets) - generates noise """ def __init__( self, framework: Framework, config: NodeConfig, global_config: GlobalConfig, # A handler called when a node receives a broadcasted message originated from the last mix. broadcasted_msg_handler: Callable[[bytes], Awaitable[None]], # An optional handler only for the simulation, # which is called when a message is fully recovered by the last mix # and returns a new message to be broadcasted. recovered_msg_handler: Callable[[bytes], Awaitable[bytes]] | None = None, ): self.framework = framework self.config = config self.global_config = global_config self.nomssip = Nomssip( framework, NomssipConfig( config.gossip.peering_degree, global_config.transmission_rate_per_sec, self.__calculate_message_size(global_config), config.temporal_mix, ), self.__process_msg, ) self.broadcast = Gossip(framework, config.gossip, broadcasted_msg_handler) self.recovered_msg_handler = recovered_msg_handler @staticmethod def __calculate_message_size(global_config: GlobalConfig) -> int: """ Calculate the actual message size to be gossiped, which depends on the maximum length of mix path. """ sample_sphinx_packet, _ = SphinxPacketBuilder.build( bytes(global_config.max_message_size), global_config, global_config.max_mix_path_length, ) return len(sample_sphinx_packet.bytes()) async def __process_msg(self, msg: bytes) -> None: """ A handler to process messages received via Nomssip channel """ sphinx_packet = SphinxPacket.from_bytes( msg, self.global_config.max_mix_path_length ) result = await self.__process_sphinx_packet(sphinx_packet) match result: case SphinxPacket(): # Gossip the next Sphinx packet await self.nomssip.gossip(result.bytes()) case bytes(): if self.recovered_msg_handler is not None: result = await self.recovered_msg_handler(result) # Broadcast the message fully recovered from Sphinx packets await self.broadcast.gossip(result) case None: return async def __process_sphinx_packet( self, packet: SphinxPacket ) -> SphinxPacket | bytes | None: """ Unwrap the Sphinx packet and process the next Sphinx packet or the payload if possible """ try: processed = packet.process(self.config.private_key) match processed: case ProcessedForwardHopPacket(): return processed.next_packet case ProcessedFinalHopPacket(): return processed.payload.recover_plain_playload() except ValueError: # Return nothing, if it cannot be unwrapped by the private key of this node. return None def connect_mix( self, peer: Node, inbound_conn: SimplexConnection, outbound_conn: SimplexConnection, ): Node.__connect(self.nomssip, peer.nomssip, inbound_conn, outbound_conn) def connect_broadcast( self, peer: Node, inbound_conn: SimplexConnection, outbound_conn: SimplexConnection, ): Node.__connect(self.broadcast, peer.broadcast, inbound_conn, outbound_conn) @staticmethod def __connect( self_channel: Gossip, peer_channel: Gossip, inbound_conn: SimplexConnection, outbound_conn: SimplexConnection, ): """ Establish a duplex connection with a peer node. """ if not self_channel.can_accept_conn() or not peer_channel.can_accept_conn(): raise PeeringDegreeReached() # Register a duplex connection for its own use self_channel.add_conn(inbound_conn, outbound_conn) # Register a duplex connection for the peer peer_channel.add_conn(outbound_conn, inbound_conn) async def send_message(self, msg: bytes): """ Build a Sphinx packet and gossip it to all connected peers. """ # Here, we handle the case in which a msg is split into multiple Sphinx packets. # But, in practice, we expect a message to be small enough to fit in a single Sphinx packet. sphinx_packet, _ = SphinxPacketBuilder.build( msg, self.global_config, self.config.mix_path_length, ) await self.nomssip.gossip(sphinx_packet.bytes())