Add a category for timedout pong
[dnsseed-rust] / src / main.rs
1 mod printer;
2 mod reader;
3 mod peer;
4 mod timeout_stream;
5 mod datastore;
6
7 use std::{cmp, env};
8 use std::collections::HashMap;
9 use std::sync::{Arc, Mutex};
10 use std::sync::atomic::{Ordering, AtomicBool};
11 use std::time::{Duration, Instant};
12 use std::net::{SocketAddr, ToSocketAddrs};
13
14 use bitcoin_hashes::sha256d;
15
16 use bitcoin::blockdata::block::Block;
17 use bitcoin::blockdata::constants::genesis_block;
18 use bitcoin::network::constants::Network;
19 use bitcoin::network::message::NetworkMessage;
20 use bitcoin::network::message_blockdata::{GetHeadersMessage, Inventory, InvType};
21 use bitcoin::util::hash::BitcoinHash;
22
23 use printer::{Printer, Stat};
24 use peer::Peer;
25 use datastore::{AddressState, Store, U64Setting, RegexSetting};
26 use timeout_stream::TimeoutStream;
27 use rand::Rng;
28
29 use tokio::prelude::*;
30 use tokio::timer::Delay;
31
32 static mut REQUEST_BLOCK: Option<Box<Mutex<Arc<(u64, sha256d::Hash, Block)>>>> = None;
33 static mut HIGHEST_HEADER: Option<Box<Mutex<(sha256d::Hash, u64)>>> = None;
34 static mut HEADER_MAP: Option<Box<Mutex<HashMap<sha256d::Hash, u64>>>> = None;
35 static mut HEIGHT_MAP: Option<Box<Mutex<HashMap<u64, sha256d::Hash>>>> = None;
36 static mut DATA_STORE: Option<Box<Store>> = None;
37 static mut PRINTER: Option<Box<Printer>> = None;
38 pub static START_SHUTDOWN: AtomicBool = AtomicBool::new(false);
39 static SCANNING: AtomicBool = AtomicBool::new(false);
40
41 struct PeerState {
42         request: Arc<(u64, sha256d::Hash, Block)>,
43         node_services: u64,
44         msg: (String, bool),
45         fail_reason: AddressState,
46         recvd_version: bool,
47         recvd_verack: bool,
48         recvd_pong: bool,
49         recvd_addrs: bool,
50         recvd_block: bool,
51         pong_nonce: u64,
52 }
53
54 pub fn scan_node(scan_time: Instant, node: SocketAddr, manual: bool) {
55         if START_SHUTDOWN.load(Ordering::Relaxed) { return; }
56         let printer = unsafe { PRINTER.as_ref().unwrap() };
57         let store = unsafe { DATA_STORE.as_ref().unwrap() };
58
59         let mut rng = rand::thread_rng();
60         let peer_state = Arc::new(Mutex::new(PeerState {
61                 recvd_version: false,
62                 recvd_verack: false,
63                 recvd_pong: false,
64                 recvd_addrs: false,
65                 recvd_block: false,
66                 pong_nonce: rng.gen(),
67                 node_services: 0,
68                 fail_reason: AddressState::Timeout,
69                 msg: (String::new(), false),
70                 request: Arc::clone(&unsafe { REQUEST_BLOCK.as_ref().unwrap() }.lock().unwrap()),
71         }));
72         let final_peer_state = Arc::clone(&peer_state);
73
74         let peer = Delay::new(scan_time).then(move |_| {
75                 printer.set_stat(Stat::NewConnection);
76                 let timeout = store.get_u64(U64Setting::RunTimeout);
77                 Peer::new(node.clone(), Duration::from_secs(timeout), printer)
78         });
79         tokio::spawn(peer.and_then(move |(mut write, read)| {
80                 TimeoutStream::new_timeout(read, scan_time + Duration::from_secs(store.get_u64(U64Setting::RunTimeout))).map_err(|_| { () }).for_each(move |msg| {
81                         let mut state_lock = peer_state.lock().unwrap();
82                         macro_rules! check_set_flag {
83                                 ($recvd_flag: ident, $msg: expr) => { {
84                                         if state_lock.$recvd_flag {
85                                                 state_lock.fail_reason = AddressState::ProtocolViolation;
86                                                 state_lock.msg = (format!("due to dup {}", $msg), true);
87                                                 state_lock.$recvd_flag = false;
88                                                 return future::err(());
89                                         }
90                                         state_lock.$recvd_flag = true;
91                                 } }
92                         }
93                         state_lock.fail_reason = AddressState::TimeoutDuringRequest;
94                         match msg {
95                                 NetworkMessage::Version(ver) => {
96                                         if ver.start_height < 0 || ver.start_height as u64 > state_lock.request.0 + 1008*2 {
97                                                 state_lock.fail_reason = AddressState::HighBlockCount;
98                                                 return future::err(());
99                                         }
100                                         let safe_ua = ver.user_agent.replace(|c: char| !c.is_ascii() || c < ' ' || c > '~', "");
101                                         if (ver.start_height as u64) < state_lock.request.0 {
102                                                 state_lock.msg = (format!("({} < {})", ver.start_height, state_lock.request.0), true);
103                                                 state_lock.fail_reason = AddressState::LowBlockCount;
104                                                 return future::err(());
105                                         }
106                                         let min_version = store.get_u64(U64Setting::MinProtocolVersion);
107                                         if (ver.version as u64) < min_version {
108                                                 state_lock.msg = (format!("({} < {})", ver.version, min_version), true);
109                                                 state_lock.fail_reason = AddressState::LowVersion;
110                                                 return future::err(());
111                                         }
112                                         if ver.services & (1 | (1 << 10)) == 0 {
113                                                 state_lock.msg = (format!("({}: services {:x})", safe_ua, ver.services), true);
114                                                 state_lock.fail_reason = AddressState::NotFullNode;
115                                                 return future::err(());
116                                         }
117                                         if !store.get_regex(RegexSetting::SubverRegex).is_match(&ver.user_agent) {
118                                                 state_lock.msg = (format!("subver {}", safe_ua), true);
119                                                 state_lock.fail_reason = AddressState::BadVersion;
120                                                 return future::err(());
121                                         }
122                                         check_set_flag!(recvd_version, "version");
123                                         state_lock.node_services = ver.services;
124                                         state_lock.msg = (format!("(subver: {})", safe_ua), false);
125                                         if let Err(_) = write.try_send(NetworkMessage::Verack) {
126                                                 return future::err(());
127                                         }
128                                 },
129                                 NetworkMessage::Verack => {
130                                         check_set_flag!(recvd_verack, "verack");
131                                         if let Err(_) = write.try_send(NetworkMessage::Ping(state_lock.pong_nonce)) {
132                                                 return future::err(());
133                                         }
134                                 },
135                                 NetworkMessage::Ping(v) => {
136                                         if let Err(_) = write.try_send(NetworkMessage::Pong(v)) {
137                                                 return future::err(())
138                                         }
139                                 },
140                                 NetworkMessage::Pong(v) => {
141                                         if v != state_lock.pong_nonce {
142                                                 state_lock.fail_reason = AddressState::ProtocolViolation;
143                                                 state_lock.msg = ("due to invalid pong nonce".to_string(), true);
144                                                 return future::err(());
145                                         }
146                                         check_set_flag!(recvd_pong, "pong");
147                                         if let Err(_) = write.try_send(NetworkMessage::GetAddr) {
148                                                 return future::err(());
149                                         }
150                                 },
151                                 NetworkMessage::Addr(addrs) => {
152                                         if addrs.len() > 1000 {
153                                                 state_lock.fail_reason = AddressState::ProtocolViolation;
154                                                 state_lock.msg = (format!("due to oversized addr: {}", addrs.len()), true);
155                                                 state_lock.recvd_addrs = false;
156                                                 return future::err(());
157                                         }
158                                         if addrs.len() > 10 {
159                                                 if !state_lock.recvd_addrs {
160                                                         if let Err(_) = write.try_send(NetworkMessage::GetData(vec![Inventory {
161                                                                 inv_type: InvType::WitnessBlock,
162                                                                 hash: state_lock.request.1,
163                                                         }])) {
164                                                                 return future::err(());
165                                                         }
166                                                 }
167                                                 state_lock.recvd_addrs = true;
168                                         }
169                                         unsafe { DATA_STORE.as_ref().unwrap() }.add_fresh_nodes(&addrs);
170                                 },
171                                 NetworkMessage::Block(block) => {
172                                         if block != state_lock.request.2 {
173                                                 state_lock.fail_reason = AddressState::ProtocolViolation;
174                                                 state_lock.msg = ("due to bad block".to_string(), true);
175                                                 return future::err(());
176                                         }
177                                         check_set_flag!(recvd_block, "block");
178                                         return future::err(());
179                                 },
180                                 NetworkMessage::Tx(_) => {
181                                         state_lock.fail_reason = AddressState::ProtocolViolation;
182                                         state_lock.msg = ("due to unrequested transaction".to_string(), true);
183                                         return future::err(());
184                                 },
185                                 _ => {},
186                         }
187                         future::ok(())
188                 }).then(|_| {
189                         future::err(())
190                 })
191         }).then(move |_: Result<(), ()>| {
192                 let printer = unsafe { PRINTER.as_ref().unwrap() };
193                 let store = unsafe { DATA_STORE.as_ref().unwrap() };
194                 printer.set_stat(Stat::ConnectionClosed);
195
196                 let mut state_lock = final_peer_state.lock().unwrap();
197                 if state_lock.recvd_version && state_lock.recvd_verack && state_lock.recvd_pong &&
198                                 state_lock.recvd_addrs && state_lock.recvd_block {
199                         let old_state = store.set_node_state(node, AddressState::Good, state_lock.node_services);
200                         if manual || (old_state != AddressState::Good && state_lock.msg.0 != "") {
201                                 printer.add_line(format!("Updating {} from {} to Good {}", node, old_state.to_str(), &state_lock.msg.0), state_lock.msg.1);
202                         }
203                 } else {
204                         assert!(state_lock.fail_reason != AddressState::Good);
205                         if state_lock.fail_reason == AddressState::TimeoutDuringRequest && state_lock.recvd_version && state_lock.recvd_verack {
206                                 if !state_lock.recvd_pong {
207                                         state_lock.fail_reason = AddressState::TimeoutAwaitingPong;
208                                 } else if !state_lock.recvd_addrs {
209                                         state_lock.fail_reason = AddressState::TimeoutAwaitingAddr;
210                                 } else if !state_lock.recvd_block {
211                                         state_lock.fail_reason = AddressState::TimeoutAwaitingBlock;
212                                 }
213                         }
214                         let old_state = store.set_node_state(node, state_lock.fail_reason, 0);
215                         if (manual || old_state != state_lock.fail_reason) && state_lock.fail_reason == AddressState::TimeoutDuringRequest {
216                                 printer.add_line(format!("Updating {} from {} to Timeout During Request (ver: {}, vack: {})",
217                                         node, old_state.to_str(), state_lock.recvd_version, state_lock.recvd_verack), true);
218                         } else if manual || (old_state != state_lock.fail_reason && state_lock.msg.0 != "" && state_lock.msg.1) {
219                                 printer.add_line(format!("Updating {} from {} to {} {}", node, old_state.to_str(), state_lock.fail_reason.to_str(), &state_lock.msg.0), state_lock.msg.1);
220                         }
221                 }
222                 future::ok(())
223         }));
224 }
225
226 fn poll_dnsseeds() {
227         tokio::spawn(future::lazy(|| {
228                 let printer = unsafe { PRINTER.as_ref().unwrap() };
229                 let store = unsafe { DATA_STORE.as_ref().unwrap() };
230
231                 let mut new_addrs = 0;
232                 for seed in ["seed.bitcoin.sipa.be", "dnsseed.bitcoin.dashjr.org", "seed.bitcoinstats.com", "seed.bitcoin.jonasschnelli.ch", "seed.btc.petertodd.org", "seed.bitcoin.sprovoost.nl", "dnsseed.emzy.de"].iter() {
233                         new_addrs += store.add_fresh_addrs((*seed, 8333u16).to_socket_addrs().unwrap_or(Vec::new().into_iter()));
234                         new_addrs += store.add_fresh_addrs((("x9.".to_string() + seed).as_str(), 8333u16).to_socket_addrs().unwrap_or(Vec::new().into_iter()));
235                 }
236                 printer.add_line(format!("Added {} new addresses from other DNS seeds", new_addrs), false);
237                 Delay::new(Instant::now() + Duration::from_secs(60)).then(|_| {
238                         let store = unsafe { DATA_STORE.as_ref().unwrap() };
239                         store.save_data().then(|_| {
240                                 if !START_SHUTDOWN.load(Ordering::Relaxed) {
241                                         poll_dnsseeds();
242                                 }
243                                 future::ok(())
244                         })
245                 })
246         }));
247 }
248
249 fn scan_net() {
250         tokio::spawn(future::lazy(|| {
251                 let printer = unsafe { PRINTER.as_ref().unwrap() };
252                 let store = unsafe { DATA_STORE.as_ref().unwrap() };
253
254                 let mut scan_nodes = store.get_next_scan_nodes();
255                 printer.add_line(format!("Got {} addresses to scan", scan_nodes.len()), false);
256                 let per_iter_time = Duration::from_millis(1000 / store.get_u64(U64Setting::ConnsPerSec));
257                 let start_time = Instant::now();
258                 let mut iter_time = start_time;
259
260                 for node in scan_nodes.drain(..) {
261                         scan_node(iter_time, node, false);
262                         iter_time += per_iter_time;
263                 }
264                 Delay::new(cmp::max(iter_time, start_time + Duration::from_secs(1))).then(|_| {
265                         if !START_SHUTDOWN.load(Ordering::Relaxed) {
266                                 scan_net();
267                         }
268                         future::ok(())
269                 })
270         }));
271 }
272
273 fn make_trusted_conn(trusted_sockaddr: SocketAddr) {
274         let printer = unsafe { PRINTER.as_ref().unwrap() };
275         let trusted_peer = Peer::new(trusted_sockaddr.clone(), Duration::from_secs(600), printer);
276         tokio::spawn(trusted_peer.and_then(move |(mut trusted_write, trusted_read)| {
277                 printer.add_line("Connected to local peer".to_string(), false);
278                 let mut starting_height = 0;
279                 TimeoutStream::new_persistent(trusted_read, Duration::from_secs(600)).map_err(|_| { () }).for_each(move |msg| {
280                         if START_SHUTDOWN.load(Ordering::Relaxed) {
281                                 return future::err(());
282                         }
283                         match msg {
284                                 NetworkMessage::Version(ver) => {
285                                         if let Err(_) = trusted_write.try_send(NetworkMessage::Verack) {
286                                                 return future::err(())
287                                         }
288                                         starting_height = ver.start_height;
289                                 },
290                                 NetworkMessage::Verack => {
291                                         if let Err(_) = trusted_write.try_send(NetworkMessage::SendHeaders) {
292                                                 return future::err(());
293                                         }
294                                         if let Err(_) = trusted_write.try_send(NetworkMessage::GetHeaders(GetHeadersMessage {
295                                                 version: 70015,
296                                                 locator_hashes: vec![unsafe { HIGHEST_HEADER.as_ref().unwrap() }.lock().unwrap().0.clone()],
297                                                 stop_hash: Default::default(),
298                                         })) {
299                                                 return future::err(());
300                                         }
301                                         if let Err(_) = trusted_write.try_send(NetworkMessage::GetAddr) {
302                                                 return future::err(());
303                                         }
304                                 },
305                                 NetworkMessage::Addr(addrs) => {
306                                         unsafe { DATA_STORE.as_ref().unwrap() }.add_fresh_nodes(&addrs);
307                                 },
308                                 NetworkMessage::Headers(headers) => {
309                                         if headers.is_empty() {
310                                                 return future::ok(());
311                                         }
312                                         let mut header_map = unsafe { HEADER_MAP.as_ref().unwrap() }.lock().unwrap();
313                                         let mut height_map = unsafe { HEIGHT_MAP.as_ref().unwrap() }.lock().unwrap();
314
315                                         if let Some(height) = header_map.get(&headers[0].prev_blockhash).cloned() {
316                                                 for i in 0..headers.len() {
317                                                         let hash = headers[i].bitcoin_hash();
318                                                         if i < headers.len() - 1 && headers[i + 1].prev_blockhash != hash {
319                                                                 return future::err(());
320                                                         }
321                                                         header_map.insert(headers[i].bitcoin_hash(), height + 1 + (i as u64));
322                                                         height_map.insert(height + 1 + (i as u64), headers[i].bitcoin_hash());
323                                                 }
324
325                                                 let top_height = height + headers.len() as u64;
326                                                 *unsafe { HIGHEST_HEADER.as_ref().unwrap() }.lock().unwrap()
327                                                         = (headers.last().unwrap().bitcoin_hash(), top_height);
328                                                 printer.set_stat(printer::Stat::HeaderCount(top_height));
329
330                                                 if top_height >= starting_height as u64 {
331                                                         if let Err(_) = trusted_write.try_send(NetworkMessage::GetData(vec![Inventory {
332                                                                 inv_type: InvType::WitnessBlock,
333                                                                 hash: height_map.get(&(top_height - 216)).unwrap().clone(),
334                                                         }])) {
335                                                                 return future::err(());
336                                                         }
337                                                 }
338                                         } else {
339                                                 // Wat? Lets start again...
340                                                 printer.add_line("Got unconnected headers message from local trusted peer".to_string(), true);
341                                         }
342                                         if let Err(_) = trusted_write.try_send(NetworkMessage::GetHeaders(GetHeadersMessage {
343                                                 version: 70015,
344                                                 locator_hashes: vec![unsafe { HIGHEST_HEADER.as_ref().unwrap() }.lock().unwrap().0.clone()],
345                                                 stop_hash: Default::default(),
346                                         })) {
347                                                 return future::err(())
348                                         }
349                                 },
350                                 NetworkMessage::Block(block) => {
351                                         let hash = block.header.bitcoin_hash();
352                                         let header_map = unsafe { HEADER_MAP.as_ref().unwrap() }.lock().unwrap();
353                                         let height = *header_map.get(&hash).expect("Got loose block from trusted peer we coulnd't have requested");
354                                         if height == unsafe { HIGHEST_HEADER.as_ref().unwrap() }.lock().unwrap().1 - 216 {
355                                                 *unsafe { REQUEST_BLOCK.as_ref().unwrap() }.lock().unwrap() = Arc::new((height, hash, block));
356                                                 if !SCANNING.swap(true, Ordering::SeqCst) {
357                                                         scan_net();
358                                                         poll_dnsseeds();
359                                                 }
360                                         }
361                                 },
362                                 NetworkMessage::Ping(v) => {
363                                         if let Err(_) = trusted_write.try_send(NetworkMessage::Pong(v)) {
364                                                 return future::err(())
365                                         }
366                                 },
367                                 _ => {},
368                         }
369                         future::ok(())
370                 }).then(|_| {
371                         future::err(())
372                 })
373         }).then(move |_: Result<(), ()>| {
374                 if !START_SHUTDOWN.load(Ordering::Relaxed) {
375                         printer.add_line("Lost connection from trusted peer".to_string(), true);
376                         make_trusted_conn(trusted_sockaddr);
377                 }
378                 future::ok(())
379         }));
380 }
381
382 fn main() {
383         if env::args().len() != 3 {
384                 println!("USAGE: dnsseed-rust datastore localPeerAddress");
385                 return;
386         }
387
388         unsafe { HEADER_MAP = Some(Box::new(Mutex::new(HashMap::with_capacity(600000)))) };
389         unsafe { HEIGHT_MAP = Some(Box::new(Mutex::new(HashMap::with_capacity(600000)))) };
390         unsafe { HEADER_MAP.as_ref().unwrap() }.lock().unwrap().insert(genesis_block(Network::Bitcoin).bitcoin_hash(), 0);
391         unsafe { HEIGHT_MAP.as_ref().unwrap() }.lock().unwrap().insert(0, genesis_block(Network::Bitcoin).bitcoin_hash());
392         unsafe { HIGHEST_HEADER = Some(Box::new(Mutex::new((genesis_block(Network::Bitcoin).bitcoin_hash(), 0)))) };
393         unsafe { REQUEST_BLOCK = Some(Box::new(Mutex::new(Arc::new((0, genesis_block(Network::Bitcoin).bitcoin_hash(), genesis_block(Network::Bitcoin)))))) };
394
395         let trt = tokio::runtime::Builder::new()
396                 .blocking_threads(2).core_threads(num_cpus::get().max(1) * 3)
397                 .build().unwrap();
398
399         let _ = trt.block_on_all(future::lazy(|| {
400                 let mut args = env::args();
401                 args.next();
402                 let path = args.next().unwrap();
403                 let addr = args.next().unwrap();
404
405                 Store::new(path).and_then(move |store| {
406                         unsafe { DATA_STORE = Some(Box::new(store)) };
407                         let store = unsafe { DATA_STORE.as_ref().unwrap() };
408                         unsafe { PRINTER = Some(Box::new(Printer::new(store))) };
409
410                         let trusted_sockaddr: SocketAddr = addr.parse().unwrap();
411                         make_trusted_conn(trusted_sockaddr);
412
413                         reader::read(store, unsafe { PRINTER.as_ref().unwrap() });
414
415                         future::ok(())
416                 }).or_else(|_| {
417                         future::err(())
418                 })
419         }));
420
421         tokio::run(future::lazy(|| {
422                 unsafe { DATA_STORE.as_ref().unwrap() }.save_data()
423         }));
424 }