@serve.zone/interfaces 32.3.0 → 32.4.0

package/ts/data/networkcredential.ts

@@ -1,9 +1,11 @@
 import type { IRuntimeAuthorityReference } from './runtimeassignment.js';
+import { runtimeNetworkAddressPlanContract, type TRuntimeNetworkVpnTransport } from './networkaddressplan.js';
 import { snapshotRuntimeSessionBinding, type IRuntimeSessionBinding } from './runtimesession.js';
 import { validateRuntimeNetworkProjection, type IRuntimeNetworkProjection } from './networkprojection.js';
 import { snapshotRuntimeNetworkDnsLeaseRenewal, validateRuntimeNetworkDnsLeaseRenewal } from './networklease.js';
 import { captureNetwork, failNetwork, networkCounter, networkEffectiveDnsWindow, networkEqual, networkId, networkIpv4,
-  networkRecord, networkReference, networkReferenceOf, networkSafe, networkSameScope, requireNetwork } from '../private/networkcontract.js';
+  networkNoiseKey, networkRecord, networkReference, networkReferenceOf, networkSafe, networkSameScope,
+  requireNetwork } from '../private/networkcontract.js';
 
 export interface IGetRuntimeManagedVpnCredentialRequest {
   session: IRuntimeSessionBinding;
@@ -14,8 +16,16 @@ export interface IGetRuntimeManagedVpnCredentialRequest {
  * persist, hash, log, or include it in a signed network projection. The native
  * Noise owner validates and uses the keys; these shapes confer no TUN readiness. */
 export interface IGetRuntimeManagedVpnCredentialResponse extends IGetRuntimeManagedVpnCredentialRequest {
-  transport: 'quic';
-  relay: { id: string; address: string; port: number };
+  transport: TRuntimeNetworkVpnTransport;
+  /** The cluster hub endpoint this node dials, named by the id its signed projection selected. */
+  hub: { id: string; address: string; port: number };
+  /**
+   * The TLS name the hub's WebSocket transport is dialled under, present exactly when `transport`
+   * is `websocket` and absent otherwise: QUIC is dialled on the address alone. It is the hub
+   * relay's own origin hostname, which the node cross-checks against the relay origin it stores,
+   * so a name the node does not already trust ends the handshake before any native effect.
+   */
+  serverName?: string;
   authorityId: string;
   serverPublicKey: string;
   clientPublicKey: string;
@@ -27,28 +37,44 @@ export interface IGetRuntimeManagedVpnCredentialResponse extends IGetRuntimeMana
   expiresAt: number;
 }
 
-/** Canonical 32-byte key encoding only. Cryptographic key agreement and pair
- * validation belong to the native Noise implementation, not this JSON parser. */
-const key = (value: unknown): string => {
-  requireNetwork(typeof value === 'string' && /^[A-Za-z0-9+/]{43}=$/.test(value));
-  const decoded = atob(value);
-  requireNetwork(decoded.length === 32 && btoa(decoded) === value && [...decoded].some(byte => byte.charCodeAt(0) !== 0));
-  return value;
-};
-
 export const snapshotGetRuntimeManagedVpnCredentialRequest = (value: unknown): IGetRuntimeManagedVpnCredentialRequest => networkSafe(() => {
   const item = networkRecord(captureNetwork(value), ['session', 'projection']);
   return { session: snapshotRuntimeSessionBinding(item.session), projection: networkReference(item.projection) };
 });
 
+/**
+ * The TLS name a WebSocket hub is dialled under: a lower-case domain name of at least two labels,
+ * which is what a relay origin's hostname is and what a certificate can be issued for. An address
+ * literal is not one, so a node can never be sent to a name nothing vouches for.
+ */
+const serverName = (value: unknown): string => {
+  requireNetwork(typeof value === 'string' && value.length <= 253);
+  const labels = (value as string).split('.');
+  // The last label starts with a letter, which is what makes this a name and not an address
+  // literal: a hub reached by address is reached over QUIC, which needs no name at all.
+  requireNetwork(labels.length >= 2 && labels.every(label => /^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$/.test(label))
+    && /^[a-z]/.test(labels[labels.length - 1]));
+  return value as string;
+};
+
+const transportOf = (value: unknown): TRuntimeNetworkVpnTransport => {
+  const row = runtimeNetworkAddressPlanContract.hubTransports.find(candidate => candidate.transport === value);
+  requireNetwork(row); return row.transport;
+};
+
 export const snapshotGetRuntimeManagedVpnCredentialResponse = (value: unknown): IGetRuntimeManagedVpnCredentialResponse => networkSafe(() => {
-  const item = networkRecord(captureNetwork(value), ['session', 'projection', 'transport', 'relay', 'authorityId',
-    'serverPublicKey', 'clientPublicKey', 'clientPrivateKey', 'expiresAt']);
-  const relay = networkRecord(item.relay, ['id', 'address', 'port']); requireNetwork(item.transport === 'quic');
-  return { session: snapshotRuntimeSessionBinding(item.session), projection: networkReference(item.projection), transport: 'quic',
-    relay: { id: networkId(relay.id), address: networkIpv4(relay.address), port: networkCounter(relay.port, 65535) },
-    authorityId: networkId(item.authorityId), serverPublicKey: key(item.serverPublicKey), clientPublicKey: key(item.clientPublicKey),
-    clientPrivateKey: key(item.clientPrivateKey), expiresAt: networkCounter(item.expiresAt) };
+  const item = networkRecord(captureNetwork(value), ['session', 'projection', 'transport', 'hub', 'authorityId',
+    'serverPublicKey', 'clientPublicKey', 'clientPrivateKey', 'expiresAt'], ['serverName']);
+  const hub = networkRecord(item.hub, ['id', 'address', 'port']), transport = transportOf(item.transport);
+  // A name belongs to the one transport that is dialled by name; stating it for QUIC would name a
+  // trust the node never checks, and omitting it for WebSocket leaves the TLS identity unstated.
+  requireNetwork(Object.hasOwn(item, 'serverName') === (transport === 'websocket'));
+  return { session: snapshotRuntimeSessionBinding(item.session), projection: networkReference(item.projection), transport,
+    hub: { id: networkId(hub.id), address: networkIpv4(hub.address), port: networkCounter(hub.port, 65535) },
+    ...(transport === 'websocket' ? { serverName: serverName(item.serverName) } : {}),
+    authorityId: networkId(item.authorityId), serverPublicKey: networkNoiseKey(item.serverPublicKey),
+    clientPublicKey: networkNoiseKey(item.clientPublicKey), clientPrivateKey: networkNoiseKey(item.clientPrivateKey),
+    expiresAt: networkCounter(item.expiresAt) };
 });
 
 const bindRequest = (request: IGetRuntimeManagedVpnCredentialRequest,
@@ -70,8 +96,8 @@ export const bindGetRuntimeManagedVpnCredentialRequest = async (value: unknown,
   } catch { return failNetwork(); }
 };
 
-/** Bind the secret response to the original request and exact selected router
- * UDP endpoint, inside the projection's effective DNS window. renewalValue is the
+/** Bind the secret response to the original request and the exact selected router
+ * endpoint of the credential's transport, inside the projection's effective DNS window. renewalValue is the
  * bare lease renewal the caller already verified and admitted for this exact
  * projection, or null; this helper verifies no signature. Time is caller-qualified;
  * this helper does not sample a clock, authenticate a transport, admit policy or
@@ -89,9 +115,11 @@ export const bindGetRuntimeManagedVpnCredentialResponse = async (value: unknown,
     const window = networkEffectiveDnsWindow(projection, renewal);
     bindRequest(request, projection, trusted);
     requireNetwork(networkEqual(response.session, request.session) && networkEqual(response.projection, request.projection));
-    requireNetwork(projection.router?.platformEndpointIds.includes(response.relay.id));
-    const endpoint = projection.protectedAuthority.platformEndpoints.find(item => item.id === response.relay.id);
-    requireNetwork(endpoint && endpoint.protocol === 'udp' && endpoint.address === response.relay.address && endpoint.port === response.relay.port);
+    requireNetwork(projection.router?.platformEndpointIds.includes(response.hub.id));
+    const endpoint = projection.protectedAuthority.platformEndpoints.find(item => item.id === response.hub.id);
+    const expected = runtimeNetworkAddressPlanContract.hubTransports.find(row => row.transport === response.transport);
+    requireNetwork(endpoint && expected && endpoint.protocol === expected.protocol
+      && endpoint.address === response.hub.address && endpoint.port === response.hub.port);
     requireNetwork(window.notBefore <= now && now < response.expiresAt && response.expiresAt <= window.expiresAt);
     return response;
   } catch { return failNetwork(); }

package/ts/data/runtimeassignment.ts

@@ -55,7 +55,20 @@ export interface IRuntimeAssignment extends IRuntimeAssignmentScope {
   /** No automatic relocation or expiry-based claim of a stopped writer. */
   offlinePolicy: 'continue-node-bound';
   workload: {
+    /**
+     * The registry that published this image, which is the publication identity the image release
+     * is bound to. It is never rewritten: only `pullEndpoint` decides where the bytes are fetched.
+     */
     registryHost: string;
+    /**
+     * Where this node fetches the image instead of `registryHost`, as `host[:port]`.
+     *
+     * A cluster whose relay forwards the registry states the relay's own origin here, so a node
+     * pulls inside its cluster and nothing cluster-side dials the control plane. Absent when the
+     * node pulls from the publishing registry itself. The reference stays digest-pinned either
+     * way, so the endpoint decides reachability and never content.
+     */
+    pullEndpoint?: string;
     repository: string;
     imageDigest: TSha256Digest;
     platform: TImmutableContainerPlatform;
@@ -99,7 +112,7 @@ const workloadAuthorityDemands: Readonly<Record<
 export const requiredWorkloadAuthorities = (
   workloadArg: IRuntimeAssignment['workload'],
 ): TRuntimeWorkloadAuthority[] => {
-  if (!isExactRecord(workloadArg, workloadKeys) || !Array.isArray(workloadArg.storage)) {
+  if (!isExactRecord(workloadArg, workloadKeys, optionalWorkloadKeys) || !Array.isArray(workloadArg.storage)) {
     fail(workloadSchemaMessage);
   }
   return runtimeWorkloadAuthorities
@@ -107,6 +120,30 @@ export const requiredWorkloadAuthorities = (
     .sort(compareWireTokens);
 };
 
+/**
+ * The digest-pinned image reference a node pulls this workload by.
+ *
+ * One function decides where the bytes come from: the stated `pullEndpoint`, else the publishing
+ * `registryHost`. The digest is the same either way, so a node that pulls through its cluster's
+ * relay fetches exactly the content the publishing registry named, and a controller and a node can
+ * never disagree about the reference. The workload is read as a wire value, so one whose members
+ * this contract refuses is refused here rather than by a member read.
+ */
+export const buildRuntimeAssignmentImageReference = (
+  workloadArg: IRuntimeAssignment['workload'],
+): string => {
+  if (!isExactRecord(workloadArg, workloadKeys, optionalWorkloadKeys)) {
+    fail(workloadSchemaMessage);
+  }
+  const endpoint = Object.hasOwn(workloadArg, 'pullEndpoint')
+    ? workloadArg.pullEndpoint : workloadArg.registryHost;
+  if (typeof endpoint !== 'string' || typeof workloadArg.repository !== 'string'
+    || !isDigest(workloadArg.imageDigest)) {
+    fail(workloadSchemaMessage);
+  }
+  return buildDigestPinnedImageReference(endpoint, workloadArg.repository, workloadArg.imageDigest);
+};
+
 /** True when a value is exactly a canonical authority list drawn from the authority vocabulary. */
 export const isResolvedWorkloadAuthorities = (
   valueArg: unknown,
@@ -152,18 +189,24 @@ const isPositiveInteger = (valueArg: unknown): valueArg is number =>
 const isDigest = (valueArg: unknown): valueArg is TSha256Digest =>
   typeof valueArg === 'string' && isSha256Digest(valueArg);
 
-/** Reject accessors before reading any fields; do not run input-owned code. */
+/**
+ * Reject accessors before reading any fields; do not run input-owned code.
+ *
+ * Absence stays absence: a stated optional key is read, an omitted one is not defaulted, so a
+ * controller that stated nothing is distinguishable from one that stated a value.
+ */
 const isExactRecord = (
   valueArg: unknown,
   keysArg: readonly string[],
+  optionalKeysArg: readonly string[] = [],
 ): valueArg is Record<string, unknown> => {
   if (!valueArg || typeof valueArg !== 'object' || Array.isArray(valueArg)) return false;
   const prototype = Object.getPrototypeOf(valueArg);
   if (prototype !== Object.prototype && prototype !== null) return false;
   const keys = Reflect.ownKeys(valueArg);
-  return keys.length === keysArg.length && keys.every((keyArg) => {
+  return keysArg.every((keyArg) => keys.includes(keyArg)) && keys.every((keyArg) => {
     const descriptor = Object.getOwnPropertyDescriptor(valueArg, keyArg);
-    return typeof keyArg === 'string' && keysArg.includes(keyArg)
+    return typeof keyArg === 'string' && (keysArg.includes(keyArg) || optionalKeysArg.includes(keyArg))
       && descriptor?.enumerable === true && Object.hasOwn(descriptor, 'value');
   });
 };
@@ -183,6 +226,8 @@ const isAssignmentReference = (valueArg: unknown): valueArg is IRuntimeAssignmen
 /** The workload's exact members, read by the authority vocabulary and by the snapshot alike. */
 const workloadKeys = ['registryHost', 'repository', 'imageDigest', 'platform',
   'config', 'network', 'secrets', 'storage'] as const;
+/** Stated only by a controller that sends the node somewhere else for the image bytes. */
+const optionalWorkloadKeys = ['pullEndpoint'] as const;
 const workloadSchemaMessage = 'runtime assignment workload must use exact immutable references';
 
 const assignmentKeys = [
@@ -213,8 +258,10 @@ const assertAssignment = (valueArg: unknown): IRuntimeAssignment => {
     fail('runtime assignment must bind its exact preceding generation');
   }
   const workload = valueArg.workload;
-  if (!isExactRecord(workload, workloadKeys)
+  if (!isExactRecord(workload, workloadKeys, optionalWorkloadKeys)
     || typeof workload.registryHost !== 'string' || workload.registryHost.length > 253
+    || (Object.hasOwn(workload, 'pullEndpoint')
+      && (typeof workload.pullEndpoint !== 'string' || workload.pullEndpoint.length > 253))
     || typeof workload.repository !== 'string' || workload.repository.length > 255
     || !isDigest(workload.imageDigest)
     || !['linux/amd64', 'linux/arm64'].includes(workload.platform as string)
@@ -227,6 +274,12 @@ const assertAssignment = (valueArg: unknown): IRuntimeAssignment => {
   }
   buildDigestPinnedImageReference(workload.registryHost as string,
     workload.repository as string, workload.imageDigest as TSha256Digest);
+  // The pull endpoint is an OCI registry host like the publishing one, so the same reference the
+  // node builds proves it: an endpoint no reference can name is refused where it is written.
+  if (Object.hasOwn(workload, 'pullEndpoint')) {
+    buildDigestPinnedImageReference(workload.pullEndpoint as string,
+      workload.repository as string, workload.imageDigest as TSha256Digest);
+  }
   let previousId = '';
   for (let index = 0; index < (workload.storage as unknown[]).length; index++) {
     const descriptor = Object.getOwnPropertyDescriptor(workload.storage, String(index));

package/ts/private/networkcontract.ts

@@ -89,6 +89,17 @@ export const networkDigest = (value: unknown): TSha256Digest => {
 export const networkSignature = (value: unknown): string => {
   requireNetwork(typeof value === 'string' && /^[a-f0-9]{128}$/.test(value)); return value;
 };
+/**
+ * One encoding for every Noise key this contract carries — the managed VPN credential's, a relay's
+ * hub advertisement and a cluster's VPN network: canonical 32-byte base64, never the all-zero key.
+ * Key agreement and key-pair validation belong to the native Noise implementation, not to a reader.
+ */
+export const networkNoiseKey = (value: unknown): string => {
+  requireNetwork(typeof value === 'string' && /^[A-Za-z0-9+/]{43}=$/.test(value));
+  const decoded = atob(value as string);
+  requireNetwork(decoded.length === 32 && btoa(decoded) === value && [...decoded].some(byte => byte.charCodeAt(0) !== 0));
+  return value as string;
+};
 export const networkController = (value: unknown): IRuntimeController => {
   const item = networkRecord(value, ['kind', 'id', 'epoch']);
   requireNetwork(item.kind === 'cloudly' || item.kind === 'onebox');

package/ts/requests/cluster.ts

@@ -1,5 +1,6 @@
 import * as userInterfaces from '../data/user.js';
 import * as clusterInterfaces from '../data/cluster.js';
+import type * as clusterVpnInterfaces from '../data/clustervpn.js';
 import type { IClusterRuntime, TClusterRuntimeBlocker } from '../data/clusterruntime.js';
 import type { IServiceRuntimeAssignmentView } from '../data/serviceruntime.js';
 import type * as leaseInterfaces from '../data/networklease.js';
@@ -168,6 +169,40 @@ export interface IReq_Cloudly_Relay_HoldRuntimeNetworkDnsLeaseRenewals extends p
   response: leaseInterfaces.IHoldRuntimeNetworkDnsLeaseRenewalsResponse;
 }
 
+/**
+ * Cloudly pushes one cluster's complete managed VPN to that cluster's relay.
+ *
+ * The relay is its cluster's own hub: it runs the managed VPN server every node of the cluster
+ * dials, so this is the whole authority that hub serves, never a patch. It rides the relay's
+ * already registered session, which is why no cluster is named — the socket names it. The relay
+ * answers with what its hub applied, and refuses a network for another authority or a revision it
+ * has passed with one of `data.applyClusterVpnNetworkRefusals`.
+ */
+export interface IReq_Cloudly_Relay_ApplyClusterVpnNetwork extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Cloudly_Relay_ApplyClusterVpnNetwork
+> {
+  method: 'applyClusterVpnNetwork';
+  request: clusterVpnInterfaces.IApplyClusterVpnNetworkRequest;
+  response: clusterVpnInterfaces.IApplyClusterVpnNetworkResponse;
+}
+
+/**
+ * The relay asks Cloudly for its cluster's current managed VPN.
+ *
+ * A hub daemon starts empty and its lifetime is the relay's own, invisible to Cloudly, so a relay
+ * that just bound its hub pulls the current network instead of waiting for the next push. The
+ * answer is `null` while the cluster has none.
+ */
+export interface IReq_Relay_Cloudly_GetClusterVpnNetwork extends plugins.typedrequestInterfaces.implementsTR<
+  plugins.typedrequestInterfaces.ITypedRequest,
+  IReq_Relay_Cloudly_GetClusterVpnNetwork
+> {
+  method: 'getClusterVpnNetwork';
+  request: clusterVpnInterfaces.TGetClusterVpnNetworkRequest;
+  response: clusterVpnInterfaces.IGetClusterVpnNetworkResponse;
+}
+
 /**
  * deletes a cluster
  */