Reach a Spelunk-managed server through Spelunk, and open one from a Spelunk link

A server Spelunk manages runs Spelunk's agent, which keeps a connection open
to Spelunk. A host can now be marked "Connect through Spelunk": a connect
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. Shells and file transfers both go this way.

Client, in Client.Session:

- SpelunkTunnel implements Spelunk's contract: POST
  {api}/api/servers/{id}/tunnel-tickets with the API key as a bearer token
  and {"port":N}, then a WebSocket to the API's own origin at the path
  Spelunk returns, offering spelunk.tunnel.v1 and ticket.<ticket>. After the
  upgrade the relay's RelayBridge carries the bytes unchanged. Every refusal
  is a sentence: 401 key, 403 role (with Spelunk's detail), 404 server, 503
  agent not connected, 401/503 on the upgrade, and close codes 4502 (agent
  could not reach the port, or is too old: "Unknown stream kind") and 4503
  (agent disconnected). Only a path is taken from the ticket response, so it
  cannot send the ticket to another host.
- IConnectionRoute is what RelayRoute and SpelunkTunnelRoute have in common,
  so the connect path has one shape for both.

Host model: HostSecret.Spelunk is a SpelunkRoute (normalised API base,
server id, and the id of the credential holding the API key), at payload
schema version 8. It is written last and only when present, so every other
host keeps its bytes and its version; an older build reads a Spelunk host
as read-only rather than dropping the route. A half-written route makes the
item unreadable instead of dialled. It merges as one value and is exclusive
with RelayEnabled. The API address must be https, or http to loopback.

The API key is an ordinary keychain credential whose password is the key,
referenced by id, so it is encrypted, synced, merged and rotated like every
other secret, one credential serves every server in the organisation, and
the used-by list and deletion warning count it.

Routing: OpenRouteAsync is the one decision for both transports. A Spelunk
host is never dialled directly, never probed after a failure, and a route
that hung up with a reason replaces SSH.NET's transport error.

UI: a "Connect through Spelunk" card beside the relay card in the desktop
drawer and the phone's editor; ticking one unticks the other.

dodossh://spelunk/connect?api=&server=&name=&host= links:

- SpelunkLink parses them strictly and never reads a credential from one.
- Program reads a link from the arguments; a launch that finds DodoSSH
  running passes it down the doorbell as "dodossh.open-link <link>", which
  the running instance parses again, bounded, and otherwise ignores whole.
  The plain come-forward ring is unchanged.
- A saved host routed to that server on that Spelunk is connected to;
  otherwise the editor opens on a new, unsaved Spelunk host, with the key
  pre-chosen only when another host already sends it to that Spelunk. A link
  that arrives while locked waits for the unlock.
- Windows registers the scheme under HKCU from Velopack's install and update
  hooks and removes it on uninstall only if it still points at this
  executable; the macOS plist template declares CFBundleURLTypes and the app
  takes the URL from Avalonia's activation event; the Linux desktop entry
  gets %u and MimeType=x-scheme-handler/dodossh.
This commit is contained in:
jaap-jan committed 2026-09-28 21:25:04 +02:00
1 parent c8848ec1e3
commit 6e39807cc0
32 files changed
+3428 -85

No files matched your search

@@ -0,0 +1,224 @@
using System.Net;
using System.Net.Sockets;
using System.Net.WebSockets;
using System.Security.Cryptography;
using System.Text;
namespace DodoSSH.Client.Session.Tests;
/// <summary>
/// Spelunk's two tunnel endpoints, as far as the wire is concerned: HTTP/1.1 over a real loopback socket.
/// </summary>
/// <remarks>
/// <para>
/// Real sockets rather than a stubbed handler, because what is being tested is the client's own HTTP and
/// WebSocket stack talking to something: the header the key goes in, the subprotocols the upgrade offers,
/// a refused upgrade's status read back through <c>CollectHttpResponseDetails</c>, and a close code
/// arriving through <see cref="Client.Ssh.RelayBridge"/>. A handler stub would skip exactly those.
/// </para>
/// <para>
/// Hand-rolled rather than Kestrel, so this client suite takes no dependency on the ASP.NET Core framework
/// for one fixture. It speaks only what the client sends: one request per connection, answered with
/// <c>Connection: close</c>, and the one upgrade.
/// </para>
/// </remarks>
internal sealed class FakeSpelunk : IAsyncDisposable
{
internal const string Ticket = "dGlja2V0LWZvci1hLXR1bm5lbA";
private readonly TcpListener listener = new(IPAddress.Loopback, 0);
private readonly CancellationTokenSource stopping = new();
private readonly Task accepting;
internal FakeSpelunk()
{
listener.Start();
accepting = AcceptAsync();
}
/// <summary>The API base a client is given.</summary>
internal string ApiBase => $"http://127.0.0.1:{((IPEndPoint)listener.LocalEndpoint).Port}";
/// <summary>Every request that arrived, in order.</summary>
internal List<Request> Requests { get; } = [];
/// <summary>How the ticket endpoint answers. By default, with a ticket.</summary>
internal Func<Request, Answer> OnTicket { get; set; } = request => Answer.Json(
HttpStatusCode.OK,
$$"""
{"ticket":"{{Ticket}}","expiresAt":"2026-09-28T12:00:30Z","path":"{{request.Path.Replace("tunnel-tickets", "tunnel", StringComparison.Ordinal)}}","subprotocol":"spelunk.tunnel.v1"}
""");
/// <summary>How the upgrade is answered: null accepts it, anything else refuses it with that status.</summary>
internal Func<Request, HttpStatusCode?> OnUpgrade { get; set; } = _ => null;
/// <summary>What Spelunk does with an accepted tunnel — by default nothing, until the client closes.</summary>
internal Func<WebSocket, Task> OnTunnel { get; set; } = DrainAsync;
public async ValueTask DisposeAsync()
{
await stopping.CancelAsync();
listener.Stop();
try
{
await accepting;
}
catch (Exception exception) when (exception is OperationCanceledException or SocketException or ObjectDisposedException)
{
// Stopped.
}
stopping.Dispose();
}
/// <summary>Reads until the client closes, and answers the close.</summary>
internal static async Task DrainAsync(WebSocket socket)
{
var buffer = new byte[4096];
while ((await socket.ReceiveAsync(buffer, CancellationToken.None)).MessageType != WebSocketMessageType.Close)
{
}
await socket.CloseOutputAsync(WebSocketCloseStatus.NormalClosure, string.Empty, CancellationToken.None);
}
private async Task AcceptAsync()
{
while (!stopping.IsCancellationRequested)
{
var client = await listener.AcceptTcpClientAsync(stopping.Token);
_ = ServeAsync(client);
}
}
private async Task ServeAsync(TcpClient client)
{
using (client)
{
var stream = client.GetStream();
var request = await ReadRequestAsync(stream);
lock (Requests)
{
Requests.Add(request);
}
if (request.Headers.TryGetValue("Upgrade", out var upgrade)
&& upgrade.Equals("websocket", StringComparison.OrdinalIgnoreCase))
{
await UpgradeAsync(stream, request);
return;
}
var answer = OnTicket(request);
var body = Encoding.UTF8.GetBytes(answer.Body);
await WriteAsync(
stream,
$"HTTP/1.1 {(int)answer.Status} {answer.Status}\r\nContent-Type: {answer.ContentType}\r\n"
+ $"Content-Length: {body.Length}\r\nConnection: close\r\n\r\n");
await stream.WriteAsync(body);
}
}
private async Task UpgradeAsync(NetworkStream stream, Request request)
{
if (OnUpgrade(request) is { } refusal)
{
await WriteAsync(
stream,
$"HTTP/1.1 {(int)refusal} {refusal}\r\nContent-Length: 0\r\nConnection: close\r\n\r\n");
return;
}
await WriteAsync(
stream,
"HTTP/1.1 101 Switching Protocols\r\nUpgrade: websocket\r\nConnection: Upgrade\r\n"
+ $"Sec-WebSocket-Accept: {AcceptFor(request.Headers["Sec-WebSocket-Key"])}\r\n"
+ "Sec-WebSocket-Protocol: spelunk.tunnel.v1\r\n\r\n");
using var socket = WebSocket.CreateFromStream(
stream,
new WebSocketCreationOptions
{
IsServer = true,
SubProtocol = "spelunk.tunnel.v1",
KeepAliveInterval = TimeSpan.Zero,
});
try
{
await OnTunnel(socket);
}
catch (Exception exception) when (exception is WebSocketException or IOException)
{
// The client went away; nothing here is under test.
}
}
/// <summary>The handshake's accept value, as RFC 6455 section 4.2.2 defines it.</summary>
private static string AcceptFor(string key)
{
#pragma warning disable RS0030, CA5350 // RFC 6455 fixes SHA-1 for this value. It authenticates nothing; it proves the peer read the key.
return Convert.ToBase64String(SHA1.HashData(Encoding.ASCII.GetBytes(key + "258EAFA5-E914-47DA-95CA-C5AB0DC85B11")));
#pragma warning restore RS0030, CA5350
}
private static async Task<Request> ReadRequestAsync(NetworkStream stream)
{
var head = new List<byte>();
var one = new byte[1];
while (!(head.Count >= 4 && head[^4] == '\r' && head[^3] == '\n' && head[^2] == '\r' && head[^1] == '\n'))
{
if (await stream.ReadAsync(one) == 0)
{
break;
}
head.Add(one[0]);
}
var lines = Encoding.ASCII.GetString([.. head]).Split("\r\n", StringSplitOptions.RemoveEmptyEntries);
var requestLine = lines[0].Split(' ');
var headers = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
foreach (var line in lines.Skip(1))
{
var colon = line.IndexOf(':', StringComparison.Ordinal);
headers[line[..colon].Trim()] = line[(colon + 1)..].Trim();
}
var body = string.Empty;
if (headers.TryGetValue("Content-Length", out var length) && int.Parse(length, System.Globalization.CultureInfo.InvariantCulture) is > 0 and var count)
{
var bytes = new byte[count];
await stream.ReadExactlyAsync(bytes);
body = Encoding.UTF8.GetString(bytes);
}
return new Request(requestLine[0], requestLine[1], headers, body);
}
private static Task WriteAsync(NetworkStream stream, string text) =>
stream.WriteAsync(Encoding.ASCII.GetBytes(text)).AsTask();
/// <summary>One request as it arrived.</summary>
internal sealed record Request(string Method, string Path, Dictionary<string, string> Headers, string Body);
/// <summary>What the ticket endpoint says back.</summary>
internal sealed record Answer(HttpStatusCode Status, string ContentType, string Body)
{
internal static Answer Json(HttpStatusCode status, string body) => new(status, "application/json", body);
internal static Answer Problem(HttpStatusCode status, string title, string? detail = null) => new(
status,
"application/problem+json",
detail is null
? $$"""{"type":"about:blank","title":"{{title}}","status":{{(int)status}}}"""
: $$"""{"type":"about:blank","title":"{{title}}","status":{{(int)status}},"detail":"{{detail}}"}""");
}
}
@@ -0,0 +1,115 @@
namespace DodoSSH.Client.Session.Tests;
/// <summary>
/// Reading a <c>dodossh://spelunk/connect</c> link, which anything on the machine can hand the application.
/// </summary>
/// <remarks>
/// A link is data to check, never an instruction. The refusals below are the part that matters: each is a
/// link that is nearly right, and "nearly right" is the shape a crafted one takes.
/// </remarks>
public sealed class SpelunkLinkTests
{
private const string Server = "0192f0c8-bbbb-7c3d-8e4f-5a6b7c8d9e0b";
private const string Link =
"dodossh://spelunk/connect?api=https%3A%2F%2Fapi.spelunk.example.com&server=" + Server
+ "&name=web%2001&host=203.0.113.10";
[Fact]
public void ALinkFromSpelunk_IsRead()
{
SpelunkLink.TryParse(Link, out var link).ShouldBeTrue();
link.ShouldBe(new SpelunkLink("https://api.spelunk.example.com", Guid.Parse(Server), "web 01", "203.0.113.10"));
link.Hostname.ShouldBe("203.0.113.10");
}
[Fact]
public void ALinkWithNoHost_NamesTheHostAfterTheServer()
{
// The name the host key is pinned under, so it has to be stable and this server's alone.
SpelunkLink.TryParse(Link.Replace("&host=203.0.113.10", string.Empty, StringComparison.Ordinal), out var link)
.ShouldBeTrue();
link.Host.ShouldBeNull();
link.Hostname.ShouldBe($"spelunk-{Server}");
}
[Fact]
public void ALink_WritesOutAsItReadsBack()
{
// What a second launch sends the running instance: the one spelling this build writes.
SpelunkLink.TryParse(Link, out var link).ShouldBeTrue();
SpelunkLink.TryParse(link.ToString(), out var again).ShouldBeTrue();
again.ShouldBe(link);
}
[Fact]
public void ANameFormEncoded_AndOneWithControlCharacters_AreCleanedForDisplay()
{
SpelunkLink.TryParse(Link.Replace("web%2001", "web+01%0A%1B%5B31m", StringComparison.Ordinal), out var link)
.ShouldBeTrue();
link.Name.ShouldNotContain('\n');
link.Name.ShouldNotContain('\u001b');
link.Name.ShouldStartWith("web 01");
}
[Fact]
public void AnUnknownParameter_IsIgnored()
{
// So a newer Spelunk can add one without every DodoSSH already installed refusing its links.
SpelunkLink.TryParse(Link + "&port=22", out _).ShouldBeTrue();
}
[Theory]
[InlineData("https://spelunk/connect?api=https%3A%2F%2Fapi.example.com&server=" + Server)]
[InlineData("dodossh://elsewhere/connect?api=https%3A%2F%2Fapi.example.com&server=" + Server)]
[InlineData("dodossh://spelunk/disconnect?api=https%3A%2F%2Fapi.example.com&server=" + Server)]
[InlineData("dodossh://user@spelunk/connect?api=https%3A%2F%2Fapi.example.com&server=" + Server)]
[InlineData("dodossh://spelunk:8080/connect?api=https%3A%2F%2Fapi.example.com&server=" + Server)]
[InlineData("dodossh://spelunk/connect?api=https%3A%2F%2Fapi.example.com&server=" + Server + "#x")]
[InlineData("dodossh://spelunk/connect?server=" + Server)]
[InlineData("dodossh://spelunk/connect?api=https%3A%2F%2Fapi.example.com")]
[InlineData("dodossh://spelunk/connect?api=https%3A%2F%2Fapi.example.com&server=not-a-guid")]
[InlineData("dodossh://spelunk/connect?api=https%3A%2F%2Fapi.example.com&server=00000000-0000-0000-0000-000000000000")]
[InlineData("dodossh://spelunk/connect?api=http%3A%2F%2Fapi.example.com&server=" + Server)]
[InlineData("dodossh://spelunk/connect?api=https%3A%2F%2Fu%3Ap%40api.example.com&server=" + Server)]
[InlineData("dodossh://spelunk/connect?api=https%3A%2F%2Fapi.example.com&api=https%3A%2F%2Fevil.example&server=" + Server)]
[InlineData("dodossh://spelunk/connect?api=https%3A%2F%2Fapi.example.com&server=" + Server + "&host=bad%20host")]
[InlineData("dodossh://spelunk/connect?api=https%3A%2F%2Fapi.example.com&server=" + Server + "&name=a b")]
[InlineData("")]
public void ALinkThatIsNotExactlyThis_IsRefused(string text)
{
SpelunkLink.TryParse(text, out var link).ShouldBeFalse();
link.ShouldBeNull();
}
[Fact]
public void AnOverlongLink_IsRefusedBeforeItIsParsed()
{
SpelunkLink.TryParse(Link + "&name=" + new string('a', SpelunkLink.MaxLength), out _).ShouldBeFalse();
}
[Fact]
public void ANameThatRunsOn_IsCut()
{
SpelunkLink.TryParse(Link.Replace("web%2001", new string('a', 500), StringComparison.Ordinal), out var link)
.ShouldBeTrue();
link.Name.Length.ShouldBe(SpelunkLink.MaxNameLength);
}
[Theory]
[InlineData("dodossh://spelunk/connect", true)]
[InlineData("DODOSSH://anything", true)]
[InlineData("--veloapp-install", false)]
[InlineData(null, false)]
public void TheLauncher_TellsALinkFromAnotherArgument(string? argument, bool looksLikeOne)
{
SpelunkLink.LooksLikeOne(argument).ShouldBe(looksLikeOne);
}
}
@@ -0,0 +1,283 @@
using System.Net;
using System.Net.Sockets;
using System.Net.WebSockets;
using System.Text;
namespace DodoSSH.Client.Session.Tests;
/// <summary>
/// The Spelunk tunnel client against Spelunk's contract, over real sockets.
/// </summary>
/// <remarks>
/// <para>
/// Every test here uses the application's own <see cref="SpelunkTunnel"/> — its shared transport and its
/// real WebSocket dialler — against <see cref="FakeSpelunk"/>. What is asserted is what the contract fixes:
/// the ticket request, the two subprotocols, bytes both ways once the tunnel is up, and a sentence for every
/// way Spelunk says no.
/// </para>
/// <para>
/// The bytes are not SSH here. The bridge is the relay's, and a real SSH connection through it is
/// <c>RelayBridgeTests</c>' job; this suite holds the half that is Spelunk's.
/// </para>
/// </remarks>
public sealed class SpelunkTunnelTests : IAsyncLifetime
{
private const string ApiKey = "spelunk_0123456789abcdefghijklmnopqrstuvwxyzABCDEFG";
private static readonly Guid ServerId = Guid.Parse("0192f0c8-bbbb-7c3d-8e4f-5a6b7c8d9e0b");
private static readonly TimeSpan Settles = TimeSpan.FromSeconds(20);
private readonly FakeSpelunk spelunk = new();
private static CancellationToken Token => TestContext.Current.CancellationToken;
public ValueTask InitializeAsync() => ValueTask.CompletedTask;
public ValueTask DisposeAsync() => spelunk.DisposeAsync();
[Fact]
public async Task ATicket_IsAskedForWithTheKey_AndSpentAsTheSecondSubprotocol()
{
await using var route = await OpenAsync();
var ticket = spelunk.Requests[0];
ticket.Method.ShouldBe("POST");
ticket.Path.ShouldBe($"/api/servers/{ServerId}/tunnel-tickets");
ticket.Headers["Authorization"].ShouldBe($"Bearer {ApiKey}");
ticket.Body.ShouldBe("""{"port":22}""");
var upgrade = spelunk.Requests[1];
upgrade.Path.ShouldBe($"/api/servers/{ServerId}/tunnel");
upgrade.Headers["Sec-WebSocket-Protocol"].ShouldBe($"spelunk.tunnel.v1, ticket.{FakeSpelunk.Ticket}");
// The key opened the ticket and went nowhere else: the socket carries the ticket alone.
upgrade.Headers.ContainsKey("Authorization").ShouldBeFalse();
upgrade.Path.ShouldNotContain(FakeSpelunk.Ticket);
}
[Fact]
public async Task BytesCross_BothWays_ThroughTheBridge()
{
var received = new TaskCompletionSource<string>();
spelunk.OnTunnel = async socket =>
{
// What the agent's end does: read what the client sent, answer with the server's own bytes.
var buffer = new byte[64];
var read = await socket.ReceiveAsync(buffer, CancellationToken.None);
received.TrySetResult(Encoding.ASCII.GetString(buffer, 0, read.Count));
await socket.SendAsync(
Encoding.ASCII.GetBytes("SSH-2.0-OpenSSH_9.9\r\n"),
WebSocketMessageType.Binary,
endOfMessage: true,
CancellationToken.None);
await FakeSpelunk.DrainAsync(socket);
};
await using var route = await OpenAsync();
using var client = await ThroughSocksAsync(route.Proxy.Port);
var stream = client.GetStream();
await stream.WriteAsync(Encoding.ASCII.GetBytes("SSH-2.0-DodoSSH\r\n"), Token);
(await received.Task.WaitAsync(Settles, Token)).ShouldBe("SSH-2.0-DodoSSH\r\n");
var answer = new byte["SSH-2.0-OpenSSH_9.9\r\n".Length];
await stream.ReadExactlyAsync(answer, Token);
Encoding.ASCII.GetString(answer).ShouldBe("SSH-2.0-OpenSSH_9.9\r\n");
}
[Fact]
public async Task ThePortAsked_IsTheHostsPort()
{
await using var route = await spelunk.ApiBase.OpenAsync(port: 2222);
spelunk.Requests[0].Body.ShouldBe("""{"port":2222}""");
}
[Theory]
[InlineData(HttpStatusCode.Unauthorized, "did not accept the API key")]
[InlineData(HttpStatusCode.NotFound, "does not know this server")]
[InlineData(HttpStatusCode.ServiceUnavailable, "agent on this server is not connected")]
[InlineData(HttpStatusCode.InternalServerError, "HTTP 500")]
public async Task ARefusedTicket_IsExplained_AndNoSocketIsOpened(HttpStatusCode status, string explanation)
{
spelunk.OnTicket = _ => FakeSpelunk.Answer.Problem(status, "refused");
var refusal = await Should.ThrowAsync<SpelunkTunnelException>(OpenAsync);
refusal.Message.ShouldContain(explanation);
refusal.StatusCode.ShouldBe(status);
spelunk.Requests.ShouldHaveSingleItem();
}
[Fact]
public async Task AKeyWithTooLowARole_IsToldWhatSpelunkSaid()
{
// Spelunk's detail says which role the key has and which it needs, and it is the useful half.
spelunk.OnTicket = _ => FakeSpelunk.Answer.Problem(
HttpStatusCode.Forbidden,
"Forbidden",
"This API key has the Viewer role; opening a tunnel needs Admin.");
var refusal = await Should.ThrowAsync<SpelunkTunnelException>(OpenAsync);
refusal.Message.ShouldContain("not allowed to open a terminal");
refusal.Message.ShouldContain("needs Admin");
}
[Theory]
[InlineData(HttpStatusCode.Unauthorized, "refused the tunnel ticket")]
[InlineData(HttpStatusCode.ServiceUnavailable, "agent on this server is not connected")]
public async Task ARefusedUpgrade_IsExplained(HttpStatusCode status, string explanation)
{
spelunk.OnUpgrade = _ => status;
var refusal = await Should.ThrowAsync<SpelunkTunnelException>(OpenAsync);
refusal.Message.ShouldContain(explanation);
}
[Theory]
[InlineData("//evil.example/api/servers/x/tunnel")]
[InlineData("@evil.example/api/servers/x/tunnel")]
[InlineData("api/servers/x/tunnel")]
[InlineData("/api/servers/x/tunnel?elsewhere=1")]
public async Task ATicketNamingAnythingButAPath_IsRefused_AndNothingIsDialled(string path)
{
// The path is appended to the API's own origin. Anything that would move it to another host — and
// take the ticket with it — is not a path.
spelunk.OnTicket = _ => FakeSpelunk.Answer.Json(
HttpStatusCode.OK,
$$"""{"ticket":"{{FakeSpelunk.Ticket}}","path":"{{path}}","subprotocol":"spelunk.tunnel.v1"}""");
var refusal = await Should.ThrowAsync<SpelunkTunnelException>(OpenAsync);
refusal.Message.ShouldContain("does not understand");
spelunk.Requests.ShouldHaveSingleItem();
}
[Theory]
[InlineData("connection refused", "could not connect to port 22 on the server itself (connection refused)")]
[InlineData("Unknown stream kind: tunnel", "too old to open a terminal")]
public async Task AnAgentThatCouldNotReachThePort_SaysSo(string reason, string explanation)
{
spelunk.OnTunnel = socket =>
socket.CloseOutputAsync((WebSocketCloseStatus)4502, reason, CancellationToken.None);
var route = await OpenAsync();
await EndOfStreamAsync(route);
route.Failure.ShouldNotBeNull().ShouldContain(explanation);
}
[Fact]
public async Task AnAgentThatDisconnected_SaysSo()
{
spelunk.OnTunnel = socket =>
socket.CloseOutputAsync((WebSocketCloseStatus)4503, "agent gone", CancellationToken.None);
var route = await OpenAsync();
await EndOfStreamAsync(route);
route.Failure.ShouldNotBeNull().ShouldContain("disconnected from Spelunk");
}
[Fact]
public async Task ANormalClose_IsNotReworded()
{
// 1000 is the SSH server hanging up, and SSH.NET's own account of that is the accurate one.
spelunk.OnTunnel = socket =>
socket.CloseOutputAsync(WebSocketCloseStatus.NormalClosure, string.Empty, CancellationToken.None);
var route = await OpenAsync();
await EndOfStreamAsync(route);
route.Failure.ShouldBeNull();
}
[Fact]
public async Task AKeyWithALineBreakInTheMiddle_IsRefusedBeforeAnythingIsSent()
{
var refusal = await Should.ThrowAsync<SpelunkTunnelException>(
new SpelunkTunnel().OpenAsync(spelunk.ApiBase, ServerId, "spelunk_abc\ndef", 22, Token));
refusal.Message.ShouldContain("does not hold one");
spelunk.Requests.ShouldBeEmpty();
}
[Fact]
public async Task AKeyPastedWithANewline_IsTrimmed()
{
await using var route = await new SpelunkTunnel()
.OpenAsync(spelunk.ApiBase, ServerId, ApiKey + "\r\n", 22, Token);
spelunk.Requests[0].Headers["Authorization"].ShouldBe($"Bearer {ApiKey}");
}
[Fact]
public async Task AnUnreachableSpelunk_SaysWhere()
{
// A port that was listening a moment ago and is not any more.
var closed = new TcpListener(IPAddress.Loopback, 0);
closed.Start();
var port = ((IPEndPoint)closed.LocalEndpoint).Port;
closed.Stop();
var refusal = await Should.ThrowAsync<SpelunkTunnelException>(
new SpelunkTunnel().OpenAsync($"http://127.0.0.1:{port}", ServerId, ApiKey, 22, Token));
refusal.Message.ShouldContain($"could not be reached at http://127.0.0.1:{port}");
}
private Task<SpelunkTunnelRoute> OpenAsync() => spelunk.ApiBase.OpenAsync(port: 22);
/// <summary>Speaks SOCKS5 to the bridge as SSH.NET would, and hands back the open stream.</summary>
private static async Task<TcpClient> ThroughSocksAsync(int port)
{
var client = new TcpClient();
await client.ConnectAsync(IPAddress.Loopback, port, Token);
var stream = client.GetStream();
var name = Encoding.ASCII.GetBytes("203.0.113.10");
await stream.WriteAsync(new byte[] { 5, 1, 0 }, Token);
await stream.ReadExactlyAsync(new byte[2], Token);
await stream.WriteAsync((byte[])[5, 1, 0, 3, (byte)name.Length, .. name, 0, 22], Token);
await stream.ReadExactlyAsync(new byte[10], Token);
return client;
}
/// <summary>Arrives at the bridge and reads until it closes the stream, which it does once Spelunk has.</summary>
private static async Task EndOfStreamAsync(SpelunkTunnelRoute route)
{
using var client = await ThroughSocksAsync(route.Proxy.Port);
var stream = client.GetStream();
var rest = new byte[256];
while (await stream.ReadAsync(rest, Token).AsTask().WaitAsync(Settles, Token) > 0)
{
}
await route.DisposeAsync();
}
}
/// <summary>Opens a tunnel to the test server with the one key and server the suite uses.</summary>
file static class Opening
{
internal static Task<SpelunkTunnelRoute> OpenAsync(this string apiBase, int port) =>
new SpelunkTunnel().OpenAsync(
apiBase,
Guid.Parse("0192f0c8-bbbb-7c3d-8e4f-5a6b7c8d9e0b"),
"spelunk_0123456789abcdefghijklmnopqrstuvwxyzABCDEFG",
port,
TestContext.Current.CancellationToken);
}