# Users and what they may do Who the users are, and what each may do, is the swarm's: a registry in the document, the same on every node. How a user proves who it is stays each node's: its `--htpasswd`, or a reverse proxy naming the user (`--user-header`, [`trust.md`](trust.md)). ## The registry `_continuum/users/`, one entry per user. It is protocol data: every member holds it, a remake's snapshot carries it into the next epoch, and it holds no secrets (no password hashes: every member reads the document). ```json { "since": 1762400000000, "by": "continuum:3f…", "caps": { "8c41e2…": { "path": [], "rights": ["read", "write"], "by": "continuum:3f…", "since": 1762400000000 } }, "disabled": false } ``` * **Names** are what `--htpasswd` and the proxy give: 1 to 64 of `A-Z a-z 0-9 . _ @ -`. * **Capabilities** (`caps`): each a path, as segments as the store's API takes them, and the rights it gives there and below: `read`, `write`. A capability covers its path segment by segment (`servers/eu` covers `servers/eu/0`, not `servers/europe`). One outside protocol data never covers protocol data: `[]` is all of the swarm's data, `["_continuum"]` protocol data, managing users included (`_continuum/users`). They are kept by a random ID, so two capabilities granted at once both hold, and revoking one removes it alone. Each names who granted it (`by`: a user as `user:`, or the node that recorded it) and when (`since`). * **`disabled`**: the entry stays (who wrote what stays readable), and gives nothing. An entry that doesn't read as above gives less, never more: a capability that doesn't read is left out, and anything but `false` disables. ## A new swarm A swarm gets a registry from its start if its genesis node is given its first users, `--bootstrap-users`: it records them, with the swarm ID, in its first change, each with everything (`[]` and `["_continuum"]`). Other users, of its `--htpasswd` or any node's, may do nothing until added (the genesis node warns of those of its `--htpasswd`). Without it, the swarm has no registry: its users are all alike (A swarm without a registry, below), until someone gives it one. `--protocol-writers` counts in both: without a registry, as who may write protocol data; with one, to set it right should nobody be left who may manage users (Keeping the swarm manageable, below). ## At the HTTP API Every request is checked against the registry, as the node serving it holds it: a change to it counts on a node as soon as it has reached it. * **The store** (`/store`, `/stream`): writing a path (`PUT`, `POST`, `DELETE`) takes `write` on it; `?prune=true` deletes maps left empty only up to the highest one the user may write. Reading takes `read`: of a place the user may read only partly, it sees the keys on the way to what it may read, as a directory one may pass through but not list (a capability on `servers/eu` shows `servers` with `eu` alone in it), and nothing else; a list on the way is left out whole, as its items have no paths of their own. Native forms (`text/plain` of a map, a counter as its own type) only of what it may read whole. What a write answers with is what was written. A stream shows what the user could read when it opened. * **Protocol data** is in the store too, under `_continuum`: `read` and `write` on it as on any path. * **Looking at the node** (`/admin/stats`, `GET /peers`, the dashboard): any user with a capability. The dashboard's document box is read through the store, as the user may; the page is told only of changes where its user may read. * **Remakes** (`/admin/remakes`): `read` on `_continuum/remakes` to look, `write` to propose or abort one. **Forgetting a peer** (`DELETE /peers/…`): `write` on `_continuum/forgotten`. * **Everything else an operator does** (`/admin/config`, `/admin/log`, `/admin/document`, `/admin/changes`, `/admin/epochs`, `/admin/quarantine`, `/debug`): `read` on `_continuum` to look, `write` on it to act. A user the node lets in but the registry doesn't have may do nothing (`403`). `[]` and `["_continuum"]` are two capabilities on purpose: protocol data acts on the whole swarm (its members, its remakes, its users), so it is given apart, never by accident with the data. A user who may do both has both. ## Managing users Through `/admin/users` ([`openapi.yaml`](openapi.yaml), Users): looking needs `read` on `_continuum/users`, changing `write` on it. Each change is one change to the document, logged and named by who made it. `POST /admin/users` adds several at once (below). ```sh curl -u alice http://localhost:3000/admin/users # who, and what each may do curl -u alice -X POST -H 'Content-Type: application/json' \ --data '{"caps": [{"path": ["servers", "eu"], "rights": ["read"]}]}' \ http://localhost:3000/admin/users/bob # add bob, reading servers/eu curl -u alice -X POST -H 'Content-Type: application/json' \ --data '{"path": [], "rights": ["read", "write"]}' \ http://localhost:3000/admin/users/bob/caps # grant: answers its ID curl -u alice -X DELETE http://localhost:3000/admin/users/bob/caps/ID # revoke it curl -u alice -X PUT -H 'Content-Type: application/json' --data true \ http://localhost:3000/admin/users/bob/disabled # disable bob ``` Disabling a user keeps who wrote what readable; removing it (`DELETE`) doesn't. The registry is protocol data in the store too, so a user who may write `_continuum/users` may also edit its entries there directly; the same checks apply. ## A swarm without a registry In a swarm whose document has no registry (`_continuum/users`), started without `--bootstrap-users`, every user a node lets in may read and write the swarm's data and use the admin endpoints, and only those in `--protocol-writers` write protocol data. It gets a registry once a protocol writer adds its users: ```sh curl -u alice -X POST -H 'Content-Type: application/json' --data '{ "alice": {"caps": [{"path": [], "rights": ["read", "write"]}, {"path": ["_continuum"], "rights": ["read", "write"]}]}, "bob": {"caps": [{"path": [], "rights": ["read", "write"]}]} }' http://localhost:3000/admin/users ``` From that change on, every node serves only the users the registry has, so the caller must be among them, with `write` on `_continuum` (else `409`): list every node's users first. ## Keeping the swarm manageable A user may not lock itself out: a write that would keep its writer from managing users (enabled, with `write` on `_continuum/users`) when it could, deleting, disabling or narrowing its own entry, is refused (`409`), and nothing of it is written; so is one that would remove the registry (`_continuum/users`). Others are not kept from removing the last user who may manage users: each node can only judge what it holds, and two such writes on two nodes at once would leave nobody once they merge anyway. Then, while nobody may manage users, the users in a node's `--protocol-writers` may do everything there again, to set it right.