using System.Security.Cryptography;
using System.Text;
using Renci.SshNet.Common;
namespace DodoSSH.Client.Ssh.Tests;
///
/// Public-key authentication through the path the vault actually uses, against a real sshd.
///
///
///
/// PtyAndResizeSpikeTests also authenticates with this fixture's key, and it does so by building
/// SSH.NET's PrivateKeyAuthenticationMethod itself — correct for a spike whose subject is the PTY,
/// and it leaves the application's own path unexercised. What runs here is what a vault-held key goes
/// through: carrying PEM bytes rather than a path, into
/// , which hands them to PrivateKeyFile as a
/// MemoryStream. That indirection is the reason a key in this product never becomes a file on disk,
/// and until now nothing established that it authenticates.
///
///
/// The fixture's key is RSA because there is no BCL Ed25519, and the fixture has to render the public half
/// in authorized_keys form to install it. Which algorithm it is does not matter to anything under
/// test here — the client never parses the key, it forwards it.
///
///
[Collection(SshCollection.Name)]
public sealed class KeyAuthenticationTests(SshServerFixture fixture)
{
private static CancellationToken Token => TestContext.Current.CancellationToken;
[Fact]
public async Task AKeyHeldAsBytes_AuthenticatesAndOpensAShell()
{
await using var connection = await ConnectTrustedAsync(
new SshPrivateKeyCredential(Pkcs1(fixture.ClientKey), Passphrase: null));
connection.IsConnected.ShouldBeTrue();
// Authenticated is not the same as usable: a channel has to open on the connection too.
await using var shell = await connection.OpenShellAsync(TerminalSize.Default, Token);
shell.IsOpen.ShouldBeTrue();
}
[Fact]
public async Task TheSameKeyInPkcs8Armour_AlsoAuthenticates()
{
// SshKeySecret stores whatever armour it was given, verbatim, and declines to normalise it. This is
// the half of that claim which is about SSH.NET rather than the codec: the two commonest forms
// ssh-keygen and openssl produce both load without the client knowing which it has.
await using var connection = await ConnectTrustedAsync(
new SshPrivateKeyCredential(Pkcs8(fixture.ClientKey), Passphrase: null));
connection.IsConnected.ShouldBeTrue();
}
[Fact]
public async Task AKeyTheServerDoesNotKnow_FailsAsAnAuthenticationError()
{
// The specific failure worth pinning is a misreport. The host key is already trusted here, so the
// factory's gate must translate nothing and let the authentication error through — if it answered
// with SshHostKeyUnknownException instead, the user would be shown a fingerprint to approve for a
// problem that approving it cannot fix.
using var stranger = RSA.Create(2048);
var knownHosts = await TrustedStoreAsync();
var factory = new SshNetConnectionFactory(knownHosts);
await Should.ThrowAsync(async () =>
await factory.ConnectAsync(Request(new SshPrivateKeyCredential(Pkcs1(stranger), null)), Token));
}
[Fact]
public async Task APassphraseOnAnUnprotectedKey_IsIgnoredRatherThanRefused()
{
// Written expecting the opposite, and it records what SSH.NET measurably does: PrivateKeyFile
// accepts a passphrase for a key that has none, and the connection authenticates as if it had not
// been given. See docs/platform-flags.md — the consequence is that nothing downstream will catch a
// stray passphrase, so a client that wants that caught has to notice it itself, and a client that
// does not can stop worrying about the case.
await using var connection = await ConnectTrustedAsync(
new SshPrivateKeyCredential(Pkcs1(fixture.ClientKey), "a passphrase this key does not have"));
connection.IsConnected.ShouldBeTrue();
}
private static byte[] Pkcs1(RSA key) => Encoding.UTF8.GetBytes(key.ExportRSAPrivateKeyPem());
private static byte[] Pkcs8(RSA key) => Encoding.UTF8.GetBytes(key.ExportPkcs8PrivateKeyPem());
private SshConnectionRequest Request(SshCredential credential) =>
new(fixture.Host, fixture.Port, SshServerFixture.Username, credential);
/// A store that already trusts the container's host key, so first contact is not the subject.
private async Task TrustedStoreAsync()
{
var knownHosts = new InMemoryKnownHostStore();
var factory = new SshNetConnectionFactory(knownHosts);
// Learned by being refused, which is the only way this client learns a host key.
var unknown = await Should.ThrowAsync(async () =>
await factory.ConnectAsync(
Request(new SshPasswordCredential(SshServerFixture.Password)), Token));
await knownHosts.TrustAsync(unknown.Presentation, Token);
return knownHosts;
}
private async Task ConnectTrustedAsync(SshCredential credential)
{
var knownHosts = await TrustedStoreAsync();
return await new SshNetConnectionFactory(knownHosts)
.ConnectAsync(Request(credential), Token);
}
}