@openchambery/relay-server 1.19.0-beta.4 → 1.19.0-beta.40

package/src/push/config.js

@@ -0,0 +1,145 @@
+import fs from 'node:fs';
+import { isIP } from 'node:net';
+
+export const DEFAULT_HOST = '127.0.0.1';
+export const DEFAULT_PORT = 8788;
+export const DEFAULT_DATABASE_PATH = './data/push-relay.sqlite';
+export const DEFAULT_BUNDLE_ID = 'com.yee94.openchamber';
+export const ENV_PREFIX = 'OPENCHAMBER_PUSH_RELAY_';
+export const DEFAULT_LIMITS = {
+  timestampSkewMs: 300_000,
+  replayMs: 600_000,
+  maxReplayEntries: 10_000,
+  registerLimitPerMinute: 60,
+  sendLimitPerMinute: 60,
+  serverSendLimitPerMinute: 120,
+  maxTokens: 100_000,
+  maxInFlight: 64,
+  maxRateLimitEntries: 10_000,
+  jsonBodyBytes: 16 * 1024,
+};
+
+const LIMIT_KEYS = ['timestampSkewMs', 'replayMs', 'maxReplayEntries', 'registerLimitPerMinute', 'sendLimitPerMinute', 'serverSendLimitPerMinute', 'maxTokens', 'maxInFlight'];
+
+export const resolvePushRelayClientIp = (request, trustProxy = false) => {
+  const remoteAddress = request.socket.remoteAddress ?? 'unknown';
+  if (!trustProxy) return remoteAddress;
+  const forwarded = request.headers['x-forwarded-for'];
+  const candidate = typeof forwarded === 'string' && !forwarded.includes(',') ? forwarded.trim() : '';
+  return isIP(candidate) ? candidate : remoteAddress;
+};
+
+export const formatPushRelayUrl = (host, port) => `http://${isIP(host) === 6 ? `[${host}]` : host}:${port}`;
+
+const upperSnake = (key) => key.replace(/[A-Z]/g, (letter) => `_${letter}`).toUpperCase();
+export const envName = (key) => `${ENV_PREFIX}${upperSnake(key)}`;
+export const fail = (name) => { throw new Error(`Invalid ${name}`); };
+
+export const positive = (name, value) => {
+  if (!/^[1-9][0-9]*$/.test(String(value))) fail(name);
+  const number = Number(value);
+  if (!Number.isSafeInteger(number)) fail(name);
+  return number;
+};
+
+export const bool = (name, value) => {
+  if (value === undefined) return false;
+  if (value === 'true' || value === '1' || value === true) return true;
+  if (value === 'false' || value === '0' || value === false) return false;
+  fail(name);
+};
+
+export const validHost = (name, value) => {
+  if (typeof value !== 'string' || value.trim() !== value || value.length === 0 || value.includes('/') || value.includes('\\') || value.includes('@') || value.includes(':') && !isIP(value) || (!isIP(value) && !/^(?=.{1,253}$)(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)(?:\.(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?))*$/.test(value))) fail(name);
+  return value;
+};
+
+export const validDatabasePath = (name, value) => {
+  if (typeof value !== 'string' || value.trim() !== value || value.length === 0 || value.includes('\0')) fail(name);
+  return value;
+};
+
+export const normalizePem = (value) => (typeof value === 'string' ? value.replace(/\\n/g, '\n').trim() : '');
+
+export const validatePushRelayLimits = (limits) => {
+  if (limits.replayMs < limits.timestampSkewMs * 2 || limits.maxReplayEntries < 1) throw new RangeError('invalid replay limits');
+  if (limits.maxTokens < 1 || limits.maxInFlight < 1 || limits.registerLimitPerMinute < 1 || limits.sendLimitPerMinute < 1 || limits.serverSendLimitPerMinute < 1) {
+    throw new RangeError('invalid push limits');
+  }
+  return limits;
+};
+
+export const normalizePushRelayOptions = (options = {}) => {
+  const limits = validatePushRelayLimits({ ...DEFAULT_LIMITS, ...options.limits });
+  const host = options.host ?? DEFAULT_HOST;
+  validHost('host', host);
+  const port = options.port ?? DEFAULT_PORT;
+  if (!Number.isSafeInteger(port) || port < 0 || port > 65535) fail('port');
+  const databasePath = options.databasePath ?? DEFAULT_DATABASE_PATH;
+  validDatabasePath('databasePath', databasePath);
+  if (!options.apnsProvider) {
+    const apns = options.apns ?? {};
+    if (!apns.keyId || !apns.teamId || !apns.p8 || !apns.bundleId) throw new Error('Invalid APNs configuration');
+  }
+  return {
+    host,
+    port,
+    trustProxy: Boolean(options.trustProxy),
+    databasePath,
+    limits,
+    apns: options.apns,
+    apnsProvider: options.apnsProvider,
+    clock: options.clock,
+    logger: options.logger,
+    resolveClientIp: options.resolveClientIp,
+    store: options.store,
+    http2: options.http2,
+  };
+};
+
+const envValue = (env, key) => {
+  const value = env[envName(key)];
+  return typeof value === 'string' && value.trim().length === 0 ? undefined : value;
+};
+
+const loadP8 = (env) => {
+  const inline = envValue(env, 'apnsP8') ?? env[`${ENV_PREFIX}APNS_P8`];
+  if (typeof inline === 'string' && inline.trim().length > 0) return normalizePem(inline);
+  const p8Path = envValue(env, 'apnsP8Path') ?? env[`${ENV_PREFIX}APNS_P8_PATH`];
+  if (typeof p8Path === 'string' && p8Path.trim().length > 0) {
+    try { return normalizePem(fs.readFileSync(p8Path.trim(), 'utf8')); } catch { fail(`${ENV_PREFIX}APNS_P8_PATH`); }
+  }
+  fail(`${ENV_PREFIX}APNS_P8`);
+};
+
+export const buildPushRelayConfig = (parsed = {}, env = process.env) => {
+  const pick = (key, fallback) => parsed[key] ?? envValue(env, key) ?? fallback;
+  const portValue = pick('port', DEFAULT_PORT);
+  const port = positive(parsed.port !== undefined ? '--port' : envName('port'), portValue);
+  if (port > 65535) fail(parsed.port !== undefined ? '--port' : envName('port'));
+  const host = validHost(parsed.host !== undefined ? '--host' : envName('host'), pick('host', DEFAULT_HOST));
+  const databasePath = validDatabasePath(envName('databasePath'), pick('databasePath', DEFAULT_DATABASE_PATH));
+  const limits = {};
+  for (const key of LIMIT_KEYS) {
+    const value = pick(key, undefined);
+    if (value !== undefined) limits[key] = positive(parsed[key] !== undefined ? `--${upperSnake(key).toLowerCase().replaceAll('_', '-')}` : envName(key), value);
+  }
+  const merged = { ...DEFAULT_LIMITS, ...limits };
+  if (merged.replayMs < merged.timestampSkewMs * 2) fail(parsed.replayMs !== undefined ? '--replay-ms' : envName('replayMs'));
+  validatePushRelayLimits(merged);
+  const keyId = pick('apnsKeyId', env[`${ENV_PREFIX}APNS_KEY_ID`]);
+  const teamId = pick('apnsTeamId', env[`${ENV_PREFIX}APNS_TEAM_ID`]);
+  const bundleId = pick('apnsBundleId', env[`${ENV_PREFIX}APNS_BUNDLE_ID`]) || DEFAULT_BUNDLE_ID;
+  if (typeof keyId !== 'string' || keyId.trim().length === 0) fail(`${ENV_PREFIX}APNS_KEY_ID`);
+  if (typeof teamId !== 'string' || teamId.trim().length === 0) fail(`${ENV_PREFIX}APNS_TEAM_ID`);
+  const p8 = loadP8(env);
+  if (!p8) fail(`${ENV_PREFIX}APNS_P8`);
+  return {
+    host,
+    port,
+    databasePath,
+    trustProxy: parsed.trustProxy ?? bool(envName('trustProxy'), envValue(env, 'trustProxy')),
+    limits: merged,
+    apns: { keyId: keyId.trim(), teamId: teamId.trim(), p8, bundleId: String(bundleId).trim() },
+  };
+};

package/src/push/crypto.js

@@ -0,0 +1,34 @@
+import crypto from 'node:crypto';
+
+const B64 = /^[A-Za-z0-9_-]+$/;
+
+export const canonicalPublicJwkString = (jwk) => JSON.stringify({ crv: jwk.crv, kty: jwk.kty, x: jwk.x, y: jwk.y });
+
+export const b64urlExact = (value, length) => {
+  if (typeof value !== 'string' || !B64.test(value)) return null;
+  try {
+    const decoded = Buffer.from(value, 'base64url');
+    return decoded.length === length && decoded.toString('base64url') === value ? decoded : null;
+  } catch {
+    return null;
+  }
+};
+
+export const parsePublicJwk = (value) => {
+  if (!value || typeof value !== 'object' || Array.isArray(value)) return null;
+  const keys = Object.keys(value);
+  if (keys.length !== 4 || !keys.includes('crv') || !keys.includes('kty') || !keys.includes('x') || !keys.includes('y')) return null;
+  if (value.kty !== 'EC' || value.crv !== 'P-256' || !b64urlExact(value.x, 32) || !b64urlExact(value.y, 32)) return null;
+  return { crv: value.crv, kty: value.kty, x: value.x, y: value.y };
+};
+
+export const deriveServerId = (jwk) => crypto.createHash('sha256').update(canonicalPublicJwkString(jwk)).digest('base64url');
+
+export const verifyP1363 = (message, jwk, signature) => {
+  try {
+    const key = crypto.createPublicKey({ key: { kty: jwk.kty, crv: jwk.crv, x: jwk.x, y: jwk.y }, format: 'jwk' });
+    return crypto.verify('SHA256', Buffer.from(message), { key, dsaEncoding: 'ieee-p1363' }, signature);
+  } catch {
+    return false;
+  }
+};

package/src/push/guard.js

@@ -0,0 +1,145 @@
+export const createReplayGuard = ({ replayMs, maxReplayEntries, now }) => {
+  const replay = new Map();
+  const purge = () => {
+    const ts = now();
+    for (const [key, expiry] of replay) if (expiry <= ts) replay.delete(key);
+  };
+  return {
+    has(key) {
+      purge();
+      return replay.has(key);
+    },
+    remember(key) {
+      purge();
+      if (replay.size >= maxReplayEntries && !replay.has(key)) return false;
+      replay.set(key, now() + replayMs);
+      return true;
+    },
+    clear() { replay.clear(); },
+    get size() { return replay.size; },
+  };
+};
+
+export const createSlidingWindowLimiter = ({ windowMs, maxCount, maxEntries, now }) => {
+  const entries = new Map();
+  const pruneKey = (key, cutoff) => {
+    const stamps = entries.get(key);
+    if (!stamps) return null;
+    let index = 0;
+    while (index < stamps.length && stamps[index] <= cutoff) index += 1;
+    if (index) stamps.splice(0, index);
+    if (stamps.length === 0) { entries.delete(key); return null; }
+    return stamps;
+  };
+  const purge = (cutoff) => {
+    for (const key of [...entries.keys()]) pruneKey(key, cutoff);
+  };
+  return {
+    allow(key) {
+      const ts = now();
+      const cutoff = ts - windowMs;
+      let stamps = pruneKey(key, cutoff);
+      if (!stamps) {
+        if (entries.size >= maxEntries) {
+          purge(cutoff);
+          if (entries.size >= maxEntries) return false;
+        }
+        stamps = [];
+        entries.set(key, stamps);
+      }
+      if (stamps.length >= maxCount) return false;
+      stamps.push(ts);
+      return true;
+    },
+    clear() { entries.clear(); },
+  };
+};
+
+export const createInFlightGate = (maxInFlight) => {
+  const maxWaiters = maxInFlight;
+  let generation = 1;
+  let active = 0;
+  let accepting = true;
+  const waiters = [];
+  const idleWaiters = [];
+  const notifyIdle = () => {
+    if (active !== 0) return;
+    while (idleWaiters.length) idleWaiters.shift()();
+  };
+  return {
+    acquire() {
+      if (!accepting) return Promise.resolve(false);
+      if (active < maxInFlight) {
+        active += 1;
+        return Promise.resolve(generation);
+      }
+      if (waiters.length >= maxWaiters) return Promise.resolve(false);
+      const gen = generation;
+      return new Promise((resolve) => {
+        waiters.push(() => {
+          if (!accepting || generation !== gen) { resolve(false); return; }
+          resolve(generation);
+        });
+      });
+    },
+    release(ticket) {
+      if (ticket !== generation) return;
+      if (accepting) {
+        const next = waiters.shift();
+        if (next) { next(); return; }
+      } else {
+        while (waiters.length) waiters.shift()();
+      }
+      active = Math.max(0, active - 1);
+      notifyIdle();
+    },
+    rejectWaiters() {
+      accepting = false;
+      while (waiters.length) waiters.shift()();
+    },
+    reset() {
+      generation += 1;
+      accepting = true;
+      active = 0;
+      waiters.length = 0;
+      while (idleWaiters.length) idleWaiters.shift()();
+    },
+    whenIdle() {
+      if (active === 0) return Promise.resolve();
+      return new Promise((resolve) => { idleWaiters.push(resolve); });
+    },
+    get active() { return active; },
+    get waiting() { return waiters.length; },
+  };
+};
+
+export const createWorkTracker = () => {
+  let generation = 1;
+  let active = 0;
+  const idleWaiters = [];
+  const notifyIdle = () => {
+    if (active !== 0) return;
+    while (idleWaiters.length) idleWaiters.shift()();
+  };
+  return {
+    begin() {
+      active += 1;
+      const gen = generation;
+      return () => {
+        if (gen !== generation) return;
+        active = Math.max(0, active - 1);
+        notifyIdle();
+      };
+    },
+    whenIdle() {
+      if (active === 0) return Promise.resolve();
+      return new Promise((resolve) => { idleWaiters.push(resolve); });
+    },
+    reset() {
+      generation += 1;
+      active = 0;
+      while (idleWaiters.length) idleWaiters.shift()();
+    },
+    get active() { return active; },
+  };
+};

package/src/push/index.d.ts

@@ -0,0 +1,110 @@
+import type { IncomingMessage } from 'node:http';
+import type { AddressInfo } from 'node:net';
+
+export type PushRelayState = 'idle' | 'starting' | 'running' | 'stopping' | 'stopped';
+export type PushRelayEnv = 'production' | 'sandbox';
+
+export interface PushRelayLimits {
+  timestampSkewMs: number;
+  replayMs: number;
+  maxReplayEntries: number;
+  registerLimitPerMinute: number;
+  sendLimitPerMinute: number;
+  serverSendLimitPerMinute: number;
+  maxTokens: number;
+  maxInFlight: number;
+  maxRateLimitEntries: number;
+  jsonBodyBytes: number;
+}
+
+export interface PushRelayApnsConfig {
+  keyId: string;
+  teamId: string;
+  p8: string;
+  bundleId: string;
+}
+
+export interface PushRelayClock {
+  now: () => number;
+  setTimeout: typeof globalThis.setTimeout;
+  clearTimeout: typeof globalThis.clearTimeout;
+  setInterval: typeof globalThis.setInterval;
+  clearInterval: typeof globalThis.clearInterval;
+  setImmediate: typeof globalThis.setImmediate;
+}
+
+export interface PushApnsSendInput {
+  token: string;
+  env: PushRelayEnv;
+  payload: unknown;
+  collapseId?: string;
+}
+
+export interface PushApnsSendResult {
+  ok: boolean;
+  drop?: boolean;
+}
+
+export interface PushApnsProvider {
+  send(input: PushApnsSendInput): Promise<PushApnsSendResult>;
+  close?(): void;
+}
+
+export interface PushTokenRecord {
+  serverId: string;
+  platform: string;
+  updatedAt: number;
+}
+
+export interface PushTokenStore {
+  get(token: string): PushTokenRecord | null;
+  upsert(token: string, serverId: string, platform: string, updatedAt: number): void;
+  delete(token: string): void;
+  count(): number;
+  close(): void;
+}
+
+export interface PushRelaySnapshotReasons {
+  authRejected: number;
+  policyRejected: number;
+  limited: number;
+  replayRejected: number;
+}
+
+export interface PushRelaySnapshot {
+  state: PushRelayState;
+  tokenCount: number;
+  inFlight: number;
+  replayEntries: number;
+  reasons: PushRelaySnapshotReasons;
+}
+
+export interface PushRelayOptions {
+  host?: string;
+  port?: number;
+  trustProxy?: boolean;
+  databasePath?: string;
+  limits?: Partial<PushRelayLimits>;
+  apns?: PushRelayApnsConfig;
+  apnsProvider?: PushApnsProvider;
+  clock?: Partial<PushRelayClock>;
+  logger?: Pick<Console, 'info' | 'warn' | 'error'>;
+  resolveClientIp?: (request: IncomingMessage) => string;
+  store?: PushTokenStore;
+  http2?: { connect: typeof import('node:http2').connect };
+}
+
+export interface PushRelayServerInstance {
+  start(): Promise<void>;
+  stop(): Promise<void>;
+  address(): string | AddressInfo | null | undefined;
+  readonly url: string | null;
+  getSnapshot(): PushRelaySnapshot;
+}
+
+export function resolvePushRelayClientIp(request: IncomingMessage, trustProxy?: boolean): string;
+export function formatPushRelayUrl(host: string, port: number): string;
+export function canonicalPublicJwkString(jwk: { crv: string; kty: string; x: string; y: string }): string;
+export function deriveServerId(jwk: { crv: string; kty: string; x: string; y: string }): string;
+export function createPushRelayServer(options?: PushRelayOptions): PushRelayServerInstance;
+export function startPushRelayServer(options?: PushRelayOptions): Promise<PushRelayServerInstance>;

package/src/push/index.js

@@ -0,0 +1,3 @@
+export { createPushRelayServer, startPushRelayServer } from './server.js';
+export { resolvePushRelayClientIp, formatPushRelayUrl } from './config.js';
+export { canonicalPublicJwkString, deriveServerId } from './crypto.js';

package/src/push/schema.js

@@ -0,0 +1,108 @@
+import { b64urlExact, parsePublicJwk } from './crypto.js';
+
+export const IOS_TOKEN = /^[0-9a-fA-F]{64}$/;
+export const JSON_BODY_BYTES = 16 * 1024;
+export const APNS_PAYLOAD_BYTES = 4096;
+export const MAX_TOKENS_PER_REQUEST = 100;
+export const MAX_TITLE_BYTES = 256;
+export const MAX_BODY_BYTES = 1024;
+export const MAX_COLLAPSE_ID_BYTES = 64;
+export const MAX_DATA_ENTRIES = 16;
+export const MAX_DATA_KEY_BYTES = 64;
+export const MAX_DATA_VALUE_BYTES = 256;
+export const MAX_DATA_TOTAL_BYTES = 2048;
+
+const bytes = (value) => Buffer.byteLength(value, 'utf8');
+const isSafeInt = (value) => typeof value === 'number' && Number.isSafeInteger(value);
+
+export const isIosToken = (value) => typeof value === 'string' && IOS_TOKEN.test(value);
+
+const parseTs = (value) => (isSafeInt(value) ? value : null);
+const parseSig = (value) => b64urlExact(value, 64);
+
+const parseData = (value) => {
+  if (value === undefined) return {};
+  if (!value || typeof value !== 'object' || Array.isArray(value)) return null;
+  const entries = Object.entries(value);
+  if (entries.length > MAX_DATA_ENTRIES) return null;
+  let total = 0;
+  const data = {};
+  for (const [key, entry] of entries) {
+    if (typeof key !== 'string' || key.length === 0 || key === 'aps' || typeof entry !== 'string') return null;
+    const keyBytes = bytes(key);
+    const valueBytes = bytes(entry);
+    if (keyBytes > MAX_DATA_KEY_BYTES || valueBytes > MAX_DATA_VALUE_BYTES) return null;
+    total += keyBytes + valueBytes;
+    if (total > MAX_DATA_TOTAL_BYTES) return null;
+    data[key] = entry;
+  }
+  return data;
+};
+
+export const buildApnsPayload = ({ title, body, badge, collapseId, data }) => {
+  const alert = { title };
+  if (body) alert.body = body;
+  const aps = { alert, sound: 'default', 'mutable-content': 1 };
+  if (badge !== undefined) aps.badge = badge;
+  if (collapseId) aps['thread-id'] = collapseId;
+  return Object.keys(data).length > 0 ? { aps, ...data } : { aps };
+};
+
+export const validateRegisterBody = (body) => {
+  if (!body || typeof body !== 'object' || Array.isArray(body)) return { error: 'invalid_request' };
+  if (body.platform === 'android') return { error: 'unsupported_platform' };
+  if (body.platform !== 'ios') return { error: 'invalid_request' };
+  if (!isIosToken(body.token)) return { error: 'invalid_request' };
+  const jwk = parsePublicJwk(body.publicKeyJwk);
+  const ts = parseTs(body.ts);
+  const sig = parseSig(body.sig);
+  if (!jwk || ts === null || !sig) return { error: 'invalid_request' };
+  return { value: { token: body.token, platform: 'ios', publicKeyJwk: jwk, ts, sig } };
+};
+
+export const validateSendBody = (body) => {
+  if (!body || typeof body !== 'object' || Array.isArray(body)) return { error: 'invalid_request' };
+  const tokens = body.tokens;
+  if (!Array.isArray(tokens) || tokens.length < 1 || tokens.length > MAX_TOKENS_PER_REQUEST) return { error: 'invalid_request' };
+  if (tokens.some((token) => !isIosToken(token))) return { error: 'invalid_request' };
+  if (typeof body.title !== 'string' || body.title.length === 0 || bytes(body.title) > MAX_TITLE_BYTES) return { error: 'invalid_request' };
+  if (body.body !== undefined && (typeof body.body !== 'string' || bytes(body.body) > MAX_BODY_BYTES)) return { error: 'invalid_request' };
+  if (body.badge !== undefined && (!isSafeInt(body.badge) || body.badge < 0)) return { error: 'invalid_request' };
+  if (body.collapseId !== undefined && (typeof body.collapseId !== 'string' || bytes(body.collapseId) > MAX_COLLAPSE_ID_BYTES)) return { error: 'invalid_request' };
+  if (body.env !== undefined && body.env !== 'production' && body.env !== 'sandbox') return { error: 'invalid_request' };
+  const jwk = parsePublicJwk(body.publicKeyJwk);
+  const ts = parseTs(body.ts);
+  const sig = parseSig(body.sig);
+  const data = parseData(body.data);
+  if (!jwk || ts === null || !sig || !data) return { error: 'invalid_request' };
+  const unique = [];
+  const seen = new Set();
+  for (const token of tokens) {
+    if (seen.has(token)) continue;
+    seen.add(token);
+    unique.push(token);
+  }
+  const payload = buildApnsPayload({
+    title: body.title,
+    body: body.body ?? '',
+    badge: body.badge,
+    collapseId: body.collapseId,
+    data,
+  });
+  if (bytes(JSON.stringify(payload)) > APNS_PAYLOAD_BYTES) return { error: 'invalid_request' };
+  return {
+    value: {
+      tokens,
+      uniqueTokens: unique,
+      title: body.title,
+      body: typeof body.body === 'string' ? body.body : '',
+      badge: body.badge,
+      collapseId: body.collapseId || undefined,
+      env: body.env === 'production' ? 'production' : 'sandbox',
+      publicKeyJwk: jwk,
+      ts,
+      sig,
+      payload,
+    },
+  };
+};