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