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 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
// Copyright 2018 The Grin Developers // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. use crate::util::RwLock; use std::convert::From; use std::fs::File; use std::io; use std::net::{IpAddr, SocketAddr}; use std::sync::mpsc; use std::sync::Arc; use chrono::prelude::*; use crate::core::core::hash::Hash; use crate::core::pow::Difficulty; use crate::core::{core, ser}; use grin_store; /// Maximum number of block headers a peer should ever send pub const MAX_BLOCK_HEADERS: u32 = 512; /// Maximum number of block bodies a peer should ever ask for and send #[allow(dead_code)] pub const MAX_BLOCK_BODIES: u32 = 16; /// Maximum number of peer addresses a peer should ever send pub const MAX_PEER_ADDRS: u32 = 256; /// Maximum number of block header hashes to send as part of a locator pub const MAX_LOCATORS: u32 = 20; /// How long a banned peer should be banned for const BAN_WINDOW: i64 = 10800; /// The max peer count const PEER_MAX_COUNT: u32 = 25; /// min preferred peer count const PEER_MIN_PREFERRED_COUNT: u32 = 8; #[derive(Debug)] pub enum Error { Serialization(ser::Error), Connection(io::Error), /// Header type does not match the expected message type BadMessage, MsgLen, Banned, ConnectionClose, Timeout, Store(grin_store::Error), PeerWithSelf, NoDandelionRelay, ProtocolMismatch { us: u32, peer: u32, }, GenesisMismatch { us: Hash, peer: Hash, }, Send(String), PeerException, } impl From<ser::Error> for Error { fn from(e: ser::Error) -> Error { Error::Serialization(e) } } impl From<grin_store::Error> for Error { fn from(e: grin_store::Error) -> Error { Error::Store(e) } } impl From<io::Error> for Error { fn from(e: io::Error) -> Error { Error::Connection(e) } } impl<T> From<mpsc::TrySendError<T>> for Error { fn from(e: mpsc::TrySendError<T>) -> Error { Error::Send(e.to_string()) } } /// Configuration for the peer-to-peer server. #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] pub struct P2PConfig { pub host: IpAddr, pub port: u16, /// Method used to get the list of seed nodes for initial bootstrap. #[serde(default)] pub seeding_type: Seeding, /// The list of seed nodes, if using Seeding as a seed type pub seeds: Option<Vec<String>>, /// Capabilities expose by this node, also conditions which other peers this /// node will have an affinity toward when connection. pub capabilities: Capabilities, pub peers_allow: Option<Vec<String>>, pub peers_deny: Option<Vec<String>>, /// The list of preferred peers that we will try to connect to pub peers_preferred: Option<Vec<String>>, pub ban_window: Option<i64>, pub peer_max_count: Option<u32>, pub peer_min_preferred_count: Option<u32>, pub dandelion_peer: Option<SocketAddr>, } /// Default address for peer-to-peer connections. impl Default for P2PConfig { fn default() -> P2PConfig { let ipaddr = "0.0.0.0".parse().unwrap(); P2PConfig { host: ipaddr, port: 3414, capabilities: Capabilities::FULL_NODE, seeding_type: Seeding::default(), seeds: None, peers_allow: None, peers_deny: None, peers_preferred: None, ban_window: None, peer_max_count: None, peer_min_preferred_count: None, dandelion_peer: None, } } } /// Note certain fields are options just so they don't have to be /// included in grin-server.toml, but we don't want them to ever return none impl P2PConfig { /// return ban window pub fn ban_window(&self) -> i64 { match self.ban_window { Some(n) => n, None => BAN_WINDOW, } } /// return peer_max_count pub fn peer_max_count(&self) -> u32 { match self.peer_max_count { Some(n) => n, None => PEER_MAX_COUNT, } } /// return peer_preferred_count pub fn peer_min_preferred_count(&self) -> u32 { match self.peer_min_preferred_count { Some(n) => n, None => PEER_MIN_PREFERRED_COUNT, } } } /// Type of seeding the server will use to find other peers on the network. #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)] pub enum Seeding { /// No seeding, mostly for tests that programmatically connect None, /// A list of seed addresses provided to the server List, /// Automatically get a list of seeds from multiple DNS DNSSeed, /// Mostly for tests, where connections are initiated programmatically Programmatic, } impl Default for Seeding { fn default() -> Seeding { Seeding::DNSSeed } } bitflags! { /// Options for what type of interaction a peer supports #[derive(Serialize, Deserialize)] pub struct Capabilities: u32 { /// We don't know (yet) what the peer can do. const UNKNOWN = 0b00000000; /// Can provide full history of headers back to genesis /// (for at least one arbitrary fork). const HEADER_HIST = 0b00000001; /// Can provide block headers and the TxHashSet for some recent-enough /// height. const TXHASHSET_HIST = 0b00000010; /// Can provide a list of healthy peers const PEER_LIST = 0b00000100; /// Can broadcast and request txs by kernel hash. const TX_KERNEL_HASH = 0b00001000; /// All nodes right now are "full nodes". /// Some nodes internally may maintain longer block histories (archival_mode) /// but we do not advertise this to other nodes. /// All nodes by default will accept lightweight "kernel first" tx broadcast. const FULL_NODE = Capabilities::HEADER_HIST.bits | Capabilities::TXHASHSET_HIST.bits | Capabilities::PEER_LIST.bits | Capabilities::TX_KERNEL_HASH.bits; } } /// Types of connection enum_from_primitive! { #[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)] pub enum Direction { Inbound = 0, Outbound = 1, } } /// Ban reason enum_from_primitive! { #[derive(Debug, Clone, Copy, PartialEq, Serialize, Deserialize)] pub enum ReasonForBan { None = 0, BadBlock = 1, BadCompactBlock = 2, BadBlockHeader = 3, BadTxHashSet = 4, ManualBan = 5, FraudHeight = 6, BadHandshake = 7, } } #[derive(Clone, Debug)] pub struct PeerLiveInfo { pub total_difficulty: Difficulty, pub height: u64, pub last_seen: DateTime<Utc>, pub stuck_detector: DateTime<Utc>, } /// General information about a connected peer that's useful to other modules. #[derive(Clone, Debug)] pub struct PeerInfo { pub capabilities: Capabilities, pub user_agent: String, pub version: u32, pub addr: SocketAddr, pub direction: Direction, pub live_info: Arc<RwLock<PeerLiveInfo>>, } impl PeerInfo { /// The current total_difficulty of the peer. pub fn total_difficulty(&self) -> Difficulty { self.live_info.read().total_difficulty } pub fn is_outbound(&self) -> bool { self.direction == Direction::Outbound } /// The current height of the peer. pub fn height(&self) -> u64 { self.live_info.read().height } /// Time of last_seen for this peer (via ping/pong). pub fn last_seen(&self) -> DateTime<Utc> { self.live_info.read().last_seen } /// Update the total_difficulty, height and last_seen of the peer. /// Takes a write lock on the live_info. pub fn update(&self, height: u64, total_difficulty: Difficulty) { let mut live_info = self.live_info.write(); if total_difficulty != live_info.total_difficulty { live_info.stuck_detector = Utc::now(); } live_info.height = height; live_info.total_difficulty = total_difficulty; live_info.last_seen = Utc::now() } } /// Flatten out a PeerInfo and nested PeerLiveInfo (taking a read lock on it) /// so we can serialize/deserialize the data for the API and the TUI. #[derive(Clone, Debug, Serialize, Deserialize)] pub struct PeerInfoDisplay { pub capabilities: Capabilities, pub user_agent: String, pub version: u32, pub addr: SocketAddr, pub direction: Direction, pub total_difficulty: Difficulty, pub height: u64, } impl From<PeerInfo> for PeerInfoDisplay { fn from(info: PeerInfo) -> PeerInfoDisplay { PeerInfoDisplay { capabilities: info.capabilities.clone(), user_agent: info.user_agent.clone(), version: info.version.clone(), addr: info.addr.clone(), direction: info.direction.clone(), total_difficulty: info.total_difficulty(), height: info.height(), } } } /// The full txhashset data along with indexes required for a consumer to /// rewind to a consistent requested state. pub struct TxHashSetRead { /// Output tree index the receiver should rewind to pub output_index: u64, /// Kernel tree index the receiver should rewind to pub kernel_index: u64, /// Binary stream for the txhashset zipped data pub reader: File, } /// Bridge between the networking layer and the rest of the system. Handles the /// forwarding or querying of blocks and transactions from the network among /// other things. pub trait ChainAdapter: Sync + Send { /// Current total difficulty on our chain fn total_difficulty(&self) -> Difficulty; /// Current total height fn total_height(&self) -> u64; /// A valid transaction has been received from one of our peers fn transaction_received(&self, tx: core::Transaction, stem: bool); fn get_transaction(&self, kernel_hash: Hash) -> Option<core::Transaction>; fn tx_kernel_received(&self, kernel_hash: Hash, addr: SocketAddr); /// A block has been received from one of our peers. Returns true if the /// block could be handled properly and is not deemed defective by the /// chain. Returning false means the block will never be valid and /// may result in the peer being banned. fn block_received(&self, b: core::Block, addr: SocketAddr, was_requested: bool) -> bool; fn compact_block_received(&self, cb: core::CompactBlock, addr: SocketAddr) -> bool; fn header_received(&self, bh: core::BlockHeader, addr: SocketAddr) -> bool; /// A set of block header has been received, typically in response to a /// block /// header request. fn headers_received(&self, bh: &[core::BlockHeader], addr: SocketAddr) -> bool; /// Finds a list of block headers based on the provided locator. Tries to /// identify the common chain and gets the headers that follow it /// immediately. fn locate_headers(&self, locator: &[Hash]) -> Vec<core::BlockHeader>; /// Gets a full block by its hash. fn get_block(&self, h: Hash) -> Option<core::Block>; /// Provides a reading view into the current txhashset state as well as /// the required indexes for a consumer to rewind to a consistant state /// at the provided block hash. fn txhashset_read(&self, h: Hash) -> Option<TxHashSetRead>; /// Whether the node is ready to accept a new txhashset. If this isn't the /// case, the archive is provided without being requested and likely an /// attack attempt. This should be checked *before* downloading the whole /// state data. fn txhashset_receive_ready(&self) -> bool; /// Update txhashset downloading progress fn txhashset_download_update( &self, start_time: DateTime<Utc>, downloaded_size: u64, total_size: u64, ) -> bool; /// Writes a reading view on a txhashset state that's been provided to us. /// If we're willing to accept that new state, the data stream will be /// read as a zip file, unzipped and the resulting state files should be /// rewound to the provided indexes. fn txhashset_write(&self, h: Hash, txhashset_data: File, peer_addr: SocketAddr) -> bool; } /// Additional methods required by the protocol that don't need to be /// externally implemented. pub trait NetAdapter: ChainAdapter { /// Find good peers we know with the provided capability and return their /// addresses. fn find_peer_addrs(&self, capab: Capabilities) -> Vec<SocketAddr>; /// A list of peers has been received from one of our peers. fn peer_addrs_received(&self, _: Vec<SocketAddr>); /// Heard total_difficulty from a connected peer (via ping/pong). fn peer_difficulty(&self, _: SocketAddr, _: Difficulty, _: u64); /// Is this peer currently banned? fn is_banned(&self, addr: SocketAddr) -> bool; }