Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
use std::path;

use tracing::{
	info_span,
	instrument,
	Instrument,
	Span
};
use tokio::task;
use futures::future;

use crate::net::InterfaceAddress;
use crate::config::{
	Config,
	HandlerDirectory
};
use crate::control::{
	KeyArg,
	ControlSocket,
	AnyRequest,
	DaemonReq,
	NodeReq,
	MirrorReq,
	DispatcherReq,
	RouterReq,
	NodeJoinRequest
};
use crate::event::{
	AnyEvent,
	DaemonEvent,
	Dispatcher,
	DispatcherSetup,
	Interest,
	parse_all,
	launch,
	get_all_entries
};
use crate::message::Payload;
use crate::node::Node;
use crate::net::router::{
	Router,
	RouterMonitor,
	RouterSetup
};
use crate::net::Mirror;
use crate::peer::NodeID;
use crate::store::{
	self,
	Store
};
use crate::util::*;


#[derive(Debug)]
pub struct Daemon {
	node: Node,
	ctrl_rx: Receiver<AnyRequest>,
	net: NetBundle,
	dispatch: DispatchBundle,
	mirror_query_tx: Option<Sender<MirrorReq>>,
	tasks: Vec<Task>,
	span: Span
}

#[derive(Debug)]
pub struct NetBundle {
	pub inbound_pkt_rx: Receiver<PktFrom>,
	pub router_tx: Sender<RouterReq>,
	pub monitor: RouterMonitor
}

#[derive(Debug)]
pub struct DispatchBundle {
	pub event_tx: Sender<AnyEvent>,
	pub query_tx: Sender<DispatcherReq>,
	pub interest_tx: Sender<Interest>
}

impl Daemon {

	pub fn from_raw_parts(
		node: Node,
		ctrl_rx: Receiver<AnyRequest>,
		net: NetBundle,
		dispatch: DispatchBundle,
		tasks: Vec<Task>,
		span: Span)
		-> Self
	{
		Self {
			node,
			ctrl_rx,
			net,
			dispatch,
			mirror_query_tx: None,
			tasks,
			span
		}
	}

	pub async fn init(cfg: Config) -> Option<Self> {

		let span = info_span!("daemon");
		let init = info_span!("daemon_init");
		let _g = init.enter();

		let addrs: Vec<InterfaceAddress> = cfg.server.addrs
			.iter()
			.flatten()
			.map(|addr| addr.parse())
			.filter_map(|parse_res| parse_res
				.map_err(|err| error!(:init, %err, "invalid interface address"))
				.ok())
			.collect();

		let db = Store::open(&cfg.db_path())
			.map_err(|err| error!(:init, %err, "failed to open db"))
			.ok()?;

		let (ctrl_task, ctrl_rx) = Self::spawn_control_socket(
			cfg.cnsprcy.control_socket_path,
			&span
		)?;

		let (dispatcher_task, dispatch) = Self::spawn_dispatcher(
			cfg.handlers,
			&db,
			&span
		).in_current_span().await?;

		// if there is no key in the db, store key from the config file
		//TODO find a better approach and remove this
		match db.read_config(store::Config::KEY) {
			Ok(Some(_)) => {},
			Ok(None) => {
				let serialized = cfg.cnsprcy.key.to_string();
				match db.write_config(store::Config::KEY, &serialized) {
					Ok(true) => {},
					Ok(false) => {
						error!(:init, "failed to store key in db");
						return None;
					},
					Err(err) => {
						error!(:init, %err, "failed to store key in db");
						return None;
					}
				}
			},
			Err(err) => {
				error!(:init, %err, "failed to check if key is already stored");
				return None;
			}
		}

		let (router_task, outbound_pkt_tx, net) = Self::spawn_router(
			cfg.cnsprcy.key,
			addrs,
			&span
		).in_current_span().await;

		let mut tasks = vec![
			ctrl_task,
			dispatcher_task,
			router_task
		];

		let (mirror_task, mirror_query_tx) = Self::spawn_mirror(
			cfg.server.interfaces,
			net.router_tx.clone(),
			&span
		).in_current_span().await.unzip();
		tasks.extend(mirror_task);

		let node = Node::load(db, outbound_pkt_tx, dispatch.event_tx.clone())
			.map_err(|err| error!(:init, %err, "failed to load node from db"))
			.ok()
			.flatten()?;

		info!(:init, "complete");

		Some(Self {node, ctrl_rx, net, dispatch, mirror_query_tx, tasks, span})
	}

	pub async fn run(mut self) -> Option<()> {
		self.dispatch_event(DaemonEvent::Start);

		let mut ticker = self.span.in_scope(Sleeper::start);
		let mut is_active = true;

		loop {
			if is_active != *self.net.monitor.borrow() {
				if !is_active {
					info!(@self, "entering active state");
					self.dispatch_event(DaemonEvent::Active);
					is_active = true;
				}
				else {
					info!(@self, "entering dormant state");
					self.dispatch_event(DaemonEvent::Inactive);
					is_active = false;
				}
			}
			tokio::select! {
				// Poll futures in order, meant to favor commands
				biased;
				// Ctrl+C interrupt signal received
				_ = tokio::signal::ctrl_c() => {
					info!(@self, "Interrupt signal received, shutting down!");
					break;
				},
				// Incoming client query
				q = self.ctrl_rx.recv() => match q {
					Some(q) => match self.handle_query(q).await {
						//TODO: push ticker here?
						true => continue,
						false => break,
					},
					None => {
						error!(@self, "control socket shut down unexpectedly!");
						break
					}
				},
				// Router active/dormant status changed
				r = self.net.monitor.changed() => if r.is_err() {
					error!(@self, "router crashed, shutting down!");
					break;
				},
				// Incoming packet, pass it on to the node
				rep = self.net.inbound_pkt_rx.recv() => match rep {
					Some((from, pkt)) => self.span.in_scope(|| {
						self.node.handle_pkt(from, pkt);
						ticker.push(self.node.tick_peers());
					}),
					None => {
						error!(@self, "router crashed, shutting down!");
						break;
					}
				},
				// Timed update is due
				Some(()) = ticker.sleep(), if is_active => {
					let _g = self.span.enter();
					ticker.push(self.node.tick_peers());
				}
			}
		}

		let _g = self.span.enter();
		self.dispatch_event(DaemonEvent::Stop);
		// dropping the node closes dispatcher and outbound pkt channels
		drop(self.node);
		drop(self.dispatch.event_tx);
		self.ctrl_rx.close();
		self.mirror_query_tx.take();
		future::join_all(self.tasks).in_current_span().await;
		info!("Done, shutdown complete!");

		Some(())
	}

	#[instrument(skip(daemon_span), level = "info", name = "control socket")]
	fn spawn_control_socket(
		at: path::PathBuf,
		daemon_span: &Span)
		-> Option<(Task, Receiver<AnyRequest>)>
	{
		// control channel
		let (tx, rx) = new_channel();

		//info!("Starting control server…");
		let socket = ControlSocket::open(tx, at, daemon_span)?;

		let ctrl_task = tokio::task::spawn(async move {
			socket.run().await
		});

		//info!("Started control server!");
		info!("Done!");

		Some((ctrl_task, rx))
	}

	async fn spawn_dispatcher(
		handlers: Option<Vec<HandlerDirectory>>,
		db: &Store,
		daemon_span: &Span)
		-> Option<(Task, DispatchBundle)>
	{
		let DispatcherSetup {
			dispatcher,
			event_tx,
			query_tx,
			interest_tx
		} = Dispatcher::setup(daemon_span);

		let task = task::spawn(dispatcher.run());

		let resolver = |name: &str| -> Option<NodeID> {
			db.find_conspirator_id(name)
				.map_err(|err| error!(%err, name, "failed to look up id"))
				.ok()
				.flatten()
		};

		for handler_dir in handlers.iter().flatten() {
			get_all_entries(&handler_dir.path)
				.in_current_span()
				.await
				.map_err(|err| error!(%err, ?handler_dir, "failed to load"))
				.map(|entries| parse_all(&resolver, entries)
					.into_iter()
					.flat_map(|res| res
						.map_err(|err| error!(%err, "failed to parse handler"))
						.ok()
					)
				)
				.ok()
				.into_iter()
				.flatten()
				.map(launch)
				.for_each(|interest| {let _ = interest_tx.send(interest);});
		}
		Some((task, DispatchBundle {event_tx, query_tx, interest_tx}))
	}

	async fn spawn_router(
		key: KeyArg,
		addrs: Vec<InterfaceAddress>,
		daemon_span: &Span)
		-> (Task, Sender<PktTo>, NetBundle)
	{
		let RouterSetup {
			router,
			inbound_packet_receiver,
			router_monitor,
			outbound_packet_sender,
			router_query_sender
		} = Router::setup(key, daemon_span);
		let router_task = task::spawn(router.run());

		for addr in addrs {
			let reply = router_query_sender
				.request(RouterReq::BindInterface, addr.clone())
				.in_current_span()
				.await
				.unwrap_or(false);
			if !reply {
				warn!(%addr, "skipping address");
			}
		}
		let bundle = NetBundle {
			inbound_pkt_rx: inbound_packet_receiver,
			router_tx: router_query_sender,
			monitor: router_monitor
		};

		(router_task, outbound_packet_sender, bundle)
	}

	async fn spawn_mirror(
		interfaces: Option<Vec<String>>,
		router_query_sender: Sender<RouterReq>,
		daemon_span: &Span)
		-> Option<(Task, Sender<MirrorReq>)>
	{
		let (query_tx, query_rx) = new_channel();
		match Mirror::init(interfaces?, query_rx, daemon_span).await {
			Ok(mirror) => Some((
				task::spawn(mirror.track(router_query_sender)),
				query_tx
			)),
			Err(error) => {
				error!(?error, "failed to initialize Mirror");
				None
			}
		}
	}


	fn dispatch_event<E: Into<AnyEvent>>(&self, event: E) {
		self.dispatch.event_tx
			.send(event.into())
			.unwrap_or_else(|e| error!(@self, event = ?e.0, "failed to send"))
	}

	/// Returns false if shutdown signal received
	async fn handle_query(&mut self, req: AnyRequest) -> bool {
		// need to clone because we might call &mut self methods later
		//let clone_span = self.span.clone();
		//let _g = clone_span.enter();
		let _g = self.span.enter();

		match req {
			AnyRequest::Daemon(DaemonReq::GetStatus(((), replier))) => {
				let addrs = self.net.router_tx
					.get(RouterReq::GetInterfaces)
					.timeout_ms(100)
					.in_current_span()
					.await
					.ok()
					.and_then(Result::ok)
					.unwrap_or_default();
				let handlers = self.dispatch.query_tx
					.get(DispatcherReq::GetHandlers)
					.timeout_ms(100)
					.in_current_span()
					.await
					.ok()
					.and_then(Result::ok)
					.unwrap_or_default();
				self.node.handle_request(
					NodeReq::GetStatus(((addrs, handlers), replier))
				);
				return true
			},
			AnyRequest::Daemon(DaemonReq::StopServer(req)) => {
				info!("received termination signal, shutting down…");
				self.node.leave();
				req.reply(true);
				// make sure the Quit packets get sent out
				tokio::task::yield_now().await;
				return false
			},
			AnyRequest::Daemon(DaemonReq::Invite((public_key, replier))) => {
				let addrs = self.net.router_tx
					.get(RouterReq::GetInterfaces)
					.timeout_ms(100)
					.in_current_span()
					.await
					.ok()
					.and_then(Result::ok)
					.unwrap_or_default()
					.iter()
					.map(InterfaceAddress::get_address)
					.collect();
				let req = NodeReq::Invite(((public_key, addrs), replier));
				self.node.handle_request(req);
			},
			AnyRequest::Daemon(DaemonReq::Accept((invitation, replier))) => {
				// get the node to decrypt the invite (this also stores the new key in the db)
				let content = match self.node.decrypt(invitation) {
					Ok(content) => content,
					Err(err) => {
						error!(%err, "failed to accept invitation");
						replier.reply(false);
						return true;
					}
				};
				// send out RouterReq::Rekey()
				let rekeyed = self.net.router_tx
					.request(RouterReq::Rekey, content.key)
					.timeout_ms(100)
					.in_current_span()
					.await
					.ok()
					.and_then(Result::ok)
					.unwrap_or(false);
				if !rekeyed {
					error!("re-key request failed or timed out");
					replier.reply(false);
					return true;
				}

				// add inductor as a Peer
				let Some(&addr) = content.addresses.first() else {
					error!("invitation contains no addresses");
					replier.reply(false);
					return true;
				};
				let id = content.id.into();
				let join_req = NodeReq::Join((
					NodeJoinRequest { id, name: content.name, addr },
					replier
				));
				self.node.handle_request(join_req);

				// send out pings to the other addreses, if any
				//TODO: if there are multiple routes, this is likely to pick the slowest
				for address in content.addresses.iter().skip(1).copied() {
					debug!(%address, %id, "reaching out");
					self.node.send_payload(
						id.into(),
						Payload::None,
						Some(address)
					);
				}
			},
			AnyRequest::Node(req) => self.node.handle_request(req),
			AnyRequest::Mirror(req) => match self.mirror_query_tx.as_ref() {
				Some(tx) => tx.send_request(req),
				None => match req {
					MirrorReq::Enable((_, r)) |
					MirrorReq::Disable((_, r)) => r.reply(false),
				}
			}
			AnyRequest::Router(req) => self.net.router_tx.send_request(req),
			AnyRequest::Dispatcher(req) =>
				self.dispatch.query_tx.send_request(req),
		}
		true
	}
}