use std::{fmt, io, mem}; use crate::crypto; use crate::crypto::Unverified; use crate::identity::Id; use crate::node; use crate::node::{Address, Alias}; use crate::prelude::BoundedVec; use crate::service::filter::Filter; use crate::service::{Link, NodeId, Timestamp}; use crate::storage; use crate::storage::refs::SignedRefs; use crate::storage::{ReadStorage, RemoteRepository as _}; use crate::wire; /// Maximum number of addresses which can be announced to other nodes. pub const ADDRESS_LIMIT: usize = 16; /// Maximum number of repository remotes that can be included in a [`RefsAnnouncement`] message. pub const REF_REMOTE_LIMIT: usize = 512; /// Maximum number of inventory which can be announced to other nodes. pub const INVENTORY_LIMIT: usize = 2973; #[derive(Debug, Clone, PartialEq, Eq)] // TODO: We should check the length and charset when deserializing. pub struct Hostname(String); impl fmt::Display for Hostname { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { write!(f, "{}", self.0) } } #[derive(Debug, Clone, PartialEq, Eq)] pub struct Subscribe { /// Subscribe to events matching this filter. pub filter: Filter, /// Request messages since this time. pub since: Timestamp, /// Request messages until this time. pub until: Timestamp, } impl Subscribe { pub fn all() -> Self { Self { filter: Filter::default(), since: Timestamp::MIN, until: Timestamp::MAX, } } } /// Node announcing itself to the network. #[derive(Debug, Clone, PartialEq, Eq)] pub struct NodeAnnouncement { /// Advertized features. pub features: node::Features, /// Monotonic timestamp. pub timestamp: Timestamp, /// Non-unique alias. pub alias: Alias, /// Announced addresses. pub addresses: BoundedVec, /// Nonce used for announcement proof-of-work. pub nonce: u64, } impl NodeAnnouncement { /// Calculate the amount of work that went into creating this announcement. /// /// Proof-of-work uses the [`scrypt`] algorithm with the parameters in /// [`Announcement::POW_PARAMS`]. The "work" is calculated by counting the number of leading /// zero bits after running `scrypt` on a serialized [`NodeAnnouncement`] using /// [`wire::serialize`]. /// /// In other words, `work = leading-zeros(scrypt(serialize(announcement)))`. /// /// Higher numbers mean higher difficulty. For each increase in work, difficulty is doubled. /// For instance, an output of `7` is *four* times more work than an output of `5`. /// pub fn work(&self) -> u32 { let (n, r, p) = Announcement::POW_PARAMS; let params = scrypt::Params::new(n, r, p).expect("proof-of-work parameters are valid"); let mut output = vec![0; 32]; scrypt::scrypt( wire::serialize(self).as_ref(), Announcement::POW_SALT, ¶ms, &mut output, ) .expect("proof-of-work output vector is a valid length"); // Calculate the number of leading zero bits in the output vector. if let Some((zero_bytes, non_zero)) = output.iter().enumerate().find(|(_, &x)| x != 0) { zero_bytes as u32 * 8 + non_zero.leading_zeros() } else { output.len() as u32 * 8 } } /// Solve the proof-of-work of a node announcement for the given target, by iterating through /// different nonces. /// /// If the given difficulty target is too high, there may not be a result. In that case, `None` /// is returned. pub fn solve(mut self, target: u32) -> Option { loop { if let Some(nonce) = self.nonce.checked_add(1) { self.nonce = nonce; if self.work() >= target { break; } } else { return None; } } Some(self) } } impl wire::Encode for NodeAnnouncement { fn encode(&self, writer: &mut W) -> Result { let mut n = 0; n += self.features.encode(writer)?; n += self.timestamp.encode(writer)?; n += self.alias.encode(writer)?; n += self.addresses.encode(writer)?; n += self.nonce.encode(writer)?; Ok(n) } } impl wire::Decode for NodeAnnouncement { fn decode(reader: &mut R) -> Result { let features = node::Features::decode(reader)?; let timestamp = Timestamp::decode(reader)?; let alias = wire::Decode::decode(reader)?; let addresses = BoundedVec::::decode(reader)?; let nonce = u64::decode(reader)?; Ok(Self { features, timestamp, alias, addresses, nonce, }) } } /// Node announcing project refs being created or updated. #[derive(Debug, Clone, PartialEq, Eq)] pub struct RefsAnnouncement { /// Repository identifier. pub rid: Id, /// Updated refs. pub refs: BoundedVec, REF_REMOTE_LIMIT>, /// Time of announcement. pub timestamp: Timestamp, } impl RefsAnnouncement { /// Check if this announcement is "fresh", meaning if it contains refs we do not have. pub fn is_fresh(&self, storage: S) -> Result { let repo = match storage.repository(self.rid) { // If the repo doesn't exist, we consider this announcement "fresh", since we // obviously don't have the refs. Err(e) if e.is_not_found() => return Ok(true), Err(e) => return Err(e), Ok(r) => r, }; for theirs in self.refs.iter() { if let Ok(ours) = repo.remote(&theirs.id) { if *ours.refs != theirs.refs { return Ok(true); } } else { return Ok(true); } } Ok(false) } /// Check if an announcement tells us that a node is in sync with a local remote. pub fn is_synced( &self, remote: &NodeId, storage: S, ) -> Result { let repo = match storage.repository(self.rid) { // If the repo doesn't exist, we're not in sync. Err(e) if e.is_not_found() => return Ok(false), Err(e) => return Err(e), Ok(r) => r, }; if let Some(refs) = self.refs.iter().find(|refs| &refs.id == remote) { let local_refs = repo.remote(remote)?.refs.unverified(); return Ok(&local_refs == refs); } Ok(false) } } /// Node announcing its inventory to the network. /// This should be the whole inventory every time. #[derive(Debug, Clone, PartialEq, Eq)] pub struct InventoryAnnouncement { /// Node inventory. pub inventory: BoundedVec, /// Time of announcement. pub timestamp: Timestamp, } /// Announcement messages are messages that are relayed between peers. #[derive(Clone, PartialEq, Eq)] pub enum AnnouncementMessage { /// Inventory announcement. Inventory(InventoryAnnouncement), /// Node announcement. Node(NodeAnnouncement), /// Refs announcement. Refs(RefsAnnouncement), } impl AnnouncementMessage { /// Sign this announcement message. pub fn signed(self, signer: &G) -> Announcement { let msg = wire::serialize(&self); let signature = signer.sign(&msg); Announcement { node: *signer.public_key(), message: self, signature, } } pub fn timestamp(&self) -> Timestamp { match self { Self::Inventory(InventoryAnnouncement { timestamp, .. }) => *timestamp, Self::Refs(RefsAnnouncement { timestamp, .. }) => *timestamp, Self::Node(NodeAnnouncement { timestamp, .. }) => *timestamp, } } } impl From for AnnouncementMessage { fn from(ann: NodeAnnouncement) -> Self { Self::Node(ann) } } impl From for AnnouncementMessage { fn from(ann: InventoryAnnouncement) -> Self { Self::Inventory(ann) } } impl From for AnnouncementMessage { fn from(ann: RefsAnnouncement) -> Self { Self::Refs(ann) } } impl fmt::Debug for AnnouncementMessage { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { Self::Node { .. } => write!(f, "Node(..)"), Self::Inventory(message) => { write!( f, "Inventory([{}], {})", message .inventory .iter() .map(|i| i.to_string()) .collect::>() .join(", "), message.timestamp ) } Self::Refs(message) => { write!( f, "Refs({}, {}, {:?})", message.rid, message.timestamp, message.refs ) } } } } #[derive(Debug, Clone, PartialEq, Eq)] pub struct Announcement { /// Node identifier. pub node: NodeId, /// Unsigned node announcement. pub message: AnnouncementMessage, /// Signature over the announcement. pub signature: crypto::Signature, } impl Announcement { /// Proof-of-work parameters for announcements. /// /// These parameters are fed into `scrypt`. /// They represent the `log2(N)`, `r`, `p` parameters, respectively. /// /// * log2(N) – iterations count (affects memory and CPU usage), e.g. 15 /// * r – block size (affects memory and CPU usage), e.g. 8 /// * p – parallelism factor (threads to run in parallel - affects the memory, CPU usage), usually 1 /// /// `15, 8, 1` are usually the recommended parameters. /// #[cfg(debug_assertions)] pub const POW_PARAMS: (u8, u32, u32) = (1, 1, 1); #[cfg(not(debug_assertions))] pub const POW_PARAMS: (u8, u32, u32) = (15, 8, 1); /// Salt used for generating PoW. pub const POW_SALT: &[u8] = &[b'r', b'a', b'd']; /// Verify this announcement's signature. pub fn verify(&self) -> bool { let msg = wire::serialize(&self.message); self.node.verify(msg, &self.signature).is_ok() } pub fn matches(&self, filter: &Filter) -> bool { match &self.message { AnnouncementMessage::Inventory(_) => true, AnnouncementMessage::Node(_) => true, AnnouncementMessage::Refs(RefsAnnouncement { rid, .. }) => filter.contains(rid), } } /// Check whether this announcement is of the same variant as another. pub fn variant_eq(&self, other: &Self) -> bool { std::mem::discriminant(&self.message) == std::mem::discriminant(&other.message) } /// Get the announcement timestamp. pub fn timestamp(&self) -> Timestamp { self.message.timestamp() } } /// Message payload. /// These are the messages peers send to each other. #[derive(Clone, PartialEq, Eq)] pub enum Message { /// Subscribe to gossip messages matching the filter and time range. Subscribe(Subscribe), /// Gossip announcement. These messages are relayed to peers, and filtered /// using [`Message::Subscribe`]. Announcement(Announcement), /// Ask a connected peer for a Pong. /// /// Used to check if the remote peer is responsive, or a side-effect free way to keep a /// connection alive. Ping(Ping), /// Response to `Ping` message. Pong { /// The pong payload. zeroes: ZeroBytes, }, } impl PartialOrd for Message { fn partial_cmp(&self, other: &Self) -> Option { Some(self.cmp(other)) } } impl Ord for Message { fn cmp(&self, other: &Self) -> std::cmp::Ordering { let this = wire::serialize(self); let other = wire::serialize(other); this.cmp(&other) } } impl Message { pub fn announcement( node: NodeId, message: impl Into, signature: crypto::Signature, ) -> Self { Announcement { node, signature, message: message.into(), } .into() } pub fn node(message: NodeAnnouncement, signer: &G) -> Self { AnnouncementMessage::from(message).signed(signer).into() } pub fn inventory(message: InventoryAnnouncement, signer: &G) -> Self { AnnouncementMessage::from(message).signed(signer).into() } pub fn subscribe(filter: Filter, since: Timestamp, until: Timestamp) -> Self { Self::Subscribe(Subscribe { filter, since, until, }) } pub fn log(&self, level: log::Level, remote: &NodeId, link: Link) { if !log::log_enabled!(level) { return; } let (verb, prep) = if link.is_inbound() { ("Received", "from") } else { ("Sending", "to") }; let msg = match self { Self::Announcement(Announcement { node, message, .. }) => match message { AnnouncementMessage::Node(NodeAnnouncement { addresses, .. }) => format!( "{verb} node announcement of {node} with {} address(es) {prep} {remote}", addresses.len() ), AnnouncementMessage::Refs(RefsAnnouncement { rid, refs, .. }) => format!( "{verb} refs announcement of {node} for {rid} with {} remote(s) {prep} {remote}", refs.len() ), AnnouncementMessage::Inventory(InventoryAnnouncement { inventory, .. }) => { format!( "{verb} inventory announcement of {node} with {} item(s) {prep} {remote}", inventory.len() ) } }, Self::Ping { .. } => format!("{verb} ping {prep} {remote}"), Self::Pong { .. } => format!("{verb} pong {prep} {remote}"), Self::Subscribe(Subscribe { .. }) => { format!("{verb} subscription filter {prep} {remote}") } }; log::log!(target: "service", level, "{msg}"); } } /// A ping message. #[derive(Debug, PartialEq, Eq, Clone)] pub struct Ping { /// The requested length of the pong message. pub ponglen: wire::Size, /// Zero bytes (ignored). pub zeroes: ZeroBytes, } impl Ping { /// Maximum number of zero bytes in a ping message. pub const MAX_PING_ZEROES: wire::Size = Message::MAX_SIZE // Message size without the type. - mem::size_of::() as wire::Size // Account for pong length. - mem::size_of::() as wire::Size; // Account for zeroes length prefix. /// Maximum number of zero bytes in a pong message. pub const MAX_PONG_ZEROES: wire::Size = Message::MAX_SIZE - mem::size_of::() as wire::Size; // Account for zeroes length // prefix. pub fn new(rng: &mut fastrand::Rng) -> Self { let ponglen = rng.u16(0..Self::MAX_PONG_ZEROES); Ping { ponglen, zeroes: ZeroBytes::new(rng.u16(0..Self::MAX_PING_ZEROES)), } } } impl From for Message { fn from(ann: Announcement) -> Self { Self::Announcement(ann) } } impl fmt::Debug for Message { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { Self::Subscribe(Subscribe { since, until, .. }) => { write!(f, "Subscribe({since}..{until})") } Self::Announcement(Announcement { node, message, .. }) => { write!(f, "Announcement({node}, {message:?})") } Self::Ping(Ping { ponglen, zeroes }) => write!(f, "Ping({ponglen}, {zeroes:?})"), Self::Pong { zeroes } => write!(f, "Pong({zeroes:?})"), } } } /// Represents a vector of zeroes of a certain length. #[derive(Clone, Debug, PartialEq, Eq)] pub struct ZeroBytes(wire::Size); impl ZeroBytes { pub fn new(size: wire::Size) -> Self { ZeroBytes(size) } pub fn is_empty(&self) -> bool { self.0 == 0 } pub fn len(&self) -> usize { self.0.into() } } #[cfg(test)] mod tests { use super::*; use crate::prelude::*; use crate::wire::Encode; use crate::crypto::test::signer::MockSigner; use crate::test::arbitrary; use fastrand; use qcheck_macros::quickcheck; #[test] fn test_ref_remote_limit() { let mut refs = BoundedVec::<_, REF_REMOTE_LIMIT>::new(); let rs = Refs::default(); let signer = MockSigner::default(); let signed_refs = rs.signed(&signer).unwrap().unverified(); assert_eq!(refs.capacity(), REF_REMOTE_LIMIT); for _ in 0..refs.capacity() { refs.push(signed_refs.clone()).unwrap(); } let msg: Message = AnnouncementMessage::from(RefsAnnouncement { rid: arbitrary::gen(1), refs, timestamp: LocalTime::now().as_millis(), }) .signed(&MockSigner::default()) .into(); let mut buf: Vec = Vec::new(); assert!(msg.encode(&mut buf).is_ok()); let decoded = wire::deserialize(buf.as_slice()); assert!(decoded.is_ok()); assert_eq!(msg, decoded.unwrap()); } #[test] fn test_inventory_limit() { let msg = Message::inventory( InventoryAnnouncement { inventory: arbitrary::vec(INVENTORY_LIMIT) .try_into() .expect("size within bounds limit"), timestamp: LocalTime::now().as_millis(), }, &MockSigner::default(), ); let mut buf: Vec = Vec::new(); assert!( msg.encode(&mut buf).is_ok(), "INVENTORY_LIMIT is a valid limit for encoding", ); let decoded = wire::deserialize(buf.as_slice()); assert!( decoded.is_ok(), "INVENTORY_LIMIT is a valid limit for decoding" ); assert_eq!( msg, decoded.unwrap(), "encoding and decoding should be safe for message at INVENTORY_LIMIT", ); } #[quickcheck] fn prop_refs_announcement_signing(rid: Id, refs: Refs) { let signer = MockSigner::new(&mut fastrand::Rng::new()); let timestamp = 0; let signed_refs = refs.signed(&signer).unwrap(); let refs = BoundedVec::collect_from(&mut [signed_refs.unverified()].into_iter()); let message = AnnouncementMessage::Refs(RefsAnnouncement { rid, refs, timestamp, }); let ann = message.signed(&signer); assert!(ann.verify()); } #[test] fn test_node_announcement_validate() { let ann = NodeAnnouncement { features: node::Features::SEED, timestamp: 42491841, alias: Alias::new("alice"), addresses: BoundedVec::new(), nonce: 0, }; assert_eq!(ann.work(), 0); assert_eq!(ann.clone().solve(1).unwrap().work(), 4); assert_eq!(ann.clone().solve(8).unwrap().work(), 9); assert_eq!(ann.solve(14).unwrap().work(), 14); } }