Public Access
Compare commits
31
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3ccafdd53b | ||
|
|
22b4d82ba8 | ||
|
|
619f49a35a | ||
|
|
a6d3924e0d | ||
|
|
079914bfb4 | ||
|
|
6c09bdecb6 | ||
|
|
372a7cbdc7 | ||
|
|
a4b81da597 | ||
|
|
0e8fe4fc80 | ||
|
|
2ff9dff560 | ||
|
|
6846f67c20 | ||
|
|
f332d9a56f | ||
|
|
03c8e8589a | ||
|
|
4c7f47c026 | ||
|
|
412c314aec | ||
|
|
b08f2c58e3 | ||
|
|
ee423b25ce | ||
|
|
38ab9b431b | ||
|
|
07bd5c9886 | ||
|
|
31aca26e89 | ||
|
|
843713b118 | ||
|
|
9c7be8ae9b | ||
|
|
3d0a66f997 | ||
|
|
689ba6c1bf | ||
|
|
6e39807cc0 | ||
|
|
d7d002c972 | ||
|
|
c3dfa42108 | ||
|
|
a6a21decbd | ||
|
|
f05deb4fbc | ||
|
|
c8848ec1e3 | ||
|
|
ab432e475e |
No files matched your search
@@ -1326,6 +1326,19 @@ jobs:
|
||||
# inspects — it is the thing that gets deployed.
|
||||
needs: [build]
|
||||
runs-on: [linux]
|
||||
# Gitea's own container registry, on the forge this workflow runs on, under the same owner as
|
||||
# the repository - so the image is listed with the repository's packages rather than on a
|
||||
# registry of its own. Lowercase, because an image reference may not contain capitals and
|
||||
# the owner is DodoTech-Public.
|
||||
#
|
||||
# REGISTRY_USERNAME and REGISTRY_PASSWORD are a Gitea account and a token of its own with
|
||||
# package read and write, allowed to publish for that owner. Not the job's built-in
|
||||
# GITEA_TOKEN, tempting as it is here: the container registry does not accept an Actions
|
||||
# task token and answers `unauthorized` at /v2/ (go-gitea/gitea#23642). Spelunk's workflow
|
||||
# pushes the same way, with the same two secrets.
|
||||
env:
|
||||
REGISTRY: git.dodotech.cloud
|
||||
IMAGE: dodotech-public/dodossh-api
|
||||
steps:
|
||||
# Duplicated from the build job; see the comment there for why it cannot be factored
|
||||
# out. Any change here has to be made in all three.
|
||||
@@ -1451,9 +1464,6 @@ jobs:
|
||||
# changes, and where setup-buildx-action starts earning its place.
|
||||
- name: work out the tags
|
||||
id: tags
|
||||
env:
|
||||
REGISTRY: registry-docker.dodotech.cloud
|
||||
IMAGE: dodotech/dodossh-api
|
||||
run: |
|
||||
set -euo pipefail
|
||||
repo="$REGISTRY/$IMAGE"
|
||||
@@ -1578,7 +1588,7 @@ jobs:
|
||||
echo "username: ${#REGISTRY_USERNAME} characters; password: set"
|
||||
|
||||
printf '%s' "$REGISTRY_PASSWORD" \
|
||||
| docker login registry-docker.dodotech.cloud \
|
||||
| docker login "$REGISTRY" \
|
||||
--username "$REGISTRY_USERNAME" --password-stdin
|
||||
|
||||
- name: push
|
||||
@@ -1596,7 +1606,7 @@ jobs:
|
||||
# does not leave it behind.
|
||||
- name: log out
|
||||
if: always() && github.event_name != 'pull_request'
|
||||
run: docker logout registry-docker.dodotech.cloud
|
||||
run: docker logout "$REGISTRY"
|
||||
|
||||
# No job here publishes the desktop *release* channel, and there is not going to be one. The desktop
|
||||
# nightly job above publishes a different application — its own pack id, its own Velopack channel, its own
|
||||
|
||||
@@ -44,7 +44,7 @@ Three consequences worth knowing before you read further:
|
||||
The reasoning behind each major decision is recorded in [`docs/adr/`](docs/adr/), starting with
|
||||
[the E2EE trust model](docs/adr/0001-e2ee-trust-model.md).
|
||||
|
||||
The desktop client's interface was built from a design covering more product than exists yet — file
|
||||
The desktop client's interface was built from a design covering more product than existed at the time — file
|
||||
transfer, teams, saved snippets, port forwarding. Everything that design asked for and this build has not
|
||||
got is written down in [`docs/design-import-gaps.md`](docs/design-import-gaps.md), with the layer each
|
||||
piece would land in and what the interface shows in its place. Nothing was rendered with invented data to
|
||||
@@ -426,6 +426,90 @@ What is not here: transferring a directory, dragging between the panes, and rout
|
||||
bastion — the last needs jump hosts the connection layer has not got. All three are in
|
||||
[`docs/design-import-gaps.md`](docs/design-import-gaps.md).
|
||||
|
||||
### Forwarding ports
|
||||
|
||||
A host can carry **port forwards**, added under PORT FORWARDS in its editor, in the three kinds OpenSSH has:
|
||||
**local** (`-L`, a port here reaching a machine the remote can see), **remote** (`-R`, a port on the remote
|
||||
reaching back to one this machine can see) and **dynamic** (`-D`, a SOCKS proxy here whose connections leave
|
||||
from the remote). They are saved in the host's encrypted payload, so they sync, merge and are shared with the
|
||||
host, and they start with every terminal opened to it, on either head. The session sidebar lists them under
|
||||
FORWARDS with the state of each, and the status bar counts the ones listening; on the phone the same list is a
|
||||
sheet off the terminal's bar.
|
||||
|
||||
Three things about them are worth expecting rather than discovering.
|
||||
|
||||
**Everything listens on localhost, and there is no setting for it.** A forward is a field any member of a
|
||||
shared keychain can fill in, and one bound to every interface would hand the remote's network to anybody who
|
||||
can reach your machine for as long as the terminal is open. A remote forward asks the remote for its loopback
|
||||
too; whether the remote honours that is its own `GatewayPorts`.
|
||||
|
||||
**A forward lives as long as its terminal.** It runs over that tab's connection, so closing the tab, losing
|
||||
the connection or reconnecting stops it — a reconnect starts the host's forwards again on the new session. A
|
||||
second tab to the same host runs the same forwards, and they fail there because the ports are taken; the row
|
||||
says so, and the terminal is unaffected. Any row can be switched off and on while its session is up.
|
||||
|
||||
**No byte counts**, which the design draws: SSH.NET keeps none, so a number there would be invented. The
|
||||
phone runs forwards too, listed behind a `⇄` in its terminal's bar, but cannot edit them yet; see
|
||||
[The Android head](#the-android-head).
|
||||
|
||||
### Reaching a server through Spelunk
|
||||
|
||||
A server managed by Spelunk runs Spelunk's agent, which keeps a connection open to Spelunk. DodoSSH can use
|
||||
that connection instead of dialling: tick **Connect through Spelunk** in the host editor and fill in
|
||||
Spelunk's API address, the server's id in Spelunk, and your Spelunk API key. A connection then asks Spelunk
|
||||
for a ticket, opens a WebSocket, and the agent connects to the SSH server on the machine's own loopback — so
|
||||
the server needs no open SSH port at all. Shells and file transfers both go this way; the relay and Spelunk
|
||||
are one choice, and ticking one unticks the other.
|
||||
|
||||
- **Fill in the API key once, under Settings → Security → Spelunk.** Give Spelunk's API address and paste
|
||||
the key (`spelunk_…`, with the Admin role). It is saved as a *Spelunk key* in your personal vault —
|
||||
encrypted, synced to your other devices, never shown again — together with the address, and **it is only
|
||||
ever sent to that address**: a host that names the key with any other address is refused at connect. One
|
||||
key serves every server in that Spelunk organisation; saving a key for an address that already has one
|
||||
replaces it, and every host using it connects with the new key. The host editor offers saved keys first
|
||||
and picks the one for the address you type. The API address must be `https://`, except for a Spelunk on
|
||||
this machine.
|
||||
- A key kept the older way, as a credential's password, still works and is still offered in the editor;
|
||||
its password goes to whatever address the host names.
|
||||
- **The hostname and port still matter**, though nothing dials them: the host key is pinned under them as it
|
||||
is for every host, and the port is what the agent connects to on the server.
|
||||
- **There is no falling back to a direct dial**, and a refusal is said in Spelunk's terms: a key Spelunk will
|
||||
not take, a key whose role is too low, a server outside the key's organisation, an agent that is not
|
||||
connected, an agent that could not reach the SSH port or is too old to open terminals.
|
||||
|
||||
**Sign in through Spelunk (no SSH key needed)**, the box under the key in the same card, lets Spelunk log
|
||||
you in instead of an SSH key or password of the host's own. For each connection DodoSSH makes a throwaway
|
||||
Ed25519 key pair in memory and sends the public half with the ticket request, which the API key authorises;
|
||||
the agent runs a one-connection `sshd -i` on the server whose only authorised key is that one, and says
|
||||
which account it logs in as (`root`). It is real SSH to the server's real host key, so shells, file
|
||||
transfers and port forwards all work, and the key is gone with the connection — it is never stored,
|
||||
synced or logged. The login and authentication choices are greyed out while it is ticked and saved as
|
||||
nothing. The server needs OpenSSH's `sshd` installed (not running, and no open port); an agent too old
|
||||
to sign in, or a server without `sshd`, is said so. Such a host is written at host schema version 10,
|
||||
so a DodoSSH older than this shows it read-only.
|
||||
|
||||
**"Open in DodoSSH" in Spelunk** starts DodoSSH with a `dodossh://spelunk/connect?api=…&server=…&name=…&host=…`
|
||||
link, or hands the link to the copy already running, and **connects straight away.** The link never
|
||||
carries a credential. The hosts links make live in your personal vault, tagged `spelunk`:
|
||||
|
||||
- If your personal vault has a host tagged `spelunk` for that server on that Spelunk, DodoSSH connects to it.
|
||||
- Otherwise, when you have saved a Spelunk key for that Spelunk under Settings → Security — or a saved host
|
||||
already sends an API key there — DodoSSH saves a new host in your personal vault — named as the link
|
||||
names it, at the link's address (or `spelunk-<server id>`), port 22, signing in through Spelunk with that
|
||||
key, tagged `spelunk` (the tag is made if the vault has none) — and connects to it. It syncs like any host
|
||||
you saved yourself.
|
||||
- **A link from a Spelunk with no key** opens the host editor instead, filled in the same way with sign-in
|
||||
ticked and the tag on, and you choose that Spelunk's API key once and save. Every later link from that
|
||||
Spelunk connects straight away. A link can be sent by anything on this machine, so an API key is never
|
||||
sent to an address you have not sent it to — saving the key under Security is how you say you have.
|
||||
|
||||
A host you set up by hand, or one in a team's vault, is left as it is: a link for its server adds a host of
|
||||
its own. A link that arrives while the vault is locked waits for the unlock.
|
||||
|
||||
The Windows installer registers the scheme for your user and removes it on uninstall, the macOS bundle
|
||||
declares it in its `Info.plist`, and the Linux package's desktop entry declares `x-scheme-handler/dodossh`.
|
||||
The phone reaches Spelunk hosts the same way but does not answer links yet.
|
||||
|
||||
### Sharing a vault
|
||||
|
||||
**VAULTS** in the nav rail lists every vault you can see, makes new ones, adds people to one,
|
||||
@@ -641,8 +725,9 @@ its host if it has one and back into the box if it does not.
|
||||
**A connected phone shows one bar and then the terminal.** The header, the session strip and the bottom
|
||||
bar are collapsed while a shell is up, and a single 35-pixel row replaces them: back on the left, the
|
||||
sessions as pills, and a `+` on the right offering the three connections this application can make — a
|
||||
shell, a host's files over SFTP, or a bucket. The system back gesture does what the arrow does, and lowers
|
||||
that menu first if it is open.
|
||||
shell, a host's files over SFTP, or a bucket. Beside the `+`, for a tab whose host has port forwards, a `⇄`
|
||||
opens them; see below. The system back gesture does what the arrow does, and lowers either sheet first if
|
||||
one is open.
|
||||
|
||||
Widening the rail moved the desktop window's minimum from `880x560` to `1016x574`, which leaves every
|
||||
screen exactly the width it was designed against.
|
||||
@@ -710,10 +795,25 @@ What it does *not* yet do is use the extra width inside a screen: the host list
|
||||
size. Two columns needs the row model to change — the list is headings and hosts in one sequence, and a
|
||||
heading has to span — which is shared with the desktop and is its own piece of work.
|
||||
|
||||
**Port forwarding is not built anywhere**, and the phone's More screen says so in a paragraph rather than
|
||||
leaving a gap. The v2 design draws a whole screen for it; nothing in the SSH layer forwards anything, so
|
||||
every control on that screen would have had no effect. See
|
||||
[`docs/design-import-gaps.md`](docs/design-import-gaps.md).
|
||||
**Port forwarding runs here too, and is edited on the desktop.** A host's forwards start with every
|
||||
terminal the phone opens to it, as they do on the desktop. The terminal's bar grows a `⇄` for a tab that has
|
||||
any, carrying the number listening in green, or turning red when one could not start; it opens a sheet
|
||||
listing the tab's forwards with their route, their state, the reason a failed one gave, and a tap on each to
|
||||
switch it off or on — the desktop sidebar's FORWARDS section, over the same rows. The v2 design's whole
|
||||
FORWARDING screen is not drawn, for the reason the desktop has none: a forward belongs to a host and runs
|
||||
with a session, and both already have a place. What the phone has not got is an editor for them — its host
|
||||
form has no PORT FORWARDS section — so they are added on the desktop and arrive with the host; the More
|
||||
screen says so in a paragraph.
|
||||
|
||||
Forwards ride the **keep-alive** a shell already has. A forward runs over its tab's connection, so the
|
||||
foreground service that holds a shell open in the background is holding its forwards open too, and nothing
|
||||
else needs to: the service is never started for a forward alone, because there is never a listening forward
|
||||
without a live shell. What forwards change is the notification, which counts them beside the shells —
|
||||
`1 shell connected · 2 ports forwarded` — because a phone in a pocket holding ports open is something its
|
||||
owner should be able to see. Local and SOCKS forwards listen on the phone's own loopback, which every app on
|
||||
the phone can reach; that is what makes one useful here — a database client on the phone reaching a server
|
||||
behind the remote — and it is the same exposure the desktop's localhost has to its own processes. See
|
||||
[Forwarding ports](#forwarding-ports) and [`docs/design-import-gaps.md`](docs/design-import-gaps.md).
|
||||
|
||||
It is deliberately **not** in `DodoSSH.slnx`. Putting it there would make the `android` workload and a full
|
||||
Android SDK a prerequisite of `dotnet build DodoSSH.slnx` for everybody; it has its own CI job instead, which
|
||||
|
||||
@@ -247,6 +247,13 @@ ln -s ../../opt/%{dodo_dir}/DodoSSH %{buildroot}%{_bindir}/%{dodo_bin}
|
||||
# window is a second, unlabelled icon in the dock beside the one that launched it. It is the assembly
|
||||
# name deliberately and not the package's binary name — the window does not know which package
|
||||
# started it.
|
||||
#
|
||||
# %%u — RPM's spelling of a literal %u, the field code for "one URL" — and the MimeType line make this
|
||||
# the handler for dodossh:// links, which is how Spelunk's "Open in DodoSSH" reaches the application:
|
||||
# the desktop starts the binary with the link as its one argument, and Program.Main reads and checks
|
||||
# it, or passes it to the instance already running. update-desktop-database in the post-install
|
||||
# scriptlet is what makes xdg-open see the handler. Both channels declare it, so whichever is
|
||||
# installed answers, and with both installed the desktop's own default decides.
|
||||
mkdir -p %{buildroot}%{_datadir}/applications
|
||||
cat > %{buildroot}%{_datadir}/applications/%{dodo_bin}.desktop <<DESKTOP
|
||||
[Desktop Entry]
|
||||
@@ -255,13 +262,14 @@ Version=1.0
|
||||
Name=%{dodo_title}
|
||||
GenericName=SSH Client
|
||||
Comment=SSH and SFTP with an end-to-end encrypted credential vault
|
||||
Exec=%{dodo_bin}
|
||||
Exec=%{dodo_bin} %%u
|
||||
Icon=%{dodo_bin}
|
||||
Terminal=false
|
||||
StartupNotify=true
|
||||
StartupWMClass=DodoSSH
|
||||
Categories=Network;RemoteAccess;System;
|
||||
Keywords=SSH;SFTP;Terminal;Remote;Shell;
|
||||
MimeType=x-scheme-handler/dodossh;
|
||||
DESKTOP
|
||||
|
||||
# One file per size into the hicolor theme, named for the package so the two channels show different
|
||||
|
||||
@@ -119,6 +119,25 @@
|
||||
<key>LSUIElement</key>
|
||||
<false/>
|
||||
|
||||
<!--
|
||||
The dodossh:// scheme, which is how Spelunk's "Open in DodoSSH" reaches the application. macOS
|
||||
does not pass the link as an argument: Launch Services sends an "open URL" event to the running
|
||||
application, or to the one it has just started, and DodoSshApp.ListenForOpenedLinks takes it from
|
||||
Avalonia's activation event. Registered when the bundle is first seen by Launch Services, which
|
||||
for a Velopack install is on first launch from /Applications.
|
||||
-->
|
||||
<key>CFBundleURLTypes</key>
|
||||
<array>
|
||||
<dict>
|
||||
<key>CFBundleURLName</key>
|
||||
<string>dev.dodotech.dodossh.link</string>
|
||||
<key>CFBundleURLSchemes</key>
|
||||
<array>
|
||||
<string>dodossh</string>
|
||||
</array>
|
||||
</dict>
|
||||
</array>
|
||||
|
||||
<key>NSHumanReadableCopyright</key>
|
||||
<string>© DodoTech. MIT licensed.</string>
|
||||
</dict>
|
||||
|
||||
@@ -631,7 +631,8 @@ go at 360dp:
|
||||
for. `ShellScreen` gained `More` and `Buckets`. The palette went blue and the two heads moved together,
|
||||
because it is shared. What v2 asked for and did not get is in
|
||||
[`docs/design-import-gaps.md`](design-import-gaps.md) — the short version being that port forwarding is
|
||||
named as absent rather than drawn, because nothing in the SSH layer forwards anything.
|
||||
named rather than drawn as a screen: it has since been built, and this head runs a host's forwards with
|
||||
every terminal and lists them in a sheet off the terminal's bar. It cannot edit them yet.
|
||||
|
||||
**The bar has since gone from four entries to three.** The keychain joined the hub, which is now called
|
||||
SETTINGS rather than MORE and wears a gear: a bottom bar is for the places a session moves between, and
|
||||
|
||||
+5
-1
@@ -299,7 +299,8 @@ value can forge a field boundary. UUIDs must be serialised in RFC 4122 order —
|
||||
|
||||
`1` User, `2` Device, `3` Vault, `4` Host, `5` Credential, `6` SshKey, `7` HostGroup,
|
||||
`8` Tag, `9` Snippet, `10` PortForward, `11` KnownHostKey, `12` HostTag,
|
||||
`13` HostCredential, `14` ConnectionLogEntry, `15` ActivityLogEntry, `16` ObjectStore.
|
||||
`13` HostCredential, `14` ConnectionLogEntry, `15` ActivityLogEntry, `16` ObjectStore,
|
||||
`17` SpelunkKey.
|
||||
|
||||
> **Added 2026-07-29:** `12` and `13`. `Contracts.SyncEntityType` has listed `HostTag` and
|
||||
> `HostCredential` as syncable since the contract was frozen, but this table had no value for
|
||||
@@ -318,6 +319,9 @@ value can forge a field boundary. UUIDs must be serialised in RFC 4122 order —
|
||||
> `ConnectionLogEntry` is `11` there and `14` here. Nothing casts between them, and
|
||||
> `AadResourceTypeTests` pins each pairing by name for exactly that reason.
|
||||
|
||||
> **Added 2026-09-29:** `17` SpelunkKey, a Spelunk API key and the address it may be sent to. It is
|
||||
> `14` on the wire, three behind, as `16` ObjectStore is `13`.
|
||||
|
||||
`0` means not applicable and is legal only where the table in §4.2 implies no resource.
|
||||
|
||||
### 4.4 What this prevents
|
||||
|
||||
+15
-12
@@ -39,8 +39,8 @@ the chrome, hosts and terminals, file transfer, the vault, teams, and preference
|
||||
>
|
||||
> | 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. |
|
||||
> | The **FORWARDING** screen: local/remote/dynamic rules, toggles, bytes transferred | **Built, as a sheet off the terminal rather than a screen, and running on the phone as on the desktop.** A host's forwards start with every terminal opened to it on either head — `MainWindowViewModel.StartForwards` no longer skips Android. The terminal's bar draws a `⇄` for a tab that has forwards, with the listening count in green and the glyph in the danger colour when one failed, and it raises a sheet (`IsForwardsSheetOpen`) listing `SelectedTab.Forwards` with notation, route, state word, failure reason and a tap-to-toggle per row — the desktop sidebar's FORWARDS section over the same rows. Not a screen, for the desktop's reason: a forward belongs to a host and runs with a session. **Two gaps remain.** The phone's host form has no PORT FORWARDS section, so forwards are edited on the desktop and arrive with the host; the MORE screen's paragraph, now tagged IN THE TERMINAL, says so. And byte counts are built on neither head: SSH.NET keeps none. The keep-alive notification counts listening forwards beside the shells they run over, and is never started for a forward alone, since a forward cannot outlive its shell. |
|
||||
> | `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 forwarded anything at the time (forwards now have the `⇄` in the bar above; see the row before this one), 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. |
|
||||
@@ -78,7 +78,7 @@ the chrome, hosts and terminals, file transfer, the vault, teams, and preference
|
||||
>
|
||||
> | 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 **FORWARDING** screen, the `⇄ N forwards` chip on the session strip, and the host detail's FORWARDING card | **Built, as three smaller things.** Forwards are rules on the host, edited in its drawer under PORT FORWARDS and shown read-only on its detail pane; they run per terminal, listed with a switch each under FORWARDS in the session sidebar; and the session status bar counts the listening ones as `⇄ N FORWARDS`. No screen of their own, because a forward is not a thing you visit — it belongs to a host and runs with a session, and both of those already have a place. |
|
||||
> | 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. |
|
||||
@@ -171,7 +171,7 @@ the chrome, hosts and terminals, file transfer, the vault, teams, and preference
|
||||
> | The **Backspace / Default** row | Omitted, and it is the one row on this list that could now be built cheaply — a setting, an opcode and a control, the way the text size was. What it lacks is a reason: which byte backspace sends is a fact about the remote's `stty`, so a client-side switch fixes a mismatch by hiding it. See the Preferences section. |
|
||||
> | 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. |
|
||||
> | **Port Forwarding** in the sidebar | No rail entry; see the FORWARDING row above for where forwards are instead. |
|
||||
> | The host grid's toolbar avatar, share and tag-filter controls | Omitted, as in v3 and for the same reasons. |
|
||||
>
|
||||
> ## The desktop's v5 — hosts, restyled, and two reversals
|
||||
@@ -295,7 +295,7 @@ the chrome, hosts and terminals, file transfer, the vault, teams, and preference
|
||||
> | v5b element | What ships instead |
|
||||
> | --- | --- |
|
||||
> | The host header's OS label (`Ubuntu 24.04 LTS`) and latency reading (`12 ms`) | Neither. The client does not know the remote's OS and nothing measures round-trip time — the same two absences the terminal pane header already recorded before this pass, carried into the new header rather than reopened. |
|
||||
> | A **Port forward** button on the host header | Omitted. The feature does not exist; see the FORWARDING rows earlier in this document. |
|
||||
> | A **Port forward** button on the host header | **Add forward**, at the foot of the session sidebar's FORWARDS list, which opens the host's editor the way Pin folder does. The header it would have sat on has since moved into that sidebar. |
|
||||
> | The tab and status dots' third, amber state | ◆ **Still two states**, for the reason the hosts screen's own dot has stayed two states since v3: green means a shell is open (or a session is connected), grey means it is not, and nothing here pings a host to justify a third colour meaning "reachable but not connected". |
|
||||
> | The status bar's negotiated cipher, host-key algorithm and key/credential name | ◆ **Shipped, on both surfaces, with three honest deviations.** `ISshConnection` and `ISftpSession` now both carry `Cipher` — the server-to-client algorithm off SSH.NET's own `ConnectionInfo.CurrentServerEncryption`, captured once at construction because a rekey is not an event SSH.NET raises — and `TerminalWorkspace.GetSessionFacts` hands the cipher and the host key's algorithm back to the shell the moment a session opens; `VaultViewModel.TryBuildAuthentication` now threads the authenticating key's or credential's own `Label` into `HostAuthentication.IdentityLabel`, all the way to `MainWindowViewModel`'s surface-aware `SessionCipher`, `SessionHostKeyAlgorithm` and `SessionIdentityLabel`, composed into one `SessionIdentityText` run for the status bar. Three deviations from the mock, not omissions: the algorithm prints exactly as negotiated (`ssh-ed25519`), not the design's shortened `ed25519`, because trimming it would be an edit to a string this client did not choose; the run is plain text rather than the design's clickable element, because there is no pin-details modal for a session that is already open, and drawing a click target for a screen that does not exist would itself be a fabrication; and a typed-password session — nothing filed in the keychain to name — shows the host-key algorithm alone, with no `·` after it, because there is no item behind the dot. |
|
||||
> | S3 dimmed in the design's own switcher | **Enabled.** The mock leaves S3 as future work; this application already has bucket browsing, so SSH, SFTP and S3 are a true three-way segment, wired to `IsSshShowing`, `IsTransfersShowing` and `IsBucketsShowing` exactly alike. |
|
||||
@@ -392,9 +392,10 @@ sharing that would rest on them — or a decision recorded here not to build the
|
||||
|
||||
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.
|
||||
**An SSH connection here opens a shell, and forwards beside it.** `ISshConnection` offers `OpenShellAsync`
|
||||
and `StartForwardAsync` (`src/DodoSSH.Client.Ssh/SshConnection.cs`). There is still no ProxyJump, which is
|
||||
what removes every `via bastion-eu` in the design. Port forwarding arrived later than most of what this
|
||||
document accounts for, and the rows about it now say where it went.
|
||||
|
||||
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
|
||||
@@ -461,8 +462,10 @@ configuration, a server kind that refuses every plaintext field, a codec, a merg
|
||||
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
|
||||
`HostTag`, `HostCredential` and `PortForward` are still reserved and still unused — and `HostTag` and
|
||||
`PortForward` are now reserved *against a decision* rather than pending one. Port forwards shipped inside the
|
||||
host's payload, for the reason `RelayTicketRequest.PortForwardId` already assumed and the one below gives for
|
||||
tags. 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.
|
||||
@@ -509,7 +512,7 @@ field cannot be removed and stays as a permanently refused member; `SyncEndpoint
|
||||
| `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 port forwards | client-ssh | — | **Shipped** on the session status bar as a count of listening forwards; the ports themselves are in the session sidebar. |
|
||||
| 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. | **Shipped, since v5, and not IBM Plex.** The v5 design asked for Montserrat, JetBrains Mono and Material Icons instead, and all three are embedded as `AvaloniaResource` in the Shell project rather than requested by name and left to whatever the machine happens to have. Montserrat is the default sans, with Inter — the earlier substitution — kept only as its fallback; `MonoFont` puts JetBrains Mono first, ahead of the system-monospace stack the terminal still falls back to. Named once each in `Program.cs` and `Palette.axaml`, so a later design's fonts are still a one-line swap. |
|
||||
@@ -533,7 +536,7 @@ caption buttons and window title drawn on top of the application's own — two s
|
||||
| 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. |
|
||||
| `⇄ FORWARDS · 2` | client-ssh | — | **Shipped**, as `⇄ 2 FORWARDS` on the session status bar, counting only forwards actually listening. |
|
||||
| `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. |
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
using DodoSSH.Domain;
|
||||
using Microsoft.AspNetCore.Authorization;
|
||||
|
||||
namespace DodoSSH.Api.Authorization;
|
||||
|
||||
/// <summary>Requires the caller's account to be <see cref="UserStatus.Active"/>.</summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <see cref="UserStatus.Suspended"/> is documented as "sign-in blocked", and nothing blocked it: the identity
|
||||
/// provider still issues tokens for the person, every endpoint resolved them through the current-user context,
|
||||
/// and that context looked an account up by issuer, subject and deletion alone. A suspended account could pull
|
||||
/// and push vaults, take relay tickets and hold the events socket open. This is the check, on both policies, so
|
||||
/// that no endpoint can be reached without it.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// A connection already open when the account is suspended — a relay tunnel, the events socket — is not
|
||||
/// reached by this; it ends on its own idle and lifetime limits.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal sealed class ActiveAccountRequirement : IAuthorizationRequirement;
|
||||
|
||||
/// <summary>Satisfies <see cref="ActiveAccountRequirement"/> from the account row.</summary>
|
||||
internal sealed class ActiveAccountHandler(ICurrentUserContext currentUser, IHttpContextAccessor accessor)
|
||||
: AuthorizationHandler<ActiveAccountRequirement>
|
||||
{
|
||||
/// <inheritdoc />
|
||||
protected override async Task HandleRequirementAsync(
|
||||
AuthorizationHandlerContext context,
|
||||
ActiveAccountRequirement requirement)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(context);
|
||||
|
||||
// The policy's authentication requirement already refuses an anonymous caller with a 401; failing this
|
||||
// as well would turn that into a 403.
|
||||
if (context.User.Identity?.IsAuthenticated != true)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
var cancellationToken = accessor.HttpContext?.RequestAborted ?? CancellationToken.None;
|
||||
|
||||
var user = await currentUser.GetOrProvisionAsync(cancellationToken).ConfigureAwait(false);
|
||||
|
||||
if (user.Status == UserStatus.Active)
|
||||
{
|
||||
context.Succeed(requirement);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -102,8 +102,14 @@ internal sealed class CurrentUserContext(
|
||||
/// read-then-write: <c>user_account</c> carries the xmin concurrency token, so two overlapping
|
||||
/// requests from one user would each read the row, each set the timestamp, and the second would
|
||||
/// fail on a version that had moved under it. This writes at most one row and cannot conflict.
|
||||
/// The tracked entity is deliberately left alone — a value up to an hour stale in memory changes
|
||||
/// nothing, and marking it modified would enlist the user row in whatever the request saves next.
|
||||
/// <para>
|
||||
/// ◆ <b>But the write moves xmin under the tracked entity, so the entity is re-read after it.</b> It is
|
||||
/// not marked modified — that would enlist the user row in whatever the request saves next — and a
|
||||
/// stale timestamp in memory would change nothing on its own. A stale concurrency token does: the next
|
||||
/// save in the same request that touches this user (enrolment stamps <c>EnrolledAtUtc</c>) compared
|
||||
/// against the version from before the update and failed, so enrolling more than an hour after first
|
||||
/// signing in answered 500. Only when a row was actually written, which is once an hour at most.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private async Task RefreshLastSeenAsync(UserAccount user, CancellationToken cancellationToken)
|
||||
{
|
||||
@@ -114,13 +120,18 @@ internal sealed class CurrentUserContext(
|
||||
return;
|
||||
}
|
||||
|
||||
await database.Users
|
||||
var written = await database.Users
|
||||
.Where(u => u.Id == user.Id
|
||||
&& (u.LastSeenAtUtc == null || u.LastSeenAtUtc < now - LastSeenWindow))
|
||||
.ExecuteUpdateAsync(
|
||||
setters => setters.SetProperty(u => u.LastSeenAtUtc, now),
|
||||
cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
if (written > 0)
|
||||
{
|
||||
await database.Entry(user).ReloadAsync(cancellationToken).ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
|
||||
private Task<UserAccount?> FindAsync(string issuer, string subject, CancellationToken cancellationToken) =>
|
||||
|
||||
@@ -80,6 +80,26 @@ internal sealed class DodoAuthorizationResultHandler : IAuthorizationMiddlewareR
|
||||
ArgumentNullException.ThrowIfNull(context);
|
||||
ArgumentNullException.ThrowIfNull(authorizeResult);
|
||||
|
||||
var accountNotActive = authorizeResult.Forbidden
|
||||
&& authorizeResult.AuthorizationFailure is { } refusal
|
||||
&& refusal.FailedRequirements.OfType<ActiveAccountRequirement>().Any();
|
||||
|
||||
if (accountNotActive)
|
||||
{
|
||||
await TypedResults.Problem(
|
||||
detail: "This account has been suspended. Ask whoever runs this DodoSSH server.",
|
||||
statusCode: StatusCodes.Status403Forbidden,
|
||||
type: ProblemCodes.TypeBaseUri + ProblemCodes.AccountNotActive,
|
||||
extensions: new Dictionary<string, object?>(StringComparer.Ordinal)
|
||||
{
|
||||
["code"] = ProblemCodes.AccountNotActive,
|
||||
})
|
||||
.ExecuteAsync(context)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
var enrollmentMissing = authorizeResult.Forbidden
|
||||
&& authorizeResult.AuthorizationFailure is { } failure
|
||||
&& failure.FailedRequirements.OfType<EnrolledRequirement>().Any();
|
||||
|
||||
@@ -2,9 +2,18 @@
|
||||
#
|
||||
# docker build -f src/DodoSSH.Api/Dockerfile .
|
||||
#
|
||||
# Directory.Build.props, Directory.Packages.props, NuGet.config and global.json all sit at
|
||||
# the root and all four are load-bearing here — central package management means a csproj
|
||||
# alone does not name a single version, and a build that cannot see them resolves nothing.
|
||||
# Directory.Build.props, Directory.Build.targets, Directory.Packages.props, NuGet.config and
|
||||
# global.json all sit at the root and all five are load-bearing here — central package
|
||||
# management means a csproj alone does not name a single version, and a build that cannot see
|
||||
# them resolves nothing.
|
||||
#
|
||||
# Directory.Build.targets is the one that is easy to forget, because leaving it out breaks
|
||||
# nothing until the day it does: it pins the version of the trimmer the SDK adds to
|
||||
# DodoSSH.Contracts and DodoSSH.Crypto by itself (see the comment there). Without it the restore
|
||||
# below asks for whatever ILLink the image's SDK bundles, which matches the lock files only
|
||||
# until .NET ships a servicing release — and then this image fails with NU1004 while ci.yml,
|
||||
# which does see the pin, stays green. That is how it was found: sdk:10.0-noble moved to
|
||||
# 10.0.401 (ILLink 10.0.12) and this build broke with no commit touching a package.
|
||||
|
||||
# ---------------------------------------------------------------------------------------
|
||||
# Build
|
||||
@@ -26,7 +35,7 @@ WORKDIR /src
|
||||
# dependency change and by nothing else. Every project in DodoSSH.Api's reference closure
|
||||
# has to be here — restore walks ProjectReference, and a missing csproj fails the graph
|
||||
# rather than skipping a node.
|
||||
COPY global.json NuGet.config Directory.Build.props Directory.Packages.props ./
|
||||
COPY global.json NuGet.config Directory.Build.props Directory.Build.targets Directory.Packages.props ./
|
||||
COPY src/DodoSSH.Api/DodoSSH.Api.csproj src/DodoSSH.Api/
|
||||
COPY src/DodoSSH.Api/packages.lock.json src/DodoSSH.Api/
|
||||
COPY src/DodoSSH.Contracts/DodoSSH.Contracts.csproj src/DodoSSH.Contracts/
|
||||
|
||||
@@ -211,10 +211,23 @@ internal sealed class VaultEventsEndpoint(
|
||||
|
||||
/// <summary>Runs the socket until something ends it, then closes it politely.</summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Three loops rather than one: reading a socket and writing to it are independent waits, and the
|
||||
/// clock is a third. They are joined by <see cref="Task.WhenAny(Task[])"/> and then <em>all</em>
|
||||
/// awaited before the close is written, because a close frame racing a notice frame is a protocol
|
||||
/// clock is a third. They are joined by <see cref="Task.WhenAny(Task[])"/>, and the sender is
|
||||
/// finished before the close is written, because a close frame racing a notice frame is a protocol
|
||||
/// violation that presents as a client dropping its connection for no visible reason.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>No operation on the WebSocket is ever cancelled.</b> Cancelling a pending receive or send on
|
||||
/// the socket Kestrel hands over aborts it, and an aborted socket cannot send the close frame that
|
||||
/// is the only way a client learns <em>why</em> it was dropped — 4401 "reconnect with a fresh
|
||||
/// token" against 1001 "the server is going away" against a failure to back off from. This was
|
||||
/// once the case here, and it went unnoticed because <c>TestServer</c>'s in-memory socket survives
|
||||
/// the cancellation that a real one does not. So the token stops the queue and the clock; the
|
||||
/// sender is let finish its last write; the close goes out; and the receiver ends on the client's
|
||||
/// answering close. Each wait is bounded, and the socket is aborted only when a peer has stopped
|
||||
/// answering altogether. The relay's pump does the same, for the same reason.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private async Task PumpAsync(
|
||||
WebSocket socket,
|
||||
@@ -236,15 +249,21 @@ internal sealed class VaultEventsEndpoint(
|
||||
VaultCount: connection.VaultCount));
|
||||
|
||||
var sending = SendAsync(socket, connection, pump.Token);
|
||||
var receiving = ReceiveAsync(socket, connection, pump.Token);
|
||||
var receiving = ReceiveAsync(socket, connection);
|
||||
var minding = MindAsync(connection, closure, pump.Token);
|
||||
|
||||
await Task.WhenAny(sending, receiving, minding).ConfigureAwait(false);
|
||||
|
||||
await pump.CancelAsync().ConfigureAwait(false);
|
||||
|
||||
// Nothing may still be mid-send when the close frame goes out.
|
||||
await Task.WhenAll(Settled(sending), Settled(receiving), Settled(minding)).ConfigureAwait(false);
|
||||
// Nothing may still be mid-send when the close frame goes out. A send that does not finish is
|
||||
// a client that has stopped reading, which will not read a close frame either.
|
||||
if (!await SettlesAsync(sending).ConfigureAwait(false))
|
||||
{
|
||||
socket.Abort();
|
||||
}
|
||||
|
||||
await SettlesAsync(minding).ConfigureAwait(false);
|
||||
|
||||
if (lifetime.ApplicationStopping.IsCancellationRequested)
|
||||
{
|
||||
@@ -256,6 +275,14 @@ internal sealed class VaultEventsEndpoint(
|
||||
EventsLog.ClosingConnection(logger, connection.UserId, closure.Reason);
|
||||
|
||||
await CloseAsync(socket, closure).ConfigureAwait(false);
|
||||
|
||||
// The client's answering close is what ends the receiver. Returning before it arrives would
|
||||
// dispose the socket under a close frame still in flight.
|
||||
if (!await SettlesAsync(receiving).ConfigureAwait(false))
|
||||
{
|
||||
socket.Abort();
|
||||
await SettlesAsync(receiving).ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -287,8 +314,9 @@ internal sealed class VaultEventsEndpoint(
|
||||
|
||||
var bytes = JsonSerializer.SerializeToUtf8Bytes(frame, DodoSshJsonContext.Default.VaultEvent);
|
||||
|
||||
// Not cancellable, deliberately. See PumpAsync.
|
||||
await socket
|
||||
.SendAsync(bytes, WebSocketMessageType.Text, endOfMessage: true, cancellationToken)
|
||||
.SendAsync(bytes, WebSocketMessageType.Text, endOfMessage: true, CancellationToken.None)
|
||||
.ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
@@ -297,21 +325,26 @@ internal sealed class VaultEventsEndpoint(
|
||||
/// Reads what the client sends, which in this version is heartbeats and a close.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// A client cannot ask to follow a vault, and that is deliberate rather than unfinished: a
|
||||
/// <c>subscribe(vaultId)</c> frame is an existence oracle for vault ids, which is the disclosure
|
||||
/// <c>SyncPullEndpoint</c> answers 404 rather than 403 to avoid. Subscription is decided from the
|
||||
/// caller's access and nothing else.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// It takes no token: it ends on the client's close, a frame it refuses, or the socket failing —
|
||||
/// and when the server is the one ending the connection, the close it sends is what prompts the
|
||||
/// first of those. See <see cref="PumpAsync"/>.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private static async Task ReceiveAsync(
|
||||
WebSocket socket,
|
||||
VaultEventConnection connection,
|
||||
CancellationToken cancellationToken)
|
||||
private static async Task ReceiveAsync(WebSocket socket, VaultEventConnection connection)
|
||||
{
|
||||
var buffer = new byte[MaxInboundFrameBytes];
|
||||
|
||||
while (!cancellationToken.IsCancellationRequested)
|
||||
while (true)
|
||||
{
|
||||
var received = await socket.ReceiveAsync(buffer, cancellationToken).ConfigureAwait(false);
|
||||
// Not cancellable, deliberately. See PumpAsync.
|
||||
var received = await socket.ReceiveAsync(buffer, CancellationToken.None).ConfigureAwait(false);
|
||||
|
||||
if (received.MessageType == WebSocketMessageType.Close)
|
||||
{
|
||||
@@ -492,31 +525,39 @@ internal sealed class VaultEventsEndpoint(
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Awaits a pump loop, treating its cancellation and its socket faults as the ordinary end.
|
||||
/// Waits for a pump loop to finish, for at most the close timeout.
|
||||
/// </summary>
|
||||
/// <returns>Whether it finished.</returns>
|
||||
/// <remarks>
|
||||
/// Every one of these loops ends by being cancelled or by the socket going away, so an exception
|
||||
/// here is the expected shape of "this connection is over" rather than a fault to propagate — and
|
||||
/// propagating it would skip the close frame the other side is waiting for.
|
||||
/// </remarks>
|
||||
private static async Task Settled(Task loop)
|
||||
private static async Task<bool> SettlesAsync(Task loop)
|
||||
{
|
||||
try
|
||||
{
|
||||
await loop.ConfigureAwait(false);
|
||||
await loop.WaitAsync(CloseTimeout).ConfigureAwait(false);
|
||||
|
||||
return true;
|
||||
}
|
||||
catch (TimeoutException)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
catch (Exception exception)
|
||||
when (exception is OperationCanceledException or WebSocketException or ObjectDisposedException)
|
||||
{
|
||||
// Expected.
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Why the socket is being closed, decided by whichever loop ended first.</summary>
|
||||
/// <remarks>
|
||||
/// Mutable and shared, and safe without a lock for one specific reason: it is written by the pump
|
||||
/// loops and read only after <see cref="Task.WhenAll(Task[])"/> over all of them, which is a
|
||||
/// memory barrier. Writes race only with each other, and any of them is a true answer.
|
||||
/// Mutable and shared, and safe without a lock for one specific reason: it is written only by
|
||||
/// <see cref="MindAsync"/>, and read only after that loop has been awaited, which is a memory
|
||||
/// barrier. If that loop outlived the close timeout, a late write races the read, and either
|
||||
/// answer is still a true one.
|
||||
/// </remarks>
|
||||
private sealed class Closure(int code, string reason)
|
||||
{
|
||||
|
||||
@@ -73,6 +73,7 @@ internal static class ItemKinds
|
||||
(IItemKind)new HostKind(), new SshKeyKind(), new CredentialKind(), new KnownHostKeyKind(),
|
||||
new HostGroupKind(), new TagKind(), new SnippetKind(),
|
||||
new ConnectionLogEntryKind(), new ActivityLogEntryKind(), new ObjectStoreKind(),
|
||||
new SpelunkKeyKind(),
|
||||
}.ToDictionary(kind => kind.WireType);
|
||||
|
||||
/// <summary>The kind for a wire type, or null when this server does not synchronise it yet.</summary>
|
||||
@@ -1093,3 +1094,98 @@ internal sealed class ObjectStoreKind : IItemKind
|
||||
/// <inheritdoc />
|
||||
public SyncPlaintextFields? Hydrate(IVaultItem item) => null;
|
||||
}
|
||||
|
||||
/// <summary>Spelunk keys: an envelope and nothing else.</summary>
|
||||
/// <remarks>
|
||||
/// <see cref="ObjectStoreKind"/>'s rules, because it holds the same class of thing: an API key is a password,
|
||||
/// and the address beside it is where somebody manages their servers. Nothing on the server calls Spelunk.
|
||||
/// </remarks>
|
||||
internal sealed class SpelunkKeyKind : IItemKind
|
||||
{
|
||||
/// <inheritdoc />
|
||||
public SyncEntityType WireType => SyncEntityType.SpelunkKey;
|
||||
|
||||
/// <inheritdoc />
|
||||
public ChangeEntityType ChangeType => ChangeEntityType.SpelunkKey;
|
||||
|
||||
/// <inheritdoc />
|
||||
public async Task<IVaultItem?> FindAsync(
|
||||
DodoDbContext database,
|
||||
Guid id,
|
||||
CancellationToken cancellationToken) =>
|
||||
await database.SpelunkKeys.SingleOrDefaultAsync(s => s.Id == id, cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
/// <inheritdoc />
|
||||
public async Task<Dictionary<Guid, IVaultItem>> LoadAsync(
|
||||
DodoDbContext database,
|
||||
Guid vaultId,
|
||||
Guid[] ids,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
var rows = await database.SpelunkKeys
|
||||
.Where(s => s.VaultId == vaultId && ids.Contains(s.Id))
|
||||
.ToListAsync(cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
return rows.ToDictionary(row => row.Id, row => (IVaultItem)row);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public IVaultItem Add(DodoDbContext database, Guid id, Guid vaultId)
|
||||
{
|
||||
var key = new VaultSpelunkKey { Id = id, VaultId = vaultId };
|
||||
|
||||
database.SpelunkKeys.Add(key);
|
||||
|
||||
return key;
|
||||
}
|
||||
|
||||
/// <summary>Refuses every plaintext field there is.</summary>
|
||||
/// <remarks>
|
||||
/// The relay fields are refused although this type holds an address, as they are for a bucket: the
|
||||
/// address belongs in the ciphertext, and the server has no business keeping a list of where its users
|
||||
/// manage their servers from.
|
||||
/// </remarks>
|
||||
/// <inheritdoc />
|
||||
public bool ValidateFields(SyncPlaintextFields fields, out string error)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(fields);
|
||||
|
||||
error = string.Empty;
|
||||
|
||||
if (fields.RelayEnabled || fields.Hostname is not null || fields.Port is not null)
|
||||
{
|
||||
error = "A Spelunk key is not something the server dials; its address stays encrypted.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (fields.GroupId is not null || fields.ParentId is not null || fields.RelatedId is not null)
|
||||
{
|
||||
error = "A Spelunk key's contents are inside its payload.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (fields.Kind is not null || fields.PublicKeyFingerprint is not null)
|
||||
{
|
||||
error = "A Spelunk key carries no plaintext fields at all.";
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <remarks>Nothing to copy: this type has no plaintext columns to copy anything into.</remarks>
|
||||
/// <inheritdoc />
|
||||
public void ApplyFields(IVaultItem item, SyncPlaintextFields fields)
|
||||
{
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public void ClearFieldsOnDelete(IVaultItem item)
|
||||
{
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public SyncPlaintextFields? Hydrate(IVaultItem item) => null;
|
||||
}
|
||||
@@ -536,9 +536,21 @@ internal sealed class SyncService(
|
||||
|
||||
/// <summary>Attaches current row state to change-log entries.</summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// A page of changes can mix item types, so rows are loaded per type — one query each, not one per
|
||||
/// change — and then matched back in the log's order. Ordering is the log's, never the load's: a pull
|
||||
/// that returned changes grouped by type would hand the client a sequence its cursor cannot resume from.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// ◆ <b>An entry an item has since moved past is left out.</b> The log keeps every revision, but the
|
||||
/// table keeps only the latest ciphertext — so hydrating an old entry paired that entry's revision number
|
||||
/// with the newest payload, and the payload's AAD binds the revision it was sealed at. A client opened it
|
||||
/// at the old number, failed, and parked its own unsent edit to that item as undecryptable. The later
|
||||
/// entry is in this page or a later one, since the item's <c>ChangeSequence</c> is that entry's sequence;
|
||||
/// it carries the same payload under the right number, so nothing is lost by sending it once. Leaving
|
||||
/// the old entries out also stops a fresh device downloading an item once per edit it ever had. The
|
||||
/// cursor is computed from the unfiltered page by the caller, so it still moves past them.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private async Task<List<Contracts.SyncChange>> HydrateAsync(
|
||||
Vault vault,
|
||||
@@ -571,10 +583,13 @@ internal sealed class SyncService(
|
||||
}
|
||||
}
|
||||
|
||||
return [.. changes.Select(change => Describe(
|
||||
change,
|
||||
kinds.GetValueOrDefault(change.EntityType),
|
||||
rows.GetValueOrDefault((change.EntityType, change.EntityId))))];
|
||||
return [.. changes
|
||||
.Where(change => rows.GetValueOrDefault((change.EntityType, change.EntityId)) is not { } row
|
||||
|| row.ChangeSequence <= change.Sequence)
|
||||
.Select(change => Describe(
|
||||
change,
|
||||
kinds.GetValueOrDefault(change.EntityType),
|
||||
rows.GetValueOrDefault((change.EntityType, change.EntityId))))];
|
||||
}
|
||||
|
||||
/// <summary>Turns one change-log entry and its row into what a client receives.</summary>
|
||||
|
||||
@@ -179,8 +179,8 @@ internal sealed class ArchiveTeamEndpoint(ICurrentUserContext currentUser, TeamS
|
||||
}
|
||||
|
||||
// Owner, not admin. An admin the owner promoted must not be able to archive the team out
|
||||
// from under them — that is the boundary IsOwner exists to draw. Nothing behind this
|
||||
// re-checks it, unlike the transfer below, so this line is the whole of the guard.
|
||||
// from under them — that is the boundary IsOwner exists to draw. TeamService.ArchiveAsync
|
||||
// checks it again, because deleting a team's last vault archives it too.
|
||||
if (!access.IsOwner)
|
||||
{
|
||||
return Problems.Coded(
|
||||
|
||||
@@ -244,8 +244,16 @@ internal sealed class TeamService(
|
||||
Team team,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(actor);
|
||||
ArgumentNullException.ThrowIfNull(team);
|
||||
|
||||
// Both callers check this first and answer the caller properly; this is what stops a third one that
|
||||
// forgets from letting an admin archive the team out from under its owner.
|
||||
if (!(await ResolveAsync(actor.Id, team.Id, cancellationToken).ConfigureAwait(false)).IsOwner)
|
||||
{
|
||||
throw new InvalidOperationException("Only the owner of a team can archive it.");
|
||||
}
|
||||
|
||||
var vaultCount = await CountVaultsAsync(team.Id, cancellationToken).ConfigureAwait(false);
|
||||
|
||||
if (vaultCount > 0)
|
||||
|
||||
@@ -191,7 +191,12 @@ internal sealed class DeleteVaultEndpoint(
|
||||
{
|
||||
var orphaned = await grants.DeleteVaultAsync(user, access.Vault!, ct).ConfigureAwait(false);
|
||||
|
||||
if (orphaned is not null)
|
||||
// Archived only by its owner. Archiving revokes every membership, the owner's included, and an
|
||||
// admin the owner promoted must not be able to do that by deleting vaults one at a time when the
|
||||
// archive endpoint refuses them outright. An admin's delete stands; the empty team is left for
|
||||
// the owner, who can archive it or make a vault in it.
|
||||
if (orphaned is not null
|
||||
&& (await teams.ResolveAsync(user.Id, orphaned.Id, ct).ConfigureAwait(false)).IsOwner)
|
||||
{
|
||||
await teams.ArchiveAsync(user, orphaned, ct).ConfigureAwait(false);
|
||||
}
|
||||
|
||||
@@ -55,6 +55,7 @@ builder.Services.AddDodoRelay();
|
||||
// Scoped rather than the AddAuthorization default of singleton: the handler reads the request's
|
||||
// DbContext, and a singleton would capture one for the lifetime of the process.
|
||||
builder.Services.AddScoped<IAuthorizationHandler, EnrolledHandler>();
|
||||
builder.Services.AddScoped<IAuthorizationHandler, ActiveAccountHandler>();
|
||||
|
||||
// Replaces the framework default, which is also registered as a singleton. Last registration wins.
|
||||
builder.Services.AddSingleton<IAuthorizationMiddlewareResultHandler, DodoAuthorizationResultHandler>();
|
||||
|
||||
@@ -62,7 +62,14 @@ internal static class Auth
|
||||
|
||||
private static void AddDodoPolicies(AuthorizationOptions options)
|
||||
{
|
||||
options.AddPolicy(AuthenticatedPolicy, policy => policy.RequireAuthenticatedUser());
|
||||
// Both policies also require the account to be active. A suspended or deprovisioned account still
|
||||
// holds a token the identity provider will vouch for until it expires — the status is this server's
|
||||
// own decision, so it is this server that has to refuse. See ActiveAccountHandler.
|
||||
options.AddPolicy(
|
||||
AuthenticatedPolicy,
|
||||
policy => policy
|
||||
.RequireAuthenticatedUser()
|
||||
.AddRequirements(new Authorization.ActiveAccountRequirement()));
|
||||
|
||||
// Enrollment state lives in the database, so this is satisfied by EnrolledHandler.
|
||||
// An unmet EnrolledRequirement is rewritten into a ProblemDetails carrying
|
||||
@@ -72,7 +79,7 @@ internal static class Auth
|
||||
EnrolledPolicy,
|
||||
policy => policy
|
||||
.RequireAuthenticatedUser()
|
||||
.AddRequirements(new Authorization.EnrolledRequirement()));
|
||||
.AddRequirements(new Authorization.ActiveAccountRequirement(), new Authorization.EnrolledRequirement()));
|
||||
|
||||
// Deny by default: an endpoint without an explicit policy still requires a caller.
|
||||
options.FallbackPolicy = options.GetPolicy(AuthenticatedPolicy);
|
||||
|
||||
@@ -132,7 +132,8 @@ public sealed partial class DodoSshApp : Avalonia.Application
|
||||
var keepAlive = new SessionKeepAlive(
|
||||
workspace,
|
||||
activeTransfers: () => viewModel.Transfers.ActiveTransfers,
|
||||
holdsFileSession: () => viewModel.Transfers.HasLiveFileSession);
|
||||
holdsFileSession: () => viewModel.Transfers.HasLiveFileSession,
|
||||
listeningForwards: () => viewModel.ListeningForwardCount);
|
||||
|
||||
// The other end of the same wire: the workspace announces its own sessions ending, and the queue
|
||||
// announces transfers appearing and finishing, and a Files session connecting or disconnecting.
|
||||
@@ -148,6 +149,11 @@ public sealed partial class DodoSshApp : Avalonia.Application
|
||||
// in the first place, which was precisely the promise this whole arrangement exists to keep.
|
||||
viewModel.TerminalSessionOpened += (_, _) => keepAlive.Refresh();
|
||||
|
||||
// A forward starting, stopping or failing changes the notification's wording and nothing else — it
|
||||
// rides a shell's connection, so the shell is already what holds the service up. The user is still
|
||||
// entitled to know a phone in their pocket is holding ports open.
|
||||
viewModel.ForwardsChanged += (_, _) => keepAlive.Refresh();
|
||||
|
||||
keepAlive.Refresh();
|
||||
}
|
||||
|
||||
|
||||
@@ -141,6 +141,11 @@ internal sealed class SessionForegroundService : Service
|
||||
/// <param name="liveSessions">Shells with a live channel behind them.</param>
|
||||
/// <param name="activeTransfers">Transfers still moving bytes.</param>
|
||||
/// <param name="holdsFileSession">Whether the Files screen holds a live, idle SFTP connection.</param>
|
||||
/// <param name="listeningForwards">
|
||||
/// Port forwards listening over those shells. Named in the summary and nothing else: a forward rides a
|
||||
/// shell's connection, so it cannot be the reason the process has to stay up — see
|
||||
/// <see cref="SessionKeepAlive"/>.
|
||||
/// </param>
|
||||
/// <remarks>
|
||||
/// Three outcomes, not the two a plain start-or-stop would have. Nothing live stops the service, as
|
||||
/// always. Something live and the service not yet running starts it. Something live and the service
|
||||
@@ -152,7 +157,7 @@ internal sealed class SessionForegroundService : Service
|
||||
/// which needs no foreground-start permission at all. A foregrounded refresh still prefers a real
|
||||
/// start even over a service that looks like it is running; the inline remark below is why.
|
||||
/// </remarks>
|
||||
public static void Reconcile(int liveSessions, int activeTransfers, bool holdsFileSession)
|
||||
public static void Reconcile(int liveSessions, int activeTransfers, bool holdsFileSession, int listeningForwards)
|
||||
{
|
||||
var context = PhoneEnvironment.Require();
|
||||
|
||||
@@ -165,7 +170,7 @@ internal sealed class SessionForegroundService : Service
|
||||
|
||||
// The summary says what is actually held, counted rather than generic — the same principle the
|
||||
// delete confirmations follow. "DodoSSH is running" would tell the user nothing they could act on.
|
||||
var summary = Summarise(liveSessions, activeTransfers, holdsFileSession);
|
||||
var summary = Summarise(liveSessions, activeTransfers, holdsFileSession, listeningForwards);
|
||||
|
||||
// In-place only while backgrounded, where it is the only legal move. Foregrounded, a real start is
|
||||
// always allowed and is preferred even when `running` says the service is up: a disconnect followed
|
||||
@@ -255,15 +260,22 @@ internal sealed class SessionForegroundService : Service
|
||||
activity.RequestPermissions([postNotifications], NotificationPermissionRequestCode));
|
||||
}
|
||||
|
||||
private static string Summarise(int liveSessions, int activeTransfers, bool holdsFileSession)
|
||||
private static string Summarise(int liveSessions, int activeTransfers, bool holdsFileSession, int listeningForwards)
|
||||
{
|
||||
var parts = new List<string>(3);
|
||||
var parts = new List<string>(4);
|
||||
|
||||
if (liveSessions > 0)
|
||||
{
|
||||
parts.Add(liveSessions == 1 ? "1 shell connected" : $"{liveSessions} shells connected");
|
||||
}
|
||||
|
||||
// Beside the shells they run over, and only while one is: a count left over from a session that has
|
||||
// just ended would be a receipt for ports nothing holds open any more.
|
||||
if (liveSessions > 0 && listeningForwards > 0)
|
||||
{
|
||||
parts.Add(listeningForwards == 1 ? "1 port forwarded" : $"{listeningForwards} ports forwarded");
|
||||
}
|
||||
|
||||
if (holdsFileSession)
|
||||
{
|
||||
parts.Add("Files connected");
|
||||
|
||||
@@ -24,12 +24,20 @@ namespace DodoSSH.Client.Android.Platform;
|
||||
/// looked, to this class, exactly like nothing being open at all. <c>holdsFileSession</c> below is that
|
||||
/// gap closed, read the same way the other two facts are: asked, not cached.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Listening port forwards are a fourth fact, and a different kind: they only change what the notification
|
||||
/// says. A forward runs over a shell's connection and stops with it, so there is never a listening forward
|
||||
/// without a live shell already holding the service up — and a count that could start the service on its own
|
||||
/// would only ever be wrong, in the moment a forward's Stopped had not been heard yet. What they add is the
|
||||
/// receipt: the user is entitled to know the phone is holding ports open, as well as shells.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal sealed class SessionKeepAlive : IDisposable
|
||||
{
|
||||
private readonly TerminalWorkspace workspace;
|
||||
private readonly Func<int> activeTransfers;
|
||||
private readonly Func<bool> holdsFileSession;
|
||||
private readonly Func<int> listeningForwards;
|
||||
|
||||
/// <param name="workspace">The live shells.</param>
|
||||
/// <param name="activeTransfers">
|
||||
@@ -40,11 +48,20 @@ internal sealed class SessionKeepAlive : IDisposable
|
||||
/// Whether the Files screen holds a live SFTP connection with nothing moving on it — the idle-but-
|
||||
/// connected case a transfer count alone would miss. See <c>TransfersViewModel.HasLiveFileSession</c>.
|
||||
/// </param>
|
||||
public SessionKeepAlive(TerminalWorkspace workspace, Func<int> activeTransfers, Func<bool> holdsFileSession)
|
||||
/// <param name="listeningForwards">
|
||||
/// How many port forwards are listening, across every tab. For the notification's wording only; see the
|
||||
/// class remarks. See <c>MainWindowViewModel.ListeningForwardCount</c>.
|
||||
/// </param>
|
||||
public SessionKeepAlive(
|
||||
TerminalWorkspace workspace,
|
||||
Func<int> activeTransfers,
|
||||
Func<bool> holdsFileSession,
|
||||
Func<int> listeningForwards)
|
||||
{
|
||||
this.workspace = workspace;
|
||||
this.activeTransfers = activeTransfers;
|
||||
this.holdsFileSession = holdsFileSession;
|
||||
this.listeningForwards = listeningForwards;
|
||||
|
||||
// Raised on whatever thread the workspace announced from — a continuation of the ended run, or the
|
||||
// closer's own — which is fine: starting and stopping a service is a binder call and needs no
|
||||
@@ -56,14 +73,15 @@ internal sealed class SessionKeepAlive : IDisposable
|
||||
|
||||
/// <summary>Re-reads the counts and starts or stops the service to match.</summary>
|
||||
/// <remarks>
|
||||
/// Called after anything that could change any of the three facts — opening a shell, closing a tab, a
|
||||
/// transfer finishing, a Files connection opening or closing. Calling it when nothing changed is free:
|
||||
/// Called after anything that could change any of the facts — opening a shell, closing a tab, a transfer
|
||||
/// finishing, a Files connection opening or closing, a forward starting or stopping. Calling it when nothing changed is free:
|
||||
/// reconciling to the state it is already in is either a redundant <c>startForegroundService</c> — or,
|
||||
/// now, a redundant notification post — on a running service, or a <c>stopService</c> on a stopped one,
|
||||
/// and Android treats all of those as no-ops.
|
||||
/// </remarks>
|
||||
public void Refresh() =>
|
||||
SessionForegroundService.Reconcile(workspace.LiveSessionCount, activeTransfers(), holdsFileSession());
|
||||
SessionForegroundService.Reconcile(
|
||||
workspace.LiveSessionCount, activeTransfers(), holdsFileSession(), listeningForwards());
|
||||
|
||||
/// <inheritdoc />
|
||||
public void Dispose()
|
||||
@@ -72,7 +90,7 @@ internal sealed class SessionKeepAlive : IDisposable
|
||||
|
||||
// The notification goes with the composition root. Leaving it up over a process that is shutting
|
||||
// down is how an SSH client acquires a reputation for a notification you cannot get rid of.
|
||||
SessionForegroundService.Reconcile(0, 0, false);
|
||||
SessionForegroundService.Reconcile(0, 0, false, 0);
|
||||
}
|
||||
|
||||
private void OnSessionEnded(object? sender, TerminalSessionEndedEventArgs e) => Refresh();
|
||||
|
||||
@@ -1002,7 +1002,8 @@
|
||||
FormatString="0" ShowButtonSpinner="False" MinHeight="44"
|
||||
PlaceholderText="{Binding EditorPortPlaceholder}" />
|
||||
<TextBox Grid.Column="2" Classes="field" Text="{Binding EditorUsername}"
|
||||
PlaceholderText="{Binding EditorUsernamePlaceholder}" />
|
||||
PlaceholderText="{Binding EditorUsernamePlaceholder}"
|
||||
IsEnabled="{Binding EditorAsksForLogin}" />
|
||||
</Grid>
|
||||
|
||||
<TextBox Classes="field" Text="{Binding EditorNotes}" PlaceholderText="notes" />
|
||||
@@ -1016,6 +1017,7 @@
|
||||
<TextBlock Classes="label" Text="AUTHENTICATION" Margin="0,4,0,0" />
|
||||
<ComboBox ItemsSource="{Binding EditorAuthenticationChoices}"
|
||||
SelectedItem="{Binding EditorSelectedAuthentication}"
|
||||
IsEnabled="{Binding EditorAsksForLogin}"
|
||||
HorizontalAlignment="Stretch" MinHeight="44">
|
||||
<ComboBox.ItemTemplate>
|
||||
<DataTemplate x:DataType="vm:AuthenticationChoice">
|
||||
@@ -1028,6 +1030,9 @@
|
||||
</DataTemplate>
|
||||
</ComboBox.ItemTemplate>
|
||||
</ComboBox>
|
||||
<!-- Why the login is greyed out, as on the desktop. See VaultViewModel.EditorAsksForLogin. -->
|
||||
<TextBlock Classes="detail" TextWrapping="Wrap" IsVisible="{Binding !EditorAsksForLogin}"
|
||||
Text="Spelunk signs you in to this host, so it needs no username, SSH key or password." />
|
||||
|
||||
<!--
|
||||
Making a credential without leaving the host, as on the desktop and on the same reasoning: the
|
||||
@@ -1212,6 +1217,41 @@
|
||||
<TextBlock Classes="body"
|
||||
Text="The server dials this host on your behalf, for a machine this phone cannot reach — so the server has to be able to reach it. That is why the address and port are stored on the server in the clear; everything else about the host stays encrypted. A relayed host needs a port of its own rather than its group's, and connects only while you are online." />
|
||||
|
||||
<!--
|
||||
The relay's alternative, and the desktop drawer's Spelunk card in this head's controls: ticking
|
||||
one unticks the other. The key is a keychain credential chosen here, never typed here. See
|
||||
VaultViewModel.Spelunk.cs.
|
||||
-->
|
||||
<CheckBox IsChecked="{Binding EditorThroughSpelunk}" MinHeight="44">
|
||||
<TextBlock Classes="mono" FontSize="11.5"
|
||||
Text="Reach this host through Spelunk"
|
||||
TextWrapping="Wrap" />
|
||||
</CheckBox>
|
||||
<StackPanel Spacing="8" IsVisible="{Binding EditorThroughSpelunk}">
|
||||
<TextBox Classes="field" Text="{Binding EditorSpelunkApi}"
|
||||
PlaceholderText="Spelunk API address (https://api.…)" />
|
||||
<TextBox Classes="field" Text="{Binding EditorSpelunkServerId}"
|
||||
PlaceholderText="Spelunk server id" />
|
||||
<TextBlock Classes="detail" Text="Spelunk API key" />
|
||||
<ComboBox ItemsSource="{Binding EditorSpelunkKeyChoices}"
|
||||
SelectedItem="{Binding EditorSelectedSpelunkKey}"
|
||||
HorizontalAlignment="Stretch" MinHeight="44">
|
||||
<ComboBox.ItemTemplate>
|
||||
<DataTemplate x:DataType="vm:AuthenticationChoice">
|
||||
<TextBlock Classes="mono" FontSize="12" Text="{Binding Label}" />
|
||||
</DataTemplate>
|
||||
</ComboBox.ItemTemplate>
|
||||
</ComboBox>
|
||||
<!-- The desktop card's sign-in box. See SpelunkRoute.SignInThroughSpelunk. -->
|
||||
<CheckBox IsChecked="{Binding EditorSpelunkSignIn}" MinHeight="44">
|
||||
<TextBlock Classes="mono" FontSize="11.5"
|
||||
Text="Sign in through Spelunk (no SSH key needed)"
|
||||
TextWrapping="Wrap" />
|
||||
</CheckBox>
|
||||
</StackPanel>
|
||||
<TextBlock Classes="body"
|
||||
Text="Spelunk's agent on the server connects to its SSH server for you, so the server needs no open SSH port. Choose a Spelunk API key (Admin role) saved from the desktop's Settings → Security, or a credential whose password is the key; it is sent only to the address above. Signing in through Spelunk logs you in as the account Spelunk names, with a key made for each connection and never kept. Connects only while Spelunk and its agent are reachable." />
|
||||
|
||||
<!--
|
||||
This page covers the whole screen while it is open, which is why it needs a Status line of its
|
||||
own rather than relying on the one the list behind it draws at the top of HOSTS (see this file's
|
||||
|
||||
@@ -189,14 +189,18 @@
|
||||
◆ Port forwarding, stated rather than drawn.
|
||||
|
||||
The v2 design gives this hub a sixth entry and a full screen behind it: local, remote and dynamic
|
||||
rules with toggles and byte counters. Nothing in this application forwards anything — ISshConnection
|
||||
offers OpenShellAsync and nothing else — so every switch on that screen would be a control with no
|
||||
effect and every counter a number with no source.
|
||||
rules with toggles and byte counters. Forwarding is built and runs here as on the desktop — a host's
|
||||
forwards start with every terminal opened to it — but it is not a destination, so it has no row. A
|
||||
forward belongs to a host and runs with a session, and on this head the session's forwards are a
|
||||
sheet off the terminal's bar: the ⇄ button, drawn for a tab that has some, lists them with a switch
|
||||
each. See MainWindowViewModel.IsForwardsSheetOpen.
|
||||
|
||||
What the phone lacks is the editor: its host form has no PORT FORWARDS section yet, so forwards are
|
||||
added on the desktop and arrive here with the host. The byte counters are not built anywhere;
|
||||
SSH.NET keeps no count to draw.
|
||||
|
||||
It is a paragraph here rather than a missing row for the reason the desktop keeps TEAMS in its rail:
|
||||
a destination that is quietly absent reads as a product that never intended it, and this one is
|
||||
intended. SyncEntityType.PortForward = 9 is reserved on the wire and unused. See
|
||||
docs/design-import-gaps.md.
|
||||
a place somebody looks for a feature should say where it went. See docs/design-import-gaps.md.
|
||||
-->
|
||||
<Border Classes="card" Margin="6,16,6,0">
|
||||
<StackPanel Spacing="7">
|
||||
@@ -206,11 +210,11 @@
|
||||
<TextBlock Classes="mono" FontSize="13.5" FontWeight="SemiBold"
|
||||
Foreground="{StaticResource TextDim}" Text="Port forwarding" />
|
||||
<Border Classes="tag outline" VerticalAlignment="Center">
|
||||
<TextBlock Text="NOT BUILT" />
|
||||
<TextBlock Text="IN THE TERMINAL" />
|
||||
</Border>
|
||||
</StackPanel>
|
||||
<TextBlock Classes="body"
|
||||
Text="A connection here opens one channel — a shell — and nothing else, so there is no tunnel for a rule to run through. The wire protocol reserves a slot for forwarding rules and no client writes one. Nothing on this screen is hidden by a setting; the feature is absent." />
|
||||
Text="Forwards saved on a host start with every terminal opened to it, here as on the desktop. The ⇄ button in the terminal's bar lists them, with a switch each and the reason one could not start. They are added and edited in the desktop app's host editor; this phone runs them but has no editor for them yet." />
|
||||
</StackPanel>
|
||||
</Border>
|
||||
|
||||
|
||||
@@ -579,7 +579,7 @@ internal sealed partial class PhoneShell : UserControl
|
||||
/// <para>
|
||||
/// <b>The connect menu is a second such guard, and it matters more than the first.</b> A terminal now
|
||||
/// fills the screen — no header, no bottom bar — so while that menu is up this gesture is the only way
|
||||
/// off it other than the scrim and CANCEL. It is checked before the terminal is dismissed for the
|
||||
/// off it other than the scrim and CANCEL. The forwards sheet, raised from the same bar, shares the guard. It is checked before the terminal is dismissed for the
|
||||
/// reason it is drawn over it: back takes the topmost thing, and dismissing the surface underneath a
|
||||
/// menu would take two, neither of them the one being looked at.
|
||||
/// </para>
|
||||
@@ -598,13 +598,12 @@ internal sealed partial class PhoneShell : UserControl
|
||||
return;
|
||||
}
|
||||
|
||||
// The connect menu, which is raised from the terminal's own bar and is the topmost thing the phone
|
||||
// draws while it is up. Ahead of the editors below because it is nearer, and ahead of leaving the
|
||||
// terminal because a gesture that dismissed the surface underneath a menu would close two things at
|
||||
// once — and the one the user was looking at would not be either of them.
|
||||
if (current.IsConnectSheetOpen)
|
||||
// The connect menu or the forwards sheet, which are raised from the terminal's own bar and are the
|
||||
// topmost thing the phone draws while one is up. Ahead of the editors below because they are nearer,
|
||||
// and ahead of leaving the terminal because a gesture that dismissed the surface underneath a sheet
|
||||
// would close two things at once — and the one the user was looking at would not be either of them.
|
||||
if (TryCloseATerminalSheet(current))
|
||||
{
|
||||
current.CloseConnectSheetCommand.Execute(null);
|
||||
e.Handled = true;
|
||||
return;
|
||||
}
|
||||
@@ -647,6 +646,31 @@ internal sealed partial class PhoneShell : UserControl
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Lowers the connect menu or the forwards sheet, whichever is up over the terminal.
|
||||
/// </summary>
|
||||
/// <returns>Whether one was closed, and so whether back has been spent.</returns>
|
||||
/// <remarks>
|
||||
/// Both are raised from the terminal's bar and the scrim under each covers that bar, so at most one is
|
||||
/// ever open; the order below decides nothing.
|
||||
/// </remarks>
|
||||
private static bool TryCloseATerminalSheet(MainWindowViewModel current)
|
||||
{
|
||||
if (current.IsConnectSheetOpen)
|
||||
{
|
||||
current.CloseConnectSheetCommand.Execute(null);
|
||||
return true;
|
||||
}
|
||||
|
||||
if (current.IsForwardsSheetOpen)
|
||||
{
|
||||
current.CloseForwardsSheetCommand.Execute(null);
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Lowers whatever the hosts screen has raised over its list, topmost first.
|
||||
/// </summary>
|
||||
|
||||
@@ -110,6 +110,34 @@
|
||||
<Setter Property="Foreground" Value="{StaticResource Danger}" />
|
||||
</Style>
|
||||
|
||||
<!--
|
||||
── the forwards ──────────────────────────────────────────────────────────────────────────────────────
|
||||
The desktop sidebar's state word, in the same three colours: green only while listening, the danger
|
||||
text colour for a forward that could not start, faint for OFF and STARTING. The bar's ⇄ follows the
|
||||
same rule for the failed case and is otherwise the colour of the icons beside it. Mono and 9.5, which
|
||||
is this head's label lettering rather than the desktop's Montserrat, and its own family for the reason
|
||||
the step captions above give.
|
||||
-->
|
||||
<Style Selector="TextBlock.fwdstate">
|
||||
<Setter Property="Foreground" Value="{StaticResource TextFaint}" />
|
||||
<Setter Property="FontFamily" Value="{StaticResource MonoFont}" />
|
||||
<Setter Property="FontWeight" Value="SemiBold" />
|
||||
<Setter Property="FontSize" Value="9.5" />
|
||||
<Setter Property="VerticalAlignment" Value="Center" />
|
||||
</Style>
|
||||
<Style Selector="TextBlock.fwdstate.live">
|
||||
<Setter Property="Foreground" Value="{StaticResource Live}" />
|
||||
</Style>
|
||||
<Style Selector="TextBlock.fwdstate.failed">
|
||||
<Setter Property="Foreground" Value="{StaticResource DangerText}" />
|
||||
</Style>
|
||||
<Style Selector="TextBlock.fwdglyph">
|
||||
<Setter Property="Foreground" Value="{StaticResource TextDim}" />
|
||||
</Style>
|
||||
<Style Selector="TextBlock.fwdglyph.failed">
|
||||
<Setter Property="Foreground" Value="{StaticResource DangerText}" />
|
||||
</Style>
|
||||
|
||||
</UserControl.Styles>
|
||||
|
||||
<Panel>
|
||||
@@ -139,7 +167,7 @@
|
||||
job — see the remark on the header in PhoneShell.axaml. -->
|
||||
<Border Grid.Row="0" Height="35" Background="{StaticResource DeepChrome}"
|
||||
BorderBrush="{StaticResource Border}" BorderThickness="0,0,0,1">
|
||||
<Grid ColumnDefinitions="Auto,*,Auto">
|
||||
<Grid ColumnDefinitions="Auto,*,Auto,Auto">
|
||||
|
||||
<!--
|
||||
Back, and it goes to the page this terminal was opened over rather than to Hosts by name. The
|
||||
@@ -244,10 +272,37 @@
|
||||
HOSTS, which is the only action on its screen; this one is not.
|
||||
|
||||
Click as well as Command, and the handler does one thing the command cannot: put the software
|
||||
keyboard away. See OnConnectMenuRequested.
|
||||
keyboard away. See OnSheetRequested.
|
||||
-->
|
||||
<Button Grid.Column="2" Classes="icon" Content="+" Height="34" Margin="0,0,4,0"
|
||||
Click="OnConnectMenuRequested"
|
||||
<!--
|
||||
The selected tab's forwards, which is what lets this head start them at all: a phone opening
|
||||
listeners it never shows you is worse than one opening none. Drawn only for a tab that has some, so
|
||||
a host without forwards pays nothing for the feature in a 35-pixel bar.
|
||||
|
||||
The count beside the arrows is the listening ones, in the green that means "running" everywhere
|
||||
else; the arrows themselves turn the danger colour when one could not start. The desktop can leave a
|
||||
refusal in its sidebar for the eye to find, because the sidebar is always drawn. The sheet this opens
|
||||
is not, so the button has to say it first.
|
||||
|
||||
Outside the ScrollViewer with +, for the reason both ends are: a tenth tab must not push it away.
|
||||
Width is not pinned to Button.icon's 44, because "⇄ 12" is wider than that; 44 is its minimum.
|
||||
-->
|
||||
<Button Grid.Column="2" Classes="icon" Height="34" Width="NaN" MinWidth="44" Padding="8,0"
|
||||
Click="OnSheetRequested"
|
||||
Command="{Binding OpenForwardsSheetCommand}"
|
||||
IsVisible="{Binding SelectedTab.HasForwards, FallbackValue=False}">
|
||||
<StackPanel Orientation="Horizontal" Spacing="5" VerticalAlignment="Center">
|
||||
<TextBlock Classes="fwdglyph" Classes.failed="{Binding SelectedTab.HasFailedForward, FallbackValue=False}"
|
||||
Text="⇄" FontSize="16" VerticalAlignment="Center" />
|
||||
<TextBlock Classes="mono" FontSize="12" FontWeight="SemiBold" Foreground="{StaticResource Live}"
|
||||
VerticalAlignment="Center"
|
||||
Text="{Binding SelectedTab.ListeningForwardCount, FallbackValue=''}"
|
||||
IsVisible="{Binding SelectedTab.HasListeningForward, FallbackValue=False}" />
|
||||
</StackPanel>
|
||||
</Button>
|
||||
|
||||
<Button Grid.Column="3" Classes="icon" Content="+" Height="34" Margin="0,0,4,0"
|
||||
Click="OnSheetRequested"
|
||||
Command="{Binding OpenConnectSheetCommand}" />
|
||||
</Grid>
|
||||
</Border>
|
||||
@@ -742,6 +797,75 @@
|
||||
</Border>
|
||||
</Panel>
|
||||
|
||||
<!-- ============ the forwards sheet ============ -->
|
||||
<!--
|
||||
The desktop sidebar's FORWARDS section, as a sheet: the selected tab's forwards as they run over its
|
||||
session, bound to the same rows. Each row is its own switch, as there — tap a listening one to stop it,
|
||||
an off or failed one to start it, a failed one being a retry because the port may have been freed.
|
||||
|
||||
The route is written under the notation rather than left to a tooltip, which is where the desktop
|
||||
keeps it: a phone has no hover, and which end each port is on is exactly what people get backwards
|
||||
about -L and -R. The reason a row failed sits under that again, as the desktop draws it.
|
||||
|
||||
The same shape as the connect sheet above, raised from the bar the same way, collapsing the renderer
|
||||
the same way — see MainWindowViewModel.IsForwardsSheetOpen. It scrolls, capped at most of the display,
|
||||
because a host may carry more forwards than fit, and a sheet that grew past the top of the screen would
|
||||
put its own title out of reach.
|
||||
|
||||
Nothing here edits a forward, and there is no add row: this head's host editor has no PORT FORWARDS
|
||||
section yet, and the desktop's Add forward row leads to one. The footer says where they are edited.
|
||||
-->
|
||||
<Panel IsVisible="{Binding IsForwardsSheetOpen}">
|
||||
|
||||
<Button Classes="scrim" Command="{Binding CloseForwardsSheetCommand}" />
|
||||
|
||||
<Border VerticalAlignment="Bottom" Background="{StaticResource Panel}"
|
||||
BorderBrush="{StaticResource BorderMid}" BorderThickness="0,1,0,0"
|
||||
CornerRadius="22,22,0,0" Padding="20,18,20,16">
|
||||
<StackPanel Spacing="0">
|
||||
|
||||
<Border Width="38" Height="4" CornerRadius="2" Background="{StaticResource BorderMid}"
|
||||
HorizontalAlignment="Center" Margin="0,0,0,16" />
|
||||
|
||||
<TextBlock Classes="title" Text="FORWARDS" FontSize="13" />
|
||||
<TextBlock Classes="detail" FontSize="10.5" Margin="0,3,0,0"
|
||||
Text="{Binding SelectedTab.Label, FallbackValue=''}" />
|
||||
|
||||
<ScrollViewer Margin="0,10,0,0" MaxHeight="420" HorizontalScrollBarVisibility="Disabled">
|
||||
<ItemsControl ItemsSource="{Binding SelectedTab.Forwards}">
|
||||
<ItemsControl.ItemTemplate>
|
||||
<DataTemplate x:DataType="vm:PortForwardViewModel">
|
||||
<Button Classes="row" Padding="12,8" Command="{Binding ToggleCommand}">
|
||||
<Grid ColumnDefinitions="*,Auto">
|
||||
<StackPanel Grid.Column="0" Spacing="3" VerticalAlignment="Center">
|
||||
<TextBlock Classes="mono" FontSize="13.5" FontWeight="SemiBold"
|
||||
Text="{Binding Notation}" TextTrimming="CharacterEllipsis" />
|
||||
<TextBlock Classes="detail" FontSize="10.5" TextWrapping="Wrap"
|
||||
Text="{Binding Route}" />
|
||||
<TextBlock Classes="detail" FontSize="10.5" TextWrapping="Wrap"
|
||||
Foreground="{StaticResource TextDim}" Text="{Binding Detail}"
|
||||
IsVisible="{Binding Detail, Converter={x:Static StringConverters.IsNotNullOrEmpty}}" />
|
||||
</StackPanel>
|
||||
<TextBlock Grid.Column="1" Classes="fwdstate" Margin="12,0,0,0"
|
||||
Text="{Binding StateText}"
|
||||
Classes.live="{Binding IsListening}" Classes.failed="{Binding IsFailed}" />
|
||||
</Grid>
|
||||
</Button>
|
||||
</DataTemplate>
|
||||
</ItemsControl.ItemTemplate>
|
||||
</ItemsControl>
|
||||
</ScrollViewer>
|
||||
|
||||
<TextBlock Classes="body" Margin="0,10,0,0"
|
||||
Text="Tap a forward to switch it off or on. Local and SOCKS forwards listen on this phone's localhost, where any app on it can connect, and every forward stops with this tab's connection. Forwards are saved on the host and edited in the desktop app; a change starts with the next connection." />
|
||||
|
||||
<Button Classes="secondary" Content="DONE" Margin="0,12,0,0"
|
||||
Command="{Binding CloseForwardsSheetCommand}" />
|
||||
|
||||
</StackPanel>
|
||||
</Border>
|
||||
</Panel>
|
||||
|
||||
</Panel>
|
||||
|
||||
</UserControl>
|
||||
@@ -210,10 +210,14 @@ internal sealed partial class TerminalScreen : UserControl
|
||||
private void AdoptRenderer() => RendererFocus.Suppress(input.Acquire);
|
||||
|
||||
/// <summary>
|
||||
/// Puts the keyboard away on the way to the connect menu.
|
||||
/// Puts the keyboard away on the way to the connect menu or the forwards sheet.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// One handler for both buttons in the terminal's bar that raise a sheet, since what follows is true of
|
||||
/// either: each is a panel at the bottom of the screen, which is where the keyboard is.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// A handler beside the button's command rather than something the command does, because the command is
|
||||
/// on the shared view model and this is a platform call: the desktop head has no software keyboard to
|
||||
/// put away, and a shell view model that knew about Android's input-method manager would be the first
|
||||
@@ -222,7 +226,7 @@ internal sealed partial class TerminalScreen : UserControl
|
||||
/// <para>
|
||||
/// <b>The keyboard is up in the ordinary case.</b> This button sits above a terminal somebody is typing
|
||||
/// into, so the sheet it raises would otherwise arrive underneath a keyboard covering half the display —
|
||||
/// and the three rows on it are the bottom half. Worse, the keyboard's inset shortens everything the
|
||||
/// and the rows on it are the bottom half. Worse, the keyboard's inset shortens everything the
|
||||
/// phone draws (see <c>PhoneShell.ApplyKeyboardInset</c>), so the sheet would be laid out into the
|
||||
/// remaining strip rather than merely hidden behind it.
|
||||
/// </para>
|
||||
@@ -231,7 +235,7 @@ internal sealed partial class TerminalScreen : UserControl
|
||||
/// what the other writes: this one talks to the platform and the command sets a flag, so they commute.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private void OnConnectMenuRequested(object? sender, RoutedEventArgs e) => SoftKeyboard.Hide();
|
||||
private void OnSheetRequested(object? sender, RoutedEventArgs e) => SoftKeyboard.Hide();
|
||||
|
||||
/// <summary>
|
||||
/// Takes the browser gestures back off a surface that is not a web page.
|
||||
|
||||
@@ -26,6 +26,20 @@ namespace DodoSSH.Client.App;
|
||||
/// </remarks>
|
||||
internal sealed partial class DodoSshApp : Application
|
||||
{
|
||||
/// <summary>
|
||||
/// Where a <c>dodossh://</c> link goes once the shell exists; null until then.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Links can arrive before there is anything to hand them to — macOS delivers the one an application was
|
||||
/// opened with as an event shortly after launch, which may be while the splash is still up — so until
|
||||
/// <see cref="Compose"/> sets this, the latest is kept in <see cref="waitingLink"/>. Both are touched on
|
||||
/// the UI thread only.
|
||||
/// </remarks>
|
||||
private static Action<SpelunkLink>? openLink;
|
||||
|
||||
/// <summary>A link that arrived before <see cref="openLink"/> was set. See there.</summary>
|
||||
private static SpelunkLink? waitingLink;
|
||||
|
||||
/// <inheritdoc />
|
||||
public override void Initialize() => AvaloniaXamlLoader.Load(this);
|
||||
|
||||
@@ -34,12 +48,59 @@ internal sealed partial class DodoSshApp : Application
|
||||
{
|
||||
if (ApplicationLifetime is IClassicDesktopStyleApplicationLifetime desktop)
|
||||
{
|
||||
ListenForOpenedLinks();
|
||||
ShowSomethingWhileComposing(desktop);
|
||||
}
|
||||
|
||||
base.OnFrameworkInitializationCompleted();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Takes the links the platform hands a running application, which on macOS is every link.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Windows and Linux start the executable with the link as an argument, and <c>Program.Main</c> reads it
|
||||
/// there — or passes it to the instance already running. macOS does neither: Launch Services sends the
|
||||
/// running application, or the one it has just started, an "open URL" event, which Avalonia raises as an
|
||||
/// activation. The scheme is declared for it in build/macos's Info.plist template.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Checked exactly as a launch argument is, by <see cref="SpelunkLink.TryParse"/>; anything else is
|
||||
/// ignored. Where the lifetime offers no activation at all this does nothing, which is the answer on the
|
||||
/// desktops that deliver links as arguments instead.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private void ListenForOpenedLinks()
|
||||
{
|
||||
if (TryGetFeature(typeof(IActivatableLifetime)) is not IActivatableLifetime activatable)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
activatable.Activated += (_, e) =>
|
||||
{
|
||||
if (e is ProtocolActivatedEventArgs { Kind: ActivationKind.OpenUri, Uri: { } uri }
|
||||
&& SpelunkLink.TryParse(uri.OriginalString, out var link))
|
||||
{
|
||||
Avalonia.Threading.Dispatcher.UIThread.Post(() => Receive(link));
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>Hands a link to the shell, or keeps it until there is one. UI thread only.</summary>
|
||||
private static void Receive(SpelunkLink link)
|
||||
{
|
||||
if (openLink is { } open)
|
||||
{
|
||||
open(link);
|
||||
}
|
||||
else
|
||||
{
|
||||
waitingLink = link;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Puts a window on screen first, and composes the application behind it.
|
||||
/// </summary>
|
||||
@@ -206,9 +267,20 @@ internal sealed partial class DodoSshApp : Application
|
||||
// The other half of Program's claim on this profile: a second launch was refused, and this is what
|
||||
// answers it. Posted onto the UI thread because a pipe accept completes on a thread pool thread and
|
||||
// a window may only be touched from the thread that owns it — see SingleInstance.Listen.
|
||||
// A second launch's dodossh:// link comes the same way as this launch's own and macOS's: through
|
||||
// Receive on the UI thread, then MainWindowViewModel.OpenLink, which holds it until a vault is open.
|
||||
var others = SingleInstance.Listen(
|
||||
paths,
|
||||
() => Avalonia.Threading.Dispatcher.UIThread.Post(() => BringToFront(desktop.MainWindow)));
|
||||
() => Avalonia.Threading.Dispatcher.UIThread.Post(() => BringToFront(desktop.MainWindow)),
|
||||
link => Avalonia.Threading.Dispatcher.UIThread.Post(() => Receive(link)));
|
||||
|
||||
openLink = viewModel.OpenLink;
|
||||
|
||||
if ((waitingLink ?? Program.LaunchLink) is { } first)
|
||||
{
|
||||
waitingLink = null;
|
||||
viewModel.OpenLink(first);
|
||||
}
|
||||
|
||||
// Started rather than awaited: the framework's initialisation must not block on a schema
|
||||
// migration. The view model shows its own progress and handles its own failures, which is why
|
||||
@@ -280,39 +352,9 @@ internal sealed partial class DodoSshApp : Application
|
||||
copyToClipboard: ClipboardWriter(desktop),
|
||||
readClipboard: ClipboardReader(desktop),
|
||||
updates: updates,
|
||||
openInEditor: OpenInDefaultEditorAsync,
|
||||
openInEditor: LocalEditor.OpenAsync,
|
||||
watchFile: WatchFile);
|
||||
|
||||
/// <summary>
|
||||
/// Hands a local file to whatever this machine opens that kind of file with.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// One of the two halves of editing a remote file in place, and both are this platform's rather than
|
||||
/// the shell's: what opens a <c>.conf</c> is a registry association, a desktop entry or a Launch
|
||||
/// Services binding depending on which desktop this is, and watching a file is a platform object with
|
||||
/// its own thread. The shell decides <em>when</em>; see <c>TransfersViewModel.EditRemoteAsync</c>.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <c>UseShellExecute</c> is the whole of it, and it is what makes the same three lines work on all
|
||||
/// three desktops: Windows resolves the association, macOS goes through <c>open</c> and Linux through
|
||||
/// <c>xdg-open</c>, each of which .NET reaches for when the flag is set. Without it the path is treated
|
||||
/// as an executable to run, which for a <c>.conf</c> fails and for something else would be worse.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// The process is not waited on and is deliberately not kept: an editor may hand off to an already-open
|
||||
/// instance and exit at once, so its lifetime says nothing about whether the file is still being
|
||||
/// edited. What ends an edit session is the user saying so — see the file browser's STOP EDITING.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private static Task OpenInDefaultEditorAsync(string path)
|
||||
{
|
||||
using var opened = System.Diagnostics.Process.Start(
|
||||
new System.Diagnostics.ProcessStartInfo(path) { UseShellExecute = true });
|
||||
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Watches one file for saves, until the handle is disposed.
|
||||
/// </summary>
|
||||
|
||||
@@ -0,0 +1,48 @@
|
||||
using System.Security.Cryptography;
|
||||
using System.Text;
|
||||
using DodoSSH.Client.Session;
|
||||
|
||||
namespace DodoSSH.Client.App.Platform;
|
||||
|
||||
/// <summary>
|
||||
/// What a platform key store calls the hardware key behind one profile's device unlock.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// ◆ <b>One key per profile, because the key outlives the file and is shared by name.</b> The CNG key and
|
||||
/// the Secure Enclave keychain item are found by name in a store that belongs to the user, not to the
|
||||
/// profile directory. While every profile used the same name, the release build and the nightly — which
|
||||
/// <see cref="ClientPaths.ForChannel"/> keeps apart precisely so neither can damage the other — shared one
|
||||
/// key: signing out of either deleted it, and the other's device unlock silently stopped working.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>The default profile keeps the name it has always had</b>, so an existing install's sealed key still
|
||||
/// opens. Every other profile gets that name with a digest of its directory on the end — a digest rather
|
||||
/// than the directory's own name, because a portable copy can live in any folder and two such folders can
|
||||
/// end in the same name.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal static class DeviceKeyNames
|
||||
{
|
||||
/// <summary>The name of the key behind <paramref name="paths"/>' device unlock.</summary>
|
||||
/// <param name="paths">The profile.</param>
|
||||
/// <param name="legacy">The name every profile used before names were per profile.</param>
|
||||
internal static string For(ClientPaths paths, string legacy)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(paths);
|
||||
|
||||
var directory = Normalise(paths.DataDirectory);
|
||||
|
||||
if (string.Equals(directory, Normalise(ClientPaths.Default.DataDirectory), StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
return legacy;
|
||||
}
|
||||
|
||||
var digest = SHA256.HashData(Encoding.UTF8.GetBytes(directory.ToUpperInvariant()));
|
||||
|
||||
return $"{legacy}.{Convert.ToHexStringLower(digest.AsSpan(0, 8))}";
|
||||
}
|
||||
|
||||
private static string Normalise(string directory) =>
|
||||
Path.TrimEndingDirectorySeparator(Path.GetFullPath(directory));
|
||||
}
|
||||
@@ -0,0 +1,126 @@
|
||||
using System.Diagnostics;
|
||||
|
||||
namespace DodoSSH.Client.App.Platform;
|
||||
|
||||
/// <summary>
|
||||
/// Opens a local copy of a remote file for editing, without running it.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// One of the two halves of editing a remote file in place, and both are this platform's rather than the
|
||||
/// shell's: what opens a <c>.conf</c> is a registry association, a desktop entry or a Launch Services binding
|
||||
/// depending on which desktop this is. The shell decides <em>when</em>; see
|
||||
/// <c>TransfersViewModel.EditRemoteAsync</c>.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// ◆ <b>"Open" is not "edit", and for a file somebody else named the difference is code execution.</b> The
|
||||
/// file comes from a host, and whoever can write to that host chooses its name. Handing <c>deploy.bat</c>,
|
||||
/// <c>notes.hta</c> or <c>run.command</c> to the desktop's default action runs it, on this machine, as this
|
||||
/// user — so a file whose default action is to run is opened with an editor instead. On Windows that is the
|
||||
/// type's own <c>edit</c> verb where it has one (Notepad, for <c>.bat</c>, <c>.cmd</c>, <c>.js</c>,
|
||||
/// <c>.vbs</c>, <c>.ps1</c> and <c>.reg</c>) and Notepad where it has not; on macOS it is <c>open -t</c>,
|
||||
/// which is the default text editor whatever the type. Everything else still goes to its association, which
|
||||
/// is the point of the feature — an <c>nginx.conf</c> should open in whatever this person edits configs with.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Linux is the exception: there is no portable "the text editor", so a <c>.desktop</c> entry — the one type
|
||||
/// <c>xdg-open</c> may launch rather than open — is refused with a sentence instead. A shell script is opened
|
||||
/// by every mainstream desktop's file associations in an editor, not run.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// The process is not waited on and is deliberately not kept: an editor may hand off to an already-open
|
||||
/// instance and exit at once, so its lifetime says nothing about whether the file is still being edited.
|
||||
/// What ends an edit session is the user saying so — see the file browser's STOP EDITING.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal static class LocalEditor
|
||||
{
|
||||
/// <summary>
|
||||
/// Extensions Windows runs rather than opens, beyond whatever <c>PATHEXT</c> lists on this machine.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <c>PATHEXT</c> covers the console's notion of executable (<c>.exe</c>, <c>.bat</c>, <c>.js</c>,
|
||||
/// <c>.vbs</c>…) and is read as well, because an interpreter's installer may add its own. These are the
|
||||
/// ones Explorer acts on that are not in it: shortcuts, installers, HTML applications, control panel
|
||||
/// items, and the script hosts that installers do not register there.
|
||||
/// </remarks>
|
||||
private static readonly string[] WindowsRunsThese =
|
||||
[
|
||||
".application", ".appref-ms", ".bat", ".chm", ".cmd", ".com", ".cpl", ".diagcab", ".exe", ".hta",
|
||||
".inf", ".jar", ".js", ".jse", ".library-ms", ".lnk", ".msc", ".msi", ".msp", ".pif", ".ps1",
|
||||
".psm1", ".py", ".pyw", ".reg", ".scf", ".scr", ".search-ms", ".settingcontent-ms", ".url",
|
||||
".vbe", ".vbs", ".website", ".ws", ".wsc", ".wsf", ".wsh", ".xll",
|
||||
];
|
||||
|
||||
/// <summary>Extensions Launch Services runs, or installs, rather than opens.</summary>
|
||||
private static readonly string[] MacRunsThese =
|
||||
[
|
||||
".app", ".command", ".dmg", ".fileloc", ".inetloc", ".jar", ".mpkg", ".pkg", ".scpt", ".terminal",
|
||||
".tool", ".webloc", ".workflow",
|
||||
];
|
||||
|
||||
/// <summary>Opens <paramref name="path"/> for editing.</summary>
|
||||
/// <exception cref="InvalidOperationException">
|
||||
/// This desktop would run the file and has no editor to offer in its place.
|
||||
/// </exception>
|
||||
internal static Task OpenAsync(string path)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(path);
|
||||
|
||||
using var opened = Process.Start(StartInfoFor(path));
|
||||
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
|
||||
/// <summary>What to start so that <paramref name="path"/> opens in an editor.</summary>
|
||||
internal static ProcessStartInfo StartInfoFor(string path)
|
||||
{
|
||||
if (OperatingSystem.IsWindows() && WouldRunOnWindows(path))
|
||||
{
|
||||
var edit = new ProcessStartInfo(path) { UseShellExecute = true, Verb = "edit" };
|
||||
|
||||
if (edit.Verbs.Contains("edit", StringComparer.OrdinalIgnoreCase))
|
||||
{
|
||||
return edit;
|
||||
}
|
||||
|
||||
return new ProcessStartInfo("notepad.exe") { UseShellExecute = false, ArgumentList = { path } };
|
||||
}
|
||||
|
||||
if (OperatingSystem.IsMacOS() && HasExtension(path, MacRunsThese))
|
||||
{
|
||||
return new ProcessStartInfo("open") { UseShellExecute = false, ArgumentList = { "-t", path } };
|
||||
}
|
||||
|
||||
if (OperatingSystem.IsLinux() && HasExtension(path, [".desktop"]))
|
||||
{
|
||||
throw new InvalidOperationException(
|
||||
$"{Path.GetFileName(path)} is a launcher, which this desktop would run rather than open. "
|
||||
+ "Download it and open it in an editor instead.");
|
||||
}
|
||||
|
||||
return new ProcessStartInfo(path) { UseShellExecute = true };
|
||||
}
|
||||
|
||||
/// <summary>Whether Windows' default action for this file is to run it.</summary>
|
||||
internal static bool WouldRunOnWindows(string path, string? pathExt = null)
|
||||
{
|
||||
var listed = (pathExt ?? Environment.GetEnvironmentVariable("PATHEXT") ?? string.Empty)
|
||||
.Split(';', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries);
|
||||
|
||||
return HasExtension(path, WindowsRunsThese) || HasExtension(path, listed);
|
||||
}
|
||||
|
||||
/// <summary>Whether the file's last extension is one of these, ignoring case.</summary>
|
||||
/// <remarks>
|
||||
/// Trailing dots and spaces are dropped first, because Windows drops them too: <c>run.bat.</c> is
|
||||
/// <c>run.bat</c> by the time anything acts on it.
|
||||
/// </remarks>
|
||||
private static bool HasExtension(string path, IEnumerable<string> extensions)
|
||||
{
|
||||
var extension = Path.GetExtension(Path.GetFileName(path).TrimEnd('.', ' '));
|
||||
|
||||
return extension.Length > 0
|
||||
&& extensions.Contains(extension, StringComparer.OrdinalIgnoreCase);
|
||||
}
|
||||
}
|
||||
@@ -78,11 +78,21 @@ public sealed partial class MacDeviceKeyStore : IDeviceKeyStore
|
||||
|
||||
private readonly ClientPaths paths;
|
||||
|
||||
/// <summary>This profile's own enclave key; see <see cref="DeviceKeyNames"/>.</summary>
|
||||
/// <remarks>
|
||||
/// <see cref="KeyTag"/> for the default profile and a tag of its own for every other, so that signing
|
||||
/// out of one installation cannot delete the key another's Touch ID unlock is sealed to. A profile
|
||||
/// registered before this is still sealed to the shared tag and is read from there until it registers
|
||||
/// again; it is never deleted from a profile that does not own it.
|
||||
/// </remarks>
|
||||
private readonly string keyTag;
|
||||
|
||||
/// <summary>Creates the store.</summary>
|
||||
public MacDeviceKeyStore(ClientPaths paths)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(paths);
|
||||
this.paths = paths;
|
||||
keyTag = DeviceKeyNames.For(paths, KeyTag);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -163,7 +173,7 @@ public sealed partial class MacDeviceKeyStore : IDeviceKeyStore
|
||||
ReadOnlyMemory<byte> devicePrivateKey,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
var sealedKey = Seal(devicePrivateKey.Span)
|
||||
var sealedKey = Seal(devicePrivateKey.Span, keyTag)
|
||||
?? throw new InvalidOperationException(
|
||||
"The Secure Enclave would not seal the device key. Check IsAvailableAsync before offering to register one.");
|
||||
|
||||
@@ -184,7 +194,8 @@ public sealed partial class MacDeviceKeyStore : IDeviceKeyStore
|
||||
var sealedKey = await File.ReadAllBytesAsync(paths.DeviceKeyFile, cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
return Unseal(sealedKey);
|
||||
// The shared tag only while this profile has no key of its own, so one unlock is one prompt.
|
||||
return Unseal(sealedKey, !string.Equals(keyTag, KeyTag, StringComparison.Ordinal) && !HasKey(keyTag) ? KeyTag : keyTag);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
@@ -202,7 +213,7 @@ public sealed partial class MacDeviceKeyStore : IDeviceKeyStore
|
||||
// Discarded, and that is deliberate: there is nothing a caller could do about a failure here,
|
||||
// and the file deleted above is the half that decides whether unlock will try at all. A key
|
||||
// left in the enclave with no ciphertext to open is inert.
|
||||
_ = DeleteKey(symbols, KeyTag);
|
||||
_ = DeleteKey(symbols, keyTag);
|
||||
}
|
||||
|
||||
return ValueTask.CompletedTask;
|
||||
@@ -212,7 +223,26 @@ public sealed partial class MacDeviceKeyStore : IDeviceKeyStore
|
||||
/// Silent: it uses only the public half. Null on every failure, and the caller's answer to all of
|
||||
/// them is the same — do not offer a device unlock.
|
||||
/// </remarks>
|
||||
private static byte[]? Seal(ReadOnlySpan<byte> devicePrivateKey)
|
||||
/// <summary>Whether a key is filed under this tag, asked without using it and so without a prompt.</summary>
|
||||
private static bool HasKey(string tag)
|
||||
{
|
||||
try
|
||||
{
|
||||
using var scope = new CoreFoundationScope();
|
||||
|
||||
var symbols = MacSymbols.Resolve();
|
||||
|
||||
return symbols.Complete && FindKey(scope, symbols, tag, prompt: null) != IntPtr.Zero;
|
||||
}
|
||||
catch (Exception exception) when (exception is DllNotFoundException
|
||||
or EntryPointNotFoundException
|
||||
or BadImageFormatException)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
private static byte[]? Seal(ReadOnlySpan<byte> devicePrivateKey, string tag)
|
||||
{
|
||||
try
|
||||
{
|
||||
@@ -227,11 +257,11 @@ public sealed partial class MacDeviceKeyStore : IDeviceKeyStore
|
||||
|
||||
// Created on first use rather than at registration, so that a device key re-registered after
|
||||
// a ForgetAsync gets a key again without anything having to notice that it had gone.
|
||||
var privateKey = FindKey(scope, symbols, KeyTag, prompt: null);
|
||||
var privateKey = FindKey(scope, symbols, tag, prompt: null);
|
||||
|
||||
if (privateKey == IntPtr.Zero)
|
||||
{
|
||||
privateKey = CreateEnclaveKey(scope, symbols, KeyTag);
|
||||
privateKey = CreateEnclaveKey(scope, symbols, tag);
|
||||
}
|
||||
|
||||
if (privateKey == IntPtr.Zero)
|
||||
@@ -281,7 +311,7 @@ public sealed partial class MacDeviceKeyStore : IDeviceKeyStore
|
||||
/// on a thread that is also expected to draw the window behind it.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private static byte[]? Unseal(byte[] sealedKey)
|
||||
private static byte[]? Unseal(byte[] sealedKey, string tag)
|
||||
{
|
||||
try
|
||||
{
|
||||
@@ -294,7 +324,7 @@ public sealed partial class MacDeviceKeyStore : IDeviceKeyStore
|
||||
return null;
|
||||
}
|
||||
|
||||
var privateKey = FindKey(scope, symbols, KeyTag, ConsentPrompt);
|
||||
var privateKey = FindKey(scope, symbols, tag, ConsentPrompt);
|
||||
|
||||
if (privateKey == IntPtr.Zero)
|
||||
{
|
||||
|
||||
@@ -34,6 +34,12 @@ namespace DodoSSH.Client.App.Platform;
|
||||
/// process asks the first to come forward and then leaves, which is what every desktop application does and
|
||||
/// what makes the exclusion invisible rather than mysterious.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>A launch that carries a link passes the link on.</b> Clicking "Open in DodoSSH" in Spelunk starts
|
||||
/// this executable with a <c>dodossh://</c> link, and while DodoSSH is already running that start is a
|
||||
/// second launch like any other — so the doorbell has a second message, which carries the link to the
|
||||
/// instance that can act on it. See <see cref="OpenLinkPrefix"/>.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal static class SingleInstance
|
||||
{
|
||||
@@ -46,6 +52,30 @@ internal static class SingleInstance
|
||||
/// </remarks>
|
||||
private const string ComeForward = "dodossh.come-forward";
|
||||
|
||||
/// <summary>The other thing a second launch may say: come forward, and open this link.</summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Followed by the link, on the same one line. Checked as strictly as <see cref="ComeForward"/> is, and
|
||||
/// for the same reason: anything on this machine may write to the pipe, so the link is parsed again here
|
||||
/// by <see cref="SpelunkLink.TryParse"/>, and a message that is not exactly this prefix and a link that
|
||||
/// passes is ignored whole — the window does not even come forward for it.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// A second message rather than a second line after <see cref="ComeForward"/>, so that an older running
|
||||
/// build, which compares the whole line against that constant, ignores a link it cannot act on rather
|
||||
/// than half-obeying it.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private const string OpenLinkPrefix = "dodossh.open-link ";
|
||||
|
||||
/// <summary>The longest message the doorbell reads before it stops listening to that caller.</summary>
|
||||
/// <remarks>
|
||||
/// The longest link a second launch could send, and its prefix. A caller that goes on past it is not a
|
||||
/// DodoSSH, and reading a line of whatever length it likes would let it decide how much memory this
|
||||
/// process spends on it.
|
||||
/// </remarks>
|
||||
private const int MaxMessageLength = 64 + SpelunkLink.MaxLength;
|
||||
|
||||
/// <summary>How long a second launch waits for the first to answer its pipe.</summary>
|
||||
/// <remarks>
|
||||
/// Short, because the pipe is local and the process on the other end is either listening or not. It is
|
||||
@@ -86,7 +116,11 @@ internal static class SingleInstance
|
||||
/// How long to keep trying a lock nobody answers for, or null for <see cref="DefaultPatience"/>. Named
|
||||
/// by a test so the give-up path does not cost the suite three seconds; the application never passes it.
|
||||
/// </param>
|
||||
internal static IDisposable? Claim(ClientPaths paths, TimeSpan? patience = null)
|
||||
/// <param name="link">
|
||||
/// The link this launch was started with, if any — passed to the running instance instead of a bare
|
||||
/// request to come forward.
|
||||
/// </param>
|
||||
internal static IDisposable? Claim(ClientPaths paths, TimeSpan? patience = null, SpelunkLink? link = null)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(paths);
|
||||
|
||||
@@ -116,7 +150,7 @@ internal static class SingleInstance
|
||||
|
||||
// Asked before waiting, so the ordinary case — an instance that is up and running — costs one
|
||||
// round trip on a local pipe rather than the whole window below.
|
||||
if (AskTheRunningOneToComeForward(paths))
|
||||
if (AskTheRunningOneToComeForward(paths, link))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
@@ -142,25 +176,32 @@ internal static class SingleInstance
|
||||
/// </remarks>
|
||||
/// <param name="paths">The profile this instance claimed.</param>
|
||||
/// <param name="comeForward">What to do when another launch asks for the window.</param>
|
||||
internal static IAsyncDisposable Listen(ClientPaths paths, Action comeForward)
|
||||
/// <param name="openLink">
|
||||
/// What to do with a link another launch passed on, after <paramref name="comeForward"/>; null to ignore
|
||||
/// links, which then still bring the window forward. Invoked on the same thread pool thread.
|
||||
/// </param>
|
||||
internal static IAsyncDisposable Listen(
|
||||
ClientPaths paths,
|
||||
Action comeForward,
|
||||
Action<SpelunkLink>? openLink = null)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(paths);
|
||||
ArgumentNullException.ThrowIfNull(comeForward);
|
||||
|
||||
var listener = new Doorbell(PipeNameFor(paths), comeForward);
|
||||
var listener = new Doorbell(PipeNameFor(paths), comeForward, openLink);
|
||||
|
||||
listener.Start();
|
||||
|
||||
return listener;
|
||||
}
|
||||
|
||||
/// <summary>Tells the instance that holds this profile to raise its window.</summary>
|
||||
/// <summary>Tells the instance that holds this profile to raise its window, and to open a link if given one.</summary>
|
||||
/// <returns>Whether anything was listening.</returns>
|
||||
/// <remarks>
|
||||
/// Internal rather than private because it is the half a test can drive: the exclusion is a file handle
|
||||
/// and proves itself, and this is the part with a protocol in it.
|
||||
/// </remarks>
|
||||
internal static bool AskTheRunningOneToComeForward(ClientPaths paths)
|
||||
internal static bool AskTheRunningOneToComeForward(ClientPaths paths, SpelunkLink? link = null)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(paths);
|
||||
|
||||
@@ -175,7 +216,9 @@ internal static class SingleInstance
|
||||
|
||||
using var writer = new StreamWriter(pipe, Encoding.UTF8) { AutoFlush = true };
|
||||
|
||||
writer.WriteLine(ComeForward);
|
||||
// The link as this build writes it, rather than as it arrived: the receiver parses what a DodoSSH
|
||||
// sent, and a link that parsed here has exactly one spelling. See SpelunkLink.ToString.
|
||||
writer.WriteLine(Message(link));
|
||||
|
||||
return true;
|
||||
}
|
||||
@@ -188,6 +231,42 @@ internal static class SingleInstance
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>What a launch says down the pipe: come forward, with or without a link to open.</summary>
|
||||
internal static string Message(SpelunkLink? link) =>
|
||||
link is null ? ComeForward : OpenLinkPrefix + link;
|
||||
|
||||
/// <summary>
|
||||
/// Reads what a caller said: whether it is a ring at all, and the link that came with it.
|
||||
/// </summary>
|
||||
/// <returns>
|
||||
/// True for exactly <see cref="ComeForward"/>, with no link, and for <see cref="OpenLinkPrefix"/> followed
|
||||
/// by a link <see cref="SpelunkLink.TryParse"/> accepts, with that link. False for everything else,
|
||||
/// including a link that is almost right — the caller then does nothing at all.
|
||||
/// </returns>
|
||||
internal static bool TryRead(string? said, out SpelunkLink? link)
|
||||
{
|
||||
link = null;
|
||||
|
||||
if (said is null || said.Length > MaxMessageLength)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if (string.Equals(said, ComeForward, StringComparison.Ordinal))
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
if (said.StartsWith(OpenLinkPrefix, StringComparison.Ordinal)
|
||||
&& SpelunkLink.TryParse(said[OpenLinkPrefix.Length..], out var parsed))
|
||||
{
|
||||
link = parsed;
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/// <summary>Takes the lock, or answers null if somebody else has it.</summary>
|
||||
/// <remarks>
|
||||
/// The file is left in place rather than deleted on close. <c>FileOptions.DeleteOnClose</c> looks
|
||||
@@ -278,14 +357,16 @@ internal static class SingleInstance
|
||||
{
|
||||
private readonly string name;
|
||||
private readonly Action comeForward;
|
||||
private readonly Action<SpelunkLink>? openLink;
|
||||
private readonly CancellationTokenSource lifetime = new();
|
||||
|
||||
private Task? loop;
|
||||
|
||||
internal Doorbell(string name, Action comeForward)
|
||||
internal Doorbell(string name, Action comeForward, Action<SpelunkLink>? openLink)
|
||||
{
|
||||
this.name = name;
|
||||
this.comeForward = comeForward;
|
||||
this.openLink = openLink;
|
||||
}
|
||||
|
||||
internal void Start() => loop = RunAsync(lifetime.Token);
|
||||
@@ -324,11 +405,16 @@ internal static class SingleInstance
|
||||
// leaveOpen, because this server outlives the conversation. See the remark above.
|
||||
using (var reader = new StreamReader(server, Encoding.UTF8, false, 1024, leaveOpen: true))
|
||||
{
|
||||
var said = await reader.ReadLineAsync(cancellationToken).ConfigureAwait(false);
|
||||
var said = await ReadBoundedLineAsync(reader, cancellationToken).ConfigureAwait(false);
|
||||
|
||||
if (string.Equals(said, ComeForward, StringComparison.Ordinal))
|
||||
if (TryRead(said, out var link))
|
||||
{
|
||||
comeForward();
|
||||
|
||||
if (link is not null)
|
||||
{
|
||||
openLink?.Invoke(link);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -348,6 +434,39 @@ internal static class SingleInstance
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Reads one line, or null once it runs past <see cref="MaxMessageLength"/> or the caller hangs up.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <see cref="StreamReader.ReadLineAsync(CancellationToken)"/> reads a line of whatever length the
|
||||
/// caller sends, and the caller is anybody on this machine. A character at a time is cheap here — the
|
||||
/// reader buffers underneath, and a real message is one short line.
|
||||
/// </remarks>
|
||||
private static async Task<string?> ReadBoundedLineAsync(
|
||||
StreamReader reader,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
var line = new StringBuilder();
|
||||
var next = new char[1];
|
||||
|
||||
while (await reader.ReadAsync(next.AsMemory(), cancellationToken).ConfigureAwait(false) == 1)
|
||||
{
|
||||
if (next[0] == '\n')
|
||||
{
|
||||
return line.ToString().TrimEnd('\r');
|
||||
}
|
||||
|
||||
if (line.Length == MaxMessageLength)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
line.Append(next[0]);
|
||||
}
|
||||
|
||||
return line.Length == 0 ? null : line.ToString().TrimEnd('\r');
|
||||
}
|
||||
|
||||
/// <summary>Ends one conversation without ending the doorbell.</summary>
|
||||
/// <remarks>
|
||||
/// Guarded, because <c>Disconnect</c> throws on a server that is not connected — which is the state
|
||||
|
||||
@@ -123,6 +123,10 @@ public sealed class WindowsDeviceKeyStore : IDeviceKeyStore
|
||||
/// rather than failing to open blobs written by a previous build. A device that cannot be opened
|
||||
/// falls back to the passphrase, which is survivable — but silently, and a user would only notice
|
||||
/// their gesture had stopped working.
|
||||
/// <para>
|
||||
/// This is the default profile's key, and the name every profile shared before keys were per profile;
|
||||
/// see <see cref="DeviceKeyNames"/> and <see cref="keyName"/>.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private const string KeyName = "DodoSSH.DeviceKey.v1";
|
||||
|
||||
@@ -133,11 +137,22 @@ public sealed class WindowsDeviceKeyStore : IDeviceKeyStore
|
||||
|
||||
private readonly ClientPaths paths;
|
||||
|
||||
/// <summary>This profile's own key.</summary>
|
||||
/// <remarks>
|
||||
/// <see cref="KeyName"/> for the default profile and a name of its own for every other — so signing out
|
||||
/// of the nightly no longer deletes the key the release build's device unlock is sealed to. A profile
|
||||
/// registered before this still has its blob sealed to the shared key, and <see cref="TryLoadAsync"/>
|
||||
/// keeps opening it there until the next registration re-seals it here. It is never deleted from a
|
||||
/// profile that does not own it, which is the half of this that matters.
|
||||
/// </remarks>
|
||||
private readonly string keyName;
|
||||
|
||||
/// <summary>Creates the store.</summary>
|
||||
public WindowsDeviceKeyStore(ClientPaths paths)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(paths);
|
||||
this.paths = paths;
|
||||
keyName = DeviceKeyNames.For(paths, KeyName);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -182,7 +197,7 @@ public sealed class WindowsDeviceKeyStore : IDeviceKeyStore
|
||||
ReadOnlyMemory<byte> devicePrivateKey,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
using var key = OpenOrCreate();
|
||||
using var key = OpenOrCreate(keyName);
|
||||
using var rsa = new RSACng(key);
|
||||
|
||||
var sealedKey = rsa.Encrypt(devicePrivateKey.Span, RSAEncryptionPadding.OaepSHA256);
|
||||
@@ -204,7 +219,13 @@ public sealed class WindowsDeviceKeyStore : IDeviceKeyStore
|
||||
var sealedKey = await File.ReadAllBytesAsync(paths.DeviceKeyFile, cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
return Unseal(sealedKey);
|
||||
// The shared key only while this profile has none of its own: a profile registered before keys were
|
||||
// per profile is still sealed to it. Asking both would show two consent dialogs for one unlock.
|
||||
var sealedTo = !string.Equals(keyName, KeyName, StringComparison.Ordinal) && !CngKey.Exists(keyName, new CngProvider(PlatformProvider))
|
||||
? KeyName
|
||||
: keyName;
|
||||
|
||||
return Unseal(sealedKey, sealedTo);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
@@ -215,9 +236,11 @@ public sealed class WindowsDeviceKeyStore : IDeviceKeyStore
|
||||
File.Delete(paths.DeviceKeyFile);
|
||||
}
|
||||
|
||||
if (CngKey.Exists(KeyName, new CngProvider(PlatformProvider)))
|
||||
// This profile's key and never the shared one, unless this is the profile that owns it. Another
|
||||
// profile's device unlock may still be sealed to it.
|
||||
if (CngKey.Exists(keyName, new CngProvider(PlatformProvider)))
|
||||
{
|
||||
using var key = CngKey.Open(KeyName, new CngProvider(PlatformProvider));
|
||||
using var key = CngKey.Open(keyName, new CngProvider(PlatformProvider));
|
||||
key.Delete();
|
||||
}
|
||||
|
||||
@@ -231,16 +254,16 @@ public sealed class WindowsDeviceKeyStore : IDeviceKeyStore
|
||||
/// user and all have the same remedy, so none of them are worth telling apart here — see
|
||||
/// <c>UnlockStatus.DeviceKeyUnavailable</c>.
|
||||
/// </remarks>
|
||||
private static byte[]? Unseal(byte[] sealedKey)
|
||||
private static byte[]? Unseal(byte[] sealedKey, string name)
|
||||
{
|
||||
try
|
||||
{
|
||||
if (!CngKey.Exists(KeyName, new CngProvider(PlatformProvider)))
|
||||
if (!CngKey.Exists(name, new CngProvider(PlatformProvider)))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
using var key = CngKey.Open(KeyName, new CngProvider(PlatformProvider));
|
||||
using var key = CngKey.Open(name, new CngProvider(PlatformProvider));
|
||||
using var rsa = new RSACng(key);
|
||||
|
||||
return rsa.Decrypt(sealedKey, RSAEncryptionPadding.OaepSHA256);
|
||||
@@ -256,18 +279,18 @@ public sealed class WindowsDeviceKeyStore : IDeviceKeyStore
|
||||
/// key rather than ever reconfiguring one: a key created without the policy would decrypt silently, and
|
||||
/// silently is the one behaviour this whole file exists to prevent.
|
||||
/// </remarks>
|
||||
private static CngKey OpenOrCreate()
|
||||
private static CngKey OpenOrCreate(string name)
|
||||
{
|
||||
var provider = new CngProvider(PlatformProvider);
|
||||
|
||||
if (CngKey.Exists(KeyName, provider))
|
||||
if (CngKey.Exists(name, provider))
|
||||
{
|
||||
return CngKey.Open(KeyName, provider);
|
||||
return CngKey.Open(name, provider);
|
||||
}
|
||||
|
||||
return CngKey.Create(
|
||||
CngAlgorithm.Rsa,
|
||||
KeyName,
|
||||
name,
|
||||
new CngKeyCreationParameters
|
||||
{
|
||||
Provider = provider,
|
||||
|
||||
@@ -0,0 +1,82 @@
|
||||
using System.Runtime.Versioning;
|
||||
using DodoSSH.Client.Session;
|
||||
using Microsoft.Win32;
|
||||
|
||||
namespace DodoSSH.Client.App.Platform;
|
||||
|
||||
/// <summary>
|
||||
/// Registers this executable as the handler for <c>dodossh://</c> links, for this user, on Windows.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <b>Under HKCU\Software\Classes, because the install is per user.</b> Velopack installs into the user's
|
||||
/// own profile with no elevation, and a handler registered machine-wide would need the elevation the
|
||||
/// installer deliberately never asks for. Windows merges this key into <c>HKEY_CLASSES_ROOT</c> for the
|
||||
/// user, which is all a browser consults.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>Written by Velopack's install and update hooks, removed by its uninstall hook</b> — see
|
||||
/// <c>Program.Main</c>. An update rewrites it because the first update to a build that has this is how an
|
||||
/// existing installation gets it at all, and because it costs nothing to say again.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>Removed only when it is still ours.</b> The release and the nightly are separate installations that
|
||||
/// both answer <c>dodossh://</c>, and the last one installed holds the key. Uninstalling the other must not
|
||||
/// take the handler away from the one that is still there.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
[SupportedOSPlatform("windows")]
|
||||
internal static class WindowsUrlScheme
|
||||
{
|
||||
private const string KeyPath = @"Software\Classes\" + SpelunkLink.Scheme;
|
||||
private const string CommandPath = @"shell\open\command";
|
||||
|
||||
/// <summary>Points <c>dodossh://</c> at <paramref name="executable"/>.</summary>
|
||||
internal static void Register(string executable)
|
||||
{
|
||||
using var scheme = Registry.CurrentUser.CreateSubKey(KeyPath);
|
||||
|
||||
scheme.SetValue(string.Empty, "URL:DodoSSH");
|
||||
|
||||
// Empty, and its presence is the whole of it: this value is what makes the key a URL scheme rather
|
||||
// than a file type.
|
||||
scheme.SetValue("URL Protocol", string.Empty);
|
||||
|
||||
using (var icon = scheme.CreateSubKey("DefaultIcon"))
|
||||
{
|
||||
icon.SetValue(string.Empty, $"\"{executable}\",0");
|
||||
}
|
||||
|
||||
using var command = scheme.CreateSubKey(CommandPath);
|
||||
|
||||
command.SetValue(string.Empty, CommandFor(executable));
|
||||
}
|
||||
|
||||
/// <summary>Takes the handler away, if it is still <paramref name="executable"/>'s.</summary>
|
||||
internal static void Unregister(string executable)
|
||||
{
|
||||
string? registered;
|
||||
|
||||
using (var command = Registry.CurrentUser.OpenSubKey($@"{KeyPath}\{CommandPath}"))
|
||||
{
|
||||
registered = command?.GetValue(string.Empty) as string;
|
||||
}
|
||||
|
||||
if (IsOurs(registered, executable))
|
||||
{
|
||||
Registry.CurrentUser.DeleteSubKeyTree(KeyPath, throwOnMissingSubKey: false);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>The command Windows runs for a link: this executable, with the link as its one argument.</summary>
|
||||
/// <remarks>
|
||||
/// Both halves quoted. The path has spaces in it on any profile whose user name does, and the link is
|
||||
/// handed over whole as <c>%1</c> — which Windows quotes into one argument only because it is quoted
|
||||
/// here. Program.Main then reads it back and checks it before anything acts on it.
|
||||
/// </remarks>
|
||||
internal static string CommandFor(string executable) => $"\"{executable}\" \"%1\"";
|
||||
|
||||
/// <summary>Whether a registered command is the one <see cref="Register"/> writes for this executable.</summary>
|
||||
internal static bool IsOurs(string? registered, string executable) =>
|
||||
string.Equals(registered, CommandFor(executable), StringComparison.OrdinalIgnoreCase);
|
||||
}
|
||||
@@ -8,6 +8,16 @@ namespace DodoSSH.Client.App;
|
||||
|
||||
internal static class Program
|
||||
{
|
||||
/// <summary>
|
||||
/// The <c>dodossh://</c> link this process was started with, once it has claimed the profile; null for an
|
||||
/// ordinary launch.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// A static handed across to <c>DodoSshApp</c> rather than a constructor argument, because Avalonia
|
||||
/// constructs the application itself — and the designer does too, through <see cref="BuildAvaloniaApp"/>,
|
||||
/// with no arguments to have.
|
||||
/// </remarks>
|
||||
internal static SpelunkLink? LaunchLink { get; private set; }
|
||||
/// <summary>
|
||||
/// Entry point.
|
||||
/// </summary>
|
||||
@@ -29,11 +39,12 @@ internal static class Program
|
||||
// and a silent installer run that reached either would be a background process holding the cache
|
||||
// file open during the very file operations the installer is performing.
|
||||
//
|
||||
// There are deliberately no OnFirstRun or OnAfterUpdate hooks. A hook process has no passphrase,
|
||||
// so the cache is bytes it cannot read, and the one thing that would want doing after an update —
|
||||
// a schema migration — already runs on every ordinary launch from MainWindowViewModel.StartAsync,
|
||||
// before unlock and touching no encrypted content.
|
||||
VelopackApp.Build().Run();
|
||||
// There are deliberately no OnFirstRun or OnAfterUpdate hooks that touch the profile. A hook process
|
||||
// has no passphrase, so the cache is bytes it cannot read, and the one thing that would want doing
|
||||
// after an update — a schema migration — already runs on every ordinary launch from
|
||||
// MainWindowViewModel.StartAsync, before unlock and touching no encrypted content. The hooks it does
|
||||
// have touch only the registry; see RunVelopack.
|
||||
RunVelopack();
|
||||
|
||||
KeepTheWebViewProfileOutOfTheInstallDirectory();
|
||||
|
||||
@@ -51,16 +62,100 @@ internal static class Program
|
||||
*/
|
||||
var paths = ClientPaths.ForChannel(DesktopChannel.Name);
|
||||
|
||||
using var claim = SingleInstance.Claim(paths);
|
||||
// Read before the claim, because a launch that carries a link and finds DodoSSH already running
|
||||
// passes the link on rather than merely asking for the window.
|
||||
var link = LinkFrom(args);
|
||||
|
||||
using var claim = SingleInstance.Claim(paths, link: link);
|
||||
|
||||
if (claim is null)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
LaunchLink = link;
|
||||
|
||||
BuildAvaloniaApp().StartWithClassicDesktopLifetime(args);
|
||||
}
|
||||
|
||||
/// <summary>Lets Velopack do its install bookkeeping, with this application's three hooks.</summary>
|
||||
/// <remarks>
|
||||
/// The hooks touch only the registry: they make this executable the handler for <c>dodossh://</c> links,
|
||||
/// which is how Spelunk's "Open in DodoSSH" reaches it, and take that away again on uninstall. Velopack
|
||||
/// runs them on Windows only, and offers them only there; the other desktops declare the scheme in their
|
||||
/// packages instead — build/macos's Info.plist template and build/linux's desktop entry. See
|
||||
/// <see cref="WindowsUrlScheme"/>.
|
||||
/// </remarks>
|
||||
private static void RunVelopack()
|
||||
{
|
||||
var velopack = VelopackApp.Build();
|
||||
|
||||
if (OperatingSystem.IsWindows())
|
||||
{
|
||||
velopack = velopack
|
||||
.OnAfterInstallFastCallback(_ => RegisterUrlScheme())
|
||||
.OnAfterUpdateFastCallback(_ => RegisterUrlScheme())
|
||||
.OnBeforeUninstallFastCallback(_ => UnregisterUrlScheme());
|
||||
}
|
||||
|
||||
velopack.Run();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The <c>dodossh://</c> link among this launch's arguments, if there is one and it passes the checks.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// A link that fails them is dropped and the launch goes ahead as an ordinary one: the user clicked
|
||||
/// something that meant "open DodoSSH", and a window is still the right answer to that even when what
|
||||
/// came with it cannot be trusted. See <see cref="SpelunkLink.TryParse"/> for what is checked.
|
||||
/// </remarks>
|
||||
private static SpelunkLink? LinkFrom(string[] args) =>
|
||||
args.FirstOrDefault(SpelunkLink.LooksLikeOne) is { } candidate
|
||||
&& SpelunkLink.TryParse(candidate, out var link)
|
||||
? link
|
||||
: null;
|
||||
|
||||
/// <summary>Makes this executable the handler for <c>dodossh://</c> links, where that is a registry key.</summary>
|
||||
/// <remarks>
|
||||
/// Failures are swallowed. This runs inside Velopack's install, and an installer that failed because a
|
||||
/// convenience could not be set up would be the wrong trade — the application works without it, and the
|
||||
/// only thing lost is Spelunk's button opening it.
|
||||
/// </remarks>
|
||||
private static void RegisterUrlScheme()
|
||||
{
|
||||
if (!OperatingSystem.IsWindows() || Environment.ProcessPath is not { } executable)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
WindowsUrlScheme.Register(executable);
|
||||
}
|
||||
catch (Exception exception) when (exception is IOException or UnauthorizedAccessException or System.Security.SecurityException)
|
||||
{
|
||||
// See the remarks.
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="RegisterUrlScheme" path="/remarks" />
|
||||
private static void UnregisterUrlScheme()
|
||||
{
|
||||
if (!OperatingSystem.IsWindows() || Environment.ProcessPath is not { } executable)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
WindowsUrlScheme.Unregister(executable);
|
||||
}
|
||||
catch (Exception exception) when (exception is IOException or UnauthorizedAccessException or System.Security.SecurityException)
|
||||
{
|
||||
// See the remarks on RegisterUrlScheme.
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Puts WebView2's user data folder beside the vault cache instead of beside the executable.
|
||||
/// </summary>
|
||||
|
||||
@@ -59,7 +59,7 @@
|
||||
<StackPanel Orientation="Horizontal" Spacing="6">
|
||||
<Button Classes="danger" Content="DELETE" Command="{Binding ConfirmDeleteCommand}"
|
||||
IsEnabled="{Binding !IsBusy}" />
|
||||
<Button Classes="ghost" Content="CANCEL" Command="{Binding CancelDeleteCommand}" />
|
||||
<Button x:Name="CancelButton" Classes="ghost" Content="CANCEL" Command="{Binding CancelDeleteCommand}" />
|
||||
</StackPanel>
|
||||
|
||||
</StackPanel>
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
using Avalonia.Controls;
|
||||
using DodoSSH.Client.Shell.ViewModels;
|
||||
|
||||
namespace DodoSSH.Client.App.Views;
|
||||
|
||||
@@ -12,5 +13,10 @@ namespace DodoSSH.Client.App.Views;
|
||||
/// </remarks>
|
||||
internal sealed partial class ConfirmDeleteCard : UserControl
|
||||
{
|
||||
public ConfirmDeleteCard() => InitializeComponent();
|
||||
public ConfirmDeleteCard()
|
||||
{
|
||||
InitializeComponent();
|
||||
|
||||
SafeAnswerFocus.Follow(this, nameof(VaultViewModel.PendingDeletion), () => CancelButton);
|
||||
}
|
||||
}
|
||||
@@ -4,7 +4,7 @@
|
||||
Width="420" SizeToContent="Height"
|
||||
CanResize="False" ShowInTaskbar="False"
|
||||
WindowStartupLocation="CenterOwner"
|
||||
Background="{StaticResource Surface}"
|
||||
Background="{StaticResource Panel}"
|
||||
Title="DodoSSH">
|
||||
|
||||
<!--
|
||||
@@ -32,7 +32,7 @@
|
||||
|
||||
<TextBlock Classes="heading" FontSize="15" x:Name="Heading" TextWrapping="Wrap" />
|
||||
|
||||
<TextBlock Foreground="{StaticResource MutedText}" FontSize="12" TextWrapping="Wrap"
|
||||
<TextBlock Foreground="{StaticResource TextDim}" FontSize="12" TextWrapping="Wrap"
|
||||
x:Name="Explanation" />
|
||||
|
||||
<!--
|
||||
|
||||
@@ -39,7 +39,10 @@ public sealed partial class DevicePinWindow : Window
|
||||
/// <summary>Creates the window. Avalonia's designer needs this; nothing else should call it.</summary>
|
||||
public DevicePinWindow()
|
||||
{
|
||||
AvaloniaXamlLoader.Load(this);
|
||||
// InitializeComponent, not AvaloniaXamlLoader.Load: only the generated method assigns the x:Name
|
||||
// fields below, and with Load the first of them was null — so this window threw on construction and
|
||||
// no Linux PIN prompt was ever shown.
|
||||
InitializeComponent();
|
||||
|
||||
Accept.Click += OnAccept;
|
||||
Cancel.Click += OnCancel;
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
<UserControl xmlns="https://github.com/avaloniaui"
|
||||
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
|
||||
xmlns:vm="using:DodoSSH.Client.Shell.ViewModels"
|
||||
xmlns:dom="using:DodoSSH.Client.Domain"
|
||||
xmlns:views="using:DodoSSH.Client.App.Views"
|
||||
x:Class="DodoSSH.Client.App.Views.HostDrawer"
|
||||
x:DataType="vm:VaultViewModel">
|
||||
@@ -385,6 +386,33 @@
|
||||
</StackPanel>
|
||||
</Border>
|
||||
|
||||
<!--
|
||||
============ FORWARDS (read-only) ============
|
||||
QUICK ACCESS's shape, and hidden when empty for the same reason: a card with nothing under it
|
||||
answers a question nobody asked here.
|
||||
-->
|
||||
<Border Classes="section" IsVisible="{Binding SelectedHost.HasForwards}">
|
||||
<StackPanel Spacing="6">
|
||||
<TextBlock Classes="sectionhead" Text="Port forwards" Margin="0,0,0,2" />
|
||||
|
||||
<Button Classes="fieldrow" Command="{Binding EditSelectedHostCommand}">
|
||||
<Grid ColumnDefinitions="Auto,*">
|
||||
<TextBlock Grid.Column="0" FontFamily="{StaticResource IconFont}" FontSize="13"
|
||||
Foreground="{StaticResource TextFaint}" Width="16" VerticalAlignment="Top"
|
||||
Margin="0,3,0,0" Text="" />
|
||||
<ItemsControl Grid.Column="1" ItemsSource="{Binding SelectedHost.Host.PortForwards}">
|
||||
<ItemsControl.ItemTemplate>
|
||||
<DataTemplate x:DataType="dom:PortForwardRule">
|
||||
<TextBlock Classes="mono" Text="{Binding Notation}" FontSize="12"
|
||||
TextTrimming="CharacterEllipsis" Margin="0,0,0,2" />
|
||||
</DataTemplate>
|
||||
</ItemsControl.ItemTemplate>
|
||||
</ItemsControl>
|
||||
</Grid>
|
||||
</Button>
|
||||
</StackPanel>
|
||||
</Border>
|
||||
|
||||
<TextBlock Classes="hint" FontSize="11" TextWrapping="Wrap"
|
||||
Text="Double-clicking the card does the same as CONNECT. The terminal opens as a tab in the strip above and stays there while you look at anything else." />
|
||||
|
||||
@@ -550,7 +578,8 @@
|
||||
-->
|
||||
<Grid ColumnDefinitions="*,8,78">
|
||||
<TextBox Grid.Column="0" Text="{Binding EditorUsername}"
|
||||
PlaceholderText="{Binding EditorUsernamePlaceholder}" Height="40" />
|
||||
PlaceholderText="{Binding EditorUsernamePlaceholder}" Height="40"
|
||||
IsEnabled="{Binding EditorAsksForLogin}" />
|
||||
<NumericUpDown Grid.Column="2" FontFamily="{StaticResource MonoFont}"
|
||||
Value="{Binding EditorPort}" Minimum="1" Maximum="65535" FormatString="0"
|
||||
ShowButtonSpinner="False" PlaceholderText="{Binding EditorPortPlaceholder}"
|
||||
@@ -571,6 +600,7 @@
|
||||
-->
|
||||
<ComboBox ItemsSource="{Binding EditorAuthenticationChoices}"
|
||||
SelectedItem="{Binding EditorSelectedAuthentication}"
|
||||
IsEnabled="{Binding EditorAsksForLogin}"
|
||||
HorizontalAlignment="Stretch" Height="40">
|
||||
<ComboBox.ItemTemplate>
|
||||
<DataTemplate x:DataType="vm:AuthenticationChoice">
|
||||
@@ -584,6 +614,15 @@
|
||||
</ComboBox.ItemTemplate>
|
||||
</ComboBox>
|
||||
|
||||
<!--
|
||||
Why the two controls above are greyed out for a host Spelunk signs in to: disabled rather
|
||||
than hidden, so a login somebody chose is still there to see and comes back if the box in
|
||||
the Spelunk card is unticked before saving. See VaultViewModel.EditorAsksForLogin.
|
||||
-->
|
||||
<TextBlock Classes="hint" FontSize="11" TextWrapping="Wrap"
|
||||
IsVisible="{Binding !EditorAsksForLogin}"
|
||||
Text="Spelunk signs you in to this host, so it needs no username, SSH key or password." />
|
||||
|
||||
<!--
|
||||
Making a credential without leaving the host. The moment one is wanted is this one: somebody
|
||||
is deciding how a host authenticates and finds the password is not in the keychain yet, and
|
||||
@@ -664,6 +703,66 @@
|
||||
</StackPanel>
|
||||
</Border>
|
||||
|
||||
<!--
|
||||
◆ THE SPELUNK CARD, the relay card's twin and its alternative: ticking one unticks the other,
|
||||
because a host has one route. A host ticked here is reached through the Spelunk agent already
|
||||
on the server, so it needs no open SSH port at all. The fields appear only when the box is
|
||||
ticked, and the key is a keychain credential — picked, never typed here — so it is encrypted
|
||||
and synced like every other secret. See VaultViewModel.Spelunk.cs.
|
||||
-->
|
||||
<Border CornerRadius="12" Background="{StaticResource Field}"
|
||||
BorderBrush="{StaticResource Border}" BorderThickness="1" Padding="12">
|
||||
<StackPanel Spacing="6">
|
||||
<CheckBox IsChecked="{Binding EditorThroughSpelunk}" VerticalContentAlignment="Center">
|
||||
<TextBlock Text="Connect through Spelunk" FontSize="13"
|
||||
FontWeight="SemiBold" Foreground="{StaticResource Text}"
|
||||
TextWrapping="Wrap" />
|
||||
</CheckBox>
|
||||
<StackPanel Spacing="6" IsVisible="{Binding EditorThroughSpelunk}">
|
||||
<TextBox Text="{Binding EditorSpelunkApi}" Height="36"
|
||||
PlaceholderText="Spelunk API address (https://api.…)" />
|
||||
<TextBox Text="{Binding EditorSpelunkServerId}" Height="36"
|
||||
PlaceholderText="Spelunk server id" />
|
||||
<!--
|
||||
Saved Spelunk keys first (Settings → Security), each qualified by the one address it
|
||||
goes to, then credentials whose password is a key. A deleted one keeps a placeholder, as
|
||||
the authentication picker's does, so an unrelated edit cannot drop it. Typing an address
|
||||
a key is saved for picks that key when nothing is picked yet.
|
||||
-->
|
||||
<TextBlock Classes="hint" FontSize="10.5" Text="Spelunk API key" />
|
||||
<ComboBox ItemsSource="{Binding EditorSpelunkKeyChoices}"
|
||||
SelectedItem="{Binding EditorSelectedSpelunkKey}"
|
||||
HorizontalAlignment="Stretch" Height="40">
|
||||
<ComboBox.ItemTemplate>
|
||||
<DataTemplate x:DataType="vm:AuthenticationChoice">
|
||||
<StackPanel Orientation="Horizontal" Spacing="8">
|
||||
<TextBlock Text="{Binding Label}" />
|
||||
<TextBlock Text="{Binding Qualifier}" Classes="hint" FontSize="11"
|
||||
VerticalAlignment="Center" />
|
||||
</StackPanel>
|
||||
</DataTemplate>
|
||||
</ComboBox.ItemTemplate>
|
||||
</ComboBox>
|
||||
<!--
|
||||
Spelunk signs the user in: a key pair made in memory for each connection, its public
|
||||
half sent with the ticket, and the agent's one-connection SSH server accepting only
|
||||
that. Ticking it greys out the login above. See SpelunkRoute.SignInThroughSpelunk.
|
||||
-->
|
||||
<CheckBox IsChecked="{Binding EditorSpelunkSignIn}" VerticalContentAlignment="Center">
|
||||
<TextBlock Text="Sign in through Spelunk (no SSH key needed)" FontSize="12.5"
|
||||
Foreground="{StaticResource Text}" TextWrapping="Wrap" />
|
||||
</CheckBox>
|
||||
</StackPanel>
|
||||
<!--
|
||||
What the route asks for and what it costs, said where the decision is made: an Admin-role
|
||||
Spelunk API key, sent to the address above and nowhere else, and a host that is reached
|
||||
only while Spelunk and its agent are.
|
||||
-->
|
||||
<TextBlock Classes="hint" FontSize="11.5"
|
||||
Text="Spelunk's agent on the server connects to its SSH server for you, so the server needs no open SSH port. Save your Spelunk API key (Admin role) under Settings → Security and choose it here, or keep it as a credential's password; it is sent only to the address above. Signing in through Spelunk logs you in as the account Spelunk names, with a key made for each connection and never kept. The hostname and port still name this machine's host key. Connects only while Spelunk and its agent are reachable." />
|
||||
</StackPanel>
|
||||
</Border>
|
||||
|
||||
<!--
|
||||
Withdrawing host key trust lives here, in the host's own settings, because a changed host
|
||||
key is refused outright with no way to continue past it — so a legitimately rebuilt server
|
||||
@@ -740,6 +839,84 @@
|
||||
</StackPanel>
|
||||
</Border>
|
||||
|
||||
<!--
|
||||
============ PORT FORWARDS ============
|
||||
Staged on VaultViewModel.EditorPortForwards the way QUICK ACCESS stages its pins, and saved
|
||||
with the host. Each row is drawn in OpenSSH's own notation, because that is what anybody who has
|
||||
used one reads fastest; the add row spells out which end the listening port is on instead,
|
||||
because -L and -R are the two flags people get backwards.
|
||||
|
||||
No bind-address field, and that is not an omission: every listener binds loopback. A forward is
|
||||
a field every member of a shared keychain can fill in, and one bound to 0.0.0.0 would hand the
|
||||
remote's network to anybody who can reach this machine. See SshPortForwardSpec.
|
||||
-->
|
||||
<Border Classes="section">
|
||||
<StackPanel Spacing="8">
|
||||
<TextBlock Classes="sectionlabel" Text="PORT FORWARDS" />
|
||||
|
||||
<ItemsControl ItemsSource="{Binding EditorPortForwards}">
|
||||
<ItemsControl.ItemsPanel>
|
||||
<ItemsPanelTemplate><StackPanel Spacing="6" /></ItemsPanelTemplate>
|
||||
</ItemsControl.ItemsPanel>
|
||||
<ItemsControl.ItemTemplate>
|
||||
<DataTemplate x:DataType="dom:PortForwardRule">
|
||||
<Border Height="33" CornerRadius="9" Background="{StaticResource Field}"
|
||||
BorderBrush="{StaticResource Border}" BorderThickness="1" Padding="8,0">
|
||||
<Grid ColumnDefinitions="Auto,*,Auto">
|
||||
<TextBlock Grid.Column="0" FontFamily="{StaticResource IconFont}" FontSize="14"
|
||||
Foreground="{StaticResource TextFaint}" VerticalAlignment="Center"
|
||||
Text="" />
|
||||
<TextBlock Grid.Column="1" Classes="mono" Text="{Binding Notation}" FontSize="12.5"
|
||||
Margin="8,0" VerticalAlignment="Center"
|
||||
TextTrimming="CharacterEllipsis" ToolTip.Tip="{Binding Notation}" />
|
||||
<Button Grid.Column="2" Classes="flat paneicon" Content="✕" Width="22" Height="22"
|
||||
FontSize="11"
|
||||
Command="{Binding $parent[ItemsControl].((vm:VaultViewModel)DataContext).RemoveEditorForwardCommand}"
|
||||
CommandParameter="{Binding}" ToolTip.Tip="Removes this forward" />
|
||||
</Grid>
|
||||
</Border>
|
||||
</DataTemplate>
|
||||
</ItemsControl.ItemTemplate>
|
||||
</ItemsControl>
|
||||
|
||||
<ComboBox SelectedIndex="{Binding EditorNewForwardKind}" HorizontalAlignment="Stretch"
|
||||
Height="36">
|
||||
<ComboBoxItem Content="Local -L" />
|
||||
<ComboBoxItem Content="Remote -R" />
|
||||
<ComboBoxItem Content="Dynamic -D (SOCKS)" />
|
||||
</ComboBox>
|
||||
|
||||
<!-- Which end each port is on, for the kind chosen: the thing -L and -R get backwards. -->
|
||||
<TextBlock Classes="hint" FontSize="11" TextWrapping="Wrap"
|
||||
Text="{Binding EditorNewForwardKindHint}" />
|
||||
|
||||
<Grid ColumnDefinitions="104,6,*,6,Auto">
|
||||
<TextBox Grid.Column="0" FontFamily="{StaticResource MonoFont}"
|
||||
Text="{Binding EditorNewForwardBindPort}"
|
||||
PlaceholderText="{Binding EditorNewForwardBindHint}" Height="36"
|
||||
ToolTip.Tip="{Binding EditorNewForwardBindHint}">
|
||||
<TextBox.KeyBindings>
|
||||
<KeyBinding Gesture="Enter" Command="{Binding AddEditorForwardCommand}" />
|
||||
</TextBox.KeyBindings>
|
||||
</TextBox>
|
||||
<TextBox Grid.Column="2" FontFamily="{StaticResource MonoFont}"
|
||||
Text="{Binding EditorNewForwardTarget}"
|
||||
IsVisible="{Binding EditorNewForwardHasTarget}"
|
||||
PlaceholderText="host:port" Height="36">
|
||||
<TextBox.KeyBindings>
|
||||
<KeyBinding Gesture="Enter" Command="{Binding AddEditorForwardCommand}" />
|
||||
</TextBox.KeyBindings>
|
||||
</TextBox>
|
||||
<Button Grid.Column="4" Classes="ghost" Content="+" Width="36" Height="36" FontSize="15"
|
||||
HorizontalContentAlignment="Center"
|
||||
Command="{Binding AddEditorForwardCommand}" ToolTip.Tip="Adds this forward" />
|
||||
</Grid>
|
||||
|
||||
<TextBlock Classes="hint" FontSize="11.5" TextWrapping="Wrap"
|
||||
Text="Forwards start with every terminal opened to this host and stop when it closes. Everything listens on localhost only. A change here applies from the next connection." />
|
||||
</StackPanel>
|
||||
</Border>
|
||||
|
||||
</StackPanel>
|
||||
|
||||
<!-- ============ THE GROUP EDITOR ============ -->
|
||||
|
||||
@@ -45,7 +45,11 @@
|
||||
80% of Canvas, written out because a scrim is a brush with an alpha and the palette holds no alpha
|
||||
variant of a surface; the pre-multiplied ones there are accent washes.
|
||||
-->
|
||||
<Border Background="#CC05050A">
|
||||
<!--
|
||||
Tab cycles inside the card rather than walking the page under the wash, which it used to: a question
|
||||
that cannot be answered by clicking away should not be answerable by tabbing away either.
|
||||
-->
|
||||
<Border Background="#CC05050A" KeyboardNavigation.TabNavigation="Cycle">
|
||||
<Panel>
|
||||
|
||||
<!-- ============ UNKNOWN HOST KEY ============ -->
|
||||
@@ -83,7 +87,7 @@
|
||||
<StackPanel Orientation="Horizontal" Spacing="6">
|
||||
<Button Classes="accent" Content="TRUST AND CONNECT"
|
||||
Command="{Binding TrustHostKeyCommand}" />
|
||||
<Button Classes="ghost" Content="CANCEL" Command="{Binding RejectHostKeyCommand}" />
|
||||
<Button x:Name="CancelButton" Classes="ghost" Content="CANCEL" Command="{Binding RejectHostKeyCommand}" />
|
||||
</StackPanel>
|
||||
|
||||
</StackPanel>
|
||||
@@ -119,7 +123,7 @@
|
||||
is not an answer, because this half of the control has none to give. Compare the accent button
|
||||
above, which connects.
|
||||
-->
|
||||
<Button Classes="ghost" Content="CLOSE" HorizontalAlignment="Left"
|
||||
<Button x:Name="CloseButton" Classes="ghost" Content="CLOSE" HorizontalAlignment="Left"
|
||||
Command="{Binding RejectHostKeyCommand}" />
|
||||
|
||||
</StackPanel>
|
||||
|
||||
@@ -17,4 +17,14 @@ namespace DodoSSH.Client.App.Views;
|
||||
internal sealed partial class HostKeyCard : UserControl
|
||||
{
|
||||
public HostKeyCard() => InitializeComponent();
|
||||
|
||||
/// <summary>The answer the keyboard is given when the card appears: CANCEL, or CLOSE for a changed key.</summary>
|
||||
/// <remarks>
|
||||
/// Never TRUST AND CONNECT, for the reason <see cref="SafeAnswerFocus"/> gives about every confirmation
|
||||
/// and with more force here: an Enter meant for whatever was focused before the card appeared must not
|
||||
/// be what pins a key nobody has compared. The window moves the keyboard rather than the card, because
|
||||
/// this one is raised over a terminal that may be holding it natively — see
|
||||
/// <c>MainWindow.OnHostKeyDecision</c>.
|
||||
/// </remarks>
|
||||
internal Control SafeAnswer => CancelButton.IsEffectivelyVisible ? CancelButton : CloseButton;
|
||||
}
|
||||
@@ -683,7 +683,7 @@
|
||||
TextTrimming never fires and the name would run on past the card's own
|
||||
border instead of trimming. See the longer note this carried in v4.
|
||||
-->
|
||||
<Grid ColumnDefinitions="*,Auto,Auto">
|
||||
<Grid ColumnDefinitions="*,Auto">
|
||||
<TextBlock Grid.Column="0" Text="{Binding Label}" FontSize="17"
|
||||
FontWeight="Bold" Foreground="{StaticResource Text}"
|
||||
TextTrimming="CharacterEllipsis" />
|
||||
@@ -708,17 +708,27 @@
|
||||
<Ellipse Classes="dot" Classes.live="{Binding IsConnected}"
|
||||
Width="9" Height="9" />
|
||||
</StackPanel>
|
||||
</Grid>
|
||||
|
||||
<Border Grid.Column="2" Classes="chip warn" Padding="4,0" Margin="6,0,0,0"
|
||||
<!--
|
||||
"not synced" and its kin sit on the address line. Beside the name, where it
|
||||
used to be, it took seventy of the card's pixels from the one thing a card
|
||||
is read for: "bastion" drew as "bast…", and k8s-worker-a and k8s-worker-b
|
||||
both drew as "k8s…". The address can give the room up — it trims, and the
|
||||
tooltip and the drawer both carry it whole.
|
||||
-->
|
||||
<Grid ColumnDefinitions="*,Auto">
|
||||
<TextBlock Grid.Column="0" Classes="mono" Text="{Binding Address}" FontSize="12.5"
|
||||
Foreground="{StaticResource TextGhost}"
|
||||
TextTrimming="CharacterEllipsis" />
|
||||
|
||||
<Border Grid.Column="1" Classes="chip warn" Padding="4,0" Margin="6,0,0,0"
|
||||
VerticalAlignment="Center"
|
||||
IsVisible="{Binding Badge, Converter={x:Static StringConverters.IsNotNullOrEmpty}}">
|
||||
<TextBlock Text="{Binding Badge}" FontSize="9.5" />
|
||||
</Border>
|
||||
</Grid>
|
||||
|
||||
<TextBlock Classes="mono" Text="{Binding Address}" FontSize="12.5"
|
||||
Foreground="{StaticResource TextGhost}"
|
||||
TextTrimming="CharacterEllipsis" />
|
||||
|
||||
<!--
|
||||
Which vault this host is in, and only when there is more than one to be
|
||||
in. It decides who else can see the host and where an edit goes back to,
|
||||
@@ -734,8 +744,13 @@
|
||||
<Grid Grid.Row="2" ColumnDefinitions="*,Auto" VerticalAlignment="Bottom"
|
||||
Margin="0,8,0,0">
|
||||
|
||||
<StackPanel Grid.Column="0" Orientation="Horizontal" Spacing="4"
|
||||
VerticalAlignment="Bottom">
|
||||
<!--
|
||||
A DockPanel rather than a horizontal StackPanel. A horizontal StackPanel
|
||||
measures its children with infinite width, so the tags' WrapPanel below
|
||||
never wrapped and ran past the card's edge; the last child of a DockPanel
|
||||
gets the width that is actually left, and wraps in it.
|
||||
-->
|
||||
<DockPanel Grid.Column="0" VerticalAlignment="Bottom">
|
||||
|
||||
<!--
|
||||
The pin badge: how many folders are pinned on this host, reading
|
||||
@@ -743,8 +758,8 @@
|
||||
property's own remarks. Only when there is at least one; a badge reading
|
||||
zero would be a fact nobody asked for.
|
||||
-->
|
||||
<Border Classes="chip" Height="19" CornerRadius="5" Padding="6,2"
|
||||
IsVisible="{Binding HasPins}">
|
||||
<Border DockPanel.Dock="Left" Classes="chip" Height="19" CornerRadius="5"
|
||||
Padding="6,2" Margin="0,0,4,4" IsVisible="{Binding HasPins}">
|
||||
<StackPanel Orientation="Horizontal" Spacing="3">
|
||||
<TextBlock Text="" FontFamily="{StaticResource IconFont}"
|
||||
FontSize="11" Foreground="{StaticResource TextFaint}" />
|
||||
@@ -767,12 +782,13 @@
|
||||
<Border Classes="chip" Height="21" CornerRadius="5" Padding="6,2"
|
||||
Margin="0,0,4,4">
|
||||
<TextBlock Text="{Binding}" FontSize="11"
|
||||
Foreground="{StaticResource TextFaint}" />
|
||||
Foreground="{StaticResource TextFaint}"
|
||||
TextTrimming="CharacterEllipsis" />
|
||||
</Border>
|
||||
</DataTemplate>
|
||||
</ItemsControl.ItemTemplate>
|
||||
</ItemsControl>
|
||||
</StackPanel>
|
||||
</DockPanel>
|
||||
|
||||
<!--
|
||||
HostRowViewModel.LastConnectedText is filled from the connection log on
|
||||
|
||||
@@ -122,6 +122,13 @@ internal sealed partial class HostsScreen : UserControl
|
||||
// touched; see KeyboardTarget for the other half of who has the keyboard on this screen.
|
||||
Board.KeyDown += OnGridKey;
|
||||
|
||||
// The arrows' half of the selection, which the pointer's half writes by hand in OnPointerPressed. See
|
||||
// OnCardSelectionChanged for why this is not simply a two-way binding.
|
||||
Board.AddHandler(SelectingItemsControl.SelectionChangedEvent, OnCardSelectionChanged);
|
||||
|
||||
// Tunnelled, because a section's list answers Enter itself and nothing bubbles past it.
|
||||
Board.AddHandler(KeyDownEvent, OnCardEnter, RoutingStrategies.Tunnel);
|
||||
|
||||
// ◆ The band is the scroller's rather than any one section list's, because the space it is dragged
|
||||
// out over is mostly not a list's: a WrapPanel of cards is exactly as tall as its cards, and the gaps
|
||||
// between sections and below the last one belong to the stack around them. Tunnelled for the reason
|
||||
@@ -315,6 +322,16 @@ internal sealed partial class HostsScreen : UserControl
|
||||
return;
|
||||
}
|
||||
|
||||
// An arrow with the board itself focused — which is where this screen puts the keyboard, see
|
||||
// KeyboardTarget — goes into the cards: onto the selected one, or the first. Otherwise no arrow ever
|
||||
// reaches a section's list, since none of them has the keyboard until a card has been clicked.
|
||||
if (e.Key is Key.Up or Key.Down or Key.Left or Key.Right && ReferenceEquals(e.Source, Board))
|
||||
{
|
||||
e.Handled = EnterTheCards(vault);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if (e.Key is Key.A && e.KeyModifiers.HasFlag(KeyModifiers.Control) && vault.HasHostBoardEntries)
|
||||
{
|
||||
var order = vault.HostBoardOrder.ToList();
|
||||
@@ -347,6 +364,80 @@ internal sealed partial class HostsScreen : UserControl
|
||||
/// on the empty space means is decided on the release. See <see cref="OnBandReleased"/>.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
/// <summary>Enter on a card is the double-press, for somebody who got there with the arrows.</summary>
|
||||
/// <remarks>
|
||||
/// Only on a card, for the reason <see cref="OnHostActivated"/> gives: Enter with the board itself focused
|
||||
/// would connect to whatever was selected before, which is not something anyone is looking at. And not
|
||||
/// while cards are ticked, where the selection is not what the set is about.
|
||||
/// </remarks>
|
||||
private void OnCardEnter(object? sender, KeyEventArgs e)
|
||||
{
|
||||
if (e.Key is not Key.Enter
|
||||
|| e.KeyModifiers != KeyModifiers.None
|
||||
|| Vault is not { IsChoosingHosts: false } vault
|
||||
|| RowUnder(e.Source) is not HostRowViewModel row)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
vault.SelectedHost = row;
|
||||
|
||||
_ = vault.ConnectCommand.ExecuteAsync(null);
|
||||
e.Handled = true;
|
||||
}
|
||||
|
||||
/// <summary>Writes a selection the arrows made in one section's list back to the vault.</summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// The cards' <c>SelectedItem</c> is one-way, for the reason the markup gives: several lists rebuilt
|
||||
/// independently would each null the vault's selection on every filter keystroke and every sync pass. So
|
||||
/// the pointer writes it by hand, and until this nothing wrote it for the arrows — a card lit by the
|
||||
/// keyboard was not the one the drawer's CONNECT and DELETE then acted on, which is the same mistake the
|
||||
/// right-click handler exists to prevent.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// ◆ Only from the list that has the keyboard, and only for a card. A rebuild's reset arrives as a change
|
||||
/// to nothing, and the binding's own refills of the lists nobody is in arrive without the keyboard — both
|
||||
/// are exactly the writes the one-way binding keeps out, and they stay out. A click arrives here too, after
|
||||
/// <see cref="OnPointerPressed"/> has already written the same card, and changes nothing.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private void OnCardSelectionChanged(object? sender, SelectionChangedEventArgs e)
|
||||
{
|
||||
if (Vault is not { } vault
|
||||
|| e.Source is not ListBox { IsKeyboardFocusWithin: true, SelectedItem: HostRowViewModel row }
|
||||
|| ReferenceEquals(row, vault.SelectedHost))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (vault.IsChoosingHosts)
|
||||
{
|
||||
vault.ClearHostChoiceCommand.Execute(null);
|
||||
}
|
||||
|
||||
anchor = row;
|
||||
vault.SelectedHost = row;
|
||||
}
|
||||
|
||||
/// <summary>Hands the keyboard from the board to a card: the selected one if it is drawn, else the first.</summary>
|
||||
private bool EnterTheCards(VaultViewModel vault)
|
||||
{
|
||||
var cards = Board.GetVisualDescendants().OfType<ListBoxItem>().Where(card => card.IsEffectivelyVisible).ToList();
|
||||
|
||||
var card = cards.Find(card => ReferenceEquals(card.DataContext, vault.SelectedHost)) ?? cards.FirstOrDefault();
|
||||
|
||||
if (card?.DataContext is not HostRowViewModel row)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
vault.SelectedHost = row;
|
||||
anchor = row;
|
||||
|
||||
return card.Focus(NavigationMethod.Directional);
|
||||
}
|
||||
|
||||
private void OnBandPressed(object? sender, PointerPressedEventArgs e)
|
||||
{
|
||||
EndBand();
|
||||
|
||||
@@ -256,7 +256,8 @@
|
||||
</Border>
|
||||
|
||||
<!-- ============ The table ============ -->
|
||||
<Grid Grid.Column="1" RowDefinitions="Auto,Auto,*" Background="{StaticResource Pane}">
|
||||
<Grid Grid.Column="1" RowDefinitions="Auto,Auto,*" Background="{StaticResource Pane}"
|
||||
Grid.IsSharedSizeScope="True">
|
||||
|
||||
<Border Grid.Row="0" Padding="16,0" Height="44"
|
||||
BorderBrush="{StaticResource Border}" BorderThickness="0,0,0,1">
|
||||
@@ -275,12 +276,24 @@
|
||||
item this application stores carries a timestamp; see the file-level remark above and
|
||||
docs/design-import-gaps.md.
|
||||
-->
|
||||
<Grid Grid.Row="1" ColumnDefinitions="2,2.2*,1*,1*,1.4*" Margin="0,10,16,6"
|
||||
<!--
|
||||
VAULT is sized to what is in it, and shared between this heading and every row so the two agree:
|
||||
with one vault no row names one, and a fixed column was a heading over a stripe of nothing.
|
||||
-->
|
||||
<Grid Grid.Row="1" Margin="0,10,16,6"
|
||||
IsVisible="{Binding HasVaultItems}">
|
||||
<Grid.ColumnDefinitions>
|
||||
<ColumnDefinition Width="2" />
|
||||
<ColumnDefinition Width="3*" />
|
||||
<ColumnDefinition Width="1.1*" />
|
||||
<ColumnDefinition Width="Auto" SharedSizeGroup="KeychainVault" />
|
||||
<ColumnDefinition Width="1.2*" />
|
||||
</Grid.ColumnDefinitions>
|
||||
<TextBlock Grid.Column="1" Classes="label" Text="NAME" FontSize="9.5" LetterSpacing="1"
|
||||
Margin="12,0,8,0" />
|
||||
<TextBlock Grid.Column="2" Classes="label" Text="TYPE" FontSize="9.5" LetterSpacing="1" />
|
||||
<TextBlock Grid.Column="3" Classes="label" Text="VAULT" FontSize="9.5" LetterSpacing="1" />
|
||||
<TextBlock Grid.Column="3" Classes="label" Text="VAULT" FontSize="9.5" LetterSpacing="1"
|
||||
Margin="0,0,16,0" IsVisible="{Binding ShowsVaultColumn}" />
|
||||
<TextBlock Grid.Column="4" Classes="label" Text="USED BY" FontSize="9.5" LetterSpacing="1" />
|
||||
</Grid>
|
||||
|
||||
@@ -290,18 +303,31 @@
|
||||
Margin="8,0,8,10">
|
||||
<ListBox.ItemTemplate>
|
||||
<DataTemplate x:DataType="vm:VaultItemRowViewModel">
|
||||
<Grid ColumnDefinitions="2,2.2*,1*,1*,1.4*" Height="40" Margin="6,0,10,0">
|
||||
<StackPanel Grid.Column="1" Orientation="Horizontal" Spacing="10" Margin="10,0,8,0"
|
||||
VerticalAlignment="Center">
|
||||
<TextBlock FontFamily="{StaticResource IconFont}" FontSize="15"
|
||||
<Grid Height="40" Margin="6,0,10,0">
|
||||
<Grid.ColumnDefinitions>
|
||||
<ColumnDefinition Width="2" />
|
||||
<ColumnDefinition Width="3*" />
|
||||
<ColumnDefinition Width="1.1*" />
|
||||
<ColumnDefinition Width="Auto" SharedSizeGroup="KeychainVault" />
|
||||
<ColumnDefinition Width="1.2*" />
|
||||
</Grid.ColumnDefinitions>
|
||||
<!--
|
||||
A Grid rather than a horizontal StackPanel: the StackPanel measured the name with infinite
|
||||
width, so TextTrimming never fired and a long name printed over the TYPE and USED BY
|
||||
columns beside it.
|
||||
-->
|
||||
<Grid Grid.Column="1" ColumnDefinitions="Auto,*" Margin="10,0,8,0" VerticalAlignment="Center">
|
||||
<TextBlock Grid.Column="0" FontFamily="{StaticResource IconFont}" FontSize="15"
|
||||
Text="{Binding IconGlyph}" Foreground="{StaticResource AccentText}"
|
||||
VerticalAlignment="Center" />
|
||||
<TextBlock Classes="mono" Text="{Binding Name}" FontSize="12.5" FontWeight="Medium"
|
||||
Foreground="{StaticResource Text}" TextTrimming="CharacterEllipsis" />
|
||||
</StackPanel>
|
||||
VerticalAlignment="Center" Margin="0,0,10,0" />
|
||||
<TextBlock Grid.Column="1" Classes="mono" Text="{Binding Name}" FontSize="12.5"
|
||||
FontWeight="Medium" Foreground="{StaticResource Text}"
|
||||
TextTrimming="CharacterEllipsis" ToolTip.Tip="{Binding Name}" />
|
||||
</Grid>
|
||||
<TextBlock Grid.Column="2" Classes="mono" Text="{Binding Type}" FontSize="10.5"
|
||||
Foreground="{StaticResource TextGhost}" VerticalAlignment="Center" />
|
||||
<Border Grid.Column="3" Classes="chip" HorizontalAlignment="Left"
|
||||
Foreground="{StaticResource TextGhost}" VerticalAlignment="Center"
|
||||
TextTrimming="CharacterEllipsis" />
|
||||
<Border Grid.Column="3" Classes="chip" HorizontalAlignment="Left" Margin="0,0,16,0"
|
||||
VerticalAlignment="Center" IsVisible="{Binding HasVaultBadge}">
|
||||
<TextBlock Text="{Binding VaultBadge}" FontSize="10" />
|
||||
</Border>
|
||||
|
||||
@@ -332,7 +332,7 @@
|
||||
a sidebar naming no host would be furniture with nothing to say. Collapsing frees the
|
||||
"Auto" column it sits in, so the pane column takes the width back.
|
||||
-->
|
||||
<views:SessionSidebar Grid.Column="1" ShowsSnips="True"
|
||||
<views:SessionSidebar Grid.Column="1" ShowsSnips="True" ShowsForwards="True"
|
||||
IsVisible="{Binding ShowsQuickAccessSidebar, FallbackValue=False}" />
|
||||
</Grid>
|
||||
</Border>
|
||||
@@ -383,7 +383,12 @@
|
||||
not replayed. See MainWindow.axaml.cs.
|
||||
-->
|
||||
<TextBox x:Name="ServerUrlBox" Text="{Binding ServerUrl}"
|
||||
PlaceholderText="https://dodossh.example" />
|
||||
PlaceholderText="https://dodossh.example">
|
||||
<!-- Enter signs in, as it unlocks on the unlock card. -->
|
||||
<TextBox.KeyBindings>
|
||||
<KeyBinding Gesture="Enter" Command="{Binding SignInCommand}" />
|
||||
</TextBox.KeyBindings>
|
||||
</TextBox>
|
||||
<Button Classes="accent" Content="SIGN IN WITH YOUR BROWSER" Command="{Binding SignInCommand}"
|
||||
IsEnabled="{Binding !IsBusy}" HorizontalAlignment="Left" />
|
||||
<TextBlock Classes="hint" Text="{Binding StatusMessage}" />
|
||||
@@ -395,8 +400,14 @@
|
||||
<TextBlock Classes="heading" Text="Choose a keychain passphrase" />
|
||||
<TextBlock Classes="hint"
|
||||
Text="This passphrase never leaves this machine, and the server cannot reset it. It is the only thing standing between a stolen copy of the database and every credential in your keychain." />
|
||||
<TextBox Text="{Binding Passphrase}" PlaceholderText="passphrase" PasswordChar="•" />
|
||||
<TextBox Text="{Binding ConfirmPassphrase}" PlaceholderText="again" PasswordChar="•" />
|
||||
<TextBox x:Name="NewPassphraseBox" Text="{Binding Passphrase}" PlaceholderText="passphrase"
|
||||
PasswordChar="•" />
|
||||
<TextBox Text="{Binding ConfirmPassphrase}" PlaceholderText="again" PasswordChar="•">
|
||||
<!-- On the second box only: Enter in the first moves nowhere useful, Enter here is "done". -->
|
||||
<TextBox.KeyBindings>
|
||||
<KeyBinding Gesture="Enter" Command="{Binding EnrollCommand}" />
|
||||
</TextBox.KeyBindings>
|
||||
</TextBox>
|
||||
<Button Classes="accent" Content="CREATE MY KEYCHAIN" Command="{Binding EnrollCommand}"
|
||||
IsEnabled="{Binding !IsBusy}" HorizontalAlignment="Left" />
|
||||
<TextBlock Classes="hint" Text="{Binding StatusMessage}" />
|
||||
|
||||
@@ -33,6 +33,11 @@ internal sealed partial class MainWindow : Window
|
||||
|
||||
private bool wasUnlocked;
|
||||
|
||||
/// <summary>Which closed-vault card the keyboard was last sent to, so it is sent once per card.</summary>
|
||||
private ShellState? closedState;
|
||||
|
||||
private bool wasAskingAboutHostKey;
|
||||
|
||||
public MainWindow()
|
||||
{
|
||||
InitializeComponent();
|
||||
@@ -184,6 +189,7 @@ internal sealed partial class MainWindow : Window
|
||||
{
|
||||
ShellState.Locked => UnlockPane.PassphraseBox,
|
||||
ShellState.NeedsServer => ServerUrlBox,
|
||||
ShellState.NeedsEnrollment => NewPassphraseBox,
|
||||
_ => this,
|
||||
};
|
||||
|
||||
@@ -226,33 +232,96 @@ internal sealed partial class MainWindow : Window
|
||||
size.Execute(null);
|
||||
e.Handled = true;
|
||||
}
|
||||
// A host-key decision before the palette, because it is drawn over the palette: Escape is CANCEL or
|
||||
// CLOSE, both of which refuse — never the answer that connects. See HostKeyCard.SafeAnswer.
|
||||
else if (e.Key == Key.Escape && viewModel.IsHostKeyDecisionShowing)
|
||||
{
|
||||
viewModel.Vault?.RejectHostKeyCommand.Execute(null);
|
||||
e.Handled = true;
|
||||
}
|
||||
else if (viewModel.IsSearching)
|
||||
{
|
||||
Palette.HandleKey(e);
|
||||
}
|
||||
// v5c: Escape leaves settings mode, the same full-window-state idiom the palette's own Escape
|
||||
// already follows one branch up. Checked after the palette rather than before it: the two states
|
||||
// are mutually exclusive in practice — opening the palette does not enter settings mode and entering
|
||||
// settings does not open the palette — but an Escape while both were somehow true should close the
|
||||
// thing drawn on top, which is the palette.
|
||||
//
|
||||
// v5c: with the importer up, Escape closes only that — the same "closest thing first" rule, and the
|
||||
// same one the titlebar's own back button follows by showing "Back to preferences" rather than
|
||||
// "Back to application" while IsImportOpen is true.
|
||||
else if (e.Key == Key.Escape && viewModel.IsImportOpen)
|
||||
else if (e.Key == Key.Escape && CloseTheNearestThing(viewModel))
|
||||
{
|
||||
viewModel.CloseImportCommand.Execute(null);
|
||||
e.Handled = true;
|
||||
}
|
||||
else if (e.Key == Key.Escape && viewModel.IsSettingsMode)
|
||||
{
|
||||
viewModel.LeaveSettingsCommand.Execute(null);
|
||||
e.Handled = true;
|
||||
}
|
||||
|
||||
base.OnKeyDown(e);
|
||||
}
|
||||
|
||||
/// <summary>What Escape closes when the palette is not up: the thing drawn nearest the user.</summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// One rule throughout — closest thing first — so the order of these arms is the order things are drawn
|
||||
/// over one another. A confirmation before anything, because it is a question in front of whatever page
|
||||
/// it is on, including a settings page: Escape on the sign-out question cancels it and stays in settings.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// v5c: Escape leaves settings mode, the same full-window-state idiom the palette's own Escape already
|
||||
/// follows in the caller. Checked after the palette rather than before it: the two states are mutually
|
||||
/// exclusive in practice — opening the palette does not enter settings mode and entering settings does
|
||||
/// not open the palette — but an Escape while both were somehow true should close the thing drawn on
|
||||
/// top, which is the palette.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// v5c: with the importer up, Escape closes only that — the same rule, and the same one the titlebar's own
|
||||
/// back button follows by showing "Back to preferences" rather than "Back to application" while
|
||||
/// IsImportOpen is true. The members dialog on Settings → Vaults likewise: it is drawn over the page, so
|
||||
/// it goes first and settings stays.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Last, because it is the furthest thing back: the hosts drawer, which Escape puts away exactly as its
|
||||
/// own arrow does — an open editor abandoned, the selection kept. See VaultViewModel.CloseDrawer.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private static bool CloseTheNearestThing(MainWindowViewModel viewModel)
|
||||
{
|
||||
if (AnswerNoToTheQuestionShowing(viewModel))
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
var close = viewModel switch
|
||||
{
|
||||
{ IsImportOpen: true } => viewModel.CloseImportCommand,
|
||||
{ IsSettingsMode: true, Vaults.IsMembersPanelOpen: true } => viewModel.Vaults.CloseMembersPanelCommand,
|
||||
{ IsSettingsMode: true } => viewModel.LeaveSettingsCommand,
|
||||
{ IsUnlocked: true, IsTerminalShowing: false, Screen: ShellScreen.Hosts, Vault: { IsDrawerOpen: true } vault }
|
||||
=> vault.CloseDrawerCommand,
|
||||
_ => null,
|
||||
};
|
||||
|
||||
close?.Execute(null);
|
||||
|
||||
return close is not null;
|
||||
}
|
||||
|
||||
/// <summary>Escape on a confirmation drawn in place: the sign-out one, or a deletion's.</summary>
|
||||
/// <remarks>
|
||||
/// Both answers it gives are CANCEL, which is the only thing a key with no label is allowed to mean on a
|
||||
/// question about destroying something. A deletion question left armed on a screen somebody navigated away
|
||||
/// from is cancelled by it too, which is harmless — it is the same answer the question would get if it
|
||||
/// were on screen — and cheaper than deciding which of the six places that card is drawn is showing.
|
||||
/// </remarks>
|
||||
private static bool AnswerNoToTheQuestionShowing(MainWindowViewModel viewModel)
|
||||
{
|
||||
if (viewModel.IsConfirmingSignOut)
|
||||
{
|
||||
viewModel.CancelSignOutCommand.Execute(null);
|
||||
return true;
|
||||
}
|
||||
|
||||
if (viewModel is { IsUnlocked: true, IsTerminalShowing: false, Vault: { IsConfirmingDeletion: true } vault })
|
||||
{
|
||||
vault.CancelDeleteCommand.Execute(null);
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The text-size chords, when the terminal is not the thing hearing them.
|
||||
/// </summary>
|
||||
@@ -300,6 +369,15 @@ internal sealed partial class MainWindow : Window
|
||||
Terminal.Source = viewModel.TerminalPageUrl;
|
||||
|
||||
wasUnlocked = viewModel.IsUnlocked;
|
||||
closedState = null;
|
||||
wasAskingAboutHostKey = viewModel.IsHostKeyDecisionShowing;
|
||||
|
||||
// The shell may have reached its card before this window was given it, and then no change would
|
||||
// ever say so.
|
||||
if (!viewModel.IsUnlocked)
|
||||
{
|
||||
FocusClosedVaultCard(viewModel);
|
||||
}
|
||||
|
||||
viewModel.TerminalSessionOpened += OnTerminalSessionOpened;
|
||||
viewModel.TerminalFocusRequested += OnTerminalFocusRequested;
|
||||
@@ -358,6 +436,10 @@ internal sealed partial class MainWindow : Window
|
||||
OnSelectedTabChanged(viewModel);
|
||||
break;
|
||||
|
||||
case nameof(MainWindowViewModel.IsHostKeyDecisionShowing):
|
||||
OnHostKeyDecision(viewModel);
|
||||
break;
|
||||
|
||||
default:
|
||||
break;
|
||||
}
|
||||
@@ -373,10 +455,77 @@ internal sealed partial class MainWindow : Window
|
||||
{
|
||||
ReleaseKeyboardTo(ClosedVaultKeyboardHome);
|
||||
}
|
||||
else if (!unlocked && viewModel.State != closedState)
|
||||
{
|
||||
FocusClosedVaultCard(viewModel);
|
||||
}
|
||||
|
||||
closedState = unlocked ? null : viewModel.State;
|
||||
wasUnlocked = unlocked;
|
||||
}
|
||||
|
||||
/// <summary>Hands the keyboard to the box on whichever card a closed vault is showing.</summary>
|
||||
/// <remarks>
|
||||
/// For arriving at a card other than by locking — launch landing on the unlock card, a sign-in finishing
|
||||
/// on the enrolment one — which used to leave the passphrase somebody started typing going nowhere. Once
|
||||
/// per card, which is what keeps it from moving the keyboard while somebody is mid-sign-in: IsUnlocked is
|
||||
/// raised for every state change, and the state does not change while they type. Posted, because the card
|
||||
/// is revealed by a binding the same change has not reached yet.
|
||||
/// </remarks>
|
||||
private void FocusClosedVaultCard(MainWindowViewModel viewModel)
|
||||
{
|
||||
closedState = viewModel.State;
|
||||
|
||||
var home = ClosedVaultKeyboardHome;
|
||||
|
||||
Dispatcher.UIThread.Post(() => home.Focus(), DispatcherPriority.Loaded);
|
||||
}
|
||||
|
||||
/// <summary>Gives the host-key card the keyboard when it appears, and gives it back when it goes.</summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// It used to appear with the keyboard wherever it had been — often inside the terminal it covers, whose
|
||||
/// native window goes on holding it after the WebView is collapsed, so the card took no keys at all and
|
||||
/// Tab walked the page under it. Hence <see cref="ReleaseKeyboardTo"/> rather than <c>Focus()</c>, and
|
||||
/// posted, because the binding that reveals the card has not run yet.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Latched, because the flag is re-raised with every change to the terminal's state and the keyboard must
|
||||
/// move once per question, not once per raise. On the way out the keyboard goes where the window would
|
||||
/// put it for whatever is now showing; a connection that went ahead moves it again when its terminal opens.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private void OnHostKeyDecision(MainWindowViewModel viewModel)
|
||||
{
|
||||
var asking = viewModel.IsHostKeyDecisionShowing;
|
||||
|
||||
if (asking == wasAskingAboutHostKey)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
wasAskingAboutHostKey = asking;
|
||||
|
||||
Dispatcher.UIThread.Post(
|
||||
() =>
|
||||
{
|
||||
if (shell != viewModel || viewModel.IsHostKeyDecisionShowing != asking)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (asking)
|
||||
{
|
||||
ReleaseKeyboardTo(HostKeyPane.SafeAnswer);
|
||||
}
|
||||
else
|
||||
{
|
||||
OnShowingSomethingElse(viewModel);
|
||||
}
|
||||
},
|
||||
DispatcherPriority.Loaded);
|
||||
}
|
||||
|
||||
/// <remarks>
|
||||
/// Closing only. Opening also has to move the keyboard — the palette is a text box somebody is expected
|
||||
/// to start typing into immediately — but the palette does that for itself when it becomes visible,
|
||||
|
||||
@@ -0,0 +1,81 @@
|
||||
using System.ComponentModel;
|
||||
using Avalonia.Controls;
|
||||
using Avalonia.Threading;
|
||||
using Avalonia.VisualTree;
|
||||
|
||||
namespace DodoSSH.Client.App.Views;
|
||||
|
||||
/// <summary>
|
||||
/// Hands the keyboard to a confirmation's harmless answer when the question appears.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// For the questions drawn in place on a page — the deletion and the sign-out confirmations — which used to
|
||||
/// appear with the keyboard still on the button that asked them, or nowhere. Tab then walked the page behind
|
||||
/// the question, Enter did nothing useful, and somebody working from the keyboard had to reach for the mouse
|
||||
/// to say no.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// ◆ <b>The harmless answer, never the one the question is about.</b> Enter on a focused button presses it,
|
||||
/// so the button that takes the keyboard is the one an accidental Enter is allowed to press: CANCEL. Putting it
|
||||
/// on DELETE or SIGN OUT AND DELETE would make two keystrokes — the one that asked and the one after — a way to
|
||||
/// destroy something without reading the sentence in between.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Each card follows its own question rather than the window following all of them, because the same card is
|
||||
/// drawn in several places and only the one somebody can see should take the keyboard — which the posted
|
||||
/// check on <c>IsEffectivelyVisible</c> decides, after the binding that reveals it has run. Subscribed only
|
||||
/// while the card is in the tree: settings pages are rebuilt as they are visited, and a card that subscribed
|
||||
/// for good would leave one handler on the long-lived view model per visit.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal static class SafeAnswerFocus
|
||||
{
|
||||
internal static void Follow(Control card, string question, Func<Control> safeAnswer)
|
||||
{
|
||||
INotifyPropertyChanged? watched = null;
|
||||
|
||||
void OnChanged(object? sender, PropertyChangedEventArgs e)
|
||||
{
|
||||
if (!string.Equals(e.PropertyName, question, StringComparison.Ordinal))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
Dispatcher.UIThread.Post(
|
||||
() =>
|
||||
{
|
||||
if (safeAnswer() is { IsEffectivelyVisible: true } answer)
|
||||
{
|
||||
answer.Focus();
|
||||
}
|
||||
},
|
||||
DispatcherPriority.Loaded);
|
||||
}
|
||||
|
||||
void Watch(INotifyPropertyChanged? next)
|
||||
{
|
||||
if (watched is not null)
|
||||
{
|
||||
watched.PropertyChanged -= OnChanged;
|
||||
}
|
||||
|
||||
watched = next;
|
||||
|
||||
if (watched is not null)
|
||||
{
|
||||
watched.PropertyChanged += OnChanged;
|
||||
}
|
||||
}
|
||||
|
||||
card.AttachedToVisualTree += (_, _) => Watch(card.DataContext as INotifyPropertyChanged);
|
||||
card.DetachedFromVisualTree += (_, _) => Watch(null);
|
||||
card.DataContextChanged += (_, _) =>
|
||||
{
|
||||
if (card.IsAttachedToVisualTree())
|
||||
{
|
||||
Watch(card.DataContext as INotifyPropertyChanged);
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
@@ -39,6 +39,22 @@
|
||||
is showing without knowing anything about the state — and the pane beside it grows into what is freed.
|
||||
-->
|
||||
|
||||
<!--
|
||||
A forward's state word: green only while it is listening, which is the one status Live is for, and the
|
||||
danger text colour for a forward that could not start. OFF and STARTING stay faint.
|
||||
-->
|
||||
<UserControl.Styles>
|
||||
<Style Selector="TextBlock.fwdstate">
|
||||
<Setter Property="Foreground" Value="{StaticResource TextFaint}" />
|
||||
</Style>
|
||||
<Style Selector="TextBlock.fwdstate.live">
|
||||
<Setter Property="Foreground" Value="{StaticResource Live}" />
|
||||
</Style>
|
||||
<Style Selector="TextBlock.fwdstate.failed">
|
||||
<Setter Property="Foreground" Value="{StaticResource DangerText}" />
|
||||
</Style>
|
||||
</UserControl.Styles>
|
||||
|
||||
<Panel>
|
||||
|
||||
<!-- ============ THE RAIL, WHEN THE COLUMN IS CLOSED ============ -->
|
||||
@@ -142,6 +158,64 @@
|
||||
</StackPanel>
|
||||
</Button>
|
||||
|
||||
<!-- ============ FORWARDS (the terminal surface only) ============ -->
|
||||
<!--
|
||||
The selected tab's forwards: the host's saved ones, as they run over this session. Each row is
|
||||
its own switch, and a failed one says why under its notation — a port already taken, most often
|
||||
by a second tab to the same host running the same forwards. Nothing here edits a forward; the add
|
||||
row goes to the host's editor, where they are saved, as Pin folder does for QUICK ACCESS.
|
||||
|
||||
No byte counts, which the design draws. SSH.NET keeps no count of what a forward carries, so a
|
||||
number here would be invented.
|
||||
-->
|
||||
<StackPanel Spacing="6" Margin="0,16,0,0" IsVisible="{Binding #Root.ShowsForwards}">
|
||||
|
||||
<TextBlock Classes="label" Text="FORWARDS" FontSize="10" Margin="8,0" />
|
||||
|
||||
<ItemsControl ItemsSource="{Binding SelectedTab.Forwards}">
|
||||
<ItemsControl.ItemTemplate>
|
||||
<DataTemplate x:DataType="vm:PortForwardViewModel">
|
||||
<!--
|
||||
The reason sits under the row rather than inside it: a sidebar row is a fixed 33 pixels, and
|
||||
a refusal is a sentence. Indented to the notation, so it reads as belonging to the row.
|
||||
-->
|
||||
<StackPanel>
|
||||
<Button Classes="sidebarrow" Command="{Binding ToggleCommand}"
|
||||
ToolTip.Tip="{Binding Route}">
|
||||
<Grid ColumnDefinitions="Auto,*,Auto">
|
||||
<TextBlock Grid.Column="0" Text=""
|
||||
FontFamily="{StaticResource IconFont}" FontSize="15"
|
||||
Foreground="{StaticResource AccentText}" VerticalAlignment="Center"
|
||||
Margin="0,0,10,0" />
|
||||
<TextBlock Grid.Column="1" FontFamily="{StaticResource MonoFont}" FontSize="12.5"
|
||||
Text="{Binding Notation}" TextTrimming="CharacterEllipsis"
|
||||
VerticalAlignment="Center" />
|
||||
<TextBlock Grid.Column="2" Classes="fwdstate" FontFamily="Montserrat"
|
||||
FontWeight="SemiBold" FontSize="9" LetterSpacing="1"
|
||||
VerticalAlignment="Center" Margin="8,0,0,0"
|
||||
Text="{Binding StateText}"
|
||||
Classes.live="{Binding IsListening}" Classes.failed="{Binding IsFailed}" />
|
||||
</Grid>
|
||||
</Button>
|
||||
<TextBlock FontSize="11" Foreground="{StaticResource TextFaint}" TextWrapping="Wrap"
|
||||
Margin="37,0,12,4" Text="{Binding Detail}"
|
||||
IsVisible="{Binding Detail, Converter={x:Static StringConverters.IsNotNullOrEmpty}}" />
|
||||
</StackPanel>
|
||||
</DataTemplate>
|
||||
</ItemsControl.ItemTemplate>
|
||||
</ItemsControl>
|
||||
|
||||
<Button Classes="sidebaradd" Command="{Binding AddForwardFromSidebarCommand}"
|
||||
ToolTip.Tip="Opens the active tab's host for editing, where its forwards are saved. A new forward starts with the next connection.">
|
||||
<StackPanel Orientation="Horizontal" Spacing="10">
|
||||
<TextBlock Text="" FontFamily="{StaticResource IconFont}" FontSize="14"
|
||||
VerticalAlignment="Center" />
|
||||
<TextBlock Text="Add forward" VerticalAlignment="Center" />
|
||||
</StackPanel>
|
||||
</Button>
|
||||
|
||||
</StackPanel>
|
||||
|
||||
<!-- ============ SNIPS (the terminal surface only) ============ -->
|
||||
<StackPanel Spacing="6" Margin="0,16,0,0" IsVisible="{Binding #Root.ShowsSnips}">
|
||||
|
||||
|
||||
@@ -19,6 +19,10 @@ internal sealed partial class SessionSidebar : UserControl
|
||||
internal static readonly StyledProperty<bool> ShowsSnipsProperty =
|
||||
AvaloniaProperty.Register<SessionSidebar, bool>(nameof(ShowsSnips));
|
||||
|
||||
/// <summary>Whether the FORWARDS section draws. The terminal's own, for the reason SNIPS is.</summary>
|
||||
internal static readonly StyledProperty<bool> ShowsForwardsProperty =
|
||||
AvaloniaProperty.Register<SessionSidebar, bool>(nameof(ShowsForwards));
|
||||
|
||||
public SessionSidebar() => InitializeComponent();
|
||||
|
||||
internal bool ShowsSnips
|
||||
@@ -26,4 +30,10 @@ internal sealed partial class SessionSidebar : UserControl
|
||||
get => GetValue(ShowsSnipsProperty);
|
||||
set => SetValue(ShowsSnipsProperty, value);
|
||||
}
|
||||
|
||||
internal bool ShowsForwards
|
||||
{
|
||||
get => GetValue(ShowsForwardsProperty);
|
||||
set => SetValue(ShowsForwardsProperty, value);
|
||||
}
|
||||
}
|
||||
@@ -76,6 +76,13 @@
|
||||
</StackPanel>
|
||||
|
||||
<StackPanel Grid.Column="1" Orientation="Horizontal" Spacing="18" VerticalAlignment="Center">
|
||||
<!--
|
||||
How many of the selected tab's forwards are listening, and nothing when none are. The terminal's
|
||||
own, for the reason UTF-8 is: an SFTP connection runs no forwards.
|
||||
-->
|
||||
<TextBlock Classes="mono" FontSize="11.5" Foreground="{StaticResource TextGhost}"
|
||||
VerticalAlignment="Center" Text="{Binding SelectedTab.ForwardsSummary}"
|
||||
IsVisible="{Binding #Root.ShowsEncoding}" />
|
||||
<TextBlock Classes="mono" FontSize="11.5" Foreground="{StaticResource TextGhost}"
|
||||
VerticalAlignment="Center" Text="{Binding SessionElapsedText}"
|
||||
IsVisible="{Binding SessionElapsedText, Converter={x:Static StringConverters.IsNotNullOrEmpty}}" />
|
||||
|
||||
@@ -86,7 +86,14 @@
|
||||
Classes.connecting="{Binding IsConnecting}"
|
||||
Classes.dropped="{Binding IsDropped}"
|
||||
VerticalAlignment="Center" />
|
||||
<TextBlock Text="{Binding Label}" VerticalAlignment="Center" />
|
||||
<!--
|
||||
Bounded. A label is whatever the host was called, or the address typed into the palette,
|
||||
and one long one used to push every tab after it and the "+" past the strip's edge. The
|
||||
whole of it is on the label's own tooltip; the tab's is the address, as before.
|
||||
-->
|
||||
<TextBlock Text="{Binding Label}" VerticalAlignment="Center"
|
||||
MaxWidth="200" TextTrimming="CharacterEllipsis"
|
||||
ToolTip.Tip="{Binding Label}" />
|
||||
|
||||
<Button Classes="flat close inline" Width="16" Height="16" Padding="0"
|
||||
VerticalAlignment="Center"
|
||||
|
||||
@@ -136,7 +136,7 @@
|
||||
<Border Classes="settingscard">
|
||||
<StackPanel Margin="24,20" Spacing="10">
|
||||
<TextBlock Classes="settingsrowcaption"
|
||||
Text="Unlocking with Windows Hello moved to Security — it registers this machine rather than a preference of this screen's, and Security is where the rest of this machine's trust facts live." />
|
||||
Text="Unlocking with this machine's device key moved to Security — it registers this machine rather than a preference of this screen's, and Security is where the rest of this machine's trust facts live." />
|
||||
<TextBlock Classes="settingsrowcaption"
|
||||
Text="Terminal font, cursor and scrollback — the renderer hard-codes those three. Text size above is the one that is not." />
|
||||
<TextBlock Classes="settingsrowcaption"
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
<UserControl xmlns="https://github.com/avaloniaui"
|
||||
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
|
||||
xmlns:vm="using:DodoSSH.Client.Shell.ViewModels"
|
||||
xmlns:views="using:DodoSSH.Client.App.Views"
|
||||
x:Class="DodoSSH.Client.App.Views.SettingsSecurityPage"
|
||||
x:DataType="vm:MainWindowViewModel">
|
||||
x:DataType="vm:MainWindowViewModel"
|
||||
x:Name="Root">
|
||||
|
||||
<!--
|
||||
v5c: Security, against Settings-Security.dc.html.
|
||||
@@ -24,6 +26,14 @@
|
||||
on purpose — known-hosts is a MAIN-chrome screen, and there is no honest way to show it without leaving;
|
||||
ShowScreenCommand already does that for any target that is not Preferences or Vaults.
|
||||
|
||||
SPELUNK is where a Spelunk API key is filled in: an address and a key, saved as a Spelunk key item in the
|
||||
personal vault (VaultViewModel.SaveSpelunkKeyCommand) and synced like every secret. The address is the
|
||||
point — a key saved here is only ever sent there, and links from that Spelunk connect straight away
|
||||
because saving it is the user saying so. A second key for an address already saved replaces the first.
|
||||
The key box is a password box and is emptied the moment the key is in the keychain; the list below it
|
||||
shows the name, the address and how many hosts use each key, never the key. Deleting goes through the
|
||||
same ConfirmDeleteCard every other deletion does, with a count of the hosts that would stop connecting.
|
||||
|
||||
RECENT SECURITY EVENTS is the link row alone, not the design's own list of rows. A real list would mean
|
||||
building a filtered read over LogsViewModel's activity and connection logs — which entries count as
|
||||
"security" is itself a judgement call the design does not resolve — and the honest link is complete on
|
||||
@@ -36,19 +46,21 @@
|
||||
<TextBlock Classes="settingstitle" Text="Security" />
|
||||
|
||||
<Border Classes="settingscard" Margin="0,26,0,0" Padding="20,20">
|
||||
<StackPanel Orientation="Horizontal" Spacing="16">
|
||||
<Border Width="44" Height="44" CornerRadius="12" Background="#103A2F">
|
||||
<!-- A Grid, so the caption is measured against the card's width and wraps inside it. -->
|
||||
<Grid ColumnDefinitions="Auto,*">
|
||||
<Border Grid.Column="0" Width="44" Height="44" CornerRadius="12" Background="#103A2F"
|
||||
Margin="0,0,16,0" VerticalAlignment="Top">
|
||||
<TextBlock FontFamily="{StaticResource IconFont}" Text="" FontSize="20"
|
||||
Foreground="{StaticResource Live}"
|
||||
HorizontalAlignment="Center" VerticalAlignment="Center" />
|
||||
</Border>
|
||||
<StackPanel Spacing="6" VerticalAlignment="Center">
|
||||
<StackPanel Grid.Column="1" Spacing="6" VerticalAlignment="Center">
|
||||
<TextBlock Text="End-to-end encrypted" FontSize="15" FontWeight="Bold" LetterSpacing="-0.2"
|
||||
Foreground="{StaticResource Text}" />
|
||||
<TextBlock Classes="settingsrowcaption"
|
||||
<TextBlock Classes="settingsrowcaption" TextWrapping="Wrap"
|
||||
Text="Every vault item is sealed on your devices. The server and the relay both store ciphertext and timestamps only — neither can read a single field." />
|
||||
</StackPanel>
|
||||
</StackPanel>
|
||||
</Grid>
|
||||
</Border>
|
||||
|
||||
<TextBlock Classes="settingssection" Text="UNLOCKING" />
|
||||
@@ -58,15 +70,15 @@
|
||||
<Border Classes="settingsrow last">
|
||||
<Grid ColumnDefinitions="*,Auto">
|
||||
<StackPanel Grid.Column="0" Spacing="6" Margin="0,0,16,0" MaxWidth="640">
|
||||
<TextBlock Classes="settingsrowtitle" Text="Windows Hello on this machine" />
|
||||
<TextBlock Classes="settingsrowtitle" Text="{Binding DeviceUnlock.Name}" />
|
||||
<TextBlock Classes="settingsrowcaption"
|
||||
Text="Registers this machine so a later launch can open the keychain with a Windows confirmation instead of your passphrase. Your passphrase keeps working."
|
||||
Text="{Binding DeviceUnlock.Offer}"
|
||||
IsVisible="{Binding CanRegisterDevice}" />
|
||||
<TextBlock Classes="settingsrowcaption"
|
||||
Text="Registered · the TPM holds a device key that can open the keychain with a Windows confirmation."
|
||||
Text="{Binding DeviceUnlock.Registered}"
|
||||
IsVisible="{Binding CanForgetDevice}" />
|
||||
<TextBlock Classes="settingsrowcaption"
|
||||
Text="This machine has nowhere to keep a device key, so the keychain will keep asking for your passphrase. That needs a TPM and a Windows keystore willing to release the key."
|
||||
Text="{Binding DeviceUnlock.Unavailable}"
|
||||
IsVisible="{Binding HasNoDeviceKeyOption}" />
|
||||
</StackPanel>
|
||||
<Button Grid.Column="1" Classes="accent" Height="38" Content="REGISTER"
|
||||
@@ -101,6 +113,86 @@
|
||||
</StackPanel>
|
||||
</Border>
|
||||
|
||||
<TextBlock Classes="settingssection" Text="SPELUNK" />
|
||||
|
||||
<Border Classes="settingscard">
|
||||
<StackPanel>
|
||||
<Border Classes="settingsrow">
|
||||
<StackPanel Spacing="10">
|
||||
<StackPanel Spacing="6" MaxWidth="640" HorizontalAlignment="Left">
|
||||
<TextBlock Classes="settingsrowtitle" Text="Spelunk API key" />
|
||||
<TextBlock Classes="settingsrowcaption" TextWrapping="Wrap"
|
||||
Text="Hosts reached through Spelunk use this key, and links from that Spelunk connect straight away. It is kept encrypted in your personal vault, syncs to your other devices, and is only ever sent to the address below. Use a key with the Admin role." />
|
||||
</StackPanel>
|
||||
<Grid ColumnDefinitions="*,*,Auto" ColumnSpacing="10"
|
||||
IsEnabled="{Binding Vault, Converter={x:Static ObjectConverters.IsNotNull}}">
|
||||
<TextBox Grid.Column="0" Height="38" Text="{Binding Vault.SpelunkKeyFormApi}"
|
||||
PlaceholderText="Spelunk API address (https://api.…)" />
|
||||
<TextBox Grid.Column="1" Height="38" PasswordChar="•" Text="{Binding Vault.SpelunkKeyFormKey}"
|
||||
PlaceholderText="API key (spelunk_…)">
|
||||
<TextBox.KeyBindings>
|
||||
<KeyBinding Gesture="Enter" Command="{Binding Vault.SaveSpelunkKeyCommand}" />
|
||||
</TextBox.KeyBindings>
|
||||
</TextBox>
|
||||
<Button Grid.Column="2" Classes="accent" Height="38" Content="SAVE KEY"
|
||||
Command="{Binding Vault.SaveSpelunkKeyCommand}"
|
||||
IsEnabled="{Binding !Vault.IsBusy, FallbackValue=False}" />
|
||||
</Grid>
|
||||
<TextBlock Classes="settingsrowcaption" TextWrapping="Wrap"
|
||||
Text="{Binding Vault.SpelunkKeyFormNote}"
|
||||
IsVisible="{Binding Vault.HasSpelunkKeyFormNote, FallbackValue=False}" />
|
||||
<TextBlock Classes="settingsrowcaption" TextWrapping="Wrap"
|
||||
IsVisible="{Binding Vault, Converter={x:Static ObjectConverters.IsNull}}"
|
||||
Text="Unlock your keychain to save a Spelunk key." />
|
||||
</StackPanel>
|
||||
</Border>
|
||||
|
||||
<!-- The delete confirmation, in place, as the tags and groups pages draw it. -->
|
||||
<Border Margin="24,12" Padding="20" CornerRadius="12"
|
||||
Background="{StaticResource DangerWash}" BorderBrush="{StaticResource DangerSoft}"
|
||||
BorderThickness="1"
|
||||
IsVisible="{Binding Vault.PendingDeletion, Converter={x:Static ObjectConverters.IsNotNull}, FallbackValue=False}">
|
||||
<views:ConfirmDeleteCard DataContext="{Binding Vault}" />
|
||||
</Border>
|
||||
|
||||
<ItemsControl ItemsSource="{Binding Vault.SpelunkKeys}">
|
||||
<ItemsControl.ItemsPanel>
|
||||
<ItemsPanelTemplate>
|
||||
<StackPanel />
|
||||
</ItemsPanelTemplate>
|
||||
</ItemsControl.ItemsPanel>
|
||||
<ItemsControl.ItemTemplate>
|
||||
<DataTemplate x:DataType="vm:SpelunkKeyRowViewModel">
|
||||
<Border Classes="settingsrow" Padding="24,14">
|
||||
<Grid ColumnDefinitions="*,Auto,Auto" ColumnSpacing="12">
|
||||
<StackPanel Grid.Column="0" Spacing="4" VerticalAlignment="Center">
|
||||
<StackPanel Orientation="Horizontal" Spacing="8">
|
||||
<TextBlock Classes="settingsrowtitle" Text="{Binding Label}" />
|
||||
<Border Classes="chip" IsVisible="{Binding HasVaultBadge}" VerticalAlignment="Center">
|
||||
<TextBlock Text="{Binding VaultBadge}" />
|
||||
</Border>
|
||||
<TextBlock Classes="hint" FontSize="11" Text="{Binding Badge}" VerticalAlignment="Center" />
|
||||
</StackPanel>
|
||||
<TextBlock Classes="mono" FontSize="11.5" Foreground="{StaticResource TextFaint}"
|
||||
Text="{Binding ApiBase}" />
|
||||
</StackPanel>
|
||||
<TextBlock Grid.Column="1" Classes="settingsrowcaption" VerticalAlignment="Center"
|
||||
Text="{Binding UsedBy}" />
|
||||
<Button Grid.Column="2" Classes="paneicon danger" Width="30" Height="30" FontSize="13"
|
||||
VerticalAlignment="Center"
|
||||
Command="{Binding #Root.((vm:MainWindowViewModel)DataContext).Vault.DeleteSpelunkKeyRowCommand}"
|
||||
CommandParameter="{Binding}"
|
||||
ToolTip.Tip="Delete this key. Hosts that reach Spelunk with it stop connecting until they name another.">
|
||||
<TextBlock FontFamily="{StaticResource IconFont}" Text="" />
|
||||
</Button>
|
||||
</Grid>
|
||||
</Border>
|
||||
</DataTemplate>
|
||||
</ItemsControl.ItemTemplate>
|
||||
</ItemsControl>
|
||||
</StackPanel>
|
||||
</Border>
|
||||
|
||||
<TextBlock Classes="settingssection" Text="RECENT SECURITY EVENTS" />
|
||||
|
||||
<Border Classes="settingscard" Margin="0,12,0,40">
|
||||
|
||||
@@ -2,7 +2,9 @@ using Avalonia.Controls;
|
||||
|
||||
namespace DodoSSH.Client.App.Views;
|
||||
|
||||
/// <summary>Settings mode's Security page: the E2E explainer, Windows Hello, and approved host keys.</summary>
|
||||
/// <summary>
|
||||
/// Settings mode's Security page: the E2E explainer, Windows Hello, approved host keys, and Spelunk API keys.
|
||||
/// </summary>
|
||||
internal sealed partial class SettingsSecurityPage : UserControl
|
||||
{
|
||||
public SettingsSecurityPage() => InitializeComponent();
|
||||
|
||||
@@ -81,11 +81,15 @@
|
||||
IsVisible="{Binding Vault, Converter={x:Static ObjectConverters.IsNotNull}}">
|
||||
<StackPanel>
|
||||
|
||||
<Grid ColumnDefinitions="1.4*,*,*,Auto" Margin="20,14,20,10">
|
||||
<!--
|
||||
No VAULT column, although the design draws one: TagRowViewModel does not carry which vault a tag
|
||||
lives in (tags are read from the active vault alone; see VaultViewModel.NewTag's own remark), so
|
||||
the column was a heading over nothing on every row.
|
||||
-->
|
||||
<Grid ColumnDefinitions="1.4*,2*,Auto" Margin="20,14,20,10">
|
||||
<TextBlock Grid.Column="0" Classes="label" Text="TAG" />
|
||||
<TextBlock Grid.Column="1" Classes="label" Text="USED BY" />
|
||||
<TextBlock Grid.Column="2" Classes="label" Text="VAULT" />
|
||||
<TextBlock Grid.Column="3" Classes="label" Text=" " />
|
||||
<TextBlock Grid.Column="2" Classes="label" Text=" " />
|
||||
</Grid>
|
||||
|
||||
<ItemsControl ItemsSource="{Binding Vault.Tags}">
|
||||
@@ -97,7 +101,7 @@
|
||||
<ItemsControl.ItemTemplate>
|
||||
<DataTemplate x:DataType="vm:TagRowViewModel">
|
||||
<Border Classes="settingsrow last" Padding="20,10">
|
||||
<Grid ColumnDefinitions="1.4*,*,*,Auto">
|
||||
<Grid ColumnDefinitions="1.4*,2*,Auto">
|
||||
|
||||
<Border Grid.Column="0" Classes="chip" HorizontalAlignment="Left" VerticalAlignment="Center">
|
||||
<TextBlock Text="{Binding Label}" />
|
||||
@@ -107,14 +111,7 @@
|
||||
Foreground="{StaticResource TextFaint}" VerticalAlignment="Center"
|
||||
Text="{Binding Description}" />
|
||||
|
||||
<!--
|
||||
No vault chip here — unlike a group, TagRowViewModel does not carry which vault it lives
|
||||
in (tags are read from the active vault alone; see VaultViewModel.NewTag's own remark),
|
||||
so there is no second vault this column could honestly name.
|
||||
-->
|
||||
<TextBlock Grid.Column="2" />
|
||||
|
||||
<StackPanel Grid.Column="3" Orientation="Horizontal" Spacing="8" VerticalAlignment="Center">
|
||||
<StackPanel Grid.Column="2" Orientation="Horizontal" Spacing="8" VerticalAlignment="Center">
|
||||
<Button Classes="paneicon" Width="30" Height="30" FontSize="13"
|
||||
Command="{Binding #Root.((vm:MainWindowViewModel)DataContext).Vault.EditTagRowCommand}"
|
||||
CommandParameter="{Binding}" ToolTip.Tip="Rename this tag.">
|
||||
|
||||
@@ -55,7 +55,7 @@
|
||||
<StackPanel Orientation="Horizontal" Spacing="8">
|
||||
<Button Classes="danger" Content="SIGN OUT AND DELETE"
|
||||
Command="{Binding ConfirmSignOutCommand}" IsEnabled="{Binding !IsBusy}" />
|
||||
<Button Classes="ghost" Content="CANCEL" Command="{Binding CancelSignOutCommand}" />
|
||||
<Button x:Name="CancelButton" Classes="ghost" Content="CANCEL" Command="{Binding CancelSignOutCommand}" />
|
||||
</StackPanel>
|
||||
|
||||
<TextBlock Classes="hint" FontSize="11" TextWrapping="Wrap"
|
||||
|
||||
@@ -1,9 +1,15 @@
|
||||
using Avalonia.Controls;
|
||||
using DodoSSH.Client.Shell.ViewModels;
|
||||
|
||||
namespace DodoSSH.Client.App.Views;
|
||||
|
||||
/// <summary>The sign-out confirmation, shown on the preferences screen and on the unlock screen.</summary>
|
||||
internal sealed partial class SignOutCard : UserControl
|
||||
{
|
||||
public SignOutCard() => InitializeComponent();
|
||||
public SignOutCard()
|
||||
{
|
||||
InitializeComponent();
|
||||
|
||||
SafeAnswerFocus.Follow(this, nameof(MainWindowViewModel.IsConfirmingSignOut), () => CancelButton);
|
||||
}
|
||||
}
|
||||
@@ -167,8 +167,12 @@
|
||||
TextAlignment="Center" MaxWidth="360"
|
||||
IsVisible="{Binding !HasVisible}" />
|
||||
|
||||
<!--
|
||||
Only with a snippet chosen. Three greyed buttons under a list nobody has clicked in read as
|
||||
something broken rather than something waiting, and the pane on the right already says what to do.
|
||||
-->
|
||||
<Border Grid.Row="1" Padding="16,10" BorderBrush="{StaticResource BorderSubtle}"
|
||||
BorderThickness="0,1,0,0">
|
||||
BorderThickness="0,1,0,0" IsVisible="{Binding HasSelection}">
|
||||
<StackPanel Orientation="Horizontal" Spacing="8">
|
||||
<Button Classes="ghost" Content="Edit" Command="{Binding EditCommand}"
|
||||
IsEnabled="{Binding HasSelection}" />
|
||||
|
||||
@@ -9,8 +9,9 @@
|
||||
|
||||
The design puts five things here: the active host and the bastion it is reached through, the open port
|
||||
forwards, the SFTP transfer count, an auto-lock countdown, and the last sync time. Four of those five
|
||||
have nothing behind them — there is no jump-host routing, no port forwarding, no file transfer and no
|
||||
idle auto-lock — so what is left is the active session, the vault's last message, and the shortcut hint.
|
||||
had nothing behind them when this was written — there was no jump-host routing, no port forwarding, no
|
||||
file transfer and no idle auto-lock — so what is left is the active session, the vault's last message,
|
||||
and the shortcut hint. Forwards have since been built, and are counted on SessionStatusBar instead.
|
||||
|
||||
The last message is the load-bearing one, and it is why this bar is worth having at all: the vault's
|
||||
status line used to be a cramped label in the account bar, and everything the application has to say
|
||||
|
||||
@@ -44,15 +44,15 @@
|
||||
IsEnabled="{Binding !IsBusy}" />
|
||||
<!--
|
||||
Shown only when this machine has both a registered wrap and a keystore still willing to release the
|
||||
key. Absent rather than disabled, because a greyed-out "Use Windows Hello" on a machine that never
|
||||
key. Absent rather than disabled, because a greyed-out "Use Touch ID" on a machine that never
|
||||
had it invites the reading that something is broken — and the passphrase box beside it is not a
|
||||
fallback, it is the ordinary way in.
|
||||
-->
|
||||
<Button Classes="ghost" Content="USE WINDOWS HELLO"
|
||||
<Button Classes="ghost" Content="{Binding DeviceUnlock.Button}"
|
||||
Command="{Binding UnlockWithDeviceCommand}"
|
||||
IsEnabled="{Binding !IsBusy}"
|
||||
IsVisible="{Binding CanUnlockWithDevice}"
|
||||
ToolTip.Tip="Opens the keychain with this machine's device key. Windows will ask you to confirm." />
|
||||
ToolTip.Tip="{Binding DeviceUnlock.Tip}" />
|
||||
</StackPanel>
|
||||
|
||||
<TextBlock Classes="hint" Text="{Binding StatusMessage}" TextWrapping="Wrap" />
|
||||
|
||||
@@ -45,6 +45,13 @@ public sealed record HostSecret : IVaultSecret
|
||||
/// </remarks>
|
||||
public const int MaxPinnedPaths = 32;
|
||||
|
||||
/// <summary>The most port forwards a host may carry.</summary>
|
||||
/// <remarks>
|
||||
/// Each one is a listener opened with every terminal to the host, so the bound is on what one connect
|
||||
/// may open as much as on the payload.
|
||||
/// </remarks>
|
||||
public const int MaxPortForwards = 16;
|
||||
|
||||
/// <summary>Display name. The only name this host has anywhere.</summary>
|
||||
public required string Label { get; init; }
|
||||
|
||||
@@ -223,6 +230,15 @@ public sealed record HostSecret : IVaultSecret
|
||||
/// </remarks>
|
||||
public PinnedPathList PinnedPaths { get; init; } = PinnedPathList.Empty;
|
||||
|
||||
/// <summary>
|
||||
/// The port forwards started with every terminal opened to this host.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Here rather than in an item of their own; see <see cref="PortForwardRule"/>. Merged per forward, so two
|
||||
/// machines each adding one both keep theirs, and two editing the same one is a recorded conflict.
|
||||
/// </remarks>
|
||||
public PortForwardList PortForwards { get; init; } = PortForwardList.Empty;
|
||||
|
||||
/// <summary>
|
||||
/// The group this host is filed under, or null for none.
|
||||
/// </summary>
|
||||
@@ -281,6 +297,34 @@ public sealed record HostSecret : IVaultSecret
|
||||
/// </remarks>
|
||||
public bool RelayEnabled { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// How this host is reached through Spelunk, or null for a host that is dialled.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// A host carrying one is never dialled directly and never falls back to it, for the reason the relay
|
||||
/// does not: the user chose this route because the direct one does not exist or does not work, and a
|
||||
/// connection that quietly went another way would be the box saying one thing and the connection doing
|
||||
/// another. See <see cref="SpelunkRoute"/> for what the route is.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b><see cref="Hostname"/> and <see cref="Port"/> still matter, and not for dialling.</b> The host key
|
||||
/// is pinned under them, as it is for every host, so they have to name this machine stably — a host made
|
||||
/// from a Spelunk link takes the server's address, or a name made from its id when Spelunk gave none.
|
||||
/// The port is also what the agent is asked to connect to on the server's own loopback.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>Mutually exclusive with <see cref="RelayEnabled"/>.</b> Two routes to one host is the same failure
|
||||
/// as two bindings: the editor, the connect path and the user would each be free to guess which one is
|
||||
/// meant. <see cref="TryValidate"/> refuses the pair.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public SpelunkRoute? Spelunk { get; init; }
|
||||
|
||||
/// <summary>Whether Spelunk signs the user in to this host, so it needs no login of its own.</summary>
|
||||
/// <remarks>See <see cref="SpelunkRoute.SignInThroughSpelunk"/>.</remarks>
|
||||
public bool SignsInThroughSpelunk => Spelunk?.SignInThroughSpelunk is true;
|
||||
|
||||
/// <summary>
|
||||
/// Checks the fields that must hold before this can be stored.
|
||||
/// </summary>
|
||||
@@ -314,7 +358,49 @@ public sealed record HostSecret : IVaultSecret
|
||||
return false;
|
||||
}
|
||||
|
||||
return PinnedPathsAreStorable(out reason) && ReferencesAreStorable(out reason);
|
||||
return PinnedPathsAreStorable(out reason)
|
||||
&& PortForwardsAreStorable(out reason)
|
||||
&& ReferencesAreStorable(out reason)
|
||||
&& RouteIsStorable(out reason);
|
||||
}
|
||||
|
||||
/// <summary>Checks the forwards saved on this host, each on its own terms and the list as a whole.</summary>
|
||||
private bool PortForwardsAreStorable([NotNullWhen(false)] out string? reason)
|
||||
{
|
||||
if (PortForwards.Count > MaxPortForwards)
|
||||
{
|
||||
reason = $"A host cannot carry more than {MaxPortForwards} port forwards.";
|
||||
return false;
|
||||
}
|
||||
|
||||
foreach (var forward in PortForwards)
|
||||
{
|
||||
if (!forward.TryValidate(out reason))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
reason = null;
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>Checks the Spelunk route, if there is one, and that it is the only route.</summary>
|
||||
private bool RouteIsStorable([NotNullWhen(false)] out string? reason)
|
||||
{
|
||||
if (Spelunk is null)
|
||||
{
|
||||
reason = null;
|
||||
return true;
|
||||
}
|
||||
|
||||
if (RelayEnabled)
|
||||
{
|
||||
reason = "A host is reached through the server relay or through Spelunk, not both.";
|
||||
return false;
|
||||
}
|
||||
|
||||
return Spelunk.TryValidate(out reason);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
|
||||
@@ -112,12 +112,51 @@ public static class HostSecretCodec
|
||||
/// </remarks>
|
||||
public const int PinnedPathsSchemaVersion = 7;
|
||||
|
||||
/// <summary>The version that introduced <see cref="HostSecret.PortForwards"/>.</summary>
|
||||
/// <remarks>
|
||||
/// Its own version for the reason <see cref="PinnedPathsSchemaVersion"/> gives: a host can carry
|
||||
/// forwards without pinning anything, and should stay editable on a build that knows 7 until it does.
|
||||
/// </remarks>
|
||||
public const int PortForwardsSchemaVersion = 8;
|
||||
|
||||
/// <summary>The version that introduced <see cref="HostSecret.Spelunk"/>.</summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Its own version, by the rule this file follows, and it matters more here than for a tag. An older
|
||||
/// build that decoded a Spelunk host as editable would drop the route on the next save — and the host
|
||||
/// would then be dialled directly, at an address that exists only so its key has a name to be pinned
|
||||
/// under. Written at this version, the older build shows the host, refuses to edit it, and says to update.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Additive, like every version but <see cref="PortInheritSchemaVersion"/>: the route is one more
|
||||
/// property, and a build that does not know it skips it and still reads a valid host. It follows
|
||||
/// <see cref="PortForwardsSchemaVersion"/>, whose forwards reached main first.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public const int SpelunkSchemaVersion = 9;
|
||||
|
||||
/// <summary>The version that introduced <see cref="SpelunkRoute.SignInThroughSpelunk"/>.</summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Its own version, and nested in the existing <c>spelunk</c> object rather than beside it, because it
|
||||
/// is part of that one decision. A build that knows 9 skips the unknown member and reads a valid host —
|
||||
/// a Spelunk host with no login of its own — and it must not save that back: the flag would be dropped
|
||||
/// and the host would start asking for a password it never had. Written at this version, that build
|
||||
/// shows the host, refuses to edit it, and says to update.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Only a route that signs in is written here. Every other Spelunk host stays at
|
||||
/// <see cref="SpelunkSchemaVersion"/>, byte for byte what it was.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public const int SpelunkSignInSchemaVersion = 10;
|
||||
|
||||
/// <summary>The highest schema version this build can write.</summary>
|
||||
/// <remarks>
|
||||
/// Names the highest constant above, which <see cref="SchemaVersionFor"/> assumes when it takes a
|
||||
/// maximum. A new field added below this line has to be named here too.
|
||||
/// </remarks>
|
||||
public const int CurrentSchemaVersion = PinnedPathsSchemaVersion;
|
||||
public const int CurrentSchemaVersion = SpelunkSignInSchemaVersion;
|
||||
|
||||
/// <summary>Serialises a host to the bytes that get sealed.</summary>
|
||||
/// <exception cref="ArgumentException">The host is not valid for storage.</exception>
|
||||
@@ -163,6 +202,14 @@ public static class HostSecretCodec
|
||||
// Last, and null for the same reason TagIds is: a host that pins nothing must encode exactly
|
||||
// as it did before this field existed.
|
||||
PinnedPaths = host.PinnedPaths.Count == 0 ? null : [.. host.PinnedPaths],
|
||||
|
||||
// Last, and null when empty, for the reason both fields above give.
|
||||
PortForwards = host.PortForwards.Count == 0
|
||||
? null
|
||||
: [.. host.PortForwards.Select(PortForwardDocument.From)],
|
||||
// Last of all, and absent for a host that is dialled, so every host without a route encodes
|
||||
// exactly as it did before routes existed.
|
||||
Spelunk = host.Spelunk is { } route ? SpelunkPayloadDocument.From(route) : null,
|
||||
};
|
||||
|
||||
return JsonSerializer.SerializeToUtf8Bytes(
|
||||
@@ -238,6 +285,21 @@ public static class HostSecretCodec
|
||||
version = Math.Max(version, PinnedPathsSchemaVersion);
|
||||
}
|
||||
|
||||
if (host.PortForwards.Count > 0)
|
||||
{
|
||||
version = Math.Max(version, PortForwardsSchemaVersion);
|
||||
}
|
||||
|
||||
if (host.Spelunk is not null)
|
||||
{
|
||||
version = Math.Max(version, SpelunkSchemaVersion);
|
||||
}
|
||||
|
||||
if (host.SignsInThroughSpelunk)
|
||||
{
|
||||
version = Math.Max(version, SpelunkSignInSchemaVersion);
|
||||
}
|
||||
|
||||
return version;
|
||||
}
|
||||
|
||||
@@ -295,6 +357,11 @@ public static class HostSecretCodec
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!TryBuildForwards(parsed.PortForwards, out var forwards))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
var candidate = new HostSecret
|
||||
{
|
||||
Label = parsed.Label ?? string.Empty,
|
||||
@@ -316,6 +383,9 @@ public static class HostSecretCodec
|
||||
TagIds = TagSet.Create(parsed.TagIds ?? []),
|
||||
|
||||
PinnedPaths = PinnedPathList.Create(parsed.PinnedPaths ?? []),
|
||||
|
||||
PortForwards = forwards,
|
||||
Spelunk = RouteFrom(parsed.Spelunk),
|
||||
};
|
||||
|
||||
if (!candidate.TryValidate(out _))
|
||||
@@ -326,6 +396,65 @@ public static class HostSecretCodec
|
||||
host = candidate;
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <remarks>
|
||||
/// A missing id, kind or port is a refusal rather than a default. Each would be invented here — a fresh
|
||||
/// id the other machines do not have, a <c>Local</c> nobody chose — and an invented forward is one the
|
||||
/// next save writes back as though somebody had asked for it.
|
||||
/// </remarks>
|
||||
private static bool TryBuildForwards(
|
||||
PortForwardDocument?[]? parsed,
|
||||
[NotNullWhen(true)] out PortForwardList? forwards)
|
||||
{
|
||||
forwards = PortForwardList.Empty;
|
||||
|
||||
if (parsed is null)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
var rules = new List<PortForwardRule>(parsed.Length);
|
||||
|
||||
foreach (var entry in parsed)
|
||||
{
|
||||
if (entry?.Id is not { } id || entry.Kind is not { } kind || entry.BindPort is not { } bindPort)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
rules.Add(new PortForwardRule
|
||||
{
|
||||
Id = id,
|
||||
Kind = (PortForwardKind)kind,
|
||||
BindPort = bindPort,
|
||||
TargetHost = entry.TargetHost,
|
||||
TargetPort = entry.TargetPort,
|
||||
});
|
||||
}
|
||||
|
||||
forwards = PortForwardList.Create(rules);
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>The route as stored, or null when there is none.</summary>
|
||||
/// <remarks>
|
||||
/// Missing parts come through as empty values rather than making the route vanish, so that
|
||||
/// <see cref="HostSecret.TryValidate"/> refuses the host. Reading a half-written route as "no route"
|
||||
/// would turn a Spelunk host into one that is dialled directly, which is the one reading of a damaged
|
||||
/// payload that does something the user never asked for.
|
||||
/// </remarks>
|
||||
private static SpelunkRoute? RouteFrom(SpelunkPayloadDocument? parsed) =>
|
||||
parsed is null
|
||||
? null
|
||||
: new SpelunkRoute
|
||||
{
|
||||
ApiBase = parsed.Api ?? string.Empty,
|
||||
ServerId = parsed.ServerId ?? Guid.Empty,
|
||||
ApiKeyCredentialId = parsed.ApiKeyCredentialId ?? Guid.Empty,
|
||||
|
||||
// False folds to the default, as AsksForPassword's does: one state, one spelling.
|
||||
SignInThroughSpelunk = parsed.SignIn is true,
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -396,6 +525,70 @@ internal sealed class HostPayloadDocument
|
||||
/// newer of the two and follows the same rule.
|
||||
/// </remarks>
|
||||
public string[]? PinnedPaths { get; set; }
|
||||
|
||||
/// <remarks>Last, and null rather than <c>[]</c>, for the reasons <see cref="TagIds"/> gives.</remarks>
|
||||
public PortForwardDocument?[]? PortForwards { get; set; }
|
||||
|
||||
/// <remarks>
|
||||
/// Last, and null for a host that is dialled, for the reason <see cref="TagIds"/> gives. One nested object
|
||||
/// rather than three loose properties, because the three are one decision — a server id without its
|
||||
/// Spelunk means nothing — and an object makes "all or none" the shape of the JSON.
|
||||
/// </remarks>
|
||||
public SpelunkPayloadDocument? Spelunk { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>The serialised shape of a <see cref="SpelunkRoute"/>. Nullable because it models untrusted input.</summary>
|
||||
internal sealed class SpelunkPayloadDocument
|
||||
{
|
||||
public string? Api { get; set; }
|
||||
|
||||
public Guid? ServerId { get; set; }
|
||||
|
||||
public Guid? ApiKeyCredentialId { get; set; }
|
||||
|
||||
/// <remarks>
|
||||
/// Last, and null unless true, so a route that does not sign in keeps the bytes it had at version 9.
|
||||
/// See <see cref="HostSecretCodec.SpelunkSignInSchemaVersion"/>.
|
||||
/// </remarks>
|
||||
public bool? SignIn { get; set; }
|
||||
|
||||
public static SpelunkPayloadDocument From(SpelunkRoute route) => new()
|
||||
{
|
||||
Api = route.ApiBase,
|
||||
ServerId = route.ServerId,
|
||||
ApiKeyCredentialId = route.ApiKeyCredentialId,
|
||||
|
||||
// Null rather than false, so a route that does not sign in encodes exactly as it did before the
|
||||
// field existed — the rule AsksForPassword follows.
|
||||
SignIn = route.SignInThroughSpelunk ? true : null,
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>One forward's serialised shape. Nullable throughout, because it models untrusted input.</summary>
|
||||
/// <remarks>
|
||||
/// The kind is written as its number rather than its name, so renaming a member of
|
||||
/// <see cref="PortForwardKind"/> can never change what is on the wire.
|
||||
/// </remarks>
|
||||
internal sealed class PortForwardDocument
|
||||
{
|
||||
public Guid? Id { get; set; }
|
||||
|
||||
public int? Kind { get; set; }
|
||||
|
||||
public int? BindPort { get; set; }
|
||||
|
||||
public string? TargetHost { get; set; }
|
||||
|
||||
public int? TargetPort { get; set; }
|
||||
|
||||
public static PortForwardDocument From(PortForwardRule rule) => new()
|
||||
{
|
||||
Id = rule.Id,
|
||||
Kind = (int)rule.Kind,
|
||||
BindPort = rule.BindPort,
|
||||
TargetHost = rule.TargetHost,
|
||||
TargetPort = rule.TargetPort,
|
||||
};
|
||||
}
|
||||
|
||||
[JsonSourceGenerationOptions(
|
||||
|
||||
@@ -99,6 +99,8 @@ public static class HostSecretMerge
|
||||
TagIds = MergeTags(ancestor.TagIds, local.TagIds, remote.TagIds, conflicts),
|
||||
PinnedPaths = MergePinnedPaths(
|
||||
ancestor.PinnedPaths, local.PinnedPaths, remote.PinnedPaths, conflicts),
|
||||
PortForwards = MergePortForwards(
|
||||
ancestor.PortForwards, local.PortForwards, remote.PortForwards, conflicts),
|
||||
RelayEnabled = Field(
|
||||
nameof(HostSecret.RelayEnabled),
|
||||
ancestor.RelayEnabled,
|
||||
@@ -166,6 +168,18 @@ public static class HostSecretMerge
|
||||
remote.AsksForPassword,
|
||||
conflicts,
|
||||
static asked => asked is true ? "a typed password" : "the group's binding"),
|
||||
|
||||
// Here rather than beside RelayEnabled, because it is a reference too — to a Spelunk server and to
|
||||
// the credential holding its key — and it merges as one value for the reason the jump chain does:
|
||||
// an API address from one side and a server id from the other would be a route neither user
|
||||
// chose, to a server that may not exist on that Spelunk.
|
||||
Spelunk = Field(
|
||||
nameof(HostSecret.Spelunk),
|
||||
ancestor.Spelunk,
|
||||
local.Spelunk,
|
||||
remote.Spelunk,
|
||||
conflicts,
|
||||
static route => route is null ? "dialled directly" : $"server {route.ServerId} on {route.ApiBase}"),
|
||||
};
|
||||
|
||||
private static string Text(
|
||||
@@ -342,6 +356,46 @@ public static class HostSecretMerge
|
||||
return PinnedPathList.Create(merge.Merged.Keys);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Merges the forwards per forward, so two people each adding one both keep theirs.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Keyed by id and ordered the way <see cref="MergePinnedPaths"/> is: existing forwards, then this
|
||||
/// machine's additions, then the server's.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>Unlike a tag or a pinned path, a conflict is reachable here.</b> The value under a key is the whole
|
||||
/// rule, so two machines changing one forward differently is a genuine clash. The server's version wins,
|
||||
/// as every scalar's does, and the other is recorded in OpenSSH's notation so the user can read what was
|
||||
/// lost. An edit on one side beats a removal on the other, which is the map merge's standing rule.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private static PortForwardList MergePortForwards(
|
||||
PortForwardList ancestor,
|
||||
PortForwardList local,
|
||||
PortForwardList remote,
|
||||
List<HostFieldConflict> conflicts)
|
||||
{
|
||||
var merge = ThreeWayMerge.Map(
|
||||
ancestor.ToIdMap(),
|
||||
local.ToIdMap(),
|
||||
remote.ToIdMap(),
|
||||
EqualityComparer<Guid>.Default);
|
||||
|
||||
foreach (var conflict in merge.Conflicts)
|
||||
{
|
||||
conflicts.Add(new HostFieldConflict(
|
||||
$"{nameof(HostSecret.PortForwards)}[{conflict.Key}]",
|
||||
conflict.DiscardedSide,
|
||||
conflict.Kept?.Notation ?? "removed",
|
||||
conflict.Discarded?.Notation ?? "removed",
|
||||
conflict.DiscardedWasRemoval));
|
||||
}
|
||||
|
||||
return PortForwardList.Create(merge.Merged.Values);
|
||||
}
|
||||
|
||||
private static string FormatChain(JumpChain chain) =>
|
||||
chain.Count == 0 ? "(none)" : string.Join(" → ", chain);
|
||||
}
|
||||
@@ -0,0 +1,140 @@
|
||||
using System.Collections;
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
|
||||
namespace DodoSSH.Client.Domain;
|
||||
|
||||
/// <summary>
|
||||
/// The port forwards saved on a host, in the order the user added them.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// A dedicated type rather than a list, for the reason <see cref="PinnedPathList"/> gives: a plain list on a
|
||||
/// record compares by reference, so every host would read as changed on every sync pass.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>Ordered and unique by id.</b> Order is how the session sidebar lists them. Uniqueness is by
|
||||
/// <see cref="PortForwardRule.Id"/> rather than by value, keeping the first occurrence, because the id is
|
||||
/// what the merge keys on — two entries with one id would be one forward the merge could not tell apart.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Invalid rules are not rejected at construction, for the reason every collection in this assembly gives:
|
||||
/// they arrive from another client's payload, and a throw here would fail the whole sync pass.
|
||||
/// <see cref="HostSecret.TryValidate"/> catches them.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public sealed class PortForwardList : IReadOnlyList<PortForwardRule>, IEquatable<PortForwardList>
|
||||
{
|
||||
private readonly PortForwardRule[] rules;
|
||||
private readonly int hash;
|
||||
|
||||
private PortForwardList(PortForwardRule[] rules)
|
||||
{
|
||||
this.rules = rules;
|
||||
hash = ComputeHash(rules);
|
||||
}
|
||||
|
||||
/// <summary>No forwards.</summary>
|
||||
public static PortForwardList Empty { get; } = new([]);
|
||||
|
||||
/// <inheritdoc />
|
||||
public int Count => rules.Length;
|
||||
|
||||
/// <inheritdoc />
|
||||
public PortForwardRule this[int index] => rules[index];
|
||||
|
||||
/// <summary>Copies a sequence of rules, keeping order and the first rule with any given id.</summary>
|
||||
public static PortForwardList Create(IEnumerable<PortForwardRule> rules)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(rules);
|
||||
|
||||
var kept = new List<PortForwardRule>();
|
||||
var seen = new HashSet<Guid>();
|
||||
|
||||
foreach (var rule in rules)
|
||||
{
|
||||
if (rule is null)
|
||||
{
|
||||
throw new ArgumentException("A forward list cannot contain a null rule.", nameof(rules));
|
||||
}
|
||||
|
||||
if (seen.Add(rule.Id))
|
||||
{
|
||||
kept.Add(rule);
|
||||
}
|
||||
}
|
||||
|
||||
return kept.Count == 0 ? Empty : new PortForwardList([.. kept]);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The list as a map from id to rule, in list order, which is the shape <see cref="ThreeWayMerge.Map"/>
|
||||
/// takes.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Built in list order for the reason <see cref="PinnedPathList.ToPathMap"/> is: the merge unions keys
|
||||
/// ancestor first, then local, then remote, so an ordered map is what keeps "existing forwards, then
|
||||
/// additions" without the merge ordering anything itself. Unlike a pinned path, a value here can change
|
||||
/// under its key, so a conflict is reachable: both machines editing the same forward differently.
|
||||
/// </remarks>
|
||||
public IReadOnlyDictionary<Guid, PortForwardRule> ToIdMap()
|
||||
{
|
||||
var map = new Dictionary<Guid, PortForwardRule>(rules.Length);
|
||||
|
||||
foreach (var rule in rules)
|
||||
{
|
||||
map[rule.Id] = rule;
|
||||
}
|
||||
|
||||
return map;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public bool Equals(PortForwardList? other)
|
||||
{
|
||||
if (ReferenceEquals(this, other))
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
return other is not null
|
||||
&& other.hash == hash
|
||||
&& rules.AsSpan().SequenceEqual(other.rules);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public override bool Equals(object? obj) => Equals(obj as PortForwardList);
|
||||
|
||||
/// <inheritdoc />
|
||||
public override int GetHashCode() => hash;
|
||||
|
||||
/// <inheritdoc />
|
||||
public IEnumerator<PortForwardRule> GetEnumerator() => ((IEnumerable<PortForwardRule>)rules).GetEnumerator();
|
||||
|
||||
/// <inheritdoc />
|
||||
IEnumerator IEnumerable.GetEnumerator() => rules.GetEnumerator();
|
||||
|
||||
/// <summary>Contents equality, tolerating nulls on either side.</summary>
|
||||
[SuppressMessage(
|
||||
"Usage",
|
||||
"CA2225:Operator overloads have named alternates",
|
||||
Justification = "Equals(PortForwardList) is the named alternate.")]
|
||||
public static bool operator ==(PortForwardList? left, PortForwardList? right) =>
|
||||
left is null ? right is null : left.Equals(right);
|
||||
|
||||
/// <summary>Contents inequality.</summary>
|
||||
public static bool operator !=(PortForwardList? left, PortForwardList? right) => !(left == right);
|
||||
|
||||
private static int ComputeHash(PortForwardRule[] rules)
|
||||
{
|
||||
// Order-sensitive, because order is kept.
|
||||
var accumulator = new HashCode();
|
||||
accumulator.Add(rules.Length);
|
||||
|
||||
foreach (var rule in rules)
|
||||
{
|
||||
accumulator.Add(rule);
|
||||
}
|
||||
|
||||
return accumulator.ToHashCode();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,166 @@
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using System.Globalization;
|
||||
|
||||
namespace DodoSSH.Client.Domain;
|
||||
|
||||
/// <summary>Which way a saved forward carries connections.</summary>
|
||||
/// <remarks>
|
||||
/// Stored as its number, so the values are part of the payload format and must never be renumbered. The
|
||||
/// SSH layer has its own enum with the same three members; the connect path maps one to the other, which
|
||||
/// keeps this assembly free of any reference to it.
|
||||
/// </remarks>
|
||||
public enum PortForwardKind
|
||||
{
|
||||
/// <summary>A port on this machine, carried to a target the remote can reach. <c>ssh -L</c>.</summary>
|
||||
Local = 0,
|
||||
|
||||
/// <summary>A port on the remote, carried back to a target this machine can reach. <c>ssh -R</c>.</summary>
|
||||
Remote = 1,
|
||||
|
||||
/// <summary>A SOCKS proxy on this machine, whose connections leave from the remote. <c>ssh -D</c>.</summary>
|
||||
Dynamic = 2,
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// A port forward saved on a host, started with every terminal opened to it.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <b>Part of the host's encrypted payload rather than an item of its own</b>, which is what
|
||||
/// <c>RelayTicketRequest.PortForwardId</c> has said since the contract was frozen. A forward means nothing
|
||||
/// without the host it runs over, it is edited in the host's own editor, and a separate item kind would be a
|
||||
/// table, a server kind, a cipher and a repository to buy one thing the host's per-id merge already gives:
|
||||
/// two machines each adding a forward both keep theirs. <c>SyncEntityType.PortForward</c> stays reserved,
|
||||
/// the way <c>HostTag</c> does for the same reason.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>There is no bind address.</b> Every listener binds loopback — see <c>SshPortForwardSpec</c> for why a
|
||||
/// field another member of the keychain can fill in must not be able to say otherwise.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <see cref="Id"/> is what the merge keys on, so editing a forward's port on one machine and its target on
|
||||
/// another is one forward changed twice — a conflict the merge records — rather than two forwards.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public sealed record PortForwardRule
|
||||
{
|
||||
/// <summary>The longest a target host may be, which is the longest a DNS name can be.</summary>
|
||||
public const int MaxTargetHostLength = 253;
|
||||
|
||||
/// <summary>Identifies this forward within its host, for the merge.</summary>
|
||||
public required Guid Id { get; init; }
|
||||
|
||||
/// <summary>Which way it carries connections.</summary>
|
||||
public required PortForwardKind Kind { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// The port to listen on: on this machine for a local or dynamic forward, on the remote for a remote one.
|
||||
/// </summary>
|
||||
public required int BindPort { get; init; }
|
||||
|
||||
/// <summary>Where each connection goes, or null for a dynamic forward.</summary>
|
||||
/// <remarks>
|
||||
/// Resolved by the remote for a local forward — so it may name a machine only the remote can see — and
|
||||
/// by this machine for a remote one.
|
||||
/// </remarks>
|
||||
public string? TargetHost { get; init; }
|
||||
|
||||
/// <summary>The port on <see cref="TargetHost"/>, or null for a dynamic forward.</summary>
|
||||
public int? TargetPort { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// The forward in OpenSSH's own notation, which is what anybody who has used one will read fastest.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <c>-L 5432:db.internal:5432</c>, <c>-R 8080:localhost:3000</c>, <c>-D 1080</c>. No bind address, because
|
||||
/// there is never one to show.
|
||||
/// </remarks>
|
||||
public string Notation => Kind switch
|
||||
{
|
||||
PortForwardKind.Local => $"-L {Port(BindPort)}:{TargetHost}:{Port(TargetPort)}",
|
||||
PortForwardKind.Remote => $"-R {Port(BindPort)}:{TargetHost}:{Port(TargetPort)}",
|
||||
_ => $"-D {Port(BindPort)}",
|
||||
};
|
||||
|
||||
/// <summary>Checks the fields that must hold before this can be stored.</summary>
|
||||
/// <remarks>
|
||||
/// Deliberately silent about two forwards on one port. Two machines each adding one is exactly what the
|
||||
/// merge produces, and a host that failed validation after a merge could not be written back at all; the
|
||||
/// second listener fails when it starts instead, and says so. The editor refuses the duplicate up front.
|
||||
/// </remarks>
|
||||
public bool TryValidate([NotNullWhen(false)] out string? reason)
|
||||
{
|
||||
if (Id == Guid.Empty)
|
||||
{
|
||||
reason = "A port forward cannot have an empty id.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!Enum.IsDefined(Kind))
|
||||
{
|
||||
reason = $"'{(int)Kind}' is not a kind of port forward.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (BindPort is < 1 or > 65535)
|
||||
{
|
||||
reason = $"A forward's listening port must be between 1 and 65535, not {BindPort}.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (Kind is PortForwardKind.Dynamic)
|
||||
{
|
||||
if (TargetHost is not null || TargetPort is not null)
|
||||
{
|
||||
reason = "A dynamic forward has no target: each connection through it names its own.";
|
||||
return false;
|
||||
}
|
||||
|
||||
reason = null;
|
||||
return true;
|
||||
}
|
||||
|
||||
return TargetIsStorable(out reason);
|
||||
}
|
||||
|
||||
private static string Port(int? port) => port?.ToString(CultureInfo.InvariantCulture) ?? "?";
|
||||
|
||||
/// <remarks>
|
||||
/// Whitespace and control characters are refused as well as blanks: neither is part of any host name,
|
||||
/// both are what a corrupted payload looks like, and this string is drawn on screen as it stands.
|
||||
/// </remarks>
|
||||
private bool TargetIsStorable([NotNullWhen(false)] out string? reason)
|
||||
{
|
||||
if (string.IsNullOrWhiteSpace(TargetHost))
|
||||
{
|
||||
reason = "A forward needs a host to forward to.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (TargetHost.Length > MaxTargetHostLength)
|
||||
{
|
||||
reason = $"A forward's target cannot be longer than {MaxTargetHostLength} characters.";
|
||||
return false;
|
||||
}
|
||||
|
||||
foreach (var ch in TargetHost)
|
||||
{
|
||||
if (char.IsControl(ch) || char.IsWhiteSpace(ch))
|
||||
{
|
||||
reason = "A forward's target cannot contain spaces or control characters.";
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
if (TargetPort is not (>= 1 and <= 65535))
|
||||
{
|
||||
reason = TargetPort is { } port
|
||||
? $"A forward's target port must be between 1 and 65535, not {port}."
|
||||
: "A forward needs a port to forward to.";
|
||||
return false;
|
||||
}
|
||||
|
||||
reason = null;
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,92 @@
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
|
||||
namespace DodoSSH.Client.Domain;
|
||||
|
||||
/// <summary>
|
||||
/// A Spelunk API key and the one Spelunk it may be sent to, decrypted.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <b>The address is what makes this an item of its own.</b> A key kept as a credential's password can be
|
||||
/// sent anywhere a host names, and a link from Spelunk can be sent by anything on the machine — so a link
|
||||
/// that is not already backed by a saved host has to stop and ask. A key stored with its address says, once
|
||||
/// and in the keychain, where the user agreed it may go: a link from that Spelunk connects straight away, and
|
||||
/// a host naming this key with any other address is refused at connect rather than sending it there. See
|
||||
/// <c>VaultViewModel.OpenSpelunkLinkAsync</c>.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b><see cref="ApiKey"/> is a password, and everything this codebase does about passwords applies to
|
||||
/// it</b>, as it does to <see cref="ObjectStoreSecret.SecretAccessKey"/>: it is inside the encrypted payload,
|
||||
/// the activity log records that it changed and never what it was, and the merge reports that it differed
|
||||
/// rather than either value.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public sealed record SpelunkKeySecret : IVaultSecret
|
||||
{
|
||||
/// <summary>The longest API key stored.</summary>
|
||||
/// <remarks>
|
||||
/// Far beyond any real key, for the reason <see cref="SpelunkRoute.MaxApiBaseLength"/> exists: an
|
||||
/// unbounded string is the shape a corrupted payload takes, and this one goes into a request header.
|
||||
/// </remarks>
|
||||
public const int MaxApiKeyLength = 4096;
|
||||
|
||||
/// <summary>What the user calls this key.</summary>
|
||||
public required string Label { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// The Spelunk API this key is for, as <see cref="SpelunkRoute.TryNormalizeApiBase"/> writes it, and the
|
||||
/// only address it is ever sent to.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Normalised for the reason <see cref="SpelunkRoute.ApiBase"/> is: it is compared, byte for byte, with
|
||||
/// the address a host or a link names.
|
||||
/// </remarks>
|
||||
public required string ApiBase { get; init; }
|
||||
|
||||
/// <summary>The API key itself, as Spelunk issued it.</summary>
|
||||
public required string ApiKey { get; init; }
|
||||
|
||||
/// <summary>Whether this is storable, and why not if it is not.</summary>
|
||||
public bool TryValidate([NotNullWhen(false)] out string? reason)
|
||||
{
|
||||
if (string.IsNullOrWhiteSpace(Label))
|
||||
{
|
||||
reason = "A Spelunk key needs a name.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (string.IsNullOrWhiteSpace(ApiBase))
|
||||
{
|
||||
reason = "A Spelunk key needs the address of the Spelunk it is for.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!SpelunkRoute.TryNormalizeApiBase(ApiBase, out var normalized, out reason))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!string.Equals(normalized, ApiBase, StringComparison.Ordinal))
|
||||
{
|
||||
reason = "The Spelunk API address is not in its normal form.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (string.IsNullOrWhiteSpace(ApiKey))
|
||||
{
|
||||
reason = "A Spelunk key needs the key.";
|
||||
return false;
|
||||
}
|
||||
|
||||
// A header value cannot hold a line break, and a key with one would fail at the first connect with an
|
||||
// HTTP error that names neither the key nor this item.
|
||||
if (ApiKey.Length > MaxApiKeyLength || ApiKey.Any(char.IsControl))
|
||||
{
|
||||
reason = "That does not look like a Spelunk API key.";
|
||||
return false;
|
||||
}
|
||||
|
||||
reason = null;
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,112 @@
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Serialization;
|
||||
|
||||
namespace DodoSSH.Client.Domain;
|
||||
|
||||
/// <summary>A decoded Spelunk key payload, together with the schema version it was written at.</summary>
|
||||
/// <param name="Key">The key.</param>
|
||||
/// <param name="SchemaVersion">The version the writing client used.</param>
|
||||
public sealed record SpelunkKeySecretDocument(SpelunkKeySecret Key, int SchemaVersion)
|
||||
{
|
||||
/// <inheritdoc cref="HostSecretDocument.IsReadOnly" />
|
||||
public bool IsReadOnly => SchemaVersion > SpelunkKeySecretCodec.CurrentSchemaVersion;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Encodes and decodes the plaintext inside a Spelunk key item's encrypted payload.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Mirrors <see cref="ObjectStoreSecretCodec"/>, for the same reasons and with the same guarantees.
|
||||
/// </remarks>
|
||||
public static class SpelunkKeySecretCodec
|
||||
{
|
||||
/// <summary>The schema version this build writes.</summary>
|
||||
public const int CurrentSchemaVersion = 1;
|
||||
|
||||
/// <summary>Serialises a key to the bytes that get sealed.</summary>
|
||||
/// <exception cref="ArgumentException">The key is not valid for storage.</exception>
|
||||
public static byte[] Encode(SpelunkKeySecret key)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(key);
|
||||
|
||||
if (!key.TryValidate(out var reason))
|
||||
{
|
||||
throw new ArgumentException(reason, nameof(key));
|
||||
}
|
||||
|
||||
var document = new SpelunkKeyPayloadDocument
|
||||
{
|
||||
SchemaVersion = CurrentSchemaVersion,
|
||||
Label = key.Label,
|
||||
ApiBase = key.ApiBase,
|
||||
ApiKey = key.ApiKey,
|
||||
};
|
||||
|
||||
return JsonSerializer.SerializeToUtf8Bytes(
|
||||
document, SpelunkKeyPayloadJsonContext.Default.SpelunkKeyPayloadDocument);
|
||||
}
|
||||
|
||||
/// <summary>Parses a decrypted payload.</summary>
|
||||
/// <inheritdoc cref="HostSecretCodec.TryDecode" path="/remarks" />
|
||||
public static bool TryDecode(
|
||||
ReadOnlySpan<byte> payload,
|
||||
[NotNullWhen(true)] out SpelunkKeySecretDocument? document)
|
||||
{
|
||||
document = null;
|
||||
|
||||
SpelunkKeyPayloadDocument? parsed;
|
||||
try
|
||||
{
|
||||
parsed = JsonSerializer.Deserialize(
|
||||
payload, SpelunkKeyPayloadJsonContext.Default.SpelunkKeyPayloadDocument);
|
||||
}
|
||||
catch (JsonException)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if (parsed is null || parsed.SchemaVersion < 1)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
var candidate = new SpelunkKeySecret
|
||||
{
|
||||
Label = parsed.Label ?? string.Empty,
|
||||
ApiBase = parsed.ApiBase ?? string.Empty,
|
||||
ApiKey = parsed.ApiKey ?? string.Empty,
|
||||
};
|
||||
|
||||
// A key whose address is not in its normal form is refused rather than normalised here: the address
|
||||
// is what decides where the key may go, and a payload that disagrees with how every client writes it
|
||||
// is not one to guess about.
|
||||
if (!candidate.TryValidate(out _))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
document = new SpelunkKeySecretDocument(candidate, parsed.SchemaVersion);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>The serialised shape. Mutable and nullable because it models untrusted input.</summary>
|
||||
/// <inheritdoc cref="HostPayloadDocument" path="/remarks" />
|
||||
internal sealed class SpelunkKeyPayloadDocument
|
||||
{
|
||||
public int SchemaVersion { get; set; }
|
||||
|
||||
public string? Label { get; set; }
|
||||
|
||||
public string? ApiBase { get; set; }
|
||||
|
||||
public string? ApiKey { get; set; }
|
||||
}
|
||||
|
||||
[JsonSourceGenerationOptions(
|
||||
PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
|
||||
DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
|
||||
UnmappedMemberHandling = JsonUnmappedMemberHandling.Skip)]
|
||||
[JsonSerializable(typeof(SpelunkKeyPayloadDocument))]
|
||||
internal sealed partial class SpelunkKeyPayloadJsonContext : JsonSerializerContext;
|
||||
@@ -0,0 +1,89 @@
|
||||
namespace DodoSSH.Client.Domain;
|
||||
|
||||
/// <summary>The merged Spelunk key, and everything that had to be overridden to produce it.</summary>
|
||||
/// <param name="Merged">The key to store and push.</param>
|
||||
/// <param name="Conflicts">Empty when the two sides were reconcilable field by field.</param>
|
||||
public sealed record SpelunkKeyMergeResult(
|
||||
SpelunkKeySecret Merged,
|
||||
IReadOnlyList<HostFieldConflict> Conflicts)
|
||||
{
|
||||
/// <summary>Whether anything had to be overridden.</summary>
|
||||
public bool HasConflicts => Conflicts.Count > 0;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Merges two divergent versions of a Spelunk key against the version they both started from.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <b>The address and the key merge as one value, not two.</b> The pair is the whole meaning of this item —
|
||||
/// "this key may go to this Spelunk" — and merging them apart could keep one device's new address beside the
|
||||
/// other device's new key, sending a key to a Spelunk nobody ever paired it with. So when both sides changed
|
||||
/// the pair, one side's pair is kept whole.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>The key never reaches the conflict log</b>, for the reason a secret access key does not: a discarded
|
||||
/// one is very often still live. The addresses are shown, because which Spelunk the kept key goes to is the
|
||||
/// whole content of the notice.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public static class SpelunkKeySecretMerge
|
||||
{
|
||||
/// <summary>The name a conflict over the address and key is recorded under.</summary>
|
||||
public const string PairField = "ApiBaseAndKey";
|
||||
|
||||
/// <summary>Produces the merged key.</summary>
|
||||
/// <param name="ancestor">The version both sides branched from.</param>
|
||||
/// <param name="local">The pending local version.</param>
|
||||
/// <param name="remote">The server's current version.</param>
|
||||
public static SpelunkKeyMergeResult Merge(
|
||||
SpelunkKeySecret ancestor,
|
||||
SpelunkKeySecret local,
|
||||
SpelunkKeySecret remote)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(ancestor);
|
||||
ArgumentNullException.ThrowIfNull(local);
|
||||
ArgumentNullException.ThrowIfNull(remote);
|
||||
|
||||
var conflicts = new List<HostFieldConflict>();
|
||||
|
||||
var label = ThreeWayMerge.Scalar(ancestor.Label, local.Label, remote.Label, StringComparer.Ordinal);
|
||||
|
||||
if (label.IsConflicted)
|
||||
{
|
||||
conflicts.Add(new HostFieldConflict(
|
||||
nameof(SpelunkKeySecret.Label),
|
||||
MergeSide.Local,
|
||||
label.Value,
|
||||
label.Discarded ?? "(none)",
|
||||
DiscardedWasRemoval: false));
|
||||
}
|
||||
|
||||
// A tuple of two strings compares both ordinally, which is the comparison each field needs.
|
||||
var pair = ThreeWayMerge.Scalar(
|
||||
(ancestor.ApiBase, ancestor.ApiKey),
|
||||
(local.ApiBase, local.ApiKey),
|
||||
(remote.ApiBase, remote.ApiKey));
|
||||
|
||||
if (pair.IsConflicted)
|
||||
{
|
||||
conflicts.Add(new HostFieldConflict(
|
||||
PairField,
|
||||
MergeSide.Local,
|
||||
$"{pair.Value.ApiBase} (with its key)",
|
||||
string.Equals(pair.Discarded.ApiBase, pair.Value.ApiBase, StringComparison.Ordinal)
|
||||
? "(a different key for the same address was discarded)"
|
||||
: $"{pair.Discarded.ApiBase} (with its key)",
|
||||
DiscardedWasRemoval: false));
|
||||
}
|
||||
|
||||
var merged = new SpelunkKeySecret
|
||||
{
|
||||
Label = label.Value,
|
||||
ApiBase = pair.Value.ApiBase,
|
||||
ApiKey = pair.Value.ApiKey,
|
||||
};
|
||||
|
||||
return new SpelunkKeyMergeResult(merged, conflicts);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,192 @@
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
|
||||
namespace DodoSSH.Client.Domain;
|
||||
|
||||
/// <summary>
|
||||
/// How a host is reached through Spelunk: which Spelunk, which of its servers, and which key opens the way.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Spelunk manages servers through an agent that runs on each of them and keeps a connection open to
|
||||
/// Spelunk. A host carrying one of these is never dialled: a connection to it asks that Spelunk for a
|
||||
/// ticket, opens a WebSocket, and Spelunk hands the bytes to the agent, which connects to the SSH server on
|
||||
/// the machine's own loopback. That reaches a server with no public SSH port at all — which is the case
|
||||
/// this exists for — and it is why nothing here names an address to dial.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>Inside the host's encrypted payload, and nowhere else.</b> Unlike the relay, nothing about this has to
|
||||
/// be readable by the DodoSSH server: the tunnel is opened by this client, against Spelunk, with a key only
|
||||
/// the vault holds. So the concession ADR 0004 argues for the relay's address is not made for this.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>The API key is referenced, not embedded.</b> <see cref="ApiKeyCredentialId"/> names the keychain item
|
||||
/// holding it, for the reason <see cref="HostSecret.CredentialId"/> gives: one Spelunk key is the key for
|
||||
/// every server in its organisation, and a copy per host is twenty places to rotate it and one to forget.
|
||||
/// That item is a <see cref="SpelunkKeySecret"/>, which also says the one address the key may go to, or —
|
||||
/// for a host set up before those existed — an ordinary credential whose password is the key.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public sealed record SpelunkRoute
|
||||
{
|
||||
/// <summary>The longest API address stored.</summary>
|
||||
/// <remarks>
|
||||
/// Far beyond any real address, and there for the reason <see cref="HostSecret.MaxPinnedPathLength"/>
|
||||
/// is: this is rendered by every device that decrypts the host, and an unbounded string is the shape a
|
||||
/// corrupted payload takes.
|
||||
/// </remarks>
|
||||
public const int MaxApiBaseLength = 512;
|
||||
|
||||
/// <summary>
|
||||
/// The Spelunk API's base address, as <see cref="TryNormalizeApiBase"/> writes it — for example
|
||||
/// <c>https://api.spelunk.example.com</c>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// A string in its normalised form rather than a <see cref="Uri"/>, because this is compared: two hosts
|
||||
/// on the same Spelunk must say so in the same bytes, or a link from Spelunk would not find the host
|
||||
/// already saved for it and the merge would see a change nobody made.
|
||||
/// </remarks>
|
||||
public required string ApiBase { get; init; }
|
||||
|
||||
/// <summary>The server's id in Spelunk.</summary>
|
||||
public required Guid ServerId { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// The keychain item holding the Spelunk API key: a <see cref="SpelunkKeySecret"/>, or a credential whose
|
||||
/// password is the key.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Named for the credential it always was, and kept so on the wire: item ids are unique across kinds, so
|
||||
/// the one id says which, and a build that predates Spelunk keys reads a host naming one as a host whose
|
||||
/// key credential has gone — refused at connect, and kept as it is by an edit — rather than as damage.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Required rather than nullable. A route with no key can never be opened, and a host saved that way
|
||||
/// would refuse every connection with a sentence about something the editor let through. The reference
|
||||
/// can still dangle — the credential may be deleted on another machine — and that is refused where it
|
||||
/// is noticed, at connect, exactly as a missing SSH credential is.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public required Guid ApiKeyCredentialId { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Whether Spelunk signs the user in, so the host needs no SSH key, credential or password of its own.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// For each connection this client makes a throwaway key pair in memory and sends the public half with
|
||||
/// the ticket request, which the API key authorises. The agent then runs a one-connection SSH server on
|
||||
/// the machine whose only authorised key is that one, and says which account it logs in as. It is real
|
||||
/// SSH to the server's own host key, so shells, file transfer and port forwards work as for any host,
|
||||
/// and the key is gone when the connection is.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>What the host says about logging in is then not asked.</b> Its username, key, credential and
|
||||
/// typed-password choice — its own or a group's — are left alone rather than refused, because they are
|
||||
/// the host's answer for the day this is unticked, and refusing a host that carries them would make a
|
||||
/// merge of two honest edits undecodable. The editor stores no binding beside this, and the connect path
|
||||
/// never reads one for a host that has it. See <c>VaultViewModel.TryBuildAuthentication</c>.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Written from <see cref="HostSecretCodec.SpelunkSignInSchemaVersion"/>, and only when true, so a route
|
||||
/// without it encodes exactly as it did before it existed.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public bool SignInThroughSpelunk { get; init; }
|
||||
|
||||
/// <summary>Whether this is the route to the given server on the given Spelunk.</summary>
|
||||
/// <param name="apiBase">A normalised API base, as <see cref="TryNormalizeApiBase"/> writes it.</param>
|
||||
/// <param name="serverId">The server's id in Spelunk.</param>
|
||||
public bool IsFor(string apiBase, Guid serverId) =>
|
||||
ServerId == serverId && string.Equals(ApiBase, apiBase, StringComparison.Ordinal);
|
||||
|
||||
/// <summary>Checks that this route can be stored and opened.</summary>
|
||||
public bool TryValidate([NotNullWhen(false)] out string? reason)
|
||||
{
|
||||
if (!TryNormalizeApiBase(ApiBase, out var normalized, out reason))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
// Stored normalised or not at all, for the comparison the remarks on ApiBase depend on.
|
||||
if (!string.Equals(normalized, ApiBase, StringComparison.Ordinal))
|
||||
{
|
||||
reason = "The Spelunk API address is not in its normal form.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (ServerId == Guid.Empty)
|
||||
{
|
||||
reason = "A host reached through Spelunk needs the id of its Spelunk server.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (ApiKeyCredentialId == Guid.Empty)
|
||||
{
|
||||
reason = "A host reached through Spelunk needs its Spelunk API key chosen.";
|
||||
return false;
|
||||
}
|
||||
|
||||
reason = null;
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Reads a Spelunk API address as a user or a link gives it, into the one form it is stored in.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <b>HTTPS, or plain HTTP to this machine only.</b> The API key travels in a header on every tunnel, so
|
||||
/// an address that sends it in clear across a network is refused rather than stored. A Spelunk running
|
||||
/// on the developer's own box is the one place plain HTTP is harmless, and it is allowed there so the
|
||||
/// feature can be tried against one.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// No user name, password, query or fragment: none of them means anything to the API, and the first two
|
||||
/// are the classic way to make an address read as one host while naming another. What is left is the
|
||||
/// scheme, the authority and any path prefix, lower-cased where URLs are case-insensitive and without a
|
||||
/// trailing slash — so the same Spelunk typed twice is stored the same way twice.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public static bool TryNormalizeApiBase(
|
||||
string? text,
|
||||
[NotNullWhen(true)] out string? apiBase,
|
||||
[NotNullWhen(false)] out string? reason)
|
||||
{
|
||||
apiBase = null;
|
||||
|
||||
var trimmed = text?.Trim() ?? string.Empty;
|
||||
|
||||
if (trimmed.Length == 0)
|
||||
{
|
||||
reason = "A host reached through Spelunk needs the address of the Spelunk API.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (trimmed.Length > MaxApiBaseLength
|
||||
|| !Uri.TryCreate(trimmed, UriKind.Absolute, out var uri)
|
||||
|| uri.Scheme is not ("https" or "http")
|
||||
|| uri.HostNameType is UriHostNameType.Unknown
|
||||
|| string.IsNullOrEmpty(uri.Host))
|
||||
{
|
||||
reason = "The Spelunk API address must be a web address, like https://api.spelunk.example.com.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (string.Equals(uri.Scheme, Uri.UriSchemeHttp, StringComparison.Ordinal) && !uri.IsLoopback)
|
||||
{
|
||||
reason = "The Spelunk API address must use https, because the API key is sent with every connection.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (uri.UserInfo.Length > 0 || uri.Query.Length > 0 || uri.Fragment.Length > 0)
|
||||
{
|
||||
reason = "The Spelunk API address cannot carry a user name, a query or a fragment.";
|
||||
return false;
|
||||
}
|
||||
|
||||
apiBase = uri.GetLeftPart(UriPartial.Path).TrimEnd('/');
|
||||
reason = null;
|
||||
return true;
|
||||
}
|
||||
}
|
||||
@@ -283,6 +283,9 @@ internal sealed class S3FileStore : IRemoteFileStore
|
||||
/// have cost.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
/// <inheritdoc />
|
||||
public bool CanWriteFromAnOffset => false;
|
||||
|
||||
public Task<Stream> OpenWriteAsync(string path, long offset, CancellationToken cancellationToken)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(path);
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
using DodoSSH.Client.Ssh;
|
||||
|
||||
namespace DodoSSH.Client.Session;
|
||||
|
||||
/// <summary>
|
||||
/// A way to a host that is not a dial: one connection long, handed to SSH.NET as a loopback proxy.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Two things answer to this — the server relay (<see cref="RelayRoute"/>) and a Spelunk tunnel
|
||||
/// (<see cref="SpelunkTunnelRoute"/>) — and both are the same shape underneath: a WebSocket carrying the
|
||||
/// SSH bytes, and a <see cref="RelayBridge"/> that turns it into an address SSH.NET can be given. What the
|
||||
/// connect path needs from either is exactly that address, the reason the far end gave if it hung up, and a
|
||||
/// way to let go of it when the connect never got as far as handing it over.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Handing <see cref="Proxy"/> to a connection hands the bridge over with it, so the connection's own
|
||||
/// disposal is what closes the route. <see cref="IAsyncDisposable.DisposeAsync"/> is for a caller that ends
|
||||
/// up not connecting; after a hand-over it does nothing, because the bridge's disposal is idempotent.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public interface IConnectionRoute : IAsyncDisposable
|
||||
{
|
||||
/// <summary>The loopback proxy to connect through, which owns the route from then on.</summary>
|
||||
SshLoopbackProxy Proxy { get; }
|
||||
|
||||
/// <summary>
|
||||
/// What the far end said when it closed, in words a user can act on; null when it has not closed, or
|
||||
/// closed with nothing to say.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// For a connect that failed. SSH.NET reports a route that hung up as a stream that ended, which reads
|
||||
/// exactly like the direct connection the route was chosen to get around — so the route's own reason,
|
||||
/// when it gave one, replaces it.
|
||||
/// </remarks>
|
||||
string? Failure { get; }
|
||||
}
|
||||
@@ -40,7 +40,7 @@ public interface IServerRelay
|
||||
/// disposal is what closes the relay. <see cref="DisposeAsync"/> is for a caller that ends up not
|
||||
/// connecting; after a hand-over it does nothing, because the bridge's disposal is idempotent.
|
||||
/// </remarks>
|
||||
public sealed class RelayRoute : IAsyncDisposable
|
||||
public sealed class RelayRoute : IConnectionRoute
|
||||
{
|
||||
private readonly RelayBridge bridge;
|
||||
|
||||
|
||||
@@ -0,0 +1,209 @@
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using System.Text;
|
||||
using DodoSSH.Client.Domain;
|
||||
|
||||
namespace DodoSSH.Client.Session;
|
||||
|
||||
/// <summary>
|
||||
/// A <c>dodossh://spelunk/connect</c> link from Spelunk's web interface, read and checked.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Spelunk puts one of these behind a "Open in DodoSSH" button on a server's page:
|
||||
/// <c>dodossh://spelunk/connect?api=…&server=…&name=…&host=…</c>. It says which Spelunk and which
|
||||
/// server, and what to call it. <b>It never carries a credential</b>, and nothing reads one out of it: the
|
||||
/// API key is the user's, chosen in the vault, and a link that could supply one would be a link that could
|
||||
/// supply somebody else's.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>Anything on the machine can hand this application a link</b> — a web page, a mail, another program —
|
||||
/// so a link is data to check, never an instruction. It is refused whole unless it is exactly this shape,
|
||||
/// and the most it can ever do is connect to a host a link made before, add one for another server on a
|
||||
/// Spelunk a saved host already sends its API key to — with that same key — or open the editor on a new
|
||||
/// one that the user then has to finish and save. It never sends an API key anywhere a saved host does
|
||||
/// not already send it. See <c>VaultViewModel.OpenSpelunkLinkAsync</c>.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
/// <param name="ApiBase">The Spelunk API's base address, normalised as <see cref="SpelunkRoute"/> stores it.</param>
|
||||
/// <param name="ServerId">The server's id in Spelunk.</param>
|
||||
/// <param name="Name">What Spelunk calls the server, cleaned for display.</param>
|
||||
/// <param name="Host">The server's public address as Spelunk knows it, or null when it gave none.</param>
|
||||
public sealed record SpelunkLink(string ApiBase, Guid ServerId, string Name, string? Host)
|
||||
{
|
||||
/// <summary>The URL scheme DodoSSH registers.</summary>
|
||||
public const string Scheme = "dodossh";
|
||||
|
||||
/// <summary>The longest link read at all. Anything longer is refused before it is parsed.</summary>
|
||||
/// <remarks>
|
||||
/// A real link is a few hundred characters. The bound is what a second launch may put down the doorbell
|
||||
/// pipe, and what the parser is asked to walk — neither of which should be up to the sender.
|
||||
/// </remarks>
|
||||
public const int MaxLength = 4096;
|
||||
|
||||
/// <summary>The longest name kept. Longer is cut, not refused: it is only a label.</summary>
|
||||
public const int MaxNameLength = 100;
|
||||
|
||||
private const string Authority = "spelunk";
|
||||
private const string Path = "/connect";
|
||||
|
||||
/// <summary>
|
||||
/// The hostname a new host from this link is given: Spelunk's address for the server, or a name made
|
||||
/// from its id when there is none.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// It is not dialled — the tunnel ignores it — but the host key is pinned under it, so it has to be
|
||||
/// stable for this server and unlike any other. The id is both; the address is also what the user would
|
||||
/// recognise, and a key already trusted for a direct connection to that address is found again.
|
||||
/// </remarks>
|
||||
public string Hostname => Host ?? $"spelunk-{ServerId}";
|
||||
|
||||
/// <summary>Whether a string looks like it is meant to be one of these, before checking it is one.</summary>
|
||||
/// <remarks>
|
||||
/// For the launcher, which is handed arguments of every kind and needs to tell a link that failed the
|
||||
/// checks from something that was never a link.
|
||||
/// </remarks>
|
||||
public static bool LooksLikeOne(string? text) =>
|
||||
text is not null && text.StartsWith(Scheme + ":", StringComparison.OrdinalIgnoreCase);
|
||||
|
||||
/// <summary>Reads a link, or refuses it.</summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Strict on everything that decides where anything goes: the scheme, <c>spelunk</c> as the authority
|
||||
/// with no user, password or port, <c>/connect</c> as the path, no fragment, each known parameter at
|
||||
/// most once, an API address <see cref="SpelunkRoute.TryNormalizeApiBase"/> accepts, and a server id
|
||||
/// that is a real one. Unknown parameters are ignored rather than refused, so a newer Spelunk can add
|
||||
/// one without every existing DodoSSH ignoring its links outright.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Lenient only on the name, which is display text: control characters become spaces and a long one is
|
||||
/// cut. A missing name falls back to the host, then to a plain one.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public static bool TryParse(string? text, [NotNullWhen(true)] out SpelunkLink? link)
|
||||
{
|
||||
link = null;
|
||||
|
||||
if (text is null
|
||||
|| text.Length > MaxLength
|
||||
|| text.Any(character => char.IsWhiteSpace(character) || char.IsControl(character))
|
||||
|| !Uri.TryCreate(text, UriKind.Absolute, out var uri)
|
||||
|| !string.Equals(uri.Scheme, Scheme, StringComparison.Ordinal)
|
||||
|| !string.Equals(uri.Host, Authority, StringComparison.Ordinal)
|
||||
|| uri.UserInfo.Length > 0
|
||||
|| !uri.IsDefaultPort
|
||||
|| !string.Equals(uri.AbsolutePath, Path, StringComparison.Ordinal)
|
||||
|| uri.Fragment.Length > 0
|
||||
|| !TryReadQuery(QueryOf(text), out var parameters)
|
||||
|| !parameters.TryGetValue("api", out var api)
|
||||
|| !SpelunkRoute.TryNormalizeApiBase(api, out var apiBase, out _)
|
||||
|| !parameters.TryGetValue("server", out var server)
|
||||
|| !Guid.TryParseExact(server, "D", out var serverId)
|
||||
|| serverId == Guid.Empty)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
string? host = null;
|
||||
|
||||
if (parameters.TryGetValue("host", out var given) && given.Trim() is { Length: > 0 } trimmed)
|
||||
{
|
||||
if (trimmed.Length > 253 || Uri.CheckHostName(trimmed) is UriHostNameType.Unknown)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
host = trimmed;
|
||||
}
|
||||
|
||||
var name = Clean(parameters.GetValueOrDefault("name")) ?? host ?? "Spelunk server";
|
||||
|
||||
link = new SpelunkLink(apiBase, serverId, name, host);
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>The link written out again, in the one form <see cref="TryParse"/> reads back to the same value.</summary>
|
||||
/// <remarks>
|
||||
/// What a second launch sends the running instance, so the instance parses a link this build wrote rather
|
||||
/// than whatever the browser handed over.
|
||||
/// </remarks>
|
||||
public override string ToString()
|
||||
{
|
||||
var builder = new StringBuilder($"{Scheme}://{Authority}{Path}?api=")
|
||||
.Append(Uri.EscapeDataString(ApiBase))
|
||||
.Append("&server=")
|
||||
.Append(ServerId.ToString("D"))
|
||||
.Append("&name=")
|
||||
.Append(Uri.EscapeDataString(Name));
|
||||
|
||||
if (Host is not null)
|
||||
{
|
||||
builder.Append("&host=").Append(Uri.EscapeDataString(Host));
|
||||
}
|
||||
|
||||
return builder.ToString();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Splits a query into its known parameters, refusing one that names any of them twice.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// By hand rather than through a web utility, because this project has none and because the rule that
|
||||
/// matters — twice is refused, not "last wins" — is one no general-purpose parser applies. <c>+</c> is a
|
||||
/// space, as a browser's form encoding writes it.
|
||||
/// </remarks>
|
||||
private static bool TryReadQuery(string query, out Dictionary<string, string> parameters)
|
||||
{
|
||||
parameters = new Dictionary<string, string>(StringComparer.Ordinal);
|
||||
|
||||
foreach (var pair in query.Split('&', StringSplitOptions.RemoveEmptyEntries))
|
||||
{
|
||||
var equals = pair.IndexOf('=', StringComparison.Ordinal);
|
||||
var key = equals < 0 ? pair : pair[..equals];
|
||||
var value = equals < 0 ? string.Empty : pair[(equals + 1)..];
|
||||
|
||||
if (key is not ("api" or "server" or "name" or "host"))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
string decoded;
|
||||
|
||||
try
|
||||
{
|
||||
decoded = Uri.UnescapeDataString(value.Replace('+', ' '));
|
||||
}
|
||||
catch (UriFormatException)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!parameters.TryAdd(key, decoded))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>The query exactly as it was written, rather than as <see cref="Uri"/> re-escapes it.</summary>
|
||||
/// <remarks>
|
||||
/// <see cref="Uri"/> has no rules for a scheme it does not know, and how much of the query it unescapes
|
||||
/// for one is its business. Taking the text after the first <c>?</c> means every parameter is decoded
|
||||
/// exactly once, here.
|
||||
/// </remarks>
|
||||
private static string QueryOf(string text) =>
|
||||
text.IndexOf('?', StringComparison.Ordinal) is var at and >= 0 ? text[(at + 1)..] : string.Empty;
|
||||
|
||||
private static string? Clean(string? name)
|
||||
{
|
||||
if (string.IsNullOrWhiteSpace(name))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
var cleaned = new string([.. name.Trim().Select(character => char.IsControl(character) ? ' ' : character)]);
|
||||
|
||||
return cleaned.Length > MaxNameLength ? cleaned[..MaxNameLength].TrimEnd() : cleaned;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,81 @@
|
||||
using System.Text;
|
||||
using DodoSSH.Client.Ssh;
|
||||
|
||||
namespace DodoSSH.Client.Session;
|
||||
|
||||
/// <summary>
|
||||
/// The throwaway key one connection signs in to a Spelunk server with.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// For a host set to sign in through Spelunk — see <c>SpelunkRoute.SignInThroughSpelunk</c> — each connection
|
||||
/// makes one of these, sends <see cref="PublicKeyLine"/> with its ticket request, and authenticates with
|
||||
/// <see cref="Credential"/> once the tunnel is up. Spelunk's agent runs a one-connection SSH server whose only
|
||||
/// authorised key is this one, so the key is worth nothing after the connection it was made for.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>Made in memory and never kept.</b> Nothing writes it to a disk or to the vault, and nothing logs it:
|
||||
/// <see cref="ToString"/> says what it is and nothing of what it holds. Ed25519, which is what
|
||||
/// <see cref="SshKeyGenerator"/> makes instantly and what every OpenSSH the agent could start accepts.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public sealed class SpelunkSignIn
|
||||
{
|
||||
/// <summary>The account Spelunk signs in as when its answer does not name one.</summary>
|
||||
public const string DefaultUser = "root";
|
||||
|
||||
/// <summary>The comment the public key carries, which is what Spelunk and the server's logs see.</summary>
|
||||
internal const string KeyComment = "dodossh-spelunk-sign-in";
|
||||
|
||||
private SpelunkSignIn(string publicKeyLine, SshPrivateKeyCredential credential)
|
||||
{
|
||||
PublicKeyLine = publicKeyLine;
|
||||
Credential = credential;
|
||||
}
|
||||
|
||||
/// <summary>The public half, as one OpenSSH <c>authorized_keys</c> line: <c>ssh-ed25519 AAAA… comment</c>.</summary>
|
||||
public string PublicKeyLine { get; }
|
||||
|
||||
/// <summary>The private half, in the form a connection authenticates with.</summary>
|
||||
public SshPrivateKeyCredential Credential { get; }
|
||||
|
||||
/// <summary>Makes a fresh key pair for one connection.</summary>
|
||||
public static SpelunkSignIn Create()
|
||||
{
|
||||
var key = SshKeyGenerator.Generate(SshKeyAlgorithm.Ed25519, KeyComment);
|
||||
|
||||
return new SpelunkSignIn(
|
||||
key.PublicKeyLine.Trim(),
|
||||
new SshPrivateKeyCredential(Encoding.UTF8.GetBytes(key.PrivateKeyArmour), Passphrase: null));
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <remarks>Says nothing of the key, so one that reaches a log by accident takes nothing with it.</remarks>
|
||||
public override string ToString() => "Spelunk sign-in key";
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The credential of a connection that will sign in through Spelunk, before the tunnel has made its key.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// A host that signs in through Spelunk is resolved to a login before anything is opened — the same
|
||||
/// resolution every host goes through — but its key does not exist until the tunnel is opened, and the
|
||||
/// account is whatever Spelunk then says. This stands in for the key until the route replaces it, together
|
||||
/// with the username, as the connection is made through it.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>It authenticates nothing.</b> The SSH layer knows only passwords and private keys, and refuses any other
|
||||
/// credential before it dials — so a path that forgot to take the route's key fails closed rather than
|
||||
/// sending something else in its place.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public sealed record SpelunkSignInPending : SshCredential
|
||||
{
|
||||
/// <summary>The one value; there is nothing in it to tell two apart.</summary>
|
||||
public static SpelunkSignInPending Instance { get; } = new();
|
||||
|
||||
private SpelunkSignInPending()
|
||||
{
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,661 @@
|
||||
using System.Globalization;
|
||||
using System.Net;
|
||||
using System.Net.Http.Headers;
|
||||
using System.Net.Http.Json;
|
||||
using System.Net.WebSockets;
|
||||
using System.Text;
|
||||
using System.Text.Json;
|
||||
using System.Text.Json.Serialization;
|
||||
using DodoSSH.Client.Domain;
|
||||
using DodoSSH.Client.Ssh;
|
||||
|
||||
namespace DodoSSH.Client.Session;
|
||||
|
||||
/// <summary>
|
||||
/// Spelunk's tunnel: the routes, the subprotocol and the close codes, as Spelunk defines them.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// The same two steps as the server relay's, and on purpose, because the bridge on this side is the relay's
|
||||
/// and it only has to be told where to go. An authenticated POST decides everything — whose key, which
|
||||
/// server, whether the key may — and answers with a ticket; the WebSocket that spends the ticket carries no
|
||||
/// authority of its own, and after the upgrade every binary message is simply the next bytes of the SSH
|
||||
/// stream, both ways, with nothing else in the socket at all.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// This is Spelunk's contract, not DodoSSH's, which is why it lives here and not in
|
||||
/// <c>DodoSSH.Contracts</c>: nothing on the DodoSSH server takes part in a Spelunk tunnel.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public static class SpelunkTunnelProtocol
|
||||
{
|
||||
/// <summary>The only subprotocol this version speaks.</summary>
|
||||
public const string SubProtocol = "spelunk.tunnel.v1";
|
||||
|
||||
/// <summary>The prefix of the second subprotocol an upgrade offers, which carries the ticket.</summary>
|
||||
/// <remarks>
|
||||
/// A header rather than the query string, for the reason the relay gives: a URL is what proxies, access
|
||||
/// logs and traces keep. Spelunk echoes <see cref="SubProtocol"/> alone.
|
||||
/// </remarks>
|
||||
public const string TicketProtocolPrefix = "ticket.";
|
||||
|
||||
/// <summary>
|
||||
/// Close code for an agent that could not connect to the port on its own machine — or that is too old to
|
||||
/// know what a tunnel is, in which case the reason says <see cref="UnknownStreamKind"/>.
|
||||
/// </summary>
|
||||
public const int TargetUnreachableCloseCode = 4502;
|
||||
|
||||
/// <summary>Close code for an agent that disconnected from Spelunk while the tunnel was open.</summary>
|
||||
public const int AgentDisconnectedCloseCode = 4503;
|
||||
|
||||
/// <summary>
|
||||
/// What an agent that predates tunnels — or, asked to sign in, predates that — says, inside a
|
||||
/// <see cref="TargetUnreachableCloseCode"/>.
|
||||
/// </summary>
|
||||
internal const string UnknownStreamKind = "Unknown stream kind";
|
||||
|
||||
/// <summary>Where a ticket for one server is asked for.</summary>
|
||||
internal static string TicketsPath(Guid serverId) =>
|
||||
string.Create(CultureInfo.InvariantCulture, $"/api/servers/{serverId}/tunnel-tickets");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Opens SSH connections to Spelunk-managed servers through Spelunk.
|
||||
/// </summary>
|
||||
public interface ISpelunkTunnel
|
||||
{
|
||||
/// <summary>
|
||||
/// Opens a tunnel to one server, ready for a connection to be made through it.
|
||||
/// </summary>
|
||||
/// <param name="apiBase">The Spelunk API's base address, normalised by <see cref="SpelunkRoute"/>.</param>
|
||||
/// <param name="serverId">The server's id in Spelunk.</param>
|
||||
/// <param name="apiKey">The Spelunk API key, which authorises the ticket and is sent nowhere else.</param>
|
||||
/// <param name="port">
|
||||
/// The port the agent is to connect to on the server's own loopback. Not sent when signing in, where the
|
||||
/// agent starts an SSH server of its own and Spelunk ignores it.
|
||||
/// </param>
|
||||
/// <param name="signIn">
|
||||
/// The throwaway key to have Spelunk sign in with, or null for a plain tunnel to <paramref name="port"/>.
|
||||
/// Its public half goes with the ticket request; the route hands the whole of it back, with the account
|
||||
/// Spelunk named, for the connection made through it.
|
||||
/// </param>
|
||||
/// <param name="cancellationToken">Cancellation.</param>
|
||||
/// <remarks>
|
||||
/// Asks for a ticket, opens the socket and starts the bridge, in that order and at once — the ticket is
|
||||
/// spent by the socket and dead thirty seconds after issue, so this is called by the connect that will
|
||||
/// use it and never ahead of one. The key is a parameter rather than a field of some request record
|
||||
/// because a record prints its fields, and a key has no business in anything that might be logged.
|
||||
/// </remarks>
|
||||
/// <exception cref="SpelunkTunnelException">The tunnel could not be opened; the message says why.</exception>
|
||||
Task<SpelunkTunnelRoute> OpenAsync(
|
||||
string apiBase,
|
||||
Guid serverId,
|
||||
string apiKey,
|
||||
int port,
|
||||
SpelunkSignIn? signIn,
|
||||
CancellationToken cancellationToken);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// An open Spelunk tunnel, one connection long.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The same ownership as <see cref="RelayRoute"/>, because it is the same bridge: see
|
||||
/// <see cref="IConnectionRoute"/>.
|
||||
/// </remarks>
|
||||
public sealed class SpelunkTunnelRoute : IConnectionRoute
|
||||
{
|
||||
/// <summary>The longest stretch of Spelunk's own close reason that is repeated to the user.</summary>
|
||||
private const int MaxReasonLength = 200;
|
||||
|
||||
private readonly RelayBridge bridge;
|
||||
private readonly int port;
|
||||
|
||||
internal SpelunkTunnelRoute(RelayBridge bridge, int port, SpelunkSignIn? signIn = null, string? user = null)
|
||||
{
|
||||
this.bridge = bridge;
|
||||
this.port = port;
|
||||
SignIn = signIn;
|
||||
User = signIn is null ? null : user ?? SpelunkSignIn.DefaultUser;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public SshLoopbackProxy Proxy => bridge.Proxy;
|
||||
|
||||
/// <summary>The key Spelunk was asked to sign in with, or null for a plain tunnel.</summary>
|
||||
/// <remarks>
|
||||
/// Handed back rather than kept by whoever asked, so the connection made through this route takes its
|
||||
/// credential from the same place it takes its proxy, and cannot be given one without the other.
|
||||
/// </remarks>
|
||||
public SpelunkSignIn? SignIn { get; }
|
||||
|
||||
/// <summary>
|
||||
/// The account Spelunk signs in as — its answer's <c>user</c>, or <see cref="SpelunkSignIn.DefaultUser"/>
|
||||
/// when it named none — or null for a plain tunnel.
|
||||
/// </summary>
|
||||
public string? User { get; }
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <remarks>
|
||||
/// A normal close is not a failure worth rewording: it is the SSH server hanging up, and SSH.NET's own
|
||||
/// account of that is the accurate one.
|
||||
/// </remarks>
|
||||
public string? Failure =>
|
||||
bridge.CloseStatus is { } status
|
||||
? Describe((int)status, bridge.CloseDescription, port, signingIn: SignIn is not null)
|
||||
: null;
|
||||
|
||||
/// <inheritdoc />
|
||||
public ValueTask DisposeAsync() => bridge.DisposeAsync();
|
||||
|
||||
/// <summary>What a close code from Spelunk means, for someone who has to do something about it.</summary>
|
||||
internal static string? Describe(int code, string? reason, int port, bool signingIn = false) => code switch
|
||||
{
|
||||
SpelunkTunnelProtocol.TargetUnreachableCloseCode
|
||||
when reason?.Contains(SpelunkTunnelProtocol.UnknownStreamKind, StringComparison.OrdinalIgnoreCase) is true =>
|
||||
signingIn
|
||||
? "The Spelunk agent on this server is too old to sign you in. Update the agent, then try again."
|
||||
: "The Spelunk agent on this server is too old to open a terminal. Update the agent, then try again.",
|
||||
|
||||
// Signing in, the agent connects to nothing: it starts an SSH server of its own, and what it could not
|
||||
// do is that — most often because the server has no OpenSSH server to start, which Spelunk's reason
|
||||
// says in its own words.
|
||||
SpelunkTunnelProtocol.TargetUnreachableCloseCode when signingIn =>
|
||||
"The Spelunk agent could not sign you in on this server"
|
||||
+ (Readable(reason) is { } said ? $" ({said})" : string.Empty)
|
||||
+ ". Signing in through Spelunk needs OpenSSH's server (sshd) installed there.",
|
||||
|
||||
SpelunkTunnelProtocol.TargetUnreachableCloseCode =>
|
||||
string.Create(
|
||||
CultureInfo.InvariantCulture,
|
||||
$"The Spelunk agent could not connect to port {port} on the server itself")
|
||||
+ (Readable(reason) is { } said ? $" ({said})" : string.Empty)
|
||||
+ ". Check that the SSH server is running and listening on that port.",
|
||||
|
||||
SpelunkTunnelProtocol.AgentDisconnectedCloseCode =>
|
||||
"The Spelunk agent on this server disconnected from Spelunk. It may be restarting; try again in a "
|
||||
+ "moment.",
|
||||
|
||||
(int)WebSocketCloseStatus.EndpointUnavailable => "Spelunk is restarting. Try again in a moment.",
|
||||
|
||||
_ => null,
|
||||
};
|
||||
|
||||
/// <summary>
|
||||
/// Spelunk's own words, cut to one line of printable text, or null when there are none worth showing.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Shown because they are specific — "connection refused" and "no route to host" are different problems
|
||||
/// on the server — and trimmed because they are another program's output going onto a status line.
|
||||
/// </remarks>
|
||||
internal static string? Readable(string? text)
|
||||
{
|
||||
if (string.IsNullOrWhiteSpace(text))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
var builder = new StringBuilder(Math.Min(text.Length, MaxReasonLength));
|
||||
|
||||
foreach (var character in text.Trim())
|
||||
{
|
||||
if (builder.Length == MaxReasonLength)
|
||||
{
|
||||
builder.Append('…');
|
||||
break;
|
||||
}
|
||||
|
||||
builder.Append(char.IsControl(character) ? ' ' : character);
|
||||
}
|
||||
|
||||
return builder.ToString();
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>A Spelunk tunnel that could not be opened, with the reason in its message.</summary>
|
||||
/// <remarks>
|
||||
/// Its own type for the reason <see cref="ServerRelayException"/> is one: the connect path must be able to
|
||||
/// tell a refusal, which already says exactly what happened, from a connection failure it might explain by
|
||||
/// probing — and probing a Spelunk host would dial an address that exists only to name its key.
|
||||
/// </remarks>
|
||||
public sealed class SpelunkTunnelException : Exception
|
||||
{
|
||||
/// <summary>A refusal with nothing underneath it.</summary>
|
||||
public SpelunkTunnelException(string message)
|
||||
: base(message)
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>A refusal and what caused it.</summary>
|
||||
public SpelunkTunnelException(string message, Exception innerException)
|
||||
: base(message, innerException)
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>A refusal Spelunk answered with a status.</summary>
|
||||
public SpelunkTunnelException(string message, HttpStatusCode statusCode)
|
||||
: base(message) =>
|
||||
StatusCode = statusCode;
|
||||
|
||||
/// <summary>What Spelunk answered with, or null where the refusal came from somewhere else.</summary>
|
||||
/// <remarks>Kept for tests and logs; the screen reads the message.</remarks>
|
||||
public HttpStatusCode? StatusCode { get; }
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The Spelunk tunnel: a ticket from the API, a socket, and the relay's bridge.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Every way this can fail is turned into a sentence here, as <see cref="ServerRelay"/> does for the relay,
|
||||
/// because the status codes are Spelunk's and the one place that should know what each means is the one
|
||||
/// that asked.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>Nothing from Spelunk's answer is trusted to go anywhere else.</b> The socket is opened on the API's
|
||||
/// own scheme, host and port, with only the path taken from the answer — and only a path that is one — so a
|
||||
/// ticket response cannot send this client, or the ticket, to a different machine.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public sealed class SpelunkTunnel : ISpelunkTunnel
|
||||
{
|
||||
/// <summary>The longest ticket accepted. Far beyond Spelunk's; a bound on what goes into a header.</summary>
|
||||
private const int MaxTicketLength = 2048;
|
||||
|
||||
/// <summary>The longest account name taken from Spelunk's answer — well past what a Unix system allows.</summary>
|
||||
private const int MaxUserLength = 64;
|
||||
|
||||
/// <summary>The longest error body read, so a misbehaving proxy cannot hand this a gigabyte.</summary>
|
||||
private const int MaxProblemBytes = 16 * 1024;
|
||||
|
||||
/// <summary>
|
||||
/// One transport for the process, as the platform advises for <see cref="HttpClient"/>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Bounded well short of the default hundred seconds: a ticket is one small request, and somebody
|
||||
/// watching "Connecting…" should hear that Spelunk is not answering while they still care.
|
||||
/// </remarks>
|
||||
private static readonly HttpClient SharedHttp = new(
|
||||
new SocketsHttpHandler { PooledConnectionLifetime = TimeSpan.FromMinutes(5) })
|
||||
{
|
||||
Timeout = TimeSpan.FromSeconds(30),
|
||||
};
|
||||
|
||||
private readonly HttpClient http;
|
||||
private readonly Func<Uri, IReadOnlyList<string>, CancellationToken, Task<WebSocket>> connect;
|
||||
|
||||
/// <summary>A tunnel over the process's shared transport, which is how the application builds one.</summary>
|
||||
public SpelunkTunnel()
|
||||
: this(SharedHttp, DialAsync)
|
||||
{
|
||||
}
|
||||
|
||||
/// <summary>A tunnel whose requests and socket are supplied, for tests.</summary>
|
||||
internal SpelunkTunnel(
|
||||
HttpClient http,
|
||||
Func<Uri, IReadOnlyList<string>, CancellationToken, Task<WebSocket>> connect)
|
||||
{
|
||||
this.http = http;
|
||||
this.connect = connect;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public async Task<SpelunkTunnelRoute> OpenAsync(
|
||||
string apiBase,
|
||||
Guid serverId,
|
||||
string apiKey,
|
||||
int port,
|
||||
SpelunkSignIn? signIn,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
if (!SpelunkRoute.TryNormalizeApiBase(apiBase, out var normalized, out var reason))
|
||||
{
|
||||
throw new SpelunkTunnelException(reason);
|
||||
}
|
||||
|
||||
var ticket = await IssueTicketAsync(normalized, serverId, Sanitise(apiKey), port, signIn, cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
var socket = await connect(
|
||||
SocketUrl(normalized, ticket.Path!),
|
||||
[SpelunkTunnelProtocol.SubProtocol, SpelunkTunnelProtocol.TicketProtocolPrefix + ticket.Ticket],
|
||||
cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
return new SpelunkTunnelRoute(RelayBridge.Start(socket), port, signIn, ticket.User);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Where the tunnel socket is: the API's own origin, on the WebSocket scheme, at the path Spelunk named.
|
||||
/// </summary>
|
||||
internal static Uri SocketUrl(string apiBase, string path)
|
||||
{
|
||||
var secure = apiBase.StartsWith("https://", StringComparison.Ordinal);
|
||||
var rest = apiBase[(secure ? "https".Length : "http".Length)..];
|
||||
|
||||
return new Uri((secure ? "wss" : "ws") + rest + path, UriKind.Absolute);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Trims the stored key and refuses one that could not be a header value.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// A key pasted into a credential arrives with a newline behind it often enough to be worth handling, and
|
||||
/// one with a space in the middle would otherwise surface as a <see cref="FormatException"/> from inside
|
||||
/// <see cref="HttpClient"/> rather than as a sentence about the credential.
|
||||
/// </remarks>
|
||||
private static string Sanitise(string apiKey)
|
||||
{
|
||||
var trimmed = apiKey?.Trim() ?? string.Empty;
|
||||
|
||||
if (trimmed.Length == 0 || trimmed.Any(character => char.IsWhiteSpace(character) || char.IsControl(character)))
|
||||
{
|
||||
throw new SpelunkTunnelException(
|
||||
"The credential chosen for the Spelunk API key does not hold one. A Spelunk API key is one "
|
||||
+ "unbroken run of characters starting with spelunk_; paste it as the credential's password.");
|
||||
}
|
||||
|
||||
return trimmed;
|
||||
}
|
||||
|
||||
private async Task<SpelunkTicketDocument> IssueTicketAsync(
|
||||
string apiBase,
|
||||
Guid serverId,
|
||||
string apiKey,
|
||||
int port,
|
||||
SpelunkSignIn? signIn,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
using var request = new HttpRequestMessage(
|
||||
HttpMethod.Post,
|
||||
new Uri(apiBase + SpelunkTunnelProtocol.TicketsPath(serverId), UriKind.Absolute));
|
||||
|
||||
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);
|
||||
|
||||
// Serialised up front rather than streamed, so the request carries a Content-Length: a dozen bytes
|
||||
// do not need chunked encoding, and not every proxy in front of an API accepts it.
|
||||
//
|
||||
// Signing in sends the public key and no port: the agent starts an SSH server of its own rather than
|
||||
// connecting to one, and Spelunk ignores the port beside a key anyway.
|
||||
request.Content = new ByteArrayContent(JsonSerializer.SerializeToUtf8Bytes(
|
||||
signIn is null
|
||||
? new SpelunkTicketRequestDocument { Port = port }
|
||||
: new SpelunkTicketRequestDocument
|
||||
{
|
||||
SignIn = new SpelunkSignInRequestDocument { PublicKey = signIn.PublicKeyLine },
|
||||
},
|
||||
SpelunkTunnelJsonContext.Default.SpelunkTicketRequestDocument))
|
||||
{
|
||||
Headers = { ContentType = new MediaTypeHeaderValue("application/json") },
|
||||
};
|
||||
|
||||
HttpResponseMessage response;
|
||||
|
||||
try
|
||||
{
|
||||
response = await http.SendAsync(request, cancellationToken).ConfigureAwait(false);
|
||||
}
|
||||
catch (HttpRequestException exception)
|
||||
{
|
||||
throw new SpelunkTunnelException(
|
||||
$"Spelunk could not be reached at {apiBase}: {exception.Message}",
|
||||
exception);
|
||||
}
|
||||
catch (TaskCanceledException exception) when (!cancellationToken.IsCancellationRequested)
|
||||
{
|
||||
throw new SpelunkTunnelException(
|
||||
$"Spelunk at {apiBase} did not answer in time. Try again in a moment.",
|
||||
exception);
|
||||
}
|
||||
|
||||
using (response)
|
||||
{
|
||||
if (!response.IsSuccessStatusCode)
|
||||
{
|
||||
var problem = await ReadProblemAsync(response, cancellationToken).ConfigureAwait(false);
|
||||
|
||||
throw new SpelunkTunnelException(Describe(response.StatusCode, problem), response.StatusCode);
|
||||
}
|
||||
|
||||
return await ReadTicketAsync(response, signingIn: signIn is not null, cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Reads the ticket, and refuses one this client would have to take on trust.</summary>
|
||||
private static async Task<SpelunkTicketDocument> ReadTicketAsync(
|
||||
HttpResponseMessage response,
|
||||
bool signingIn,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
SpelunkTicketDocument? ticket;
|
||||
|
||||
try
|
||||
{
|
||||
ticket = await response.Content
|
||||
.ReadFromJsonAsync(SpelunkTunnelJsonContext.Default.SpelunkTicketDocument, cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
}
|
||||
catch (JsonException exception)
|
||||
{
|
||||
throw new SpelunkTunnelException(Unintelligible, exception);
|
||||
}
|
||||
|
||||
// The ticket goes into a header as part of a subprotocol name, which may hold only token characters —
|
||||
// base64url is all of those, and anything else would fail inside the WebSocket client instead. The
|
||||
// path is appended to the API's own origin, so it has to be a path: "//elsewhere" or "@elsewhere"
|
||||
// would turn it into a different host.
|
||||
if (ticket is not { Ticket: { Length: > 0 and <= MaxTicketLength } value, Path: { } path }
|
||||
|| !value.All(IsBase64UrlCharacter)
|
||||
|| !path.StartsWith('/')
|
||||
|| path.StartsWith("//", StringComparison.Ordinal)
|
||||
|| path.Any(character => character is '?' or '#' or '\\' or '@' || char.IsWhiteSpace(character) || char.IsControl(character))
|
||||
|| (ticket.Subprotocol is { } named
|
||||
&& !string.Equals(named, SpelunkTunnelProtocol.SubProtocol, StringComparison.Ordinal))
|
||||
|| (signingIn && ticket.User is { } user && !IsAccountName(user)))
|
||||
{
|
||||
throw new SpelunkTunnelException(Unintelligible);
|
||||
}
|
||||
|
||||
return ticket;
|
||||
}
|
||||
|
||||
private const string Unintelligible =
|
||||
"Spelunk answered the tunnel request in a way this app does not understand. Update DodoSSH, or check "
|
||||
+ "that the API address is Spelunk's.";
|
||||
|
||||
private static bool IsBase64UrlCharacter(char character) =>
|
||||
char.IsAsciiLetterOrDigit(character) || character is '-' or '_';
|
||||
|
||||
/// <summary>
|
||||
/// Whether the account Spelunk named is one an SSH login could be for: a short run of the characters
|
||||
/// Unix account names are made of.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Checked because it goes to the server as the login and onto the tab and the status line, and an
|
||||
/// answer carrying anything else is not one this client understands.
|
||||
/// </remarks>
|
||||
private static bool IsAccountName(string user) =>
|
||||
user.Length is > 0 and <= MaxUserLength
|
||||
&& user.All(character => char.IsAsciiLetterOrDigit(character) || character is '_' or '-' or '.');
|
||||
|
||||
/// <summary>What a refused ticket means, in the words of the status and of Spelunk's own detail.</summary>
|
||||
private static string Describe(HttpStatusCode status, SpelunkProblemDocument? problem)
|
||||
{
|
||||
var detail = SpelunkTunnelRoute.Readable(problem?.Detail);
|
||||
|
||||
return status switch
|
||||
{
|
||||
// Spelunk's validation says which field and why; for a sign-in it is the public key.
|
||||
HttpStatusCode.BadRequest =>
|
||||
"Spelunk would not accept the request to open the tunnel"
|
||||
+ ((SpelunkTunnelRoute.Readable(PublicKeyError(problem))
|
||||
?? detail
|
||||
?? SpelunkTunnelRoute.Readable(problem?.Title)) is { } said
|
||||
? $": {said}"
|
||||
: ". Update DodoSSH, or check that the API address is Spelunk's."),
|
||||
|
||||
HttpStatusCode.Unauthorized =>
|
||||
"Spelunk did not accept the API key. It may have been revoked or mistyped — create a new one in "
|
||||
+ "Spelunk and paste it into the credential this host uses for it.",
|
||||
|
||||
// The detail is the useful half here: it says which role the key has and which it needs.
|
||||
HttpStatusCode.Forbidden =>
|
||||
"The Spelunk API key is not allowed to open a terminal on this server"
|
||||
+ (detail is null ? ". Opening one needs a key with the Admin role." : $": {detail}"),
|
||||
|
||||
HttpStatusCode.NotFound =>
|
||||
"Spelunk does not know this server in the API key's organisation. It may have been removed, or "
|
||||
+ "the key belongs to a different organisation.",
|
||||
|
||||
HttpStatusCode.ServiceUnavailable =>
|
||||
"The Spelunk agent on this server is not connected, so Spelunk cannot reach it. Check that the "
|
||||
+ "agent is running on the server, then try again.",
|
||||
|
||||
_ => string.Create(
|
||||
CultureInfo.InvariantCulture,
|
||||
$"Spelunk would not open the tunnel (HTTP {(int)status})")
|
||||
+ ((detail ?? SpelunkTunnelRoute.Readable(problem?.Title)) is { } said ? $": {said}" : "."),
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>What a validation problem says about the sign-in key, if it says anything.</summary>
|
||||
/// <remarks>
|
||||
/// Matched on the end of the name and without regard to case, because a validator may name the field
|
||||
/// <c>publicKey</c>, <c>PublicKey</c> or <c>signIn.publicKey</c>, and all three mean this one.
|
||||
/// </remarks>
|
||||
private static string? PublicKeyError(SpelunkProblemDocument? problem) =>
|
||||
problem?.Errors?
|
||||
.FirstOrDefault(field => field.Key.EndsWith("publicKey", StringComparison.OrdinalIgnoreCase))
|
||||
.Value?
|
||||
.FirstOrDefault();
|
||||
|
||||
/// <summary>Reads an RFC 7807 body if there is one; null when there is not, or it will not parse.</summary>
|
||||
private static async Task<SpelunkProblemDocument?> ReadProblemAsync(
|
||||
HttpResponseMessage response,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
try
|
||||
{
|
||||
var body = await response.Content.ReadAsByteArrayAsync(cancellationToken).ConfigureAwait(false);
|
||||
|
||||
return body.Length is 0 or > MaxProblemBytes
|
||||
? null
|
||||
: JsonSerializer.Deserialize(body, SpelunkTunnelJsonContext.Default.SpelunkProblemDocument);
|
||||
}
|
||||
catch (JsonException)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Opens the tunnel socket, and translates a refused upgrade into its reason.</summary>
|
||||
/// <remarks>
|
||||
/// The status of a refused upgrade is collected, as the relay's dialler does. A 401 is a ticket Spelunk
|
||||
/// would not take — spent, or expired on the way — and asking again is the remedy; a 503 is the agent
|
||||
/// going away in the moment between the ticket and the socket.
|
||||
/// </remarks>
|
||||
private static async Task<WebSocket> DialAsync(
|
||||
Uri url,
|
||||
IReadOnlyList<string> protocols,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
var socket = new ClientWebSocket();
|
||||
|
||||
try
|
||||
{
|
||||
foreach (var protocol in protocols)
|
||||
{
|
||||
socket.Options.AddSubProtocol(protocol);
|
||||
}
|
||||
|
||||
socket.Options.CollectHttpResponseDetails = true;
|
||||
|
||||
await socket.ConnectAsync(url, cancellationToken).ConfigureAwait(false);
|
||||
}
|
||||
catch (WebSocketException exception)
|
||||
{
|
||||
var status = socket.HttpStatusCode;
|
||||
socket.Dispose();
|
||||
|
||||
throw new SpelunkTunnelException(
|
||||
status switch
|
||||
{
|
||||
HttpStatusCode.Unauthorized => "Spelunk refused the tunnel ticket. Try connecting again.",
|
||||
HttpStatusCode.ServiceUnavailable => Describe(status, problem: null),
|
||||
_ => $"The Spelunk tunnel could not be opened: {exception.Message}",
|
||||
},
|
||||
exception);
|
||||
}
|
||||
catch
|
||||
{
|
||||
socket.Dispose();
|
||||
throw;
|
||||
}
|
||||
|
||||
if (!string.Equals(socket.SubProtocol, SpelunkTunnelProtocol.SubProtocol, StringComparison.Ordinal))
|
||||
{
|
||||
socket.Abort();
|
||||
socket.Dispose();
|
||||
|
||||
throw new SpelunkTunnelException(
|
||||
"Spelunk answered the tunnel in a protocol this app does not speak. Update DodoSSH or Spelunk.");
|
||||
}
|
||||
|
||||
return socket;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>The body of a ticket request.</summary>
|
||||
/// <remarks>
|
||||
/// Either a port or a sign-in, never both: the one not asked for is null and left out of the JSON, so a plain
|
||||
/// tunnel still asks for exactly <c>{"port":22}</c>.
|
||||
/// </remarks>
|
||||
internal sealed class SpelunkTicketRequestDocument
|
||||
{
|
||||
public int? Port { get; set; }
|
||||
|
||||
public SpelunkSignInRequestDocument? SignIn { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>What a sign-in sends: the one-line OpenSSH public key the agent's SSH server is to accept.</summary>
|
||||
internal sealed class SpelunkSignInRequestDocument
|
||||
{
|
||||
public string? PublicKey { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>A ticket as Spelunk returns it. Nullable because it models untrusted input.</summary>
|
||||
internal sealed class SpelunkTicketDocument
|
||||
{
|
||||
public string? Ticket { get; set; }
|
||||
|
||||
public DateTimeOffset? ExpiresAt { get; set; }
|
||||
|
||||
public string? Path { get; set; }
|
||||
|
||||
public string? Subprotocol { get; set; }
|
||||
|
||||
/// <summary>The account a sign-in logs in as; absent or null for a plain tunnel.</summary>
|
||||
public string? User { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>The fields of an RFC 7807 problem this client repeats.</summary>
|
||||
internal sealed class SpelunkProblemDocument
|
||||
{
|
||||
public string? Title { get; set; }
|
||||
|
||||
public string? Detail { get; set; }
|
||||
|
||||
/// <summary>A validation problem's messages by field, as ASP.NET Core writes them.</summary>
|
||||
public Dictionary<string, string[]>? Errors { get; set; }
|
||||
}
|
||||
|
||||
[JsonSourceGenerationOptions(
|
||||
PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase,
|
||||
PropertyNameCaseInsensitive = true,
|
||||
DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
|
||||
UnmappedMemberHandling = JsonUnmappedMemberHandling.Skip)]
|
||||
[JsonSerializable(typeof(SpelunkTicketRequestDocument))]
|
||||
[JsonSerializable(typeof(SpelunkTicketDocument))]
|
||||
[JsonSerializable(typeof(SpelunkProblemDocument))]
|
||||
internal sealed partial class SpelunkTunnelJsonContext : JsonSerializerContext;
|
||||
@@ -145,6 +145,26 @@ public sealed class VaultKnownHostStore : IKnownHostStore
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <remarks>From the snapshot, like <see cref="FindAsync"/>, and for the same reason.</remarks>
|
||||
public ValueTask<IReadOnlyList<HostKeyPresentation>> FindForEndpointAsync(
|
||||
string host,
|
||||
int port,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
lock (gate)
|
||||
{
|
||||
IReadOnlyList<HostKeyPresentation> found = pins.Values
|
||||
.Where(pin =>
|
||||
KnownHostIdentity.Comparer.Equals(pin.Secret.Host, host) && pin.Secret.Port == port)
|
||||
.Select(pin => new HostKeyPresentation(
|
||||
pin.Secret.Host, pin.Secret.Port, pin.Secret.Algorithm, pin.Secret.Fingerprint))
|
||||
.ToArray();
|
||||
|
||||
return ValueTask.FromResult(found);
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <exception cref="InvalidOperationException">
|
||||
/// The vault is not open, so there is nowhere to record trust.
|
||||
|
||||
@@ -125,6 +125,7 @@ public sealed partial class VaultSession : IAsyncDisposable
|
||||
Tags = new TagRepository(Items, Outbox, keyring, activity);
|
||||
Snippets = new SnippetRepository(Items, Outbox, keyring, activity);
|
||||
ObjectStores = new ObjectStoreRepository(Items, Outbox, keyring, activity);
|
||||
SpelunkKeys = new SpelunkKeyRepository(Items, Outbox, keyring, activity);
|
||||
}
|
||||
|
||||
/// <summary>Who this session belongs to, and the material that unlocked it.</summary>
|
||||
@@ -200,6 +201,13 @@ public sealed partial class VaultSession : IAsyncDisposable
|
||||
/// </remarks>
|
||||
public ObjectStoreRepository ObjectStores { get; }
|
||||
|
||||
/// <summary>Spelunk API keys and the addresses they may be sent to, decrypted.</summary>
|
||||
/// <remarks>
|
||||
/// Read with the rest of the vault, and at connect from that list, as a credential's password is. The
|
||||
/// address in each is what lets a link from Spelunk connect without asking.
|
||||
/// </remarks>
|
||||
public SpelunkKeyRepository SpelunkKeys { get; }
|
||||
|
||||
/// <summary>The connections this vault has recorded, decrypted.</summary>
|
||||
/// <remarks>
|
||||
/// Written through <see cref="ConnectionRecorder"/> rather than directly by anything that connects. An
|
||||
|
||||
@@ -0,0 +1,85 @@
|
||||
namespace DodoSSH.Client.Shell.ViewModels;
|
||||
|
||||
/// <summary>
|
||||
/// What unlocking with this machine's device key is called here, and what it asks the person for.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// The words used to be Windows's everywhere: "USE WINDOWS HELLO" on a Mac, "Waiting for Windows…" over a
|
||||
/// Linux PIN prompt, and a settings row that told a MacBook it needed a TPM. Each desktop has its own device
|
||||
/// key store with its own gesture — see <c>WindowsDeviceKeyStore</c>, <c>MacDeviceKeyStore</c> and
|
||||
/// <c>LinuxDeviceKeyStore</c> — and a button has to name the one the person is about to be shown, or it reads
|
||||
/// as a feature for some other machine.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// One record rather than a property per sentence on the shell, so that the five places these words appear
|
||||
/// cannot disagree about which platform they are on.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
/// <param name="Name">What the feature is called, as a settings row's title.</param>
|
||||
/// <param name="Button">The unlock card's button, in the capitals every button here uses.</param>
|
||||
/// <param name="Wait">The status line while the platform's prompt is up.</param>
|
||||
/// <param name="Gesture">What opens the keychain instead of the passphrase, to finish a sentence.</param>
|
||||
/// <param name="Keeper">What holds the key, to finish "Registered · …".</param>
|
||||
/// <param name="Needs">What a machine with no device key store lacks, as a sentence of its own.</param>
|
||||
internal sealed record DeviceUnlockWording(
|
||||
string Name,
|
||||
string Button,
|
||||
string Wait,
|
||||
string Gesture,
|
||||
string Keeper,
|
||||
string Needs)
|
||||
{
|
||||
internal static DeviceUnlockWording Windows { get; } = new(
|
||||
"Windows Hello on this machine",
|
||||
"USE WINDOWS HELLO",
|
||||
"Waiting for Windows…",
|
||||
"a Windows confirmation",
|
||||
"the TPM holds a device key",
|
||||
"That needs a TPM and a Windows keystore willing to release the key.");
|
||||
|
||||
internal static DeviceUnlockWording Mac { get; } = new(
|
||||
"Touch ID on this Mac",
|
||||
"USE TOUCH ID",
|
||||
"Waiting for Touch ID…",
|
||||
"Touch ID or your login password",
|
||||
"the Secure Enclave holds a device key",
|
||||
"That needs a Mac with a Secure Enclave and a login password set.");
|
||||
|
||||
internal static DeviceUnlockWording Linux { get; } = new(
|
||||
"A device PIN on this machine",
|
||||
"USE DEVICE PIN",
|
||||
"Waiting for your PIN…",
|
||||
"a PIN the TPM checks",
|
||||
"the TPM holds a device key",
|
||||
"That needs a TPM 2.0 this account is allowed to use.");
|
||||
|
||||
internal static DeviceUnlockWording Android { get; } = new(
|
||||
"Fingerprint unlock on this phone",
|
||||
"USE FINGERPRINT",
|
||||
"Waiting for your fingerprint…",
|
||||
"your fingerprint",
|
||||
"the phone's keystore holds a device key",
|
||||
"That needs a screen lock and a keystore willing to release the key.");
|
||||
|
||||
/// <summary>The wording for the platform this process is running on.</summary>
|
||||
internal static DeviceUnlockWording ForThisPlatform { get; } =
|
||||
OperatingSystem.IsAndroid() ? Android
|
||||
: OperatingSystem.IsMacOS() ? Mac
|
||||
: OperatingSystem.IsLinux() ? Linux
|
||||
: Windows;
|
||||
|
||||
/// <summary>The settings caption for a machine that can register.</summary>
|
||||
internal string Offer =>
|
||||
$"Registers this machine so a later launch can open the keychain with {Gesture} instead of your passphrase. Your passphrase keeps working.";
|
||||
|
||||
/// <summary>The settings caption for a machine that has.</summary>
|
||||
internal string Registered => $"Registered · {Keeper} that can open the keychain with {Gesture}.";
|
||||
|
||||
/// <summary>The settings caption for a machine that cannot.</summary>
|
||||
internal string Unavailable =>
|
||||
$"This machine has nowhere to keep a device key, so the keychain will keep asking for your passphrase. {Needs}";
|
||||
|
||||
/// <summary>The unlock button's tooltip.</summary>
|
||||
internal string Tip => $"Opens the keychain with this machine's device key, after {Gesture}.";
|
||||
}
|
||||
@@ -566,7 +566,7 @@ internal sealed partial class HetznerImportViewModel(
|
||||
// and visible rather than harmless and confusing.
|
||||
Refresh(resetSelection: true);
|
||||
|
||||
Status = WhatWasStored(outcome.Hosts);
|
||||
Status = WhatWasStored(outcome.Hosts) + outcome.Caveats;
|
||||
|
||||
Step = HetznerImportStep.Done;
|
||||
}
|
||||
|
||||
@@ -22,10 +22,27 @@ namespace DodoSSH.Client.Shell.ViewModels;
|
||||
/// </param>
|
||||
internal sealed record ImportedHostRequest(HostSecret Host, SshKeySecret? Key, string? KeyPath);
|
||||
|
||||
/// <summary>What an import stored.</summary>
|
||||
/// <summary>What an import stored, and what it did not.</summary>
|
||||
/// <param name="Hosts">Hosts written.</param>
|
||||
/// <param name="Keys">Private keys written. Counts files read, not hosts bound to one.</param>
|
||||
internal sealed record ImportOutcome(int Hosts, int Keys);
|
||||
/// <param name="Refused">Hosts skipped because they would not validate — no hostname, a bad port.</param>
|
||||
/// <param name="Failure">Why the batch stopped before the end, or null if it did not.</param>
|
||||
/// <remarks>
|
||||
/// The last two are what the importing screen needs to not claim a success it did not have. The vault's own
|
||||
/// status line says these things too, but it is hidden in settings mode, which is where both importers live.
|
||||
/// </remarks>
|
||||
internal sealed record ImportOutcome(int Hosts, int Keys, int Refused = 0, string? Failure = null)
|
||||
{
|
||||
/// <summary>What to add after the screen's own sentence about what was stored.</summary>
|
||||
internal string Caveats =>
|
||||
(Refused switch
|
||||
{
|
||||
0 => string.Empty,
|
||||
1 => " 1 was skipped because it is not a host this keychain can connect to.",
|
||||
_ => $" {Refused} were skipped because they are not hosts this keychain can connect to.",
|
||||
})
|
||||
+ (Failure is { } failure ? $" The import stopped early: {failure}" : string.Empty);
|
||||
}
|
||||
|
||||
/// <summary>One host an <c>ssh_config</c> offered, as a row somebody decides about.</summary>
|
||||
/// <remarks>
|
||||
@@ -409,7 +426,7 @@ internal sealed partial class ImportViewModel(
|
||||
_ => $" {outcome.Keys} private keys came with them, and every host that named one is bound to it.",
|
||||
};
|
||||
|
||||
return $"Imported {outcome.Hosts} host(s). They are on the Hosts screen.{material}";
|
||||
return $"Imported {outcome.Hosts} host(s). They are on the Hosts screen.{material}{outcome.Caveats}";
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
|
||||
@@ -0,0 +1,61 @@
|
||||
using DodoSSH.Client.Session;
|
||||
|
||||
namespace DodoSSH.Client.Shell.ViewModels;
|
||||
|
||||
/// <summary>
|
||||
/// The shell's half of a link from Spelunk: holding it until there is a vault to act on it.
|
||||
/// </summary>
|
||||
internal sealed partial class MainWindowViewModel
|
||||
{
|
||||
/// <summary>
|
||||
/// Acts on a <c>dodossh://spelunk/connect</c> link now, or as soon as a vault is open.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Called by the head, on the UI thread, for a link this launch was started with, a link a second launch
|
||||
/// passed down the doorbell, or one the platform delivered to the running application. The link has
|
||||
/// already been checked by <see cref="SpelunkLink.TryParse"/>; what it may do is decided by
|
||||
/// <see cref="VaultViewModel.OpenSpelunkLinkAsync"/>, which never sends an API key to a Spelunk no saved
|
||||
/// host already sends it to.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>A locked application keeps it rather than dropping it.</b> Clicking a server in Spelunk and being
|
||||
/// asked for the passphrase is the ordinary first half of this; losing the click at the second half would
|
||||
/// make the button look broken. It is not kept across a restart.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal void OpenLink(SpelunkLink link)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(link);
|
||||
|
||||
pendingLink = link;
|
||||
|
||||
if (State is ShellState.Unlocked && Vault is not null)
|
||||
{
|
||||
DeliverPendingLink();
|
||||
return;
|
||||
}
|
||||
|
||||
if (State is ShellState.Locked)
|
||||
{
|
||||
StatusMessage = $"Unlock to open {link.Name} from Spelunk.";
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Hands a waiting link to the open vault, on the Hosts screen where its answer appears.</summary>
|
||||
private void DeliverPendingLink()
|
||||
{
|
||||
if (pendingLink is not { } link || Vault is not { } vault)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
pendingLink = null;
|
||||
|
||||
ShowScreen(ShellScreen.Hosts);
|
||||
|
||||
// Not awaited: a connect reports its own progress and failures on the vault's status line and in its
|
||||
// tab, as a tap on the row does, and this is called from places that must not wait on a handshake.
|
||||
_ = vault.OpenSpelunkLinkAsync(link);
|
||||
}
|
||||
}
|
||||
@@ -360,6 +360,25 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
/// </remarks>
|
||||
private readonly ISshReachabilityProbe? reachability;
|
||||
|
||||
/// <summary>What opens a Spelunk tunnel, handed to each vault this shell opens.</summary>
|
||||
/// <remarks>
|
||||
/// Held for the reason <see cref="reachability"/> is: the vault is built on unlock, not here. Null means
|
||||
/// the real one, which is what both heads use; a test passes one so a Spelunk host's connect never leaves
|
||||
/// the process.
|
||||
/// </remarks>
|
||||
private readonly ISpelunkTunnel? spelunk;
|
||||
|
||||
/// <summary>
|
||||
/// A <c>dodossh://spelunk/connect</c> link that arrived while there was no open vault to act on it.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// One, and the latest: a link is somebody pressing a button in Spelunk, and a second press while this
|
||||
/// machine is still locked means the second server, not both. Delivered as soon as a vault opens, and
|
||||
/// dropped if the application closes first — it is a request to do something now, not something to
|
||||
/// remember.
|
||||
/// </remarks>
|
||||
private SpelunkLink? pendingLink;
|
||||
|
||||
/// <inheritdoc cref="MainWindowViewModel(ClientPaths, ClientCacheFactory, TerminalWorkspace, VaultKnownHostStore, IDeviceKeyStore, SignInHandler, TimeProvider, ISftpSessionFactory, Argon2Profile?, ResumeHandler?, Func{string, Task}?, string?, IUpdateChannel?, Action{Action}?)" path="/param[@name='post']" />
|
||||
private readonly Action<Action> post;
|
||||
|
||||
@@ -569,9 +588,11 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
Action<Action>? post = null,
|
||||
Func<string, Task>? openInEditor = null,
|
||||
Func<string, Action, IDisposable>? watchFile = null,
|
||||
ISshReachabilityProbe? reachability = null)
|
||||
ISshReachabilityProbe? reachability = null,
|
||||
ISpelunkTunnel? spelunk = null)
|
||||
{
|
||||
this.reachability = reachability;
|
||||
this.spelunk = spelunk;
|
||||
this.post = post ?? (action => Dispatcher.UIThread.Post(action));
|
||||
|
||||
this.paths = paths;
|
||||
@@ -1220,6 +1241,18 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
/// </remarks>
|
||||
internal event EventHandler? TerminalSessionOpened;
|
||||
|
||||
/// <summary>
|
||||
/// Raised when any tab's forward starts, stops or fails, so a head can re-count what is listening.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The phone's keep-alive notification is the one listener: it says how many forwards are listening
|
||||
/// alongside how many shells are connected. On the UI thread, since every state change is.
|
||||
/// </remarks>
|
||||
internal event EventHandler? ForwardsChanged;
|
||||
|
||||
/// <summary>How many forwards are listening, across every tab.</summary>
|
||||
internal int ListeningForwardCount => Tabs.Sum(tab => tab.ListeningForwardCount);
|
||||
|
||||
/// <summary>
|
||||
/// Raised when something this shell did belongs in the terminal the user is already looking at, so the
|
||||
/// view can put the keyboard back there.
|
||||
@@ -1466,6 +1499,7 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
internal bool IsTerminalShowing =>
|
||||
IsTerminalSurface
|
||||
&& !IsConnectSheetOpen
|
||||
&& !IsForwardsSheetOpen
|
||||
&& !IsHostKeyDecisionShowing
|
||||
&& SelectedTab is { HasSession: true };
|
||||
|
||||
@@ -1761,6 +1795,10 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
ActiveSettingsPage = null;
|
||||
IsImportOpen = false;
|
||||
IsHetznerImportOpen = false;
|
||||
|
||||
// Drawn over Settings → Vaults. Left open, it was still up the next time Settings opened, over
|
||||
// whichever page that was.
|
||||
vaults.IsMembersPanelOpen = false;
|
||||
Screen = settingsReturnScreen;
|
||||
Surface = settingsReturnSurface;
|
||||
}
|
||||
@@ -2211,6 +2249,45 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
[RelayCommand]
|
||||
private void CloseConnectSheet() => IsConnectSheetOpen = false;
|
||||
|
||||
// ---- The phone's forwards sheet ----
|
||||
|
||||
/// <summary>
|
||||
/// Whether the phone's list of the selected tab's forwards is open over the terminal.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// The phone's answer to the desktop sidebar's FORWARDS section, over the same rows —
|
||||
/// <see cref="TerminalTabViewModel.Forwards"/> — with the same state word, reason and switch. A sheet
|
||||
/// rather than something always drawn because a phone gives a shell the whole screen, so it is raised
|
||||
/// from a button in the terminal's bar, which draws only for a tab that has forwards and turns the danger
|
||||
/// colour when one of them failed.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Shell state for the reason <see cref="IsConnectSheetOpen"/> is: it collapses the renderer, which is a
|
||||
/// native view nothing can be drawn over. Lowered with the connect sheet whenever the terminal surface is
|
||||
/// left — see <see cref="OnSurfaceChanged"/>.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
[ObservableProperty]
|
||||
private bool isForwardsSheetOpen;
|
||||
|
||||
/// <summary>Raises the forwards sheet over the terminal.</summary>
|
||||
/// <remarks>Gated as <see cref="OpenConnectSheet"/> is, and on there being a tab to list.</remarks>
|
||||
[RelayCommand]
|
||||
private void OpenForwardsSheet()
|
||||
{
|
||||
if (!IsTerminalSurface || SelectedTab is null)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
IsForwardsSheetOpen = true;
|
||||
}
|
||||
|
||||
/// <summary>Lowers the forwards sheet, leaving the terminal where it was.</summary>
|
||||
[RelayCommand]
|
||||
private void CloseForwardsSheet() => IsForwardsSheetOpen = false;
|
||||
|
||||
// ---- Open terminals ----
|
||||
|
||||
/// <summary>
|
||||
@@ -2742,8 +2819,10 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
/// Naming the wrong operating system here is not cosmetic — it is the sentence a user reads while
|
||||
/// deciding whether the prompt in front of them is the one this application asked for.
|
||||
/// </remarks>
|
||||
private static string GestureWait =>
|
||||
OperatingSystem.IsAndroid() ? "Waiting for your fingerprint…" : "Waiting for Windows…";
|
||||
private static string GestureWait => DeviceUnlockWording.ForThisPlatform.Wait;
|
||||
|
||||
/// <summary>What unlocking with the device key is called on this platform; the views read it whole.</summary>
|
||||
internal DeviceUnlockWording DeviceUnlock { get; } = DeviceUnlockWording.ForThisPlatform;
|
||||
|
||||
/// <summary>Opens the vault with this machine's device key instead of the passphrase.</summary>
|
||||
/// <remarks>
|
||||
@@ -2886,7 +2965,8 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
copyToClipboard,
|
||||
connectionLog,
|
||||
visibility,
|
||||
reachability);
|
||||
reachability,
|
||||
spelunk);
|
||||
State = ShellState.Unlocked;
|
||||
|
||||
// Offered only where it can actually be honoured: a machine that can keep a key, and a profile that
|
||||
@@ -2902,19 +2982,7 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
|
||||
await Vault.LoadAsync(cancellationToken).ConfigureAwait(true);
|
||||
|
||||
// After the load, because the switches are built from the vaults the session admitted and the
|
||||
// keyring is filled during it — before, and a machine with a team vault would come up with one
|
||||
// switch until something else rebuilt them.
|
||||
RebuildVaultToggles();
|
||||
|
||||
// After the load, because what the transfers screen takes from the vault is the host list and an
|
||||
// empty one would leave its picker blank until the next unlock.
|
||||
transfers.Attach(Vault, knownHosts, connectionLog, new S3ObjectStoreFactory());
|
||||
|
||||
// After the list exists, and it matters after a lock rather than after the first unlock: shells kept
|
||||
// running while the vault was closed, so some of these hosts are connected before their rows are a
|
||||
// second old.
|
||||
RefreshConnectedHosts();
|
||||
AfterTheFirstLoad(Vault);
|
||||
|
||||
// After the first load, so the list is on screen before anything talks to a server. The loop is
|
||||
// started from the UI thread deliberately: every pass resumes here, which is what keeps the
|
||||
@@ -2932,6 +3000,32 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
Vault.StartAutoSync();
|
||||
}
|
||||
|
||||
/// <summary>Everything an unlock does that needs the vault's lists to have been read.</summary>
|
||||
/// <remarks>
|
||||
/// Split out of <see cref="AdoptAsync"/> for length rather than for reuse; the order is still the one that
|
||||
/// method's remarks call load-bearing, and it is kept here as it was there.
|
||||
/// </remarks>
|
||||
private void AfterTheFirstLoad(VaultViewModel vault)
|
||||
{
|
||||
// After the load, because the switches are built from the vaults the session admitted and the
|
||||
// keyring is filled during it — before, and a machine with a team vault would come up with one
|
||||
// switch until something else rebuilt them.
|
||||
RebuildVaultToggles();
|
||||
|
||||
// After the load, because what the transfers screen takes from the vault is the host list and an
|
||||
// empty one would leave its picker blank until the next unlock.
|
||||
transfers.Attach(vault, knownHosts, connectionLog, new S3ObjectStoreFactory());
|
||||
|
||||
// After the list exists, and it matters after a lock rather than after the first unlock: shells kept
|
||||
// running while the vault was closed, so some of these hosts are connected before their rows are a
|
||||
// second old.
|
||||
RefreshConnectedHosts();
|
||||
|
||||
// After the hosts are loaded, because what a link does depends on whether one of them is already
|
||||
// the server it names.
|
||||
DeliverPendingLink();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Points the two process-lifetime stores at the session that has just opened.
|
||||
/// </summary>
|
||||
@@ -3832,11 +3926,13 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
IdentityLabel = e.IdentityLabel,
|
||||
};
|
||||
AdoptTab(adopted);
|
||||
StartForwards(adopted, e);
|
||||
RefreshConnectedHosts();
|
||||
return;
|
||||
}
|
||||
|
||||
tab.Opened(e.SessionId);
|
||||
StartForwards(tab, e);
|
||||
|
||||
// From this moment, not from when the tab first appeared — connecting is not open, and the session
|
||||
// shell's elapsed timer is about a shell that is actually running.
|
||||
@@ -3858,6 +3954,54 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
TerminalSessionOpened?.Invoke(this, EventArgs.Empty);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Puts the host's saved forwards on a tab whose session has just opened, and starts every one.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// All at once and none awaited: each row reports its own outcome, and the terminal is already usable
|
||||
/// while a remote forward waits for the server to answer. See <see cref="PortForwardViewModel"/> for why
|
||||
/// one failing stops nothing else.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// The session id is captured into the start delegate rather than read off the tab when a row is
|
||||
/// toggled later. A reconnect puts a new id on the same tab, and a row from the old session that reached
|
||||
/// for the tab's current id would start its listener on a connection it was never part of.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// ◆ <b>On the phone too.</b> This used to return early on Android, because that head had nowhere to show
|
||||
/// what was listening. Its terminal bar now carries a FORWARDS button over the same rows the desktop's
|
||||
/// sidebar lists — see <see cref="IsForwardsSheetOpen"/> — so both heads start the same forwards.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private void StartForwards(TerminalTabViewModel tab, TerminalSessionEventArgs e)
|
||||
{
|
||||
var sessionId = e.SessionId;
|
||||
|
||||
tab.ReplaceForwards(e.Forwards.Select(rule => new PortForwardViewModel(
|
||||
rule,
|
||||
(spec, cancellationToken) => workspace.StartForwardAsync(sessionId, spec, cancellationToken),
|
||||
post)));
|
||||
|
||||
foreach (var forward in tab.Forwards)
|
||||
{
|
||||
// Never unsubscribed, and it need not be: the row holds the handler, not the other way round, so a
|
||||
// row replaced by a reconnect is collected with it — after its last change, to Stopped, is heard.
|
||||
forward.PropertyChanged += OnForwardChanged;
|
||||
_ = forward.StartAsync();
|
||||
}
|
||||
|
||||
ForwardsChanged?.Invoke(this, EventArgs.Empty);
|
||||
}
|
||||
|
||||
private void OnForwardChanged(object? sender, PropertyChangedEventArgs e)
|
||||
{
|
||||
if (e.PropertyName is nameof(PortForwardViewModel.State))
|
||||
{
|
||||
ForwardsChanged?.Invoke(this, EventArgs.Empty);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Answers a connection that did not become a session.
|
||||
/// </summary>
|
||||
@@ -4374,7 +4518,7 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
{
|
||||
if (Tabs.FirstOrDefault(tab => tab.SessionId == e.SessionId) is { } tab)
|
||||
{
|
||||
tab.Ended(e.Outcome.End, e.Outcome.Description);
|
||||
tab.Ended(e.Outcome.End, e.Outcome.Description, clock.GetUtcNow());
|
||||
|
||||
// Only for the tab being looked at, which is what these three already ask. The rectangle does not
|
||||
// change — a dead tab keeps its pane and its scrollback — but the status bar under it does, and
|
||||
@@ -4658,6 +4802,17 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
vault.EditSelectedHostCommand.Execute(null);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The sidebar's FORWARDS affordance: opens the active tab's host for editing, where forwards are added.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The same route <see cref="PinFolderFromSidebar"/> takes, because a forward is saved on the host for
|
||||
/// the same reason a pin is. A forward added there starts with the next session to the host, not this
|
||||
/// one — the editor says so — since this session's forwards were started from the host as it was.
|
||||
/// </remarks>
|
||||
[RelayCommand]
|
||||
private void AddForwardFromSidebar() => PinFolderFromSidebar();
|
||||
|
||||
/// <summary>
|
||||
/// The SFTP tab row's click: makes one of the terminal's tabs the SFTP surface's browsed host.
|
||||
/// </summary>
|
||||
@@ -4843,7 +4998,12 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
return null;
|
||||
}
|
||||
|
||||
var elapsed = clock.GetUtcNow() - started;
|
||||
// Up to the end, for a shell that has one: how long it ran, not how long ago it started.
|
||||
var until = Surface is ShellSurface.Terminal && SelectedTab?.EndedAt is { } ended
|
||||
? ended
|
||||
: clock.GetUtcNow();
|
||||
|
||||
var elapsed = until - started;
|
||||
|
||||
if (elapsed < TimeSpan.Zero)
|
||||
{
|
||||
@@ -4958,6 +5118,14 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
Screen = ShellScreen.Hosts;
|
||||
Surface = ShellSurface.Page;
|
||||
}
|
||||
else
|
||||
{
|
||||
// Settings is a mode of the unlocked window, and it brings its own title bar while the main one
|
||||
// is hidden. Locking or signing out from it — LOCK NOW is on Preferences, sign-out on Account —
|
||||
// left the window in settings mode under the lock card: no title bar, so nothing to drag, minimise
|
||||
// or close, and an unlock that came back to Settings rather than to Hosts.
|
||||
LeaveSettings();
|
||||
}
|
||||
}
|
||||
|
||||
/// <remarks>
|
||||
@@ -5133,6 +5301,7 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
if (value is not ShellSurface.Terminal)
|
||||
{
|
||||
IsConnectSheetOpen = false;
|
||||
IsForwardsSheetOpen = false;
|
||||
}
|
||||
|
||||
RaiseSurfaceState();
|
||||
@@ -5317,6 +5486,9 @@ internal sealed partial class MainWindowViewModel : ObservableObject, IAsyncDisp
|
||||
/// <inheritdoc cref="OnIsSearchingChanged" />
|
||||
partial void OnIsConnectSheetOpenChanged(bool value) => RaiseTerminalState();
|
||||
|
||||
/// <inheritdoc cref="OnIsSearchingChanged" />
|
||||
partial void OnIsForwardsSheetOpenChanged(bool value) => RaiseTerminalState();
|
||||
|
||||
/// <remarks>
|
||||
/// The unlock card and the confirmation swap, so arming one has to hide the other — see
|
||||
/// <see cref="IsAskingForThePassphrase"/>.
|
||||
|
||||
@@ -0,0 +1,249 @@
|
||||
using System.Globalization;
|
||||
using CommunityToolkit.Mvvm.ComponentModel;
|
||||
using CommunityToolkit.Mvvm.Input;
|
||||
using DodoSSH.Client.Domain;
|
||||
using DodoSSH.Client.Ssh;
|
||||
|
||||
namespace DodoSSH.Client.Shell.ViewModels;
|
||||
|
||||
/// <summary>Where one of a tab's forwards has got to.</summary>
|
||||
internal enum PortForwardState
|
||||
{
|
||||
/// <summary>Not listening: switched off, or its session is over.</summary>
|
||||
Stopped = 0,
|
||||
|
||||
/// <summary>Asked for and not answered yet. A remote forward waits on the server.</summary>
|
||||
Starting = 1,
|
||||
|
||||
/// <summary>Listening.</summary>
|
||||
Listening = 2,
|
||||
|
||||
/// <summary>Could not be started; <see cref="PortForwardViewModel.Detail"/> says why.</summary>
|
||||
Failed = 3,
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// One of a host's saved forwards, as it runs on one terminal tab.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Built fresh for each session the tab holds, and started with it: the rule is the host's, the listener is
|
||||
/// this session's. A reconnect is a new session, so it gets new rows — see
|
||||
/// <see cref="TerminalTabViewModel.ReplaceForwards"/> — rather than trying to carry a listener across a
|
||||
/// connection that no longer exists.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>One failing does not stop the others, or the terminal.</b> The commonest failure is a port already in
|
||||
/// use — very often by a second tab to the same host, which is running the same forwards — and a shell that
|
||||
/// would not open because of it would be the forward taking the session hostage. The row says why instead.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal sealed partial class PortForwardViewModel : ObservableObject
|
||||
{
|
||||
private readonly Func<SshPortForwardSpec, CancellationToken, Task<ISshPortForward>> start;
|
||||
private readonly Action<Action> post;
|
||||
|
||||
private ISshPortForward? forward;
|
||||
private bool sessionOver;
|
||||
|
||||
/// <summary>The detail line: why it failed, or what last went wrong through it.</summary>
|
||||
[ObservableProperty]
|
||||
private string? detail;
|
||||
|
||||
[ObservableProperty]
|
||||
[NotifyPropertyChangedFor(nameof(IsListening))]
|
||||
[NotifyPropertyChangedFor(nameof(IsFailed))]
|
||||
[NotifyPropertyChangedFor(nameof(CanToggle))]
|
||||
[NotifyPropertyChangedFor(nameof(StateText))]
|
||||
[NotifyCanExecuteChangedFor(nameof(ToggleCommand))]
|
||||
private PortForwardState state;
|
||||
|
||||
/// <param name="rule">The host's saved forward.</param>
|
||||
/// <param name="start">Starts a forward on this tab's session; see <c>TerminalWorkspace.StartForwardAsync</c>.</param>
|
||||
/// <param name="post">Runs an action on the UI thread, for reports SSH.NET raises on its own.</param>
|
||||
internal PortForwardViewModel(
|
||||
PortForwardRule rule,
|
||||
Func<SshPortForwardSpec, CancellationToken, Task<ISshPortForward>> start,
|
||||
Action<Action> post)
|
||||
{
|
||||
Rule = rule;
|
||||
this.start = start;
|
||||
this.post = post;
|
||||
}
|
||||
|
||||
/// <summary>The saved forward this row runs.</summary>
|
||||
internal PortForwardRule Rule { get; }
|
||||
|
||||
/// <summary>The forward in OpenSSH's notation, e.g. <c>-L 5432:db.internal:5432</c>.</summary>
|
||||
internal string Notation => Rule.Notation;
|
||||
|
||||
/// <summary>What the forward connects to what, in words rather than flags.</summary>
|
||||
/// <remarks>
|
||||
/// Which end each port is on is the thing people get backwards about <c>-L</c> and <c>-R</c>, so it is
|
||||
/// written out: "this machine" and "the remote" rather than an arrow whose direction has to be learned.
|
||||
/// </remarks>
|
||||
internal string Route => Rule.Kind switch
|
||||
{
|
||||
PortForwardKind.Local =>
|
||||
$"localhost:{Port(Rule.BindPort)} here → {Rule.TargetHost}:{Port(Rule.TargetPort)} from the remote",
|
||||
PortForwardKind.Remote =>
|
||||
$"localhost:{Port(Rule.BindPort)} on the remote → {Rule.TargetHost}:{Port(Rule.TargetPort)} from here",
|
||||
_ => $"SOCKS proxy on localhost:{Port(Rule.BindPort)}, out through the remote",
|
||||
};
|
||||
|
||||
/// <summary>Whether it is listening now.</summary>
|
||||
internal bool IsListening => State is PortForwardState.Listening;
|
||||
|
||||
/// <summary>Whether it could not be started.</summary>
|
||||
internal bool IsFailed => State is PortForwardState.Failed;
|
||||
|
||||
/// <summary>
|
||||
/// Whether the switch does anything: not while a start is in flight, and never once the session is over.
|
||||
/// </summary>
|
||||
internal bool CanToggle => !sessionOver && State is not PortForwardState.Starting;
|
||||
|
||||
/// <summary>The state in the status bar's own lettering.</summary>
|
||||
internal string StateText => State switch
|
||||
{
|
||||
PortForwardState.Starting => "STARTING",
|
||||
PortForwardState.Listening => "LISTENING",
|
||||
PortForwardState.Failed => "FAILED",
|
||||
_ => "OFF",
|
||||
};
|
||||
|
||||
/// <summary>Starts the forward, unless it is already running or its session has ended.</summary>
|
||||
/// <remarks>
|
||||
/// Never throws. It is started without anyone waiting on it — every forward on a tab at once, as the
|
||||
/// tab opens — so a failure has nowhere to go but this row.
|
||||
/// </remarks>
|
||||
internal async Task StartAsync()
|
||||
{
|
||||
if (sessionOver || State is PortForwardState.Starting or PortForwardState.Listening)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
State = PortForwardState.Starting;
|
||||
Detail = null;
|
||||
|
||||
ISshPortForward started;
|
||||
|
||||
try
|
||||
{
|
||||
started = await start(ToSpec(Rule), CancellationToken.None).ConfigureAwait(true);
|
||||
}
|
||||
catch (Exception exception) when (exception is not OutOfMemoryException)
|
||||
{
|
||||
// Unless the session ended while this was in flight, in which case that is the true story and
|
||||
// SessionEnded has already told it.
|
||||
if (!sessionOver)
|
||||
{
|
||||
Detail = exception.Message;
|
||||
State = PortForwardState.Failed;
|
||||
}
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
if (sessionOver)
|
||||
{
|
||||
// The session ended while the server was answering. Its connection has gone and taken the
|
||||
// listener with it; this only lets go of the handle.
|
||||
await started.DisposeAsync().ConfigureAwait(true);
|
||||
return;
|
||||
}
|
||||
|
||||
forward = started;
|
||||
started.ErrorOccurred += OnForwardError;
|
||||
State = PortForwardState.Listening;
|
||||
}
|
||||
|
||||
/// <summary>Stops the forward and leaves the row switched off.</summary>
|
||||
internal async Task StopAsync()
|
||||
{
|
||||
await ReleaseAsync().ConfigureAwait(true);
|
||||
|
||||
if (!sessionOver)
|
||||
{
|
||||
State = PortForwardState.Stopped;
|
||||
Detail = null;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Records that the session this forward ran over has ended, which stopped the forward with it.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// A failed row keeps its reason: that the session later ended does not make it any less true that the
|
||||
/// port was taken. Anything else is off, and says it went with the session rather than being switched
|
||||
/// off, which is the difference between "I did that" and "that happened".
|
||||
/// </remarks>
|
||||
internal void SessionEnded()
|
||||
{
|
||||
if (sessionOver)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
sessionOver = true;
|
||||
_ = ReleaseAsync();
|
||||
|
||||
if (State is not PortForwardState.Failed)
|
||||
{
|
||||
State = PortForwardState.Stopped;
|
||||
Detail = "Stopped with the session.";
|
||||
}
|
||||
|
||||
OnPropertyChanged(nameof(CanToggle));
|
||||
ToggleCommand.NotifyCanExecuteChanged();
|
||||
}
|
||||
|
||||
/// <summary>The SSH layer's spec for a saved rule; the two enums share their numbering on purpose.</summary>
|
||||
internal static SshPortForwardSpec ToSpec(PortForwardRule rule) => rule.Kind switch
|
||||
{
|
||||
PortForwardKind.Local => new SshPortForwardSpec(
|
||||
SshPortForwardKind.Local, rule.BindPort, rule.TargetHost, rule.TargetPort ?? 0),
|
||||
PortForwardKind.Remote => new SshPortForwardSpec(
|
||||
SshPortForwardKind.Remote, rule.BindPort, rule.TargetHost, rule.TargetPort ?? 0),
|
||||
_ => new SshPortForwardSpec(SshPortForwardKind.Dynamic, rule.BindPort),
|
||||
};
|
||||
|
||||
/// <remarks>A failed row's switch is a retry: the port may have been freed since.</remarks>
|
||||
[RelayCommand(CanExecute = nameof(CanToggle))]
|
||||
private Task ToggleAsync() => IsListening ? StopAsync() : StartAsync();
|
||||
|
||||
private async Task ReleaseAsync()
|
||||
{
|
||||
if (forward is not { } running)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
forward = null;
|
||||
running.ErrorOccurred -= OnForwardError;
|
||||
|
||||
try
|
||||
{
|
||||
await running.DisposeAsync().ConfigureAwait(true);
|
||||
}
|
||||
catch (Exception exception) when (exception is not OutOfMemoryException)
|
||||
{
|
||||
// Stopping a listener has no failure anybody could act on; the connection closing would have
|
||||
// stopped it regardless.
|
||||
}
|
||||
}
|
||||
|
||||
/// <remarks>
|
||||
/// A connection through the forward failed — usually the target refusing it. The listener is still up,
|
||||
/// so the row stays LISTENING and says what happened underneath.
|
||||
/// </remarks>
|
||||
private void OnForwardError(object? sender, SshPortForwardErrorEventArgs e) => post(() =>
|
||||
{
|
||||
if (State is PortForwardState.Listening)
|
||||
{
|
||||
Detail = e.Message;
|
||||
}
|
||||
});
|
||||
|
||||
private static string Port(int? port) => port?.ToString(CultureInfo.InvariantCulture) ?? "?";
|
||||
}
|
||||
@@ -1,3 +1,6 @@
|
||||
using System.Collections.ObjectModel;
|
||||
using System.ComponentModel;
|
||||
using System.Globalization;
|
||||
using CommunityToolkit.Mvvm.ComponentModel;
|
||||
using DodoSSH.Client.Ssh;
|
||||
|
||||
@@ -271,6 +274,15 @@ internal sealed partial class TerminalTabViewModel : ObservableObject
|
||||
/// </remarks>
|
||||
internal DateTimeOffset? StartedAt { get; set; }
|
||||
|
||||
/// <summary>When the session behind this tab ended, or null while it has not.</summary>
|
||||
/// <remarks>
|
||||
/// What stops the status bar's timer. It used to go on counting from <see cref="StartedAt"/> to now over a
|
||||
/// shell that had exited an hour earlier, which made "how long that shell ran" — the fact the remark above
|
||||
/// keeps <see cref="StartedAt"/> for — the one thing it no longer said. Stamped by <see cref="Ended"/> from
|
||||
/// the shell's clock, and cleared whenever a new session takes the tab.
|
||||
/// </remarks>
|
||||
internal DateTimeOffset? EndedAt { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// The negotiated server-to-client cipher, for the status bar — or null while there is no session.
|
||||
/// </summary>
|
||||
@@ -326,6 +338,90 @@ internal sealed partial class TerminalTabViewModel : ObservableObject
|
||||
/// <summary>How many steps there are, for the card's track.</summary>
|
||||
internal int StepCount => Steps.Count;
|
||||
|
||||
/// <summary>
|
||||
/// The host's saved forwards, as they run over this tab's current session.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Replaced whole each time a session opens here — see <see cref="ReplaceForwards"/> — and emptied of
|
||||
/// meaning, though not of rows, when it ends: a row that says it stopped with the session is more use
|
||||
/// than one that silently disappeared.
|
||||
/// </remarks>
|
||||
internal ObservableCollection<PortForwardViewModel> Forwards { get; } = [];
|
||||
|
||||
/// <summary>How many of <see cref="Forwards"/> are listening now.</summary>
|
||||
internal int ListeningForwardCount => Forwards.Count(forward => forward.IsListening);
|
||||
|
||||
/// <summary>Whether any of <see cref="Forwards"/> is listening now.</summary>
|
||||
internal bool HasListeningForward => ListeningForwardCount > 0;
|
||||
|
||||
/// <summary>Whether this tab carries any forwards at all, running or not.</summary>
|
||||
/// <remarks>The phone's terminal bar draws its FORWARDS button only for a tab that has some.</remarks>
|
||||
internal bool HasForwards => Forwards.Count > 0;
|
||||
|
||||
/// <summary>Whether any of <see cref="Forwards"/> could not be started.</summary>
|
||||
/// <remarks>
|
||||
/// The phone's list is a sheet, not a sidebar that is always drawn, so a refusal there would be invisible
|
||||
/// until somebody happened to open it. This is what lets the button that opens it say so first.
|
||||
/// </remarks>
|
||||
internal bool HasFailedForward => Forwards.Any(forward => forward.IsFailed);
|
||||
|
||||
/// <summary>
|
||||
/// The status bar's forward count, or null when nothing is listening and there is nothing to say.
|
||||
/// </summary>
|
||||
internal string? ForwardsSummary => ListeningForwardCount switch
|
||||
{
|
||||
0 => null,
|
||||
1 => "⇄ 1 FORWARD",
|
||||
var count => string.Create(CultureInfo.InvariantCulture, $"⇄ {count} FORWARDS"),
|
||||
};
|
||||
|
||||
/// <summary>Puts a new session's forwards on this tab, ending whatever the last session left.</summary>
|
||||
internal void ReplaceForwards(IEnumerable<PortForwardViewModel> forwards)
|
||||
{
|
||||
EndForwards();
|
||||
|
||||
foreach (var forward in Forwards)
|
||||
{
|
||||
forward.PropertyChanged -= OnForwardChanged;
|
||||
}
|
||||
|
||||
Forwards.Clear();
|
||||
|
||||
foreach (var forward in forwards)
|
||||
{
|
||||
forward.PropertyChanged += OnForwardChanged;
|
||||
Forwards.Add(forward);
|
||||
}
|
||||
|
||||
RaiseForwardCount();
|
||||
}
|
||||
|
||||
/// <summary>Tells every forward its session is over; SSH.NET has already stopped the listeners.</summary>
|
||||
private void EndForwards()
|
||||
{
|
||||
foreach (var forward in Forwards)
|
||||
{
|
||||
forward.SessionEnded();
|
||||
}
|
||||
}
|
||||
|
||||
private void OnForwardChanged(object? sender, PropertyChangedEventArgs e)
|
||||
{
|
||||
if (e.PropertyName is nameof(PortForwardViewModel.State))
|
||||
{
|
||||
RaiseForwardCount();
|
||||
}
|
||||
}
|
||||
|
||||
private void RaiseForwardCount()
|
||||
{
|
||||
OnPropertyChanged(nameof(ListeningForwardCount));
|
||||
OnPropertyChanged(nameof(ForwardsSummary));
|
||||
OnPropertyChanged(nameof(HasListeningForward));
|
||||
OnPropertyChanged(nameof(HasForwards));
|
||||
OnPropertyChanged(nameof(HasFailedForward));
|
||||
}
|
||||
|
||||
/// <inheritdoc cref="TerminalTabState" />
|
||||
[ObservableProperty]
|
||||
private TerminalTabState state;
|
||||
@@ -533,6 +629,7 @@ internal sealed partial class TerminalTabViewModel : ObservableObject
|
||||
// stale-fact failure this pair exists to remove.
|
||||
EndReason = null;
|
||||
EndDescription = null;
|
||||
EndedAt = null;
|
||||
|
||||
IsLive = true;
|
||||
State = TerminalTabState.Open;
|
||||
@@ -592,17 +689,20 @@ internal sealed partial class TerminalTabViewModel : ObservableObject
|
||||
/// live attempt dead. <see cref="Advance"/> guards its own reports for the same reason.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal void Ended(SshSessionEnd end, string description)
|
||||
internal void Ended(SshSessionEnd end, string description, DateTimeOffset at)
|
||||
{
|
||||
if (State is not TerminalTabState.Open)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
EndedAt ??= at;
|
||||
EndReason = end;
|
||||
EndDescription = description;
|
||||
IsLive = false;
|
||||
|
||||
EndForwards();
|
||||
|
||||
OnPropertyChanged(nameof(EndedDetail));
|
||||
OnPropertyChanged(nameof(EndedSummary));
|
||||
OnPropertyChanged(nameof(EndDescription));
|
||||
@@ -638,9 +738,13 @@ internal sealed partial class TerminalTabViewModel : ObservableObject
|
||||
EndDescription = null;
|
||||
IsLive = false;
|
||||
|
||||
// The old session is being closed for its pane's sake, and its forwards go with its connection.
|
||||
EndForwards();
|
||||
|
||||
// Cleared with the session they were facts about. Keeping them would put the previous connection's
|
||||
// cipher in the status bar beside a handshake that has not negotiated one yet.
|
||||
StartedAt = null;
|
||||
EndedAt = null;
|
||||
Cipher = null;
|
||||
HostKeyAlgorithm = null;
|
||||
IdentityLabel = null;
|
||||
|
||||
@@ -879,6 +879,23 @@ internal sealed partial class TransfersViewModel : ObservableObject, IAsyncDispo
|
||||
[ObservableProperty]
|
||||
private ObjectStoreRowViewModel? selectedBucket;
|
||||
|
||||
/// <summary>The host and bucket somebody chose, as opposed to whatever the pickers show this instant.</summary>
|
||||
/// <remarks>
|
||||
/// <see cref="RefreshHosts"/> re-finds the selection by id, and it runs on every change to the vault's
|
||||
/// lists — including the <c>Clear()</c> a reload starts with, at which point there is nothing to re-find
|
||||
/// and the picker's own selection becomes null. Re-finding from that null on the next <c>Add</c> moved the
|
||||
/// picker to the first host on every sync pass, a minute after somebody chose another one, and CONNECT then
|
||||
/// dialled the first host with the password typed for theirs. So the choice is remembered here, written
|
||||
/// only when a person changes the picker, and is what every refresh looks for.
|
||||
/// </remarks>
|
||||
private Guid? chosenHost;
|
||||
|
||||
/// <inheritdoc cref="chosenHost" path="/remarks" />
|
||||
private Guid? chosenBucket;
|
||||
|
||||
/// <summary>Whether a selection change is <see cref="RefreshHosts"/> putting things back, not a choice.</summary>
|
||||
private bool refreshingPickers;
|
||||
|
||||
/// <summary>
|
||||
/// Whether there is a bucket to open at all.
|
||||
/// </summary>
|
||||
@@ -969,6 +986,17 @@ internal sealed partial class TransfersViewModel : ObservableObject, IAsyncDispo
|
||||
[ObservableProperty]
|
||||
private string typedPassword = string.Empty;
|
||||
|
||||
/// <summary>The host showing when <see cref="TypedPassword"/> was typed, which is the only one it is for.</summary>
|
||||
/// <remarks>
|
||||
/// The picker can move without anybody touching it — a host deleted elsewhere falls back to the first —
|
||||
/// and the box does not empty when it does, because it cannot tell that from a reload refilling the list.
|
||||
/// So the password is checked against this at the moment it would be sent instead, and never goes to a
|
||||
/// host it was not typed for.
|
||||
/// </remarks>
|
||||
private Guid? typedPasswordFor;
|
||||
|
||||
partial void OnTypedPasswordChanged(string value) => typedPasswordFor = SelectedHost?.EntityId;
|
||||
|
||||
/// <remarks>
|
||||
/// It opens saying what the state is rather than what to do about it, and that is a v3 change the
|
||||
/// desktop forced. "Choose a host and connect to browse its files" was this line for two versions, and
|
||||
@@ -1158,7 +1186,8 @@ internal sealed partial class TransfersViewModel : ObservableObject, IAsyncDispo
|
||||
internal bool SelectedHostAsksForAPassword =>
|
||||
ShowsHostPicker
|
||||
&& (SelectedHost is null
|
||||
|| SelectedHost.Resolved.Binding.Kind is ResolvedBindingKind.TypedPassword);
|
||||
|| (!SelectedHost.Host.SignsInThroughSpelunk
|
||||
&& SelectedHost.Resolved.Binding.Kind is ResolvedBindingKind.TypedPassword));
|
||||
|
||||
// ---- The remote pane ----
|
||||
|
||||
@@ -1779,8 +1808,10 @@ internal sealed partial class TransfersViewModel : ObservableObject, IAsyncDispo
|
||||
return;
|
||||
}
|
||||
|
||||
var password = typedPasswordFor == row.EntityId ? TypedPassword : string.Empty;
|
||||
|
||||
if (!open.TryBuildConnectionRequest(
|
||||
row.Host, TypedPassword, out var request, out var identityLabel, out var refusal))
|
||||
row.Host, password, out var request, out var identityLabel, out var refusal))
|
||||
{
|
||||
Status = refusal;
|
||||
return;
|
||||
@@ -1796,14 +1827,14 @@ internal sealed partial class TransfersViewModel : ObservableObject, IAsyncDispo
|
||||
await CloseSessionAsync().ConfigureAwait(true);
|
||||
|
||||
if (await OpenHostSessionAsync(open, row, request, cancellationToken).ConfigureAwait(true)
|
||||
is not { } opened)
|
||||
is not ({ } opened, { } dialled))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
session = opened;
|
||||
TypedPassword = string.Empty;
|
||||
MarkHostConnected(opened, request, row, identityLabel);
|
||||
MarkHostConnected(opened, dialled, row, identityLabel);
|
||||
|
||||
reconnectTo = (RemoteKind.Host, row.EntityId);
|
||||
|
||||
@@ -1816,34 +1847,36 @@ internal sealed partial class TransfersViewModel : ObservableObject, IAsyncDispo
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Opens the session on a host, through the relay when the host uses it, or says why not.
|
||||
/// Opens the session on a host, through the relay or Spelunk when the host uses one, or says why not.
|
||||
/// </summary>
|
||||
/// <returns>The session, or null with <see cref="Status"/> saying why there is none.</returns>
|
||||
private async Task<ISftpSession?> OpenHostSessionAsync(
|
||||
/// <returns>
|
||||
/// The session and the request it was opened with — which, for a Spelunk sign-in, carries the account
|
||||
/// Spelunk named rather than the one the host resolved to — or null with <see cref="Status"/> saying why
|
||||
/// there is none.
|
||||
/// </returns>
|
||||
private async Task<(ISftpSession Session, SshConnectionRequest Request)?> OpenHostSessionAsync(
|
||||
VaultViewModel open,
|
||||
HostRowViewModel row,
|
||||
SshConnectionRequest request,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
RelayRoute? relay = null;
|
||||
IConnectionRoute? route = null;
|
||||
|
||||
try
|
||||
{
|
||||
// Through the relay for a host set to use it, exactly as a shell to it would be. The
|
||||
// session owns the relay from here, on success and on failure alike.
|
||||
relay = row.Host.RelayEnabled
|
||||
? await open.OpenRelayAsync(row.Label, row.EntityId, cancellationToken).ConfigureAwait(true)
|
||||
: null;
|
||||
// Through the relay or Spelunk for a host set to use one, exactly as a shell to it would be.
|
||||
// The session owns the route from here, on success and on failure alike.
|
||||
route = await open.OpenRouteAsync(row, cancellationToken).ConfigureAwait(true);
|
||||
|
||||
return await sftp
|
||||
.OpenSftpAsync(relay is null ? request : request with { Proxy = relay.Proxy }, cancellationToken)
|
||||
.ConfigureAwait(true);
|
||||
var through = VaultViewModel.Through(request, route);
|
||||
|
||||
return (await sftp.OpenSftpAsync(through, cancellationToken).ConfigureAwait(true), through);
|
||||
}
|
||||
catch (Exception exception)
|
||||
when (relay?.Failure is { } failure
|
||||
when (route?.Failure is { } failure
|
||||
&& exception is not (OperationCanceledException or SshHostKeyUnknownException or SshHostKeyMismatchException))
|
||||
{
|
||||
// See VaultViewModel.OpenThroughAsync: the relay's reason is the true one.
|
||||
// See VaultViewModel.OpenThroughAsync: the route's reason is the true one.
|
||||
Status = failure;
|
||||
return null;
|
||||
}
|
||||
@@ -2674,9 +2707,15 @@ internal sealed partial class TransfersViewModel : ObservableObject, IAsyncDispo
|
||||
|
||||
foreach (var row in rows)
|
||||
{
|
||||
if (LocalDirectory.ChildPath(LocalPath, row.Name) is not { } local)
|
||||
{
|
||||
plan.Unsafe++;
|
||||
continue;
|
||||
}
|
||||
|
||||
if (row.IsFile)
|
||||
{
|
||||
plan.Downloads.Add((Path.Combine(LocalPath, row.Name), row.Entry));
|
||||
plan.Downloads.Add((local, row.Entry));
|
||||
continue;
|
||||
}
|
||||
|
||||
@@ -2692,11 +2731,19 @@ internal sealed partial class TransfersViewModel : ObservableObject, IAsyncDispo
|
||||
|
||||
await WalkRemoteAsync(
|
||||
row.FullPath,
|
||||
Path.Combine(LocalPath, row.Name),
|
||||
local,
|
||||
plan,
|
||||
cancellationToken).ConfigureAwait(true);
|
||||
}
|
||||
|
||||
EnqueueDownloads(plan);
|
||||
|
||||
Status = Describe(plan, "download into", LocalPath);
|
||||
}
|
||||
|
||||
/// <summary>Makes the directories a download plan needs here, then hands its files to the queue.</summary>
|
||||
private void EnqueueDownloads(TransferPlan plan)
|
||||
{
|
||||
foreach (var directory in plan.LocalDirectories.OrderBy(each => each.Length))
|
||||
{
|
||||
try
|
||||
@@ -2716,8 +2763,6 @@ internal sealed partial class TransfersViewModel : ObservableObject, IAsyncDispo
|
||||
|
||||
plan.Queued++;
|
||||
}
|
||||
|
||||
Status = Describe(plan, "download into", LocalPath);
|
||||
}
|
||||
|
||||
/// <summary>Adds every file under a remote directory to the plan, with where each will land here.</summary>
|
||||
@@ -2771,30 +2816,48 @@ internal sealed partial class TransfersViewModel : ObservableObject, IAsyncDispo
|
||||
return;
|
||||
}
|
||||
|
||||
switch (entry.Kind)
|
||||
{
|
||||
case SftpEntryKind.File:
|
||||
plan.Downloads.Add((Path.Combine(toDirectory, entry.Name), entry));
|
||||
break;
|
||||
|
||||
case SftpEntryKind.Directory:
|
||||
pending.Enqueue((entry.FullPath, Path.Combine(toDirectory, entry.Name)));
|
||||
break;
|
||||
|
||||
case SftpEntryKind.SymbolicLink:
|
||||
plan.Links++;
|
||||
break;
|
||||
|
||||
default:
|
||||
// A socket, a device, a pipe. There is nothing to copy and no local equivalent to
|
||||
// create, and counting it as a refusal would overstate what went wrong.
|
||||
plan.Skipped++;
|
||||
break;
|
||||
}
|
||||
PlanRemoteEntry(plan, pending, entry, toDirectory);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Adds one entry of a remote listing to a download plan.</summary>
|
||||
private static void PlanRemoteEntry(
|
||||
TransferPlan plan,
|
||||
Queue<(string Remote, string Local)> pending,
|
||||
SftpEntry entry,
|
||||
string toDirectory)
|
||||
{
|
||||
var here = entry.Kind is SftpEntryKind.File or SftpEntryKind.Directory
|
||||
? LocalDirectory.ChildPath(toDirectory, entry.Name)
|
||||
: null;
|
||||
|
||||
switch (entry.Kind)
|
||||
{
|
||||
case SftpEntryKind.File or SftpEntryKind.Directory when here is null:
|
||||
plan.Unsafe++;
|
||||
break;
|
||||
|
||||
case SftpEntryKind.File:
|
||||
plan.Downloads.Add((here!, entry));
|
||||
break;
|
||||
|
||||
case SftpEntryKind.Directory:
|
||||
pending.Enqueue((entry.FullPath, here!));
|
||||
break;
|
||||
|
||||
case SftpEntryKind.SymbolicLink:
|
||||
plan.Links++;
|
||||
break;
|
||||
|
||||
default:
|
||||
// A socket, a device, a pipe. There is nothing to copy and no local equivalent to create, and
|
||||
// counting it as a refusal would overstate what went wrong.
|
||||
plan.Skipped++;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>What an upload of this local file should carry to the host with it.</summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
@@ -2890,6 +2953,10 @@ internal sealed partial class TransfersViewModel : ObservableObject, IAsyncDispo
|
||||
/// <summary>Sockets, devices and pipes, which have nothing to copy.</summary>
|
||||
public int Skipped { get; set; }
|
||||
|
||||
/// <summary>Remote names that would land outside the directory they were meant for.</summary>
|
||||
/// <remarks>See <see cref="LocalDirectory.ChildPath"/>.</remarks>
|
||||
public int Unsafe { get; set; }
|
||||
|
||||
/// <summary>Whether the walk stopped at <see cref="Ceiling"/> rather than at the end of the tree.</summary>
|
||||
public bool Truncated { get; set; }
|
||||
|
||||
@@ -2934,6 +3001,12 @@ internal sealed partial class TransfersViewModel : ObservableObject, IAsyncDispo
|
||||
said += $" {other} not a file.";
|
||||
}
|
||||
|
||||
if (plan.Unsafe > 0)
|
||||
{
|
||||
var named = plan.Unsafe == 1 ? "1 name points outside the folder and was" : $"{plan.Unsafe} names point outside the folder and were";
|
||||
said += $" {named} left on the host.";
|
||||
}
|
||||
|
||||
if (plan.Truncated)
|
||||
{
|
||||
said += " The walk stopped at 5000 files; queue the rest a folder at a time.";
|
||||
@@ -3159,13 +3232,18 @@ internal sealed partial class TransfersViewModel : ObservableObject, IAsyncDispo
|
||||
$"Fetching {row.Name}…",
|
||||
async () =>
|
||||
{
|
||||
var copy = Path.Combine(
|
||||
var folder = Path.Combine(
|
||||
Path.GetTempPath(),
|
||||
"dodossh-edits",
|
||||
Guid.CreateVersion7().ToString("N", CultureInfo.InvariantCulture),
|
||||
row.Name);
|
||||
Guid.CreateVersion7().ToString("N", CultureInfo.InvariantCulture));
|
||||
|
||||
Directory.CreateDirectory(Path.GetDirectoryName(copy)!);
|
||||
if (LocalDirectory.ChildPath(folder, row.Name) is not { } copy)
|
||||
{
|
||||
Status = $"{row.Name} is not a name this machine can open as a file.";
|
||||
return;
|
||||
}
|
||||
|
||||
Directory.CreateDirectory(folder);
|
||||
|
||||
await FetchAsync(row.FullPath, copy, cancellationToken).ConfigureAwait(true);
|
||||
|
||||
@@ -3919,31 +3997,37 @@ internal sealed partial class TransfersViewModel : ObservableObject, IAsyncDispo
|
||||
/// </remarks>
|
||||
private void RefreshHosts()
|
||||
{
|
||||
var host = SelectedHost?.EntityId;
|
||||
var bucket = SelectedBucket?.EntityId;
|
||||
refreshingPickers = true;
|
||||
|
||||
Hosts.Clear();
|
||||
|
||||
if (vault is not { } open)
|
||||
try
|
||||
{
|
||||
return;
|
||||
}
|
||||
Hosts.Clear();
|
||||
|
||||
foreach (var row in open.Hosts)
|
||||
if (vault is not { } open)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
foreach (var row in open.Hosts)
|
||||
{
|
||||
Hosts.Add(row);
|
||||
}
|
||||
|
||||
SelectedHost = Hosts.FirstOrDefault(row => row.EntityId == chosenHost) ?? Hosts.FirstOrDefault();
|
||||
|
||||
Buckets.Clear();
|
||||
|
||||
foreach (var row in open.ObjectStores)
|
||||
{
|
||||
Buckets.Add(row);
|
||||
}
|
||||
|
||||
SelectedBucket = Buckets.FirstOrDefault(row => row.EntityId == chosenBucket) ?? Buckets.FirstOrDefault();
|
||||
}
|
||||
finally
|
||||
{
|
||||
Hosts.Add(row);
|
||||
refreshingPickers = false;
|
||||
}
|
||||
|
||||
SelectedHost = Hosts.FirstOrDefault(row => row.EntityId == host) ?? Hosts.FirstOrDefault();
|
||||
|
||||
Buckets.Clear();
|
||||
|
||||
foreach (var row in open.ObjectStores)
|
||||
{
|
||||
Buckets.Add(row);
|
||||
}
|
||||
|
||||
SelectedBucket = Buckets.FirstOrDefault(row => row.EntityId == bucket) ?? Buckets.FirstOrDefault();
|
||||
}
|
||||
|
||||
/// <summary>The session, or a failure a queue row can carry.</summary>
|
||||
@@ -4103,8 +4187,30 @@ internal sealed partial class TransfersViewModel : ObservableObject, IAsyncDispo
|
||||
await SettleRemoteListingAsync().ConfigureAwait(true);
|
||||
}
|
||||
|
||||
partial void OnSelectedHostChanged(HostRowViewModel? value) =>
|
||||
partial void OnSelectedHostChanged(HostRowViewModel? value)
|
||||
{
|
||||
if (!refreshingPickers)
|
||||
{
|
||||
chosenHost = value?.EntityId;
|
||||
|
||||
// A person moving to another host gets an empty box rather than one still showing a password
|
||||
// that, by typedPasswordFor, would no longer be sent.
|
||||
if (value is not null && typedPasswordFor is not null && value.EntityId != typedPasswordFor)
|
||||
{
|
||||
TypedPassword = string.Empty;
|
||||
}
|
||||
}
|
||||
|
||||
OnPropertyChanged(nameof(SelectedHostAsksForAPassword));
|
||||
}
|
||||
|
||||
partial void OnSelectedBucketChanged(ObjectStoreRowViewModel? value)
|
||||
{
|
||||
if (!refreshingPickers)
|
||||
{
|
||||
chosenBucket = value?.EntityId;
|
||||
}
|
||||
}
|
||||
|
||||
/// <remarks>
|
||||
/// The password box follows this as well as the host, because it is shown only for a host that asks for
|
||||
|
||||
@@ -0,0 +1,543 @@
|
||||
using System.Collections.ObjectModel;
|
||||
using CommunityToolkit.Mvvm.ComponentModel;
|
||||
using DodoSSH.Client.Domain;
|
||||
using DodoSSH.Client.Session;
|
||||
using DodoSSH.Client.Ssh;
|
||||
|
||||
namespace DodoSSH.Client.Shell.ViewModels;
|
||||
|
||||
/// <summary>
|
||||
/// Reaching a host through Spelunk: the editor's half, the connect path's half, and a link from Spelunk.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// A file of its own because it is one feature and this class is long enough without it. Everything here
|
||||
/// follows the relay, which is the other route a host can take: a tick box in the editor, a route opened by
|
||||
/// the connect that will use it, no falling back to a direct dial, and a stated failure when the route
|
||||
/// cannot be opened. See <see cref="HostSecret.Spelunk"/> and <see cref="SpelunkRoute"/>.
|
||||
/// </remarks>
|
||||
internal sealed partial class VaultViewModel
|
||||
{
|
||||
/// <summary>The tag every host made from a Spelunk link wears, and what a link looks for.</summary>
|
||||
/// <remarks>
|
||||
/// Matched without regard to case, as the editor matches every tag name — see <c>AddEditorTagAsync</c>.
|
||||
/// </remarks>
|
||||
internal const string SpelunkTag = "spelunk";
|
||||
|
||||
/// <summary>What the status bar and the log name as the identity of a Spelunk sign-in.</summary>
|
||||
private const string SpelunkSignInIdentity = "Spelunk sign-in";
|
||||
|
||||
/// <summary>What opens a tunnel when no caller supplied something else.</summary>
|
||||
/// <remarks>
|
||||
/// Static and shared for the reason <see cref="DefaultReachability"/> is: it holds nothing but a
|
||||
/// transport, and every tunnel is a fresh ticket and a fresh socket. Optional in the constructor so both
|
||||
/// heads and every existing test go on meaning what they did, and a test that wants to see what was
|
||||
/// opened passes a substitute.
|
||||
/// </remarks>
|
||||
private static readonly ISpelunkTunnel DefaultSpelunk = new SpelunkTunnel();
|
||||
|
||||
/// <summary>Whether the host being edited is reached through Spelunk.</summary>
|
||||
/// <remarks>
|
||||
/// Ticking it unticks the relay and the other way round, rather than letting both be ticked and refusing
|
||||
/// the save: a host has one route, and <see cref="HostSecret.TryValidate"/> would only catch after the
|
||||
/// fact what these two boxes can simply not express.
|
||||
/// </remarks>
|
||||
[ObservableProperty]
|
||||
[NotifyPropertyChangedFor(nameof(EditorAsksForLogin))]
|
||||
private bool editorThroughSpelunk;
|
||||
|
||||
/// <summary>Whether Spelunk signs the user in to the host being edited, so it needs no login of its own.</summary>
|
||||
/// <remarks>
|
||||
/// Inside the Spelunk card, and meaningful only while that is ticked. See
|
||||
/// <see cref="SpelunkRoute.SignInThroughSpelunk"/>.
|
||||
/// </remarks>
|
||||
[ObservableProperty]
|
||||
[NotifyPropertyChangedFor(nameof(EditorAsksForLogin))]
|
||||
private bool editorSpelunkSignIn;
|
||||
|
||||
/// <summary>The Spelunk API address in the editor, as typed.</summary>
|
||||
[ObservableProperty]
|
||||
private string editorSpelunkApi = string.Empty;
|
||||
|
||||
/// <summary>The Spelunk server id in the editor, as typed.</summary>
|
||||
[ObservableProperty]
|
||||
private string editorSpelunkServerId = string.Empty;
|
||||
|
||||
/// <summary>What the editor offers as the Spelunk API key: saved Spelunk keys, then credentials.</summary>
|
||||
/// <remarks>
|
||||
/// No "none" entry: a route with no key cannot be opened, and nothing selected is how a host made from a
|
||||
/// link says it has not been chosen yet. A key the host names that has since been deleted keeps a
|
||||
/// placeholder, for the reason <see cref="BuildAuthenticationChoices"/> keeps one.
|
||||
/// </remarks>
|
||||
internal ObservableCollection<AuthenticationChoice> EditorSpelunkKeyChoices { get; } = [];
|
||||
|
||||
/// <summary>The credential chosen to hold the Spelunk API key.</summary>
|
||||
[ObservableProperty]
|
||||
private AuthenticationChoice? editorSelectedSpelunkKey;
|
||||
|
||||
/// <summary>
|
||||
/// Whether the editor's username and login choice mean anything — false for a host Spelunk signs in to.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The two controls are disabled rather than hidden while it is false, with a sentence saying why, so a
|
||||
/// login somebody had chosen is still there to see — and comes back as it was if the box is unticked
|
||||
/// before saving.
|
||||
/// </remarks>
|
||||
internal bool EditorAsksForLogin => !(EditorThroughSpelunk && EditorSpelunkSignIn);
|
||||
|
||||
/// <inheritdoc cref="DefaultSpelunk" />
|
||||
private ISpelunkTunnel Spelunk => spelunk ?? DefaultSpelunk;
|
||||
|
||||
partial void OnEditorThroughSpelunkChanged(bool value)
|
||||
{
|
||||
if (value)
|
||||
{
|
||||
EditorRelayEnabled = false;
|
||||
}
|
||||
}
|
||||
|
||||
partial void OnEditorRelayEnabledChanged(bool value)
|
||||
{
|
||||
if (value)
|
||||
{
|
||||
EditorThroughSpelunk = false;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Opens the route a host is reached by, or null for a host that is dialled.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// The one place that decides, for both transports: a shell comes through here from
|
||||
/// <see cref="OpenThroughAsync"/>, and file transfer opens its own connection and comes through here from
|
||||
/// the transfers screen — or that screen would fail for exactly the hosts a route exists for.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// A host naming a route that cannot be opened is a refusal, never a quiet direct dial. See
|
||||
/// <see cref="OpenRelayAsync"/> for the relay's half of that argument; Spelunk's is stronger still,
|
||||
/// because a Spelunk host's address may be nothing that answers at all.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// The request a route is used for is made with <see cref="Through"/>, which is where a Spelunk sign-in's
|
||||
/// key and account replace the ones the host resolved to.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal async Task<IConnectionRoute?> OpenRouteAsync(HostRowViewModel row, CancellationToken cancellationToken)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(row);
|
||||
|
||||
if (row.Host.Spelunk is { } route)
|
||||
{
|
||||
return await OpenSpelunkTunnelAsync(row, route, cancellationToken).ConfigureAwait(true);
|
||||
}
|
||||
|
||||
return row.Host.RelayEnabled
|
||||
? await OpenRelayAsync(row.Label, row.EntityId, cancellationToken).ConfigureAwait(true)
|
||||
: null;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The request to connect with once a route is open: through its proxy, and for a Spelunk sign-in, with
|
||||
/// the key the tunnel was opened with and the account Spelunk named.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Both transports make their request through this, so a sign-in cannot reach one of them with the
|
||||
/// stand-in credential <see cref="TryBuildAuthentication"/> gives it — which the SSH layer would refuse
|
||||
/// before dialling anyway. See <see cref="SpelunkSignInPending"/>.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// The host and port are left alone. The host key is pinned under them as for every host, and Spelunk's
|
||||
/// SSH server presents the server's real host key, so a sign-in and a plain tunnel to one server are
|
||||
/// checked against the same pin.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal static SshConnectionRequest Through(SshConnectionRequest request, IConnectionRoute? route)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(request);
|
||||
|
||||
return route switch
|
||||
{
|
||||
null => request,
|
||||
SpelunkTunnelRoute { SignIn: { } signIn, User: { } user } => request with
|
||||
{
|
||||
Proxy = route.Proxy,
|
||||
Username = user,
|
||||
Credential = signIn.Credential,
|
||||
},
|
||||
_ => request with { Proxy = route.Proxy },
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Opens a Spelunk tunnel to a host, with the key it names.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// The key is read from the keychain at the moment of connecting, like every other secret the connect
|
||||
/// path uses, and goes only to the API address the host names — and for a saved Spelunk key, only when
|
||||
/// that is the address it was saved for. See <see cref="SpelunkApiKeyFor"/>.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// The port is the host's resolved one, group and all: it is the port the agent connects to on the
|
||||
/// server's own loopback, which is where the SSH server listens whatever address the world sees.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>A host Spelunk signs in to gets a new key pair here, every time.</b> It is made in memory for this
|
||||
/// one tunnel, its public half goes with the ticket request, and the route carries it to the connection —
|
||||
/// see <see cref="SpelunkSignIn"/>. A retry after a host key question, or a reconnect, comes back through
|
||||
/// here and makes another.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private async Task<IConnectionRoute> OpenSpelunkTunnelAsync(
|
||||
HostRowViewModel row,
|
||||
SpelunkRoute route,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
var apiKey = SpelunkApiKeyFor(row, route);
|
||||
|
||||
return await Spelunk
|
||||
.OpenAsync(
|
||||
route.ApiBase,
|
||||
route.ServerId,
|
||||
apiKey,
|
||||
row.Resolved.Port.Value,
|
||||
route.SignInThroughSpelunk ? SpelunkSignIn.Create() : null,
|
||||
cancellationToken)
|
||||
.ConfigureAwait(true);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Does what a <c>dodossh://spelunk/connect</c> link asks, as far as it is allowed to.
|
||||
/// </summary>
|
||||
/// <returns>
|
||||
/// The work the link started, connection attempt included, so a caller that wants to can wait for it.
|
||||
/// </returns>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <b>A host for that server in the personal vault, tagged <see cref="SpelunkTag"/>, is connected to</b>,
|
||||
/// exactly as a tap on its row would. Those are the hosts links make, and the only ones a link looks for:
|
||||
/// a host somebody set up by hand, or one in a team's vault, is theirs to connect to and not the link's.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>Otherwise, when that Spelunk already gets an API key, the host is made and connected to.</b> In the
|
||||
/// personal vault, tagged, named as the link names it, and signing in through Spelunk — so it needs no
|
||||
/// SSH key or password — with the key saved for that Spelunk under Settings → Security, or else the key
|
||||
/// credential a saved host already sends there. It is saved the ordinary way and syncs like any host.
|
||||
/// Nothing leaks by this: the key goes where the user already said it goes, and the server is one that
|
||||
/// key's own organisation holds or Spelunk refuses it.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>The first link from a Spelunk with no key opens the editor instead, and nothing more.</b> Anything
|
||||
/// on this machine can make a link, so it must never be able to send an API key to an address the user
|
||||
/// has not sent it to. The host is pre-filled — signing in through Spelunk, tagged, in the personal
|
||||
/// vault — and the user chooses the key and saves; every later link from that Spelunk connects straight
|
||||
/// away.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal async Task OpenSpelunkLinkAsync(SpelunkLink link)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(link);
|
||||
|
||||
var personal = PersonalVaultId();
|
||||
|
||||
if (personal is { } vaultId
|
||||
&& Hosts.FirstOrDefault(row =>
|
||||
row.VaultId == vaultId
|
||||
&& row.Host.Spelunk?.IsFor(link.ApiBase, link.ServerId) is true
|
||||
&& WearsSpelunkTag(row.Host)) is { } saved)
|
||||
{
|
||||
await ConnectToRowCommand.ExecuteAsync(saved).ConfigureAwait(true);
|
||||
return;
|
||||
}
|
||||
|
||||
var knownKey = KnownSpelunkKey(link.ApiBase, personal);
|
||||
|
||||
if (personal is { } into && knownKey is { } key)
|
||||
{
|
||||
await AddFromLinkAndConnectAsync(link, into, key).ConfigureAwait(true);
|
||||
return;
|
||||
}
|
||||
|
||||
await OpenLinkInEditorAsync(link, personal, knownKey).ConfigureAwait(true);
|
||||
}
|
||||
|
||||
/// <summary>The personal vault, when this session can read and write it.</summary>
|
||||
private Guid? PersonalVaultId() =>
|
||||
session.ReadableVaults.FirstOrDefault(vault => vault.IsPersonal && vault.CanWrite)?.VaultId;
|
||||
|
||||
/// <summary>Whether a host wears a tag called <see cref="SpelunkTag"/>, from whichever vault.</summary>
|
||||
private bool WearsSpelunkTag(HostSecret host) =>
|
||||
host.TagIds.Any(id => tagsById.TryGetValue(id, out var tag) && IsSpelunkTag(tag));
|
||||
|
||||
private static bool IsSpelunkTag(TagSecret tag) =>
|
||||
string.Equals(tag.Label.Trim(), SpelunkTag, StringComparison.OrdinalIgnoreCase);
|
||||
|
||||
/// <summary>
|
||||
/// The key the user has already agreed may go to this Spelunk, or null when there is none.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// A Spelunk key saved for that address first — it is the one thing that says so in as many words — and
|
||||
/// otherwise the key a saved host already sends there, which is how the answer was reached before saved
|
||||
/// keys existed and is still true of every host set up that way.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// The personal vault's first, so the answer does not depend on the order vaults happen to load in; and
|
||||
/// only a key still in the keychain, because a dangling one would make a host that cannot connect.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private Guid? KnownSpelunkKey(string apiBase, Guid? personal) =>
|
||||
SavedSpelunkKeyFor(apiBase, personal)?.EntityId
|
||||
?? Hosts
|
||||
.OrderByDescending(row => row.VaultId == personal)
|
||||
.Select(row => row.Host.Spelunk)
|
||||
.Where(route => route is not null && string.Equals(route.ApiBase, apiBase, StringComparison.Ordinal))
|
||||
.Select(route => (Guid?)route!.ApiKeyCredentialId)
|
||||
.FirstOrDefault(id =>
|
||||
Credentials.Any(credential => credential.EntityId == id)
|
||||
|| SpelunkKeys.Any(key => key.EntityId == id && string.Equals(key.ApiBase, apiBase, StringComparison.Ordinal)));
|
||||
|
||||
/// <summary>The host a link makes: what the link says, signing in through Spelunk with a known key.</summary>
|
||||
private static HostSecret HostFromLink(SpelunkLink link, Guid apiKeyCredentialId, TagSet tags) => new()
|
||||
{
|
||||
Label = link.Name,
|
||||
Hostname = link.Hostname,
|
||||
Port = HostSecret.DefaultPort,
|
||||
TagIds = tags,
|
||||
Spelunk = new SpelunkRoute
|
||||
{
|
||||
ApiBase = link.ApiBase,
|
||||
ServerId = link.ServerId,
|
||||
ApiKeyCredentialId = apiKeyCredentialId,
|
||||
SignInThroughSpelunk = true,
|
||||
},
|
||||
};
|
||||
|
||||
/// <summary>Saves the host a link describes into the personal vault, tagged, and connects to it.</summary>
|
||||
private async Task AddFromLinkAndConnectAsync(SpelunkLink link, Guid vaultId, Guid apiKeyCredentialId)
|
||||
{
|
||||
if (IsBusy)
|
||||
{
|
||||
// RunAsync would drop it without a word, and the user pressed a button somewhere else to get here.
|
||||
Status = $"Busy — open {link.Name} from Spelunk again in a moment.";
|
||||
return;
|
||||
}
|
||||
|
||||
Guid? hostId = null;
|
||||
|
||||
await RunAsync(
|
||||
$"Adding {link.Name} from Spelunk…",
|
||||
async () =>
|
||||
{
|
||||
var tagId = await EnsureSpelunkTagAsync(vaultId, CancellationToken.None).ConfigureAwait(true);
|
||||
|
||||
hostId = await session.Hosts
|
||||
.CreateAsync(
|
||||
vaultId,
|
||||
HostFromLink(link, apiKeyCredentialId, TagSet.Create([tagId])),
|
||||
CancellationToken.None)
|
||||
.ConfigureAwait(true);
|
||||
|
||||
await ReloadAsync(CancellationToken.None).ConfigureAwait(true);
|
||||
}).ConfigureAwait(true);
|
||||
|
||||
// A failure has said so on the status line already.
|
||||
if (hostId is not { } id || Hosts.FirstOrDefault(row => row.EntityId == id) is not { } row)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
Status = $"Added {link.Name} from Spelunk at {link.ApiBase}.";
|
||||
|
||||
await ConnectToRowCommand.ExecuteAsync(row).ConfigureAwait(true);
|
||||
|
||||
// After the connect rather than before it: the host is saved either way, and the terminal is what the
|
||||
// user is waiting for. As SaveHostAsync does, it goes to the server now rather than at the next tick.
|
||||
await AutoSyncAsync(CancellationToken.None).ConfigureAwait(true);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Opens the editor on a new host from a link, for the first link from a Spelunk no host sends a key to.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Opened before anything is awaited, so the editor is up in the same turn the link arrived in. The tag is
|
||||
/// made or found afterwards and added to the host being edited; a tag made for a host that is then
|
||||
/// cancelled stays, as the editor's own new-tag box leaves it.
|
||||
/// </remarks>
|
||||
private async Task OpenLinkInEditorAsync(SpelunkLink link, Guid? personal, Guid? knownKey)
|
||||
{
|
||||
// Refused while another host is half-edited, as NewHost refuses it, and said the same way: the link
|
||||
// is not worth somebody's unsaved host.
|
||||
if (AHostEditorIsInTheWay())
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
NewHost();
|
||||
|
||||
if (personal is { } vaultId
|
||||
&& EditorVaultChoices.FirstOrDefault(choice => choice.VaultId == vaultId) is { } choice)
|
||||
{
|
||||
EditorSelectedVault = choice;
|
||||
}
|
||||
|
||||
EditorLabel = link.Name;
|
||||
EditorHostname = link.Hostname;
|
||||
EditorPort = HostSecret.DefaultPort;
|
||||
EditorThroughSpelunk = true;
|
||||
EditorSpelunkSignIn = true;
|
||||
EditorSpelunkApi = link.ApiBase;
|
||||
EditorSpelunkServerId = link.ServerId.ToString();
|
||||
|
||||
BuildSpelunkKeyChoices(knownKey);
|
||||
|
||||
IsHostPaneOpen = true;
|
||||
|
||||
var said = EditorSelectedSpelunkKey is null
|
||||
? $"Adding {link.Name}, the first server from Spelunk at {link.ApiBase}. Choose your Spelunk API "
|
||||
+ "key and save — Spelunk signs you in, so no SSH key is needed, and later links from this "
|
||||
+ "Spelunk connect straight away. Saving the key under Settings → Security does the same."
|
||||
: $"Adding {link.Name} from Spelunk at {link.ApiBase}. Check it and save.";
|
||||
|
||||
Status = said;
|
||||
|
||||
if (personal is { } into)
|
||||
{
|
||||
await TagHostFromLinkAsync(into, said).ConfigureAwait(true);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Adds the <see cref="SpelunkTag"/> tag to the host a link opened the editor on.</summary>
|
||||
/// <param name="vaultId">The personal vault, where the host is to be saved and the tag is.</param>
|
||||
/// <param name="said">What the status line says about the link, put back after the reload.</param>
|
||||
private async Task TagHostFromLinkAsync(Guid vaultId, string said)
|
||||
{
|
||||
try
|
||||
{
|
||||
var tagId = await EnsureSpelunkTagAsync(vaultId, CancellationToken.None).ConfigureAwait(true);
|
||||
|
||||
// Only onto the host this link opened: the user may have cancelled it, or moved on to another, in
|
||||
// the moment the tag took.
|
||||
if (!IsEditing || editingEntityId is not null || editingHostVaultId != vaultId)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
editorTagIds = TagSet.Create([.. editorTagIds, tagId]);
|
||||
|
||||
if (!tagsById.ContainsKey(tagId))
|
||||
{
|
||||
await ReloadAsync(CancellationToken.None).ConfigureAwait(true);
|
||||
}
|
||||
|
||||
BuildTagChoices();
|
||||
Status = said;
|
||||
}
|
||||
catch (Exception exception) when (exception is not OutOfMemoryException)
|
||||
{
|
||||
// The host can still be saved; it is the tag that could not be made, and a later link would then
|
||||
// not find it. Said, rather than failing the whole link over it.
|
||||
Status = $"{said} (The '{SpelunkTag}' tag could not be added: {exception.Message})";
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>The <see cref="SpelunkTag"/> tag in a vault, made there if it has none.</summary>
|
||||
private async Task<Guid> EnsureSpelunkTagAsync(Guid vaultId, CancellationToken cancellationToken)
|
||||
{
|
||||
var listing = await session.Tags.ListAsync(vaultId, cancellationToken).ConfigureAwait(true);
|
||||
|
||||
if (listing.Items
|
||||
.Where(tag => IsSpelunkTag(tag.Secret))
|
||||
.OrderBy(tag => tag.EntityId)
|
||||
.FirstOrDefault() is { } existing)
|
||||
{
|
||||
return existing.EntityId;
|
||||
}
|
||||
|
||||
return await session.Tags
|
||||
.CreateAsync(vaultId, new TagSecret { Label = SpelunkTag }, cancellationToken)
|
||||
.ConfigureAwait(true);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Whether a host needs this key or credential to connect: as its resolved binding, or as the credential
|
||||
/// holding its Spelunk API key.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The one question the deletion warning, the table's USED BY column and the detail pane's list all ask,
|
||||
/// so a credential that is only somebody's Spelunk key is not deleted as though nothing used it. Spelunk
|
||||
/// keys are named by the host itself and never inherited, so the stored route is the whole answer there.
|
||||
/// A host Spelunk signs in to uses no binding at all, whatever its group lends.
|
||||
/// </remarks>
|
||||
private static bool Uses(HostRowViewModel row, ResolvedBindingKind kind, Guid entityId) =>
|
||||
(!row.Host.SignsInThroughSpelunk
|
||||
&& row.Resolved.Binding is { } binding
|
||||
&& binding.Kind == kind
|
||||
&& binding.EntityId == entityId)
|
||||
|| (kind is ResolvedBindingKind.Credential && row.Host.Spelunk?.ApiKeyCredentialId == entityId);
|
||||
|
||||
/// <summary>Puts a host's route into the editor, or clears it for a host that has none.</summary>
|
||||
private void LoadEditorSpelunk(SpelunkRoute? route)
|
||||
{
|
||||
EditorThroughSpelunk = route is not null;
|
||||
EditorSpelunkSignIn = route?.SignInThroughSpelunk ?? false;
|
||||
EditorSpelunkApi = route?.ApiBase ?? string.Empty;
|
||||
EditorSpelunkServerId = route?.ServerId.ToString() ?? string.Empty;
|
||||
|
||||
BuildSpelunkKeyChoices(route?.ApiKeyCredentialId);
|
||||
}
|
||||
|
||||
/// <summary>Fills the API key picker, keeping whatever the host names selectable.</summary>
|
||||
/// <remarks>
|
||||
/// Saved Spelunk keys first, named for where they go, because that is the choice the Security page made
|
||||
/// for exactly this; then every credential, for a key kept as a password before saved keys existed.
|
||||
/// </remarks>
|
||||
private void BuildSpelunkKeyChoices(Guid? selectedId)
|
||||
{
|
||||
EditorSpelunkKeyChoices.Clear();
|
||||
|
||||
foreach (var key in SpelunkKeys)
|
||||
{
|
||||
EditorSpelunkKeyChoices.Add(new AuthenticationChoice(
|
||||
AuthenticationKind.Credential, key.EntityId, key.Label, $"Spelunk key · {key.ApiBase}"));
|
||||
}
|
||||
|
||||
foreach (var credential in Credentials)
|
||||
{
|
||||
EditorSpelunkKeyChoices.Add(AuthenticationChoice.ForCredential(credential.EntityId, credential.Label));
|
||||
}
|
||||
|
||||
if (selectedId is { } missing && EditorSpelunkKeyChoices.All(choice => choice.EntityId != missing))
|
||||
{
|
||||
EditorSpelunkKeyChoices.Add(AuthenticationChoice.Missing(AuthenticationKind.Credential, missing));
|
||||
}
|
||||
|
||||
EditorSelectedSpelunkKey = EditorSpelunkKeyChoices.FirstOrDefault(choice => choice.EntityId == selectedId);
|
||||
}
|
||||
|
||||
/// <summary>The editor's route, or null when the box is not ticked.</summary>
|
||||
/// <remarks>
|
||||
/// What cannot be read is written as empty rather than left out, so that
|
||||
/// <see cref="HostSecret.TryValidate"/> says what is wrong with it — "needs the id of its Spelunk server"
|
||||
/// — instead of the save quietly producing a host that is dialled directly. The address is normalised
|
||||
/// here when it can be, so <c>https://api.example.com/</c> saves as the same Spelunk as the link's.
|
||||
/// </remarks>
|
||||
private SpelunkRoute? BuildSpelunkRoute()
|
||||
{
|
||||
if (!EditorThroughSpelunk)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
return new SpelunkRoute
|
||||
{
|
||||
ApiBase = SpelunkRoute.TryNormalizeApiBase(EditorSpelunkApi, out var normalized, out _)
|
||||
? normalized
|
||||
: EditorSpelunkApi.Trim(),
|
||||
ServerId = Guid.TryParse(EditorSpelunkServerId.Trim(), out var serverId) ? serverId : Guid.Empty,
|
||||
ApiKeyCredentialId = EditorSelectedSpelunkKey?.EntityId ?? Guid.Empty,
|
||||
SignInThroughSpelunk = EditorSpelunkSignIn,
|
||||
};
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,374 @@
|
||||
using System.Collections.ObjectModel;
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using CommunityToolkit.Mvvm.ComponentModel;
|
||||
using CommunityToolkit.Mvvm.Input;
|
||||
using DodoSSH.Client.Domain;
|
||||
using DodoSSH.Client.Session;
|
||||
using DodoSSH.Client.Sync;
|
||||
|
||||
namespace DodoSSH.Client.Shell.ViewModels;
|
||||
|
||||
/// <summary>One saved Spelunk key, as a row on the Security page.</summary>
|
||||
/// <remarks>
|
||||
/// Carries the decrypted key so the connect path needs no second decryption, and — as the credential row does
|
||||
/// — exposes nothing of it to the view: the XAML binds the name, the address and a count.
|
||||
/// </remarks>
|
||||
internal sealed class SpelunkKeyRowViewModel(VaultItem<SpelunkKeySecret> key, Guid vaultId, string vaultName)
|
||||
{
|
||||
internal Guid EntityId => key.EntityId;
|
||||
|
||||
internal Guid VaultId { get; } = vaultId;
|
||||
|
||||
internal string VaultName { get; } = vaultName;
|
||||
|
||||
internal SpelunkKeySecret Key => key.Secret;
|
||||
|
||||
internal string Label => key.Secret.Label;
|
||||
|
||||
/// <summary>The one address this key is ever sent to.</summary>
|
||||
internal string ApiBase => key.Secret.ApiBase;
|
||||
|
||||
/// <summary>The vault's name, when there is more than one to tell apart; empty otherwise.</summary>
|
||||
internal string VaultBadge { get; init; } = string.Empty;
|
||||
|
||||
internal bool HasVaultBadge => VaultBadge.Length > 0;
|
||||
|
||||
/// <summary>How many hosts reach Spelunk with this key, in words.</summary>
|
||||
internal string UsedBy { get; init; } = string.Empty;
|
||||
|
||||
internal bool IsReadOnly => key.IsReadOnly;
|
||||
|
||||
internal string Badge => ItemBadge.For(key.IsBlocked, key.IsReadOnly, key.HasUnsyncedChanges);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Spelunk keys: filling one in on the Security page, and what a saved one lets a host and a link do.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <b>A saved key says where it may go.</b> It is an API key and the one Spelunk address it belongs to, kept
|
||||
/// in the keychain and synced like any secret. A host can name it where it would name a credential, and it is
|
||||
/// then sent to that address and never to another — see <see cref="SpelunkApiKeyFor"/>. A link from that
|
||||
/// Spelunk connects straight away, because saving the key is the user saying so — see
|
||||
/// <see cref="KnownSpelunkKey"/>.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// The form saves into the personal vault, and a second key for an address the personal vault already has a
|
||||
/// key for replaces that key rather than adding a rival: one Spelunk, one key, which is also what makes the
|
||||
/// answer to "which key does a link use?" not depend on anything the user cannot see.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal sealed partial class VaultViewModel
|
||||
{
|
||||
/// <summary>Every Spelunk key this session can read, the personal vault's first.</summary>
|
||||
internal ObservableCollection<SpelunkKeyRowViewModel> SpelunkKeys { get; } = [];
|
||||
|
||||
/// <summary>Whether there is any saved key to list.</summary>
|
||||
internal bool HasSpelunkKeys => SpelunkKeys.Count > 0;
|
||||
|
||||
/// <summary>The Spelunk API address in the Security page's form, as typed.</summary>
|
||||
[ObservableProperty]
|
||||
private string spelunkKeyFormApi = string.Empty;
|
||||
|
||||
/// <summary>The API key in the Security page's form, as pasted. Cleared the moment it is saved.</summary>
|
||||
[ObservableProperty]
|
||||
private string spelunkKeyFormKey = string.Empty;
|
||||
|
||||
/// <summary>What the form has to say about the last save, or empty.</summary>
|
||||
/// <remarks>
|
||||
/// Beside the form rather than only on the status line, because the Security page is a long way from the
|
||||
/// status bar and a refusal nobody sees reads as a button that does nothing.
|
||||
/// </remarks>
|
||||
[ObservableProperty]
|
||||
private string spelunkKeyFormNote = string.Empty;
|
||||
|
||||
/// <summary>Whether <see cref="SpelunkKeyFormNote"/> has anything in it.</summary>
|
||||
internal bool HasSpelunkKeyFormNote => SpelunkKeyFormNote.Length > 0;
|
||||
|
||||
partial void OnSpelunkKeyFormNoteChanged(string value) => OnPropertyChanged(nameof(HasSpelunkKeyFormNote));
|
||||
|
||||
/// <summary>
|
||||
/// Picks the saved key for the address being typed, when nothing is chosen yet.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Only into an empty choice: a key somebody picked is theirs, and replacing it because they edited the
|
||||
/// address would be choosing for them.
|
||||
/// </remarks>
|
||||
partial void OnEditorSpelunkApiChanged(string value)
|
||||
{
|
||||
if (EditorSelectedSpelunkKey is not null
|
||||
|| !SpelunkRoute.TryNormalizeApiBase(value, out var apiBase, out _)
|
||||
|| SavedSpelunkKeyFor(apiBase, PersonalVaultId()) is not { } saved)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
EditorSelectedSpelunkKey = EditorSpelunkKeyChoices.FirstOrDefault(choice => choice.EntityId == saved.EntityId);
|
||||
}
|
||||
|
||||
/// <summary>Saves the key in the form for the address in the form.</summary>
|
||||
[RelayCommand]
|
||||
private async Task SaveSpelunkKeyAsync(CancellationToken cancellationToken)
|
||||
{
|
||||
if (!TryReadSpelunkKeyForm(out var vaultId, out var existing, out var key))
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
var apiBase = key.ApiBase;
|
||||
|
||||
SpelunkKeyFormNote = string.Empty;
|
||||
|
||||
await RunAsync(
|
||||
"Saving the Spelunk key…",
|
||||
async () =>
|
||||
{
|
||||
if (existing is not null)
|
||||
{
|
||||
await session.SpelunkKeys
|
||||
.UpdateAsync(vaultId, existing.EntityId, key, cancellationToken)
|
||||
.ConfigureAwait(true);
|
||||
}
|
||||
else
|
||||
{
|
||||
await session.SpelunkKeys.CreateAsync(vaultId, key, cancellationToken).ConfigureAwait(true);
|
||||
}
|
||||
|
||||
// The key leaves the form as soon as it is in the keychain; the address stays, as a reminder
|
||||
// of what was just saved.
|
||||
SpelunkKeyFormKey = string.Empty;
|
||||
SpelunkKeyFormApi = apiBase;
|
||||
|
||||
await ReloadAsync(cancellationToken).ConfigureAwait(true);
|
||||
|
||||
var said = existing is null
|
||||
? $"Saved the Spelunk key for {apiBase}. Links from that Spelunk now connect straight away."
|
||||
: $"Replaced the Spelunk key for {apiBase}. Every host using it connects with the new one.";
|
||||
|
||||
Status = connection() is null ? $"{said} It will sync when you are online." : said;
|
||||
SpelunkKeyFormNote = said;
|
||||
}).ConfigureAwait(true);
|
||||
|
||||
await AutoSyncAsync(cancellationToken).ConfigureAwait(true);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Reads the form into the key it would save, and where; or says on the form why it cannot.
|
||||
/// </summary>
|
||||
/// <param name="vaultId">The vault the key goes into: the personal one, when there is one.</param>
|
||||
/// <param name="existing">The key already saved there for that address, which this one replaces.</param>
|
||||
/// <param name="key">The key to save, keeping the existing one's name.</param>
|
||||
private bool TryReadSpelunkKeyForm(
|
||||
out Guid vaultId,
|
||||
out SpelunkKeyRowViewModel? existing,
|
||||
[NotNullWhen(true)] out SpelunkKeySecret? key)
|
||||
{
|
||||
vaultId = Guid.Empty;
|
||||
existing = null;
|
||||
key = null;
|
||||
|
||||
if (!SpelunkRoute.TryNormalizeApiBase(SpelunkKeyFormApi, out var apiBase, out var reason))
|
||||
{
|
||||
SpelunkKeyFormNote = reason;
|
||||
return false;
|
||||
}
|
||||
|
||||
if ((PersonalVaultId() ?? WritableActiveVault()) is not { } target)
|
||||
{
|
||||
SpelunkKeyFormNote = "There is no vault here this account can write to, so the key cannot be saved.";
|
||||
return false;
|
||||
}
|
||||
|
||||
vaultId = target;
|
||||
existing = SpelunkKeys.FirstOrDefault(row =>
|
||||
row.VaultId == target && string.Equals(row.ApiBase, apiBase, StringComparison.Ordinal));
|
||||
|
||||
var candidate = new SpelunkKeySecret
|
||||
{
|
||||
Label = existing?.Label ?? SpelunkKeyLabel(apiBase),
|
||||
ApiBase = apiBase,
|
||||
ApiKey = SpelunkKeyFormKey.Trim(),
|
||||
};
|
||||
|
||||
if (!candidate.TryValidate(out reason))
|
||||
{
|
||||
SpelunkKeyFormNote = reason;
|
||||
return false;
|
||||
}
|
||||
|
||||
key = candidate;
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>Asks whether a saved Spelunk key should go.</summary>
|
||||
[RelayCommand]
|
||||
private void DeleteSpelunkKeyRow(SpelunkKeyRowViewModel? row)
|
||||
{
|
||||
if (row is null)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
PendingDeletion = new DeletionRequest(
|
||||
DeletionTarget.SpelunkKey,
|
||||
row.EntityId,
|
||||
$"Delete the Spelunk key for {row.ApiBase}?",
|
||||
HowFarADeletionGoes("The key"),
|
||||
HostsReachingSpelunkWith(row.EntityId));
|
||||
}
|
||||
|
||||
/// <summary>Queues a tombstone for the Spelunk key that was agreed to.</summary>
|
||||
private async Task DeleteSpelunkKeyNowAsync(Guid entityId, CancellationToken cancellationToken)
|
||||
{
|
||||
if (SpelunkKeys.FirstOrDefault(row => row.EntityId == entityId) is not { } row)
|
||||
{
|
||||
Status = "That Spelunk key is no longer here, so nothing was deleted.";
|
||||
return;
|
||||
}
|
||||
|
||||
await RunAsync(
|
||||
"Deleting…",
|
||||
async () =>
|
||||
{
|
||||
await session.SpelunkKeys
|
||||
.DeleteAsync(row.VaultId, row.EntityId, cancellationToken)
|
||||
.ConfigureAwait(true);
|
||||
|
||||
await ReloadAsync(cancellationToken).ConfigureAwait(true);
|
||||
Status = $"Deleted the Spelunk key for {row.ApiBase}.";
|
||||
}).ConfigureAwait(true);
|
||||
|
||||
await AutoSyncAsync(cancellationToken).ConfigureAwait(true);
|
||||
}
|
||||
|
||||
/// <returns>How many Spelunk keys would not decrypt.</returns>
|
||||
/// <remarks>
|
||||
/// Read after the hosts, because each row says how many of them use it.
|
||||
/// </remarks>
|
||||
private async Task<int> ReloadSpelunkKeysAsync(CancellationToken cancellationToken)
|
||||
{
|
||||
var unreadable = 0;
|
||||
var rows = new List<SpelunkKeyRowViewModel>();
|
||||
|
||||
var readableVaults = session.ReadableVaults.ToList();
|
||||
var several = readableVaults.Count > 1;
|
||||
|
||||
foreach (var vault in readableVaults)
|
||||
{
|
||||
var listing = await session.SpelunkKeys
|
||||
.ListAsync(vault.VaultId, cancellationToken)
|
||||
.ConfigureAwait(true);
|
||||
|
||||
unreadable += listing.Unreadable;
|
||||
|
||||
rows.AddRange(listing.Items.Select(item => new SpelunkKeyRowViewModel(item, vault.VaultId, vault.Name)
|
||||
{
|
||||
VaultBadge = several ? vault.Name.ToUpperInvariant() : string.Empty,
|
||||
UsedBy = UsedBySummary(Hosts.Count(host => host.Host.Spelunk?.ApiKeyCredentialId == item.EntityId)),
|
||||
}));
|
||||
}
|
||||
|
||||
var personal = PersonalVaultId();
|
||||
|
||||
SpelunkKeys.Clear();
|
||||
|
||||
foreach (var row in rows
|
||||
.OrderByDescending(row => row.VaultId == personal)
|
||||
.ThenBy(row => row.VaultName, StringComparer.CurrentCulture)
|
||||
.ThenBy(row => row.ApiBase, StringComparer.Ordinal))
|
||||
{
|
||||
SpelunkKeys.Add(row);
|
||||
}
|
||||
|
||||
OnPropertyChanged(nameof(HasSpelunkKeys));
|
||||
|
||||
return unreadable;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The key to send to a host's Spelunk: a saved Spelunk key's, or a credential's password.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <b>A saved Spelunk key goes to its own address or nowhere.</b> A host naming one with a different
|
||||
/// address — edited by hand, or merged from two devices — is refused in words rather than sending the key
|
||||
/// to a Spelunk it was never saved for. A credential carries no address, so its password goes where the
|
||||
/// host says, as it always has.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Either can be gone, deleted on another machine, and that is refused exactly as a missing SSH credential
|
||||
/// is — see <see cref="TryBuildAuthentication"/>.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
/// <exception cref="SpelunkTunnelException">The key cannot be sent to this host's Spelunk.</exception>
|
||||
private string SpelunkApiKeyFor(HostRowViewModel row, SpelunkRoute route)
|
||||
{
|
||||
if (SpelunkKeys.FirstOrDefault(key => key.EntityId == route.ApiKeyCredentialId) is { } saved)
|
||||
{
|
||||
if (!string.Equals(saved.ApiBase, route.ApiBase, StringComparison.Ordinal))
|
||||
{
|
||||
throw new SpelunkTunnelException(
|
||||
$"'{row.Label}' is reached through {route.ApiBase} with the Spelunk key saved for "
|
||||
+ $"{saved.ApiBase}, and that key is never sent anywhere else. Edit the host to choose "
|
||||
+ "the key for its own Spelunk.");
|
||||
}
|
||||
|
||||
return saved.Key.ApiKey;
|
||||
}
|
||||
|
||||
if (Credentials.FirstOrDefault(credential => credential.EntityId == route.ApiKeyCredentialId) is { } credential)
|
||||
{
|
||||
return credential.Credential.Password;
|
||||
}
|
||||
|
||||
throw new SpelunkTunnelException(
|
||||
$"'{row.Label}' is reached through Spelunk with an API key that is not in this keychain any more. "
|
||||
+ "Edit the host to choose another one, or save the key under Settings → Security.");
|
||||
}
|
||||
|
||||
/// <summary>The saved key for a Spelunk, the given vault's first, or null when none is saved.</summary>
|
||||
private SpelunkKeyRowViewModel? SavedSpelunkKeyFor(string apiBase, Guid? preferredVault) =>
|
||||
SpelunkKeys
|
||||
.Where(row => string.Equals(row.ApiBase, apiBase, StringComparison.Ordinal))
|
||||
.OrderByDescending(row => row.VaultId == preferredVault)
|
||||
.FirstOrDefault();
|
||||
|
||||
/// <summary>The active vault when this session may write to it, for a session with no personal vault.</summary>
|
||||
private Guid? WritableActiveVault() =>
|
||||
session.ReadableVaults.FirstOrDefault(vault => vault.VaultId == session.ActiveVaultId && vault.CanWrite)
|
||||
?.VaultId;
|
||||
|
||||
/// <summary>The name a key saved from the form is given: where it goes.</summary>
|
||||
private static string SpelunkKeyLabel(string apiBase) =>
|
||||
Uri.TryCreate(apiBase, UriKind.Absolute, out var uri) ? $"Spelunk at {uri.Authority}" : "Spelunk";
|
||||
|
||||
private static string UsedBySummary(int hosts) => hosts switch
|
||||
{
|
||||
0 => "No host uses it yet",
|
||||
1 => "1 host uses it",
|
||||
_ => $"{hosts} hosts use it",
|
||||
};
|
||||
|
||||
/// <summary>What the hosts that reach Spelunk with a key would be left with, or nothing when none do.</summary>
|
||||
private string HostsReachingSpelunkWith(Guid entityId)
|
||||
{
|
||||
var named = Hosts
|
||||
.Where(row => row.Host.Spelunk?.ApiKeyCredentialId == entityId)
|
||||
.Select(row => row.Label)
|
||||
.ToArray();
|
||||
|
||||
if (named.Length == 0)
|
||||
{
|
||||
return string.Empty;
|
||||
}
|
||||
|
||||
var list = named.Length <= 3
|
||||
? string.Join(", ", named)
|
||||
: $"{string.Join(", ", named.Take(3))} and {named.Length - 3} more";
|
||||
|
||||
return named.Length == 1
|
||||
? $"{list} reaches Spelunk with it, and will refuse to connect until it names another key."
|
||||
: $"{named.Length} hosts reach Spelunk with it — {list} — and will refuse to connect until they "
|
||||
+ "name another key.";
|
||||
}
|
||||
}
|
||||
@@ -594,6 +594,10 @@ internal sealed partial class HostRowViewModel(
|
||||
/// <summary>Whether the card draws a pin-count badge at all.</summary>
|
||||
internal bool HasPins => PinCount > 0;
|
||||
|
||||
/// <summary>Whether this host carries any port forwards, for the detail pane's FORWARDS card.</summary>
|
||||
/// <remarks>Read off the secret for the reason <see cref="PinCount"/> is.</remarks>
|
||||
internal bool HasForwards => host.Secret.PortForwards.Count > 0;
|
||||
|
||||
/// <summary>
|
||||
/// The two letters a card's monogram avatar draws.
|
||||
/// </summary>
|
||||
@@ -956,8 +960,17 @@ internal sealed class TerminalSessionEventArgs(
|
||||
string cipher,
|
||||
string hostKeyAlgorithm,
|
||||
string? identityLabel,
|
||||
Guid? hostId) : EventArgs
|
||||
Guid? hostId,
|
||||
PortForwardList? forwards = null) : EventArgs
|
||||
{
|
||||
/// <summary>
|
||||
/// The forwards to start on this session: the host's saved ones, or none for a typed-in address.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Carried here because the shell has no vault to read them from, for the reason the label is.
|
||||
/// </remarks>
|
||||
internal PortForwardList Forwards { get; } = forwards ?? PortForwardList.Empty;
|
||||
|
||||
/// <summary>Which attempt this session came out of.</summary>
|
||||
/// <inheritdoc cref="ConnectionAttemptEventArgs.AttemptId" path="/remarks" />
|
||||
internal Guid AttemptId { get; } = attemptId;
|
||||
@@ -1330,6 +1343,9 @@ internal enum DeletionTarget
|
||||
|
||||
/// <summary>A tag, from the vault screen.</summary>
|
||||
Tag,
|
||||
|
||||
/// <summary>A saved Spelunk key, from the Security page.</summary>
|
||||
SpelunkKey,
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -1469,7 +1485,8 @@ internal sealed partial class VaultViewModel(
|
||||
Func<string, Task>? copyToClipboard = null,
|
||||
ConnectionRecorder? connectionLog = null,
|
||||
VaultVisibility? visibility = null,
|
||||
ISshReachabilityProbe? reachability = null) : ObservableObject, IAsyncDisposable
|
||||
ISshReachabilityProbe? reachability = null,
|
||||
ISpelunkTunnel? spelunk = null) : ObservableObject, IAsyncDisposable
|
||||
{
|
||||
/// <summary>What explains a failed connection when no caller supplied something else.</summary>
|
||||
/// <remarks>
|
||||
@@ -2387,6 +2404,14 @@ internal sealed partial class VaultViewModel(
|
||||
|
||||
internal bool HasVaultItems => VaultItems.Count > 0;
|
||||
|
||||
/// <summary>Whether any row in the keychain table names a vault, which is whether its VAULT column has a heading.</summary>
|
||||
/// <remarks>
|
||||
/// Read off the rows rather than off how many vaults there are, because a row's badge is what the column
|
||||
/// holds: the two agree today — see <see cref="VaultItemRowViewModel.VaultBadge"/> — and if they ever stop
|
||||
/// agreeing, a heading over nothing is the thing this exists to avoid.
|
||||
/// </remarks>
|
||||
internal bool ShowsVaultColumn => VaultItems.Any(row => row.HasVaultBadge);
|
||||
|
||||
internal bool HasSelectedVaultItem => SelectedVaultItem is not null;
|
||||
|
||||
/// <summary>
|
||||
@@ -3722,6 +3747,196 @@ internal sealed partial class VaultViewModel(
|
||||
EditorNewPin = string.Empty;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The port forwards on the host being edited, staged the way <see cref="EditorPinnedPaths"/> is.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Populated when the editor opens, changed by <see cref="AddEditorForward"/> and
|
||||
/// <see cref="RemoveEditorForward"/>, read back by <see cref="BuildHost"/> on Save. A rule keeps its id
|
||||
/// through the editor, which is what lets the merge tell an edited forward from a new one.
|
||||
/// </remarks>
|
||||
internal ObservableCollection<PortForwardRule> EditorPortForwards { get; } = [];
|
||||
|
||||
/// <summary>The add row's kind, as the index of <see cref="PortForwardKind"/>: local, remote, dynamic.</summary>
|
||||
[ObservableProperty]
|
||||
[NotifyPropertyChangedFor(nameof(EditorNewForwardHasTarget))]
|
||||
[NotifyPropertyChangedFor(nameof(EditorNewForwardBindHint))]
|
||||
[NotifyPropertyChangedFor(nameof(EditorNewForwardKindHint))]
|
||||
private int editorNewForwardKind;
|
||||
|
||||
/// <summary>The add row's listening port, as typed.</summary>
|
||||
[ObservableProperty]
|
||||
private string editorNewForwardBindPort = string.Empty;
|
||||
|
||||
/// <summary>The add row's target, as <c>host:port</c>.</summary>
|
||||
[ObservableProperty]
|
||||
private string editorNewForwardTarget = string.Empty;
|
||||
|
||||
/// <summary>Whether the add row's kind has a target at all; a dynamic forward does not.</summary>
|
||||
internal bool EditorNewForwardHasTarget => (PortForwardKind)EditorNewForwardKind is not PortForwardKind.Dynamic;
|
||||
|
||||
/// <summary>The add row's listening-port placeholder: short, because the box is narrow.</summary>
|
||||
internal string EditorNewForwardBindHint => (PortForwardKind)EditorNewForwardKind switch
|
||||
{
|
||||
PortForwardKind.Remote => "remote port",
|
||||
PortForwardKind.Dynamic => "SOCKS port",
|
||||
_ => "local port",
|
||||
};
|
||||
|
||||
/// <summary>
|
||||
/// What the add row's kind does, in a sentence naming which end each port is on — the thing people get
|
||||
/// backwards about <c>-L</c> and <c>-R</c>.
|
||||
/// </summary>
|
||||
internal string EditorNewForwardKindHint => (PortForwardKind)EditorNewForwardKind switch
|
||||
{
|
||||
PortForwardKind.Remote =>
|
||||
"A port on the remote, carried back to a host:port as this machine sees it.",
|
||||
PortForwardKind.Dynamic =>
|
||||
"A SOCKS proxy on this machine. Each connection through it leaves from the remote.",
|
||||
_ => "A port on this machine, carried to a host:port as the remote sees it.",
|
||||
};
|
||||
|
||||
/// <summary>
|
||||
/// Adds a forward to the host being edited, from the editor's add row.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Validated here rather than at Save, for the reason <see cref="AddEditorPin"/> is: a refusal at the
|
||||
/// box that caused it costs nothing else on the form. The rule's own
|
||||
/// <see cref="PortForwardRule.TryValidate"/> is the check, so this cannot drift from what the codec
|
||||
/// accepts.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>A second listener on a port this host already listens on is refused here</b>, though the domain
|
||||
/// allows it — it has to, because two machines each adding one is what a merge produces. Here it is one
|
||||
/// person, and the second would only ever fail to start.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
[RelayCommand]
|
||||
private void AddEditorForward()
|
||||
{
|
||||
var kind = (PortForwardKind)EditorNewForwardKind;
|
||||
|
||||
if (!int.TryParse(EditorNewForwardBindPort.Trim(), NumberStyles.None, CultureInfo.InvariantCulture, out var bindPort))
|
||||
{
|
||||
Status = "A forward needs a listening port, as a number.";
|
||||
return;
|
||||
}
|
||||
|
||||
string? targetHost = null;
|
||||
int? targetPort = null;
|
||||
|
||||
if (kind is not PortForwardKind.Dynamic)
|
||||
{
|
||||
if (!TryParseForwardTarget(EditorNewForwardTarget, out targetHost, out targetPort))
|
||||
{
|
||||
Status = "A forward's target is host:port, for example db.internal:5432.";
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
var rule = new PortForwardRule
|
||||
{
|
||||
Id = Guid.CreateVersion7(),
|
||||
Kind = kind,
|
||||
BindPort = bindPort,
|
||||
TargetHost = targetHost,
|
||||
TargetPort = targetPort,
|
||||
};
|
||||
|
||||
if (!rule.TryValidate(out var reason))
|
||||
{
|
||||
Status = reason;
|
||||
return;
|
||||
}
|
||||
|
||||
if (EditorPortForwards.Count >= HostSecret.MaxPortForwards)
|
||||
{
|
||||
Status = $"A host cannot carry more than {HostSecret.MaxPortForwards} port forwards.";
|
||||
return;
|
||||
}
|
||||
|
||||
// Local and dynamic forwards both listen on this machine, so they share its ports; a remote forward
|
||||
// listens on the remote, which is a different set.
|
||||
var listensHere = kind is not PortForwardKind.Remote;
|
||||
|
||||
if (EditorPortForwards.Any(existing =>
|
||||
existing.BindPort == bindPort && existing.Kind is not PortForwardKind.Remote == listensHere))
|
||||
{
|
||||
Status = listensHere
|
||||
? $"This host already has a forward listening on port {bindPort} here."
|
||||
: $"This host already has a forward listening on port {bindPort} on the remote.";
|
||||
return;
|
||||
}
|
||||
|
||||
EditorPortForwards.Add(rule);
|
||||
EditorNewForwardBindPort = string.Empty;
|
||||
EditorNewForwardTarget = string.Empty;
|
||||
Status = string.Empty;
|
||||
}
|
||||
|
||||
/// <summary>Removes a forward from the host being edited.</summary>
|
||||
[RelayCommand]
|
||||
private void RemoveEditorForward(PortForwardRule? rule)
|
||||
{
|
||||
if (rule is not null)
|
||||
{
|
||||
EditorPortForwards.Remove(rule);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Stages an existing host's forwards for editing. See <see cref="EditorPortForwards"/>.</summary>
|
||||
private void LoadEditorPortForwards(PortForwardList forwards)
|
||||
{
|
||||
EditorPortForwards.Clear();
|
||||
|
||||
foreach (var forward in forwards)
|
||||
{
|
||||
EditorPortForwards.Add(forward);
|
||||
}
|
||||
|
||||
EditorNewForwardKind = (int)PortForwardKind.Local;
|
||||
EditorNewForwardBindPort = string.Empty;
|
||||
EditorNewForwardTarget = string.Empty;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Reads <c>host:port</c>, with an IPv6 literal in brackets as OpenSSH writes one: <c>[::1]:5432</c>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Split at the last colon, so an unbracketed IPv6 address fails to parse as a port rather than being
|
||||
/// cut somewhere in its middle. The host is checked by the rule, not here.
|
||||
/// </remarks>
|
||||
internal static bool TryParseForwardTarget(string text, out string? host, out int? port)
|
||||
{
|
||||
host = null;
|
||||
port = null;
|
||||
|
||||
var trimmed = text.Trim();
|
||||
var colon = trimmed.LastIndexOf(':');
|
||||
|
||||
if (colon <= 0
|
||||
|| !int.TryParse(trimmed.AsSpan(colon + 1), NumberStyles.None, CultureInfo.InvariantCulture, out var parsed))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
var name = trimmed[..colon];
|
||||
|
||||
if (name.StartsWith('[') && name.EndsWith(']'))
|
||||
{
|
||||
name = name[1..^1];
|
||||
}
|
||||
else if (name.Contains(':', StringComparison.Ordinal))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
host = name;
|
||||
port = parsed;
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>The item being edited, or null when creating.</summary>
|
||||
private Guid? editingEntityId;
|
||||
|
||||
@@ -4104,10 +4319,15 @@ internal sealed partial class VaultViewModel(
|
||||
/// and now means "take the group's" — so reading the ids directly would put a password box in front of
|
||||
/// every host under a group that binds a key, and the box would do nothing.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// False for a host Spelunk signs in to, whatever it resolves to: there is nothing to type, and a box —
|
||||
/// or on the phone, a sheet — asking for a password there would be a question with no use for its answer.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal bool SelectedHostAsksForAPassword =>
|
||||
SelectedHost is null
|
||||
|| SelectedHost.Resolved.Binding.Kind is ResolvedBindingKind.TypedPassword;
|
||||
|| (!SelectedHost.Host.SignsInThroughSpelunk
|
||||
&& SelectedHost.Resolved.Binding.Kind is ResolvedBindingKind.TypedPassword);
|
||||
|
||||
/// <summary>
|
||||
/// What the terminal column says in place of the password box, or nothing when the box is showing.
|
||||
@@ -4126,11 +4346,13 @@ internal sealed partial class VaultViewModel(
|
||||
/// changed.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal string SelectedHostAuthenticationNote => SelectedHost?.Resolved.Binding switch
|
||||
internal string SelectedHostAuthenticationNote => SelectedHost switch
|
||||
{
|
||||
{ Kind: ResolvedBindingKind.Credential } binding =>
|
||||
{ Host.SignsInThroughSpelunk: true } =>
|
||||
"Spelunk signs you in to this host with a one-time key; no SSH key or password is needed.",
|
||||
{ Resolved.Binding: { Kind: ResolvedBindingKind.Credential } binding } =>
|
||||
$"This host uses a password stored in your keychain{From(binding)}.",
|
||||
{ Kind: ResolvedBindingKind.SshKey } binding =>
|
||||
{ Resolved.Binding: { Kind: ResolvedBindingKind.SshKey } binding } =>
|
||||
$"This host authenticates with an SSH key{From(binding)}.",
|
||||
_ => string.Empty,
|
||||
};
|
||||
@@ -4159,14 +4381,19 @@ internal sealed partial class VaultViewModel(
|
||||
/// <remarks>
|
||||
/// A sentence for "nobody" rather than the em dash the card uses. The card is a column of aligned facts
|
||||
/// where a dash reads as "none"; this is a field in a form, and an empty-looking one would read as a
|
||||
/// value that had not loaded.
|
||||
/// value that had not loaded. A host Spelunk signs in to logs in as whatever Spelunk names, so it says
|
||||
/// that rather than a username the connection will not use.
|
||||
/// </remarks>
|
||||
internal string SelectedHostUsernameLabel => SelectedHost?.Resolved.Username.Value is { Length: > 0 } user
|
||||
? user
|
||||
: "no account set";
|
||||
internal string SelectedHostUsernameLabel => SelectedHost switch
|
||||
{
|
||||
{ Host.SignsInThroughSpelunk: true } => "named by Spelunk",
|
||||
{ Resolved.Username.Value: { Length: > 0 } user } => user,
|
||||
_ => "no account set",
|
||||
};
|
||||
|
||||
/// <inheritdoc cref="SelectedHostPortIsInherited" />
|
||||
internal bool SelectedHostUsernameIsInherited => SelectedHost?.Resolved.Username.IsInherited ?? false;
|
||||
internal bool SelectedHostUsernameIsInherited =>
|
||||
SelectedHost is { Host.SignsInThroughSpelunk: false, Resolved.Username.IsInherited: true };
|
||||
|
||||
/// <summary>
|
||||
/// What the pane names in the credentials row: the key or password this host authenticates with.
|
||||
@@ -4182,11 +4409,12 @@ internal sealed partial class VaultViewModel(
|
||||
/// the reference is allowed to dangle, and a GUID in a field is not an answer to anything.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal string SelectedHostBindingLabel => SelectedHost?.Resolved.Binding switch
|
||||
internal string SelectedHostBindingLabel => SelectedHost switch
|
||||
{
|
||||
{ Kind: ResolvedBindingKind.SshKey, EntityId: { } id } =>
|
||||
{ Host.SignsInThroughSpelunk: true } => SpelunkSignInIdentity,
|
||||
{ Resolved.Binding: { Kind: ResolvedBindingKind.SshKey, EntityId: { } id } } =>
|
||||
Keys.FirstOrDefault(key => key.EntityId == id)?.Label ?? "(a key that is no longer here)",
|
||||
{ Kind: ResolvedBindingKind.Credential, EntityId: { } id } =>
|
||||
{ Resolved.Binding: { Kind: ResolvedBindingKind.Credential, EntityId: { } id } } =>
|
||||
Credentials.FirstOrDefault(credential => credential.EntityId == id)?.Label
|
||||
?? "(a password that is no longer here)",
|
||||
_ => string.Empty,
|
||||
@@ -4331,6 +4559,7 @@ internal sealed partial class VaultViewModel(
|
||||
unreadable += await ReloadKeysAsync(cancellationToken).ConfigureAwait(true);
|
||||
unreadable += await ReloadCredentialsAsync(cancellationToken).ConfigureAwait(true);
|
||||
unreadable += await ReloadObjectStoresAsync(cancellationToken).ConfigureAwait(true);
|
||||
unreadable += await ReloadSpelunkKeysAsync(cancellationToken).ConfigureAwait(true);
|
||||
unreadable += await ReloadSnippetsAsync(cancellationToken).ConfigureAwait(true);
|
||||
|
||||
// Last, because it reads the host list to work out which pins nothing dials any more.
|
||||
@@ -4385,6 +4614,7 @@ internal sealed partial class VaultViewModel(
|
||||
// longer say what the user chose.
|
||||
var authentication = EditorSelectedAuthentication;
|
||||
var groupId = EditorSelectedGroup?.EntityId;
|
||||
var spelunkKeyId = EditorSelectedSpelunkKey?.EntityId;
|
||||
|
||||
BuildTagChoices();
|
||||
|
||||
@@ -4403,6 +4633,8 @@ internal sealed partial class VaultViewModel(
|
||||
authentication?.Kind == AuthenticationKind.Credential ? authentication.EntityId : null,
|
||||
asksForPassword: authentication?.Kind == AuthenticationKind.Typed,
|
||||
grouped: EditorSelectedGroup?.EntityId is not null);
|
||||
|
||||
BuildSpelunkKeyChoices(spelunkKeyId);
|
||||
}
|
||||
|
||||
if (IsEditingGroup)
|
||||
@@ -7542,11 +7774,13 @@ internal sealed partial class VaultViewModel(
|
||||
EditorUsername = string.Empty;
|
||||
EditorNotes = string.Empty;
|
||||
EditorRelayEnabled = false;
|
||||
LoadEditorSpelunk(route: null);
|
||||
editorTagIds = TagSet.Empty;
|
||||
EditorNewTag = string.Empty;
|
||||
BuildTagChoices();
|
||||
EditorPinnedPaths.Clear();
|
||||
EditorNewPin = string.Empty;
|
||||
LoadEditorPortForwards(PortForwardList.Empty);
|
||||
|
||||
// Closed rather than carried over, and it holds a password — see EditorNewCredentialPassword.
|
||||
ClearEditorCredentialForm();
|
||||
@@ -7632,6 +7866,7 @@ internal sealed partial class VaultViewModel(
|
||||
EditorUsername = row.Host.Username ?? string.Empty;
|
||||
EditorNotes = row.Host.Notes ?? string.Empty;
|
||||
EditorRelayEnabled = row.Host.RelayEnabled;
|
||||
LoadEditorSpelunk(row.Host.Spelunk);
|
||||
editorTagIds = row.Host.TagIds;
|
||||
EditorNewTag = string.Empty;
|
||||
BuildTagChoices();
|
||||
@@ -7640,6 +7875,7 @@ internal sealed partial class VaultViewModel(
|
||||
ClearEditorCredentialForm();
|
||||
|
||||
LoadEditorPinnedPaths(row.Host.PinnedPaths);
|
||||
LoadEditorPortForwards(row.Host.PortForwards);
|
||||
|
||||
BuildEditorVaultChoices(editingHostVaultId);
|
||||
BuildGroupChoices(row.Host.GroupId);
|
||||
@@ -8610,53 +8846,94 @@ internal sealed partial class VaultViewModel(
|
||||
ArgumentNullException.ThrowIfNull(requests);
|
||||
|
||||
var target = vaultId ?? session.ActiveVaultId;
|
||||
var hosts = 0;
|
||||
var keys = 0;
|
||||
var refused = 0;
|
||||
var tally = new ImportTally();
|
||||
var ran = false;
|
||||
string? failure = null;
|
||||
|
||||
await RunAsync(
|
||||
requests.Count == 1 ? "Importing 1 host…" : $"Importing {requests.Count} hosts…",
|
||||
async () =>
|
||||
{
|
||||
// Keyed on the path rather than on the material, and filled as the batch runs rather than up
|
||||
// front: the second host naming a file has to land on the id the first one produced, and
|
||||
// nothing is reloaded until the batch finishes.
|
||||
var bound = new Dictionary<string, Guid>(StringComparer.OrdinalIgnoreCase);
|
||||
ran = true;
|
||||
|
||||
foreach (var request in requests)
|
||||
try
|
||||
{
|
||||
if (!request.Host.TryValidate(out _))
|
||||
{
|
||||
refused++;
|
||||
continue;
|
||||
}
|
||||
|
||||
var (keyId, created) = await BindImportedKeyAsync(
|
||||
request, bound, target, cancellationToken)
|
||||
.ConfigureAwait(true);
|
||||
|
||||
if (created)
|
||||
{
|
||||
keys++;
|
||||
}
|
||||
|
||||
var host = keyId is { } id ? request.Host with { SshKeyId = id } : request.Host;
|
||||
|
||||
await session.Hosts
|
||||
.CreateAsync(target, host, cancellationToken)
|
||||
.ConfigureAwait(true);
|
||||
|
||||
hosts++;
|
||||
await ImportEachAsync(requests, target, tally, cancellationToken).ConfigureAwait(true);
|
||||
}
|
||||
catch (Exception exception) when (exception is not OutOfMemoryException
|
||||
and not OperationCanceledException)
|
||||
{
|
||||
// Reported, and the hosts written before it are still reloaded below: they are in the
|
||||
// keychain whether or not the rest followed, and the screen has to say both.
|
||||
failure = exception.Message;
|
||||
}
|
||||
|
||||
await ReloadAsync(cancellationToken).ConfigureAwait(true);
|
||||
|
||||
Status = DescribeImport(hosts, keys, refused);
|
||||
Status = DescribeImport(tally.Hosts, tally.Keys, tally.Refused)
|
||||
+ (failure is null ? string.Empty : $" The import stopped early: {failure}");
|
||||
}).ConfigureAwait(true);
|
||||
|
||||
if (!ran)
|
||||
{
|
||||
// RunAsync returns at once while anything else is running — a sync pass, a save — and the
|
||||
// screen asking would otherwise have said it imported nothing as though that were the result.
|
||||
failure = "the keychain was busy with something else. Nothing was imported; try again.";
|
||||
}
|
||||
|
||||
await AutoSyncAsync(cancellationToken).ConfigureAwait(true);
|
||||
|
||||
return new ImportOutcome(hosts, keys);
|
||||
return new ImportOutcome(tally.Hosts, tally.Keys, tally.Refused, failure);
|
||||
}
|
||||
|
||||
/// <summary>Writes each host of an import, and any key it brought, counting as it goes.</summary>
|
||||
/// <remarks>
|
||||
/// Counted into <paramref name="tally"/> rather than returned, so that when a write fails partway the
|
||||
/// caller still knows how many landed before it — which is what it has to tell the person.
|
||||
/// </remarks>
|
||||
private async Task ImportEachAsync(
|
||||
IReadOnlyList<ImportedHostRequest> batch,
|
||||
Guid into,
|
||||
ImportTally tally,
|
||||
CancellationToken token)
|
||||
{
|
||||
// Keyed on the path rather than on the material, and filled as the batch runs rather than up
|
||||
// front: the second host naming a file has to land on the id the first one produced, and nothing
|
||||
// is reloaded until the batch finishes.
|
||||
var bound = new Dictionary<string, Guid>(StringComparer.OrdinalIgnoreCase);
|
||||
|
||||
foreach (var request in batch)
|
||||
{
|
||||
if (!request.Host.TryValidate(out _))
|
||||
{
|
||||
tally.Refused++;
|
||||
continue;
|
||||
}
|
||||
|
||||
var (keyId, created) = await BindImportedKeyAsync(request, bound, into, token)
|
||||
.ConfigureAwait(true);
|
||||
|
||||
if (created)
|
||||
{
|
||||
tally.Keys++;
|
||||
}
|
||||
|
||||
var host = keyId is { } id ? request.Host with { SshKeyId = id } : request.Host;
|
||||
|
||||
await session.Hosts.CreateAsync(into, host, token).ConfigureAwait(true);
|
||||
|
||||
tally.Hosts++;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>What one import has written so far.</summary>
|
||||
private sealed class ImportTally
|
||||
{
|
||||
internal int Hosts { get; set; }
|
||||
|
||||
internal int Keys { get; set; }
|
||||
|
||||
internal int Refused { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>Finds or stores the key an imported host should be bound to.</summary>
|
||||
@@ -10799,6 +11076,10 @@ internal sealed partial class VaultViewModel(
|
||||
await DeleteTagNowAsync(request.EntityId, cancellationToken).ConfigureAwait(true);
|
||||
break;
|
||||
|
||||
case DeletionTarget.SpelunkKey:
|
||||
await DeleteSpelunkKeyNowAsync(request.EntityId, cancellationToken).ConfigureAwait(true);
|
||||
break;
|
||||
|
||||
default:
|
||||
break;
|
||||
}
|
||||
@@ -10842,9 +11123,7 @@ internal sealed partial class VaultViewModel(
|
||||
private string HostsBoundTo(ResolvedBindingKind kind, Guid entityId)
|
||||
{
|
||||
var bound = Hosts
|
||||
.Where(row => row.Resolved.Binding is { } binding
|
||||
&& binding.Kind == kind
|
||||
&& binding.EntityId == entityId)
|
||||
.Where(row => Uses(row, kind, entityId))
|
||||
.Select(row => row.Label)
|
||||
.ToArray();
|
||||
|
||||
@@ -11671,10 +11950,13 @@ internal sealed partial class VaultViewModel(
|
||||
PhaseReporter reporter,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
// A relay refusal already says exactly what happened, and a relayed host is reached by a path the
|
||||
// probe does not take: it would dial the host directly — the route the user chose the relay because
|
||||
// they cannot use — and report on that instead.
|
||||
if (reporter.Furthest != SshConnectionPhase.Reaching || exception is ServerRelayException || target.Relayed)
|
||||
// A relay or Spelunk refusal already says exactly what happened, and a routed host is reached by a
|
||||
// path the probe does not take: it would dial the host directly — the route the user chose the relay
|
||||
// or Spelunk because they cannot use, or for a Spelunk host an address that exists only to name its
|
||||
// key — and report on that instead.
|
||||
if (reporter.Furthest != SshConnectionPhase.Reaching
|
||||
|| exception is ServerRelayException or SpelunkTunnelException
|
||||
|| target.Routed)
|
||||
{
|
||||
return exception.Message;
|
||||
}
|
||||
@@ -11779,7 +12061,11 @@ internal sealed partial class VaultViewModel(
|
||||
authentication.Username,
|
||||
authentication.Credential);
|
||||
|
||||
var sessionId = await OpenThroughAsync(target, request, reporter, cancellationToken).ConfigureAwait(true);
|
||||
var (sessionId, dialled) = await OpenThroughAsync(target, request, reporter, cancellationToken)
|
||||
.ConfigureAwait(true);
|
||||
|
||||
// The account the session actually logged in as, which a Spelunk sign-in learns only from the tunnel.
|
||||
authentication = authentication with { Username = dialled.Username };
|
||||
|
||||
// The workspace has already opened a ticket for this session, with the address and the moment it
|
||||
// connected. What it could not know is which keychain item this was — an SshConnectionRequest has no
|
||||
@@ -11810,7 +12096,8 @@ internal sealed partial class VaultViewModel(
|
||||
facts?.Cipher ?? string.Empty,
|
||||
facts?.HostKeyAlgorithm ?? string.Empty,
|
||||
authentication.IdentityLabel,
|
||||
target.HostId));
|
||||
target.HostId,
|
||||
target.Row?.Host.PortForwards));
|
||||
|
||||
// Last, and after the tab exists: keeping the password is a favour, and the session the user asked
|
||||
// for must not wait on a vault write to appear.
|
||||
@@ -11840,11 +12127,11 @@ internal sealed partial class VaultViewModel(
|
||||
/// this machine without touching the host.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Internal because file transfer opens a connection of its own and a relayed host needs the relay
|
||||
/// there too — or the transfers screen would fail for exactly the hosts the relay exists for.
|
||||
/// Reached through <see cref="OpenRouteAsync"/>, which is what both transports call — file transfer
|
||||
/// opens a connection of its own, and a relayed host needs the relay there too.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal async Task<RelayRoute> OpenRelayAsync(string label, Guid hostId, CancellationToken cancellationToken)
|
||||
private async Task<RelayRoute> OpenRelayAsync(string label, Guid hostId, CancellationToken cancellationToken)
|
||||
{
|
||||
if (await ResolveServerAsync(cancellationToken).ConfigureAwait(true) is not { } server)
|
||||
{
|
||||
@@ -11857,22 +12144,23 @@ internal sealed partial class VaultViewModel(
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Opens the session, through the relay when there is one, and puts the relay's reason on a failure.
|
||||
/// Opens the session, through the relay or Spelunk when the host uses one, and puts the route's reason on
|
||||
/// a failure.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// A relay that hung up reaches SSH.NET as a stream that ended, and it reports that the way it reports
|
||||
/// every lost transport — a sentence that reads exactly like the direct failure the relay was ticked to
|
||||
/// get around. When the relay said why it closed, that sentence is the true one and replaces it. The
|
||||
/// host key refusals are left alone: a key was presented, so the relay did its job.
|
||||
/// A route that hung up reaches SSH.NET as a stream that ended, and it reports that the way it reports
|
||||
/// every lost transport — a sentence that reads exactly like the direct failure the route was chosen to
|
||||
/// get around. When the route said why it closed, that sentence is the true one and replaces it. The
|
||||
/// host key refusals are left alone: a key was presented, so the route did its job.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// The relay is disposed on every failure. The connection owns it once it is handed over and disposes
|
||||
/// The route is disposed on every failure. The connection owns it once it is handed over and disposes
|
||||
/// it on its own failure paths too, but a throw before the factory is reached would otherwise leave a
|
||||
/// bridge listening until its own timeout; disposing twice is safe.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private async Task<uint> OpenThroughAsync(
|
||||
private async Task<(uint SessionId, SshConnectionRequest Request)> OpenThroughAsync(
|
||||
ConnectionTarget target,
|
||||
SshConnectionRequest request,
|
||||
PhaseReporter reporter,
|
||||
@@ -11880,28 +12168,30 @@ internal sealed partial class VaultViewModel(
|
||||
{
|
||||
// After the renderer rather than before it: a ticket is dead thirty seconds after issue, and the
|
||||
// renderer's wait is the one step of a connect with no bound a user would recognise.
|
||||
var relay = target.Relayed
|
||||
? await OpenRelayAsync(target.Label, target.HostId!.Value, cancellationToken).ConfigureAwait(true)
|
||||
var route = target.Row is { } row
|
||||
? await OpenRouteAsync(row, cancellationToken).ConfigureAwait(true)
|
||||
: null;
|
||||
|
||||
var through = Through(request, route);
|
||||
|
||||
try
|
||||
{
|
||||
return await workspace
|
||||
.OpenSessionAsync(
|
||||
relay is null ? request : request with { Proxy = relay.Proxy },
|
||||
TerminalSize.Default,
|
||||
reporter,
|
||||
cancellationToken)
|
||||
var sessionId = await workspace
|
||||
.OpenSessionAsync(through, TerminalSize.Default, reporter, cancellationToken)
|
||||
.ConfigureAwait(true);
|
||||
}
|
||||
catch (Exception exception) when (relay is not null)
|
||||
{
|
||||
await relay.DisposeAsync().ConfigureAwait(true);
|
||||
|
||||
if (relay.Failure is { } failure
|
||||
return (sessionId, through);
|
||||
}
|
||||
catch (Exception exception) when (route is not null)
|
||||
{
|
||||
await route.DisposeAsync().ConfigureAwait(true);
|
||||
|
||||
if (route.Failure is { } failure
|
||||
&& exception is not (OperationCanceledException or SshHostKeyUnknownException or SshHostKeyMismatchException))
|
||||
{
|
||||
throw new ServerRelayException(failure, exception);
|
||||
throw route is SpelunkTunnelRoute
|
||||
? new SpelunkTunnelException(failure, exception)
|
||||
: new ServerRelayException(failure, exception);
|
||||
}
|
||||
|
||||
throw;
|
||||
@@ -12128,13 +12418,13 @@ internal sealed partial class VaultViewModel(
|
||||
internal Guid? HostId => Row?.EntityId;
|
||||
|
||||
/// <summary>
|
||||
/// Whether this is reached through the server relay rather than dialled.
|
||||
/// Whether this is reached through the server relay or through Spelunk rather than dialled.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Only a keychain host can be: the relay dials the address the server holds for an item, and a
|
||||
/// machine typed into the manual box has no item and therefore nothing on the server to dial.
|
||||
/// Only a keychain host can be: the relay dials the address the server holds for an item, Spelunk is
|
||||
/// reached with a key the item names, and a machine typed into the manual box has neither.
|
||||
/// </remarks>
|
||||
internal bool Relayed => Row?.Host.RelayEnabled is true;
|
||||
internal bool Routed => Row?.Host is { } host && (host.RelayEnabled || host.Spelunk is not null);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -12216,8 +12506,25 @@ internal sealed partial class VaultViewModel(
|
||||
/// authenticates with a key that is not in this keychain any more" would go looking at a host that says
|
||||
/// nothing about keys.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>A host Spelunk signs in to is answered first, whatever it or its group binds</b> — see
|
||||
/// <see cref="SignedInBySpelunk"/>. It is the one host that connects with no binding, because it says so;
|
||||
/// every other host goes through <see cref="TryBuildBoundAuthentication"/> exactly as before.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private bool TryBuildAuthentication(
|
||||
HostSecret host,
|
||||
ResolvedHost resolved,
|
||||
string typedPassword,
|
||||
[NotNullWhen(true)] out HostAuthentication? authentication,
|
||||
[NotNullWhen(false)] out string? reason) =>
|
||||
host.SignsInThroughSpelunk
|
||||
? SignedInBySpelunk(out authentication, out reason)
|
||||
: TryBuildBoundAuthentication(host, resolved, typedPassword, out authentication, out reason);
|
||||
|
||||
/// <summary>Turns a host's resolved binding into a key, a password or a prompt, or says why it cannot.</summary>
|
||||
/// <remarks>See <see cref="TryBuildAuthentication"/>.</remarks>
|
||||
private bool TryBuildBoundAuthentication(
|
||||
HostSecret host,
|
||||
ResolvedHost resolved,
|
||||
string typedPassword,
|
||||
@@ -12282,6 +12589,27 @@ internal sealed partial class VaultViewModel(
|
||||
out reason);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// How a host Spelunk signs in to authenticates, before the tunnel that decides it is open.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Spelunk signs the host in with a key the tunnel makes and an account Spelunk names, neither of which
|
||||
/// exists yet. These stand-ins are replaced as the connection is made through the route — see
|
||||
/// <see cref="Through"/> — and refused by the SSH layer if they ever reach it. It is the only way to
|
||||
/// connect without a binding, and only for a host that says so; every other host still needs one.
|
||||
/// </remarks>
|
||||
private static bool SignedInBySpelunk(
|
||||
[NotNullWhen(true)] out HostAuthentication? authentication,
|
||||
out string? reason)
|
||||
{
|
||||
authentication = new HostAuthentication(
|
||||
SpelunkSignIn.DefaultUser,
|
||||
SpelunkSignInPending.Instance,
|
||||
SpelunkSignInIdentity);
|
||||
reason = null;
|
||||
return true;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The last thing every branch has to agree on: there is somebody to log in as.
|
||||
/// </summary>
|
||||
@@ -12343,6 +12671,10 @@ internal sealed partial class VaultViewModel(
|
||||
Notes = string.IsNullOrWhiteSpace(EditorNotes) ? null : EditorNotes,
|
||||
RelayEnabled = EditorRelayEnabled,
|
||||
|
||||
// Null unless the box is ticked, whatever the fields below it still hold: unticking is how a host
|
||||
// goes back to being dialled, and it must not keep a route the user just turned off.
|
||||
Spelunk = BuildSpelunkRoute(),
|
||||
|
||||
// Only ever true or null, never false: the two would mean the same thing, and writing false would
|
||||
// change the bytes of every host that has never touched this. See HostSecret.AsksForPassword.
|
||||
//
|
||||
@@ -12350,7 +12682,9 @@ internal sealed partial class VaultViewModel(
|
||||
// an ungrouped host's picker offers no "Inherit", so its "Password (ask each time)" is the
|
||||
// absence of a decision rather than one, and storing it as a decision would pin every ungrouped
|
||||
// host in the vault the first time it was edited.
|
||||
AsksForPassword = EditorSelectedAuthentication?.Kind == AuthenticationKind.Typed
|
||||
// Never beside a Spelunk sign-in, nor are the bindings below: a host has one way to log in.
|
||||
AsksForPassword = EditorAsksForLogin
|
||||
&& EditorSelectedAuthentication?.Kind == AuthenticationKind.Typed
|
||||
&& EditorSelectedGroup?.EntityId is not null
|
||||
? true
|
||||
: null,
|
||||
@@ -12367,6 +12701,9 @@ internal sealed partial class VaultViewModel(
|
||||
// than twice.
|
||||
PinnedPaths = PinnedPathList.Create(EditorPinnedPaths),
|
||||
|
||||
// The staged list, in the order it was built; each rule keeps the id it arrived with.
|
||||
PortForwards = PortForwardList.Create(EditorPortForwards),
|
||||
|
||||
// Both read off the one picker, including the id of something that has gone missing. Reading them
|
||||
// from the picker rather than carrying the originals through is what lets a binding be removed at
|
||||
// all, and preserving a missing id is what stops an unrelated edit removing one by accident. One
|
||||
@@ -12382,7 +12719,9 @@ internal sealed partial class VaultViewModel(
|
||||
|
||||
/// <summary>The picker's selection, if it names something of this kind.</summary>
|
||||
private Guid? Bound(AuthenticationKind kind) =>
|
||||
EditorSelectedAuthentication is { } choice && choice.Kind == kind ? choice.EntityId : null;
|
||||
EditorAsksForLogin && EditorSelectedAuthentication is { } choice && choice.Kind == kind
|
||||
? choice.EntityId
|
||||
: null;
|
||||
|
||||
/// <summary>
|
||||
/// Fills the authentication picker, keeping whatever the host is currently bound to selectable.
|
||||
@@ -13113,8 +13452,7 @@ internal sealed partial class VaultViewModel(
|
||||
private string UsedBySummaryFor(ResolvedBindingKind kind, Guid entityId)
|
||||
{
|
||||
var names = Hosts
|
||||
.Where(row => row.Resolved.Binding is { } binding
|
||||
&& binding.Kind == kind && binding.EntityId == entityId)
|
||||
.Where(row => Uses(row, kind, entityId))
|
||||
.Select(row => row.Label)
|
||||
.ToList();
|
||||
|
||||
@@ -13127,6 +13465,16 @@ internal sealed partial class VaultViewModel(
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>Re-reads what the keychain table says about its rows as a whole.</summary>
|
||||
private void RaiseVaultItemFacts()
|
||||
{
|
||||
OnPropertyChanged(nameof(SectionSummary));
|
||||
OnPropertyChanged(nameof(HasVaultItems));
|
||||
OnPropertyChanged(nameof(ShowsVaultColumn));
|
||||
OnPropertyChanged(nameof(TotalItemCount));
|
||||
OnPropertyChanged(nameof(EmptySectionMessage));
|
||||
}
|
||||
|
||||
/// <summary>── v5b ── Narrows <see cref="VaultItems"/> to rows <see cref="ItemFilter"/> matches.</summary>
|
||||
/// <remarks>
|
||||
/// Its own method for the reason <see cref="AddTagRows"/> is out of <see cref="RebuildVaultItems"/> —
|
||||
@@ -13222,10 +13570,7 @@ internal sealed partial class VaultViewModel(
|
||||
// sync every minute would otherwise move the detail pane out from under whoever was reading it.
|
||||
SelectedVaultItem = VaultItems.FirstOrDefault(row => row.EntityId == selectedId);
|
||||
|
||||
OnPropertyChanged(nameof(SectionSummary));
|
||||
OnPropertyChanged(nameof(HasVaultItems));
|
||||
OnPropertyChanged(nameof(TotalItemCount));
|
||||
OnPropertyChanged(nameof(EmptySectionMessage));
|
||||
RaiseVaultItemFacts();
|
||||
|
||||
// A reload replaces every row object, and the selection is restored by id — so the setter above may
|
||||
// not have fired even though the row this answers about is a different instance. Asked again here,
|
||||
@@ -13309,8 +13654,7 @@ internal sealed partial class VaultViewModel(
|
||||
|
||||
if (kind is { } resolvedKind && value is not null)
|
||||
{
|
||||
foreach (var row in Hosts.Where(row => row.Resolved.Binding is { } binding
|
||||
&& binding.Kind == resolvedKind && binding.EntityId == value.EntityId))
|
||||
foreach (var row in Hosts.Where(row => Uses(row, resolvedKind, value.EntityId)))
|
||||
{
|
||||
SelectedItemUsedByHosts.Add(new UsedByHostRowViewModel(row.Label, row.IsConnected));
|
||||
}
|
||||
|
||||
@@ -1639,11 +1639,32 @@ internal sealed partial class VaultsViewModel(
|
||||
}
|
||||
|
||||
// Fire-and-forget on purpose, and the only place in this class that is: selection changes come
|
||||
// from a list box, which has no cancellation token and no way to await. Wrapped here rather than
|
||||
// inside the read, because the read is also awaited from inside a reload that already holds the
|
||||
// busy gate — and a second RunAsync there would find the gate held by its own caller and skip the
|
||||
// members list entirely.
|
||||
_ = RunAsync(() => LoadSelectedAsync(CancellationToken.None));
|
||||
// from a list box, which has no cancellation token and no way to await.
|
||||
//
|
||||
// ◆ Not through RunAsync. Its busy gate returns at once while anything else runs — the first load,
|
||||
// a share, a reload — so a vault chosen in that moment never had its people read, and the panel
|
||||
// went on showing the previous vault's under the new one's name, with SHARE and REVOKE acting on
|
||||
// that mixture. The read does not need the gate: LoadSelectedAsync bumps the selection generation,
|
||||
// and every answer for an earlier selection is discarded by it.
|
||||
_ = LoadSelectionAsync();
|
||||
}
|
||||
|
||||
/// <summary>Reads the newly selected vault's people, turning a failure into a sentence.</summary>
|
||||
private async Task LoadSelectionAsync()
|
||||
{
|
||||
try
|
||||
{
|
||||
await LoadSelectedAsync(CancellationToken.None).ConfigureAwait(true);
|
||||
}
|
||||
catch (DodoSshApiException exception)
|
||||
{
|
||||
Status = exception.Message;
|
||||
}
|
||||
catch (Exception exception) when (exception is not OutOfMemoryException
|
||||
and not OperationCanceledException)
|
||||
{
|
||||
Status = exception.Message;
|
||||
}
|
||||
}
|
||||
|
||||
partial void OnPendingActionChanged(VaultActionRequest? value)
|
||||
|
||||
@@ -64,6 +64,22 @@ public interface IKnownHostStore
|
||||
/// </remarks>
|
||||
ValueTask<string?> FindAsync(string host, int port, string algorithm, CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>Returns every key pinned for one endpoint, whatever the algorithm.</summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// ◆ <b>What stops a pin being sidestepped by changing algorithm.</b> <see cref="FindAsync"/> answers
|
||||
/// per algorithm, so on its own a host pinned for <c>ssh-ed25519</c> that is answered by somebody offering
|
||||
/// only <c>ecdsa-sha2-nistp256</c> looks like a host never seen before — and "never seen before" is a
|
||||
/// question the user is asked, where "changed" is a refusal. Knowing the endpoint has pins at all is what
|
||||
/// lets the connection factory tell the two apart; see <c>SshNetConnectionFactory</c>.
|
||||
/// </para>
|
||||
/// <para>The same rule as <see cref="FindAsync"/>: no I/O.</para>
|
||||
/// </remarks>
|
||||
ValueTask<IReadOnlyList<HostKeyPresentation>> FindForEndpointAsync(
|
||||
string host,
|
||||
int port,
|
||||
CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>Records a host key as trusted.</summary>
|
||||
ValueTask TrustAsync(HostKeyPresentation presentation, CancellationToken cancellationToken);
|
||||
|
||||
@@ -156,6 +172,22 @@ public sealed class InMemoryKnownHostStore : IKnownHostStore
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public ValueTask<IReadOnlyList<HostKeyPresentation>> FindForEndpointAsync(
|
||||
string host,
|
||||
int port,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
lock (gate)
|
||||
{
|
||||
IReadOnlyList<HostKeyPresentation> found = pins.Values
|
||||
.Where(pin => KnownHostIdentity.Comparer.Equals(pin.Host, host) && pin.Port == port)
|
||||
.ToArray();
|
||||
|
||||
return ValueTask.FromResult(found);
|
||||
}
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public ValueTask TrustAsync(HostKeyPresentation presentation, CancellationToken cancellationToken)
|
||||
{
|
||||
|
||||
@@ -523,6 +523,14 @@ public interface IRemoteFileStore : IAsyncDisposable
|
||||
/// <param name="cancellationToken">Abandons the open.</param>
|
||||
Task<Stream> OpenWriteAsync(string path, long offset, CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>Whether <see cref="OpenWriteAsync"/> can start anywhere but the beginning.</summary>
|
||||
/// <remarks>
|
||||
/// True for SFTP, which is a file system. False for a bucket, where an object is written whole: an
|
||||
/// interrupted upload there starts again rather than resuming, and the transfer queue reads this to know
|
||||
/// — asking for an offset would be refused on every retry, leaving a row that can never finish.
|
||||
/// </remarks>
|
||||
bool CanWriteFromAnOffset => true;
|
||||
|
||||
/// <summary>Creates one directory, whose parent must exist.</summary>
|
||||
Task CreateDirectoryAsync(string path, CancellationToken cancellationToken);
|
||||
|
||||
|
||||
@@ -190,6 +190,15 @@ public interface ISshConnection : IAsyncDisposable
|
||||
|
||||
/// <summary>Opens an interactive shell with a pseudo-terminal.</summary>
|
||||
Task<ISshShellSession> OpenShellAsync(TerminalSize size, CancellationToken cancellationToken);
|
||||
|
||||
/// <summary>Starts a port forward over this connection.</summary>
|
||||
/// <remarks>
|
||||
/// Runs beside the shell on the same transport, as <c>ssh -L</c> does, and stops when the connection
|
||||
/// does. Any number may be started; each is its own listener and fails on its own.
|
||||
/// </remarks>
|
||||
/// <exception cref="ArgumentException">The spec is not valid; see <see cref="SshPortForwardSpec.TryValidate"/>.</exception>
|
||||
/// <exception cref="SshPortForwardException">The forward could not be started, with a message saying why.</exception>
|
||||
Task<ISshPortForward> StartForwardAsync(SshPortForwardSpec spec, CancellationToken cancellationToken);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
|
||||
@@ -187,7 +187,13 @@ public sealed class SshNetConnectionFactory(IKnownHostStore knownHosts)
|
||||
IProgress<SshConnectionPhase>? progress,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
var gate = new HostKeyGate(knownHosts, request, progress, cancellationToken);
|
||||
var endpointPins = await knownHosts
|
||||
.FindForEndpointAsync(request.Host, request.Port, cancellationToken)
|
||||
.ConfigureAwait(false);
|
||||
|
||||
PreferPinnedAlgorithms(client.ConnectionInfo, endpointPins);
|
||||
|
||||
var gate = new HostKeyGate(knownHosts, request, endpointPins, progress, cancellationToken);
|
||||
|
||||
client.HostKeyReceived += gate.OnHostKeyReceived;
|
||||
|
||||
@@ -217,17 +223,73 @@ public sealed class SshNetConnectionFactory(IKnownHostStore knownHosts)
|
||||
return gate;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Offers the host key algorithms this endpoint has pins for ahead of every other.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// The server takes the first algorithm in the client's list that it also supports, so this is what
|
||||
/// makes a server that still holds its pinned key negotiate that key — rather than, after it gained an
|
||||
/// <c>ed25519</c> key alongside the <c>rsa</c> one that was pinned, a key nobody has approved. Without it
|
||||
/// the gate below would have to choose between refusing a legitimate server and prompting for one that
|
||||
/// may not be, which is exactly the choice it must not be left with.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// Reordered rather than restricted, so a host whose pinned keys are all gone still completes the key
|
||||
/// exchange and reaches the gate, which reports it as a changed key with both fingerprints. Restricting
|
||||
/// would fail the exchange with "no matching host key algorithm", which is true and tells nobody what
|
||||
/// happened. Cleared and refilled because that is the only way a dictionary promises an order.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private static void PreferPinnedAlgorithms(
|
||||
ConnectionInfo info,
|
||||
IReadOnlyList<HostKeyPresentation> pins)
|
||||
{
|
||||
if (pins.Count == 0)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
var pinned = pins
|
||||
.Select(pin => pin.Algorithm)
|
||||
.ToHashSet(StringComparer.Ordinal);
|
||||
|
||||
var ordered = info.HostKeyAlgorithms
|
||||
.OrderBy(algorithm => pinned.Contains(algorithm.Key) ? 0 : 1)
|
||||
.ToList();
|
||||
|
||||
info.HostKeyAlgorithms.Clear();
|
||||
|
||||
foreach (var algorithm in ordered)
|
||||
{
|
||||
info.HostKeyAlgorithms.Add(algorithm.Key, algorithm.Value);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Decides host key trust during the handshake, and remembers enough to explain a refusal.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Separate from the connect method because the decision is the security-relevant part and reads
|
||||
/// better on its own: pinned and equal accepts, pinned and different refuses as a mismatch,
|
||||
/// unpinned refuses as unknown. There is no fourth branch, and there is no prompt.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// ◆ <b>"Pinned" means pinned for this endpoint, not for this algorithm.</b> Pins are stored per
|
||||
/// algorithm, and an endpoint whose pins are all for other algorithms used to fall through to "unknown"
|
||||
/// — so somebody in the middle who simply offered a different key type got the first-use question
|
||||
/// instead of the hard refusal a pin exists to produce. Now a key under an algorithm with no pin of its
|
||||
/// own is accepted only if it is the same key as one that is pinned (an RSA key is one key under
|
||||
/// <c>rsa-sha2-256</c> and <c>rsa-sha2-512</c>, and its fingerprint says so), and is otherwise a
|
||||
/// mismatch against the endpoint's pin. <see cref="PreferPinnedAlgorithms"/> is what keeps that from
|
||||
/// refusing a server that still has its pinned key.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private sealed class HostKeyGate(
|
||||
IKnownHostStore knownHosts,
|
||||
SshConnectionRequest request,
|
||||
IReadOnlyList<HostKeyPresentation> endpointPins,
|
||||
IProgress<SshConnectionPhase>? progress,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
@@ -264,13 +326,21 @@ public sealed class SshNetConnectionFactory(IKnownHostStore knownHosts)
|
||||
.GetAwaiter()
|
||||
.GetResult();
|
||||
|
||||
if (pinned is null)
|
||||
if (pinned is null && endpointPins.Count == 0)
|
||||
{
|
||||
// Refused, not prompted. The caller decides, off the handshake thread.
|
||||
e.CanTrust = false;
|
||||
return;
|
||||
}
|
||||
|
||||
// Nothing pinned under this algorithm, but the endpoint has pins: the same key under another
|
||||
// algorithm's name if any pin's fingerprint is this one, and otherwise a changed key, measured
|
||||
// against the endpoint's first pin. See the class remarks.
|
||||
pinned ??= endpointPins
|
||||
.FirstOrDefault(pin => SshHostKeyFingerprint.Equal(pin.Fingerprint, presentation.Fingerprint))
|
||||
?.Fingerprint
|
||||
?? endpointPins[0].Fingerprint;
|
||||
|
||||
var matches = SshHostKeyFingerprint.Equal(pinned, presentation.Fingerprint);
|
||||
mismatch = !matches;
|
||||
e.CanTrust = matches;
|
||||
@@ -417,6 +487,14 @@ internal sealed class SshNetConnection(
|
||||
return Task.FromResult<ISshShellSession>(new SshNetShellSession(shell, client));
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task<ISshPortForward> StartForwardAsync(SshPortForwardSpec spec, CancellationToken cancellationToken)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(spec);
|
||||
|
||||
return SshNetPortForward.StartAsync(client, spec, cancellationToken);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public async ValueTask DisposeAsync()
|
||||
{
|
||||
|
||||
@@ -0,0 +1,223 @@
|
||||
using System.Globalization;
|
||||
using System.Net;
|
||||
using System.Net.Sockets;
|
||||
using Renci.SshNet;
|
||||
using Renci.SshNet.Common;
|
||||
|
||||
namespace DodoSSH.Client.Ssh;
|
||||
|
||||
/// <summary>A forward over an SSH.NET client.</summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// One class for all three kinds, because SSH.NET's three share a base with the only members this needs —
|
||||
/// <c>Start</c>, <c>Stop</c>, <c>IsStarted</c> and the <c>Exception</c> event — and differ only in how they
|
||||
/// are built and where their bound port is read from.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// ◆ <b>Started and stopped off the calling thread.</b> A remote forward's <c>Start</c> sends
|
||||
/// <c>tcpip-forward</c> and blocks until the server answers, and every kind's <c>Stop</c> waits for its open
|
||||
/// channels to drain. Either would otherwise hold the UI thread for a round trip or longer.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
internal sealed class SshNetPortForward : ISshPortForward
|
||||
{
|
||||
/// <summary>Where every listener on this machine binds. See <see cref="SshPortForwardSpec"/>.</summary>
|
||||
private const string LoopbackAddress = "127.0.0.1";
|
||||
|
||||
private readonly SshClient client;
|
||||
private readonly ForwardedPort port;
|
||||
|
||||
private string? lastError;
|
||||
private int disposed;
|
||||
|
||||
private SshNetPortForward(SshClient client, ForwardedPort port, SshPortForwardSpec spec)
|
||||
{
|
||||
this.client = client;
|
||||
this.port = port;
|
||||
Spec = spec;
|
||||
|
||||
port.Exception += OnException;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public event EventHandler<SshPortForwardErrorEventArgs>? ErrorOccurred;
|
||||
|
||||
/// <inheritdoc />
|
||||
public SshPortForwardSpec Spec { get; }
|
||||
|
||||
/// <inheritdoc />
|
||||
public int BoundPort => port switch
|
||||
{
|
||||
ForwardedPortLocal local => (int)local.BoundPort,
|
||||
ForwardedPortDynamic dynamic => (int)dynamic.BoundPort,
|
||||
ForwardedPortRemote remote => (int)remote.BoundPort,
|
||||
_ => Spec.BindPort,
|
||||
};
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <remarks>
|
||||
/// Read off the port rather than the client: SSH.NET stops every forward on a session that ends, and
|
||||
/// <c>SshClient.IsConnected</c> throws rather than answering once the connection has been disposed.
|
||||
/// </remarks>
|
||||
public bool IsListening => Volatile.Read(ref disposed) == 0 && port.IsStarted;
|
||||
|
||||
/// <inheritdoc />
|
||||
public string? LastError => Volatile.Read(ref lastError);
|
||||
|
||||
/// <summary>Starts a forward on a connected client.</summary>
|
||||
/// <exception cref="ArgumentException">The spec is not valid.</exception>
|
||||
/// <exception cref="SshPortForwardException">The forward could not be started.</exception>
|
||||
internal static async Task<ISshPortForward> StartAsync(
|
||||
SshClient client,
|
||||
SshPortForwardSpec spec,
|
||||
CancellationToken cancellationToken)
|
||||
{
|
||||
if (!spec.TryValidate(out var reason))
|
||||
{
|
||||
throw new ArgumentException(reason, nameof(spec));
|
||||
}
|
||||
|
||||
var listener = await CreateAsync(spec, cancellationToken).ConfigureAwait(false);
|
||||
var forward = new SshNetPortForward(client, listener, spec);
|
||||
|
||||
try
|
||||
{
|
||||
client.AddForwardedPort(listener);
|
||||
|
||||
await Task.Run(listener.Start, cancellationToken).ConfigureAwait(false);
|
||||
}
|
||||
catch (Exception exception) when (exception is not OperationCanceledException)
|
||||
{
|
||||
await forward.DisposeAsync().ConfigureAwait(false);
|
||||
|
||||
throw new SshPortForwardException(Explain(spec, exception), exception);
|
||||
}
|
||||
catch
|
||||
{
|
||||
await forward.DisposeAsync().ConfigureAwait(false);
|
||||
throw;
|
||||
}
|
||||
|
||||
return forward;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
/// <remarks>
|
||||
/// Safe on a client that has already gone: SSH.NET stops its forwards when the session ends, and what
|
||||
/// is left to do then is let go of the port object, which cannot fail in a way anybody could act on.
|
||||
/// </remarks>
|
||||
public async ValueTask DisposeAsync()
|
||||
{
|
||||
if (Interlocked.Exchange(ref disposed, 1) == 1)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
port.Exception -= OnException;
|
||||
|
||||
await Task.Run(() =>
|
||||
{
|
||||
try
|
||||
{
|
||||
client.RemoveForwardedPort(port);
|
||||
}
|
||||
catch (Exception exception) when (exception is ObjectDisposedException or SshException
|
||||
or SocketException or InvalidOperationException)
|
||||
{
|
||||
// The client or its session is already gone, and took the listener with it.
|
||||
}
|
||||
|
||||
port.Dispose();
|
||||
}).ConfigureAwait(false);
|
||||
}
|
||||
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// A remote forward's target is resolved here, asynchronously, rather than by SSH.NET. Its string
|
||||
/// constructor resolves both addresses synchronously and takes whichever comes first, so
|
||||
/// <c>localhost</c> could become <c>::1</c> — which a service listening on <c>127.0.0.1</c> alone
|
||||
/// refuses — and the bound address could be sent to the remote as an IPv6 literal it has no reason to
|
||||
/// expect. IPv4 is preferred for the target for the first reason, and the bound address is the IPv4
|
||||
/// loopback literal for the second.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// A local forward's target is not resolved at all. It travels to the remote as a name in the
|
||||
/// <c>direct-tcpip</c> request, which is what lets it name a machine only the remote can see.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
private static async Task<ForwardedPort> CreateAsync(SshPortForwardSpec spec, CancellationToken cancellationToken)
|
||||
{
|
||||
switch (spec.Kind)
|
||||
{
|
||||
case SshPortForwardKind.Local:
|
||||
return new ForwardedPortLocal(
|
||||
LoopbackAddress, (uint)spec.BindPort, spec.TargetHost!, (uint)spec.TargetPort);
|
||||
|
||||
case SshPortForwardKind.Dynamic:
|
||||
return new ForwardedPortDynamic(LoopbackAddress, (uint)spec.BindPort);
|
||||
|
||||
default:
|
||||
var target = await ResolveAsync(spec.TargetHost!, cancellationToken).ConfigureAwait(false);
|
||||
|
||||
return new ForwardedPortRemote(IPAddress.Loopback, (uint)spec.BindPort, target, (uint)spec.TargetPort);
|
||||
}
|
||||
}
|
||||
|
||||
private static async Task<IPAddress> ResolveAsync(string host, CancellationToken cancellationToken)
|
||||
{
|
||||
if (IPAddress.TryParse(host, out var literal))
|
||||
{
|
||||
return literal;
|
||||
}
|
||||
|
||||
IPAddress[] addresses;
|
||||
|
||||
try
|
||||
{
|
||||
addresses = await Dns.GetHostAddressesAsync(host, cancellationToken).ConfigureAwait(false);
|
||||
}
|
||||
catch (SocketException exception)
|
||||
{
|
||||
throw new SshPortForwardException($"'{host}' could not be resolved on this machine.", exception);
|
||||
}
|
||||
|
||||
return addresses.FirstOrDefault(address => address.AddressFamily is AddressFamily.InterNetwork)
|
||||
?? addresses.FirstOrDefault()
|
||||
?? throw new SshPortForwardException($"'{host}' could not be resolved on this machine.");
|
||||
}
|
||||
|
||||
/// <summary>Says which port could not be had, and where, rather than repeating a socket error code.</summary>
|
||||
private static string Explain(SshPortForwardSpec spec, Exception exception)
|
||||
{
|
||||
var bind = spec.BindPort.ToString(CultureInfo.InvariantCulture);
|
||||
|
||||
return exception switch
|
||||
{
|
||||
SshPortForwardException own => own.Message,
|
||||
|
||||
SocketException { SocketErrorCode: SocketError.AddressAlreadyInUse } =>
|
||||
$"Port {bind} on this machine is already in use.",
|
||||
|
||||
SocketException { SocketErrorCode: SocketError.AccessDenied } =>
|
||||
$"This machine would not let DodoSSH listen on port {bind}.",
|
||||
|
||||
// What SSH.NET throws when the server answers tcpip-forward with a refusal. The server gives no
|
||||
// reason, so neither can this — but the likely ones are worth naming.
|
||||
SshException when spec.Kind is SshPortForwardKind.Remote =>
|
||||
$"The remote would not listen on port {bind}. It may be in use there, below 1024, or "
|
||||
+ "forbidden by the server's AllowTcpForwarding setting.",
|
||||
|
||||
_ => exception.Message,
|
||||
};
|
||||
}
|
||||
|
||||
/// <remarks>
|
||||
/// Raised by SSH.NET on its own threads for a connection through the forward that failed — most often a
|
||||
/// target that refused it. The listener stays up; see <see cref="ISshPortForward.LastError"/>.
|
||||
/// </remarks>
|
||||
private void OnException(object? sender, ExceptionEventArgs e)
|
||||
{
|
||||
Volatile.Write(ref lastError, e.Exception.Message);
|
||||
ErrorOccurred?.Invoke(this, new SshPortForwardErrorEventArgs(e.Exception.Message));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,164 @@
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
|
||||
namespace DodoSSH.Client.Ssh;
|
||||
|
||||
/// <summary>Which way a forward carries connections.</summary>
|
||||
/// <remarks>The three OpenSSH has, named for the flag each one is: <c>-L</c>, <c>-R</c> and <c>-D</c>.</remarks>
|
||||
public enum SshPortForwardKind
|
||||
{
|
||||
/// <summary>
|
||||
/// A port on this machine, carried to a host and port as the remote sees them. <c>ssh -L</c>.
|
||||
/// </summary>
|
||||
Local = 0,
|
||||
|
||||
/// <summary>
|
||||
/// A port on the remote, carried back to a host and port as this machine sees them. <c>ssh -R</c>.
|
||||
/// </summary>
|
||||
Remote = 1,
|
||||
|
||||
/// <summary>
|
||||
/// A SOCKS proxy on this machine, whose every connection leaves from the remote. <c>ssh -D</c>.
|
||||
/// </summary>
|
||||
Dynamic = 2,
|
||||
}
|
||||
|
||||
/// <summary>One forward to run over a connection.</summary>
|
||||
/// <param name="Kind">Which way it carries connections.</param>
|
||||
/// <param name="BindPort">
|
||||
/// The port to listen on: on this machine for <see cref="SshPortForwardKind.Local"/> and
|
||||
/// <see cref="SshPortForwardKind.Dynamic"/>, on the remote for <see cref="SshPortForwardKind.Remote"/>. Zero
|
||||
/// asks for an ephemeral port, which only a listener on this machine can report back — see
|
||||
/// <see cref="TryValidate"/>.
|
||||
/// </param>
|
||||
/// <param name="TargetHost">
|
||||
/// Where each connection goes: resolved by the remote for a local forward and by this machine for a remote
|
||||
/// one. Null for a dynamic forward, whose target is whatever each SOCKS client asks for.
|
||||
/// </param>
|
||||
/// <param name="TargetPort">The port on <paramref name="TargetHost"/>; zero for a dynamic forward.</param>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// ◆ <b>There is no bind address, and that is the point of the type.</b> Every listener this client opens
|
||||
/// is on loopback, for the reason <see cref="SshLoopbackProxy"/> gives: a forward bound to any other
|
||||
/// interface hands the remote's network to whoever else can reach this machine, for as long as the session
|
||||
/// is up. <c>ssh -L 0.0.0.0:…</c> is a flag somebody types knowing what it does; a field in a synced host
|
||||
/// that another member of the keychain filled in is not. Leaving the address out makes that
|
||||
/// unrepresentable rather than merely discouraged.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// A remote forward asks for the remote's loopback too. Whether the remote honours that is its
|
||||
/// <c>GatewayPorts</c> setting and not this client's to decide, which is the same arrangement OpenSSH has.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public sealed record SshPortForwardSpec(
|
||||
SshPortForwardKind Kind,
|
||||
int BindPort,
|
||||
string? TargetHost = null,
|
||||
int TargetPort = 0)
|
||||
{
|
||||
/// <summary>Checks the spec can be started as it stands.</summary>
|
||||
public bool TryValidate([NotNullWhen(false)] out string? reason)
|
||||
{
|
||||
if (!Enum.IsDefined(Kind))
|
||||
{
|
||||
reason = $"'{Kind}' is not a kind of forward.";
|
||||
return false;
|
||||
}
|
||||
|
||||
// A remote listener's port is chosen by the remote, and SSH.NET never reads the one it chose back,
|
||||
// so an ephemeral remote forward would be listening somewhere nobody could name.
|
||||
var lowest = Kind is SshPortForwardKind.Remote ? 1 : 0;
|
||||
|
||||
if (BindPort < lowest || BindPort > 65535)
|
||||
{
|
||||
reason = $"The listening port must be between {lowest} and 65535, not {BindPort}.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (Kind is SshPortForwardKind.Dynamic)
|
||||
{
|
||||
if (TargetHost is not null || TargetPort != 0)
|
||||
{
|
||||
reason = "A dynamic forward has no target: each connection through it names its own.";
|
||||
return false;
|
||||
}
|
||||
|
||||
reason = null;
|
||||
return true;
|
||||
}
|
||||
|
||||
if (string.IsNullOrWhiteSpace(TargetHost))
|
||||
{
|
||||
reason = "A forward needs a host to forward to.";
|
||||
return false;
|
||||
}
|
||||
|
||||
if (TargetPort is < 1 or > 65535)
|
||||
{
|
||||
reason = $"The target port must be between 1 and 65535, not {TargetPort}.";
|
||||
return false;
|
||||
}
|
||||
|
||||
reason = null;
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Why a forward is no longer carrying a connection it accepted.</summary>
|
||||
/// <param name="message">What went wrong, as SSH.NET put it.</param>
|
||||
public sealed class SshPortForwardErrorEventArgs(string message) : EventArgs
|
||||
{
|
||||
/// <summary>What went wrong.</summary>
|
||||
public string Message { get; } = message;
|
||||
}
|
||||
|
||||
/// <summary>A forward that is listening, and stops when disposed.</summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Owned by whoever started it, and also stopped by the connection it runs over: a connection that closes
|
||||
/// takes every forward on it down with it, so disposing one afterwards is safe and does nothing.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// ◆ <b>No byte counts.</b> SSH.NET copies a forwarded channel's bytes inside its own channel classes and
|
||||
/// exposes no count of them, so a figure here would be an estimate presented as a measurement.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public interface ISshPortForward : IAsyncDisposable
|
||||
{
|
||||
/// <summary>What was asked for.</summary>
|
||||
SshPortForwardSpec Spec { get; }
|
||||
|
||||
/// <summary>
|
||||
/// The port actually listened on, which differs from <see cref="SshPortForwardSpec.BindPort"/> only when
|
||||
/// that asked for an ephemeral one.
|
||||
/// </summary>
|
||||
int BoundPort { get; }
|
||||
|
||||
/// <summary>Whether the listener is still up.</summary>
|
||||
/// <remarks>
|
||||
/// False once disposed, and once the connection under it has gone — SSH.NET stops every forward on a
|
||||
/// session that ends.
|
||||
/// </remarks>
|
||||
bool IsListening { get; }
|
||||
|
||||
/// <summary>
|
||||
/// The most recent failure to carry a connection, or null if there has not been one.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// A failure here does not stop the listener. The usual cause is the target refusing one connection —
|
||||
/// a database that is down, a port nothing is on — and the next connection may well succeed.
|
||||
/// </remarks>
|
||||
string? LastError { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Raised when a connection through this forward fails, on whichever thread SSH.NET noticed it.
|
||||
/// </summary>
|
||||
event EventHandler<SshPortForwardErrorEventArgs>? ErrorOccurred;
|
||||
}
|
||||
|
||||
/// <summary>A forward that could not be started, with a sentence saying why.</summary>
|
||||
/// <remarks>
|
||||
/// What SSH.NET throws for the two commonest refusals is a socket error code and "failed to start", neither
|
||||
/// of which names the port. The message here does, and the original is kept as the inner exception.
|
||||
/// </remarks>
|
||||
public sealed class SshPortForwardException(string message, Exception? innerException = null)
|
||||
: Exception(message, innerException);
|
||||
@@ -350,6 +350,17 @@ internal sealed class SyncStateRow
|
||||
/// decide which edit wins.
|
||||
/// </remarks>
|
||||
public long ServerTimeSkewMs { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// The item types <see cref="Cursor"/> was read under, as this build names them; null before this was kept.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// A pull asks for the types this build can apply, and the cursor it gets back is past every change it
|
||||
/// read — including the changes of types it did not ask for. So a build that adds a type to that list
|
||||
/// and carries on from the old cursor never sees the items of that type made before it arrived. Kept
|
||||
/// beside the cursor so a change of list starts the pull over; see <c>SyncEngine.PullAsync</c>.
|
||||
/// </remarks>
|
||||
public string? PulledTypes { get; set; }
|
||||
}
|
||||
|
||||
/// <summary>Something the merge had to override, or an item that could not be processed.</summary>
|
||||
|
||||
@@ -141,6 +141,7 @@ internal static class AadResourceTypes
|
||||
SyncEntityType.ConnectionLogEntry => CryptoSpec.AadResourceType.ConnectionLogEntry,
|
||||
SyncEntityType.ActivityLogEntry => CryptoSpec.AadResourceType.ActivityLogEntry,
|
||||
SyncEntityType.ObjectStore => CryptoSpec.AadResourceType.ObjectStore,
|
||||
SyncEntityType.SpelunkKey => CryptoSpec.AadResourceType.SpelunkKey,
|
||||
|
||||
_ => throw new ArgumentOutOfRangeException(
|
||||
nameof(entityType), entityType, "No AAD resource type is defined for this entity type."),
|
||||
|
||||
+469
@@ -0,0 +1,469 @@
|
||||
// <auto-generated />
|
||||
using System;
|
||||
using DodoSSH.Client.Storage;
|
||||
using Microsoft.EntityFrameworkCore;
|
||||
using Microsoft.EntityFrameworkCore.Infrastructure;
|
||||
using Microsoft.EntityFrameworkCore.Migrations;
|
||||
using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
|
||||
|
||||
#nullable disable
|
||||
|
||||
namespace DodoSSH.Client.Storage.Migrations
|
||||
{
|
||||
[DbContext(typeof(ClientCacheContext))]
|
||||
[Migration("20261002104920_AddSyncStatePulledTypes")]
|
||||
partial class AddSyncStatePulledTypes
|
||||
{
|
||||
/// <inheritdoc />
|
||||
protected override void BuildTargetModel(ModelBuilder modelBuilder)
|
||||
{
|
||||
#pragma warning disable 612, 618
|
||||
modelBuilder.HasAnnotation("ProductVersion", "10.0.10");
|
||||
|
||||
modelBuilder.Entity("DodoSSH.Client.Storage.CachedItemRow", b =>
|
||||
{
|
||||
b.Property<Guid>("VaultId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("vault_id");
|
||||
|
||||
b.Property<int>("EntityType")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("entity_type");
|
||||
|
||||
b.Property<Guid>("EntityId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("entity_id");
|
||||
|
||||
b.Property<byte>("AadVersion")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("aad_version");
|
||||
|
||||
b.Property<long>("ChangeSequence")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("change_sequence");
|
||||
|
||||
b.Property<Guid?>("DataKeyId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("data_key_id");
|
||||
|
||||
b.Property<bool>("IsDeleted")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("is_deleted");
|
||||
|
||||
b.Property<uint>("KeyGeneration")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("key_generation");
|
||||
|
||||
b.Property<byte[]>("Payload")
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("payload");
|
||||
|
||||
b.Property<byte[]>("ProtectedFields")
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("protected_fields");
|
||||
|
||||
b.Property<long>("UpdatedAtUtc")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("updated_at_utc");
|
||||
|
||||
b.Property<int>("Version")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("version");
|
||||
|
||||
b.Property<byte[]>("WrappedDataKey")
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("wrapped_data_key");
|
||||
|
||||
b.HasKey("VaultId", "EntityType", "EntityId")
|
||||
.HasName("pk_item");
|
||||
|
||||
b.HasIndex("VaultId", "ChangeSequence")
|
||||
.HasDatabaseName("ix_item_vault_id_change_sequence");
|
||||
|
||||
b.HasIndex("VaultId", "EntityType")
|
||||
.HasDatabaseName("ix_item_vault_id_entity_type");
|
||||
|
||||
b.ToTable("item", (string)null);
|
||||
});
|
||||
|
||||
modelBuilder.Entity("DodoSSH.Client.Storage.CachedVaultKeyWrapRow", b =>
|
||||
{
|
||||
b.Property<Guid>("VaultId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("vault_id");
|
||||
|
||||
b.Property<uint>("KeyGeneration")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("key_generation");
|
||||
|
||||
b.Property<byte[]>("WrappedKey")
|
||||
.IsRequired()
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("wrapped_key");
|
||||
|
||||
b.HasKey("VaultId", "KeyGeneration")
|
||||
.HasName("pk_vault_key_wrap");
|
||||
|
||||
b.ToTable("vault_key_wrap", (string)null);
|
||||
});
|
||||
|
||||
modelBuilder.Entity("DodoSSH.Client.Storage.CachedVaultRow", b =>
|
||||
{
|
||||
b.Property<Guid>("VaultId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("vault_id");
|
||||
|
||||
b.Property<bool>("Hidden")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("hidden");
|
||||
|
||||
b.Property<bool>("IsPersonal")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("is_personal");
|
||||
|
||||
b.Property<uint>("KeyGeneration")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("key_generation");
|
||||
|
||||
b.Property<string>("Name")
|
||||
.IsRequired()
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("name");
|
||||
|
||||
b.Property<int>("Permissions")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("permissions");
|
||||
|
||||
b.Property<bool>("RekeyRequired")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("rekey_required");
|
||||
|
||||
b.Property<Guid?>("TeamId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("team_id");
|
||||
|
||||
b.Property<long>("UpdatedAtUtc")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("updated_at_utc");
|
||||
|
||||
b.Property<byte[]>("WrappedVaultKey")
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("wrapped_vault_key");
|
||||
|
||||
b.HasKey("VaultId")
|
||||
.HasName("pk_vault");
|
||||
|
||||
b.ToTable("vault", (string)null);
|
||||
});
|
||||
|
||||
modelBuilder.Entity("DodoSSH.Client.Storage.ConflictRow", b =>
|
||||
{
|
||||
b.Property<Guid>("Id")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("id");
|
||||
|
||||
b.Property<bool>("Acknowledged")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("acknowledged");
|
||||
|
||||
b.Property<byte[]>("Detail")
|
||||
.IsRequired()
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("detail");
|
||||
|
||||
b.Property<long>("DetectedAtUtc")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("detected_at_utc");
|
||||
|
||||
b.Property<Guid>("EntityId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("entity_id");
|
||||
|
||||
b.Property<int>("EntityType")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("entity_type");
|
||||
|
||||
b.Property<int>("Kind")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("kind");
|
||||
|
||||
b.Property<Guid>("VaultId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("vault_id");
|
||||
|
||||
b.HasKey("Id")
|
||||
.HasName("pk_conflict");
|
||||
|
||||
b.HasIndex("VaultId", "Acknowledged")
|
||||
.HasDatabaseName("ix_conflict_vault_id_acknowledged");
|
||||
|
||||
b.HasIndex("VaultId", "EntityType", "EntityId")
|
||||
.HasDatabaseName("ix_conflict_vault_id_entity_type_entity_id");
|
||||
|
||||
b.ToTable("conflict", (string)null);
|
||||
});
|
||||
|
||||
modelBuilder.Entity("DodoSSH.Client.Storage.OutboxRow", b =>
|
||||
{
|
||||
b.Property<long>("Sequence")
|
||||
.ValueGeneratedOnAdd()
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("sequence");
|
||||
|
||||
b.Property<byte>("AadVersion")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("aad_version");
|
||||
|
||||
b.Property<byte?>("AncestorAadVersion")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("ancestor_aad_version");
|
||||
|
||||
b.Property<Guid?>("AncestorDataKeyId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("ancestor_data_key_id");
|
||||
|
||||
b.Property<uint?>("AncestorKeyGeneration")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("ancestor_key_generation");
|
||||
|
||||
b.Property<byte[]>("AncestorPayload")
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("ancestor_payload");
|
||||
|
||||
b.Property<byte[]>("AncestorProtectedFields")
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("ancestor_protected_fields");
|
||||
|
||||
b.Property<int?>("AncestorVersion")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("ancestor_version");
|
||||
|
||||
b.Property<byte[]>("AncestorWrappedDataKey")
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("ancestor_wrapped_data_key");
|
||||
|
||||
b.Property<int>("Attempts")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("attempts");
|
||||
|
||||
b.Property<Guid?>("DataKeyId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("data_key_id");
|
||||
|
||||
b.Property<Guid>("EntityId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("entity_id");
|
||||
|
||||
b.Property<int>("EntityType")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("entity_type");
|
||||
|
||||
b.Property<int?>("ExpectedVersion")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("expected_version");
|
||||
|
||||
b.Property<bool>("IsParked")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("is_parked");
|
||||
|
||||
b.Property<uint>("KeyGeneration")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("key_generation");
|
||||
|
||||
b.Property<string>("LastError")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("last_error");
|
||||
|
||||
b.Property<int>("Operation")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("operation");
|
||||
|
||||
b.Property<Guid>("OperationId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("operation_id");
|
||||
|
||||
b.Property<byte[]>("Payload")
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("payload");
|
||||
|
||||
b.Property<byte[]>("ProtectedFields")
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("protected_fields");
|
||||
|
||||
b.Property<long>("QueuedAtUtc")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("queued_at_utc");
|
||||
|
||||
b.Property<Guid>("VaultId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("vault_id");
|
||||
|
||||
b.Property<byte[]>("WrappedDataKey")
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("wrapped_data_key");
|
||||
|
||||
b.HasKey("Sequence")
|
||||
.HasName("pk_outbox");
|
||||
|
||||
b.HasIndex("OperationId")
|
||||
.IsUnique()
|
||||
.HasDatabaseName("ix_outbox_operation_id");
|
||||
|
||||
b.HasIndex("VaultId", "EntityType", "EntityId")
|
||||
.IsUnique()
|
||||
.HasDatabaseName("ix_outbox_vault_id_entity_type_entity_id");
|
||||
|
||||
b.HasIndex("VaultId", "IsParked", "Sequence")
|
||||
.HasDatabaseName("ix_outbox_vault_id_is_parked_sequence");
|
||||
|
||||
b.ToTable("outbox", (string)null);
|
||||
});
|
||||
|
||||
modelBuilder.Entity("DodoSSH.Client.Storage.RememberedSignInRow", b =>
|
||||
{
|
||||
b.Property<int>("Id")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("id");
|
||||
|
||||
b.Property<byte[]>("SealedRefreshToken")
|
||||
.IsRequired()
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("sealed_refresh_token");
|
||||
|
||||
b.Property<long>("UpdatedAtUtc")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("updated_at_utc");
|
||||
|
||||
b.HasKey("Id")
|
||||
.HasName("pk_remembered_sign_in");
|
||||
|
||||
b.ToTable("remembered_sign_in", null, t =>
|
||||
{
|
||||
t.HasCheckConstraint("ck_remembered_sign_in_singleton", "id = 1");
|
||||
});
|
||||
});
|
||||
|
||||
modelBuilder.Entity("DodoSSH.Client.Storage.SyncStateRow", b =>
|
||||
{
|
||||
b.Property<Guid>("VaultId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("vault_id");
|
||||
|
||||
b.Property<string>("Cursor")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("cursor");
|
||||
|
||||
b.Property<uint>("KeyGeneration")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("key_generation");
|
||||
|
||||
b.Property<long?>("LastPulledAtUtc")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("last_pulled_at_utc");
|
||||
|
||||
b.Property<long?>("LastPushedAtUtc")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("last_pushed_at_utc");
|
||||
|
||||
b.Property<string>("PulledTypes")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("pulled_types");
|
||||
|
||||
b.Property<long>("ServerTimeSkewMs")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("server_time_skew_ms");
|
||||
|
||||
b.HasKey("VaultId")
|
||||
.HasName("pk_sync_state");
|
||||
|
||||
b.ToTable("sync_state", (string)null);
|
||||
});
|
||||
|
||||
modelBuilder.Entity("DodoSSH.Client.Storage.UnlockMaterialRow", b =>
|
||||
{
|
||||
b.Property<int>("Id")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("id");
|
||||
|
||||
b.Property<Guid?>("DeviceId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("device_id");
|
||||
|
||||
b.Property<byte[]>("DeviceWrappedPrivateKey")
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("device_wrapped_private_key");
|
||||
|
||||
b.Property<string>("DisplayName")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("display_name");
|
||||
|
||||
b.Property<string>("Email")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("email");
|
||||
|
||||
b.Property<string>("Issuer")
|
||||
.IsRequired()
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("issuer");
|
||||
|
||||
b.Property<string>("KdfAlgorithm")
|
||||
.IsRequired()
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("kdf_algorithm");
|
||||
|
||||
b.Property<int>("KdfMemoryKibibytes")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("kdf_memory_kibibytes");
|
||||
|
||||
b.Property<int>("KdfParallelism")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("kdf_parallelism");
|
||||
|
||||
b.Property<int>("KdfPasses")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("kdf_passes");
|
||||
|
||||
b.Property<byte[]>("KdfSalt")
|
||||
.IsRequired()
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("kdf_salt");
|
||||
|
||||
b.Property<uint>("KeyGeneration")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("key_generation");
|
||||
|
||||
b.Property<string>("ServerUrl")
|
||||
.IsRequired()
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("server_url");
|
||||
|
||||
b.Property<string>("Subject")
|
||||
.IsRequired()
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("subject");
|
||||
|
||||
b.Property<long>("UpdatedAtUtc")
|
||||
.HasColumnType("INTEGER")
|
||||
.HasColumnName("updated_at_utc");
|
||||
|
||||
b.Property<Guid>("UserId")
|
||||
.HasColumnType("TEXT")
|
||||
.HasColumnName("user_id");
|
||||
|
||||
b.Property<byte[]>("WrappedPrivateKey")
|
||||
.IsRequired()
|
||||
.HasColumnType("BLOB")
|
||||
.HasColumnName("wrapped_private_key");
|
||||
|
||||
b.HasKey("Id")
|
||||
.HasName("pk_unlock_material");
|
||||
|
||||
b.ToTable("unlock_material", null, t =>
|
||||
{
|
||||
t.HasCheckConstraint("ck_unlock_material_singleton", "id = 1");
|
||||
});
|
||||
});
|
||||
#pragma warning restore 612, 618
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
using Microsoft.EntityFrameworkCore.Migrations;
|
||||
|
||||
#nullable disable
|
||||
|
||||
namespace DodoSSH.Client.Storage.Migrations
|
||||
{
|
||||
/// <inheritdoc />
|
||||
public partial class AddSyncStatePulledTypes : Migration
|
||||
{
|
||||
/// <inheritdoc />
|
||||
protected override void Up(MigrationBuilder migrationBuilder)
|
||||
{
|
||||
migrationBuilder.AddColumn<string>(
|
||||
name: "pulled_types",
|
||||
table: "sync_state",
|
||||
type: "TEXT",
|
||||
nullable: true);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
protected override void Down(MigrationBuilder migrationBuilder)
|
||||
{
|
||||
migrationBuilder.DropColumn(
|
||||
name: "pulled_types",
|
||||
table: "sync_state");
|
||||
}
|
||||
}
|
||||
}
|
||||
Loaded 100 of 173 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user