1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
use crate::{PeerId, PeerIdDeserializer, PeerIdSerializer};
use massa_models::serialization::{IpAddrDeserializer, IpAddrSerializer};
use massa_serialization::{
Deserializer, SerializeError, Serializer, U16VarIntDeserializer, U16VarIntSerializer,
U32VarIntDeserializer, U32VarIntSerializer,
};
use nom::{
error::{context, ContextError, ParseError},
multi::length_count,
sequence::tuple,
IResult, Parser,
};
use peernet::transports::TransportType;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::net::SocketAddr;
use std::ops::Bound::Included;
/// Peer info provided in bootstrap
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct PeerData {
pub listeners: HashMap<SocketAddr, TransportType>,
pub category: String,
}
/// Peers that are transmitted during bootstrap
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct BootstrapPeers(pub Vec<(PeerId, HashMap<SocketAddr, TransportType>)>);
/// Serializer for `BootstrapPeers`
pub struct BootstrapPeersSerializer {
u32_serializer: U32VarIntSerializer,
ip_addr_serializer: IpAddrSerializer,
port_serializer: U16VarIntSerializer,
peer_id_serializer: PeerIdSerializer,
}
impl BootstrapPeersSerializer {
/// Creates a new `BootstrapPeersSerializer`
pub fn new() -> Self {
Self {
u32_serializer: U32VarIntSerializer::new(),
ip_addr_serializer: IpAddrSerializer::new(),
port_serializer: U16VarIntSerializer::new(),
peer_id_serializer: PeerIdSerializer::new(),
}
}
}
impl Default for BootstrapPeersSerializer {
fn default() -> Self {
Self::new()
}
}
impl Serializer<BootstrapPeers> for BootstrapPeersSerializer {
/// ```
/// use massa_protocol_exports::{BootstrapPeers, PeerId, TransportType, BootstrapPeersSerializer};
/// use massa_serialization::Serializer;
/// use massa_signature::KeyPair;
/// use std::collections::HashMap;
/// use std::str::FromStr;
///
/// let keypair1 = KeyPair::generate(0).unwrap();
/// let mut peers = vec![];
/// let mut listeners1 = HashMap::default();
/// listeners1.insert("127.0.0.1:8080".parse().unwrap(), TransportType::Tcp);
/// peers.push((PeerId::from_public_key(keypair1.get_public_key()), listeners1));
/// let mut keypair2 = KeyPair::generate(0).unwrap();
/// let mut listeners2 = HashMap::default();
/// listeners2.insert("[::1]:8080".parse().unwrap(), TransportType::Tcp);
/// peers.push((PeerId::from_public_key(keypair1.get_public_key()), listeners2));
/// let mut serialized = Vec::new();
/// let peers = BootstrapPeers(peers);
/// let peers_serializer = BootstrapPeersSerializer::new();
/// peers_serializer.serialize(&peers, &mut serialized).unwrap();
/// ```
fn serialize(
&self,
value: &BootstrapPeers,
buffer: &mut Vec<u8>,
) -> Result<(), SerializeError> {
let peers_count: u32 = value.0.len().try_into().map_err(|err| {
SerializeError::NumberTooBig(format!(
"too many peers blocks in BootstrapPeers: {}",
err
))
})?;
self.u32_serializer.serialize(&peers_count, buffer)?;
for (peer_id, listeners) in value.0.iter() {
self.peer_id_serializer.serialize(peer_id, buffer)?;
self.u32_serializer
.serialize(&(listeners.len() as u32), buffer)?;
// Emit listeners in a deterministic order: `HashMap` iteration order is not
// stable, so without sorting, logically identical peer sets could produce
// different byte encodings (a non-canonical format). Sorting by socket
// address (unique per map) yields a canonical, reproducible encoding.
let mut listeners: Vec<(&SocketAddr, &TransportType)> = listeners.iter().collect();
listeners.sort_unstable_by(|(a, _), (b, _)| a.cmp(b));
for (addr, transport_type) in listeners {
self.ip_addr_serializer.serialize(&addr.ip(), buffer)?;
self.port_serializer.serialize(&addr.port(), buffer)?;
buffer.push(*transport_type as u8);
}
}
Ok(())
}
}
/// Deserializer for `BootstrapPeers`
pub struct BootstrapPeersDeserializer {
length_deserializer: U32VarIntDeserializer,
length_listeners_deserializer: U32VarIntDeserializer,
ip_addr_deserializer: IpAddrDeserializer,
port_deserializer: U16VarIntDeserializer,
peer_id_deserializer: PeerIdDeserializer,
}
impl BootstrapPeersDeserializer {
/// Creates a new `BootstrapPeersDeserializer`
///
/// Arguments:
///
/// * `max_peers`: maximum peers that can be serialized
pub fn new(max_peers: u32, max_listeners_per_peer: u32) -> Self {
Self {
length_deserializer: U32VarIntDeserializer::new(Included(0), Included(max_peers)),
length_listeners_deserializer: U32VarIntDeserializer::new(
Included(0),
Included(max_listeners_per_peer),
),
ip_addr_deserializer: IpAddrDeserializer::new(),
port_deserializer: U16VarIntDeserializer::new(Included(0), Included(u16::MAX)),
peer_id_deserializer: PeerIdDeserializer::new(),
}
}
}
impl Deserializer<BootstrapPeers> for BootstrapPeersDeserializer {
/// ```
/// use massa_protocol_exports::{BootstrapPeers, PeerId, TransportType, BootstrapPeersSerializer, BootstrapPeersDeserializer};
/// use massa_serialization::{Serializer, Deserializer, DeserializeError};
/// use massa_signature::KeyPair;
/// use std::collections::HashMap;
/// use std::str::FromStr;
///
/// let keypair1 = KeyPair::generate(0).unwrap();
/// let mut peers = vec![];
/// let mut listeners1 = HashMap::default();
/// listeners1.insert("127.0.0.1:8080".parse().unwrap(), TransportType::Tcp);
/// peers.push((PeerId::from_public_key(keypair1.get_public_key()), listeners1));
/// let mut keypair2 = KeyPair::generate(0).unwrap();
/// let mut listeners2 = HashMap::default();
/// listeners2.insert("[::1]:8080".parse().unwrap(), TransportType::Tcp);
/// peers.push((PeerId::from_public_key(keypair1.get_public_key()), listeners2));
/// let mut serialized = Vec::new();
/// let peers = BootstrapPeers(peers);
/// let peers_serializer = BootstrapPeersSerializer::new();
/// peers_serializer.serialize(&peers, &mut serialized).unwrap();
/// let peers_deserializer = BootstrapPeersDeserializer::new(10, 10);
/// let (rest, peers) = peers_deserializer.deserialize::<DeserializeError>(&serialized).unwrap();
/// assert!(rest.is_empty());
/// assert_eq!(peers, peers);
/// ```
fn deserialize<'a, E: ParseError<&'a [u8]> + ContextError<&'a [u8]>>(
&self,
buffer: &'a [u8],
) -> IResult<&'a [u8], BootstrapPeers, E> {
length_count(
context("Failed length deserialization", |input| {
self.length_deserializer.deserialize(input)
}),
context("Failed Peer deserialization", |input| {
tuple((
context("Failed PeerId deserialization", |input: &'a [u8]| {
self.peer_id_deserializer.deserialize(input)
}),
length_count(
context("Failed length deserialization", |input| {
self.length_listeners_deserializer.deserialize(input)
}),
context("Failed listener deserialization", |buffer: &'a [u8]| {
tuple((
tuple((
context("Failed ip deserialization", |buffer| {
self.ip_addr_deserializer.deserialize(buffer)
}),
context("Failed port deserialization", |buffer| {
self.port_deserializer.deserialize(buffer)
}),
))
.map(|(addr, ip)| SocketAddr::new(addr, ip)),
context("Failed transport deserialization", |buffer| {
let (rest, id) = nom::number::complete::be_u8(buffer)?;
match id {
0 => Ok((rest, TransportType::Tcp)),
1 => Ok((rest, TransportType::Quic)),
_ => Err(nom::Err::Error(ParseError::from_error_kind(
buffer,
nom::error::ErrorKind::MapRes,
))),
}
}),
))
.parse(buffer)
}),
)
.map(|listeners| {
listeners
.into_iter()
.collect::<HashMap<SocketAddr, TransportType>>()
}),
))
.parse(input)
}),
)
.map(BootstrapPeers)
.parse(buffer)
}
}
#[cfg(test)]
mod tests {
use super::*;
use massa_serialization::DeserializeError;
use massa_signature::KeyPair;
fn peer_id() -> PeerId {
PeerId::from_public_key(KeyPair::generate(0).unwrap().get_public_key())
}
/// Logically identical `BootstrapPeers` (same listeners, different insertion
/// order) must serialize to the exact same bytes: the format is canonical.
#[test]
fn serialization_is_canonical_regardless_of_insertion_order() {
let id = peer_id();
let mut listeners_a = HashMap::default();
listeners_a.insert("127.0.0.1:8080".parse().unwrap(), TransportType::Tcp);
listeners_a.insert("127.0.0.1:8081".parse().unwrap(), TransportType::Quic);
listeners_a.insert("[::1]:8082".parse().unwrap(), TransportType::Tcp);
// same set, inserted in the opposite order
let mut listeners_b = HashMap::default();
listeners_b.insert("[::1]:8082".parse().unwrap(), TransportType::Tcp);
listeners_b.insert("127.0.0.1:8081".parse().unwrap(), TransportType::Quic);
listeners_b.insert("127.0.0.1:8080".parse().unwrap(), TransportType::Tcp);
let peers_a = BootstrapPeers(vec![(id, listeners_a)]);
let peers_b = BootstrapPeers(vec![(id, listeners_b)]);
let serializer = BootstrapPeersSerializer::new();
let mut buf_a = Vec::new();
let mut buf_b = Vec::new();
serializer.serialize(&peers_a, &mut buf_a).unwrap();
serializer.serialize(&peers_b, &mut buf_b).unwrap();
assert_eq!(buf_a, buf_b);
}
/// A serialize -> deserialize -> serialize cycle is byte-stable.
#[test]
fn serialize_deserialize_serialize_is_stable() {
let id = peer_id();
let mut listeners = HashMap::default();
listeners.insert("127.0.0.1:8080".parse().unwrap(), TransportType::Tcp);
listeners.insert("127.0.0.1:8081".parse().unwrap(), TransportType::Quic);
listeners.insert("[::1]:8082".parse().unwrap(), TransportType::Tcp);
let peers = BootstrapPeers(vec![(id, listeners)]);
let serializer = BootstrapPeersSerializer::new();
let deserializer = BootstrapPeersDeserializer::new(10, 10);
let mut buf1 = Vec::new();
serializer.serialize(&peers, &mut buf1).unwrap();
let (rest, deserialized) = deserializer.deserialize::<DeserializeError>(&buf1).unwrap();
assert!(rest.is_empty());
assert_eq!(peers, deserialized);
let mut buf2 = Vec::new();
serializer.serialize(&deserialized, &mut buf2).unwrap();
assert_eq!(buf1, buf2);
}
}