aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-16 20:51:23 +0000
committertv <tv@krebsco.de>2026-11-16 22:04:05 +0100
commite92a712c1e1419c3d680396be827aa0a85748999 (patch)
treefa02c2075de4590325a0a6b6ffad76ee532a8539
parent1343cc9bdacb6dc7b31652b4529ec843d11d1625 (diff)
topology: neighbours among the members of a node's own party, and of parties named
A node of a swarm holding a store keeps some of its neighbours among the members of its own party and of the parties its operator names (`--store-neighbour-parties`), so that a party listing many nodes can't be all of them (`docs/store.md`, Members): its neighbours by the shared graph among those members alone, each as its entry names it, which every node of its party computes alike, with those among all members.
-rw-r--r--docs/example.toml5
-rw-r--r--src/config/mod.rs40
-rw-r--r--src/federation/held.rs23
-rw-r--r--src/main.rs3
-rw-r--r--src/swarm/topology/mod.rs35
5 files changed, 105 insertions, 1 deletions
diff --git a/docs/example.toml b/docs/example.toml
index ae3d233..d101964 100644
--- a/docs/example.toml
+++ b/docs/example.toml
@@ -143,6 +143,11 @@ htpasswd = "/etc/continuum/htpasswd"
# sync with the nodes its parties list, each as its party's, and with no others.
# store-party = "tv"
+# Behind the `federation` feature, with store-root or store-id: parties among whose
+# members, with those of its own party, this node keeps some of its neighbours, so that a
+# party listing many nodes can't be all of them.
+# store-neighbour-parties = ["lass"]
+
# SSH keys, as authorized_keys lines (ssh-ed25519 <base64> [comment]), whose signature
# on a strict remake's manifest this node takes: the values kept when the swarm turns
# strict (docs/access.md). Without, it votes for no strict remake; a majority of the
diff --git a/src/config/mod.rs b/src/config/mod.rs
index 726ca12..762e9a4 100644
--- a/src/config/mod.rs
+++ b/src/config/mod.rs
@@ -240,6 +240,14 @@ pub(crate) const OPTIONS: &[OptionSpec] = &[
None,
"With store-root or store-id, which need it: the party this node is of (docs/store.md, Members), named in its entry and its handshakes. Nodes of a swarm holding a store sync with the nodes its parties list, each as its party's, and with no others.",
),
+ #[cfg(feature = "federation")]
+ option(
+ "store-neighbour-parties",
+ Kind::List,
+ "NAME,[NAME...]",
+ None,
+ "With store-root or store-id: parties among whose members, with those of its own party, this node keeps some of its neighbours, by the graph among those alone (docs/store.md, Members): so that a party listing many nodes can't be all of them.",
+ ),
option(
"strict-keys",
Kind::List,
@@ -681,6 +689,9 @@ pub(crate) struct Settings {
pub(crate) store_checkpoint: Option<String>,
#[cfg(feature = "federation")]
pub(crate) store_party: Option<String>,
+ #[cfg(feature = "federation")]
+ #[serde(default)]
+ pub(crate) store_neighbour_parties: Vec<String>,
#[serde(default)]
pub(crate) strict_keys: Vec<String>,
@@ -1156,6 +1167,10 @@ impl Settings {
("store-file", self.store_file.is_some()),
("store-checkpoint", self.store_checkpoint.is_some()),
("store-party", self.store_party.is_some()),
+ (
+ "store-neighbour-parties",
+ !self.store_neighbour_parties.is_empty(),
+ ),
];
let set: Vec<&str> = of_a_store
.iter()
@@ -1181,6 +1196,13 @@ impl Settings {
),
Some(_) => {}
}
+ if let Some(party) = self
+ .store_neighbour_parties
+ .iter()
+ .find(|party| !crate::federation::version::is_party(party))
+ {
+ bail!("store-neighbour-parties: {party:?} isn't a party's name");
+ }
let first_change = [
("genesis", self.genesis),
("bootstrap-users", !self.bootstrap_users.is_empty()),
@@ -1255,6 +1277,11 @@ impl Settings {
("store-checkpoint", self.store_checkpoint.is_some()),
#[cfg(feature = "federation")]
("store-party", self.store_party.is_some()),
+ #[cfg(feature = "federation")]
+ (
+ "store-neighbour-parties",
+ !self.store_neighbour_parties.is_empty(),
+ ),
("alias", self.alias.is_some()),
("dashboard-url", self.dashboard_url.is_some()),
("debug-api", self.debug_api),
@@ -2351,6 +2378,19 @@ mod tests {
assert!(checked(json!({ "store-party": "tv" })).is_err());
assert!(checked(json!({ "store-file": "store.json" })).is_err());
assert!(
+ checked(
+ json!({ "store-id": id, "store-party": "tv", "store-neighbour-parties": ["lass"] })
+ )
+ .is_ok()
+ );
+ assert!(
+ checked(
+ json!({ "store-id": id, "store-party": "tv", "store-neighbour-parties": ["l s"] })
+ )
+ .is_err()
+ );
+ assert!(checked(json!({ "store-neighbour-parties": ["lass"] })).is_err());
+ assert!(
checked(json!({ "store-id": id, "store-root": "root.json", "store-party": "tv" }))
.is_err()
);
diff --git a/src/federation/held.rs b/src/federation/held.rs
index fe8b6a9..542aeed 100644
--- a/src/federation/held.rs
+++ b/src/federation/held.rs
@@ -84,6 +84,9 @@ pub(crate) struct Holding {
file: Option<(PathBuf, Arc<Files>)>,
pin: Option<Id>,
party: Option<String>,
+ /// The parties among whose members, with those of its own, the node keeps some of its
+ /// neighbours (`--store-neighbour-parties`).
+ near: Vec<String>,
/// The members the store names, each with its party, as it reads now: apart from the
/// store, so that whoever asks doesn't wait while the store takes events.
members: RwLock<Option<BTreeSet<(String, String)>>>,
@@ -151,6 +154,7 @@ impl Holding {
file: Some((path, files)),
pin,
party,
+ near: Vec::new(),
members: RwLock::default(),
inner: Mutex::new(Inner {
kept,
@@ -352,6 +356,25 @@ impl Holding {
self.party.as_deref()
}
+ /// Itself, the node keeping some of its neighbours among the members of `parties`,
+ /// with those of its own (`--store-neighbour-parties`).
+ pub(crate) fn near(self, parties: Vec<String>) -> Self {
+ Holding {
+ near: parties,
+ ..self
+ }
+ }
+
+ /// The parties among whose members, with those of its own, the node keeps some of its
+ /// neighbours: its own first.
+ pub(crate) fn nearby(&self) -> Vec<&str> {
+ self.party
+ .iter()
+ .chain(&self.near)
+ .map(String::as_str)
+ .collect()
+ }
+
/// `f` of the store, where the node holds one.
pub(crate) fn with<T>(&self, f: impl FnOnce(&Store<Federation>) -> T) -> Option<T> {
self.inner.lock_or_recover().store.as_ref().map(f)
diff --git a/src/main.rs b/src/main.rs
index 91b1bc8..40ae93a 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -319,7 +319,8 @@ async fn main() -> Result<()> {
.as_deref()
.and_then(federation::store::Id::from_hex),
args.store_party.clone(),
- )?,
+ )?
+ .near(args.store_neighbour_parties.clone()),
strict_keys: args
.strict_keys
.iter()
diff --git a/src/swarm/topology/mod.rs b/src/swarm/topology/mod.rs
index 1d42724..f2538cc 100644
--- a/src/swarm/topology/mod.rs
+++ b/src/swarm/topology/mod.rs
@@ -399,6 +399,39 @@ fn of_the_store(
.collect()
}
+/// In a swarm holding a store, this node's neighbours among the members of its own party
+/// and of those its operator names (`Holding::nearby`), each as its entry names it, by the
+/// shared graph among those alone, as each of them computes it (`docs/store.md`,
+/// Members): so that a party listing many nodes can't be all of them.
+#[cfg(feature = "federation")]
+async fn nearby(state: &AppState, inputs: &Inputs<'_>) -> BTreeSet<String> {
+ let parties = state.holding.nearby();
+ if parties.is_empty() || !state.holding.tells_members() {
+ return BTreeSet::new();
+ }
+ let group: BTreeMap<String, BTreeSet<String>> = {
+ let replica = state.doc.read().await;
+ inputs
+ .transports
+ .iter()
+ .filter(|(member, _)| {
+ members::party(&replica.doc, member)
+ .is_some_and(|party| parties.contains(&party.as_str()))
+ })
+ .map(|(member, transports)| (member.clone(), transports.clone()))
+ .collect()
+ };
+ neighbours_across(
+ &RingAndPairs,
+ &group,
+ state.local_id(),
+ inputs.local_transports,
+ inputs.k,
+ inputs.unreachable,
+ inputs.stable,
+ )
+}
+
/// Whether `peer` is in the member list, as the view was last computed from it; None
/// while the view isn't known.
pub(crate) fn listed(state: &AppState, peer: &str) -> Option<bool> {
@@ -863,6 +896,8 @@ pub(crate) async fn refresh(state: &AppState) -> Option<NeighbourChange> {
None => state.peer_states.read().await.keys().cloned().collect(),
};
let mut computed = topology.neighbours(state.local_id(), &inputs);
+ #[cfg(feature = "federation")]
+ computed.extend(nearby(state, &inputs).await);
computed.extend(outbound.iter().cloned());
#[cfg(test)]
let listed_neighbours = computed.len();