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