Public Access
jaap-jan
b20f7cae04
The relay checkbox said it was not wired up, and the plan said the server half was built and shipped. It was not: there was ADR 0004, the contract records, RelayOptions and a CHECK constraint, and RelayOptions said in its own remarks that there was no endpoint and no dialler. So both halves are built here, as step 3 of docs/reaching-a-host-you-cannot-dial.md. Server, in Features/Relay: - POST /api/v1/relay/tickets makes every decision: the host, Connect on its vault, the relay switched on, and the stored name resolved once and judged by RelayAddressPolicy. Loopback, link-local, 0.0.0.0/8, multicast and the metadata endpoints are refused with no configuration escape, with IPv4-mapped and NAT64 spellings unwrapped first; then the operator's denials, allow-list and private-network switch. What passes goes into a Data Protection ticket, and nothing resolves the name again. Every target refusal is the same 403, so the endpoint cannot be used to map the operator's DNS; the real reason is logged. - GET /api/v1/relay/connect takes the ticket as a second subprotocol, checks its expiry against TimeProvider and spends it with a unique insert into relay_ticket_use before accepting the upgrade. After the upgrade a refusal is a close code: 4502 for a host the server could not reach, 4429 for a limit, 4408 idle, 4409 lifetime, 1001 after a drain. - relay_session is the audit row, written from short-lived scopes. Client: - RelayBridge is a loopback SOCKS5 listener that accepts once and pipes to the relay socket. It rides on the new SshLoopbackProxy.Lifetime, so the connection disposes it on every way a session ends and a failed connect disposes it before throwing. - ServerRelay, exposed as IVaultServer.Relay from /api/v1/meta, asks for the ticket, opens the socket, starts the bridge and turns every refusal into a sentence. - VaultViewModel and TransfersViewModel reach a relayed host through it, never fall back to dialling it directly, and replace SSH.NET's transport error with the relay's own reason when it gave one. Neither side ever cancels a WebSocket operation. Cancelling one aborts the socket, and an aborted socket sends no close frame, which is the only way the client learns the server could not reach the host. AnIdleSession_IsClosedWithTheIdleCode asserts that the code arrives. Three departures from ADR 0004, recorded in it: awaited copy loops rather than Pipelines (same backpressure, two 32 KiB buffers), no ?ticket= fallback, and no device id in the ticket. Tests: API 245, shell 582 (5 skipped), layout 170, SSH 110 including a real login through the bridge, API client 30, contracts 25. Not run: the Android build (its change is copy only) and the Alpine layout oracle.
60 lines
2.6 KiB
C#
60 lines
2.6 KiB
C#
using DodoSSH.Api.Features.Relay;
|
|
using Microsoft.AspNetCore.DataProtection;
|
|
using Microsoft.AspNetCore.DataProtection.KeyManagement;
|
|
using Microsoft.AspNetCore.DataProtection.Repositories;
|
|
using Microsoft.Extensions.Options;
|
|
|
|
namespace DodoSSH.Api.Setup;
|
|
|
|
/// <summary>The relay's services. See ADR 0004.</summary>
|
|
internal static class RelaySetup
|
|
{
|
|
/// <summary>
|
|
/// How much longer than the drain the host waits before it stops regardless.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Room for the close handshakes and the audit rows' final writes once the drain has run out, which
|
|
/// is the part of a shutdown an operator would otherwise lose without noticing.
|
|
/// </remarks>
|
|
private static readonly TimeSpan ShutdownMargin = TimeSpan.FromSeconds(10);
|
|
|
|
internal static IServiceCollection AddDodoRelay(this IServiceCollection services)
|
|
{
|
|
// Singletons: a session outlives the request that opened it, a protector is safe to share, and
|
|
// the network seam holds no state.
|
|
services.AddSingleton<RelayTicketCodec>();
|
|
services.AddSingleton<RelaySessionRegistry>();
|
|
services.AddSingleton<IRelayNetwork, SystemRelayNetwork>();
|
|
|
|
// The application name isolates this deployment's payloads from any other ASP.NET application
|
|
// sharing a key directory, and — unlike the default, which is derived from the content root —
|
|
// is the same on every node, which is what lets any node verify any node's ticket.
|
|
services.AddDataProtection().SetApplicationName("DodoSSH");
|
|
|
|
services.AddOptions<KeyManagementOptions>()
|
|
.Configure<IOptions<RelayOptions>, ILoggerFactory>((keys, relay, loggers) =>
|
|
{
|
|
if (relay.Value.KeyRingDirectory is { Length: > 0 } directory)
|
|
{
|
|
keys.XmlRepository = new FileSystemXmlRepository(new DirectoryInfo(directory), loggers);
|
|
}
|
|
});
|
|
|
|
// Longer than the drain, or the host would stop waiting for live sessions before the drain ADR 0004
|
|
// promises them had run. Harmless with the relay off: nothing else holds a request open that long,
|
|
// and the host stops as soon as the last request has.
|
|
services.AddOptions<HostOptions>()
|
|
.Configure<IOptions<RelayOptions>>((host, relay) =>
|
|
{
|
|
var wanted = relay.Value.DrainTimeout + ShutdownMargin;
|
|
|
|
if (wanted > host.ShutdownTimeout)
|
|
{
|
|
host.ShutdownTimeout = wanted;
|
|
}
|
|
});
|
|
|
|
return services;
|
|
}
|
|
}
|