@nxgt/janus 0.17.1 → 0.18.0

package/dist/index.js

@@ -7,13 +7,13 @@ import {
   MAX_PAGE_SIZE2,
   pageLimit2,
   invalidCursor2
-} from "./chunks/index-kj3st57z.js";
+} from "./chunks/index-4khsm7mw.js";
 import {
   mintId2,
   isId2,
   mintedAt2,
   createMemoryStores2
-} from "./chunks/index-baazjyvc.js";
+} from "./chunks/index-kvjj5xkp.js";
 import {
   JanusError2,
   UserInvalidError2,
@@ -22,6 +22,7 @@ import {
   TokenError2,
   SecondFactorError2,
   StepUpRequiredError2,
+  MailThrottledError2,
   InvalidCursorError2,
   UnsupportedError2,
   PermissionDepthError2,
@@ -38,7 +39,7 @@ import {
   formatTuple2,
   parseTuple2,
   parseSubject2
-} from "./chunks/index-hnwggyxs.js";
+} from "./chunks/index-kppkcbn5.js";
 
 // src/auth/hashers.ts
 import { randomBytes, scrypt, timingSafeEqual } from "node:crypto";
@@ -303,25 +304,32 @@ function resolveSecondFactor(config, where) {
   };
 }
 
-// src/auth/config/resolve-sign-in.ts
+// src/auth/config/resolve-throttle.ts
 function resolveSignInThrottle(config, where) {
+  return resolveThrottle(config, { option: "signIn", attempts: 10, window: "15m" }, where);
+}
+function resolveMailThrottle(config, where) {
+  return resolveThrottle(config, { option: "mail", attempts: 5, window: "10m" }, where);
+}
+function resolveThrottle(config, defaults, where) {
+  const { option } = defaults;
   if (config !== undefined && (typeof config !== "object" || config === null)) {
-    throw new TypeError(`${where}: signIn must be an object — { throttle }`);
+    throw new TypeError(`${where}: ${option} must be an object — { throttle }`);
   }
   const throttle = config?.throttle ?? {};
   if (throttle === false)
     return null;
-  const at = `${where}: signIn.throttle`;
+  const at = `${where}: ${option}.throttle`;
   if (typeof throttle !== "object" || throttle === null) {
     throw new TypeError(`${at} must be { attempts, window }, or false to count nothing`);
   }
-  const attempts = throttle.attempts ?? 10;
+  const attempts = throttle.attempts ?? defaults.attempts;
   if (!Number.isSafeInteger(attempts) || attempts < 1) {
     throw new TypeError(`${at}.attempts must be a whole number above zero`);
   }
   return {
     attempts,
-    windowMs: parseDuration(throttle.window ?? "15m", `${at}.window`)
+    windowMs: parseDuration(throttle.window ?? defaults.window, `${at}.window`)
   };
 }
 
@@ -372,6 +380,7 @@ function resolveConfig(config, where) {
     tokenTtlMs: resolveTokenTtls(config, where),
     cookie: resolveCookie(config.cookie ?? {}, where),
     signInThrottle: resolveSignInThrottle(config.signIn, where),
+    mailThrottle: resolveMailThrottle(config.mail, where),
     secondFactor: resolveSecondFactor(config.secondFactor, where),
     devices: resolveDevices(config.devices, where)
   };
@@ -419,6 +428,46 @@ function resolveTokenTtls(config, where) {
     stepUp: parseDuration(config.tokens?.stepUp ?? "10m", `${where}: tokens.stepUp`)
   };
 }
+// src/auth/config/warn-throttle-window.ts
+var FLOWS = [
+  "magicLink",
+  "signInCode",
+  "resetPassword",
+  "verifyEmail",
+  "stepUp"
+];
+var UNITS2 = [
+  ["d", 86400000],
+  ["h", 3600000],
+  ["m", 60000],
+  ["s", 1000]
+];
+function show(ms) {
+  const unit = UNITS2.find(([, size]) => ms % size === 0);
+  return unit === undefined ? `${ms}ms` : `${ms / unit[1]}${unit[0]}`;
+}
+function throttleWindowMessage(resolved, where) {
+  const throttle = resolved.mailThrottle;
+  if (throttle === null)
+    return null;
+  const window = show(throttle.windowMs);
+  const shorter = FLOWS.filter((flow) => resolved.tokenTtlMs[flow] < throttle.windowMs);
+  if (shorter.length === 0)
+    return null;
+  const shortest = Math.min(...shorter.map((flow) => resolved.tokenTtlMs[flow]));
+  const parts = shorter.map((flow) => `tokens.${flow} is ${show(resolved.tokenTtlMs[flow])}, shorter than mail.throttle.window, ${window}`);
+  return `${where}: ${parts.join("; ")} — past the limit the last ${shorter.length === 1 ? "token" : "tokens"} sent can expire before the refusal ends. Set mail.throttle.window to ${show(shortest)} or less, or raise ${shorter.map((flow) => `tokens.${flow}`).join(", ")} to ${window} or more.`;
+}
+function warnThrottleWindow(resolved, where) {
+  const message = throttleWindowMessage(resolved, where);
+  if (message === null)
+    return;
+  if (typeof process === "undefined" || typeof process.emitWarning !== "function") {
+    return;
+  }
+  process.emitWarning(message, { code: "JANUS_THROTTLE_WINDOW" });
+}
+
 // src/auth/context/create-context.ts
 function createContext(config, store, relations, capabilities, clock, hasher, verifiers, events = null) {
   let dummy = null;
@@ -726,7 +775,7 @@ function assertStores(stores, where) {
     }
   }
   const sessions = stores.sessions;
-  const collect = sessions.deleteExpiredSessions;
+  const collect = sessions["deleteExpiredSessions"];
   if (collect !== undefined && typeof collect !== "function") {
     throw new TypeError(`${where}: store.sessions.deleteExpiredSessions must be a function or absent`);
   }
@@ -1008,6 +1057,13 @@ function sharedApi(context) {
     types: [...config.types.keys()]
   };
 }
+// src/auth/counter-key.ts
+function counterKey(context, purpose) {
+  const sealer = context.config.secondFactor?.sealer;
+  return sealer === undefined ? Buffer.from(purpose) : derivedKey(sealer, purpose);
+}
+var keyed = (key, parts) => keyedHash(key, parts).toString("base64url");
+
 // src/auth/one-time/codes.ts
 import { timingSafeEqual as timingSafeEqual3 } from "node:crypto";
 
@@ -1173,6 +1229,38 @@ async function insertLink(links, tokenHash) {
     return inserted;
   throw links.counting.vanished();
 }
+// src/auth/mail-requests.ts
+var PURPOSE2 = "janus/mail/requests/v1";
+async function countMailByAddress(context, type, flow, email, where) {
+  await countMail(context, type, flow, { address: normalizeEmail(email) }, where);
+}
+async function countMailByUser(context, type, flow, userId, where) {
+  await countMail(context, type, flow, { userId }, where);
+}
+async function countMail(context, type, flow, counted, where) {
+  const throttle = context.config.mailThrottle;
+  if (throttle === null)
+    return;
+  const key = counterKey(context, PURPOSE2);
+  const subject = "address" in counted ? keyed(key, [flow, "address", counted.address]) : keyed(key, [flow, "user", counted.userId]);
+  const { attempts, endsAt } = await countInWindow(context, {
+    windowMs: throttle.windowMs,
+    spent: "carry",
+    userId: subject,
+    linkHash: (window, link) => hashSecret(keyed(key, [subject, String(window), String(link)])),
+    vanished: () => new StoreFailure2(`${where}: the store dropped the requests it had just counted`, { slot: "tokens", operation: "countAttempt" })
+  });
+  if (attempts <= throttle.attempts)
+    return;
+  const now = context.clock.now().getTime();
+  const byUser = "userId" in counted;
+  throw new MailThrottledError2(`${where}: too many e-mails asked for this ${byUser ? "user" : "address"} — the last one sent still works; use it, or wait for the next window`, {
+    userType: type.name,
+    ...byUser ? { userId: counted.userId } : {},
+    retryAfter: Math.max(1, Math.ceil((endsAt - now) / 1000))
+  });
+}
+
 // src/auth/password-written.ts
 async function endWhatThePasswordOpened(context, userId) {
   const now = context.clock.now();
@@ -1234,6 +1322,7 @@ function resetPasswordFlows(context, type, at) {
     async request(email) {
       const where = at("resetPassword.request");
       passwordRule(type, where);
+      await countMailByAddress(context, type, "resetPassword", String(email), where);
       const record = await holderOfEmail(context, type, String(email));
       if (record === null)
         return null;
@@ -1278,6 +1367,7 @@ function verifyEmailFlows(context, type, at) {
     async send(user) {
       const where = at("verifyEmail.send");
       const record = await getRecord(context, idOf(user), type.name, where);
+      await countMailByUser(context, type, "verifyEmail", record.id, where);
       return issueEmailToken(context, type, "verifyEmail", record, where);
     },
     async confirm(secret) {
@@ -1465,7 +1555,7 @@ async function finishEmailSignIn(context, type, finish, signIn) {
 function magicLinkFlows(context, type, at, finish) {
   return {
     async request(email) {
-      return requestLink(context, type, String(email));
+      return requestLink(context, type, String(email), at("magicLink.request"));
     },
     async confirm(token, options) {
       const where = at("magicLink.confirm");
@@ -1474,7 +1564,8 @@ function magicLinkFlows(context, type, at, finish) {
     }
   };
 }
-async function requestLink(context, type, email) {
+async function requestLink(context, type, email, where) {
+  await countMailByAddress(context, type, "magicLink", email, where);
   const record = await signInHolder(context, type, email);
   if (record === null)
     return null;
@@ -1500,18 +1591,12 @@ async function confirmLink(context, type, finish, secret, where, device) {
 }
 
 // src/auth/sign-in-attempts.ts
-var PURPOSE2 = "janus/sign-in/attempts/v1";
-var UNSEALED = Buffer.from(PURPOSE2);
-function counterKey(context) {
-  const sealer = context.config.secondFactor?.sealer;
-  return sealer === undefined ? UNSEALED : derivedKey(sealer, PURPOSE2);
-}
-var keyed = (key, parts) => keyedHash(key, parts).toString("base64url");
+var PURPOSE3 = "janus/sign-in/attempts/v1";
 async function countLogin(context, type, login, where) {
   const throttle = context.config.signInThrottle;
   if (throttle === null)
     return null;
-  const key = counterKey(context);
+  const key = counterKey(context, PURPOSE3);
   const loginKey = keyed(key, [type.name, login]);
   return countInWindow(context, {
     windowMs: throttle.windowMs,
@@ -1634,7 +1719,7 @@ var RECOVERY_CODES = 10;
 var ALPHABET = "0123456789abcdefghjkmnpqrstvwxyz";
 var LENGTH = 10;
 var SHAPE = /^[0-9a-hjkmnp-tv-z]{10}$/;
-var PURPOSE3 = "janus/second-factor/recovery-codes/v1";
+var PURPOSE4 = "janus/second-factor/recovery-codes/v1";
 function mintRecoveryCodes() {
   return Array.from({ length: RECOVERY_CODES }, () => {
     let code = "";
@@ -1648,7 +1733,7 @@ function readRecoveryCode(typed) {
   const code = typed.toLowerCase().replace(/[\s-]/g, "").replace(/o/g, "0").replace(/[il]/g, "1");
   return SHAPE.test(code) ? code : null;
 }
-var macKey = (sealer, keyId) => derivedKey(sealer, PURPOSE3, keyId);
+var macKey = (sealer, keyId) => derivedKey(sealer, PURPOSE4, keyId);
 var mac = (key, userId, code) => keyedHash(key, [userId, code]);
 function hashRecoveryCode(sealer, userId, code) {
   const read = readRecoveryCode(code) ?? code;
@@ -1759,7 +1844,7 @@ function accountOf(type, record, where) {
 // src/auth/second-factor/app-code-attempts.ts
 var APP_CODE_WINDOW_MS = 15 * 60000;
 var WINDOW_MINUTES = APP_CODE_WINDOW_MS / 60000;
-var PURPOSE4 = "janus/second-factor/regenerate-attempts/v1";
+var PURPOSE5 = "janus/second-factor/regenerate-attempts/v1";
 function linkHash(sealer, record, window, link) {
   const parts = [
     record.id,
@@ -1767,7 +1852,7 @@ function linkHash(sealer, record, window, link) {
     String(record.secondFactor?.lastStep ?? ""),
     String(link)
   ];
-  const key = derivedKey(sealer, PURPOSE4);
+  const key = derivedKey(sealer, PURPOSE5);
   return hashSecret(keyedHash(key, parts).toString("base64url"));
 }
 async function countAppCodeAttempt(context, sealer, record, where) {
@@ -1883,14 +1968,15 @@ function secondFactorFlows(context, type, at) {
 function signInCodeFlows(context, type, at, finish) {
   return {
     async request(email) {
-      return requestCode(context, type, String(email));
+      return requestCode(context, type, String(email), at("signInCode.request"));
     },
     async confirm(challenge, code, options) {
       return confirmCode(context, type, finish, { challenge, code, options }, at);
     }
   };
 }
-async function requestCode(context, type, email) {
+async function requestCode(context, type, email, where) {
+  await countMailByAddress(context, type, "signInCode", email, where);
   const record = await signInHolder(context, type, email);
   if (record === null)
     return null;
@@ -2028,6 +2114,7 @@ async function byEmail(context, type, record, where) {
       operation: where
     });
   }
+  await countMailByUser(context, type, "stepUp", record.id, where);
   const { secret, code, expiresAt } = await issueCode(context, {
     kind: "stepUp",
     userId: record.id,
@@ -2136,7 +2223,7 @@ async function signIn(context, type, finish, input, call) {
   const rule = passwordRule(type, where);
   const hasher = requireHasher(context, where);
   const login = input?.[rule.login];
-  const password = input?.password;
+  const password = input?.["password"];
   const normalized = typeof login === "string" ? rule.normalize(login) : null;
   if (normalized !== null) {
     await countSignInAttempt(context, type, normalized, where);
@@ -2175,7 +2262,7 @@ function passwordFlows(context, type, at, finish) {
       const where = at("signUp");
       const device = deviceHint(context, options, where);
       passwordRule(type, where);
-      if (input?.password === undefined) {
+      if (input?.["password"] === undefined) {
         checkPassword(type, undefined, where);
       }
       const record = await insert(context, type, input, where);
@@ -2320,6 +2407,7 @@ function typeApi(context, type) {
 function janus(config) {
   const where = "janus";
   const resolved = resolveConfig(config, where);
+  warnThrottleWindow(resolved, where);
   const capabilities = assertStores(config.store, where);
   const hasher = config.hasher ?? null;
   const verifiers = [
@@ -2346,7 +2434,7 @@ function janus(config) {
     type.name,
     typeApi(context, type)
   ]));
-  const surface = resolved.single ? { ...shared, ...types.user } : { ...shared, ...types };
+  const surface = resolved.single ? { ...shared, ...types["user"] } : { ...shared, ...types };
   return surface;
 }
 // src/auth/sessions/fresh.ts
@@ -2363,6 +2451,7 @@ export {
   InvalidCursorError2 as InvalidCursorError,
   JanusError2 as JanusError,
   MAX_PAGE_SIZE2 as MAX_PAGE_SIZE,
+  MailThrottledError2 as MailThrottledError,
   NotFoundError2 as NotFoundError,
   PermissionDepthError2 as PermissionDepthError,
   SecondFactorError2 as SecondFactorError,
@@ -2399,5 +2488,5 @@ export {
   systemClock
 };
 
-//# debugId=735288C311F315A564756E2164756E21
+//# debugId=ACD85BEBE6A087E464756E2164756E21
 //# sourceMappingURL=index.js.map