# Federation: a design A design, not what the code does: none of this is built. It says how a swarm can be kept by parties that don't trust each other, for a first use: the krebs registry of users, their hosts, and the hosts' names, addresses and keys ([krebs/kartei](https://github.com/krebs/kartei)), today plain files in a git repository that one maintainer merges into. Claims about the code as it is are marked *(checked)* where they were read in the code, *(docs)* where they are taken from the docs, and *(assumed)* otherwise; the last section lists them. How sure each part of the design is, is said with the promises. ## Optional A swarm is federated if its root carries the federated policy (below). Everything here holds under that policy, and nothing else changes: * A swarm started as today has no such policy and stays as it is: its rules, its users with their capabilities, its remakes by the members' votes, its tokens, and what its nodes send and do. * The code is apart where it would cost. Judging reads the policy as it does today and takes the federated rules under the federated one only; the resolved registry is kept there only; envelopes carry their new fields there only. The wire's version goes up for every swarm, as with every change to it. * Shown at every stage by the existing tests passing untouched, and by the cost of judging a change (`bench_screening`) staying where it is for a swarm without a policy and with today's. ## The parties and the adversary A **party** is a user and the nodes that carry for it. The user holds SSH keys and signs; its nodes commit what it signed and sync with the others' nodes. Some users are the swarm's **roots**: at first whoever starts it. Nobody owns the swarm, and any party may be malicious, alone or together with others, a root too. What an adversary can do: * run nodes, and once it is in, bring in users of its own; * craft any change: under any actor, with any dependencies (so "made long ago", as the document sees it), any operations; * send different changes to different peers, send none, or pass on only some; * delay or drop messages between any nodes for as long as it likes, short of forever between honest nodes; * choose its node keys, and so where its nodes fall among the members; * steal a key of another party (a user's key, a node's key), as a case of its own. What it can't: forge an Ed25519 signature, or find two changes with one hash. Out of scope: keeping the registry from being read (every party reads all of it), hiding who talks to whom, and a party's own machine taken over whole (then the adversary is that party). ## What is promised To an honest node, whatever the others do, with any number of them malicious (3 to 5 but for what the voters can do to a user, said with each and below): 1. **Only valid changes.** Every change it holds passed the rules, judged as its writer saw the document (at its dependencies). 2. **The same document.** Two honest nodes holding the same changes hold the same document, and resolve it (Resolving, below) to the same registry. 3. **Signed by its user.** Whatever the resolved registry shows in a user's namespace was signed with a key that was that user's when it signed, or is as the root change has it. What it shows as held by a user, the user claimed with such a key, or a rule keeps for it, or a decision gave it (7). A key is a user's by what its own keys signed, or by a decision that gave it first keys anew. 4. **One holder.** The resolved registry gives each name of each kind to one user at most, and each user name to one user. 5. **First come, first served, once a root saw it, and for good once the voters did.** A claim is **settled** once a node of a root committed a change after receiving it, with no other claim of that name standing there: every other claim of it, whenever it shows up and whatever it says it saw, is late. A settled claim is a root's word, and what a root can still do to it is not promised against (below). It is **final** once a third of the voters' nodes saw it hold the name for as long as the policy says: from then on nobody else holds that name, whatever shows up, whatever a root does, whatever is cut off, until its user releases it or is gone, its own key is cut off, or the voters deal with it (7). 6. **Nobody waits for anybody.** An honest user's valid write needs no vote and no other party's consent; it counts at once, and reaches every honest node its nodes reach. And for what the swarm decides together, with the fractions the design recommends and fewer than a third of the voters malicious (the voters are the users an epoch's root change names; a voter is honest here if its user is and the nodes that carry for it are): 7. **Decisions by two thirds.** A proposal (a remake, a number, the policy, first keys for a user that lost its own, a name) is decided only once more than two thirds of all the voters voted for it, and nodes of that many held those votes together. So none is decided that no honest voter voted for, and a side of a partition decides only with nodes of that many voters on it. Of the decisions of one matter every node acts on the same one, the last. A remake changes nothing in what counts: every node builds the next epoch itself, from the changes it holds. Nobody is moved against its will: a decision is refused by choice. What is not promised: * **One history at all times.** Both sides of a partition go on. A name claimed on both sides goes to the side a root was on, or is contested until one side releases it or the voters decide. * **That a name is never contested**, before it is final. Before a claim is settled, a claim made out of its sight contests it. After, a root does, by saying it saw another first; and so does anyone, through one honest node of a root or of the claimant that hadn't received the claim yet and is given the other first. * **A settled name against the roots.** One root contests it. To take it, every root that saw it first has to turn: each cuts off the node that saw it. A final name is out of their reach. * **A name another gave up**, before it is final: whoever released it takes it back by cutting off the key that signed the release. * **Protection from a stolen key** before its user notices: what was signed with it counts until a key above it cuts it off; then all of it stops counting (Cuts). Past what became final meanwhile, and past a remake, it stays. * **Agreement in the classic sense, for what users write.** There is no quorum there, so no n ≥ 3f+1: promises 1 to 4 and 6 hold against any number of malicious parties, and 5 from when a root saw the claim. Only decisions take two thirds, and only the voters make them. * **A name against the voters.** Two thirds of them give a user's first keys anew. Meant for a user that lost them, it hands a name to whoever they say: in the open, over the days a vote takes. The same two thirds free the names of a user that is out, or give them to another, say who has a contested name, and decide a policy that covers a name no more. And a third of them, stamping as they like, make a user that is out gone, a claim final, and what a policy uncovered dropped, at once. * **A name through a long partition.** A user unvouched on one side of a partition that outlasts `gone` is gone, though someone vouched for it in time on the other. Two claims that each became final on a side of one that outlasts `final` are contested. * **That everyone follows a decision.** A party refuses one it won't bear, and goes on without it, with those who think alike: two epochs, by choice (Refusing a decision). * **A user put out by the swarm.** Nobody is put out by a vote: a user is in while one user that counts vouches for it (Unvouching). So a user is out when those who vouched for it say so: one root, for a user only that root created. * **Decisions against a third of the voters.** A third or more of them keep anything from being decided, and by voting both ways get two proposals of one matter decided and choose which is the later. * **When a proposal is decided.** One that had the votes and lacks records of nodes hangs over its matter: whoever holds the last record chooses the day. The voters end that by deciding a later proposal of the matter (Decisions). * **Decisions without the voters.** With a third of an epoch's voters not taking part (gone, silent, without a node that carries for them), nothing more is decided there; what users write goes on. Those left go apart (Going apart). * **Anything of 7 with one voter.** A swarm that one user starts has that user as its only root and voter until a remake names others: it decides alone, and what a third of the voters see, it sees alone. * **Time across a remake.** A length of time that had begun when a remake came starts anew after it. What became gone, final or dropped after a remake's base stays so where the nodes of a third of the voters carried it over (Remakes). * **A swarm that never splits.** A node that forks its own actor (two changes with one number) splits the honest nodes that took one from those that took the other, until one side drops its own (Partitions). It is found, proven and named; it isn't prevented. How sure: 1 to 4 follow from how changes are judged today plus rules of the same shape, and from Kleppmann's result that a hash-linked change graph whose validity depends on a change and its history alone converges whatever the faulty nodes do (*Making CRDTs Byzantine Fault Tolerant*, 2022): high, given the conditions under Why it holds. 6: high. 5 is this design's own construction, argued below: medium for settled, and for final as sure as the lengths of time are, which are read from the nodes' stamps: medium, less where clocks are off. 7 is the two-thirds argument with votes that take days: medium. 5 and 7 want the tests named under Attacks, and someone trying to break them. ## The design It builds on the strict policy ([`access.md`](access.md), Values signed by their users): values as envelopes their users sign, which every node checks against the registry as the writer saw it. What it adds: users come in by being vouched for, and go by being unvouched; each has its namespace; names of declared kinds are held by one user each; what a key signed can be cut off after the fact; and the swarm decides by its voters' votes. ### The policy, in the root A federated swarm's policy is `{"version": 2, "values": "signed", "users": "vouched"}`, with what the rules read beside it in `_continuum/access`: the kinds of names (`claims`), the paths in namespaces whose values are signed (`userSigned`, as today), and the **numbers**. All of it is in the swarm's root, its genesis change, with the roots, the voters, and the users it starts with: * Nothing is ever written before the policy, so nothing is judged by none. * Every node is given a root and takes no other: the genesis root (`--genesis-root`), or, in a swarm that was remade, the ID of a later epoch. The root is what a party trusts, not what its seeds say. * A node that doesn't know the policy doesn't sync at all. (Today it receives without judging *(docs)*, which here would let anything in.) The policy changes by a decision: each number by itself, the rest as a whole (The policy changes by a decision). **The numbers.** The quantities of this design are numbers of the policy. The design recommends; the genesis policy sets each, and a decision changes any of them to any value: | Number | Recommended | What it says | |---|---|---| | `window` | 7 days | how long a vote runs | | `gone` | 30 days | after how long seen out a user is gone; none: its names wait until a vouch or a decision | | `final` | 30 days | after how long seen holding a name a claim is final; none: never | | `uncovered` | 90 days | how long what a policy no longer covers stays aside before it is dropped; none: until its user takes it away | | `archiveRetention` | 90 days | how long a node answers for an epoch it left, at least | | `stamp` | 1 day | how often a node that is up renews its alive stamp | | `baseAge` | 10 minutes | how much of what a node holds a remake's base may lack | | `witness` | 1 minute | how long a root's node lets a claim wait before it writes | | `limits.keys` | 64 | keys a user has at once | | `limits.nodes` | 64 | nodes carrying for a user at once | | `limits.users` | 16 | users a user created that stand; a root: no limit | | `limits.vouches`, `limits.bans` | 64 | vouches, and bans, of a user that stand | | `limits.proposals` | 8 | proposals of a user that are open | | `limits.name` | 255 | bytes of a name | | `limits.entry` | 4096 | bytes of a node's member entry | | a kind's `limit` | none | names of the kind a user holds by a claim | | `fractions.decide` | 2/3 | a decision takes more than this share of all the voters | | `fractions.seen` | 1/3 | the share of the voters whose nodes must have seen a thing for long: a user out, a claim holding, a thing uncovered | What today's genesis change sets for the swarm as a whole (how many neighbours, the topology, the dissemination, the relays *(checked: `document::meta`)*) are numbers of the policy too. Nothing constrains them, and a number that makes no sense has the result it has. A time of nothing is "at once"; a limit of nothing lets nothing more in; a `baseAge` of nothing takes a base that lacks nothing. Three end deciding itself: a `fractions.decide` of 1, `limits.proposals` at 0, a `window` of nothing. What is left then is refusing that decision, or going apart. A proposal that leaves a number without a value where it needs one is no proposal. More than a share is strictly more; a share of the voters, for what was seen for long, is the fewest voters that are that share at least, and one at least. Where this text says two thirds and a third, it means the two fractions as recommended. What is promised of decisions is argued for those; a swarm that sets others has what its numbers carry (Why it holds). What a node does for itself alone (how fast it takes a party's changes) is its own setting. ### Users: statements, keys, nodes `_continuum/users//` holds the **statements** about and by a user, each an envelope kept under its SHA-256, never replaced or deleted: the register only grows. A statement is signed by one user and says one thing: | Statement | Signed by | Says | |---|---|---| | `create` | another user (the creator) | the name, its first keys | | `vouch` | another user | "I vouch for this user too" (no keys) | | `unvouch` | the signer of a `create` or `vouch`; a root, for what is the seats' | that one taken back (Unvouching) | | `key` | the user | one more key | | `retire` | the user | a key, and the cut after which what it signed doesn't count | | `node` | the user | a node that carries for it; or one that stops, with a cut | | `release` | the user | a claim, a vote, a proposal or a ban of its own given up; or itself | | `ban` | the user | a user that doesn't count for it, with a cut (Bans) | | `claim` | the user | a name it wants (Claims; in the name's own register) | | `propose`, `vote` | a voter (a fork: any user) | Decisions | * **A statement says where it was signed.** Its payload names the changes its signer had seen, by their hashes (`seen`), as a cut does, and a change that carries it must have them in its history. One statement is **in sight of** another if the other is in the history of what it names. That, and not the change that happened to carry it, is a statement's place wherever its place matters: carried a second time, by anyone, it is where it was. Its envelope names the register as its path. * **A user is its creation.** The `create` statement's digest is the **user ID**, and every envelope the user signs names it, with the name, the swarm and the epoch it was signed in. Two creations of one name are two users with two sets of keys; which has the name is decided below, and a key listed in both signs for the one its envelope names. * **A user the root change holds** has the ID given there, and needs no creation. It may be there without keys (a registry moved in from elsewhere): then it is in, has its name and what the root change holds in its name, and nobody signs for it, until a root's `create` for that name gives it its first keys. That is no other user, and the only `create` a name that is taken gets. * **Keys form a tree.** A user's first keys are those its creation names. A `key` statement adds one, signed with a key the user has, which is **above** the new one, as are the keys above itself. Any number over time; at once as many as `limits.keys` says. Use: the first keys stay offline, and add the keys of the devices. Any key signs for its user, but for one thing: giving the user up takes a first key. * **A node carries for a user** once the user named it and the node agreed: the node itself commits the `node` statement that names it, in a change that holds nothing else but its member entry. A node commits changes only while it carries for a user, and an envelope is taken only in a change committed by a node that carries for its signer (but for what a decision is made of, and what is carried over a remake, which any node commits). So every change is some party's: its node's signature proves the node ([`access.md`](access.md), signatures required), and the user's statement binds the node to the user. At once as many nodes a user as `limits.nodes` says. * **A user without a node** names another party's, which carries for it too if it agrees. That node's changes witness for both, and it takes proposals up for both: for the swarm, such a user is the party that carries for it. Nothing is signed in its place. * **Past a limit.** A user's statements of one kind are counted from the first: each has, and states, the number after the highest of those it was signed in sight of, and of two with one number the one with the lower digest comes first. A statement is past its limit if as many of that kind come before it as the limit allows, not counting what was given up or cut off in its sight (a key retired, a node stopped, a claim released). It doesn't count. So what is signed out of the sight of the others to get past a limit doesn't, and giving up an earlier one later doesn't bring a later one in. The limit is the one that holds where the registry is read: lowered, it leaves out the last. So for every limit: keys, nodes, creations, vouches, bans, proposals, a kind's claims. * **Names** of users are 1 to 64 of `A-Z a-z 0-9 . _ @ -`, as today, less the top-level keys the swarm uses otherwise (`_continuum`). Which of them may be created, and by whom, the kind `user` says (Claims). ### Vouching, lines, the roots A user creates whom it likes, within a limit (`limits.users`), and vouches for whom it likes, within another. The new user signs, claims and creates in turn from its creation on: in any change that has the creation in its history. Users and what they signed for each other form a graph, the roots at its top. A **line** of a user is a chain of creations and vouches that count, from a root down to it. A user is **vouched for**, and in, while it has a line. So rings away from the roots hold nobody, and a vouch by a user whose own lines all pass through the one it vouches for adds none. When its creator goes (unvouched, cut off, out), a user that another vouched for stays in, by that line, without doing anything. When the last goes, it is out (Unvouching). A line says who is in, and nothing else. Who vouched for whom gives nobody a say about another's names (the witnesses of a claim are its user's nodes and the roots': Two claims), and says nothing about who connects to whom (Reaching the others). What it does give: a creator's limit bounds how many users come in through it, and each shows below it, for all to see, and goes with it when it goes. Bringing someone in means handing over, out of the document, what a party needs to connect and to start (the root, some seeds, the swarm key where there is one), and writing the `create`. **The roots** are the users the epoch's root change names as such: in a genesis change the user who starts the swarm, or those the file it starts from names; then those a remake names (Remakes). They change with a remake only, so a root is one for its whole epoch. What sets a root apart: * It is in by its seat: it needs nobody's vouch while it holds one, and nobody's unvouch puts it out. A user that held a seat and holds none any more is in like anyone, by a line: one that leaves its seat has someone vouch for it, or is out. * The lines start at the roots. What a root signed for another (a `create`, a `vouch`) counts while its signer holds a seat, and is the **seats'** after: it counts while there are roots, whoever they are. A user the root change holds without a creator is in by the seats too. Its signer takes back what it signed while it holds a seat. What is the seats' the roots take back together: it is taken back once each of them unvouched it. So where there are several, no root alone puts out a user the root change holds. * Its nodes' changes witness every claim, which is what settles one. * It creates users without a limit. What is the seats' counts toward nobody's limit. * It holds the names a rule gives to a root, while it holds its seat: one that leaves its seat leaves them to the roots, to claim. A root can't write in another's namespace, nor take a name that is final. It can contest any name that isn't, in the open. With several roots, any one that is up settles claims, any one that lies contests them, and none takes a name alone. A root that is away, or turns on the others, is banned by the parties it harms (Bans), and left out by the voters at the next remake; what is final stays as it is meanwhile. ### Lengths of time The document orders what was written: a change's history is what its writer had seen. It measures no time. The nodes' alive stamps do, each by its own node's clock *(checked: `alive`, Unix ms)*. So a length of time is read between two stamps of one node, and what that node had seen at each, from the stamps' histories. A thing has been **seen for** a length of time, at a set of changes, once a third of the voters (`fractions.seen`; the voters: Decisions) each have a node with two alive stamps that far apart or more, the thing so at both and at every stamp of that node between. A length of nothing takes one stamp. A node counts for one voter in this, though it carry for several. It is read from the changes alone: the stamps are changes in the history, each renewal one. * A node that is up renews its stamp as often as `stamp` says, whatever else is written or isn't. (Today the interval follows what members publish in their entries *(checked: `swarm::members`)*; in a federated swarm it is the policy's.) So nobody does anything to be seen, and there are always stamps to read time from. While no node writes at all, no time passes: nothing is seen for longer by it. * The length that counts is the number's as it holds in the later stamp's history. What was seen for long stays so: gone, final and dropped never go away. * A remake starts every length anew: what was being seen is seen from the new epoch's first stamps on. What had been seen for long stays so (Remakes). No clock is compared with another. A third, because decisions are argued against fewer than a third of the voters being malicious: so few show nothing by themselves, whatever they stamp. And no more than a third, because everyone it takes must be there: two thirds may have left, and the rest still see it. ### Unvouching A user takes back a `create` or a `vouch` it signed: `unvouch`, naming it. Nobody else can; what is the seats', the roots take back together (Vouching). What it does, exactly: * **From the unvouch on, as far as the user had been seen.** What the user signed counts through this creation or vouch if the unvouch was signed in sight of it, or if a node of the unvoucher or of a root committed a change with it in its history and not the unvouch. Everything else it signs is past the point. So an unvouch that says it saw little undoes nothing that its signer's own nodes, or a root's, had seen. * **Another vouch keeps the user.** With another line, the user stays in, with everything it has. * **Else the user is out, from there.** Nothing of it counts: its namespace doesn't, its nodes witness nothing, and what they commit in sight of the unvouch is refused. Its names **wait** for it, its user name among them: its claims stand, so nobody else claims them, and nobody holds them. One thing it keeps: where it is a voter, it votes on, at whatever node takes its vote. Who votes is a remake's word, not its vouchers'. * **Those it brought in go with it,** from the same point: a user all of whose lines ran through it is out too, with the same consequences, unless another user that counts vouches for it, before or after. * **A vouch brings a user back,** with its names and what it signed in between, as long as it isn't gone. What another claimed meanwhile, in sight of a claim of the user's that didn't count then, stays the other's (Claims). * **Out for long is gone.** A user is **gone** once it has been seen out for `gone` (Lengths of time). Then its claims and its creation stand no more: whoever comes first claims its names, and no vouch brings it back. It comes in again by being created anew. * **Or by a decision.** While a user is out, the voters free its names or give them to another (Decisions), at once and whatever `gone` says. Where the policy sets no `gone`, the names wait until a vouch or a decision. * **What it did before stays done.** Releases it signed stand, and so does what others built on them. * **Out of sight.** What the user signs saying it saw nothing of the unvouch, or on the far side of a partition, is valid as written, so nodes hold it; it is past the point, and doesn't count. A node takes changes of an unvouched user's nodes only as part of another party's history, never from those nodes, so they can't make it work. So whoever relied on a user that is out has that long to find another who vouches: for itself, and for those it brought in. Until then nothing it holds is taken, but by a decision. **Only who signed takes back.** A vouch is its signer's word, and nobody else takes it back: not the users above the signer either, who answer for the signer, whom they brought in. One of them that wants a user out unvouches whom it brought in itself. That takes all below along, and those worth keeping get another's vouch while their names wait. Were it otherwise, a root, above everyone, would put out whom it liked, and for good: every line passes one. **Nobody is put out by a vote.** A user is in while one user that counts vouches for it, and no decision changes that. Against a user that keeps within the rules and harms all the same (squats names up to its limits, gets others' names contested) there is: each party's ban, which changes what that party reads (Bans); the voters saying who has a contested name; its vouchers unvouching it; and a root unvouching the user it created above it, with all below, who then need other vouches. A vouch from anyone brings it back. A user gives itself up by a `release` of its own creation, signed with a first key: from that release on it is gone, and its names are free at once. ### Namespaces A user's namespace is the top-level key with its name. One rule: below ``, only envelopes signed by a user of that name, at the depths `userSigned` lists (for the registry, `["*", "hosts", "*"]`: a host is one signed value). A value there is replaced as today, by an envelope naming the one it replaces (`prev`). Nothing plain is written anywhere but a node's own member entry and its own records of proposals. Delegating (another user writing below `/shared`, say) would be a statement in the user's register granting a capability within its namespace: for later; the rule has room for it. ### Claims: names held by one user What must be unique across users (a host's name, an address, a top-level domain) is **claimed**. The swarm declares the kinds, as data in the policy: ```json { "name": { "chars": "a-z0-9-", "rules": [ { "match": "**.{user}.*", "by": "{user}" }, { "match": "*.*", "by": "{voters}" }, { "match": "*", "by": "{root}" } ] }, "ip4": { "chars": "0-9", "rules": [ { "match": "10.243.*.*", "by": "*" } ], "limit": 256 }, "user": { "chars": "a-z0-9_-", "rules": [ { "match": "*", "by": "*" } ] } } ``` * **A name is written as it is used**: `toaster.tv.r`, `10.243.0.7`. It is one key in the document, and a rule's `match` is written the same way. Both are split into segments at the kind's `separator` (a dot, unless the kind names another) and compared segment by segment: `*` fits any one segment, `**` one or more (once in a rule), `{user}` one segment, taken as a user's name, anything else itself. * **Structure, not meaning.** Continuum doesn't ask what a segment is: `10.243.foo.bar` fits `10.243.*.*`. Nor does it know that two spellings mean one thing (`::1`): names are compared as written. What a name means is the application's, which claims one spelling and reads no other. A name is `limits.name` bytes at most, and no path: it has no `/`. * **Its characters.** A kind may say what its names' segments are made of (`chars`: characters and ranges of them). A name with any other isn't one of the kind, so the `10.243.foo.bar` above is none where `ip4` says digits. Recommended wherever case means nothing: lower case only, so that `TV` is no name beside `tv`. The kind `user` says so for the users' names, within what continuum takes for one. * **The first rule whose `match` fits says who may hold the name** (`by`): a user, or one of a list; anyone vouched for (`"*"`), first come, first served; the user whose name stands where `{user}` does; a root (`"{root}"`); or whom the voters give it to, by a decision (`"{voters}"`). No rule, no holder. * A name a rule gives to `{user}` is **kept**: it is that user's without a claim, since nobody else could claim it, and it is nobody's while there is no such user. Its user may claim it all the same. Such a claim doesn't count toward the kind's limit while the name is kept, and is what holds the name on if a policy stops keeping it. * So above: everything below `tv.` is tv's, for any top-level domain, whatever tv claimed. A name right below a top-level domain (`wiki.r`) is given by the voters. A top-level domain is a root's to claim. An address goes to whoever comes first, 256 a user. * The kind `user` is the users' names themselves: its rules say who may create which (a swarm can keep names for one creator). Above, anyone creates a name of one segment. `_continuum/claims///` holds the statements about one name, again only growing: `claim` (by the user who wants it) and `release` (by that user, of its claim: how a name is given up). A claim **stands** while it counts, isn't released, its user isn't gone, a rule of the policy lets its user, and no decision freed the name or gave it to another. A claim is taken, as its writer saw the document, if a rule lets the user, the user is within the kind's limit, and no claim of that name stands there. That is first come, first served wherever one claim was made in sight of the other: the later one is refused by every node. **What comes back.** A claim made in sight of another that didn't stand there doesn't give way to it later. Whatever has the other count or stand again (a vouch that brings its user back with what it signed meanwhile, a limit raised, a rule that lets its user again), the other gives way to it, for good. One thing brings an earlier claim back over a later one: the earlier was released, or left out by a cut, with a key that is then cut off from before. It is as if it had never been down: the later one gives way, and nobody having seen the earlier one down counts against it; unless the later is final (below). That is what a user has against a thief who released its names. The registry shows such a later claim as held while that release stands. A claim says nothing else. What the name is for is in the namespace: a host's entry names its addresses and names, and they count while its user holds them. ### Two claims out of each other's sight Two users claim one name at once, or on two sides of a partition, or one of them pretends to: it crafts a claim that says it saw nothing of the other's. No node can tell these apart, and both claims are valid as their writers saw the document, so every node holds both. What decides is who can be shown to have seen what. The witnesses for a claim are its **side**: the nodes of its user and of the roots. * A claim is **late** against another if a change committed by a node of its side (one carrying for its user or for a root when it committed it) has the other in its history, standing there, while the claim itself wasn't there yet, or didn't stand there: the claimant's side had seen the other hold the name while the claim didn't. Whether a claim stood there is read from that history, less what a cut has taken back since. * Of the claims of a name that stand, those remain that are late against no other and give way to none. If one remains, its user holds the name, or has it wait while it is out. If none or several do, the name is **contested**: nobody holds it, until releases leave one, or the voters say whose it is (Decisions). Being late is read from the changes alone, so every node finds the same. It goes away only with its witness: where the node that committed the change is stopped with a cut from before it (Cuts). What this gives: * **Settled.** Every node writes its member entry as often as `stamp` says, and a root's node also when a claim reaches it that it hadn't seen, `witness` apart at most. Such a change has in its history everything the node had received. The roots' nodes are on every side. So once a root's node wrote after receiving a claim, while it held no other of that name that stood, every other claim of the name is late against it: one surfacing later, however little it says it saw, and one that was there and comes to count later. The claim is **settled**, within `witness` of reaching a root's node. A node tells (`settled`, below). * **Several roots.** Any one of them settles a claim. Two that received two claims in different orders make each late against the other: contested, as two claims made at once are, and one releases. So with more roots a claim is settled though one is away, and two made within the same moment are contested more often. * **A user that is up is bound by its own node**: after its node wrote once with a claim in its history, it never holds that name against it, short of stopping that node with a cut from before. * **To take a name from a claim**, a rival needs the claim to be late and its own not to be: a node of the claimant or of a root that wrote after receiving the rival and before the claim, and no root's node that wrote after the claim and before the rival. Once a root saw the claim, the second can't be, short of that root cutting its node off. * **Before a claim is settled**, a claim out of its sight contests it, or holds, where a root's node received that one first. Honest users claiming at once see "contested", and one releases. While no root's node is up, a claim isn't settled, and whichever of two reaches one first when it is back holds. * **A node that comes back** (started, or cut off for a while) writes nothing before it caught up with the peers it keeps (its user's other nodes, its seeds). So it is the harder to hand a node a rival before the claim it would have seen first. * **Final.** A claim is **final** once it has been seen holding the name for `final` (Lengths of time). From then on no other claim of the name holds it or contests it, whatever a witness says and whatever is cut off: not a rival that a root says it saw first, not an earlier claim whose release is cut off, not one that shows up with a witness of its own. It ends as a claim does (released, its user gone, by the voters), and it doesn't count where the key that signed it is cut off from before it. Final takes no root: a claim nobody contested for that long is final though no root ever saw it. Two claims that each became final out of the other's sight, on two sides of a partition, are contested. So a name is its claimant's against anyone but the roots within a minute, and against the roots too within `final`: that long a root can still contest it, in the open, and a root that does is banned and left out at the next remake. A user's name is claimed the same way: the `create` statement is the claim, its side the nodes of its creator, of the new user and of the roots. Two creations of one name out of each other's sight are decided as above; while it is contested, no user has the name, and neither namespace counts. A user that doesn't have its name still holds what it claimed where anyone may claim: those claims stand, so contesting a user's name frees none of them. What a rule gives to a name (a kept name, a name only `tv` claims) is nobody's while the name is. ### Cuts: what stops counting A **cut** is a set of changes, named by their hashes: "as far as I saw". A statement is within the cut if a change that carries it is in the history of the cut. Whether it is doesn't depend on who asks or when: a change's history is fixed by its hash. * **Retiring a key** names the key and a cut. What the key signed within the cut counts as before; what it signed outside doesn't count, for anyone, whenever it shows up. A statement signed with a retired key and offered later, saying it saw little, is outside the cut. That is how retiring reaches a node that was away: it needs no order of arrival. * **Who retires what.** A key above another retires it with any cut: a user whose device key was stolen cuts it off from before the theft. A key retires itself only from where it stands (its cut must hold everything it signed that the retiring change's history holds): rotating, not rewriting. No key retires one beside or above it, so a stolen device key can't cut off the keys above it, nor undo what it signed before. * **A node that stops carrying** is named with a cut the same way, by the key that named it or one above: what it committed outside the cut is nobody's, as a witness or as a carrier. * **A cut never reaches its own statement.** A `retire`, a stop and an `unvouch` count by the key that signed them and the node that carried them as these were where the statement was judged, and are left out only by a cut of that key set by another statement. So a key retires itself, a node commits its own stop, and a retirement counts though the node that carried it carries only by what the retired key signed. * **What a cut takes back.** Everything the key signed outside it: a claim, a vouch, a release, and also what that key cut off itself. The keys it retired and the nodes it stopped count again, and a user it unvouched is in again. What stops counting stays in the document, and every node holds the same. It is left out when resolving. In a namespace, where a value that doesn't count replaced one that does, the one that does is read again (Resolving). The price: a key above retiring one below with an early cut takes back what that key signed since, a vouch or a release among them, further back than an unvouch reaches. Whoever relies on another's statement relies on that, until what it holds is final: a second vouch is what makes a user independent of its creator's keys. And a user's first keys have none of its own above them: above those are the voters, who give a user first keys anew by a decision (Decisions). Any key of a user signs for it, so a device key in the wrong hands unvouches whom the user brought in and releases its names. A key above takes all of that back with a cut, as far as nothing final was built on it. Only giving the user itself up takes a first key. A cut reaches no further back than the epoch (Remakes). ### Bans: for those who follow A user may state that another doesn't count for it, from a cut on: `ban`, which a `release` of it ends. A node resolves with the bans of the users it **follows** (`--follow`; its own user by default): what the banned user signed and what its nodes committed outside the cut is left out, as a holder and as a witness. Bans are taken in the order they were made; of two made out of each other's sight, the one by the user with the shorter line to a root first, then by digest; and none by a user that a ban taken before leaves out. A ban changes what a node reads and writes out, never what it takes or refuses: every node still holds every valid change, so banning splits nothing. It is what a party does about a user it can't unvouch: one that squats, a root that contests its names or that it no longer trusts. Its registry goes on without them. Parties following the same users read the same registry. A node refuses its own user's write that only its bans make valid (a claim of a name the banned user holds): the others would refuse it, and everything the node writes after. This is the trust root a user has beyond the swarm's: the root every node is given, and whom it follows. In a dispute, the nodes following a user read its side. ### Decisions Some things are the swarm's to decide: its numbers and the rest of its policy, a user's first keys where it lost its own, the names of a user that is out, whose a contested name is, names the rules leave to the voters, and when to compact, with who votes and who the roots are from then on. They are decided by votes of users, signed by them, over days. **Who votes.** The **voters** are the users the epoch's root change names. A genesis change names the user who starts the swarm, or those the file it starts from says. A remake names those of the next epoch: its proposal says who, all users (recommended) or those of a list. All users are those there when the remake is proposed: the users with keys that count where the proposal was signed, and still do at the base. So who votes is decided by those who vote, with each remake; a user brought in later, while the votes run too, votes once a remake names it; and a swarm that one user started is that one's to decide until its first remake. A voter votes while it isn't gone, whether it is in or out: who is in is its vouchers' word, who votes is the remake's. What to weigh in it: * Every voter named counts toward what a decision takes, whether it takes part or not, in or out: more than two thirds of all of them. One that never votes stands in the way like one voting against. With a third of them not voting nothing is decided, and no remake either, which is what would name others. * So a swarm remakes while two thirds of its voters still take part, and names those who do. Past that, those left go apart, naming who votes among them (Going apart). * What is seen for long takes a third of the voters each with a node of their own. * All users is whoever brought users in: a user that created sixteen has seventeen votes in the next epoch. The list is fixed with the proposal, so the voters see it before they vote for it (`GET /registry/decisions`), and name one of their own where they don't like it. A change in who votes takes a remake because a remake is what puts the votes of before out of reach (below). **How.** 1. A voter **proposes**: a statement naming its matter (what it is about: one number, one user's first keys, one name) and what is to hold. The proposals of a matter are numbered: each has, and states, the number after the highest of its matter that it was signed in sight of. Any number of proposals are open at a time, on one matter too; `limits.proposals` of one voter's at most. A proposal is open until it is decided, its proposer releases it, or one of its matter with a higher number is decided. 2. Voters **vote** for it: each a statement signed by the user, saying when the vote runs out, `window` from signing unless the user says sooner; a node counts no vote for longer than `window` from when it first held it. A voter has one vote on a matter at a time; `release` takes one back, as far as it gets there first: a node that holds the vote without its release counts it, and a proposal may be decided with a vote whose release was on its way. A vote is meant when signed. 3. A node that carries for a voter **takes the proposal up** once it holds votes for it by more than two thirds of all the voters (`fractions.decide`), none released, each still running by the node's clock. It records so, once, under `_continuum/decisions//`. It takes up no proposal with a lower number than one of the matter that it took up, or that it holds as taken up by another node of its voters. Every node judges the record: its history must hold votes for the proposal by that many voters, none released there. A record counts for each voter its node carries for, and for each voter that is out whose vote its history holds (its own nodes commit nothing); a voter counts once, however many records count for it. 4. The proposal is **decided**, and is a **decision**, once a record of it has in its history, itself among them, records that count for more than two thirds of all the voters, the fraction as it holds there. That is read from the document, the same by every node, and never goes away while the epoch lasts. **At once.** Nothing waits for a vote's days to end. With the votes there, the nodes take the proposal up as it reaches them, and it is decided as fast as they sync. **The last holds.** Several proposals of one matter can be open, and voted on, at a time, and more than one can come to be decided: voters change their minds. Of the decisions of a matter, the one with the highest number **holds**; of two with the same number, made out of each other's sight, the one with the lower digest. A decision closes the proposals of its matter with a lower number: clients offer no vote on them. **What hangs.** A proposal that had the votes and is short of records (nodes were down, or keep theirs back) can still be decided, and whoever holds the last record chooses the day: a record can be made to look as old as its maker likes, so no rule ends its time. Two things bound it. A node takes up nothing lower than it took up, so what is decided late changes what holds only where no proposal with a higher number was decided since. And it shows: `GET /registry/decisions` has what was taken up, by whose nodes, and how many it is short of. The voters end it by deciding a later proposal of the matter, saying the same or something else: that one holds, whatever comes after. **Where a decision counts.** A change is judged by the decisions decided in its history, so one made out of sight of a decision is valid as it was written, and every node holds it. The registry is resolved by the decisions that hold among all the changes a node holds: a limit that was lowered leaves out what is past it, wherever that was signed. Every node acts on the decision that holds, the same from the same changes, unless it refuses it (Refusing a decision). **By any node.** A proposal, a vote and their release are taken in any node's change: the signature is the voter's. So a voter votes at whatever node it reaches, or signs a vote that someone carries to one. A vote kept back counts while it runs, as its signer wrote, and no longer. What brings a vote from a person to a node (a client, a page, paper) is the application's. **From the past.** Votes kept back until they ran out, or crafted to look old, are held while they run by no honest node, so nothing takes their proposal up but its makers' nodes, and their records are judged like any: they need the votes of two thirds of the voters. With that many keys stolen later, a decision of then is made up within the epoch, and holds if it gets the highest number of its matter; the voters decide a later one. A remake puts everything before it out of reach. The votes are the users' own, signed with their keys, and take the days people take. Taking up is their nodes', and takes as long as syncing does. One time is compared across machines: a vote's end, written by the voter's client and read by the nodes' clocks. A window of days bears clocks that are minutes apart. **What is decided.** * **A number**: any number of the policy, the fractions among them, to any value. Each number is a matter of its own. * **The policy**, the rest of it, as a whole (The policy changes by a decision). * **A user's first keys**, for a user that lost them or had them stolen. The proposal names the user, the first keys it is to have, and a cut for those it has: what they signed outside the cut doesn't count, as with a key above them (Cuts). The voters are above every user's first keys. A user that lost its keys comes in again under another name, so that it has a voice and the voters know whom they give the name back to. Decided, it signs under its name as before, with its names, its lines and those it brought in, and releases the other name. * **The names of a user that is out**, while they wait. The proposal names the user and, for each name it deals with, that it is free or who is to have it. A name freed is anyone's to claim from the decision on; the user's own name freed, the user is gone. A name given is the user's claim made over: the user the decision names holds it where that claim was, releases it like its own, and it doesn't count toward its limit. A user that is vouched for again has back what no decision dealt with. What another claimed in sight of a claim that didn't stand (the user was gone meanwhile) stays the other's, as with anything that comes back. * **Whose a contested name is.** The proposal names one of its claims: decided, that claim is final. * **A name the rules leave to the voters** (`"{voters}"`): given to a user, who holds it as by a claim and releases it like one; it doesn't count toward its limit. Released, it is given anew. * **A remake**, and with it who votes and who the roots are in the next epoch (below). An epoch's remakes are one matter. A decision stays, whatever is cut off after: a vote signed with a key that is retired later, from before, stays in it. The days a vote takes are the time to cut a stolen key off. ### Remakes A federated swarm compacts by a remake its voters decide. A remake throws history away and names who votes and who the roots are in the next epoch, and does nothing else: what the next epoch holds isn't voted on. It is the registry as it resolves, which every node works out itself. * **The proposal** names the voters of the next epoch (all users, or those of a list) and its roots (those there are, unless it names others). It is voted on like anything else. * **The base.** The remake's **coordinator** is the node of the proposer that takes it up first. It names the base in its record: the base is that record's history. * **Taking it up.** A voter's node takes a remake up with its base: once the votes are there, and the base holds all that the node held `baseAge` before the base reached it, so that a remake can't leave out what the swarm has. It builds the snapshot first, and records the ID of the epoch it got. The remake is decided for an ID: by records that name that one (Continuum changing under a swarm). One base a proposal, the first to reach the node; a voter whose nodes recorded two IDs counts for neither. A coordinator that names two bases, or none, may get no remake: it is proposed again, under the next number. * **Every node builds the snapshot** itself once the remake is decided, from the base as it holds it, and switches after the switch delay, as today. The snapshot holds the registry as it resolves at the base: * the policy that holds, with its numbers; * the voters and the roots, as the proposal says; * the users that count, and those out and not gone, each with its name (or that it is contested, and with which), ID, keys, nodes, and who created and who vouches for it, or that it is in by the seats; * the claims that stand, the names decisions gave, and what the order among the claims of a name rests on: which gives way to which, which is late against which, which is settled, which final; * the values in the namespaces that count, as the envelopes they are; * the bans that stand, and what is uncovered and not dropped; * the member entries of the nodes that carry for a user it holds, and the epochs' metadata, as today; * the digest of every statement the base holds, for this one epoch. * **What it leaves out**: all history, and with it everything that is over or didn't count. A claim released, and its release. A key retired, a node stopped, an unvouch, each with its cut: what they left out is out for good. A user gone. A proposal, its votes and the nodes' records: what holds is in the policy and the registry. So after a remake the document's size goes by what stands (users, their keys and nodes, names held, values, members), and for one epoch by 32 bytes for each statement there was; not by what ever happened. Within an epoch nothing is removed: a release is a statement like any other, signed, and a document keeps its history. The remake is what deletes. * **Nothing it dropped is written again.** An envelope is taken in the epoch it names and in the next. So that what a remake left out (a stolen laptop's key and node, retired since) can't be handed in again in the next epoch as signed in the one before, the root change lists the digests of all the statements the base held, and a statement among them is refused. The epoch after drops the list. * **Carried over.** A node that switches writes again, as they are, the envelopes it holds that the base lacks, whoever signed them: statements, values, proposals and votes. It does so in its first changes of the new epoch, before it takes anything from a peer, and in the order it holds them: what is late against another, or gives way to it, in a later change than that other. Any node commits what names the epoch before (a `node` statement only the node it names). It is taken as it is signed, and never refused for what stands in the new epoch: whether it counts is resolved. So what a node's changes witnessed in the old epoch its first changes witness again, and a claim that turns up later as signed in the epoch before is late against what a root's node carried over. Against a claim the snapshot holds, what is carried over gives way. * **A cut carried over** (with a `retire`, a stop, an `unvouch`, a ban) names changes of the epoch before, which the new one doesn't hold. It reaches as far as the snapshot: everything of its key, its node or its user that the snapshot doesn't hold is outside it. What was meant to stay is signed again. * **Decisions after the base** aren't in the snapshot. Their proposals and votes are carried over, and a node that held one decided takes it up again in the new epoch, whether its votes still run or not: it is decided there once the nodes of two thirds of the voters switched. Where the remake changed the voters so that its votes are too few, it is proposed again. * **Seen for long, over a remake.** What was gone, final or dropped at the base is so in the snapshot. What came to be so after the base: each node that carries for a voter says in its member entry, in its first change of the new epoch, which users it held as gone, which claims as final and what as dropped, beyond the snapshot. What the nodes of a third of the voters say, a node counted for one voter, is so. Every other length starts anew. * **Two remakes of one epoch.** They are one matter: the one with the highest number holds. A node that holds a remake decided takes up no other; one that switched goes on syncing the epoch it left while it keeps it, and where it finds a remake decided there with a higher number, it moves to that one by itself: it builds the snapshot from that base and carries over what it holds of the epoch both came from. What was signed only in the epoch it leaves goes to the quarantine, for its user to sign again. * **A remake that hangs**, short of records, and is decided weeks later sends every node to a base that old. What was signed since comes along: every node carries over what it holds, in order, decisions among it. What it costs is the lengths that had begun, and whatever only a node witnessed that didn't come along. A swarm ends it as any proposal that hangs: by deciding another remake. * **What a remake makes final.** A cut reaches no further back than the snapshot. What a key signed that counted at the base counts for good, though the key be cut off later from before; so for an unvouch. The days a vote takes are the time to cut off a stolen key and to sort out what is contested. After, what a thief did stands until it is undone by hand. * **A node that was away** comes back as said below (Coming back after remakes). * **A node that joins** is given a root to start from, by whoever brings its user in: the genesis root, or the ID of a later epoch. * **No other kinds.** `replace` and `import` put content nobody signed: they start a new swarm. For the registry the document is small: a statement is under a KiB, a node's alive stamp with its digest and signature some 350 bytes, so a hundred nodes stamping daily write some 13 MiB a year. A remake a year is plenty for its size. What a remake also does is name the voters and the roots; a swarm whose users come and go remakes for that. ### Coming back after remakes A node that was away holds an epoch the swarm left, one remake back or several. Its peers name their epoch in the handshake and don't sync with it; `GET /admin/epochs` shows the epochs they name, and which of them the roots' nodes are in. A federated node never rejoins because peers advertise an epoch, however many do. It gets there in one of two ways: 1. **By the archives, on nobody's word.** A peer answers for an epoch it left as long as it keeps that epoch's document: `archiveRetention` at least, longer if its operator says, and every epoch on a node kept as an archive. Peers say in the handshake which epochs they keep. From such a peer the node syncs the rest of the epoch it is in, judging every change; sees the remake decided; builds the snapshot itself; and is in the next epoch, whose ID is the snapshot's hash. So on, epoch by epoch, as far as peers keep them: with an archive within reach, from any epoch to the swarm's, and for a node that joins, from the genesis root. Where the walk ends in another epoch than the node's peers are in, the node stops and shows it, for its operator to say which: an archive can keep changes back, and a decision of long ago can be made up with keys stolen since. Keeping an archive is an application's; continuum answers for what a node keeps. 2. **By an ID, on its operator's word.** Where no peer keeps the epoch any more, the node can't check how the swarm got from there to here. Its operator gives it the ID of the epoch to go to (`POST /admin/epochs/rejoin`), from a party it trusts: as when the node first joined, whoever brought its user in. The node rejoins as today: it downloads that epoch's snapshot from any peer, checked against the ID, and syncs what was written since. Either way, what follows: * **What it holds and the swarm never got.** What was signed in the epoch just before the one the node arrives in is carried over: written again as it is. What was signed further back isn't: an envelope is taken in its epoch and the next, no later. Its own user's go to the quarantine, and the client lists them for the user to sign again. A claim signed again is a new claim, after what was claimed since. * **What it finds of its user**, as the snapshot has it. There, with its keys, nodes and names: the node carries for it as before, and writes its member entry anew. Or out, its names waiting. Or gone, and so not in the snapshot: then no node takes the node's changes, it shows why, and its user comes in again as anyone does. * **As a voter or a root** the user is what the epoch it arrives in names it. * **Its old document** goes to the archive, as today. A node moves to an older epoch, or to another of the same age that doesn't hold by the rule above, only by its operator's word. ### The policy changes by a decision The policy but for its numbers is one matter. A proposal carries it whole: the version, the kinds with their rules, `userSigned`. As with every decision, a change is judged by the policy decided in its history, and the registry is resolved by the one that holds. No remake comes with it. A remake throws history away, a change of policy changes the rules, and neither needs the other. * **A policy a node doesn't know.** A node knows a policy if it knows everything in it (Continuum changing under a swarm). One that doesn't can't take the proposal up, so a policy is decided only once nodes of two thirds of the voters know it. A node that doesn't know a policy that holds stops syncing, as under any policy it doesn't know, says why, and goes on once it is upgraded. Or its operator refuses the decision (below). * **What the policy no longer covers** is **uncovered** where the decision holds: a claim that no rule lets its user make any more (the kind is gone, or the rule, or the name is now kept for another or left to the voters), a name a decision gave that the rules no longer leave to the voters, a value at a path `userSigned` no longer lists. It doesn't count. Every node shows it aside, under `_continuum/uncovered//` at the path it had, and no longer where it was. * **A kept name has no claim behind it.** Where a policy stops keeping a name for its user and lets anyone claim it, it is the first comer's at once, unless its user claimed it before: that claim stands like any other. * **Only its user takes it away**, and nobody changes it: a value by an envelope that puts nothing in its place (`null`), a claim by its `release`. Each names the path the thing had. Nothing else is written there. * **For as long as `uncovered` says.** Once it has been seen uncovered for that long (Lengths of time) it is **dropped**: no node shows it any more, and nothing brings it back. At 0 it is dropped at once. Until then, a later policy that covers it again has it count again, where it was. * **Where it is.** Within an epoch a rule moves nothing: a move is a change someone has to write, and every node would have to write the same one. So what is uncovered stays in the document where it was written, shown aside by every node while the policy that holds doesn't cover it. A remake moves it: the snapshot holds what is uncovered and not dropped under `_continuum/uncovered//`, and leaves out what was dropped. Where a later policy covers it again, every node shows it where it was, and the remake after puts it back. * **Whole, not merged.** Two proposals of a policy are two policies, and the later holds: what one changed isn't worked into the other. ### Going apart: a fork by choice Whoever the swarm's decisions leave behind goes on apart, with those who want the same: with an only root that went before the first remake, with a third of the voters gone so that nothing is decided, with two thirds of them turned against the rest, or for a policy the others won't have. A fork is proposed, and binds nobody: * Any user proposes it, one at a time: the policy to go on with (the one that holds, or another), and, if it likes, who votes there and who the roots are. Where it names none, they are as in a remake. Voters may vote for it: that shows who would go, and decides nothing. * The proposer's node names the base, as a remake's coordinator does, when its user says so, votes or none. * A node follows if its operator says so (`POST /admin/fork`, naming the proposal and the base): it builds the snapshot at the base with what the proposal says, carries over what it holds beyond the base, and goes on in that epoch. A node that doesn't stays in the epoch it is in, which goes on as it was. * Both sides have the same history up to the base and the same swarm ID, and from there different epochs. Their nodes don't sync, and leave each other out as neighbours. A statement signed on one side counts for nothing on the other: it names its epoch. What was signed in the epoch both came from counts on both, and a node carries for its user on a side only by writing there. * On each side the voters are those its epoch names, the ones that went the other way among them. A side that keeps two thirds of them remakes, and names those who stayed. A side with fewer decides nothing until it names its own, by a fork of its own. It moves nobody, and takes nothing along but the history: each party chooses its side. ### Refusing a decision A decision binds the nodes that follow it, and no node has to. By default a node follows every decision. Its operator has it refuse: * **By bounds** (`--bounds`, a file; `GET` and `PUT /admin/bounds`): for any number of the policy, the least and the most the node goes along with. A decision that holds and sets a number outside them is refused. Bounds that the policy breaks as the node starts with them refuse nothing: the node shows them. * **By hand** (`POST /admin/decisions/refuse`, naming the proposal): any decision of the epoch the node is in. What refusing does: * **Before.** While a proposal's votes run, a node whose bounds it breaks says so in its member entry, so the voters see who would go (`GET /registry/decisions`). * **The epoch without it.** A node that refuses a decision moves to the epoch built where its proposal was signed (at the changes the proposal says its signer saw): the registry as it resolves there, the policy, the voters and the roots as they are there, and the digest of the proposal refused, which makes it no other epoch and no proposal there. Every node that refuses the same decision builds the same epoch, whenever it does. So those who think alike meet there without arranging it. * **What it takes along.** As with a remake, the node carries over what it holds beyond that base, decisions among it but the one refused. So refusing costs what a remake costs, however old the proposal is. * **After**, as after any fork: the same swarm ID and the same history up to the base, different epochs, no syncing between them. On each side the voters are those the epoch names, and a side with too few of them names its own, by a fork. A node moves to the other side by its operator's word. * **A remake** is refused by staying: the epoch a node is in goes on as it was. So every number is the swarm's to set, and each party's to bear or not. A decision that lets one voter decide for all is followed by those who don't mind. This is how Bitcoin changes its rules. Nobody decides for anyone: nodes run the rules their operators chose. A change comes into force once enough of those who count signal that they run it, at a height named beforehand. Nodes that won't have it keep their rules, and with them their chain, the same up to there. And a transaction that would count on both chains is kept to one by naming its chain. Here the signalling is the nodes taking a proposal up, which takes knowing its policy; refusing is keeping one's rules; the height is the base; and the epoch in every envelope keeps a statement on its side. ### What every node judges A change is valid if, in the document at its dependencies: 1. It has no dependencies and is the root the node was given (the genesis change, or the epoch's snapshot). Else: 2. Its committer is a node that carries for a user there, one that isn't out and hasn't stopped there, proven by the node's signature. Or the change is the one by which a node comes to carry: it holds a `node` statement naming its committer, by a user that isn't out there, the committer's member entry, and nothing else. 3. Apart from the node's own member entry (of the shape the policy's version gives it, within `limits.entry`) and its own records of proposals, it writes only envelopes, each naming the swarm, its epoch, its path, its user and user ID, and for a statement what its signer saw (`seen`, changes in this change's history) and, where statements of its kind are numbered, the number that gives it, signed with a key that is that user's there and not retired there. The committer carries for that user, but for a proposal, a vote and their release, which any node commits, and a `node` statement, which the node it names does. 4. In a register (`_continuum/users/`, `_continuum/claims//`): only a new entry under its own digest. Under `_continuum/decisions/`: only the node's own record, once, of a proposal that is there, with votes for it in the change's history by more than `fractions.decide` of the voters, none released there. Nothing replaced, nothing deleted, nor anything that holds a register. 5. A `create`: its name is one the kind `user` takes, has no creation there that stands, a rule of the kind lets the signer, and the signer isn't past its limit there; or it is a root's, for a user the root change holds without keys. `key`, `node`, `vouch`, `ban`: not past their limits there; a `vouch` for a user that isn't gone there. `unvouch`: by the signer of what it takes back, or by a root for what is the seats'. `retire`, a node stopping: by a key above, or by the key itself as said under Cuts, the cut in the change's history. `release`: by the user of what it releases; of the user itself, with a first key. 6. A `claim`: the kind is declared, the name is one of it, a rule lets the signer, the signer isn't past the kind's limit there, and no claim of that name stands there. One that doesn't count there doesn't stand there. 7. In a namespace: at a listed depth, an envelope by a user of that name, replacing what is there (`prev`); nothing within one, nothing replacing what holds one. At a place the policy no longer covers: only its user's envelope that puts nothing there. 8. `propose`, `vote`: by a voter that isn't gone there (a fork: proposed by any user that isn't); a proposal not past its user's limit there (a fork: the only one of its user that is open); a vote where the user has none on that matter that isn't released. 9. `_continuum/access`, the swarm ID, the epochs, and what the root change sets for the swarm as a whole: never. **What is carried over**: an envelope naming the epoch before this one is held to less. Any node commits it (a `node` statement only the node it names). What it says its signer saw isn't looked at, and its number is taken as it states it. Of 5 to 8 only what the envelope itself shows is asked: its signature by a key that is its user's there, its register, for a value that it replaces what is there, and that the root change doesn't list its digest. Whether it counts is resolved. Where a rule goes by a user's name (6, 7) and the name has several creations there, a user that lost it, as far as the change's history shows (another remains, Two claims), is refused; while none remains, each of them may write. So a user whose late creation of a name is known can't scribble over the namespace, and one whose name a liar got contested goes on writing, for those who ban the liar to read. Judging reads the registers at the change's dependencies, and nothing else: no cut is applied beyond a retiring or an unvouch that is there; who is gone is as the stamps there show; and the policy with its numbers, the first keys and the names freed or given are as the decisions decided there leave them. A statement in a register was valid when it was taken, so judging the next needs no look further back. ### Resolving The **resolved registry** is a function of a set of changes that holds each change's history (and, for reading, of the users followed). In five steps, each reading only the steps before: 1. **Decisions.** Which proposals are decided, and which decision of each matter holds (Decisions): the policy with its numbers, the first keys given, the names freed, given or said to be someone's. They are read from the records, which were judged against the votes where they were written, so nothing below changes them. 2. **Who counts, and where.** The roots count, by their seats; a user the root change holds without a creator is in by the seats. A user counts at a statement if a `create` or `vouch` for it counts whose signer counts there by a line that doesn't pass through the user (so this ends), and the statement is within what every `unvouch` of that one leaves; what is the seats' is taken back once every root unvouched it. A statement counts if its user counts at it (a proposal and a vote: while their voter isn't gone); its key was the user's (added by statements that count, up to its creation, or given by a decision); it is within every cut set for that key (by a `retire` that counts, or a decision); a node carrying for the user committed it (any node, for what any node commits), within that node's cut if it has one; and it isn't past its limit (Users), by the limit that holds. A `retire`, a stop and an `unvouch` are never outside a cut they set themselves, nor left out with their carrier. Bans of followed users cut the same way. A user is **out** where no `create` or `vouch` for it counts any more. It is **gone** once seen out for `gone`, or where it released itself or a decision freed its name; and gone it stays, whatever is vouched or cut off after. 3. **Users' names.** A creation stands while it counts, isn't released, its user isn't gone, and a rule of the kind `user` lets its signer. Of the creations of a name that stand: the one that remains (Two claims) has the name, or has it wait while it is out. 4. **Names.** A claim stands the same way, where a rule of the policy that holds lets its user: anyone vouched for where the rule says `"*"`, a root where it says `"{root}"`, else the user that has the name the rule gives; and a name the voters gave stands as its decision says while the rule says `"{voters}"`. Among the claims of a name that stand: * every other gives way to a final one, unless it is final too; * of two, one signed in sight of the other: the other gives way (it didn't stand there, or the one in sight would have been refused). But where the other was down only by a release or a cut that a cut has taken back, the one signed in sight gives way, unless it is final; * what was carried over gives way to what the snapshot held; * and one is late against another as said under Two claims. Those that give way to none and are late against none remain: one, and its user holds the name, or has it wait while it is out; else the name is contested. A kept name is held by the user that has the user name. 5. **Values.** A value in a namespace counts if its envelope does and its user has the name. Where the document holds several at one place (written at once), those that count, in Automerge's order. Where the one there doesn't count, the last that does, back along `prev` (read in the document at the dependencies of the change that replaced it). A node keeps the resolved registry as it goes (a statement changes it around its own name), and answers from it: * `GET /registry/users/`: the user that has the name, its keys and nodes, who created it and who vouches for it; or that it is contested, between whom; or out, since where, and how long its names still wait; or gone. * `GET /registry/claims//`: the holder, and whether the claim is settled, and final; held "while a release stands" where it was made after one and isn't final; or contested, between whom, with the changes that make each claim late and whose nodes committed them. A user whose nodes showed both orders of two claims is marked, a root too: it lied, or its nodes were apart. * `GET /registry/decisions`: the roots, the voters, the policy and its numbers; what is proposed, with its number, who voted, until when, whose nodes took it up, how many it is short of, and which nodes would refuse it; what is decided, which decision of each matter holds, what hangs, and what this node refuses. * `GET /registry/uncovered/`: what a policy no longer covers of that user's, at the path it had, and how long it still stays. * `GET /store`, as today, with a value that doesn't count marked, and the one that counts in its place. ### Partitions, and coming back Three things are "conflicting data", and are dealt with apart. **Names claimed twice** are no partition: every node holds both claims and finds the same holder, or contested. The users see it and one releases; nobody drops anything. **Two epochs**, after a fork or a decision some refuse, are apart for good: each node is where its operator put it (by word or by bounds), and moves to the other side by being told to (it builds that side's snapshot from the base it holds, and carries over what it holds). After two remakes of one epoch, the nodes end up in the one that holds by themselves (Remakes). **Changes one side refuses** are a partition nobody chose. A node is cut off from the others when it holds a change they refuse, as everything it writes after builds on it. That happens by three things, and each shows: * **Its own node broke a rule**, by a bug or on purpose. The others refuse the change and, its signature proving it its own, the node as a whole: `GET /peers` (`refused`, with the change and why), the dashboard, `sync.refusedPeers` *(docs)*. * **The two sides judge differently**: versions that differ, a bug in a rule. Each refuses what the other takes; a node told so judges what it holds again and logs that the policies disagree *(docs)*. Where they only resolve differently, their stamps show it (Continuum changing under a swarm). * **An actor forked.** A node committed two changes under one actor and number and gave each to some. Automerge holds one change per actor and number, so a node holding one can't take the other, nor anything built on it *(checked upstream)*. Both carry the same node's signature: a node offered the second holds proof, shows it, and refuses the forking node from then on. (Today it refuses the second as forged, by whoever brought it *(checked: `document::signatures`)*.) Coming back is the side's own choice, never forced: an operator has the node **drop** what the others refuse (`POST /admin/refused/drop`, naming the peer whose word it takes). The node's document becomes what it would be without those changes and what was built on them, as a drop does today *(checked: `AppState::drop_taken`)*. The envelopes among them go to the quarantine and are written again as they are: an envelope doesn't name the change that carried it, so it is as valid in a new one that has in its history what its signer saw. Those that no longer fit stay there for the user to sign again: one replacing a value that is gone, or naming a change that was dropped. Which side drops, for a fork of an actor? No rule can say: the forking node may have ground the hash of the change it kept back, and a rule by hash would let it make everyone drop a year's work. A node shows which of the two the roots' nodes hold, and the operator follows them or doesn't. A node that just joined and got the lone change from the forking node drops and loses nothing. A side that doesn't want to come back stays as it is: the same swarm ID, another history. ### Reaching the others A node's neighbours come from the member list: a ring by key hash, and the pairs with the lowest scores *(checked: `swarm::topology`)*. An adversary choosing its node keys places its nodes around a victim, and then holds back what the victim writes, or what it should receive: a claim that never reaches a root is never settled. Who vouched for whom changes nothing in who connects to whom: a user's nodes needn't reach its creator's. What a federated node has against being surrounded is its operator's: * it keeps as neighbours the other nodes of its user, and its seeds, whatever the member list gives, and leaves out members that name another epoch; * it shows what would tell: a claim of its user that isn't settled long after `witness`, and how old the last change of the roots' nodes is that it holds. Being surrounded costs time, not names: a claim that reached nobody is out of the others' sight, and is contested or late like any such. A member's entry is its node's own, and stays in the document for the epoch. A remake takes along those of the nodes that carry for a user it holds. ### The API, tokens, reading * **Writing** through a node is handing it envelopes: it carries those of the users it carries for, judged before they leave, as today. `scripts/continuum-signed` signs them, votes among them. Whether a node takes proposals and votes from someone who isn't logged in (a page to vote from) is its operator's to say. * **A node's API users** (`--htpasswd`, a proxy's header) are its party's: they read, and use the node's admin endpoints. The registry gives nobody anything on another party's node: a name of the node's own is the node's, whoever has that name in the registry. * **Logging in by a key of the registry** works on a node for the users it carries for, and for those its operator names besides. (Today a user with keys in the registry logs in on any node *(docs)*.) * **Tokens** are taken only from the node itself and from the nodes its operator names: its party's others. (Today every node takes a token any member signed *(docs)*: a party's node could let itself in anywhere.) Ended sessions are each node's, as in a swarm without a registry. * **Reading**: every party reads everything. The registry holds public keys, names and addresses, nothing secret; a value only some should read is sealed for them, as today. * **Who may connect** is outside this design. Today it is the swarm key, a secret all nodes share: it keeps those who aren't parties from connecting and reading, as far as every party keeps it, and is no boundary between the parties. Nothing here rests on it. ## Why it holds **Promise 1**, by how a change is judged: every node judges a change before applying it, at its dependencies, and refuses it with everything built on it *(checked: `access::rules::judge_reading`, `access::screen`)*. The rules above read the document at the change's dependencies alone. **Promise 2.** Whether a change is valid depends on the change and its history; its hash covers both. So honest nodes agree on every change, hold the same valid changes once each has what the other has, and Automerge gives the same document for the same changes. Resolving is a function of the changes and the follows. Everything it reads is fixed by hashes: a statement's place is what it says it saw, a witness's word is its change's history, and a proposal is decided by its records' histories. A node's clock, and the order things reached it in, enter only into what its own node writes (its stamps, taking a proposal up, the base it takes), never into what it reads from the document. What must hold for this, and doesn't everywhere today: * the root given, never learned; * no window without a policy (it is in the root), and no syncing under a policy the node doesn't know; * a batch judged at heads that differ from a change's dependencies only where nothing the rules read changed in between: what screening takes as read by rules *(checked: `screen::relevant` lists members, users, remakes, votes, access and bans)* must have the registers of users and claims, the decisions and what is uncovered; * nothing a node keeps a bounded number of decides validity: a change pushed out of the waiting ones comes again *(checked: `MAX_WAITING`)*; * one change per actor and number. A forked actor breaks "hold the same changes" until one side drops. Automerge names a change by actor and number where Kleppmann's construction needs the hash. **Promise 3.** A value counts only with an envelope whose signature checks against a key that step 2 gives its user for the change that carries it. A key is a user's only by statements signed with keys above it, up to its creation, signed by its creator, and so on up to a root, in the root every node was given; or by a decision, which is promise 7's. A node that carries doesn't sign in the user's place: the envelope names its swarm, epoch, path, user and user ID *(checked for swarm, path and user: `access::envelope::check`)*, so it counts nowhere else and for nobody else. A name is held by a claim so signed, by a rule, or by a decision. Across a remake: every node builds the snapshot from changes it judged, so the snapshot holds only what counted, and what is carried over is signed as it was. **Promise 4.** Steps 3 and 4 name a holder only where exactly one claim remains. **Promise 5.** Let c be a claim that stands, and w a change that a root's node committed with c in its history, standing there, and no other claim of the name standing there (c is settled). Let c' be any other claim of that name. In the history of w it is missing, or doesn't stand. The roots' nodes are on every side, so w is a change by the side of c' that saw c hold the name while c' didn't: c' is late against c in every set of changes that holds w. A late claim never holds a name while the other stands, and c stands until it is released, its user is gone, or a decision deals with it. So nobody takes the name by another claim, whenever it surfaces, whatever it says it saw, and whatever brings it to count. What is left to an adversary while c isn't final, each in the open: * making c late too, so that none remains. That takes a change by a node of c's user or of a root with c' standing in its history and c not. An honest node that received c first never commits one: everything it commits after has c in its history. So it takes such a node that lies, or that truly received c' first. If it also committed changes with c and not c', both orders are in the document under its user's name, and the registry says so; * taking w away: the root stops its node with a cut from before w. Then c is as it was before that root saw it, and settled only if another root's node saw it too; * bringing back a claim c was made after: its release, or the cut that left it out, is cut off. Final ends all three. c has been seen holding the name for `final`: a third of the voters each have a node with two stamps that far apart, at which and between which the registry as that node held it gave the name to c. One of them is honest: its clock went that far, and all that while nothing it held took the name from c. From then on step 4 has every other claim give way to c. What is left then: a claim that became final the same way out of c's sight, which takes honest voters' nodes kept apart from c for that long, and leaves the name contested; the voters (7); and c's own key cut off from before c, which is its user's doing or the voters'. Before a root saw c: a claim c' out of its sight isn't late unless its own side shows otherwise, so the two contest each other, or, where a root's node got c' first, c' is settled and c late. That is first come, first served as far as anyone can witness it. What the assumptions are: signatures and hashes hold; an honest node's changes build on all it has received (Automerge does that); for settled, the changes the roots' nodes commit count and the roots don't turn; for final, fewer than a third of the voters are malicious, and the honest ones' nodes keep time. **Promise 6.** No rule for what users write reads a vote or waits for another party; a write is refused only by what its own history holds, and counts from the start. **Promise 7.** Let V be the epoch's voters, n of them, fewer than a third malicious. * *None that honest voters didn't vote for.* A record is valid only with votes for its proposal in its history by more than 2n/3 of V, none released there: more than n/3 of them honest voters'. And a proposal is decided only with records that count for more than 2n/3 of V, for more than n/3 of them written by honest nodes, each while it held that many votes, running by its clock. * *Not from the past.* So votes crafted later, or kept back until they ran out, bring no honest node to take anything up, and the nodes of fewer than a third decide nothing. * *The same one everywhere.* Whether a proposal is decided is read from its records and their histories; which decision of a matter holds, from the proposals' numbers, which follow from what each says its signer saw, and their digests. No node's clock enters, nor who committed a proposal, nor how often. * *Two of one matter.* A voter has one vote on a matter at a time. So two proposals of one matter are both decided only where more than a third of V voted for both: voters who changed their minds, or malicious ones, who are too few. The higher number holds. More than a third of V have nodes that took both up, honest ones among them, and an honest node takes the higher up after the lower: where voters changed their minds, what holds is what they moved to. A proposal decided late takes nothing from one with a higher number. * *The sides of a partition.* A side decides only with nodes of more than two thirds of V on it. Two sides both do only where more than a third of V have nodes, and votes, on both: then two proposals are decided, and every node acts on the same one once it holds both. * *Seen for long.* What was seen for a length of time has a third of the voters each with two stamps of one node that far apart: one of them honest, whose clock went that far, and which held the thing so all the while. Fewer than a third, stamping as they like, show nothing; and a node counts for one voter. * *A remake changes nothing.* The snapshot is a function of the base, which every node holds and judged itself. An honest voter's node takes up no base that leaves out what it held, and records the ID it built: a remake is decided for one ID. Who votes next and who the roots are is in the proposal, for all to see before they vote for it. What a node holds beyond the base it carries over itself. * *Nobody is moved.* A node refuses any decision by its operator's word or bounds, and follows a fork by its operator's word alone. * *With other fractions.* Write d for `fractions.decide` and s for `fractions.seen`. A decision no honest voter voted for takes d of the voters malicious. Two proposals of one matter both decided, with nobody changing their mind, take more than 2d − 1 of them voting both ways, which at a half or less is nobody; the same for two sides of a partition. What was seen for long holds against fewer than s of the voters. **Unvouching** takes away no more than its signer could have kept from seeing: what the unvouched user signed stays if a node of the unvoucher or of a root committed a change that has it in its history and not the unvouch. Those changes can't be taken back, so the point only moves forward as more of them show up. ## Roads not taken * **Agreement among the parties for every write** (PBFT and the like) would give one order of claims, final at once. It needs a fixed set of voters of which fewer than a third fail, halts the smaller side of a partition, and makes every claim wait for a round. It works against what continuum is for: no node special, each working on its own, both sides of a partition going on. Here only decisions take it, a few a year. * **A registrar**: every claim signed by a root before it counts. That is the roots' witnessing made a condition: one order, but nothing counts while they are away, and they decide alone. Here the same witness only orders what already counts, and time makes it final without them. * **Deciding by a hash or a timestamp** of the claims: whoever crafts later chooses the lower hash and the earlier time. * **Deciding by seniority** (the user nearer a root holds the name): always a holder, but a senior user that kept silent takes a junior's name by backdating, and a root that lies takes any. Contested, with `release` to give a name up, fails safer: a name is blocked in the open, not taken. * **The users above a user as witnesses of its claims** (those on its lines, down from a root): they would witness while the roots are away. But whoever is above a user would have a say about its names, a vouch would have to be accepted before it gave one, and in a registry whose users the roots create nobody is above anyone. The roots witness, and time makes final. * **One root.** One user's nodes would settle every claim, nothing would be settled while it is away, and it alone would stand between a claim and whoever backdates. Several roots cost a contest where two of them saw two claims in two orders. * **A root seated by a decision, within the epoch**: what the root before it settled, and whom it created, would change its standing after the fact, between the proposal and the decision. The roots are an epoch's, named with its voters. * **Votes by nodes**: a party runs as many nodes as it likes. * **Voters by a rule** (the users a root itself created, whom nobody else can multiply): who takes part and who doesn't is known to people, not to a rule. So those who vote say who votes next. * **Leaving out the voters that are away** (one whose nodes were silent for a time neither votes nor counts): those who stay could go on deciding whoever left. But silence is shown by stamps, and whoever stamps together shows the rest silent: a majority would decide at once what is to take two thirds, and a proposal crafted to look old would choose who counts. Every voter counts; a remake names those who take part, and where a third are gone before one, those left go apart. * **Recommending a majority, not two thirds**: a third that votes both ways must not get two proposals of one matter decided, to choose between them. Two thirds stand that against fewer than a third; a majority stands it against nobody. * **One decision a matter, each node taking up the first it sees and no other**: two would never both be decided. But two made at once split the nodes between them, neither is, and the matter stands still until the next epoch. Letting both be decided, and the higher number hold, never stops. * **A proposal that lapses** (taken up no more, and its records void, once its votes ran out): nothing would hang. But "once" is a time, and a record made to look as if written in time can't be told from one that was. Nodes going up in numbers only, and a later decision, end what hangs without a clock. * **A node holding back a decision that comes late**, by its own clock, for its operator to say: two nodes with the same changes would act on different decisions, and one that joined later would never ask. * **A decision counted where its proposal was made** (who votes, the numbers, a name given, all as they were there): a proposal's place is its signer's to choose. It is counted where it is decided, and the registry by what holds. * **A clock of the swarm** (the latest time a third of the voters have stamped) for how long something lasted: it sets one node's clock against another's. Two stamps of one node measure a length of time by one clock, and the document says what that node had seen at each. * **A policy that changes only by going apart**, each operator saying yes: nobody would be bound, and a swarm would split at every change. A decision binds those who don't refuse it. * **Unvouching by anyone above**: a user in between could put out one further down without taking along all below. But a root is above everyone, and would put out whom it liked, for good. * **Neighbours by who vouched for whom** (a node keeping its creator's nodes): a claim would reach a root whatever the member list gives, and a user would have to reach whoever brought it in. * **Rules that know what a name is** (an address's parts as numbers, two spellings of one address): continuum would have to know every kind. The structure of a name and the characters it is made of are the same for all of them; what it means is the application's. * **Numbers the design fixes**, the fractions above all: they would keep a swarm's voters from deciding badly by rules none of them chose. Every number is the swarm's; whoever won't bear a decision refuses it, and goes on with those who think alike. * **Users voting as soon as they are created**: whoever creates users carries every decision. * **Voters let in by a decision, without a remake**: nobody fills the votes, and nobody waits for a remake. But the voters of before make a decision "of then" later (the first root alone, for the time it was the only one). A remake is what puts that out of reach. * **A snapshot of only what its users' own nodes write again**: every node carries over what it holds, whoever signed it. Else what a root's node saw first after the base would be nowhere in the next epoch, and whoever wrote first there would have come first. * **An unvouch undoing everything its user ever signed**: nothing to backdate, but it takes back the user's releases, and no vouch brings the user back as it was. **Or only what the user signs in sight of it**: the user goes on by never building on it. **Or from where each node received it**: that is in no document, so two nodes would resolve the same changes differently. * **A user that was gone coming back by a vouch made in time**, out of the sight of those who saw it gone: a vouch crafted to look old then blocks any name claimed in good faith since. * **A claim that didn't count coming back over one made in sight of it** (its user vouched for again, its limit raised): whoever claimed a name that showed free would lose it to a claim it had seen and rightly passed over. * **First keys given by those who vouch for the user**: fewer to convince, but a user's creator takes its name where nobody else vouched. * **A registry of only what is signed**, from the start: nothing unsigned ever counts, but it is incomplete for as long as users take to come, and what reads it needs the repository beside it meanwhile. * **A document per user**, each written by one party, a claim counted across them (as in Secure Scuttlebutt's feeds). A fork of an actor then spoils only the forker's own document, not the swarm, which is the one thing this design can't give. It needs what continuum doesn't have: many documents, and what one had seen of the others recorded by hand. One Automerge document records that by itself. ## What members are trusted with, then [`trust.md`](trust.md) lists what a member can do today. In a federated swarm: | Today | Then | |---|---| | Write or delete any user data | Only envelopes, of users it carries for; nothing plain, nothing deleted from a register | | Write as any user | An envelope needs the user's key | | Edit the member and user registries | Its own member entry, of a shape and a size; users come and go by statements, which only add | | Forge votes, commit a remake alone | Votes are users', signed; a decision takes two thirds of the voters, and every node judges the records; every node builds the snapshot itself | | Make the swarm forget peers | A forget record of another's node is refused; whom a node talks to is its own | | Advertise an epoch a rejoining node follows | A node follows a remake it sees decided, or an epoch its operator gave it | | Be a joining node's first sync | Judged from the root on, by the policy in it | | Say it is ready, be a catch-up source | Still believed: it can hold changes back, not add any. A joiner syncs with the others after | | Sign a token every node takes | Taken by the nodes whose operators named it | | Let any user of the registry log in | The users it carries for, and those its operator names | | Say whom it reaches, how stable it is | Still believed: it bends who syncs with whom; a node keeps its seeds and its user's other nodes whatever | | Say when it was alive, and how often all should | Believed for itself only; it takes a third of the voters to show a user out, or a claim holding, for long. How often is the policy's | "Member" stays the word for a node in the swarm; the unit that is trusted or not is the party. ## Continuum, or the application In continuum, as rules every node judges by and data that parametrizes them: users by statements (creating, vouching and unvouching, lines, keys, cuts, nodes that carry), the namespace rule, claims by kind with their rules and limits, late, contested, settled and final, bans, lengths of time read from the stamps, decisions by the voters (the numbers, the policy, a user's first keys, names), remakes that every node builds and that name the voters and the roots, going apart and refusing a decision, resolving and its API, the drop an operator asks for. All of it is general: a swarm with other kinds, or none, uses the same. In the application, for the registry: which kinds there are and their rules (data in the root), what a host's entry holds, the client that signs (an extension of `scripts/continuum-signed`), moving the repository in, and writing out the files the consumers read. Whether a host's entry may use a name is the application's check against the resolved registry, when it writes the files out. So are a node kept as an archive of every epoch, and whatever brings a vote from a person to a node. More policies later are more data where a rule has a parameter, and a new rule in continuum, with a policy of its own, where it hasn't; either way a decision. What changes in continuum besides the rules, under the federated policy only: policy version 2; the envelope's payload names the user ID, the epoch, and for a statement what its signer saw; a node is given its root, syncs under no policy it doesn't know, takes tokens and logins by key as its operator says, writes no sessions into the document, stamps as often as the policy says, keeps its seeds and its user's other nodes as neighbours, keeps the document of an epoch it left on disk and answers for it, takes no remake but one its voters decided, rejoins no epoch because peers advertise it, and refuses what its bounds say. For every swarm: the wire's version, with a handshake that says which epochs its node keeps, and a node that speaks the wire version before its own too. [`trust.md`](trust.md), [`access.md`](access.md), [`remakes.md`](remakes.md) and the glossary get the federated case: party, statement, line, root, voter, claim, cut, late, contested, settled, final, out, gone, uncovered, seen for, taking a proposal up, a decision that holds, bounds, and a ban of a user beside a ban of a node. ## Continuum changing under a swarm Parties upgrade when they like, so a federated swarm always runs several versions of continuum. Given the same changes they must agree on three things: which are valid, what the registry is, and, byte for byte, the snapshot a remake builds. Whether two versions do can't be told by looking at them, and a version's number says what its author remembered to say. So the design goes by what nodes compute: * **Every stamp says what its node computes.** With its alive stamp a node records the digest of the registry as it resolves at that change's dependencies: what a snapshot would hold there, less the members' entries and what a remake's proposal names. A node that holds those changes resolves there and compares: as it goes where it holds exactly those, else for the latest stamp of each other party once in a while. Two digests for the same changes prove that two nodes resolve differently, signed by both, at the first input where they do: it shows (`GET /peers`, the dashboard) long before a remake would have sent them to two epochs. * **A remake is taken up by its result.** A voter's node builds the snapshot from the base before it takes the remake up, and records the ID of the epoch it got. The remake is decided for the ID that the nodes of two thirds of the voters got. A node that got another stays where it is, and says so. * **A node checks itself before it writes.** Started with a version it didn't run before, a node judges and resolves again what it holds *(docs: a node told that policies disagree does so today)*, and compares with the stamps it holds of the voters' nodes. Where it differs from those of a third of the voters or more, it writes nothing, and shows it, until its operator says to go on. Where it differs from fewer it shows that and goes on: one party stamping nonsense stops nobody. * **A change of the rules is a change of policy.** What a version judges or resolves differently on purpose, it does under a policy of its own (a part of the policy that versions before don't know), which the swarm decides. A change is judged by the policy decided in its history, so a version judges what was written before as it was judged then, and carries the rules of every policy that held in an epoch it can still walk. A node knows a policy if it knows everything in it: it goes by what the policy holds, not by its number, and takes up none that has a part it doesn't know. * **Vectors.** Continuum carries recorded inputs with what must come of them: changes and whether they are valid, sets of changes and the snapshot they resolve to. Each test named under Attacks leaves some. A release adds vectors and changes none, and every version passes all of them: a rule changed without a policy fails there, before it is released. What can't change under a swarm, whatever is decided: how an envelope is read and what its signature covers (a snapshot carries envelopes as they were signed, from epoch to epoch); a statement's digest; a change's hash, and what Automerge makes of the same changes; a snapshot's bytes for the same base and policy. A new form of any of them comes beside the old one, under a policy. What changes freely: everything a node does for itself. Its API, its storage, how it syncs and with whom. The wire is between two nodes, not the swarm's: a version speaks its own and the one before, so that parties upgrade one after another. That is new for every swarm *(checked: a message of another wire version is ignored whole today, `transport::wire`)*, and comes before a federated swarm is used. And a fork it is when nodes that hold the same changes don't come to the same, and neither gives way. It shows by a change one takes and the other refuses, by two digests for the same changes, or by two IDs for one base: by what was computed, never by a number. Which of the two is the swarm's no rule says. The parties see how many of them say which, and upgrade, drop, or go apart. ## Attacks Each with what honest nodes do, the promise it touches, and what shows it: `unit` in the module named (`access::statements`, `access::claims`, `access::resolve`, `access::decisions` are new), `sim` a simulation in `src/simtest/federation.rs`, `argued` where no test can. Each test leaves vectors (Continuum changing under a swarm). Statements and users: | # | The adversary | Honest nodes | Promise | Shown by | |---|---|---|---|---| | 1 | Signs a statement with a key that isn't the user's | Refuse | 3 | unit, statements: `a_statement_needs_its_users_key` | | 2 | Puts another user's statement into a change of its own node | Refuse, its node not carrying for the signer; but for what a decision is made of, and what is carried over a remake | 3 | unit: `only_a_users_node_carries_it` | | 3 | Replaces or deletes a statement, or what holds the register | Refuse | 2, 3 | unit: `a_register_only_grows` | | 4 | Offers a statement again; or an envelope signed for another swarm, epoch, path or user ID | Nothing where it is there under its digest; refuse elsewhere | 3 | unit, exists for swarm and path: `what_an_envelope_must_be`; `signed_for_its_user_id_and_epoch` | | 5 | Commits a statement a second time, in a change with other dependencies, to move it | A statement is where it says its signer was (`seen`), whoever carries it and how often: nothing moves | 2 | unit: `a_statement_carried_twice` | | 6 | Creates a user listing a victim's public key beside its own | The victim's envelopes name the victim's ID: they count for no other | 3 | unit: `a_key_in_two_creations` | | 7 | Users vouch for each other in a ring away from the roots; a user vouches for its creator | None is vouched for by it | 3 | unit, resolve: `no_line_no_user` | | 8 | Creates a name in sight of its creation | Refuse | 4 | unit: `a_name_created_once` | | 9 | Creates a name another has, saying it saw nothing of it | Hold both; late once a root saw the first. Before: contested, or the first is late where a root's node got the other first | 4, 5 | unit: `a_backdated_creation_is_late` | | 10 | Gets a user's name contested to free its names | Its claims stand without the name | 5 | unit: `claims_stand_without_the_name` | | 11 | Creates many users, each claiming many names (sybils); creates them out of each other's sight to pass the limit | Refuse past the limits in sight; out of sight, those past them don't count. A limit bounds how many each user brings in itself, not how many come in below it: each shows below its creator, for all to see, to ban, and to go with it when it is unvouched | 6 | unit: `limits_on_creating`, `past_a_limit_out_of_sight` | | 12 | Adds keys, nodes or statements without end; signs and gives up without end (vouch and unvouch, claim and release, key and retire) | Refuse past the limits. What is given up counts toward none: it is taken no faster than a budget per party, and a remake leaves it out | 6 | unit: `limits_on_a_register`; sim: `a_party_past_its_budget_waits` | | 13 | Signs more than its limit out of each other's sight; another claims a name that so doesn't count; then gives the earlier ones up | What is past a limit stays past it, whatever is given up later; and the claim made in sight of it doesn't give way | 5 | unit: `past_a_limit_for_good` | | 14 | Names another party's node as one that carries for it; offers that node a token of its own | A node carries only once it committed the statement naming it; a token is taken from nodes the operator named | 3 | unit: `a_node_carries_by_its_own_word`, `a_token_of_ones_party` | Unvouching: | # | The adversary | Honest nodes | Promise | Shown by | |---|---|---|---|---| | 15 | Unvouches a user it didn't vouch for; a root unvouches the users the root change holds, or those a root before it created | Refuse the first. What is the seats' is taken back once every root unvouched it: one root puts nobody out, where there are several | 3 | unit: `only_the_voucher_unvouches`, `the_seats_take_back_together` | | 16 | The roots unvouch the voters, to keep them from deciding | A voter votes while it isn't gone, in or out, and a record of any node that holds its vote counts for it: who votes is the remake's word, not its vouchers' | 7 | unit: `a_voter_that_is_out_votes` | | 17 | Unvouches saying it saw little, to undo what the user did since | What its own nodes or a root's had seen of the user stays | as said under Unvouching | unit: `an_unvouch_undoes_nothing_seen` | | 18 | The unvouched user signs on, saying it saw nothing of the unvouch, or across a partition | Hold it as part of another's history only; it doesn't count; after healing every node finds the same | 2, 3 | unit: `past_an_unvouch`; sim: `an_unvouch_across_a_partition` | | 19 | A user is unvouched: what of those it brought in, and its names? | One that another vouched for stays in, without doing anything. The others are out from the same point; a vouch after brings them back whole. Their names wait | 4 | unit: `a_second_line_keeps_it`, `those_it_brought_in`, `a_vouch_brings_back` | | 20 | An unvouched user's nodes keep sending | Refused as peers; nothing taken from them | 6 | sim: `nothing_from_an_unvouched_node` | | 21 | Claims a name of a user that is out, or creates its user name | Refuse: the names wait until the user is gone, or a decision frees them or gives them away | 5 | unit: `names_wait_while_out` | | 22 | Has a user unvouched, then stamps its nodes `gone` apart at once, to free the names; carries for many voters to be many | Gone takes a third of the voters, each with a node, and a node counts for one | 5 | unit: `gone_by_a_third_of_the_voters`, `a_node_is_seen_for_one_voter` | | 23 | Vouches for a gone user saying it saw nothing of that, over a name claimed since | Gone stays: no vouch brings it back | 4 | unit: `gone_stays_gone` | | 24 | Out, signs a claim that doesn't count; another claims the name in sight of it; a vouch brings the user back | It is back with what it signed, but the claim made in sight of one that didn't count doesn't give way to it; nor does a settled one that never saw it | 5 | unit: `back_but_not_over_a_later_claim` | Namespaces: | # | The adversary | Honest nodes | Promise | Shown by | |---|---|---|---|---| | 25 | Writes into another's namespace, signed by itself | Refuse, and the node as a whole | 3 | unit: `a_namespace_is_its_users`; sim, as `a_member_writing_against_the_rules` today | | 26 | Writes plain values, or protocol data but its own member entry | Refuse | 3 | unit: `nothing_plain` | | 27 | Puts an old envelope back | Refuse: it doesn't replace what is there | 3 | unit, exists: `what_an_envelope_must_be` | | 28 | A user with a late creation of a name writes in the namespace | Refuse where its change's history shows it lost the name; else hold it and leave it out | 3 | unit: `a_user_that_lost_its_name` | Claims: | # | The adversary | Honest nodes | Promise | Shown by | |---|---|---|---|---| | 29 | Claims a held name in sight of the claim | Refuse | 4 | unit, claims: `first_come_first_served` | | 30 | Claims a settled name saying it saw nothing of the claim, long after | Hold both; it is late, the holder holds | 5 | unit: `a_backdated_claim_is_late`; sim: `a_backdated_claim_loses` | | 31 | Two honest users claim on two sides of a partition | Hold both; every node finds the same: one holder, or contested; a release leaves one | 2, 4 | sim: `a_partition_heals_to_one_answer`; unit: `a_release_ends_a_contest` | | 32 | Claims `x.tv.r` as another; claims a top-level domain as another than a root; claims `wiki.r`, which the rules leave to the voters | Refuse: the kind's rule. A kept name needs no claim; a claim by a user that doesn't have the name its rule gives doesn't count | 4 | unit: `a_kinds_rules`, `a_kept_name`, `a_rule_goes_by_who_has_the_name` | | 33 | Claims past its limit, in sight or out of sight of its other claims | Refuse in sight; out of sight, those past the limit don't count | 4, 6 | unit: `a_limit_in_sight`, `past_a_limit_out_of_sight` | | 34 | Claims `TV.r` beside `tv.r`, or `10.243.foo.bar`; claims one address in two spellings | Refuse what has characters the kind doesn't name. Else a name is compared as written: the application claims one spelling and reads no other | 4 | unit: `a_kinds_characters`; argued (Claims) | | 35 | A root says it saw a rival first, after the claim is settled | The name is contested; the registry names the changes and the root, and marks it if it showed both orders. Once the claim is final: nothing | not promised; 5 once final | unit: `a_root_contests`; sim: `both_orders_show` | | 36 | Hands an honest node of a root or of the claimant, back from a day off, a rival before the claim | A node that comes back catches up with the peers it keeps before it writes. Where it wrote all the same: contested, until one releases or the voters say. Once the claim is final: nothing | not promised; 5 once final | sim: `a_node_handed_the_rival_first` | | 37 | Two claims made at once reach two roots' nodes in two orders | Each is late against the other: contested, and one releases | 4 | unit: `roots_that_saw_two_orders` | | 38 | Keeps silent while no root's node is up, then claims saying it saw nothing | Before the claim is settled: contested, or whichever reaches a root's node first holds. After: late. Final: it gives way | 5 | unit: `silence_before_settling` | | 39 | Releases a claim with a stolen key, an accomplice claims | Once the key is cut off the release doesn't count: the accomplice's claim, made in sight of the first, gives way, unless it is final by then | 3, 4 | unit: `a_release_cut_off` | | 40 | Every root that saw a claim stops its node with a cut from before, and a rival is handed in | A final claim holds. One that isn't is as before the roots saw it: contested, or late | 5 once final; not promised before | unit: `final_against_the_roots` | | 41 | Stamps its nodes `final` apart at once, to make a claim final that doesn't hold, or holds only as it sees it | Final takes a third of the voters, each having held the claim as the holder at both stamps and between | 5 | unit: `final_by_a_third_of_the_voters` | | 42 | Keeps honest voters' nodes apart for longer than `final`, a claim of one name on each side | Both are final: contested, until one releases or the voters say | not promised | sim: `two_finals` | Keys: | # | The adversary | Honest nodes | Promise | Shown by | |---|---|---|---|---| | 43 | Steals a device key and signs with it | Take it until a key above cuts it off, then leave out what is outside the cut; a value it replaced is read again | 3 | unit: `a_retired_key_counts_within_its_cut`, `the_value_before_counts_again`; sim: `a_stolen_key_cut_off` | | 44 | Signs with a retired key, saying it saw nothing of the retiring | Hold it (valid as written), leave it out | 3 | unit: `backdated_past_a_cut` | | 45 | With a stolen device key, retires the keys above or beside it | Refuse | 3 | unit: `no_key_retires_one_above` | | 46 | With a stolen device key, retires that key from long ago, to undo what its user signed | Refuse: a key retires itself from where it stands | 3 | unit: `a_key_retires_itself_forward` | | 47 | A key retires itself; a retirement is carried by a node that only the retired key named; a node commits its own stop | Each counts: a cut never leaves out its own statement, nor the node that carried it | 2 | unit: `a_cut_never_reaches_itself` | | 48 | With a stolen key, retires the keys below it, stops nodes, unvouches, releases names | A key above cuts it off from before: all of it is taken back, but what became final on it | 3 | unit: `a_cut_takes_back_what_the_key_cut` | | 49 | With a device key, releases the user itself | Refuse: it takes a first key | 3 | unit: `giving_up_takes_a_first_key` | | 50 | Steals a user's first key | The name is the thief's too, until a decision gives the user first keys anew, with a cut for the stolen one | 7 | unit: `first_keys_by_a_decision` | | 51 | Cuts its own key off early to take back a vouch or a release | It is taken back, but for what is final; a user with a second vouch stays | not promised | unit: `a_second_vouch_stands` | | 52 | A key is retired on one side of a partition while it signs on the other | After healing, every node leaves out the same | 2 | sim: `a_cut_across_a_partition` | | 53 | Steals a node's key: commits changes as a witness | They count until the node is stopped with a cut, then not | 5 | unit: `a_stopped_node_witnesses_nothing` | Decisions and remakes: | # | The adversary | Honest nodes | Promise | Shown by | |---|---|---|---|---| | 54 | Forges a vote; votes as a user that isn't a voter, or one that is gone | Refuse | 7 | unit, decisions: `a_vote_is_a_voters` | | 55 | Brings in many users to vote, also while a remake's votes run | They vote only if a remake names them: by a list, or as all there were when it was proposed, which those who vote saw | 7 | unit: `who_votes`, `all_users_as_proposed` | | 56 | A remake that says all users, after one user brought in many | They vote in the next epoch: all users is whoever brought users in. The voters see the list before they vote, and name one of their own instead | not promised | unit: `voters_are_the_remakes` | | 57 | Records taking a proposal up without the votes, or with released ones | Refuse: every node judges a record against the votes in its history | 7 | unit: `a_record_needs_the_votes` | | 58 | Carries for many voters that have no node, and records with votes that ran out | Taken: nobody but the recording node reads a vote's end. A voter without a node is the party that carries for it, for a record; what is seen for long counts that node once | not promised | unit: `a_record_counts_for_its_voters`; argued (Decisions) | | 59 | Keeps votes back until they ran out, or crafts them to look old, then shows them | No honest node takes the proposal up, and fewer than a third decide nothing | 7 | unit: `taken_up_while_the_votes_run`; sim: `a_decision_from_the_past` | | 60 | Keeps its node's record back, and shows it weeks later: a proposal decided late | It holds only where none of its matter with a higher number was decided since: a node takes up nothing lower than it took up. What hangs shows, and the voters end it with a later proposal | not promised | unit: `nothing_lower_is_taken_up`; sim: `decided_late` | | 61 | Two proposals of one matter both decided: voters changed their minds, or a third voted both ways | Every node acts on the one with the higher number, the same from the same changes; the other shows as replaced | 7 | unit: `the_last_holds`; sim: `two_decided_one_holds` | | 62 | Makes a proposal saying it saw little or much, for a number of its choosing; grinds its digest; commits another's a second time | A number brings nothing without the votes of two thirds and their nodes' records; who votes is the epoch's, wherever a proposal is made; a second carrier changes nothing | 7 | unit: `a_proposal_is_where_it_was_signed` | | 63 | Stays away to hold decisions up | It counts on. A third staying away do hold them up: the rest go apart, naming who votes | 7 | unit: `two_thirds_of_all` | | 64 | Asks the voters for another user's first keys, saying it is that user | It takes two thirds of them, and the days a vote takes, shown to all; the user signs on meanwhile | not promised | argued (Decisions) | | 65 | Puts a voter's vote into a change of its own node; keeps one back; offers one again | Taken: the signature is the voter's. It counts while it runs; the register holds it once | 7 | unit: `a_vote_by_any_node` | | 66 | Signs a vote that says it runs out in ten years | A node counts no vote for longer than `window` from when it first held it | 7 | unit: `a_vote_runs_a_window` | | 67 | A decision lowers a limit; a user signs on saying it saw nothing of the decision. Or a decision sets a number that makes no sense | Valid as written, and resolved by the limit that holds: what is past it doesn't count. The number has the result it has | 6 | unit: `a_lowered_limit_leaves_out_the_last` | | 68 | Opens proposals without end | Refuse past `limits.proposals` | 6 | unit: `limits_on_proposals` | | 69 | A proposal gives away the name of a user that is out; the user is gone and another claims the name before it is decided | The claim was made in sight of one that didn't stand: it doesn't give way to what the decision gives | 5 | unit: `given_too_late` | | 70 | Contests a name, then asks the voters for it | It takes two thirds of them; the claim they name is final | not promised | unit: `whose_a_contested_name_is` | | 71 | Claims `wiki.r`, which the rules leave to the voters; holds on to it against a later decision | Refuse the claim. The name is whose the decision that holds says | 4, 7 | unit: `a_name_by_the_voters` | | 72 | A user is out and stays out: what of its names? | A decision frees them, or gives them to another, whatever `gone` says | 7 | unit: `a_decision_frees_or_gives` | | 73 | The voters decide a policy that covers a user's names no more; another user writes over what is uncovered; a third of the voters stamp to drop it at once | It doesn't count where the policy holds, and shows aside. Only its user takes it away, nobody changes it; it is dropped once seen there for `uncovered` | not promised | unit: `what_a_policy_no_longer_covers`, `uncovered_is_only_taken_away` | | 74 | The voters decide a policy that stops keeping names for their users | A kept name its user claimed stays its claim. One it didn't is the first comer's | not promised | unit: `a_kept_name_claimed` | | 75 | Names a base for a remake that leaves out what the swarm holds | No honest voter's node takes it up | 7 | sim: `a_stale_base_is_not_taken_up` | | 76 | A remake's coordinator names two bases, or none; a voter's nodes record two IDs | A node takes the remake up with one base, and such a voter counts for neither: one ID is decided, or none. Then the remake is proposed again | 7 | sim: `two_bases_no_remake` | | 77 | Runs most of the nodes; serves a snapshot of its own | Nothing reads a count of nodes; every node builds the snapshot itself | 7 | sim: `every_node_builds_the_snapshot` | | 78 | A name is claimed and settled after a remake's base; after the switch a pretender signs a claim of it "in the epoch before" | Every node wrote again what it held, in its first changes of the new epoch and in order: the pretender's claim is late against what a root's node carried over | 5 | unit: `carried_over_in_order`; sim: `a_pretender_after_a_remake` | | 79 | Signs a claim "in the epoch before" of a name the snapshot holds | It gives way to what the snapshot holds | 5 | unit: `the_snapshot_comes_first` | | 80 | Hands in again what a remake left out: a stolen laptop's `node` and `key` statements, retired since | Refuse: the root change lists the digests of the statements the base held | 3 | unit: `what_a_remake_dropped_stays_out` | | 81 | Keeps the last record of a remake back, and shows it a month later | Every node goes to that base and carries over what it holds: statements, values, the order it saw, decisions since. What a third of the voters' nodes held as gone, final or dropped stays so; other lengths start anew. Not at all where another remake was decided since | not promised | sim: `a_remake_decided_late` | | 82 | Two remakes of one epoch are both decided | The one with the higher number holds; a node that got to the other moves by itself, and what was signed only there is signed again | 7 | sim: `two_remakes_one_epoch` | | 83 | A thief's statements are in the base of a remake | They stand: a remake makes final. The vote's days are the time to cut the key off | not promised | unit: `a_cut_reaches_to_the_snapshot` | | 84 | Tells a node that was away of an epoch that isn't the swarm's | The node rejoins no epoch that peers advertise: it finishes the old one from archives and builds the next itself, or takes the ID its operator gave | 1 | sim: `away_over_a_remake`, `back_by_an_id` | | 85 | A node back after several remakes offers what its user signed epochs ago | Refuse: an envelope is taken in its epoch and the next. Quarantined, for the user to sign again | 3 | unit: `carried_over_one_epoch_only` | | 86 | A version builds another snapshot from a remake's base | Its node records another ID. The remake is decided for the ID two thirds got; the node stays, and says so | 7 | sim: `a_remake_by_its_result` | | 87 | A remake names its proposer the only root, or leaves a root out; the root left out signs on as one | The voters see whom a remake names before they vote for it. A root is one in the epoch that names it: what it signs after is an ordinary user's, and it is out unless someone vouches for it | 7 | unit: `roots_are_the_remakes`, `a_root_for_its_epoch` | | 88 | Two thirds of the voters turn on the rest | They remake, name the roots and who votes, set any number (a share of the voters that lets one decide for all), change the policy, give a user's first keys to another, deal with the names of a user that is out, and say whose a contested name is: a name taken, in the open. They forge no signature and move nobody to other rules; the rest ban, refuse, or fork | not promised | argued (Going apart, Refusing a decision) | | 89 | Offers a statement signed on the other side of a fork | Refuse: it names its epoch | 3 | unit: `signed_for_its_user_id_and_epoch` | | 90 | A fork naming its proposer the only voter and root | A node follows only by its operator's word, which names the proposal; what that says shows | 7 | sim: `a_fork_by_choice` | | 91 | A decision breaks a node's bounds: the voters let one of them decide for all | The node refuses it and moves to the epoch built without it, the same for every node that refuses, with what it held: they go on together | 7 | unit: `bounds_on_the_numbers`; sim: `those_who_refuse_meet` | | 92 | Says it refuses a decision, or hands out the ID of an epoch without it, to draw nodes there | A node goes there by its own bounds or its operator's word only | 1 | unit: `refusing_is_ones_own` | Nodes and syncing: | # | The adversary | Honest nodes | Promise | Shown by | |---|---|---|---|---| | 93 | Sends different changes to different peers, each under its own number | Take all: changes made at once | 2 | sim: `two_histories_merge` | | 94 | Forks its node's actor | The nodes that took each split; one offered both holds proof and refuses the node; a side drops by its operator's choice | not promised | sim: `a_forked_actor_is_proven`, `a_side_drops_a_fork` | | 95 | Holds changes back, or passes on some | They come by other nodes; a joiner caught up with it syncs on | 6 | sim: `withheld_changes_arrive` | | 96 | Places its nodes around a victim by choosing their keys | The victim's node keeps its seeds and its user's other nodes as neighbours; a claim not settled for long shows. It costs time, not names | 5, 6 | sim: `around_a_victim` | | 97 | Hands a joining node another root, or changes from before the policy | Refuse the handshake; there is no before | 1 | sim: `a_joiner_takes_its_root_only` | | 98 | Signs a token for any user with its node's key | Taken only by a node whose operator named the signing node | 3 | unit: `a_token_of_ones_party` | | 99 | Logs in on another party's node with a key of the registry; has a name in the registry that the node's own users have | A node lets in by key the users it carries for and those its operator names; its own names are its own | 3 | unit: `login_by_key_is_the_operators` | | 100 | Lies in its member entry (ready, reached, stable); publishes a short window there to make every node stamp hourly; writes an entry of any size | Sync and trees bend; nothing gets in that way. How often nodes stamp is the policy's; an entry has a shape and a size, or the change is refused | 6 | unit: `an_entry_has_a_shape`, `stamps_by_the_policy`; argued (Reaching the others) | | 101 | Sends envelopes that don't check, without end | Refuse each (a signature costs about 30 µs to check *(docs)*); the node is refused as a whole after the first of its own | 6 | sim: `a_refused_node_costs_little` | | 102 | Writes its own member entry without end; fills the waiting changes; sends changes that say they saw little, each to be judged far back | Take them no faster than a budget per party: put off, never refused; a share of the waiting each | 6 | sim: `a_party_past_its_budget_waits` | | 103 | Crafts a change Automerge won't take, or that writes in an object nowhere to be found | Refuse *(checked: the rules refuse the second today)*; only the message that brought it fails | 1 | unit: `a_change_writing_nowhere` | Rules, and the swarm as it is: | # | The adversary | Honest nodes | Promise | Shown by | |---|---|---|---|---| | 104 | A rule differs between versions (a bug) | Each side refuses what the other takes, or their stamps name two digests for the same changes: each logs and shows it. A node that finds itself apart from a third of the voters' nodes at its first start with a version writes nothing. One side upgrades and drops | not promised | sim: `a_side_drops_and_comes_back`, `two_digests_one_history`; unit: `a_node_checks_itself` | | 105 | Stamps a wrong digest, to keep the nodes that upgrade from writing | A node stops only where it differs from the nodes of a third of the voters; from fewer it shows it and goes on | 6 | unit: `one_wrong_digest_stops_nobody` | | 106 | A policy version a node doesn't know: in the root, or decided | It doesn't sync, and takes no such proposal up: a policy is decided only with two thirds of the voters' nodes knowing it | 1 | unit: `no_sync_under_an_unknown_policy`, `an_unknown_policy_isnt_taken_up` | | 107 | A root that lies and isn't left out; a user nobody unvouches | The parties ban it from a cut on and read on without it | not promised | unit: `a_ban_for_those_who_follow` | | 108 | A banned user's name claimed by one who bans it | The node refuses its own user's write: the others would | 1 | unit: `no_write_by_ones_bans_alone` | | 109 | A partition, for any length of time | A side decides only with nodes of two thirds of all the voters on it. Where a third of them have nodes and votes on both sides, both may: every node then acts on the higher number, and of two remakes ends up in the one that holds | 7 | sim: `one_side_decides`; unit: `the_last_holds` | | 110 | None: a swarm that isn't federated | Everything as today | Optional | the existing tests, untouched; `bench_screening` | ## The registry on it ``` _continuum/users/tv/ statements about and by tv _continuum/claims/ip4/10.243.0.7/ tv's claim of 10.243.0.7 _continuum/claims/name/r/ a root's claim of the top-level domain r tv/hosts/toaster envelope: {"nets": {"retiolum": { "ip4": "10.243.0.7", "ip6": "42:0:…", "aliases": ["toaster.tv.r"], "ed25519": "…" }}} ``` The kinds are those shown under Claims, each name written as the hosts use it, in lower case. `toaster.tv.r` is kept for tv by the kind's rule and needs no claim; tv claims it all the same if it wants it through a change of the rules. A name that is no user's, right below the top-level domain (`wiki.r`), is the voters' to give: a proposal names it and a user, and decided, that user holds it. An IPv6 address is generated from the net, the user's name and the host's today; a kind `ip6` with the separator `:`, first come, first served like `ip4`, holds whether or not anyone generates honestly, for addresses written out in full. The export reads an address or a name only in the one spelling it writes. **Moving in.** The root is made from the repository by a script (`scripts/kartei-import`): the kinds and their rules; the maintainers as the roots and the first voters, with their keys and nodes; and for each namespace of the repository a user without keys, its hosts as they are, plain, and their addresses as claims in its name. The root is trusted as it is (every party is given its hash), so what it holds counts without signatures: a host from the root counts until its user signs over it, and a claim from the root is its user's. A root gives each user its first keys as it comes; from then on the user signs its own, and votes from the next remake that names it. A namespace whose user never comes stays as the root has it. What to weigh, moving in. With one maintainer as the only root and voter, that one settles every claim, decides alone, and sees alone what a third of the voters see, until a remake names others: more than one from the start is better, and a first remake once the users that take part are there. A user that comes later is created by one root, who takes that back alone; another's vouch makes it stand without that root's word. The limits in the genesis policy: 64 keys, 64 nodes and 256 addresses a user for a start. The import may set keys and addresses to twice the most any user has in the repository; a decision changes them after. **Writing out.** `scripts/kartei-export` reads the resolved registry from a node its operator trusts (its own) and writes the tree the consumers read (`/hosts//retiolum/{aliases,ip4,ip6,ed25519.key}`), leaving out what doesn't count and any address or name its host's user doesn't hold. Run on each change of the document (the store's stream), it replaces the merge button. Whoever writes out follows someone's bans (its own user's, unless it says otherwise), so two parties that ban differently write different files where a name is contested. Readers that are to see the same follow the same users: the roots, for the files the network at large reads. ## Stages Each leaves the system working, and is a few patches with its tests, which leave their vectors. At every stage the existing tests pass untouched (110). 1. **A federated swarm's frame.** `--genesis-policy` (a file, written into the genesis change with the roots, the voters and the users it starts with); a federated node is given its root, syncs under no policy it doesn't know, takes no remake yet, takes tokens and logins by key as its operator says, keeps ended sessions to itself, stamps as the policy says, and writes a member entry of the policy's shape and size. What the genesis change sets for the swarm as a whole is read from the policy. Tests: 97 to 100, 106, 110, and the policy's existing tests under a policy from the root. 2. **Statements.** The users' registers (`create`, `key`, `node`, `vouch`, `release`); the user ID, the epoch and what its signer saw in an envelope; nodes carrying for users by their own word, and the rule for committers by it; nothing plain; the limits, and the order past them. Resolving, step 2 without cuts, and `GET /registry/users`. The client signs statements. Tests: 1 to 8, 11, 12, 14, 26. 3. **Namespaces.** The rule, with `userSigned` below a name. Tests: 25, 27. From here the registry runs with users and hosts, names not yet unique. 4. **Claims in sight.** Kinds, names as they are written, their characters, rules by their structure, kept names and claims of them, limits, `claim` and `release`, judged as written; resolving step 4 for claims in sight, and what comes back. Tests: 13, 29, 32 to 34. 5. **Out of sight.** Late, contested and settled, for names and for users' names; a claim's side; a root's node writing when a claim reaches it, and a node that comes back catching up first. The voters as the root change names them; lengths of time read from the stamps; final. `GET /registry/claims` with what makes a claim late; values marked in `GET /store`. A node keeps its seeds and its user's other nodes as neighbours, and shows a claim long unsettled. Tests: 9, 10, 28, 30, 31, 35 to 38, 41, 42, 93, 95, 96. 6. **Cuts.** `retire` and the keys above, a node that stops, a cut never reaching its own statement, what a cut takes back, what doesn't count left out, the value before read again, the client listing what stopped counting. Tests: 39, 40, 43 to 49, 51 to 53. 7. **Unvouching.** `unvouch`, a user giving itself up, one that another vouched for staying, those brought in going with it, the names of a user that is out waiting, gone, nothing taken from an unvouched user's nodes, what comes back with a vouch. Tests: 15, 17 to 24. 8. **Coming back.** The drop an operator asks for, a forked actor proven and shown with what the roots' nodes hold, the budget and the share per party. Tests: 94, 101 to 103. 9. **Bans** for those who follow. Tests: 107, 108. 10. **The registry.** Import, export, and a federated swarm of the simulations with the registry's kinds and a few hundred hosts. From here it can be tried: users, hosts, names, a root that settles, names that become final. It isn't to be relied on yet. The stages after change the rules, and until a policy changes by a decision a rule changes only by every party upgrading at once: a swarm started here is started anew after the last stage, by an import of what it holds. 11. **Decisions.** `propose` and `vote` taken from any node, the nodes' records and how they are judged, taking up, decided, the decision that holds, what hangs; `GET /registry/decisions`. What is decided: a number, a user's first keys, the names of a user that is out, whose a contested name is, a name the rules leave to the voters. The simulations start from a root change naming several voters, as a remake's does. Tests: 16, 50, 54, 57 to 63, 65 to 72, 109. 12. **Versions.** The digest with every stamp, a node checking itself before it writes; for every swarm, a node that speaks the wire version before its own, and a handshake that says which epochs its node keeps. Tests: 104, 105. 13. **Remakes.** The proposal with who votes and who the roots are; the coordinator and the base, taking a remake up by its result, the snapshot every node builds, what it leaves out and what can't be written again; carrying over, by every node and in order; decisions and what was seen for long, over a remake; two remakes of one epoch; what becomes final. A node keeping the epochs it left on disk, peers answering for them and saying which; a node walking them, or rejoining by an ID its operator gave, and by none that peers advertise. Tests: 55, 56, 75 to 87. 14. **The policy by a decision.** The policy as a matter, a node that doesn't know it, what it no longer covers: shown aside, taken away by its user only, dropped after a time, moved at a remake. Tests: 73, 74, 106. 15. **Going apart, and refusing.** A fork followed by an operator's word, with who votes and who the roots are on its side. Refusing a decision: a node's bounds, the epoch without the decision, what a node takes along. Tests: 64, 88 to 92. From here it can be relied on: the rules change by decisions. ## What was checked, and what is assumed Checked in the code: * A change is judged at its dependencies, or at heads that hold the same for what rules read, before it is applied; a refused change keeps out what builds on it; a member whose own change broke a rule is refused as a whole (`access::rules`, `access::screen`). * What screening takes as read by rules is a list: members, users, remakes, votes, access and bans (`screen::relevant`). * An envelope is checked for its swarm, path, `prev`, signature, and its user's key in the registry as the writer saw it (`access::envelope::check`). * The genesis node writes the users it starts with and their keys, the swarm ID, and what holds for the swarm as a whole (neighbours, topology, dissemination) in its first change (`swarm::bootstrap`, `document::meta`), so the policy can be written with them. * A node writes anything below its own member entry (`access::rules`); readers bound what they take of it, not what is stored (`swarm::members`); a snapshot copies every entry there is (`remake::snapshot`). A shape and a size are new. * A member's entry holds its alive stamp as Unix milliseconds. It is renewed every seventh of the shortest window any member publishes in its entry, an hour at least, which is daily by default (`swarm::members`). A renewal overwrites the stamp, so two stamps of one node are two changes, found in the history; nothing reads them so today. * A drop exists and does what coming back needs (`AppState::drop_taken`); what is new is an operator asking for one its own rules wouldn't make. * Neighbours are computed from the member list by key hashes (`swarm::topology`); a member that answers from another epoch isn't left out of them. * A second change at an actor's number is refused as forged, by whoever brought it (`document::signatures`, `access::screen`). Keeping both as proof is new. * A message of another wire version is ignored whole (`transport::wire`). * A node keeps the documents of the epochs it left in memory (`remake::local`). Keeping them on disk is new. * A snapshot records the highest number per actor in its base, by which a node tells what it holds beyond it (`remake::snapshot`, `remake::delta`). The digests of the base's statements do that for a federated one. Checked upstream, in Automerge 0.12: a second change at an actor's number is refused, with the whole batch it came in (`DuplicateSeqNumber`); the change that made an operation is found (`hash_for_opid`), so the change carrying a value is found from the document. From the docs: a node under an unknown policy receives without judging; every node takes a token any member signed, and lets in by key any user of the registry; where a refused member shows; the cost of checking a signature; a node keeps the documents of epochs it left for a while (`archiveRetention`: 2 epochs, 30 days), and every node builds a remake's snapshot itself today; a node that was away rejoins the epoch enough ready members advertise, and has its own writes carried over within the replay window, the rest quarantined; a member votes for one remake of its epoch at a time, and a compaction's base is fixed by the coordinator when it commits. Assumed, to be shown as it is built: * Whether a change is in the history of a cut, of what a statement says its signer saw, or of a witness's change, can be answered cheaply enough: per actor, the last number within that history, kept per cut and per claim that has a rival. Statements and rivals are few. * Resolving kept as the node goes costs little per change. Judging a change that says it saw little reads far back: the registers there, who was gone there, which decisions were decided there (`document::at`), more than an envelope's check reads today. Whoever makes others do that pays from its party's budget. * Whether a claim stood in a witness's history is kept as the node goes, for the claims that have a rival. * Writing a quarantined statement again as it is works after a drop wherever what it builds on still holds. * A node can keep neighbours beside those the member list gives (its seeds, its user's other nodes), and leave out members of another epoch. * A limit counted at a change's dependencies (a kind's claims by one user) is read fast enough from the register; an index kept beside it otherwise. * Who lost a user name as a change's history shows it (judging, 6 and 7) is worked out only where a name has several creations there, which is rare. * The snapshot of a federated remake, built from the resolved registry, comes out byte for byte the same on every node, as today's does from the document. * A node can keep on disk, and answer sync for, an epoch it left. * A node can write again what it holds beyond a base before it takes anything from a peer, in changes ordered as the claims' order asks, at a registry's size. * What was seen for long is kept as the node goes, per voter's node and per thing watched (a user out, a claim holding its name, a thing uncovered), costs little, and is built again from the changes at a start. * The digest of the registry as it resolves is cheap enough to make with every stamp at a registry's size, and to make at another node's stamp now and then. * A version can speak the wire version before its own.