Allow NODE_NETWORK_LIMITED for full node consideration
[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::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;
13
14 use bitcoin_hashes::sha256d;
15
16 use bitcoin::blockdata::constants::genesis_block;
17 use bitcoin::network::constants::Network;
18 use bitcoin::network::message::NetworkMessage;
19 use bitcoin::network::message_blockdata::{GetHeadersMessage, Inventory, InvType};
20 use bitcoin::util::hash::BitcoinHash;
21
22 use printer::{Printer, Stat};
23 use peer::Peer;
24 use datastore::{AddressState, Store, U64Setting, RegexSetting};
25 use timeout_stream::TimeoutStream;
26
27 use tokio::prelude::*;
28 use tokio::timer::Delay;
29
30 static mut HIGHEST_HEADER: Option<Box<Mutex<(sha256d::Hash, u64)>>> = None;
31 static mut HEADER_MAP: Option<Box<Mutex<HashMap<sha256d::Hash, u64>>>> = None;
32 static mut HEIGHT_MAP: Option<Box<Mutex<HashMap<u64, sha256d::Hash>>>> = None;
33 static mut DATA_STORE: Option<Box<Store>> = None;
34 static mut PRINTER: Option<Box<Printer>> = None;
35 pub static START_SHUTDOWN: AtomicBool = AtomicBool::new(false);
36
37 struct PeerState {
38         recvd_version: bool,
39         recvd_verack: bool,
40         recvd_addrs: bool,
41         recvd_block: bool,
42         node_services: u64,
43         fail_reason: AddressState,
44         request: (u64, sha256d::Hash),
45 }
46
47 pub fn scan_node(scan_time: Instant, node: SocketAddr) {
48         if START_SHUTDOWN.load(Ordering::Relaxed) { return; }
49         let printer = unsafe { PRINTER.as_ref().unwrap() };
50         let store = unsafe { DATA_STORE.as_ref().unwrap() };
51
52         let peer_state = Arc::new(Mutex::new(PeerState {
53                 recvd_version: false,
54                 recvd_verack: false,
55                 recvd_addrs: false,
56                 recvd_block: false,
57                 node_services: 0,
58                 fail_reason: AddressState::Timeout,
59                 request: (0, Default::default()),
60         }));
61         let final_peer_state = Arc::clone(&peer_state);
62
63         let peer = Delay::new(scan_time).then(move |_| {
64                 printer.set_stat(Stat::NewConnection);
65                 let timeout = store.get_u64(U64Setting::RunTimeout);
66                 Peer::new(node.clone(), Duration::from_secs(timeout), printer)
67         });
68         tokio::spawn(peer.and_then(move |(mut write, read)| {
69                 let requested_height = unsafe { HIGHEST_HEADER.as_ref().unwrap() }.lock().unwrap().1 - 1008;
70                 let requested_block = unsafe { HEIGHT_MAP.as_ref().unwrap() }.lock().unwrap().get(&requested_height).unwrap().clone();
71                 peer_state.lock().unwrap().request = (requested_height, requested_block);
72
73                 TimeoutStream::new_timeout(read, scan_time + Duration::from_secs(store.get_u64(U64Setting::RunTimeout))).map_err(|_| { () }).for_each(move |msg| {
74                         let mut state_lock = peer_state.lock().unwrap();
75                         macro_rules! check_set_flag {
76                                 ($recvd_flag: ident, $msg: expr) => { {
77                                         if state_lock.$recvd_flag {
78                                                 state_lock.fail_reason = AddressState::ProtocolViolation;
79                                                 printer.add_line(format!("Updating {} to ProtocolViolation due to dup {}", node, $msg), true);
80                                                 state_lock.$recvd_flag = false;
81                                                 return future::err(());
82                                         }
83                                         state_lock.$recvd_flag = true;
84                                 } }
85                         }
86                         state_lock.fail_reason = AddressState::TimeoutDuringRequest;
87                         match msg {
88                                 NetworkMessage::Version(ver) => {
89                                         if ver.start_height < 0 || ver.start_height as u64 > state_lock.request.0 + 1008*2 {
90                                                 state_lock.fail_reason = AddressState::HighBlockCount;
91                                                 return future::err(());
92                                         }
93                                         if (ver.start_height as u64) < state_lock.request.0 {
94                                                 printer.add_line(format!("Updating {} to LowBlockCount ({} < {})", node, ver.start_height, state_lock.request.0), true);
95                                                 state_lock.fail_reason = AddressState::LowBlockCount;
96                                                 return future::err(());
97                                         }
98                                         let min_version = store.get_u64(U64Setting::MinProtocolVersion);
99                                         if (ver.version as u64) < min_version {
100                                                 printer.add_line(format!("Updating {} to LowVersion ({} < {})", node, ver.version, min_version), true);
101                                                 state_lock.fail_reason = AddressState::LowVersion;
102                                                 return future::err(());
103                                         }
104                                         if ver.services & (1 | (1 << 10)) == 0 {
105                                                 printer.add_line(format!("Updating {} to NotFullNode (services {:x})", node, ver.services), true);
106                                                 state_lock.fail_reason = AddressState::NotFullNode;
107                                                 return future::err(());
108                                         }
109                                         if !store.get_regex(RegexSetting::SubverRegex).is_match(&ver.user_agent) {
110                                                 printer.add_line(format!("Updating {} to BadVersion subver {}", node, ver.user_agent.replace(|c: char| !c.is_ascii() || c < ' ' || c > '~', "")), true);
111                                                 state_lock.fail_reason = AddressState::BadVersion;
112                                                 return future::err(());
113                                         }
114                                         check_set_flag!(recvd_version, "version");
115                                         state_lock.node_services = ver.services;
116                                         if let Err(_) = write.try_send(NetworkMessage::Verack) {
117                                                 return future::err(());
118                                         }
119                                 },
120                                 NetworkMessage::Verack => {
121                                         check_set_flag!(recvd_verack, "verack");
122                                         if let Err(_) = write.try_send(NetworkMessage::GetAddr) {
123                                                 return future::err(());
124                                         }
125                                         if let Err(_) = write.try_send(NetworkMessage::GetData(vec![Inventory {
126                                                 inv_type: InvType::WitnessBlock,
127                                                 hash: state_lock.request.1,
128                                         }])) {
129                                                 return future::err(());
130                                         }
131                                 },
132                                 NetworkMessage::Ping(v) => {
133                                         if let Err(_) = write.try_send(NetworkMessage::Pong(v)) {
134                                                 return future::err(())
135                                         }
136                                 },
137                                 NetworkMessage::Addr(addrs) => {
138                                         if addrs.len() > 1000 {
139                                                 state_lock.fail_reason = AddressState::ProtocolViolation;
140                                                 printer.add_line(format!("Updating {} to ProtocolViolation due to oversized addr: {}", node, addrs.len()), true);
141                                                 state_lock.recvd_addrs = false;
142                                                 return future::err(());
143                                         }
144                                         state_lock.recvd_addrs = true;
145                                         unsafe { DATA_STORE.as_ref().unwrap() }.add_fresh_nodes(&addrs);
146                                 },
147                                 NetworkMessage::Block(block) => {
148                                         if block.header.bitcoin_hash() != state_lock.request.1 ||
149                                                         !block.check_merkle_root() || !block.check_witness_commitment() {
150                                                 state_lock.fail_reason = AddressState::ProtocolViolation;
151                                                 printer.add_line(format!("Updating {} to ProtocolViolation due to bad block", node), true);
152                                                 return future::err(());
153                                         }
154                                         check_set_flag!(recvd_block, "block");
155                                 },
156                                 _ => {},
157                         }
158                         future::ok(())
159                 }).then(|_| {
160                         future::err(())
161                 })
162         }).then(move |_: Result<(), ()>| {
163                 let printer = unsafe { PRINTER.as_ref().unwrap() };
164                 let store = unsafe { DATA_STORE.as_ref().unwrap() };
165                 printer.set_stat(Stat::ConnectionClosed);
166
167                 let state_lock = final_peer_state.lock().unwrap();
168                 if state_lock.recvd_version && state_lock.recvd_verack &&
169                                 state_lock.recvd_addrs && state_lock.recvd_block {
170                         store.set_node_state(node, AddressState::Good, state_lock.node_services);
171                 } else {
172                         assert!(state_lock.fail_reason != AddressState::Good);
173                         store.set_node_state(node, state_lock.fail_reason, 0);
174                 }
175                 future::ok(())
176         }));
177 }
178
179 fn scan_net() {
180         tokio::spawn(future::lazy(|| {
181                 let store = unsafe { DATA_STORE.as_ref().unwrap() };
182                 let mut scan_nodes = store.get_next_scan_nodes();
183                 let per_iter_time = Duration::from_millis(1000 / store.get_u64(U64Setting::ConnsPerSec));
184                 let mut iter_time = Instant::now();
185
186                 for node in scan_nodes.drain(..) {
187                         scan_node(iter_time, node);
188                         iter_time += per_iter_time;
189                 }
190                 Delay::new(iter_time).then(|_| {
191                         let store = unsafe { DATA_STORE.as_ref().unwrap() };
192                         store.save_data().then(|_| {
193                                 if !START_SHUTDOWN.load(Ordering::Relaxed) {
194                                         scan_net();
195                                 }
196                                 future::ok(())
197                         })
198                 })
199         }));
200 }
201
202 fn make_trusted_conn(trusted_sockaddr: SocketAddr) {
203         let printer = unsafe { PRINTER.as_ref().unwrap() };
204         let trusted_peer = Peer::new(trusted_sockaddr.clone(), Duration::from_secs(600), printer);
205         tokio::spawn(trusted_peer.and_then(move |(mut trusted_write, trusted_read)| {
206                 printer.add_line("Connected to local peer".to_string(), false);
207                 let mut starting_height = 0;
208                 TimeoutStream::new_persistent(trusted_read, Duration::from_secs(600)).map_err(|_| { () }).for_each(move |msg| {
209                         if START_SHUTDOWN.load(Ordering::Relaxed) {
210                                 return future::err(());
211                         }
212                         match msg {
213                                 NetworkMessage::Version(ver) => {
214                                         if let Err(_) = trusted_write.try_send(NetworkMessage::Verack) {
215                                                 return future::err(())
216                                         }
217                                         starting_height = ver.start_height;
218                                 },
219                                 NetworkMessage::Verack => {
220                                         if let Err(_) = trusted_write.try_send(NetworkMessage::GetHeaders(GetHeadersMessage {
221                                                 version: 70015,
222                                                 locator_hashes: vec![unsafe { HIGHEST_HEADER.as_ref().unwrap() }.lock().unwrap().0.clone()],
223                                                 stop_hash: Default::default(),
224                                         })) {
225                                                 return future::err(());
226                                         }
227                                         if let Err(_) = trusted_write.try_send(NetworkMessage::GetAddr) {
228                                                 return future::err(());
229                                         }
230                                 },
231                                 NetworkMessage::Addr(addrs) => {
232                                         unsafe { DATA_STORE.as_ref().unwrap() }.add_fresh_nodes(&addrs);
233                                 },
234                                 NetworkMessage::Headers(headers) => {
235                                         if headers.is_empty() {
236                                                 return future::ok(());
237                                         }
238                                         let mut header_map = unsafe { HEADER_MAP.as_ref().unwrap() }.lock().unwrap();
239                                         let mut height_map = unsafe { HEIGHT_MAP.as_ref().unwrap() }.lock().unwrap();
240                                         if let Some(height) = header_map.get(&headers[0].prev_blockhash).cloned() {
241                                                 for i in 0..headers.len() {
242                                                         let hash = headers[i].bitcoin_hash();
243                                                         if i < headers.len() - 1 && headers[i + 1].prev_blockhash != hash {
244                                                                 return future::err(());
245                                                         }
246                                                         header_map.insert(headers[i].bitcoin_hash(), height + 1 + (i as u64));
247                                                         height_map.insert(height + 1 + (i as u64), headers[i].bitcoin_hash());
248                                                 }
249                                                 let top_height = height + headers.len() as u64;
250                                                 *unsafe { HIGHEST_HEADER.as_ref().unwrap() }.lock().unwrap()
251                                                         = (headers.last().unwrap().bitcoin_hash(), top_height);
252                                                 printer.set_stat(printer::Stat::HeaderCount(top_height));
253                                                 if top_height >= starting_height as u64 {
254                                                         scan_net();
255                                                 }
256                                         } else {
257                                                 // Wat? Lets start again...
258                                                 printer.add_line("Got unconnected headers message from local trusted peer".to_string(), true);
259                                         }
260                                         if let Err(_) = trusted_write.try_send(NetworkMessage::GetHeaders(GetHeadersMessage {
261                                                 version: 70015,
262                                                 locator_hashes: vec![unsafe { HIGHEST_HEADER.as_ref().unwrap() }.lock().unwrap().0.clone()],
263                                                 stop_hash: Default::default(),
264                                         })) {
265                                                 return future::err(())
266                                         }
267                                 },
268                                 NetworkMessage::Ping(v) => {
269                                         if let Err(_) = trusted_write.try_send(NetworkMessage::Pong(v)) {
270                                                 return future::err(())
271                                         }
272                                 },
273                                 _ => {},
274                         }
275                         future::ok(())
276                 }).then(|_| {
277                         future::err(())
278                 })
279         }).then(move |_: Result<(), ()>| {
280                 if !START_SHUTDOWN.load(Ordering::Relaxed) {
281                         printer.add_line("Lost connection from trusted peer".to_string(), true);
282                         make_trusted_conn(trusted_sockaddr);
283                 }
284                 future::ok(())
285         }));
286 }
287
288 fn main() {
289         if env::args().len() != 3 {
290                 println!("USAGE: dnsseed-rust datastore localPeerAddress");
291                 return;
292         }
293
294         unsafe { HEADER_MAP = Some(Box::new(Mutex::new(HashMap::new()))) };
295         unsafe { HEIGHT_MAP = Some(Box::new(Mutex::new(HashMap::new()))) };
296         unsafe { HEADER_MAP.as_ref().unwrap() }.lock().unwrap().insert(genesis_block(Network::Bitcoin).bitcoin_hash(), 0);
297         unsafe { HEIGHT_MAP.as_ref().unwrap() }.lock().unwrap().insert(0, genesis_block(Network::Bitcoin).bitcoin_hash());
298         unsafe { HIGHEST_HEADER = Some(Box::new(Mutex::new((genesis_block(Network::Bitcoin).bitcoin_hash(), 0)))) };
299
300         tokio::run(future::lazy(|| {
301                 let mut args = env::args();
302                 args.next();
303                 let path = args.next().unwrap();
304                 let addr = args.next().unwrap();
305
306                 Store::new(path).and_then(move |store| {
307                         unsafe { DATA_STORE = Some(Box::new(store)) };
308                         let store = unsafe { DATA_STORE.as_ref().unwrap() };
309                         unsafe { PRINTER = Some(Box::new(Printer::new(store))) };
310
311                         let trusted_sockaddr: SocketAddr = addr.parse().unwrap();
312                         make_trusted_conn(trusted_sockaddr);
313
314                         reader::read(store, unsafe { PRINTER.as_ref().unwrap() });
315
316                         future::ok(())
317                 }).or_else(|_| {
318                         future::err(())
319                 })
320         }));
321
322         tokio::run(future::lazy(|| {
323                 unsafe { DATA_STORE.as_ref().unwrap() }.save_data()
324         }));
325 }