Public Access
jaap-jan
e24012b039
Closes the largest remaining M1 gap in the data layer: a username and password can live in the vault, sync between machines, and be named by a host as how it authenticates. What is not here is the interface for creating one — see the end of this message. The third item type, and the first one that cost almost nothing to add. Server: a VaultCredential row, an EF configuration, a migration, and a CredentialKind. Client: a secret, a codec, a merge, a cipher, a kind, a repository facade and a session property. No new reconciliation logic, no change to the sync engine, no client cache migration. That was the whole point of the item-kind seam, and this is the evidence it holds. The narrowest type of the three on plaintext, and not for symmetry. A host has a deliberate concession — the relay needs an address it can resolve. A key has a fingerprint, public by nature, which this client still declines to send. A password has no part that is safe to expose: not its length, not a hash, not a hint. So CredentialKind refuses every plaintext field there is, hydrates none, and the table has no column to put one in. HostSecret.CredentialId is the password counterpart of SshKeyId, and the two are mutually exclusive. SSH itself would happily try a key and fall back to a password, but a host naming both leaves "how does this authenticate?" without a single answer — the interface, the connect path and the user would each be free to guess differently. TryValidate refuses it. One consequence was not anticipated: "a full host" stops being a coherent idea, which is what broke AFullHost_RoundTrips and is now written into that test. The schema version became a ladder rather than a maximum: credential-bound is 3, key-bound is 2, neither is still 1. Adding credentials therefore does not drag every key-bound host in every vault onto a version that clients understanding keys perfectly well would refuse to edit. A test pins exactly that, because it is the property the whole content-dependent-version rule exists to provide, and the obvious implementation would quietly lose it. Two tests had become false and said so: - Push_AnUnsupportedEntityType_IsInvalidNotAFailedBatch used Credential as its example of a type this server does not implement. It now asks the server's own registry what is still missing, so it cannot go stale again, and skips with a reason if that set ever empties. - ThePullFilterNamesEveryTypeThisBuildSynchronises pinned the exact list, which is what it is for. Also fixes ten nullable warnings — eight in SyncEndpointTests, two in a test file added earlier today. Neither set was introduced here; both were invisible until an unrelated change forced their project to recompile, which means the zero-warning claims made earlier in this work only ever covered what happened to be rebuilt. 777 tests green. Zero warnings, dotnet format clean. Not done, and deliberately: the credential interface. The vault column is 340 pixels wide and already holds two lists and two editors, kept from clipping its own buttons at the window's minimum height only by the one-editor-at-a-time rule added earlier today. A third list and a third editor would recreate that defect rather than avoid it, so the column needs a shape decision first. Credentials sync; they cannot yet be created in the interface.
77 lines
2.9 KiB
C#
77 lines
2.9 KiB
C#
using System.Diagnostics.CodeAnalysis;
|
|
|
|
namespace DodoSSH.Client.Domain;
|
|
|
|
/// <summary>
|
|
/// A username and password as the user sees it, decrypted.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <para>
|
|
/// The same bargain <see cref="SshKeySecret"/> documents applies here and is worth not repeating in full:
|
|
/// the password is an ordinary managed string, it cannot be wiped, and a process dump taken while the vault
|
|
/// is unlocked contains it. What that buys is that it never reaches the disk or the server in a form either
|
|
/// can read.
|
|
/// </para>
|
|
/// <para>
|
|
/// <see cref="Username"/> is optional and overrides the host's when set, which is the reason this is a
|
|
/// separate item rather than two more fields on a host: one credential is very often the same account on
|
|
/// twenty machines, and duplicating it per host means rotating it in twenty places and missing one.
|
|
/// </para>
|
|
/// </remarks>
|
|
public sealed record CredentialSecret : IVaultSecret
|
|
{
|
|
private readonly string? username;
|
|
|
|
/// <summary>What the user calls this credential.</summary>
|
|
public required string Label { get; init; }
|
|
|
|
/// <summary>
|
|
/// The password.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Required, and an empty one is not valid — see <see cref="TryValidate"/>. A credential with no password
|
|
/// is not a credential, and storing one would produce an item that looks usable and fails at the
|
|
/// handshake with an error about authentication rather than about the vault.
|
|
/// </remarks>
|
|
public required string Password { get; init; }
|
|
|
|
/// <summary>
|
|
/// The account this credential is for, when it is not the host's own username.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Empty is normalised to null, as <see cref="SshKeySecret.Passphrase"/> is and for the same kind of
|
|
/// reason: blank and absent mean one thing here — "use the host's username" — and two spellings of one
|
|
/// state would give two clients different payload bytes for an identical credential, and make
|
|
/// <c>Username is not null</c> an unreliable answer to "does this override the host?".
|
|
/// </remarks>
|
|
public string? Username
|
|
{
|
|
get => username;
|
|
init => username = string.IsNullOrEmpty(value) ? null : value;
|
|
}
|
|
|
|
/// <summary>Free text.</summary>
|
|
public string? Notes { 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 credential needs a name.";
|
|
return false;
|
|
}
|
|
|
|
if (Password.Length == 0)
|
|
{
|
|
// Length rather than IsNullOrWhiteSpace: a password of spaces is a password, and refusing it
|
|
// would lock someone out of a host over a validation opinion.
|
|
reason = "A credential needs a password.";
|
|
return false;
|
|
}
|
|
|
|
reason = null;
|
|
return true;
|
|
}
|
|
}
|