mod directory;
mod endpoint;
mod inbound;
mod outbox;
use crate::guard::{self, Guard};
use crate::reach::{Held, Reach};
use crate::roster::{self, Change, Role, Roster};
use crate::rules::{self, Rule};
use crate::types::{Address, Connector, Letter, Message, Peer, Sent};
use crate::wire::{self, ALPN, Agent, Request, Response, Ticket};
use anyhow::{Context, Result, anyhow, bail};
use iroh::endpoint::Connection;
use iroh::protocol::Router;
use iroh::{Endpoint, EndpointAddr, EndpointId};
use std::collections::{HashMap, VecDeque};
use std::path::{Path, PathBuf};
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex, MutexGuard};
use std::time::{Duration, Instant};
use tokio::sync::{mpsc, watch};
use tokio::task::JoinSet;
pub const INVITE_FOR: Duration = Duration::from_hours(1);
const CONNECT_TIMEOUT: Duration = Duration::from_secs(10);
const CALL_TIMEOUT: Duration = Duration::from_secs(20);
const INBOX_SIZE: usize = 256;
const HEARD_MAX: usize = 1000;
pub struct Node {
inner: Arc<Inner>,
router: Router,
}
struct Inner {
endpoint: Endpoint,
dir: PathBuf,
roster: Mutex<Option<Roster>>,
agents: Mutex<Vec<(Agent, Reach)>>,
senders: Mutex<Vec<String>>,
ready: AtomicBool,
heard: Mutex<VecDeque<(String, u8)>>,
seen: Mutex<HashMap<EndpointId, directory::Seen>>,
invites: Mutex<HashMap<String, Instant>>,
guard: Mutex<Guard>,
held: Mutex<Held>,
taken: Mutex<VecDeque<String>>,
rules: Mutex<Vec<Rule>>,
asked: Mutex<VecDeque<(String, EndpointId, String)>>,
outbox: Mutex<Vec<outbox::Queued>>,
inbox: mpsc::Sender<Message>,
reply_command: Mutex<String>,
network_name: Mutex<Option<String>>,
changed: watch::Sender<()>,
}
fn locked<T>(m: &Mutex<T>) -> MutexGuard<'_, T> {
m.lock().unwrap_or_else(std::sync::PoisonError::into_inner)
}
impl Node {
pub async fn start(dir: &Path, connector: &Connector) -> Result<(Self, mpsc::Receiver<Message>)> {
std::fs::create_dir_all(dir)?;
let key = endpoint::load_key(dir)?;
let endpoint = endpoint::bind(key, connector).await?;
let (tx, rx) = mpsc::channel(INBOX_SIZE);
let inner = Arc::new(Inner {
endpoint: endpoint.clone(),
dir: dir.to_path_buf(),
roster: Mutex::new(Roster::load(dir)?),
agents: Mutex::default(),
senders: Mutex::default(),
ready: AtomicBool::new(false),
heard: Mutex::default(),
seen: Mutex::default(),
invites: Mutex::default(),
guard: Mutex::default(),
held: Mutex::default(),
taken: Mutex::default(),
rules: Mutex::default(),
asked: Mutex::default(),
outbox: Mutex::default(),
inbox: tx,
reply_command: Mutex::new("codync-network".into()),
network_name: Mutex::default(),
changed: watch::Sender::new(()),
});
let router = Router::builder(endpoint).accept(ALPN, inbound::Handler(inner.clone())).spawn();
endpoint::settle(&inner.endpoint, connector).await;
inner.locate(inner.endpoint.addr())?;
inner.clone().hello_all();
tokio::spawn(outbox::retry_loop(Arc::downgrade(&inner)));
tokio::spawn(endpoint::follow_addr(Arc::downgrade(&inner), inner.endpoint.watch_addr()));
Ok((Self { inner, router }, rx))
}
pub fn id(&self) -> EndpointId {
self.inner.endpoint.id()
}
pub fn name(&self) -> Option<String> {
locked(&self.inner.roster).as_ref().map(|r| r.name(&self.id()))
}
pub fn network_id(&self) -> Option<String> {
locked(&self.inner.roster).as_ref().map(|r| r.network.to_string())
}
pub fn role(&self) -> Option<Role> {
locked(&self.inner.roster).as_ref().and_then(|r| r.role(&self.id()))
}
pub fn create(&self, name: &str) -> Result<String> {
let mut roster = locked(&self.inner.roster);
if roster.is_some() {
bail!("this computer is already in a network");
}
let key = self.inner.endpoint.secret_key();
let (new, root) = Roster::create(key, check_name(name)?, self.inner.endpoint.addr(), wire::now_ms());
self.inner.save(&new)?;
*roster = Some(new);
Ok(roster::recovery_code(&root))
}
pub fn invite(&self) -> Result<String> {
let roster = self.inner.roster()?;
if !roster.role(&self.id()).is_some_and(Role::invites) {
bail!("only the owner and admins can invite computers");
}
let secret = wire::random_hex(16);
locked(&self.inner.invites).insert(secret.clone(), Instant::now() + INVITE_FOR);
let name = locked(&self.inner.network_name).clone();
Ticket { network: roster.network, secret, addr: self.inner.endpoint.addr(), name }.encode()
}
pub async fn join(&self, ticket: &str, name: &str) -> Result<()> {
if locked(&self.inner.roster).is_some() {
bail!("this computer is already in a network");
}
let ticket = Ticket::decode(ticket)?;
let request = Request::Join { network: ticket.network, secret: ticket.secret, name: check_name(name)? };
let conn = tokio::time::timeout(CONNECT_TIMEOUT, self.inner.endpoint.connect(ticket.addr, ALPN))
.await
.context("the inviting computer didn't answer; is it on?")??;
let answer = wire::call(&conn, &request).await;
conn.close(0u32.into(), b"done");
match answer? {
Response::Welcome { roster } if roster.network == ticket.network => {
let mut roster = roster.verified();
if !roster.is_member(&self.id()) {
bail!("the inviting computer gave an unexpected answer");
}
let addr = self.inner.endpoint.addr();
let _ = roster.sign(
self.inner.endpoint.secret_key(),
wire::now_ms(),
Change::Locate { addr: roster::bounded_addr(addr) },
);
let mut guard = locked(&self.inner.roster);
self.inner.save(&roster)?;
*guard = Some(roster);
drop(guard);
self.inner.clone().hello_all();
Ok(())
}
Response::Refused { reason } => bail!("{reason}"),
_ => bail!("the inviting computer gave an unexpected answer"),
}
}
pub fn remove(&self, computer: &str, cascade: bool) -> Result<()> {
let id = self.inner.member(computer)?;
if id == self.id() {
bail!("a computer can't remove itself; remove it from another one");
}
self.inner.change(Change::Remove { id, cascade }, "only the owner removes admins; admins remove members")
}
pub fn promote(&self, computer: &str) -> Result<()> {
let id = self.inner.member(computer)?;
self.inner.change(Change::Promote { id }, "only the owner promotes computers")
}
pub fn recover(&self, code: &str) -> Result<()> {
let root = roster::root_from_code(code)?;
let mut guard = locked(&self.inner.roster);
let roster = guard.as_mut().ok_or_else(|| anyhow!("this computer isn't in a network"))?;
if root.public() != roster.network {
bail!("that recovery code is for another network");
}
let name = roster.name(&self.id());
roster.sign(&root, wire::now_ms(), Change::Owner { id: self.id(), name })?;
self.inner.save(roster)?;
drop(guard);
self.inner.clone().hello_all();
Ok(())
}
pub fn set_agents(&self, agents: impl IntoIterator<Item = (Agent, Reach)>) {
let before = self.inner.offered();
let agents = agents.into_iter().map(|(mut agent, reach)| {
if let Some(kind) = reach.kind() {
agent.kind = kind;
}
(agent, reach)
});
*locked(&self.inner.agents) = agents.collect();
if self.inner.offered() != before {
self.inner.changed.send_replace(());
}
if !self.inner.ready.swap(true, Ordering::AcqRel) {
self.inner.clone().hello_all();
}
}
pub fn set_senders(&self, senders: impl IntoIterator<Item = String>) {
*locked(&self.inner.senders) = senders.into_iter().collect();
}
pub fn set_rules(&self, rules: Vec<Rule>) -> Result<()> {
rules::check_all(&rules)?;
*locked(&self.inner.rules) = rules;
Ok(())
}
pub fn rules(&self) -> Vec<Rule> {
locked(&self.inner.rules).clone()
}
pub fn set_network_name(&self, name: Option<String>) {
*locked(&self.inner.network_name) = name;
}
pub fn set_reply_command(&self, command: impl Into<String>) {
*locked(&self.inner.reply_command) = command.into();
}
pub async fn peers(&self) -> Result<Vec<Peer>> {
let roster = self.inner.roster()?;
let mut asks = JoinSet::new();
for id in roster.members().keys().filter(|id| **id != self.id()).copied() {
let inner = self.inner.clone();
asks.spawn(async move { inner.hello(id).await });
}
while asks.join_next().await.is_some() {}
Ok(self.directory())
}
pub fn directory(&self) -> Vec<Peer> {
self.inner.directory()
}
pub fn changes(&self) -> watch::Receiver<()> {
self.inner.changed.subscribe()
}
pub fn resolve(&self, name: &str) -> Result<Address> {
self.inner.resolve(name)
}
pub async fn send(&self, letter: Letter) -> Result<Sent> {
let sender = |from: &str| {
self.inner.offered().iter().any(|a| a.id == from) || locked(&self.inner.senders).iter().any(|s| s == from)
};
if letter.reply_to.is_none() && !sender(&letter.from) {
bail!("{} isn't one of this computer's agents", letter.from);
}
let mut letter = letter;
if letter.hops == 0
&& let Some(hops) = letter.reply_to.as_deref().and_then(|id| self.inner.hops_of(id))
{
letter.hops = hops.saturating_add(1);
}
guard::check_hops(letter.hops).map_err(anyhow::Error::msg)?;
let roster = locked(&self.inner.roster).clone();
let id = match &roster {
None => self.id(),
Some(r) => {
r.find(&letter.to.computer).ok_or_else(|| anyhow!("no computer called {}", letter.to.computer))?
}
};
let local = id == self.id();
let envelope = letter.seal(wire::now_ms());
wire::check(&envelope)?;
if !local && envelope.wake && envelope.reply_to.is_none() {
remember(&mut locked(&self.inner.asked), (envelope.id.clone(), id, envelope.from.clone()), HEARD_MAX);
}
let name = |id: &EndpointId| roster.as_ref().map_or_else(|| "this computer".into(), |r| r.name(id));
let answer = if local {
Ok(self.inner.take(id, envelope.clone()).await)
} else {
self.inner.call(id, &Request::Deliver { envelope: envelope.clone() }).await
};
match answer {
Ok(Response::Stored) => Ok(Sent::Delivered),
Ok(Response::Refused { reason }) => bail!("{} refused it: {reason}", name(&id)),
Ok(Response::Later { reason }) if local => bail!("{reason}"),
Ok(Response::Later { reason }) => {
tracing::info!(to = %name(&id), reason, "queued for a computer that is starting");
self.inner.queue(id, envelope)?;
Ok(Sent::Queued)
}
Ok(_) => bail!("{} gave an unexpected answer", name(&id)),
Err(e) => {
tracing::info!(to = %name(&id), error = format!("{e:#}"), "queued for a computer that is away");
self.inner.queue(id, envelope)?;
Ok(Sent::Queued)
}
}
}
pub async fn shutdown(&self) {
let _ = self.router.shutdown().await;
}
}
impl Inner {
fn roster(&self) -> Result<Roster> {
locked(&self.roster).clone().ok_or_else(|| anyhow!("this computer isn't in a network yet"))
}
fn me(&self) -> EndpointId {
self.endpoint.id()
}
pub(super) fn answers(&self, peer: EndpointId, envelope: &wire::Envelope) -> bool {
let Some(id) = envelope.reply_to.as_deref() else { return false };
locked(&self.asked).iter().any(|(sent, to, by)| sent == id && *to == peer && *by == envelope.to)
}
fn hops_of(&self, letter: &str) -> Option<u8> {
locked(&self.heard).iter().rev().find(|(id, _)| id == letter).map(|(_, hops)| *hops)
}
fn heard(&self, letter: &str, hops: u8) {
remember(&mut locked(&self.heard), (letter.to_owned(), hops), HEARD_MAX);
}
fn offered(&self) -> Vec<Agent> {
locked(&self.agents).iter().map(|(agent, _)| agent.clone()).collect()
}
fn member(&self, computer: &str) -> Result<EndpointId> {
self.roster()?.find(computer).ok_or_else(|| anyhow!("no computer called {computer}"))
}
fn change(self: &Arc<Self>, change: Change, refused: &str) -> Result<()> {
let mut guard = locked(&self.roster);
let roster = guard.as_mut().ok_or_else(|| anyhow!("this computer isn't in a network"))?;
roster.sign(self.endpoint.secret_key(), wire::now_ms(), change).map_err(|_| anyhow!("{refused}"))?;
self.save(roster)?;
drop(guard);
self.clone().hello_all();
Ok(())
}
fn save(&self, roster: &Roster) -> Result<()> {
roster.save(&self.dir)?;
self.changed.send_replace(());
Ok(())
}
async fn connect(&self, id: EndpointId) -> Result<Connection> {
let addr = locked(&self.roster)
.as_ref()
.and_then(|r| r.members().get(&id).map(|m| m.addr.clone()))
.unwrap_or_else(|| EndpointAddr::new(id));
Ok(tokio::time::timeout(CONNECT_TIMEOUT, self.endpoint.connect(addr, ALPN)).await??)
}
async fn call(&self, id: EndpointId, request: &Request) -> Result<Response> {
let conn = self.connect(id).await?;
let answer = tokio::time::timeout(CALL_TIMEOUT, wire::call(&conn, request)).await;
conn.close(0u32.into(), b"done");
answer?
}
async fn hello(self: &Arc<Self>, id: EndpointId) -> Result<Vec<Agent>> {
let request = Request::Hello { roster: self.roster()?, agents: self.offered() };
let answer = self.call(id, &request).await;
let agents = match answer {
Ok(Response::Hello { roster, agents }) => {
self.merge(&roster)?;
self.clone().flush(id);
agents
}
Ok(Response::Refused { reason }) => {
self.saw(id, None);
bail!("{reason}")
}
Ok(_) => bail!("unexpected answer"),
Err(e) => {
self.saw(id, None);
return Err(e);
}
};
self.saw(id, Some(agents.clone()));
Ok(agents)
}
fn hello_all(self: Arc<Self>) {
let Ok(roster) = self.roster() else { return };
let me = self.me();
for id in roster.members().keys().copied().filter(|id| *id != me) {
let inner = self.clone();
tokio::spawn(async move {
if let Err(e) = inner.hello(id).await {
tracing::debug!(peer = %id.fmt_short(), error = format!("{e:#}"), "hello didn't get through");
}
});
}
}
fn merge(&self, theirs: &Roster) -> Result<()> {
let mut guard = locked(&self.roster);
let Some(mine) = guard.as_mut() else { return Ok(()) };
if mine.merge(theirs) {
self.save(mine)?;
}
Ok(())
}
}
fn check_name(name: &str) -> Result<String> {
let name = name.trim();
if name.is_empty() || name.len() > 40 || name.contains(roster::NOT_IN_NAMES) {
bail!("a computer's name is 1–40 characters, without spaces, /, @ or .");
}
Ok(name.into())
}
fn remember<T>(list: &mut VecDeque<T>, item: T, max: usize) {
if list.len() >= max {
list.pop_front();
}
list.push_back(item);
}