@ccmsg/cli 0.2.10 → 0.2.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ccmsg/cli",
-  "version": "0.2.10",
+  "version": "0.2.11",
   "description": "The ccmsg daemon, CLI and agent plugins for one instance (= one config home)",
   "license": "MIT",
   "author": "kawaz",
@@ -20,7 +20,7 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@ccmsg/protocol": "1.7.0"
+    "@ccmsg/protocol": "1.8.0"
   },
   "devDependencies": {
     "@types/bun": "^1.3.0",

package/src/auth/auth.ts

@@ -684,12 +684,17 @@ export class Auth {
       throw new OpError("auth_invalid", "この refresh token は使えません");
     }
     if (held.body.iss !== this.deps.self) {
-      // What the client said about this refresh stays here: `auth_rotate`
-      // carries the value and nothing else, and the address the issuer would
-      // see is this instance's rather than the person's. The issuer records
-      // that the family rotated, which is the part it can vouch for.
+      // What the carrier observed goes with the value: the person is at the
+      // other end of this instance's connection and not the issuer's, so these
+      // are only knowable here, and a rotation forwarded without them would be
+      // remembered as a time and nothing else. The issuer writes them
+      // unchecked, as it does the ones it observes itself (contract,
+      // `AuthRotateArgs`).
       const answer = (await this.#atIssuer(held.body.iss, "auth_rotate", {
         refresh_token: value,
+        ...(from.reason === undefined ? {} : { reason: from.reason }),
+        ...(from.ip === undefined ? {} : { ip: from.ip }),
+        ...(from.userAgent === undefined ? {} : { user_agent: from.userAgent }),
       } satisfies AuthRotateArgs)) as AuthRotateResult;
       return { session: { sub: answer.sub, access: answer.access }, refresh: answer.refresh };
     }
@@ -927,8 +932,17 @@ export function authHandlers(auth: Auth) {
       // the URL and the count of tries against it (§2.2).
       return { kind: "register", claims: auth.resolveRegistration(args.token, args.code) };
     },
-    auth_rotate: (input: HandlerInput): AuthRotateResult =>
-      auth.rotate((input.args as unknown as AuthRotateArgs).refresh_token),
+    auth_rotate: (input: HandlerInput): AuthRotateResult => {
+      const args = input.args as unknown as AuthRotateArgs;
+      // The receiving instance's account of the person, taken as stated: it is
+      // the only one that saw them, and `last_refresh` is a hint nothing is
+      // decided by (contract, `AuthRotateArgs`).
+      return auth.rotate(args.refresh_token, {
+        ...(args.reason === undefined ? {} : { reason: args.reason }),
+        ...(args.ip === undefined ? {} : { ip: args.ip }),
+        ...(args.user_agent === undefined ? {} : { userAgent: args.user_agent }),
+      });
+    },
   };
 }
 

package/src/instance/client.ts

@@ -0,0 +1,183 @@
+/** Where a request came from, when something in front of us is forwarding it
+ * (§3.1).
+ *
+ * The address the listener observed is the one thing here that cannot be
+ * claimed, and behind a reverse proxy it is always the proxy's. `X-Forwarded-*`
+ * carries what the proxy saw, but the header is a header: anyone who can reach
+ * the port can write one. The operator names the proxies as CIDR blocks, which
+ * is the only way this instance can tell a forwarding it asked for from a
+ * forwarding a caller invented.
+ *
+ * What is recovered is a hint and not a credential — an address is what a
+ * person recognises their own session by (DR-0001 §2.2), and nothing is
+ * admitted or refused by it. That is also why a wrong answer here is worse than
+ * no answer: a forged address kept on a record is a hint pointing away from
+ * whoever reads it.
+ */
+
+/** One address block, as the operator wrote it. Held as the address's bytes and
+ * how many of its leading bits the block fixes. */
+interface Cidr {
+  readonly bytes: Uint8Array;
+  readonly bits: number;
+}
+
+/** Parse an address, or answer nothing for a text that is not one.
+ *
+ * IPv4 and IPv6 are both read to bytes here rather than compared as text: a
+ * block is a run of bits, and two spellings of one address (`::ffff:127.0.0.1`
+ * and `127.0.0.1`, `::1` and `0:0:0:0:0:0:0:1`) are the same address. An
+ * IPv4-mapped IPv6 address is answered as its four IPv4 bytes, so an operator
+ * who wrote `127.0.0.0/8` is not asked to also write the mapped spelling of it.
+ */
+export function addressBytes(text: string): Uint8Array | undefined {
+  // A zone id names an interface on the host that holds the address, and says
+  // nothing about which address it is.
+  const bare = text.includes("%") ? text.slice(0, text.indexOf("%")) : text;
+  if (bare === "") return undefined;
+  return bare.includes(":") ? ipv6Bytes(bare) : ipv4Bytes(bare);
+}
+
+function ipv4Bytes(text: string): Uint8Array | undefined {
+  const parts = text.split(".");
+  if (parts.length !== 4) return undefined;
+  const bytes = new Uint8Array(4);
+  for (const [index, part] of parts.entries()) {
+    // Leading zeros are refused rather than read: `0177.0.0.1` is one address
+    // to a library that reads it as octal and another to one that does not, and
+    // an address this instance is unsure of is not one to trust a header by.
+    if (!/^(?:0|[1-9][0-9]{0,2})$/.test(part)) return undefined;
+    const value = Number(part);
+    if (value > 255) return undefined;
+    bytes[index] = value;
+  }
+  return bytes;
+}
+
+function ipv6Bytes(text: string): Uint8Array | undefined {
+  const halves = text.split("::");
+  if (halves.length > 2) return undefined;
+  const head = groupsOf(halves[0] ?? "");
+  const tail = halves.length === 2 ? groupsOf(halves[1] ?? "") : [];
+  if (head === undefined || tail === undefined) return undefined;
+  // The address's last group may be written as a dotted IPv4, which is how a
+  // mapped address is spelled; it stands for the two groups it fills.
+  const last = tail.length > 0 ? tail : head;
+  const trailing = last[last.length - 1];
+  let embedded: Uint8Array | undefined;
+  if (trailing !== undefined && trailing.includes(".")) {
+    embedded = ipv4Bytes(trailing);
+    if (embedded === undefined) return undefined;
+    last.pop();
+  }
+  const front = bytesOfGroups(head);
+  const back = bytesOfGroups(tail);
+  if (front === undefined || back === undefined) return undefined;
+  const stated = front.length + back.length + (embedded === undefined ? 0 : 4);
+  // Without `::` the groups are the whole address; with it they are less than
+  // the whole, since it has to stand for at least one group of zeros.
+  if (halves.length === 1 ? stated !== 16 : stated > 14) return undefined;
+  const bytes = new Uint8Array(16);
+  bytes.set(front, 0);
+  const rest = new Uint8Array([...back, ...(embedded ?? [])]);
+  bytes.set(rest, 16 - rest.length);
+  return mappedV4(bytes) ?? bytes;
+}
+
+function bytesOfGroups(groups: readonly string[]): Uint8Array | undefined {
+  const bytes = new Uint8Array(groups.length * 2);
+  for (const [index, group] of groups.entries()) {
+    if (!/^[0-9a-fA-F]{1,4}$/.test(group)) return undefined;
+    const value = Number.parseInt(group, 16);
+    bytes[index * 2] = value >> 8;
+    bytes[index * 2 + 1] = value & 0xff;
+  }
+  return bytes;
+}
+
+/** The four IPv4 bytes of an IPv4-mapped address (`::ffff:0:0/96`), if it is
+ * one. Held as IPv4 so that one written block covers both spellings. */
+function mappedV4(bytes: Uint8Array): Uint8Array | undefined {
+  for (let index = 0; index < 10; index += 1) if (bytes[index] !== 0) return undefined;
+  if (bytes[10] !== 0xff || bytes[11] !== 0xff) return undefined;
+  return bytes.slice(12);
+}
+
+function groupsOf(half: string): string[] | undefined {
+  if (half === "") return [];
+  const groups = half.split(":");
+  return groups.some((group) => group === "") ? undefined : groups;
+}
+
+/** Parse `<address>/<bits>`, or a bare address as the block holding it alone.
+ * Answers nothing for a text that is not a block, which is what lets config
+ * refuse it at load rather than silently trusting nobody. */
+export function parseCidr(text: string): Cidr | undefined {
+  const slash = text.lastIndexOf("/");
+  const address = slash === -1 ? text : text.slice(0, slash);
+  const bytes = addressBytes(address);
+  if (bytes === undefined) return undefined;
+  const width = bytes.length * 8;
+  if (slash === -1) return { bytes, bits: width };
+  const suffix = text.slice(slash + 1);
+  if (!/^(?:0|[1-9][0-9]?[0-9]?)$/.test(suffix)) return undefined;
+  const bits = Number(suffix);
+  if (bits > width) return undefined;
+  return { bytes, bits };
+}
+
+function within(address: Uint8Array, block: Cidr): boolean {
+  // A block fixes bits of one family, so an address of the other is outside it.
+  if (address.length !== block.bytes.length) return false;
+  const whole = block.bits >> 3;
+  for (let index = 0; index < whole; index += 1) {
+    if (address[index] !== block.bytes[index]) return false;
+  }
+  const rest = block.bits & 7;
+  if (rest === 0) return true;
+  const mask = 0xff << (8 - rest);
+  return ((address[whole] ?? 0) & mask) === ((block.bytes[whole] ?? 0) & mask);
+}
+
+/** Whether an address is one of the named blocks. */
+export function trusted(address: string | undefined, blocks: readonly Cidr[]): boolean {
+  if (address === undefined || blocks.length === 0) return false;
+  const bytes = addressBytes(address);
+  if (bytes === undefined) return false;
+  return blocks.some((block) => within(bytes, block));
+}
+
+/** The address the person is at, as far as this instance can tell.
+ *
+ * The observed address when it is not a proxy the operator named — a header
+ * from anyone else is a claim about somebody else and is dropped. When it is
+ * one, `X-Forwarded-For` is read from the right and the first address that is
+ * not itself a trusted proxy is answered: the entries to the right were written
+ * by the proxies in the chain, and the first one outside that chain is the last
+ * value this instance has any reason to believe. Everything further left was
+ * written by whoever was talking to the outermost proxy and could say anything.
+ *
+ * A chain of nothing but trusted proxies leaves the observed address, which is
+ * the honest answer when every value in the header is one of our own hops.
+ */
+export function clientAddress(
+  request: Request,
+  observed: string | undefined,
+  proxies: readonly Cidr[],
+): string | undefined {
+  if (!trusted(observed, proxies)) return observed;
+  const forwarded = request.headers.get("x-forwarded-for");
+  if (forwarded === null) return observed;
+  const hops = forwarded
+    .split(",")
+    .map((hop) => hop.trim())
+    .filter((hop) => hop !== "");
+  for (let index = hops.length - 1; index >= 0; index -= 1) {
+    const hop = hops[index] ?? "";
+    if (addressBytes(hop) === undefined) return observed;
+    if (!trusted(hop, proxies)) return hop;
+  }
+  return observed;
+}
+
+export type { Cidr };

package/src/instance/config.ts

@@ -1,6 +1,7 @@
 import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import { dirname, isAbsolute } from "node:path";
 import type { Endpoint } from "@ccmsg/protocol";
+import { parseCidr } from "./client.ts";
 
 /** Where the instance accepts WebSocket connections, and from whom.
  *
@@ -14,6 +15,15 @@ export interface EntryConfig {
   /** Source addresses allowed to connect. Empty means every address the bind
    * itself already permits, which for the default loopback bind is this host. */
   readonly source_ips: readonly string[];
+  /** Address blocks, in CIDR notation, whose `X-Forwarded-For` this instance
+   * believes.
+   *
+   * Separate from `source_ips` because the two answer different questions: that
+   * one is who may connect at all, this one is whose account of somebody else
+   * to take. A reverse proxy is commonly allowed in without being the only
+   * thing allowed in, and an operator with no proxy leaves this empty and has
+   * every forwarding header ignored. */
+  readonly trusted_proxies: readonly string[];
 }
 
 /** One value a launch recipe's command reads, as the operator declares it. */
@@ -274,10 +284,22 @@ function entryOf(file: string, raw: unknown): EntryConfig {
   if (typeof host !== "string" || host === "") {
     throw new ConfigError(file, "entry.host must be an address to bind");
   }
+  const proxies = stringsOf(file, "entry.trusted_proxies", fields["trusted_proxies"]);
+  // Read here rather than where a request is: a block that parses to nothing
+  // would silently trust nobody, and an operator who wrote one meant to trust
+  // somebody.
+  const unreadable = proxies.filter((block) => parseCidr(block) === undefined);
+  if (unreadable.length > 0) {
+    throw new ConfigError(
+      file,
+      `entry.trusted_proxies must be CIDR blocks, got ${unreadable.join(", ")}`,
+    );
+  }
   return {
     host,
     port,
     source_ips: stringsOf(file, "entry.source_ips", fields["source_ips"]),
+    trusted_proxies: proxies,
   };
 }
 

package/src/instance/instance.ts

@@ -87,6 +87,7 @@ import {
   handleAuth,
   recordsDir,
 } from "../auth/index.ts";
+import { type Cidr, clientAddress, parseCidr } from "./client.ts";
 import { type EntryConfig, type InstanceConfig, loadConfig } from "./config.ts";
 import { completeHandlers } from "./handlers.ts";
 import { acquireLock, type Held, isHeldByUs, type Lock } from "./lock.ts";
@@ -264,7 +265,8 @@ async function bindForMesh(config: InstanceConfig, mesh: Mesh): Promise<MeshWiri
         ? Promise.resolve(failure(undefined, "internal_error", "this instance is still starting"))
         : instance.handle(frame, conn),
     entry: entryPolicy(config, true, () => instance?.auth),
-    route: async (request) => (await mesh.route(request)) ?? (await instance?.route(request)),
+    route: async (request, source) =>
+      (await mesh.route(request)) ?? (await instance?.route(request, source)),
     onConn: (conn, info) => {
       mesh.accept(conn, info);
       instance?.accepted(conn, info);
@@ -313,6 +315,10 @@ export class Instance {
   /** The person's authentication: who may open a connection, and the records
    * that say so (DR-0001). */
   readonly #auth: Auth;
+  /** The forwarding proxies the operator named, read once: a block is config,
+   * and parsing one per request would be work done for every caller to answer
+   * a question the config already settled. */
+  readonly #proxies: readonly Cidr[];
   readonly #handlers: Handlers;
   readonly #capabilities: ReadonlySet<Capability>;
   /** Set the moment shutdown starts, which is the re-entry guard of §8.5 step
@@ -343,6 +349,12 @@ export class Instance {
     now?: () => Timestamp,
   ) {
     this.#conns = wiring?.conns ?? new ConnRegistry();
+    // Config refused anything that does not parse, so what is dropped here is
+    // nothing an operator wrote.
+    this.#proxies = (config.entry?.trusted_proxies ?? []).flatMap((block) => {
+      const parsed = parseCidr(block);
+      return parsed === undefined ? [] : [parsed];
+    });
     this.#mesh = wiring?.mesh;
     this.#boundWs = wiring?.ws;
     // Every capability rests on an upstream, so what is configured is what
@@ -644,7 +656,7 @@ export class Instance {
           },
           // The gateway posts to the address this instance already serves,
           // behind the same entry check (§3.1).
-          route: (request) => this.route(request),
+          route: (request, source) => this.route(request, source),
         }),
       );
     }
@@ -665,11 +677,16 @@ export class Instance {
    * gateway's webhook is the one such route this instance answers itself; the
    * mesh's two are answered before this is asked, because they are served
    * before anything is proven and this instance's own routes are not. */
-  async route(request: Request): Promise<Response | undefined> {
+  async route(request: Request, source?: string): Promise<Response | undefined> {
     // The person's authentication comes first: it is the one route reached
     // before anything is proven, and the gateway's webhook carries its own
     // secret and cannot be confused with it (DR-0001 §2.7).
-    const authorized = await handleAuth(request, { auth: this.#auth, self: this.self }, {});
+    const ip = clientAddress(request, source, this.#proxies);
+    const authorized = await handleAuth(
+      request,
+      { auth: this.#auth, self: this.self },
+      ip === undefined ? {} : { ip },
+    );
     if (authorized !== undefined) return authorized;
     return await this.#gateway.route(request);
   }

package/src/transport/ws.ts

@@ -39,8 +39,13 @@ export interface WsOptions {
    * posts to this instance reaches it at the address it already has, and the
    * entry check of §3.1 runs before this is asked, so a route cannot be
    * reached by anyone the WebSocket could not be. Answering `undefined` leaves
-   * the request to the upgrade, which refuses it. */
-  readonly route?: (request: Request) => Promise<Response | undefined>;
+   * the request to the upgrade, which refuses it.
+   *
+   * `source` is the peer address the server observed, passed for the reason
+   * `allowRequest` is given it: what a route can be told about where a request
+   * came from is written by whoever is in front of us, and only the listener
+   * knows who that actually was. */
+  readonly route?: (request: Request, source: string | undefined) => Promise<Response | undefined>;
 }
 
 /** Accept the webui, and later mesh peers, over WebSocket.
@@ -61,10 +66,11 @@ export function serveWs(options: WsOptions): Listener {
     hostname: options.hostname ?? "127.0.0.1",
     port: options.port,
     async fetch(request, srv) {
-      if (entry.allowRequest?.(request, srv.requestIP(request)?.address) === false) {
+      const source = srv.requestIP(request)?.address;
+      if (entry.allowRequest?.(request, source) === false) {
         return new Response("Forbidden", { status: 403 });
       }
-      const routed = await options.route?.(request);
+      const routed = await options.route?.(request, source);
       if (routed !== undefined) return routed;
       if (!entryPath(new URL(request.url).pathname, path)) {
         return new Response("Not Found", { status: 404 });