Public Access
Key the local cache to the identity, not to the door it was opened through
Groundwork for a device key, and a spec change rather than a feature. ADR 0007 records the decision it clears the way for: a Windows Hello gesture guarding a protected blob, with the passphrase kept as a permanent fallback. The reason that decision needed this first is that a device key cannot open a session on its own. SessionOpener derived two things from the passphrase master key — the bundle, and the local cache key — and a device wrap is SealTo(device_x25519_pk), which yields the bundle and never computes a master key at all. A device unlock could therefore have opened the identity and still not read the cache it had itself written. So LocalCacheKey now derives from the bundle: dsh1/localcache/v1 → v2, specified in crypto.md §3.2. Every wrap that opens a vault ends up holding the bundle, so every door reaches the same cache. Extract-and-expand, not expand alone. Everything derived from the master key uses HKDF-Expand directly, which is sound because an Argon2id output is uniformly random over its whole length. The bundle's encoding is not — it opens with a fixed 14-byte label and carries a version, a generation and a timestamp before reaching any key material — so it needs the extract step to become a pseudorandom key first. Two consequences fell out, both improvements and neither the point: - A passphrase change no longer discards the local cache. The bundle is unchanged by a re-wrap, so the cache key is too. Under v1 changing a passphrase silently orphaned every cached row and the next launch re-pulled the whole vault. - Recovery-code unlock is fixed before it ships. It derives a different master key from a different secret and a different salt, so under v1 it would have had the same defect as the device path, and nobody would have noticed until it landed. The cache becomes unreadable exactly when the identity is rotated, which is the correct moment to discard it. Existing caches are discarded and re-pulled on upgrade — already the specified behaviour for a stale cache, and the reason the label is versioned rather than reused: a v1 cache must fail to open rather than decrypt to nonsense. One stated guarantee got weaker and now says so. crypto.md §10 claimed locking meant "nothing on disk can be read again without the passphrase." Where a device wrap exists that is no longer true, and it would have been untrue under either candidate design — the alternative was storing a copy of the cache key in the device blob, which is the same door with an extra key lying next to it. The wording now points at ADR 0007, because what guards the device key is a platform decision and not a property of this specification. A golden vector was quietly lying, which is the part worth reading twice. The "local-cache" entry pinned HKDF-SHA512-Expand over a fixed PRK — a construction the cache key no longer uses. Regenerating it would have produced a green suite describing a derivation this code does not perform. It is replaced by a vector over a bundle whose every byte is pinned: the label, version 1, generation 1, a fixed timestamp and two recognisable key scalars, all visible in the fixture so a second implementation can check itself against it. UserSecretBundle.TryDecode is internal for this, because Create draws fresh randomness and so can never produce a reproducible input. Mutation tested, and this one earns its keep: dropping the extract step now fails CommittedVectors_MatchCurrentImplementation. The vector it replaced could not have caught that, because it never touched the bundle at all. One test became false and says so. ARecordSealedUnderAnotherPassphrase is now ARecordSealedByAnotherIdentity: a different passphrase deliberately no longer changes the cache key, and TheLocalCacheKey_SurvivesAPassphraseChange pins that. What must still be unreadable is another user's cache. CacheHarness therefore generates an identity rather than deriving from a passphrase, and has no passphrase parameter left — the cache key is not a question about passphrases any more. SyncHarness's two simulated machines now derive the same cache key, which is what keying on the bundle means: they are the same user holding the same identity. They still have separate cache databases, so nothing is shared between them but the key that would open either. Both harnesses lost a MasterKey field that existed only to make a protector. 858 tests green. Zero warnings, dotnet format clean. Not done: the device key itself. Three pieces remain, and the middle one was a discovery rather than a plan — EnrollmentService.AddDevice runs only during enrollment, so every already-enrolled account, which is all of them, needs an endpoint to add a device wrap while unlocked. The client proves possession by producing the wrap, so that shape falls out of the crypto. After that: the protector seam with the wrap cached locally for offline unlock, then the Hello implementation and the unlock-screen UI, which is where the Windows TFM lands and where automated testing stops.
This commit is contained in:
@@ -1,3 +1,4 @@
|
||||
using System.Buffers.Binary;
|
||||
using System.Globalization;
|
||||
using System.Security.Cryptography;
|
||||
using System.Text;
|
||||
@@ -32,6 +33,7 @@ internal static class GoldenVectors
|
||||
["envelope"] = BuildEnvelopeVectors(),
|
||||
["aead"] = BuildAeadVectors(),
|
||||
["hkdf"] = BuildHkdfVectors(),
|
||||
["localCacheKey"] = BuildLocalCacheKeyVectors(),
|
||||
["argon2id"] = BuildArgon2Vectors(),
|
||||
["fingerprint"] = BuildFingerprintVectors(),
|
||||
["keyStatement"] = BuildKeyStatementVectors(),
|
||||
@@ -186,6 +188,12 @@ internal static class GoldenVectors
|
||||
];
|
||||
}
|
||||
|
||||
/// <remarks>
|
||||
/// Only the labels that really are HKDF-Expand over a master key belong here. The local cache key used
|
||||
/// to be one of them and is not any more — it extracts and expands over the bundle's encoding
|
||||
/// instead — so it has its own section rather than an entry here that would describe a derivation this
|
||||
/// implementation no longer performs. See <see cref="BuildLocalCacheKeyVectors"/>.
|
||||
/// </remarks>
|
||||
private static JsonArray BuildHkdfVectors()
|
||||
{
|
||||
var prk = Enumerable.Range(0, 64).Select(i => (byte)i).ToArray();
|
||||
@@ -193,7 +201,6 @@ internal static class GoldenVectors
|
||||
(string Name, byte[] Info)[] cases =
|
||||
[
|
||||
("passphrase-kek", CryptoSpec.DerivationLabels.PassphraseKek.ToArray()),
|
||||
("local-cache", CryptoSpec.DerivationLabels.LocalCache.ToArray()),
|
||||
];
|
||||
|
||||
var array = new JsonArray();
|
||||
@@ -214,6 +221,65 @@ internal static class GoldenVectors
|
||||
return array;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The local cache key, over a bundle whose every byte is pinned. docs/crypto.md §3.2.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Built from a fixed encoding rather than from <c>UserSecretBundle.Create</c>, which draws fresh
|
||||
/// randomness and so could never produce a reproducible vector. This is the one that matters for a
|
||||
/// second implementation: it pins the extract-and-expand construction, the info label, and the fact
|
||||
/// that the input is the bundle's canonical encoding rather than any key inside it.
|
||||
/// </remarks>
|
||||
private static JsonArray BuildLocalCacheKeyVectors()
|
||||
{
|
||||
var encoded = FixedBundleEncoding();
|
||||
|
||||
using var bundle = UserSecretBundle.TryDecode(encoded)
|
||||
?? throw new InvalidOperationException("The fixed bundle encoding is not well-formed.");
|
||||
|
||||
var cacheKey = new byte[CryptoSpec.SymmetricKeySize];
|
||||
bundle.DeriveLocalCacheKey(cacheKey);
|
||||
|
||||
return
|
||||
[
|
||||
new JsonObject
|
||||
{
|
||||
["name"] = "local-cache-key-from-bundle",
|
||||
["algorithm"] = "HKDF-SHA512 extract-and-expand, no salt",
|
||||
["bundle"] = Hex(encoded),
|
||||
["info"] = Encoding.UTF8.GetString(CryptoSpec.DerivationLabels.LocalCache),
|
||||
["outputLength"] = CryptoSpec.SymmetricKeySize,
|
||||
["output"] = Hex(cacheKey),
|
||||
},
|
||||
];
|
||||
}
|
||||
|
||||
/// <remarks>
|
||||
/// The §3.1 layout with every field a constant: label, version 1, generation 1, a fixed timestamp, and
|
||||
/// two key scalars of recognisable byte patterns. Any 32 bytes is a valid X25519 scalar and a valid
|
||||
/// Ed25519 seed, so nothing here needs to be a real generated key.
|
||||
/// </remarks>
|
||||
private static byte[] FixedBundleEncoding()
|
||||
{
|
||||
var encoded = new byte[UserSecretBundle.EncodedLength];
|
||||
var span = encoded.AsSpan();
|
||||
|
||||
UserSecretBundle.Label.CopyTo(span);
|
||||
BinaryPrimitives.WriteUInt16BigEndian(span[14..], UserSecretBundle.CurrentVersion);
|
||||
BinaryPrimitives.WriteUInt32BigEndian(span[16..], 1u);
|
||||
BinaryPrimitives.WriteInt64BigEndian(
|
||||
span[20..],
|
||||
new DateTimeOffset(2026, 1, 1, 0, 0, 0, TimeSpan.Zero).ToUnixTimeMilliseconds());
|
||||
|
||||
for (var i = 0; i < CryptoSpec.SymmetricKeySize; i++)
|
||||
{
|
||||
span[28 + i] = (byte)(0x40 + i);
|
||||
span[60 + i] = (byte)(0x60 + i);
|
||||
}
|
||||
|
||||
return encoded;
|
||||
}
|
||||
|
||||
private static JsonArray BuildArgon2Vectors()
|
||||
{
|
||||
var salt = Enumerable.Range(0, CryptoSpec.SaltSize).Select(i => (byte)(0x20 + i)).ToArray();
|
||||
|
||||
Reference in New Issue
Block a user