Public Access
jaap-jan
69bc9e270b
An invitation decided access from an assertion about an address. Everything else
in this model decides it from something a person did — an admin naming an
account, a key holder wrapping a vault key to a key they verified — and this was
the one place a token's email claim was the thing that let somebody in.
It was guarded as tightly as that can be guarded: the claim was refused outright
on an unverified or absent `email_verified`, with no setting to relax it. But the
guard and the risk were the same shape. The whole defence was one boolean sent by
a system the deployment does not control.
So `POST /teams/{id}/members` is the only way in, and an address with no account
is refused with `no-such-account` — which is now the end of the road rather than
the signal to invite. Both clients say the remedy: that person signs in here
once, which is what creates the account, and then they can be added. The desktop
leaves the address in the box, because a message telling you to come back later
is one you act on later.
Gone with it: the `team_invitation` table, the claim hook in the sign-in path,
and `Oidc:EmailVerifiedClaim`, which that hook was the only reader of. Nothing in
the server now reads the email claim to decide anything.
Pending invitations are dropped rather than converted. Converting one would mean
creating a membership because an address matched, which is the property being
removed — and an invitation to an address that did have an account here had
already been claimed by the hourly sweep, so what is left is offers to people who
never arrived.
Two tests carry the property rather than the feature: the endpoint inventory
asserts the three routes are absent, and the API suite adds an address that has
no account, watches the refusal, then signs that address in and checks it joined
nothing. Without the second half, a server that merely renamed the deferred path
would pass.
505 lines
61 KiB
Markdown
505 lines
61 KiB
Markdown
# What the design asked for and this build has not got
|
||
|
||
The Avalonia client's interface was rebuilt from a Claude Design project — a five-screen spec covering
|
||
the chrome, hosts and terminals, file transfer, the vault, teams, and preferences.
|
||
|
||
> ## The second import — v2, phone
|
||
>
|
||
> A later design in the same project, **DodoSSH Android v2**, is what the phone head now draws: eight
|
||
> screens, a bottom bar with the rest behind a hub, and a new palette. It has been imported, and
|
||
> this section is the same accounting for it. The desktop's own v2 has **not** been imported — only its
|
||
> palette, because the palette is shared and the two heads may not disagree about a colour.
|
||
>
|
||
> **The bar is three rather than the design's four, and the hub is SETTINGS rather than MORE.** The design
|
||
> puts Hosts, Terminal, Keychain and More along the bottom. The keychain moved behind the hub: a bottom bar
|
||
> is for the places a session moves between, and keys, credentials and tags are managed occasionally and
|
||
> then left alone, which is the shape of everything already behind it. With the keychain on it the hub is no
|
||
> longer "more" of anything — it is where everything that is not connecting to a machine lives — so it takes
|
||
> the name and the glyph that has meant exactly that on a phone since before this application existed.
|
||
> Terminal became **Connections** in the same pass, for a reason below.
|
||
>
|
||
> **The palette went from green to blue, and one colour changed meaning rather than value.** Green used to
|
||
> be the accent, so `Ellipse.dot.live` filled with `Accent` and "the thing to press" and "a shell is open
|
||
> here" were the same colour by construction. v2 makes the accent `#5B8CFF` and keeps a green, `#3DDC97`,
|
||
> for status alone. That is now `Live`, and nothing merely interactive may use it. The accent is also two
|
||
> colours — `Accent` fills, `AccentText` writes — which is what stops a row of chips reading as a row of
|
||
> primary actions.
|
||
>
|
||
> **Five destinations moved under MORE and four of them were built**: snippets, SFTP, S3 and logs, each
|
||
> over a view model that already existed, plus preferences. `ShellScreen` gained `More` and `Buckets`;
|
||
> SFTP and S3 are one screen over one `TransfersViewModel`, differing only in which picker they offer.
|
||
>
|
||
> **A sixth is behind MORE that v2 never drew: VAULTS.** It is the reverse case — a shipped screen the
|
||
> design had no slot for — and it is on the phone because a vault arrives without being asked for.
|
||
> Somebody wraps its key to you from their machine, and the person it arrives for is at least as likely to
|
||
> be holding a phone as sitting at a desktop; a vault the server has just put somebody in, visible only on
|
||
> a head they may not have installed, is a membership they cannot see. It runs over the same view model
|
||
> the desktop screen drives, like the other four.
|
||
>
|
||
> | v2 element | What ships instead |
|
||
> | --- | --- |
|
||
> | The **FORWARDING** screen: local/remote/dynamic rules, toggles, bytes transferred | **Nothing, said out loud.** `ISshConnection` offers `OpenShellAsync` and nothing else, so there is no tunnel for a rule to run through; `SyncEntityType.PortForward = 9` is still reserved and still unused. The MORE screen carries a paragraph naming the absence, for the reason the desktop keeps VAULTS in its rail. |
|
||
> | `23 ms · fwd 5432` on the terminal's connection line | ◆ **The line is gone, and what was real on it moved.** There was never an RTT to draw — SSH.NET measures none — and nothing forwards anything, so what shipped was the account and endpoint actually dialled. In v3 a connected phone draws one 35-pixel bar and then the terminal, so a second 36-pixel row naming the machine is exactly the chrome that surface exists to give back: the address is on the connecting card, where it is read before anything has answered, and the shell's own prompt says it afterwards. The two text-size buttons that shared the line are pinned at the end of the accessory row, outside its scroller, which is what the line was protecting them from. |
|
||
> | `ED25519` badge and `SHA256:kQ9f…Zw2M` on every keychain card | `Detail`, which is what is genuinely known *about* an item. Unchanged from the first import: no algorithm field, no fingerprint, and computing either means parsing armour the type stores verbatim. |
|
||
> | An `agent` chip on a key | Omitted. There is no agent of any kind — see the first import's Vault section. |
|
||
> | Snippet cards footed with `edge-eu-1 · today 10:58 · exit 0` | The command and its badge. Nothing records where a snippet ran, when, or what it returned; the shell it is typed into never reports back. |
|
||
> | Logs: a blinking **FOLLOW** pill over a live `tail` | A REFRESH button. These are the keychain's own synced audit records, written once at close and read when the screen opens — there is nothing to tail. |
|
||
> | Logs: `ALL 8 / INFO 5 / WARN 2 / ERROR 1` and per-host chips | The real two-way choice: connections, or keychain activity. A connection record is not a syslog line and carries no level, and neither log filters by host. |
|
||
> | SFTP: the `LOCAL / REMOTE` toggle | One remote pane. Scoped storage means there is no browsable local filesystem, which `docs/android-port.md` decided before any of this was built. |
|
||
> | SFTP: the transfer card, and moving files at all | ◆ **Both directions ship, and neither is the button the design drew.** There is no local pane for an UPLOAD arrow to point away from, so the gestures are the platform's two pickers: ADD FILES is `ACTION_OPEN_DOCUMENT` — "point at a document wherever it lives" — and SAVE FILE is `ACTION_CREATE_DOCUMENT`, asked *before* the transfer because a picker raised on completion arrives over whatever the person moved on to, and often while the app is backgrounded and Android will not show one. Both stage through the cache, for the same reason: a `content://` URI has no path, no trustworthy length and no promised seek, and the queue needs all three to resume. `QueueDownloads` — the desktop's path, writing into `LocalPath` — is unused here, because `LocalPath` on Android is the app's own private directory. The queue is drawn now, since this head can fill it. |
|
||
> | S3: `96 objects · 412 GB` and `lifecycle: IA after 7d` | Omitted. Neither a bucket total nor a lifecycle policy is fetched; the listing is what `IRemoteFileStore` returns. |
|
||
> | A `+` floating button on **HOSTS** | **Shipped in v3.** It was omitted twice, on the grounds that it would open a host editor this head had not got — and that was true until one existed. It raises a sheet rather than a form, because "add" on this screen is two operations: a host, or a group to file hosts under. |
|
||
> | A 14px rounded inset around the terminal | Not drawn. The renderer is a native child view composited above everything Avalonia draws, so a rounded frame behind it clips nothing. What the design was after comes from the page's own background, which is the design's `#171A26`. |
|
||
> | Instrument Sans / Fira Code | Inter and the system monospace stack, as before and for the same reason — see the note on `MonoFont` in `Palette.axaml`. |
|
||
> | A theme toggle (`☀`) in the header, and the desktop v2's light theme | Omitted. There is one theme by decision, and a switch with one position is a control that does nothing. |
|
||
> | Nothing at all on a group beyond its heading | ◆ **A menu on the heading, which is the second thing on this list the design had no slot for.** The desktop puts Edit, Move to another vault and Delete on the group's own card; this head draws no group cards and has no right-click, so the `⋯` raises the add sheet's shape with the same three entries in the same order — Move above the rule because it is not a deletion, Delete below it. Open is the one entry it does not carry: the desktop's grid holds one level of the tree and this list holds all of it flattened, so there is nowhere to open a group *into*. It was a pencil alone while Edit was the only thing behind it. |
|
||
> | Nothing that removes a host | ◆ **DELETE, on a row of its own under EDIT and MOVE.** A phone has no hover and no tooltip, so where a thumb lands is the only thing separating a destructive button from an ordinary one — full width in the danger colour, below both, is the same arrangement KEYCHAIN uses. The counted question takes the bar's controls in place rather than stacking over them, which is what stops DELETE being pressed a second time under its own confirmation. Until v3 this head could fill a keychain and never empty one. |
|
||
> | PREFERENCES, which v2 draws as a list of settings | ◆ **One setting, one fact, and a paragraph of absences.** The setting is whether this phone may unlock with a fingerprint — see the screen. The fact is the running version, which matters more here than on the desktop: there it sits beside a CHECK NOW that will say whether it is current, and this head does not replace itself at all. What it says instead is where a newer one comes from, which is ADR 0011 rule 2 in plain words — never from the server you sign in to. |
|
||
> | TERMINAL's empty state: a sentence saying nothing is open | ◆ **More than the design asked for, which is rare enough on this list to say out loud.** The tab is called **Connections** and with nothing running the screen is where one is made: a box taking `user@host` or `user@host:port` with a password, and the machines most recently connected to underneath it, read from the vault's own connection log. The box is the only path in the product to a machine that is not in the keychain — the design assumes every connection starts from a saved host, and the case it has no answer for is an address somebody was handed five minutes ago. Nothing typed there is saved, and the screen says so. |
|
||
>
|
||
> ## The desktop's v2
|
||
>
|
||
> **DodoSSH v2** — the desktop design in the same project — has since been imported too, dark only. Its
|
||
> light theme is not built: the light accent is `#6D5AE6`, a different hue rather than a tint, so it needs
|
||
> every colour doubled, a theme variant to switch on, the renderer's page switching with it, and contrast
|
||
> checked twice. That is a piece of work, not a setting, and it is separable from the layout.
|
||
>
|
||
> **The window's minimum grew, and by exactly what v2 added.** The 54-pixel icon rail became a 190-pixel
|
||
> labelled sidebar and the chrome went from 72 tall to 86, so `880x560` became `1016x574` — leaving every
|
||
> screen the same `826x464` it was designed against. Four of the tables stop fitting at 690 wide, so
|
||
> widening the sidebar without widening the window would have broken them where the layout suite was not
|
||
> looking.
|
||
>
|
||
> **Buckets became a destination** rather than a toggle inside the files screen, matching the phone: the
|
||
> `HOST` / `BUCKET` pair is gone and `ShellScreen.Buckets` draws the same `TransfersScreen` with the other
|
||
> picker. That also settled an old disagreement — `TotalItemCount` excluded buckets and disagreed with the
|
||
> list under it. It counts every kind now, tags included.
|
||
>
|
||
> | v2 element | What ships instead |
|
||
> | --- | --- |
|
||
> | The **FORWARDING** screen, the `⇄ N forwards` chip on the session strip, and the host detail's FORWARDING card | Nothing, as on the phone and for the same reason. Three surfaces for a feature the SSH layer does not have. |
|
||
> | The host detail's 2×2 card grid — IDENTITY fingerprint, TAGS, LAST SESSION | Not drawn as a grid. There is no fingerprint on a stored key and no last-used timestamp at any layer, so two of the three cards have nothing behind them. Tags are real and are drawn — as chips on the row and a picker in the editor, which is where they are used rather than in a card beside two empty ones. |
|
||
> | The keychain detail's public-key block, USED BY hosts, and **Rotate** | The detail pane as it stands. Copy public key is real and already there; rotation is not a thing this client can do. |
|
||
> | Logs: **FOLLOW**, the severity chips, and `tailing via ssh · journald + files` | The two logs it really has. Same as the phone — these are synced audit records, not a tail, and the footer sentence describes a feature rather than the screen. |
|
||
> | Snippets: **RUNS ON** host tags and a last-run line | The command and the two buttons that name the terminal they type into. |
|
||
> | The session footer: latency, forwards, `utf-8 · xterm-256color` | Omitted. The first two have no source; the third is a constant, and a constant printed as though it were a reading is decoration. |
|
||
> | The terminal as an inset rounded panel | Not drawn, for the reason the phone does not draw it: it is a native child window that composites above everything Avalonia paints, so a rounded frame behind it clips nothing. |
|
||
> | **Split ⌘D** | Still omitted — the renderer stacks panes and shows one; tiling needs a pane geometry it has not got. |
|
||
> | macOS traffic lights, and `⌘K` | The window's own minimise/maximise/close, and `CTRL K`. Development is Windows-first and the chrome is `BorderOnly` for a documented reason. |
|
||
> | No status bar | Kept, and cut down to the one thing the titlebar does not now carry: `Vault.Status`, which is the only channel this application has for saying a save failed or a merge picked a winner. The design is a mock-up of a working afternoon and has nowhere to put a sentence like that. |
|
||
> | The sidebar's five destinations, and a **Team vault** card at its foot | Seven destinations, because Pins, Vaults and Preferences are built screens and dropping their entry would strand them — and two fewer than v2 shipped with, because SFTP and S3 became tabs; see v3 below. The card is not drawn: it is a second route to a screen already in the list, carrying a seat count nothing here produces. |
|
||
>
|
||
> ## The desktop's v3
|
||
>
|
||
> A third pass, and the smallest of the three: it moves furniture rather than adding screens. Nothing in it
|
||
> needed a layer below `client-app`, which is why it has no table of its own — there was nothing to omit.
|
||
>
|
||
> **The tab strip became the window's, not the terminal's.** Three fixed tabs sit at its head — Vaults,
|
||
> SFTP, S3 — and terminal tabs follow them. SFTP and S3 left the nav rail to get there, which is the one
|
||
> semantic change: they are the two destinations you *stay in* while something runs, and a rail entry is
|
||
> for somewhere you go and come back from. The rail is drawn under Vaults alone, so SFTP, S3 and a terminal
|
||
> each get the full window width instead of `826`. See `MainWindowViewModel.IsVaultsTab` for why the tab is
|
||
> a page test rather than a fourth `ShellSurface`.
|
||
>
|
||
> **The hosts screen became a grid of cards** — groups above, hosts below — and the 268-pixel host sidebar
|
||
> went with it. That column was choosing among forty machines *and* editing one of them at two-thirds
|
||
> width; the grid took the first job at full width and a 304-pixel right-hand drawer took the second. The
|
||
> drawer collapses when nothing is selected, which is most of the time. Pressing a group card selects it;
|
||
> double-pressing one opens it, and a breadcrumb trail above the cards is where you are and the way back —
|
||
> the same trail the transfers screen draws over a directory.
|
||
>
|
||
> **And the grid holds one level of that trail rather than every host.** A host filed under a group is drawn
|
||
> inside that group and not also on the screen the group's card sits on, which is what makes a card a place
|
||
> instead of a label: while the level above held everything anyway, opening a group could only ever subtract.
|
||
> The find box is the one thing that crosses a boundary — it searches the open group and everything under it,
|
||
> so a machine can be found without first remembering where it was filed, and the chip on a card is what says
|
||
> which group a result came out of. See `VaultViewModel.Matches`.
|
||
>
|
||
> **The type scale went up a point and the text ramp went white.** `#E3E7F4` was a blue-tinted white on
|
||
> blue-black surfaces, which costs contrast twice — once for being darker than white and once for sharing
|
||
> a hue with what it is drawn on. Every step of the ramp moved with the top, so the intervals the design
|
||
> chose are kept. Both are in the shared palette, so the phone has them too.
|
||
>
|
||
> | v3 element | What ships instead |
|
||
> | --- | --- |
|
||
> | The hosts toolbar's view-mode switch (grid / list / table) | One view. A switch between three layouts where only one is built is two disabled buttons. |
|
||
> | The hosts toolbar's tag filter, calendar and share control | Omitted. There are no saved filters, nothing in a vault carries a date, and sharing outside a team vault does not exist. Tags are real and are searched by being read off the cards. |
|
||
> | **Serial** beside **Terminal** in the toolbar | Omitted. Every session here is an SSH channel; a serial transport is not a button, it is a second session kind. |
|
||
> | The strip's tabs inside the titlebar row, with a hamburger | A row of its own under the titlebar. The titlebar already carries the drag region, the search box, the sync light and three window controls, and the strip scrolls — putting both on one 44-pixel row would make the thing that scrolls fight the thing that drags. |
|
||
> | A count on the S3 tab | Omitted. The rail entry it replaces carried one; a number on two of five tabs reads as a fact about those two rather than as the tab's own state, and a terminal tab has nothing to count. The count is on the S3 screen. |
|
||
>
|
||
> ## The desktop's v4 — the host detail pane
|
||
>
|
||
> A fourth pass, narrower than v3: one pane and the cards beside it. It changes the *shape* of the drawer
|
||
> rather than what is in it, and it changes one behaviour that is not cosmetic at all.
|
||
>
|
||
> **The drawer is asked for now.** Selecting a host used to open it, which charged 304 pixels of grid for
|
||
> the act of choosing — including every card arrowed past on the way to the one you wanted. A pencil appears
|
||
> on a card under the pointer, and on the selected card, and that is what opens the pane;
|
||
> `VaultViewModel.IsHostPaneOpen` is the flag, and the context menu has a **Details…** entry so the pane is
|
||
> reachable without a pointer. Once open the pane follows the selection, because a pane about one host
|
||
> beside a grid marking a different one is two answers to the same question.
|
||
>
|
||
> **The pane is three cards, a fixed header and a fixed footer.** Address, General, Connection — the same
|
||
> three in the detail pane and in the host editor, the first as rows and the second as boxes. Only the
|
||
> middle scrolls, so the button each panel exists to offer is never below the fold, which CONNECT could be
|
||
> on a host with fifteen tags. The detail pane's rows are *buttons that open the editor*: the design draws
|
||
> every fact as a filled box, and rather than draw an input that refuses the pointer, pressing one leads to
|
||
> the same card with a real box in it. Saving is a whole-host operation — it validates the key-or-credential
|
||
> exclusion and writes one encrypted payload — so a box committing per keystroke was never on offer.
|
||
>
|
||
> **A host card is two lines and no chips.** The subtitle is `ssh, root, pci, eu-west-1`: the transport, the
|
||
> resolved account, then every tag. It replaces the `user@host:port` line *and* the wrapped row of tag chips
|
||
> below it. The address moved to the card's tooltip rather than nowhere — a card is read while scanning
|
||
> forty machines, where the name and the kind of machine are what is being looked for, and an address is
|
||
> what you read once you have found it.
|
||
>
|
||
> | v4 element | What ships instead |
|
||
> | --- | --- |
|
||
> | **Share this host** | Omitted, as the vault screen's `SHARED WITH · 6` is. A grant is per *vault* and per-item sharing is M5; a button here would imply this one host could be handed over, which is the thing the architecture does not do. |
|
||
> | **Add Telnet**, and **Serial** in the toolbar | Omitted. `ISshConnection` is the only transport there is. This is also why the card subtitle's `ssh` is a constant today rather than a reading — it is stated in `HostRowViewModel.Summary`, which is the one place in this interface where a constant is printed on purpose. |
|
||
> | **+ SSH ID, Certificate, FIDO2** | Omitted. `IDENTITIES` and `CERTIFICATES` have been on this document's list since the first import — neither is even a reserved `SyncEntityType` — and there is no security-key path anywhere in the SSH layer. One control offering three item types that do not exist. |
|
||
> | The **Backspace / Default** row | Omitted. It is a terminal setting, and the client has no preferences store and no frame to carry one to the renderer — see the Preferences section. It would be a control whose value could not survive the window closing. |
|
||
> | The **chevron beside the vault name** | The name alone, and the move behind the pane's ⋯ menu instead. A host *can* now be moved between vaults, so the gap is no longer that there is nothing to offer — it is that a chevron on a subtitle implies an edit, and this is not one: the two vaults are encrypted under different keys, so it is a re-seal into one and a tombstone in the other, the host takes a new id, and its group and tags stay behind. A control that implied "just change this field" would be describing something else. Where a *new* host goes is still asked in the host editor, as a picker beside the name. A group moves too, from its card's right-click menu, and takes its nested groups and every host filed under them; keys, passwords and buckets take theirs from the keychain screen's standing picker and cannot be moved yet. |
|
||
> | **Show more ⌄** | Not drawn as a disclosure. What it would hide — notes, the relay switch, forgetting the host key — is in the editor, one press away, and a second fold inside a pane that already scrolls is a second place for a field to be missing from. |
|
||
> | **Port Forwarding** in the sidebar | Nothing, for the third time in this document. |
|
||
> | The host grid's toolbar avatar, share and tag-filter controls | Omitted, as in v3 and for the same reasons. |
|
||
|
||
Most of it landed. This file is the rest: every element of that design with nothing behind it, which
|
||
project each piece would have to land in, and **what the shipped interface does instead**. That last
|
||
column is the important one. This codebase states its limits rather than implying them — the README does
|
||
it for revocation, for relay session recording and for what locking does not do — so nothing here was
|
||
rendered with invented data to make a screenshot look finished. Where a feature does not exist, the
|
||
interface either omits it or says so.
|
||
|
||
Read alongside [the milestone plan](../README.md#milestones). Most of what follows is not a defect; it is
|
||
M2 and M3 arriving in a design before it arrives in the code.
|
||
|
||
## The shape of the problem
|
||
|
||
Three facts explain nearly every row below.
|
||
|
||
**An SSH connection here opens exactly one channel.** `ISshConnection` offers `OpenShellAsync` and nothing
|
||
else (`src/DodoSSH.Client.Ssh/SshConnection.cs`). No port forwarding, no ProxyJump. That one fact removes
|
||
the `FORWARDS` chip, the status bar's port list, and every `via bastion-eu` in the design.
|
||
|
||
It used to remove the file-transfer screen too. M2 did not lift the restriction — it worked around it:
|
||
file transfer is a *separate connection* rather than a second channel, because SSH.NET's `SftpClient` owns
|
||
its own transport. See [File transfer](#file-transfer-the-designs-sftp-screen), which is the one place in
|
||
this document where what shipped differs from what the row predicted.
|
||
|
||
**~~Teams are schema and nothing else.~~ Built in M3.** The `team` and `team_membership` tables were there
|
||
from the first migration with nothing reading them, and `VaultAccessService.ResolveAsync` denied every vault
|
||
that was not the caller's own. Both changed in M3 and neither needed a migration, which is what carrying two
|
||
unused tables bought. See [Vaults](#vaults). What has *not* changed is the split underneath: the server
|
||
decides what it will serve, and only a client can decide who can read it — so "shared with" is two facts on
|
||
this screen, not one.
|
||
|
||
One table was added and then dropped again, and the round trip is worth a line. An invitation named an
|
||
**address**, and `team_membership.user_id` is not nullable and carries a foreign key, so somebody who has
|
||
never signed in had nothing for that row to point at — which is why `MembershipStatus.Invited` has been
|
||
reserved since the first migration and has never once been written. `team_invitation` existed for that one
|
||
reason and is gone: membership is granted only to an account that exists, so there is no longer a shape the
|
||
reservation fails to cover. The status stays reserved, because the column holds it in nobody's database and
|
||
a client must not fail on a value a later server might send. See [ADR 0009](adr/0009-team-access-model.md).
|
||
|
||
**The client has no preferences store.** It writes exactly two files — `cache.db` and `device.key` — and the
|
||
cache has six tables, none of them settings. Nothing on the design's TERMINAL preferences panel can be
|
||
saved, and there is no frame on the terminal data plane that would carry a change to the renderer anyway.
|
||
|
||
**Three things the design did not ask for and this build now has.** A key can be generated in the client
|
||
rather than pasted in (`SshKeyGenerator`, and the `openssh-key-v1` container is written by hand — see
|
||
`OpenSshKeyWriter` for why there was no alternative and why it is written unencrypted). Hosts can be
|
||
imported from `~/.ssh/config` (`DodoSSH.Client.Import`; it reads no key material, and `ProxyJump` is
|
||
recorded as intent because the SSH layer still has no jump hosts). And the file-transfer screen takes drag
|
||
and drop in four directions — remote to Explorer is the one that does not ship, because it needs a virtual
|
||
file the platform layer cannot supply; see `docs/manual-checks.md`.
|
||
|
||
**The rail has six destinations, not five.** The design gives host keys no slot at all. They were a fourth
|
||
category on the keychain screen for a while and are now a screen of their own, `KnownHostsScreen`, because
|
||
the other categories are things somebody creates and edits and a pin is a decision recorded at the moment
|
||
of connecting — and because comparing an untruncated fingerprint against a published one needs a column
|
||
layout the shared table could not give it.
|
||
|
||
**The product surface says "keychain" and everything under it says "vault", deliberately.** The nav rail,
|
||
the unlock and enrollment copy, and every sentence a user reads now call the encrypted store a keychain.
|
||
The wire does not: the route is `/api/v1/vaults/{vaultId}`, the tables are `vault` and `vault_key_grant`,
|
||
the CLR types are `VaultViewModel` and `VaultSession`, and `docs/crypto.md` — which is normative — says
|
||
"vault key". Renaming those would break every deployed client, need a table-rename migration, and put
|
||
`CryptoSpec.AadResourceType.Vault = 3` inside the blast radius of a find-and-replace, where changing it
|
||
would make every item in every vault permanently unreadable. So the split is the answer rather than a
|
||
stage on the way to one: read "vault" in this repository as the name of the cryptographic object, and
|
||
"keychain" as what the product calls it.
|
||
|
||
One thing cuts the other way and is worth knowing before planning any of this: **the wire protocol already
|
||
reserves the slots**. `SyncEntityType` (`src/DodoSSH.Contracts/SyncEntityType.cs`) has `HostGroup = 4`,
|
||
`Tag = 5`, `HostTag = 6`, `HostCredential = 7`, `Snippet = 8` and `PortForward = 9` — reserved, unused, and
|
||
already covered by the AAD resource-type table. Groups, tags and snippets are new item types on an existing
|
||
protocol rather than a protocol change.
|
||
|
||
Two of those slots are now taken. `HostGroup` and `Snippet` shipped as full item kinds — a table, an EF
|
||
configuration, a server kind that refuses every plaintext field, a codec, a merge, a cipher and a repository
|
||
— and neither needed a contract change, which is what the reservation bought. `Tag = 5` has since shipped the
|
||
same way, for the same cost, and is the clearest case the reservation ever paid for: a whole item kind, a
|
||
table, a migration and an AAD arm, with `PublicAPI.Unshipped.txt` untouched.
|
||
|
||
`HostTag`, `HostCredential` and `PortForward` are still reserved and still unused — and `HostTag` is now
|
||
reserved *against a decision* rather than pending one. Which hosts wear a tag is a set of ids inside each
|
||
host's payload, not a join: the one thing a join buys over that is two machines tagging the same host
|
||
without either losing, and the client's per-key three-way merge already gives it. A second item type would
|
||
be a second table and a second pass through every rule in this file, for nothing.
|
||
|
||
**A third was added for something the design never mentioned**: `ObjectStore = 13`, an S3-compatible bucket
|
||
and the keys that reach it. It is a keychain item like any other — the endpoint and the secret access key are
|
||
both inside the payload, and the server refuses every plaintext field including the endpoint, because for
|
||
everybody self-hosting that is an address on their own network.
|
||
|
||
What made it cheap is that the transfer queue never needed anything SSH-specific: `IRemoteFileStore` was
|
||
lifted out of `ISftpSession` with only the host key left behind, and a bucket is the same contract with a
|
||
different implementation. Three things a bucket genuinely cannot do are refused with a reason rather than
|
||
approximated — there are no directories (only keys with slashes in them, and a marker object for an empty
|
||
one), no resumable upload (an object cannot be written from the middle), and no atomic rename (a copy and a
|
||
delete). Downloads *do* resume, because a ranged GET is part of the protocol.
|
||
|
||
**Two members were added rather than claimed**: `ConnectionLogEntry = 11` and `ActivityLogEntry = 12`, the
|
||
first additions to `SyncEntityType` since it was frozen. Logs are synced items rather than local files
|
||
because they are audit records — an administrator has to be able to read a shared vault's history once teams
|
||
land, and a log kept only on the machine that produced it can be neither read nor trusted by anybody else.
|
||
ADR 0001 records what that costs in metadata; it is not free and it is not hidden.
|
||
|
||
Three properties are worth knowing before touching them. An entry is **written once, at close** and never
|
||
updated, which is what lets a synced log avoid a merge entirely. Neither kind is **audited**, which is the
|
||
guard that stops the activity log producing an entry for every entry it writes. And both are **excluded from
|
||
the pending-change count and from what a background sync announces** — those numbers answer "how much of my
|
||
work is not yet safe", and a log entry is not somebody's work.
|
||
|
||
**One plaintext field was taken away rather than used.** `SyncPlaintextFields.GroupId` has existed since the
|
||
contract was frozen and `host.group_id` since the first migration; no client ever wrote either. Group
|
||
membership is inside the encrypted payload instead, the column is dropped, and the server now refuses the
|
||
field with a reason — because what it would have handed the operator is a clustering of every user's estate,
|
||
and ADR 0004's test for a plaintext concession is that the server *cannot function* without it. The wire
|
||
field cannot be removed and stays as a permanently refused member; `SyncEndpointTests` holds the refusal.
|
||
|
||
---
|
||
|
||
## Chrome — titlebar, nav rail, status bar
|
||
|
||
| Design element | Layer | What it would take | What ships instead |
|
||
| --- | --- | --- | --- |
|
||
| Org chip `dodotech / platform` | contracts + server | An *organisation* above teams, which does not exist — `VaultSummary.TeamId` is no longer always null since M3, but a team is not an org and there is exactly one tenant per deployment. | The vault's own name, and the account this machine is enrolled as. Team names are on the VAULTS screen, where they are about something. |
|
||
| `SYNCED` dot, always green | client-app | Nothing — the design's claim is simply unconditional. | Green **only** when a connection is held, the last sync pass actually reached the server, and the outbox is empty; otherwise `UNREACHABLE`, the count of changes still waiting, or `OFFLINE`. Holding an `IVaultServer` proves a sign-in once succeeded and nothing more, so a laptop whose lid has been shut all afternoon still has one — reachability comes from the outcome of the last pass. A permanently green light is the same as no light. |
|
||
| `VAULT SYNCED 11:02` | client-session | `StoredSyncState.LastPulledAt`/`LastPushedAt` are persisted, but `VaultSession` exposes the store as `internal`. A property away. | Omitted. The one honest sync fact — the outbox depth — is in the titlebar and the status bar. |
|
||
| `⌘K` command palette running commands | client-domain | A snippet or saved-command item type (`SyncEntityType.Snippet = 8` is reserved). | Ctrl+K opens a real host search that connects on Enter. The box says "search hosts", not "search hosts · run command". |
|
||
| Status bar `· via bastion-eu` | client-ssh | Jump-host execution. See below. | Omitted. |
|
||
| Status bar port forwards | client-ssh | Port forwarding. See below. | Omitted. |
|
||
| Status bar `sftp · 2 transfers` | client-app | Nothing now — file transfer is built. What is missing is the count reaching the status bar, which is a screen away from where the queue lives. | Omitted from the status bar. The queue itself is on the FILES screen, with a row per transfer. |
|
||
| Status bar `locks in 09:41` | client-app | An idle auto-lock. See preferences below. | Omitted. |
|
||
| IBM Plex Mono / IBM Plex Sans | ui | Shipping the font files as `AvaloniaResource` and registering them. The design loads them from Google Fonts, which a desktop app cannot. | Inter (already embedded) for prose, and the system monospace stack the terminal already names. Named once in `App.axaml` as `MonoFont`, so the substitution is reversible in one place. |
|
||
| `⌘K`, `⌥↵` | ui | Nothing; the design is Mac-flavoured. | `CTRL K`. Development is Windows-only today (`docs/platform-flags.md`). |
|
||
|
||
**Also worth knowing:** custom chrome went in as `SystemDecorations="BorderOnly"`, not by extending the
|
||
client area. `ExtendClientAreaChromeHints` was removed in Avalonia 12, so extending leaves the system
|
||
caption buttons and window title drawn on top of the application's own — two sets of window controls, and
|
||
"DodoSSH" printed twice. Measured, not assumed.
|
||
|
||
---
|
||
|
||
## Hosts + terminal
|
||
|
||
| Design element | Layer | What it would take | What ships instead |
|
||
| --- | --- | --- | --- |
|
||
| Tag chips (`nginx`, `eu`, `pg16`) | client-domain | A tag item type, and a way to put one on a host. | **Shipped.** `Tag = 5` is a live item kind and `HostSecret.TagIds` names them, merged per tag so two people tagging one host both keep theirs — which is what `HostTag = 6` was going to buy, so it stays reserved and unused. Chips are drawn on host rows on both heads and toggled in the host editor, which also creates one inline; renaming and deleting are a TAGS category on the keychain screen. The filter box still searches name, address and notes only — a chip is read rather than typed. |
|
||
| Groups `PRODUCTION` / `STAGING` / `PERSONAL` | client-domain | A host-group item type (`HostGroup = 4`, reserved) or a group field on `HostSecret`. | **Shipped**, as both: `VaultHostGroup` is a synced item kind and `HostSecret.GroupId` names one. A group carries a `ParentId` and the defaults its hosts inherit, and the two heads draw the nesting differently on purpose. The desktop is a grid of cards holding one level at a time, the way a directory pane holds one directory; the phone has no room for a row of cards, so it flattens the whole tree into one heading per group in label order with no indentation. A keychain with no groups renders exactly as it did before on both — one flat list, no headings and no cards. |
|
||
| Group badge `TEAM·PLATFORM` | server | **Built in M3.** | The vault's name on each row, and the personal vault ordered first. Not the team's name: two of a team's vaults would then carry the same badge and the badge would be naming the wrong thing. Distinct from the groups above, and deliberately so — a group is a shelf the user chose, a vault is who can read the item. |
|
||
| Groups on a **team's** hosts | client-domain | A vault id on each group row for rename and delete, and a way to tell two vaults' identically-named groups apart in a list with one heading per group. | **Shipped, and it is what makes a shared vault an arrangement rather than a heap.** Both halves are paid for: the row carries the vault it came out of, so rename and delete go back to it, and the vault's name is drawn beside the group's on the desktop's cards and the phone's headings wherever the session holds more than one — which is what lets two `production` groups sit side by side. The group editor asks which vault a new group goes into, on the terms the host editor's picker set: while adding only, hidden at one writable vault, and never offered afterwards, because the two are encrypted under different keys. The parent picker is that vault's alone, for the reason the host editor's group picker is — a parent in another vault is a level half the key holders cannot resolve. Dragging a host card onto a group card in another vault is refused with the reason, rather than filing it under an id nobody in its own vault can read. The resolution map stays wider than the list and still spans hidden vaults: a group lends a port, a username and a binding, so a host whose group went unread would silently dial 22 as nobody while the machine is on 2222 as `deploy`. |
|
||
| Per-host status dot, three colours | client-ssh | The amber state would mean "reachable but not connected", and nothing here ever probes a host. | Two states, both real: green when a terminal is open on that host, grey when not. |
|
||
| `· ⤷ bastion-eu` in the host subtitle | client-ssh | **Jump hosts are data-only.** `HostSecret.JumpHostIds` is a `JumpChain` that is stored, encrypted, synced and three-way merged — and nothing reads it at connect time. `SshConnectionRequest` carries one host. | Omitted. The stored chain is preserved untouched by every edit. |
|
||
| `SPLIT ⌘D` and side-by-side panes | client-ssh + ui | The renderer stacks panes and shows one (`terminal.css`: `.pane { position:absolute; inset:0; display:none }`). Tiling needs a real pane geometry and a splitter. | Omitted. Tabs ship instead, over the same one-WebView multiplexing. |
|
||
| `⇄ FORWARDS · 2` | client-ssh | Port forwarding. `SyncEntityType.PortForward = 9` is reserved; nothing in the SSH layer forwards anything. | Omitted. |
|
||
| `SNIPPETS` panel, `↵` to run | client-domain | A snippet item type (`Snippet = 8`, reserved). | **Shipped**, as a screen rather than a panel. `↵` is per snippet and off by default: inserting types the command at the prompt and stops, because nothing here can tell whether the terminal is at a prompt at all. |
|
||
| Broadcast to all panes (`⌥↵`) | client-ssh | Input is routed strictly by session id in `TerminalDataPlane.Dispatch`; there is no fan-out. Needs splits first. | Omitted. |
|
||
| Pane header `24ms` | client-ssh | Round-trip measurement. SSH.NET offers no RTT API. | Omitted. |
|
||
| Pane header `aes256-gcm` | client-ssh | **The closest miss on this list.** `SshNetConnection` holds the `SshClient`, so `ConnectionInfo.CurrentServerEncryption` is right there — it just is not on `ISshConnection` or surfaced by `TerminalWorkspace`. | Omitted; the tab strip shows the account and endpoint actually dialled. |
|
||
| Pane header showing the running command and `following` | client-ssh | The host moves opaque bytes and never parses terminal output. Would need shell integration (OSC 133) on the remote. | Omitted. |
|
||
| A `local · zsh` tab | client-ssh | Every session here is an SSH channel. Needs ConPTY and a second session kind. | Omitted. |
|
||
| Tab strip `+` button | ui | Not missing so much as redundant: the real operation is *select a host, press Connect*, which the hosts grid already is. | **Shipped**, as the palette rather than a menu: it opens what Ctrl+K opens, so the strip and the shortcut are one way of doing one thing. A `MenuFlyout` offering "SSH" and "local shell" is the nicer answer and is not verifiably safe above the terminal's native child window — and there is no local shell to offer. |
|
||
| Terminal font size (`--termfs`, 11–16px) | client-storage | See preferences. | Fixed at the renderer's 13px. |
|
||
|
||
---
|
||
|
||
## File transfer (the design's SFTP screen)
|
||
|
||
**Built in M2.** The screen ships: two directory panes, a breadcrumb trail on each, and a queue that moves
|
||
one file at a time with progress, throughput and resume. What follows is what it does *not* do, and one
|
||
thing this document got wrong before it was built.
|
||
|
||
**The correction.** The row below used to say an SFTP subsystem channel on `ISshConnection` was what it
|
||
would take. SSH.NET does not offer that: `SftpClient` derives from `BaseClient` and owns its own transport,
|
||
and there is no supported way to hand it a session an `SshClient` already has. So the transfers screen
|
||
**opens a second authenticated connection** to the host rather than a second channel on the terminal's. That
|
||
is visible to a user — the host records a second login, and a host whose password is typed each time asks
|
||
for it again on this screen — so it is named for what it is: `ISftpSessionFactory.OpenSftpAsync` is a
|
||
connect, and it goes through the same host key gate, the same pin and the same two refusals a shell does.
|
||
|
||
| Design element | Layer | What ships |
|
||
| --- | --- | --- |
|
||
| SFTP itself | client-ssh | `ISftpSession` over SSH.NET's `SftpClient`: listing, stat, offset-based read and write, mkdir, delete and rename. Delete is deliberately **not** recursive. |
|
||
| Remote listing with `NAME/SIZE/MODIFIED/PERMS` | client-ssh | All four. `PosixMode` renders `drwxr-xr-x` from the bits SFTP hands over; setuid, setgid and sticky are not shown, because SSH.NET does not surface them and `rwx` where `rws` is true would be worse than nothing. |
|
||
| Local listing | client-transfer | `LocalDirectory`, which is where this client's `System.IO` now lives. `PERMS` is blank on the local side rather than filled with a plausible-looking POSIX mode that is not a fact about a file on Windows. |
|
||
| Transfer queue, progress, throughput | client-transfer | `FileTransferQueue`. One transfer at a time, so the rate on a row is the rate of the link rather than a share of it. Throughput is measured over a half-second window, not averaged since the start. |
|
||
| `resume supported` | client-transfer | **Within a run of the application.** Every transfer writes to a `.dodossh-part` file beside its destination and is renamed into place at the end, so an interrupted one can never be mistaken for a finished one, and `RESUME` carries on from the part file's own length. A part file found at startup is *not* resumed: nothing records what wrote it, and resuming on the strength of a name matching is how a corrupt artefact gets delivered with nothing reporting a failure. Making it survive a restart needs the preferences store this client has not got — see below. |
|
||
|
||
| Design element | Layer | What it would take | What ships instead |
|
||
| --- | --- | --- | --- |
|
||
| Per-host last directory | client-storage | Somewhere to persist two panes' navigation state. There is still no settings table. | The remote pane opens on the account's home directory, which the server canonicalises during the handshake; the local pane opens on the user profile. |
|
||
| `sftp over bastion-eu` | client-ssh | Jump hosts, as above. `HostSecret.JumpHostIds` is still stored, synced, merged and read by nothing. | Omitted. |
|
||
| Overwriting a file that is already there | ui | A prompt, which means a modal this window has no idiom for. | Refused, with the name that is in the way. The remote pane has DELETE and MKDIR so the refusal is not a dead end. |
|
||
| Dragging between the panes | ui | Drag-and-drop between two `ListBox`es, plus a drop target that is a directory rather than a row. | Two arrow buttons between the panes, pointing at the pane the file is going to. |
|
||
| Transferring a directory | client-transfer | Recursive enumeration on both sides, and a policy for what a partial directory means. | One file at a time. A directory cannot be selected as a transfer source. |
|
||
|
||
**Not to be reached for:** `CreditWindow` is a 256 KiB flow-control window for terminal output, not a
|
||
transfer primitive. The queue does its own 64 KiB copy loop and shares nothing with the terminal data plane.
|
||
|
||
---
|
||
|
||
## Keychain — the design's Vault screen
|
||
|
||
The screen ships and is real: four categories over the vault's four item types, one table, a detail pane,
|
||
and both editors. It is called the Keychain in both heads, which is what the rail has always labelled it;
|
||
the section below keeps the design's word only where it quotes the design. What follows is what the design
|
||
drew around them.
|
||
|
||
| Design element | Layer | What it would take | What ships instead |
|
||
| --- | --- | --- | --- |
|
||
| `ACCESS` column and `your access → CONNECT-ONLY` | server | Per-item ACLs. `EncryptedPayload.DataKeyId` is documented as the seam for per-item grants **in M5**. `VaultSummary` does carry an opaque `int Permissions`, but nothing gives the bits a meaning on the wire — `PermissionFlags` itself lives in `DodoSSH.Domain` — and those are per *vault*, never per item. There is no `ConnectOnly` role in `TeamRole` at all. | Omitted. The column shows sync state instead — whether a change is still sitting in this machine's outbox — which the design had no column for. |
|
||
| `SHARED WITH · 6` avatars | server | **Built in M3**, minus the avatars — no picture is stored anywhere. `GET /api/v1/vaults/{id}/grants` lists who holds a key. | The list lives on the VAULTS screen, beside the members it is about, rather than as a count on an item row: a grant is per *vault*, and putting a number on an item would imply per-item sharing, which is M5. |
|
||
| "Private key never leaves the vault. Sessions sign through the team agent (dodod)" | client-ssh | **Both sentences are false here, and the second cannot be made true by this architecture.** There is no agent of any kind, and the connect path decrypts the private key and hands the bytes to SSH.NET. | Omitted. The key editor already says what is true: the key and its passphrase are encrypted here and never reach the server in a readable form. |
|
||
| Scope rail: `PERSONAL` / `TEAM · PLATFORM` / `TEAM · DATA` | server | **Built in M3.** `VaultAccessService.ListAsync` resolves team membership, so a session can hold several vaults. | Not a rail, because it would be a selector with nothing to select: every list on the screen already spans every vault this session can read. What replaces it is a picker for where a *new* item is filed, which is the only vault question with an answer. |
|
||
| `SCOPE` column | server | **Built in M3.** Scope is a property of a vault, never of an item, and that has not changed. | Each row names the vault it is in, and rows are grouped by vault. |
|
||
| `LAST` column (`11:02`, `1d ago`) | contracts | No last-used timestamp at any layer. `VaultItem<TSecret>` is `(id, secret, version, three sync flags)`. | Omitted. |
|
||
| `FINGERPRINT` for SSH keys | client-domain | `SshKeySecret` has no fingerprint field, and computing one means parsing key formats the type deliberately stores verbatim. | The `DETAIL` column carries what *is* known — whether a passphrase and a public half are stored. Pins show their real fingerprint, in full and untruncated. |
|
||
| `•••• rotated jul 14` for passwords | client-domain | `CredentialSecret` has no rotation date or password age. | The account the password is for. |
|
||
| `IDENTITIES` category | contracts | A new item type, not even reserved in `SyncEntityType`. | Omitted. |
|
||
| `CERTIFICATES` category, `expires 2026-09-01` | contracts | Same ladder, plus certificate parsing. | Omitted. |
|
||
| `18 items · 12 shared` | server | The sharing stack. | `N items · N not synced`, counted over the rows on screen. |
|
||
| `added by anna@dodotech.dev` | contracts | The server records `CreatedByUserId`, but `SyncChange` carries no actor field and no other user's name is fetchable. | Omitted, and the detail pane says in one line that items record no author, no timestamps and no sharing. |
|
||
| `created 2026-03-14` | client-sync | Recoverable in principle — entity ids are UUIDv7 and carry a timestamp — but nothing surfaces it. | Omitted. |
|
||
| `TEST CONNECT` | ui | Connecting is host-scoped, not credential-scoped: there is nothing to test a credential *against* without a host. | Omitted. |
|
||
| `REVOKE` | server | **Built in M3**, as WITHDRAW KEY on the VAULTS screen — because there are now grants to revoke, and a grant is what it acts on. ADR 0001 constrains how it is presented, and it is: the message says it blocks future reads only, and that what they already hold is unaffected. | On this screen, still Delete, named for what it does. Deleting an item and withdrawing somebody's key remain different acts. |
|
||
| `SSH KEY · ED25519` | client-domain | No algorithm field, and deriving it means parsing the armour. | The type without the algorithm. |
|
||
| One `+ ADD CREDENTIAL` button | ui | — | Two buttons, one per kind that can be added. "Credential" is a specific item type in this codebase (a username and a password), so using it as an umbrella word would collide with the vocabulary. |
|
||
| — | — | — | **`HOST KEYS` is the reverse case:** a fully-backed, shipped category the design had no slot for. It is in the rail. |
|
||
|
||
---
|
||
|
||
## Vaults
|
||
|
||
**Built in M3, and reshaped since.** The screen ships: a vault list, a members table with a real
|
||
last-active column, who holds a key, and the two buttons the whole design was really about — add somebody,
|
||
and share a vault key. A vault can also be renamed and handed to another member.
|
||
|
||
**It lists vaults where it used to list teams, and that is the reshaping.** A team is still what the server
|
||
authorises against; what went is the requirement that anybody make one. Naming a vault makes the membership
|
||
list that carries it, named after the vault and owned by its creator, so the thing people came to share is
|
||
the thing they create. The team resurfaces in exactly one place and is not hidden there: a membership list
|
||
carrying several vaults — which this screen cannot produce — says so, because adding somebody to one of
|
||
those vaults adds them to all of them. Archiving is gone with the team list: a vault cannot be deleted at
|
||
all, the server refuses to archive a membership list while its vault exists, so the screen says so rather
|
||
than offering a button that always refuses.
|
||
|
||
What follows is what it still does not do, and one thing this document got wrong before it was built.
|
||
|
||
**The correction.** The rows below used to describe a screen with nothing behind it, on the grounds that
|
||
`VaultAccessService.ResolveAsync` denied every vault that was not the caller's own. That is now the one
|
||
place that changed, exactly as its remark predicted, and no migration was needed: `team`,
|
||
`team_membership`, `vault.team_id` and `vault_key_grant` have all been there since the first migration.
|
||
What the row did not anticipate is that the interesting half is not the endpoints at all. It is that
|
||
**membership and readability are different things**, and the screen is arranged around saying so.
|
||
|
||
**There is one way into a team, and that is the decision.** Adding a member takes a *user id* the caller
|
||
has already got from the directory, so that account must have signed in here at least once — and the
|
||
ordering is deliberate rather than incidental, because whoever adds a member is usually about to wrap a
|
||
vault key to the public key that lookup returned. An *address* is accepted too, and has to be: the
|
||
directory lists only accounts that have published a key, so everybody between a first sign-in and their
|
||
enrollment is invisible there and would otherwise be unaddable. What is refused is an address with no
|
||
account at all, under `no-such-account`, and that refusal is the end of the road — the remedy is that
|
||
person signing in once.
|
||
|
||
There was a second way in, and there is not any more. An invitation took an address, waited, and became a
|
||
membership the next time somebody signed in asserting it. It is gone because it was the one place in this
|
||
product where access followed from an identity provider's claim about an address rather than from somebody
|
||
naming an account. See [ADR 0009](adr/0009-team-access-model.md).
|
||
|
||
| Design element | Layer | What ships |
|
||
| --- | --- | --- |
|
||
| The team itself | server | `POST/GET /api/v1/teams`, plus members, roles and team vaults. Ids are client-chosen, so a create whose response was lost is safe to repeat. |
|
||
| Shared vaults | server + client | A team owns vaults; each is created with the creator's own grant, because a vault with no grant is a container nobody can open. |
|
||
| Roles | contracts + server | `TeamMemberRole` on the wire, numerically pinned to `DodoSSH.Domain.TeamRole` by a test. Viewer reads, Member writes, Admin and Owner also share and administer. |
|
||
| Members table | server | `TeamMemberSummary`, and a directory that resolves an exact email to a public key. |
|
||
| Sharing an item | client | `VaultSession.ShareVaultAsync`: verify the recipient's key against the key log, wrap, sign, record. The server stores the wrap and the signature and can check neither. One grant per generation the sharing client holds, so a recipient can read a rotated vault's history and not only what happens next. |
|
||
| Adding a member shares the team's vaults | client | Adding somebody wraps every team vault the adding machine can open to them, as part of the add rather than as a button to remember. Membership and a key are still two acts on two machines; the client just performs both. A vault this machine holds no key to is skipped and named. |
|
||
| Removing a member rotates the vaults | server + client | `POST /api/v1/vaults/{id}/rekey` advances the generation and records the caller's new grant in one transaction — the server contributes the moment and no cryptography. The client then wraps the new key to the members who remain. Grants for earlier generations are kept, or the vault's stored items would become unreadable to everybody. See [ADR 0010](adr/0010-vault-key-rotation.md). |
|
||
| Re-sealing a rotated vault's stored items | client | `VaultResealer`, the last step of a rotation: every item is opened and the same plaintext sealed again under the new key, in batches, against the version the server holds. The plaintext is never decoded, so an item written by a newer client crosses a rotation untouched. Resumable, because a vault at mixed generations is readable — a pass that stops half way leaves a working vault and is re-run. A change queued before the rotation is re-sealed by the push path instead, so nothing reaches the server under a superseded key at all. |
|
||
| Ownership transfer | server | `POST /api/v1/teams/{id}/owner`, owner only. One transaction: the named member becomes owner and the outgoing owner becomes an admin. Not two role changes — ownership is sole, so promoting first leaves the team owned twice and demoting first leaves it owned by nobody. The outgoing owner is demoted rather than removed, because removing them would revoke their vault key grants and rotate every team vault, which is a far larger act than the one being asked for. |
|
||
| `LAST ACTIVE` | server | Real, and coarse on purpose. `UserAccount.LastSeenAtUtc` is now refreshed on ordinary authenticated requests, at most once per account per hour: writing it per request would put an UPDATE on the hot path of every authenticated call and start losing races on `user_account`'s own concurrency token. So the column answers "this week or not", which is the granularity the question is actually asked at, and is shown coarsely rather than to the minute. |
|
||
| Renaming and archiving a team | server | `PUT` and `DELETE /api/v1/teams/{id}`. The slug is deliberately not renameable: it is unique only among *live* teams, so a rename could take a slug an archived team still holds and strand it. Archiving soft-deletes the team and every membership in one transaction — and is refused outright while the team owns any vault. |
|
||
|
||
| Design element | Layer | What it would take | What ships instead |
|
||
| --- | --- | --- | --- |
|
||
| `CONNECT-ONLY` role | — | Nothing that would be true. Connect is a user-interface hint, not a boundary: SSH terminates on the client, so a session needs the credential's plaintext on that machine. See ADR 0001. | Four roles, all of which are enforceable. `Connect` rides along with `Read` and is documented as a hint. |
|
||
| `2FA ENFORCED` and the per-member 2FA column | server | No two-factor concept exists anywhere — the only hit in the whole worktree is an aside in `docs/crypto.md`. | Omitted. The member columns carry what *is* known and matters: whether they have published a key a vault can be wrapped to, and when they were last here. |
|
||
| Avatars | server | No picture is stored anywhere. | Omitted; the row shows a name and an address. |
|
||
| Pending invites, the invitation mail, and **resend** | server | An outbound mail path this server has not got, and — the larger cost — a rule that turns an identity provider's claim about an address into team membership. | **Nothing pending exists, and the screen says why.** Only an account that already exists can be added; an address with no account is refused, naming the address and saying the person has to sign in here once. There was a `team_invitation` table doing the deferred version of this and it has been dropped. See [ADR 0009](adr/0009-team-access-model.md). |
|
||
| Archiving a team that owns vaults | — | Nothing that would be safe. A team vault resolves through membership, so archiving would take those vaults away from everybody holding a key, silently, including the caller — and nothing in this product deletes a vault, so there is no sequence of calls that turns the refusal into a success. | Refused, with `team-not-empty` and a count of the vaults in the way. A stated limit rather than a coming feature, for the reason the SFTP layer refuses a recursive delete: a refusal is visible and a quiet removal is not. |
|
||
| `SSO · OIDC · okta.dodotech.dev` | server | Per-team SSO. Authentication is one global JWT scheme bound to one authority. | Omitted. |
|
||
|
||
> **The trap this document warned about is still a trap.** `GET /api/v1/meta` advertises
|
||
> `features: ["teams"]` *unconditionally* (`MetaEndpoints.cs`). It was meaningless when nothing implemented
|
||
> teams and it is meaningless now that everything does — it has never been computed from anything. Do not
|
||
> gate a client feature on it.
|
||
|
||
---
|
||
|
||
## Preferences
|
||
|
||
The screen ships with what is real — this machine's device key, locking, syncing, and signing out — and
|
||
lists the rest as absent rather than omitting it silently.
|
||
|
||
> **Signing out is not on the design and is here anyway.** The design has no way to leave a machine, and
|
||
> without one there is no way to hand a laptop on, to enrol a second account, or to get past a forgotten
|
||
> passphrase — which is unrecoverable by construction, so the unlock screen would otherwise be a dead end.
|
||
> It empties the local cache and withdraws the device key from the account; it cannot end the session at the
|
||
> identity provider, and says so.
|
||
|
||
| Design element | Layer | What it would take |
|
||
| --- | --- | --- |
|
||
| Any preference, saved | client-storage | A seventh table in the client cache, or a preference item type in the vault. Which one matters: the vault syncs, so a preference stored there follows you between machines, and a terminal font size probably should not. |
|
||
| Terminal font, size, cursor style, cursor blink, scrollback | client-terminal | The store, **and** a frame to carry it. `TerminalServerOpcode` has four values (`Output`, `SessionOpened`, `SessionClosed`, `SessionActivated`) and none carries an option. |
|
||
| Font family picker offering IBM Plex Mono | ui | Shipping the font, as above. |
|
||
| Audible bell | client-terminal + ui | xterm.js 6 removed `bellStyle` and `bellSound`; what remains is an `onBell` event, so the page would have to make the sound itself. |
|
||
| `GENERAL` section | ui | There is no general setting to put in it. The theme is fixed by decision, and window size is not persisted. |
|
||
| `KEYS & AGENT` section | client-ssh | **There is no agent, at all** — no own agent, no forwarding, no Pageant or OpenSSH-agent interop. |
|
||
| `SYNC & VAULT` section | client-domain | Nothing here is adjustable. The auto-sync interval is a `private static readonly` with a remark arguing for its value. |
|
||
| `SECURITY & SSO` section | server | Per-team SSO, which is a refusal rather than a pending endpoint: authentication is one global JWT scheme bound to one authority, so there is no per-team policy for this screen to show. |
|
||
| `SHORTCUTS` section | ui | There is no keybinding infrastructure and no rebinding surface. |
|
||
| Auto-lock after idle | client-session | An activity source, a decision about what counts as idle, and — the hard part — a policy for a shell mid-job. `LockAsync`'s own remark already argues that an unattended timeout which killed a running job would be worse than the exposure it removed. |
|
||
| Require biometric to sign | crypto | Three separate falsehoods in one row. There is no signing service — the private key is decrypted and handed to SSH.NET whole, so there is no per-signature moment to interrupt; there are no connect-only keys; and per-use consent would need the key to live in the TPM, which is a different key hierarchy from the one in `docs/crypto.md`. |
|
||
| Pill toggle switches | ui | Purely presentational — `App.axaml` has no `ToggleSwitch` selector, so Fluent's default would appear un-themed beside the hairline chrome. |
|
||
|
||
---
|
||
|
||
## Two things the import changed on purpose
|
||
|
||
**Hosts left the vault column.** They have their own screen and the vault screen holds keys, passwords and
|
||
pinned host keys. This follows the design, and it is also the better split: the host list is what you look
|
||
at while you work, and the rest is what you go and manage. `VaultSection` lost its `Hosts` member and
|
||
gained `All`.
|
||
|
||
That screen was a 268-pixel sidebar beside the terminal when this paragraph was written, and v3 made it a
|
||
grid of cards with a drawer — see above. The split it describes did not change; only which half is wide.
|
||
|
||
**Tabs moved to the shell, not the vault.** Locking disposes the vault and deliberately leaves shells
|
||
running, so a tab list rebuilt per unlock would lose track of sessions that are still connected — the very
|
||
sessions the unlock screen already counts. `TerminalWorkspace` gained `SessionActivated` on the wire,
|
||
`IsSessionLive`, and a `SessionEnded` event so a tab can stop claiming to be connected.
|