using System.Security.Cryptography;
using DodoSSH.Client.Domain;
using DodoSSH.Contracts;
using DodoSSH.Crypto;
namespace DodoSSH.Client.Sync;
///
/// Turns an SSH key into an item payload and back.
///
///
///
/// Mirrors exactly, including the rule that a payload is sealed at the version the
/// server will assign rather than the one it replaces — see .
///
///
/// The resource type is the one thing not to copy. The AAD binds it, and the two enums that name item
/// types do not agree: SyncEntityType.SshKey is 3 while CryptoSpec.AadResourceType.SshKey is 6,
/// because the crypto enum also carries None, User, Device and Vault ahead of the item types. Casting one to
/// the other would seal a private key under the resource type for a vault — which encrypts
/// perfectly, decrypts perfectly on the machine that wrote it, and is a specification violation that no test
/// would notice until an interoperating client refused the item. So it is named here as a constant, and
/// AadResourceTypeTests pins the pairing.
///
///
public static class SshKeyCipher
{
private const CryptoSpec.AadResourceType Resource = CryptoSpec.AadResourceType.SshKey;
/// Encrypts an SSH key.
/// The key. Must be valid for storage.
/// The vault key, which the data key is wrapped under.
/// The item id, which the AAD binds.
/// The vault's current key generation.
/// The version this payload will hold once the server accepts it.
public static EncryptedPayload Seal(
SshKeySecret key,
ReadOnlySpan vaultKey,
Guid entityId,
uint keyGeneration,
int itemVersion)
{
ArgumentNullException.ThrowIfNull(key);
ArgumentOutOfRangeException.ThrowIfLessThan(itemVersion, 1);
var plaintext = SshKeySecretCodec.Encode(key);
var dataKey = ItemKeys.CreateDataKey();
try
{
var dataKeyId = Guid.CreateVersion7();
var wrappedDataKey = ItemKeys.WrapDataKey(
dataKey, vaultKey, Resource, entityId, keyGeneration, (uint)itemVersion);
var envelope = ItemKeys.SealPayload(
dataKey, plaintext, Resource, entityId, dataKeyId, keyGeneration, (uint)itemVersion);
return new EncryptedPayload(
envelope, wrappedDataKey, dataKeyId, keyGeneration, CryptoSpec.CurrentAadVersion);
}
finally
{
CryptographicOperations.ZeroMemory(dataKey);
// The encoded key material, wiped. This is the one buffer in the client whose contents are a
// private key and which can actually be cleared — the strings the codec read it from cannot be.
CryptographicOperations.ZeroMemory(plaintext);
}
}
/// Decrypts an SSH key.
///
public static SshKeySecretDocument? TryOpen(
EncryptedPayload payload,
ReadOnlySpan vaultKey,
Guid entityId,
int itemVersion)
{
ArgumentNullException.ThrowIfNull(payload);
if (itemVersion < 1 || payload.WrappedDataKey.Length == 0)
{
return null;
}
var dataKey = ItemKeys.TryUnwrapDataKey(
vaultKey,
payload.WrappedDataKey,
Resource,
entityId,
payload.KeyGeneration,
(uint)itemVersion);
if (dataKey is null)
{
return null;
}
try
{
var plaintext = ItemKeys.TryOpenPayload(
dataKey,
payload.Envelope,
Resource,
entityId,
payload.DataKeyId,
payload.KeyGeneration,
(uint)itemVersion);
if (plaintext is null)
{
return null;
}
try
{
return SshKeySecretCodec.TryDecode(plaintext, out var document) ? document : null;
}
finally
{
CryptographicOperations.ZeroMemory(plaintext);
}
}
finally
{
CryptographicOperations.ZeroMemory(dataKey);
}
}
}