@owlmeans/server-auth-otp 0.1.18-rc.8 → 0.1.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/README.md +156 -24
  2. package/agent-meta/manifest.json +3 -3
  3. package/agent-meta/skills/server-auth-otp/SKILL.md +64 -30
  4. package/build/challenge.d.ts +7 -0
  5. package/build/challenge.d.ts.map +1 -0
  6. package/build/challenge.js +77 -0
  7. package/build/challenge.js.map +1 -0
  8. package/build/consts.d.ts +16 -1
  9. package/build/consts.d.ts.map +1 -1
  10. package/build/consts.js +14 -1
  11. package/build/consts.js.map +1 -1
  12. package/build/consts.local.d.ts +4 -0
  13. package/build/consts.local.d.ts.map +1 -0
  14. package/build/consts.local.js +50 -0
  15. package/build/consts.local.js.map +1 -0
  16. package/build/errors.d.ts +18 -0
  17. package/build/errors.d.ts.map +1 -0
  18. package/build/errors.js +32 -0
  19. package/build/errors.js.map +1 -0
  20. package/build/index.d.ts +8 -1
  21. package/build/index.d.ts.map +1 -1
  22. package/build/index.js +6 -0
  23. package/build/index.js.map +1 -1
  24. package/build/keys/types.d.ts +10 -0
  25. package/build/keys/types.d.ts.map +1 -0
  26. package/build/keys/types.js +2 -0
  27. package/build/keys/types.js.map +1 -0
  28. package/build/keys.d.ts +4 -0
  29. package/build/keys.d.ts.map +1 -0
  30. package/build/keys.js +10 -0
  31. package/build/keys.js.map +1 -0
  32. package/build/plugin.d.ts.map +1 -1
  33. package/build/plugin.js +18 -18
  34. package/build/plugin.js.map +1 -1
  35. package/build/service.d.ts +1 -1
  36. package/build/service.d.ts.map +1 -1
  37. package/build/service.js +56 -25
  38. package/build/service.js.map +1 -1
  39. package/build/throttle-keys/types.d.ts +8 -0
  40. package/build/throttle-keys/types.d.ts.map +1 -0
  41. package/build/throttle-keys/types.js +2 -0
  42. package/build/throttle-keys/types.js.map +1 -0
  43. package/build/throttle-keys.d.ts +4 -0
  44. package/build/throttle-keys.d.ts.map +1 -0
  45. package/build/throttle-keys.js +9 -0
  46. package/build/throttle-keys.js.map +1 -0
  47. package/build/throttle.d.ts +11 -0
  48. package/build/throttle.d.ts.map +1 -0
  49. package/build/throttle.js +67 -0
  50. package/build/throttle.js.map +1 -0
  51. package/build/types.d.ts +29 -0
  52. package/build/types.d.ts.map +1 -1
  53. package/build/types.local.d.ts +16 -0
  54. package/build/types.local.d.ts.map +1 -0
  55. package/build/types.local.js +2 -0
  56. package/build/types.local.js.map +1 -0
  57. package/package.json +15 -14
  58. package/src/challenge.ts +86 -0
  59. package/src/consts.local.ts +51 -0
  60. package/src/consts.ts +18 -1
  61. package/src/errors.ts +37 -0
  62. package/src/index.ts +8 -1
  63. package/src/keys/types.ts +9 -0
  64. package/src/keys.ts +16 -0
  65. package/src/plugin.ts +21 -25
  66. package/src/service.ts +68 -41
  67. package/src/throttle-keys/types.ts +7 -0
  68. package/src/throttle-keys.ts +17 -0
  69. package/src/throttle.ts +85 -0
  70. package/src/types.local.ts +10 -0
  71. package/src/types.ts +36 -0
  72. package/tests/context.ts +43 -0
  73. package/tests/keys.spec.ts +23 -0
  74. package/tests/service.spec.ts +88 -0
@@ -0,0 +1,32 @@
1
+ import { ResilientError } from '@owlmeans/error';
2
+ export class OtpError extends ResilientError {
3
+ static typeName = 'OtpError';
4
+ constructor(message = 'error') {
5
+ super(OtpError.typeName, `otp:${message}`);
6
+ }
7
+ }
8
+ export class OtpThrottled extends OtpError {
9
+ static typeName = `${OtpError.typeName}Throttled`;
10
+ static httpStatus = 429;
11
+ retryAfter;
12
+ constructor(retryAfter = 1, stack) {
13
+ super(typeof retryAfter === 'string' ? retryAfter : 'throttled');
14
+ this.type = OtpThrottled.typeName;
15
+ this.retryAfter = typeof retryAfter === 'number' ? Math.max(1, Math.ceil(retryAfter)) : 1;
16
+ if (stack != null)
17
+ this.oiriginalStack = stack;
18
+ }
19
+ }
20
+ export class OtpUnavailable extends OtpError {
21
+ static typeName = `${OtpError.typeName}Unavailable`;
22
+ static httpStatus = 503;
23
+ static allowServerErrorStatus = true;
24
+ constructor(message = 'store') {
25
+ super(`unavailable:${message}`);
26
+ this.type = OtpUnavailable.typeName;
27
+ }
28
+ }
29
+ ResilientError.registerErrorClass(OtpError);
30
+ ResilientError.registerErrorClass(OtpThrottled);
31
+ ResilientError.registerErrorClass(OtpUnavailable);
32
+ //# sourceMappingURL=errors.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAEhD,MAAM,OAAO,QAAS,SAAQ,cAAc;IACnC,MAAM,CAAU,QAAQ,GAAG,UAAU,CAAA;IAE5C,YAAY,OAAO,GAAW,OAAO;QACnC,KAAK,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,OAAO,EAAE,CAAC,CAAA;IAC5C,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,QAAQ;IACjC,MAAM,CAAU,QAAQ,GAAG,GAAG,QAAQ,CAAC,QAAQ,WAAW,CAAA;IAC1D,MAAM,CAAC,UAAU,GAAG,GAAG,CAAA;IACd,UAAU,CAAQ;IAElC,YAAY,UAAU,GAAoB,CAAC,EAAE,KAAc;QACzD,KAAK,CAAC,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,CAAA;QAChE,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC,QAAQ,CAAA;QACjC,IAAI,CAAC,UAAU,GAAG,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QACzF,IAAI,KAAK,IAAI,IAAI;YAAE,IAAI,CAAC,cAAc,GAAG,KAAK,CAAA;IAChD,CAAC;CACF;AAED,MAAM,OAAO,cAAe,SAAQ,QAAQ;IACnC,MAAM,CAAU,QAAQ,GAAG,GAAG,QAAQ,CAAC,QAAQ,aAAa,CAAA;IAC5D,MAAM,CAAC,UAAU,GAAG,GAAG,CAAA;IACvB,MAAM,CAAC,sBAAsB,GAAG,IAAI,CAAA;IAE3C,YAAY,OAAO,GAAW,OAAO;QACnC,KAAK,CAAC,eAAe,OAAO,EAAE,CAAC,CAAA;QAC/B,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,QAAQ,CAAA;IACrC,CAAC;CACF;AAED,cAAc,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAA;AAC3C,cAAc,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAA;AAC/C,cAAc,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAA"}
package/build/index.d.ts CHANGED
@@ -1,5 +1,12 @@
1
- export type * from './types.js';
1
+ export * from './types.js';
2
+ export type * from './keys/types.js';
3
+ export type * from './throttle-keys/types.js';
2
4
  export * from './consts.js';
3
5
  export * from './service.js';
4
6
  export * from './plugin.js';
7
+ export * from './errors.js';
8
+ export * from './throttle.js';
9
+ export * from './challenge.js';
10
+ export * from './keys.js';
11
+ export * from './throttle-keys.js';
5
12
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,YAAY,CAAA;AAC/B,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,mBAAmB,iBAAiB,CAAA;AACpC,mBAAmB,0BAA0B,CAAA;AAC7C,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA;AACzB,cAAc,oBAAoB,CAAA"}
package/build/index.js CHANGED
@@ -1,4 +1,10 @@
1
+ export * from './types.js';
1
2
  export * from './consts.js';
2
3
  export * from './service.js';
3
4
  export * from './plugin.js';
5
+ export * from './errors.js';
6
+ export * from './throttle.js';
7
+ export * from './challenge.js';
8
+ export * from './keys.js';
9
+ export * from './throttle-keys.js';
4
10
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAG1B,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,WAAW,CAAA;AACzB,cAAc,oBAAoB,CAAA"}
@@ -0,0 +1,10 @@
1
+ /** The storage keys of one OTP issuance: digests, never the raw address, id or code. */
2
+ export interface OtpKeyHelper {
3
+ /** The challenge record key of an issuance id. */
4
+ otpChallengeKey: (issuanceId: string) => string;
5
+ /** The case-insensitive digest of the address a code was sent to. */
6
+ otpEmailKey: (email: string) => string;
7
+ /** The digest of a code, bound to its issuance. */
8
+ otpCodeHash: (issuanceId: string, code: string) => string;
9
+ }
10
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/keys/types.ts"],"names":[],"mappings":"AAAA,wFAAwF;AACxF,MAAM,WAAW,YAAY;IAC3B,kDAAkD;IAClD,eAAe,EAAE,CAAC,UAAU,EAAE,MAAM,KAAK,MAAM,CAAA;IAC/C,qEAAqE;IACrE,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;IACtC,mDAAmD;IACnD,WAAW,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,MAAM,CAAA;CAC1D"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/keys/types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ import type { OtpKeyHelper } from './keys/types.js';
2
+ export declare const createOtpKeyHelper: () => OtpKeyHelper;
3
+ export declare const otpKeyHelper: OtpKeyHelper;
4
+ //# sourceMappingURL=keys.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../src/keys.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAKnD,eAAO,MAAM,kBAAkB,QAAO,YAOrC,CAAA;AAED,eAAO,MAAM,YAAY,cAAuB,CAAA"}
package/build/keys.js ADDED
@@ -0,0 +1,10 @@
1
+ import { createHash } from 'node:crypto';
2
+ const digest = (scope, value) => createHash('sha256').update(`owlmeans:otp:${scope}\0${value}`).digest('hex');
3
+ export const createOtpKeyHelper = () => {
4
+ const otpChallengeKey = (issuanceId) => `challenge:${digest('issuance', issuanceId)}`;
5
+ const otpEmailKey = (email) => digest('email', email.trim().toLowerCase());
6
+ const otpCodeHash = (issuanceId, code) => digest('code', `${issuanceId}\0${code.trim()}`);
7
+ return { otpChallengeKey, otpEmailKey, otpCodeHash };
8
+ };
9
+ export const otpKeyHelper = createOtpKeyHelper();
10
+ //# sourceMappingURL=keys.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"keys.js","sourceRoot":"","sources":["../src/keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAGxC,MAAM,MAAM,GAAG,CAAC,KAAa,EAAE,KAAa,EAAU,EAAE,CACtD,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,gBAAgB,KAAK,KAAK,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAE9E,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAAiB,EAAE;IACnD,MAAM,eAAe,GAAG,CAAC,UAAkB,EAAU,EAAE,CAAC,aAAa,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,EAAE,CAAA;IACrG,MAAM,WAAW,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAA;IAC1F,MAAM,WAAW,GAAG,CAAC,UAAkB,EAAE,IAAY,EAAU,EAAE,CAC/D,MAAM,CAAC,MAAM,EAAE,GAAG,UAAU,KAAK,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC,CAAA;IAEjD,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,EAAE,CAAA;AACtD,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,YAAY,GAAG,kBAAkB,EAAE,CAAA"}
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAmEvD,sGAAsG;AACtG,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,KAAG,CAG1F,CAAA"}
1
+ {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAmEvD,sGAAsG;AACtG,eAAO,MAAM,eAAe,GAAI,CAAC,SAAS,SAAS,EAAE,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,KAAG,CAG1F,CAAA"}
package/build/plugin.js CHANGED
@@ -1,47 +1,47 @@
1
1
  import { ALL_SCOPES, AuthenFailed, AuthRole, AuthenticationType } from '@owlmeans/auth';
2
- import { registerPlugin } from '@owlmeans/server-auth/manager/plugins';
2
+ import { AuthChallengeReplayPolicy, registerPlugin } from '@owlmeans/server-auth/manager/plugins';
3
3
  import { OTP_AUTH_TYPE, OTP_SERVICE } from '@owlmeans/auth-otp';
4
4
  import { AUTH_IDENTITY_LINKING } from '@owlmeans/server-auth-identity';
5
- import { createIdOfLength, IdStyle } from '@owlmeans/basic-ids';
6
- // Separates the email from the per-request nonce inside the challenge (see init() below).
7
- const CHALLENGE_DELIMITER = '::';
5
+ import { CHALLENGE_DELIMITER } from './consts.local.js';
8
6
  /** Factory that creates the email-OTP AuthPlugin bound to the given context. */
9
7
  const otpPlugin = (context) => ({
10
8
  type: OTP_AUTH_TYPE,
9
+ challengeReplayPolicy: AuthChallengeReplayPolicy.Plugin,
11
10
  init: async (request) => {
12
11
  if (request.userId == null || !request.userId.includes('@')) {
13
12
  throw new AuthenFailed('otp:email');
14
13
  }
15
14
  const email = request.userId.trim().toLowerCase();
16
15
  const otp = context.service(OTP_SERVICE);
17
- await otp.issueChallenge(email);
18
- // The auth manager's anti-replay cache (AUTH_CACHE) keys on this decoded challenge, so it
19
- // must be unique per request — the plaintext email alone would be identical across every
20
- // independent login attempt for that address and collide with a still-cached prior one.
21
- const nonce = createIdOfLength(16, IdStyle.Base58);
22
- return { challenge: `${email}${CHALLENGE_DELIMITER}${nonce}` };
16
+ const issuanceId = await otp.issueChallenge(email);
17
+ return { challenge: `${email}${CHALLENGE_DELIMITER}${issuanceId}` };
23
18
  },
24
19
  authenticate: async (credential) => {
25
- // credential.challenge is "email::nonce" (opened from the signed envelope in makeAuthModel).
26
- const email = credential.challenge?.split(CHALLENGE_DELIMITER)[0];
20
+ // credential.challenge is "email::issuanceId" (opened from the signed envelope).
21
+ const parts = credential.challenge?.split(CHALLENGE_DELIMITER) ?? [];
22
+ const email = parts.length === 2 ? parts[0] : undefined;
23
+ const issuanceId = parts.length === 2 ? parts[1] : undefined;
27
24
  const code = credential.credential;
28
- if (!email || !email.includes('@')) {
25
+ if (!email || !email.includes('@') || !issuanceId) {
29
26
  throw new AuthenFailed('otp:email');
30
27
  }
31
28
  if (!code) {
32
29
  throw new AuthenFailed('otp:code');
33
30
  }
34
31
  const otp = context.service(OTP_SERVICE);
35
- await otp.verifyChallenge(email, code);
32
+ await otp.verifyChallenge(email, issuanceId, code);
36
33
  const identityAlias = context.cfg.otp?.identityAlias ?? AUTH_IDENTITY_LINKING;
37
34
  const identity = context.service(identityAlias);
38
- const entityId = credential.entityId;
35
+ // What arrives on the credential is the organization SLUG the user is logging into — it is
36
+ // what a person can be asked to type. The linked profile below answers with the canonical
37
+ // slug, which is what the token ends up carrying.
38
+ const entitySlug = credential.entitySlug;
39
39
  const details = {
40
40
  type: OTP_AUTH_TYPE,
41
41
  service: 'email',
42
- clientId: entityId ?? 'default',
42
+ clientId: entitySlug ?? 'default',
43
43
  userId: email,
44
- entityId,
44
+ entityId: entitySlug,
45
45
  };
46
46
  let payload = await identity.getLinkedProfile(details);
47
47
  if (payload == null) {
@@ -51,7 +51,7 @@ const otpPlugin = (context) => ({
51
51
  credential.type = AuthenticationType.OneTimeToken;
52
52
  credential.userId = payload.userId;
53
53
  credential.profileId = payload.profileId;
54
- credential.entityId = payload.entityId;
54
+ credential.entitySlug = payload.entitySlug;
55
55
  credential.role = payload.role ?? AuthRole.User;
56
56
  credential.scopes = payload.scopes ?? [ALL_SCOPES];
57
57
  return { token: '' };
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AAEvF,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAA;AAEtE,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAE/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAA;AACtE,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAG/D,0FAA0F;AAC1F,MAAM,mBAAmB,GAAG,IAAI,CAAA;AAEhC,gFAAgF;AAChF,MAAM,SAAS,GAAG,CAA+C,OAAU,EAAc,EAAE,CAAC,CAAC;IAC3F,IAAI,EAAE,aAAa;IAEnB,IAAI,EAAE,KAAK,EAAC,OAAO,EAAC,EAAE;QACpB,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,YAAY,CAAC,WAAW,CAAC,CAAA;QACrC,CAAC;QACD,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;QACjD,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAa,WAAW,CAAC,CAAA;QACpD,MAAM,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;QAC/B,0FAA0F;QAC1F,yFAAyF;QACzF,wFAAwF;QACxF,MAAM,KAAK,GAAG,gBAAgB,CAAC,EAAE,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;QAClD,OAAO,EAAE,SAAS,EAAE,GAAG,KAAK,GAAG,mBAAmB,GAAG,KAAK,EAAE,EAAE,CAAA;IAChE,CAAC;IAED,YAAY,EAAE,KAAK,EAAC,UAAU,EAAC,EAAE;QAC/B,6FAA6F;QAC7F,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAA;QACjE,MAAM,IAAI,GAAG,UAAU,CAAC,UAAU,CAAA;QAElC,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,YAAY,CAAC,WAAW,CAAC,CAAA;QACrC,CAAC;QACD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,YAAY,CAAC,UAAU,CAAC,CAAA;QACpC,CAAC;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAa,WAAW,CAAC,CAAA;QACpD,MAAM,GAAG,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;QAEtC,MAAM,aAAa,GAAI,OAAO,CAAC,GAAW,CAAC,GAAG,EAAE,aAAa,IAAI,qBAAqB,CAAA;QACtF,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAyB,aAAa,CAAC,CAAA;QAEvE,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAA;QACpC,MAAM,OAAO,GAAG;YACd,IAAI,EAAE,aAAa;YACnB,OAAO,EAAE,OAAO;YAChB,QAAQ,EAAE,QAAQ,IAAI,SAAS;YAC/B,MAAM,EAAE,KAAK;YACb,QAAQ;SACT,CAAA;QAED,IAAI,OAAO,GAAG,MAAM,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAA;QACtD,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAA;QACpE,CAAC;QAED,wDAAwD;QACxD,UAAU,CAAC,IAAI,GAAG,kBAAkB,CAAC,YAAY,CAAA;QACjD,UAAU,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAA;QAClC,UAAU,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;QACxC,UAAU,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QACtC,UAAU,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAA;QAC/C,UAAU,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,CAAA;QAElD,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,CAAA;IACtB,CAAC;CACF,CAAC,CAAA;AAEF,sGAAsG;AACtG,MAAM,CAAC,MAAM,eAAe,GAAG,CAA+C,OAAU,EAAK,EAAE;IAC7F,cAAc,CAAC,aAAa,EAAE,SAAiD,CAAC,CAAA;IAChF,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA"}
1
+ {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAA;AACvF,OAAO,EAA2C,yBAAyB,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAA;AAC1I,OAAO,EAAmB,aAAa,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAChF,OAAO,EAA+B,qBAAqB,EAAE,MAAM,gCAAgC,CAAA;AAEnG,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AAEvD,gFAAgF;AAChF,MAAM,SAAS,GAAG,CAA+C,OAAU,EAAc,EAAE,CAAC,CAAC;IAC3F,IAAI,EAAE,aAAa;IACnB,qBAAqB,EAAE,yBAAyB,CAAC,MAAM;IAEvD,IAAI,EAAE,KAAK,EAAC,OAAO,EAAC,EAAE;QACpB,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5D,MAAM,IAAI,YAAY,CAAC,WAAW,CAAC,CAAA;QACrC,CAAC;QACD,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAA;QACjD,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAa,WAAW,CAAC,CAAA;QACpD,MAAM,UAAU,GAAG,MAAM,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;QAClD,OAAO,EAAE,SAAS,EAAE,GAAG,KAAK,GAAG,mBAAmB,GAAG,UAAU,EAAE,EAAE,CAAA;IACrE,CAAC;IAED,YAAY,EAAE,KAAK,EAAC,UAAU,EAAC,EAAE;QAC/B,iFAAiF;QACjF,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,EAAE,KAAK,CAAC,mBAAmB,CAAC,IAAI,EAAE,CAAA;QACpE,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QACvD,MAAM,UAAU,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAC5D,MAAM,IAAI,GAAG,UAAU,CAAC,UAAU,CAAA;QAElC,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YAClD,MAAM,IAAI,YAAY,CAAC,WAAW,CAAC,CAAA;QACrC,CAAC;QACD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,YAAY,CAAC,UAAU,CAAC,CAAA;QACpC,CAAC;QAED,MAAM,GAAG,GAAG,OAAO,CAAC,OAAO,CAAa,WAAW,CAAC,CAAA;QACpD,MAAM,GAAG,CAAC,eAAe,CAAC,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAA;QAElD,MAAM,aAAa,GAAI,OAAO,CAAC,GAAW,CAAC,GAAG,EAAE,aAAa,IAAI,qBAAqB,CAAA;QACtF,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAyB,aAAa,CAAC,CAAA;QAEvE,2FAA2F;QAC3F,0FAA0F;QAC1F,kDAAkD;QAClD,MAAM,UAAU,GAAG,UAAU,CAAC,UAAU,CAAA;QACxC,MAAM,OAAO,GAAG;YACd,IAAI,EAAE,aAAa;YACnB,OAAO,EAAE,OAAO;YAChB,QAAQ,EAAE,UAAU,IAAI,SAAS;YACjC,MAAM,EAAE,KAAK;YACb,QAAQ,EAAE,UAAU;SACrB,CAAA;QAED,IAAI,OAAO,GAAG,MAAM,QAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAA;QACtD,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;YACpB,OAAO,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAA;QACpE,CAAC;QAED,wDAAwD;QACxD,UAAU,CAAC,IAAI,GAAG,kBAAkB,CAAC,YAAY,CAAA;QACjD,UAAU,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAA;QAClC,UAAU,CAAC,SAAS,GAAG,OAAO,CAAC,SAAS,CAAA;QACxC,UAAU,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAA;QAC1C,UAAU,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,CAAA;QAC/C,UAAU,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,CAAA;QAElD,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,CAAA;IACtB,CAAC;CACF,CAAC,CAAA;AAEF,sGAAsG;AACtG,MAAM,CAAC,MAAM,eAAe,GAAG,CAA+C,OAAU,EAAK,EAAE;IAC7F,cAAc,CAAC,aAAa,EAAE,SAA8B,CAAC,CAAA;IAC7D,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA"}
@@ -1,3 +1,3 @@
1
- import type { OtpService } from '@owlmeans/auth-otp';
1
+ import { type OtpService } from '@owlmeans/auth-otp';
2
2
  export declare const makeOtpService: (alias?: string) => OtpService;
3
3
  //# sourceMappingURL=service.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAgBpD,eAAO,MAAM,cAAc,GAAI,cAAmB,KAAG,UA+CpD,CAAA"}
1
+ {"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,UAAU,EAAwF,MAAM,oBAAoB,CAAA;AAqB1I,eAAO,MAAM,cAAc,sBAA0B,UA0EpD,CAAA"}
package/build/service.js CHANGED
@@ -1,51 +1,82 @@
1
1
  import { appendContextual } from '@owlmeans/context';
2
2
  import { AuthenFailed } from '@owlmeans/auth';
3
- import { OTP_SERVICE, OTP_RESOURCE, OTP_TTL_SECONDS, OTP_CODE_LENGTH } from '@owlmeans/auth-otp';
3
+ import { OTP_SERVICE, OTP_TTL_SECONDS, OTP_CODE_LENGTH, OTP_MAX_FAILED_ATTEMPTS, OTP_RESOURCE } from '@owlmeans/auth-otp';
4
4
  import { MAILER_SERVICE } from '@owlmeans/mailer';
5
- const codeKey = (email) => email.toLowerCase().replace(/[^a-z0-9]/g, '_');
5
+ import { randomBytes, randomInt } from 'node:crypto';
6
+ import { OtpChallengeOutcome, OTP_CHALLENGE_STORE } from './consts.js';
7
+ import { throttleKeyHelper } from './throttle-keys.js';
8
+ import { otpKeyHelper } from './keys.js';
9
+ import { OtpThrottled, OtpUnavailable } from './errors.js';
10
+ import { makeRedisOtpChallengeStore } from './challenge.js';
11
+ import { logger, logThrottle } from '@owlmeans/log';
12
+ const log = logger('server-auth-otp');
13
+ /** An e-mail as a log may carry it: its domain only. */
14
+ const domainOf = (email) => email.slice(email.lastIndexOf('@') + 1);
15
+ const generateCode = () => {
16
+ const digits = randomInt(0, Math.pow(10, OTP_CODE_LENGTH));
17
+ return String(digits).padStart(OTP_CODE_LENGTH, '0');
18
+ };
6
19
  export const makeOtpService = (alias = OTP_SERVICE) => {
20
+ let fallbackChallenges;
21
+ const challengeStore = (ctx) => {
22
+ const challengeAlias = ctx.cfg.otp?.challengeStoreAlias ?? OTP_CHALLENGE_STORE;
23
+ if (ctx.hasService(challengeAlias))
24
+ return ctx.service(challengeAlias);
25
+ // Backwards-compatible secure default: existing consumers that registered only OTP_RESOURCE
26
+ // still get the atomic Redis store. New consumers can inject the real memory implementation.
27
+ if (fallbackChallenges == null) {
28
+ fallbackChallenges = makeRedisOtpChallengeStore(`${alias}:redis-challenge`, ctx.cfg.otp?.resourceAlias ?? OTP_RESOURCE);
29
+ fallbackChallenges.registerContext(ctx);
30
+ }
31
+ return fallbackChallenges;
32
+ };
7
33
  const service = appendContextual(alias, {
8
34
  issueChallenge: async (email) => {
9
35
  const ctx = service.ctx;
10
- const resourceAlias = ctx.cfg.otp?.resourceAlias ?? OTP_RESOURCE;
11
36
  const mailerAlias = ctx.cfg.otp?.mailerAlias ?? MAILER_SERVICE;
12
- const resource = ctx.resource(resourceAlias);
37
+ const challenges = challengeStore(ctx);
13
38
  const mailer = ctx.service(mailerAlias);
14
39
  const code = generateCode();
15
- const id = codeKey(email);
16
- // Upsert: delete previous code if any, then create fresh.
17
- try {
18
- await resource.delete(id);
40
+ const issuanceId = randomBytes(18).toString('base64url');
41
+ const throttleAlias = ctx.cfg.otp?.throttleAlias;
42
+ const throttleRules = ctx.cfg.otp?.throttleRules;
43
+ if (throttleAlias != null && throttleRules != null) {
44
+ const decision = await ctx.service(throttleAlias)
45
+ .consume(throttleKeyHelper.emailThrottleKey(email), throttleRules, issuanceId);
46
+ if (!decision.allowed) {
47
+ if (logThrottle(`otp-throttled:${otpKeyHelper.otpEmailKey(email)}`, 60_000)) {
48
+ log.warn('Login code refused: throttled', {
49
+ reason: 'otp-throttled', emailDomain: domainOf(email), retryAfter: decision.retryAfter,
50
+ }, { event: 'auth.refused' });
51
+ }
52
+ throw new OtpThrottled(decision.retryAfter);
53
+ }
19
54
  }
20
- catch { /* key may not exist */ }
21
- await resource.create({ id, code }, { ttl: OTP_TTL_SECONDS });
55
+ const issued = await challenges.issue({
56
+ id: otpKeyHelper.otpChallengeKey(issuanceId),
57
+ emailKey: otpKeyHelper.otpEmailKey(email),
58
+ codeHash: otpKeyHelper.otpCodeHash(issuanceId, code),
59
+ }, OTP_TTL_SECONDS);
60
+ if (!issued)
61
+ throw new OtpUnavailable('issuance-collision');
22
62
  await mailer.send({
23
63
  to: email,
24
64
  subject: 'Your login code',
25
65
  text: `Your one-time login code is: ${code}\n\nIt expires in ${OTP_TTL_SECONDS / 60} minutes.`,
26
66
  html: `<p>Your one-time login code is: <strong>${code}</strong></p><p>It expires in ${OTP_TTL_SECONDS / 60} minutes.</p>`,
27
67
  });
68
+ return issuanceId;
28
69
  },
29
- verifyChallenge: async (email, code) => {
70
+ verifyChallenge: async (email, issuanceId, code) => {
30
71
  const ctx = service.ctx;
31
- const resourceAlias = ctx.cfg.otp?.resourceAlias ?? OTP_RESOURCE;
32
- const resource = ctx.resource(resourceAlias);
33
- const id = codeKey(email);
34
- const record = await resource.load(id);
35
- if (record == null || record.code !== code.trim()) {
72
+ const outcome = await challengeStore(ctx).verify(otpKeyHelper.otpChallengeKey(issuanceId), otpKeyHelper.otpEmailKey(email), otpKeyHelper.otpCodeHash(issuanceId, code), OTP_MAX_FAILED_ATTEMPTS);
73
+ if (outcome !== OtpChallengeOutcome.Verified) {
74
+ // The sign-in refusal itself (`auth.refused`) is logged where the manager decides sign-in.
75
+ log.debug('OTP challenge refused', { outcome, emailDomain: domainOf(email) });
36
76
  throw new AuthenFailed('otp:code');
37
77
  }
38
- // Consume: delete so the code cannot be reused.
39
- try {
40
- await resource.delete(id);
41
- }
42
- catch { /* already expired */ }
43
78
  },
44
79
  });
45
80
  return service;
46
81
  };
47
- const generateCode = () => {
48
- const digits = Math.floor(Math.random() * Math.pow(10, OTP_CODE_LENGTH));
49
- return String(digits).padStart(OTP_CODE_LENGTH, '0');
50
- };
51
82
  //# sourceMappingURL=service.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAIhG,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAQjD,MAAM,OAAO,GAAG,CAAC,KAAa,EAAU,EAAE,CACxC,KAAK,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,CAAA;AAEhD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAK,GAAG,WAAW,EAAc,EAAE;IAChE,MAAM,OAAO,GAAe,gBAAgB,CAAa,KAAK,EAAE;QAC9D,cAAc,EAAE,KAAK,EAAE,KAAa,EAAiB,EAAE;YACrD,MAAM,GAAG,GAAG,OAAO,CAAC,GAA4B,CAAA;YAChD,MAAM,aAAa,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,aAAa,IAAI,YAAY,CAAA;YAChE,MAAM,WAAW,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,IAAI,cAAc,CAAA;YAC9D,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAA2B,aAAa,CAAC,CAAA;YACtE,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAgB,WAAW,CAAC,CAAA;YAEtD,MAAM,IAAI,GAAG,YAAY,EAAE,CAAA;YAC3B,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAA;YAEzB,0DAA0D;YAC1D,IAAI,CAAC;gBACH,MAAM,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YAC3B,CAAC;YAAC,MAAM,CAAC,CAAC,uBAAuB,CAAC,CAAC;YAEnC,MAAM,QAAQ,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,eAAe,EAAE,CAAC,CAAA;YAE7D,MAAM,MAAM,CAAC,IAAI,CAAC;gBAChB,EAAE,EAAE,KAAK;gBACT,OAAO,EAAE,iBAAiB;gBAC1B,IAAI,EAAE,gCAAgC,IAAI,qBAAqB,eAAe,GAAG,EAAE,WAAW;gBAC9F,IAAI,EAAE,2CAA2C,IAAI,iCAAiC,eAAe,GAAG,EAAE,eAAe;aAC1H,CAAC,CAAA;QACJ,CAAC;QAED,eAAe,EAAE,KAAK,EAAE,KAAa,EAAE,IAAY,EAAiB,EAAE;YACpE,MAAM,GAAG,GAAG,OAAO,CAAC,GAA4B,CAAA;YAChD,MAAM,aAAa,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,aAAa,IAAI,YAAY,CAAA;YAChE,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAA2B,aAAa,CAAC,CAAA;YAEtE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAA;YACzB,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAEtC,IAAI,MAAM,IAAI,IAAI,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;gBAClD,MAAM,IAAI,YAAY,CAAC,UAAU,CAAC,CAAA;YACpC,CAAC;YAED,gDAAgD;YAChD,IAAI,CAAC;gBACH,MAAM,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YAC3B,CAAC;YAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,CAAC;QACnC,CAAC;KACF,CAAC,CAAA;IAEF,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AAED,MAAM,YAAY,GAAG,GAAW,EAAE;IAChC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,eAAe,CAAC,CAAC,CAAA;IACxE,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,eAAe,EAAE,GAAG,CAAC,CAAA;AACtD,CAAC,CAAA"}
1
+ {"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAmB,WAAW,EAAE,eAAe,EAAE,eAAe,EAAE,uBAAuB,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAC1I,OAAO,EAAsB,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACrE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAEpD,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAC1D,OAAO,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAA;AAC3D,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AAEnD,MAAM,GAAG,GAAG,MAAM,CAAC,iBAAiB,CAAC,CAAA;AAErC,wDAAwD;AACxD,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;AAEnF,MAAM,YAAY,GAAG,GAAW,EAAE;IAChC,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,eAAe,CAAC,CAAC,CAAA;IAC1D,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,eAAe,EAAE,GAAG,CAAC,CAAA;AACtD,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAK,GAAG,WAAW,EAAc,EAAE;IAChE,IAAI,kBAAiD,CAAA;IAErD,MAAM,cAAc,GAAG,CAAC,GAA0B,EAAqB,EAAE;QACvE,MAAM,cAAc,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,mBAAmB,IAAI,mBAAmB,CAAA;QAC9E,IAAI,GAAG,CAAC,UAAU,CAAC,cAAc,CAAC;YAAE,OAAO,GAAG,CAAC,OAAO,CAAoB,cAAc,CAAC,CAAA;QAEzF,4FAA4F;QAC5F,6FAA6F;QAC7F,IAAI,kBAAkB,IAAI,IAAI,EAAE,CAAC;YAC/B,kBAAkB,GAAG,0BAA0B,CAC7C,GAAG,KAAK,kBAAkB,EAAE,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,aAAa,IAAI,YAAY,CACvE,CAAA;YACD,kBAAkB,CAAC,eAAe,CAAC,GAAG,CAAC,CAAA;QACzC,CAAC;QACD,OAAO,kBAAkB,CAAA;IAC3B,CAAC,CAAA;IAED,MAAM,OAAO,GAAe,gBAAgB,CAAa,KAAK,EAAE;QAC9D,cAAc,EAAE,KAAK,EAAE,KAAa,EAAmB,EAAE;YACvD,MAAM,GAAG,GAAG,OAAO,CAAC,GAA4B,CAAA;YAChD,MAAM,WAAW,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,IAAI,cAAc,CAAA;YAC9D,MAAM,UAAU,GAAG,cAAc,CAAC,GAAG,CAAC,CAAA;YACtC,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAgB,WAAW,CAAC,CAAA;YACtD,MAAM,IAAI,GAAG,YAAY,EAAE,CAAA;YAC3B,MAAM,UAAU,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;YAExD,MAAM,aAAa,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,aAAa,CAAA;YAChD,MAAM,aAAa,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,aAAa,CAAA;YAChD,IAAI,aAAa,IAAI,IAAI,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;gBACnD,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,OAAO,CAAsB,aAAa,CAAC;qBACnE,OAAO,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,aAAa,EAAE,UAAU,CAAC,CAAA;gBAChF,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;oBACtB,IAAI,WAAW,CAAC,iBAAiB,YAAY,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,EAAE,MAAM,CAAC,EAAE,CAAC;wBAC5E,GAAG,CAAC,IAAI,CAAC,+BAA+B,EAAE;4BACxC,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU;yBACvF,EAAE,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAA;oBAC/B,CAAC;oBACD,MAAM,IAAI,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;gBAC7C,CAAC;YACH,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC;gBACpC,EAAE,EAAE,YAAY,CAAC,eAAe,CAAC,UAAU,CAAC;gBAC5C,QAAQ,EAAE,YAAY,CAAC,WAAW,CAAC,KAAK,CAAC;gBACzC,QAAQ,EAAE,YAAY,CAAC,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC;aACrD,EAAE,eAAe,CAAC,CAAA;YACnB,IAAI,CAAC,MAAM;gBAAE,MAAM,IAAI,cAAc,CAAC,oBAAoB,CAAC,CAAA;YAE3D,MAAM,MAAM,CAAC,IAAI,CAAC;gBAChB,EAAE,EAAE,KAAK;gBACT,OAAO,EAAE,iBAAiB;gBAC1B,IAAI,EAAE,gCAAgC,IAAI,qBAAqB,eAAe,GAAG,EAAE,WAAW;gBAC9F,IAAI,EAAE,2CAA2C,IAAI,iCAAiC,eAAe,GAAG,EAAE,eAAe;aAC1H,CAAC,CAAA;YAEF,OAAO,UAAU,CAAA;QACnB,CAAC;QAED,eAAe,EAAE,KAAK,EAAE,KAAa,EAAE,UAAkB,EAAE,IAAY,EAAiB,EAAE;YACxF,MAAM,GAAG,GAAG,OAAO,CAAC,GAA4B,CAAA;YAChD,MAAM,OAAO,GAAG,MAAM,cAAc,CAAC,GAAG,CAAC,CAAC,MAAM,CAC9C,YAAY,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC,UAAU,EAAE,IAAI,CAAC,EACrH,uBAAuB,CACxB,CAAA;YACD,IAAI,OAAO,KAAK,mBAAmB,CAAC,QAAQ,EAAE,CAAC;gBAC7C,2FAA2F;gBAC3F,GAAG,CAAC,KAAK,CAAC,uBAAuB,EAAE,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;gBAC7E,MAAM,IAAI,YAAY,CAAC,UAAU,CAAC,CAAA;YACpC,CAAC;QACH,CAAC;KACF,CAAC,CAAA;IAEF,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA"}
@@ -0,0 +1,8 @@
1
+ /** Throttle subjects as non-raw keys: digests of what a request is throttled by. */
2
+ export interface ThrottleKeyHelper {
3
+ /** Collision-resistant, non-raw key for case-insensitive email throttles. */
4
+ emailThrottleKey: (email: string) => string;
5
+ /** Non-raw key for request-source throttles. Callers remain responsible for trusted-proxy parsing. */
6
+ ipThrottleKey: (ip: string) => string;
7
+ }
8
+ //# sourceMappingURL=types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/throttle-keys/types.ts"],"names":[],"mappings":"AAAA,oFAAoF;AACpF,MAAM,WAAW,iBAAiB;IAChC,6EAA6E;IAC7E,gBAAgB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;IAC3C,sGAAsG;IACtG,aAAa,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,CAAA;CACtC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/throttle-keys/types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,4 @@
1
+ import type { ThrottleKeyHelper } from './throttle-keys/types.js';
2
+ export declare const createThrottleKeyHelper: () => ThrottleKeyHelper;
3
+ export declare const throttleKeyHelper: ThrottleKeyHelper;
4
+ //# sourceMappingURL=throttle-keys.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"throttle-keys.d.ts","sourceRoot":"","sources":["../src/throttle-keys.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAKjE,eAAO,MAAM,uBAAuB,QAAO,iBAQ1C,CAAA;AAED,eAAO,MAAM,iBAAiB,mBAA4B,CAAA"}
@@ -0,0 +1,9 @@
1
+ import { createHash } from 'node:crypto';
2
+ const digestKey = (kind, value) => createHash('sha256').update(`owlmeans:throttle:${kind}\0${value}`).digest('hex');
3
+ export const createThrottleKeyHelper = () => {
4
+ const emailThrottleKey = (email) => `email:${digestKey('email', email.trim().toLowerCase())}`;
5
+ const ipThrottleKey = (ip) => `ip:${digestKey('ip', ip.trim().toLowerCase())}`;
6
+ return { emailThrottleKey, ipThrottleKey };
7
+ };
8
+ export const throttleKeyHelper = createThrottleKeyHelper();
9
+ //# sourceMappingURL=throttle-keys.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"throttle-keys.js","sourceRoot":"","sources":["../src/throttle-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAGxC,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,KAAa,EAAU,EAAE,CACxD,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,qBAAqB,IAAI,KAAK,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAElF,MAAM,CAAC,MAAM,uBAAuB,GAAG,GAAsB,EAAE;IAC7D,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAU,EAAE,CACjD,SAAS,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,EAAE,CAAA;IAE3D,MAAM,aAAa,GAAG,CAAC,EAAU,EAAU,EAAE,CAC3C,MAAM,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,EAAE,CAAA;IAElD,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,CAAA;AAC5C,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,iBAAiB,GAAG,uBAAuB,EAAE,CAAA"}
@@ -0,0 +1,11 @@
1
+ import type { AuthThrottleService } from './types.js';
2
+ import type { Clock } from './types.local.js';
3
+ /** Real in-memory implementation for single-process development and deterministic unit tests. */
4
+ export declare const makeMemoryThrottleService: (alias?: string, now?: Clock) => AuthThrottleService;
5
+ /** Redis implementation: every configured window is checked and consumed in one Lua operation. */
6
+ export declare const makeRedisThrottleService: (alias?: string, resourceAlias?: string) => AuthThrottleService;
7
+ /** @deprecated compat:factory-refactor — use `throttleKeyHelper.emailThrottleKey(…)` */
8
+ export declare const emailThrottleKey: (email: string) => string;
9
+ /** @deprecated compat:factory-refactor — use `throttleKeyHelper.ipThrottleKey(…)` */
10
+ export declare const ipThrottleKey: (ip: string) => string;
11
+ //# sourceMappingURL=throttle.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"throttle.d.ts","sourceRoot":"","sources":["../src/throttle.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,mBAAmB,EAAyD,MAAM,YAAY,CAAA;AAG5G,OAAO,KAAK,EAAE,KAAK,EAA0B,MAAM,kBAAkB,CAAA;AAUrE,iGAAiG;AACjG,eAAO,MAAM,yBAAyB,yBACD,KAAK,KACvC,mBAyBF,CAAA;AAED,kGAAkG;AAClG,eAAO,MAAM,wBAAwB,8CAElC,mBA4BF,CAAA;AAED,wFAAwF;AACxF,eAAO,MAAM,gBAAgB,UAAW,MAAM,KAAG,MAAmD,CAAA;AAEpG,qFAAqF;AACrF,eAAO,MAAM,aAAa,OAAQ,MAAM,KAAG,MAA6C,CAAA"}
@@ -0,0 +1,67 @@
1
+ import { randomBytes } from 'node:crypto';
2
+ import { createService, appendContextual } from '@owlmeans/context';
3
+ import { OtpUnavailable } from './errors.js';
4
+ import { OTP_RESOURCE, OTP_THROTTLE_SERVICE } from './consts.js';
5
+ import { REDIS_THROTTLE_SCRIPT } from './consts.local.js';
6
+ import { throttleKeyHelper } from './throttle-keys.js';
7
+ const assertRules = (rules) => {
8
+ if (rules.length === 0 || rules.some(rule => !Number.isInteger(rule.limit) || rule.limit < 1
9
+ || !Number.isInteger(rule.windowSeconds) || rule.windowSeconds < 1)) {
10
+ throw new SyntaxError('auth-otp throttle rules require positive integer limits and windows');
11
+ }
12
+ };
13
+ /** Real in-memory implementation for single-process development and deterministic unit tests. */
14
+ export const makeMemoryThrottleService = (alias = OTP_THROTTLE_SERVICE, now = Date.now) => {
15
+ const events = new Map();
16
+ return createService(alias, {
17
+ consume: async (key, rules) => {
18
+ assertRules(rules);
19
+ const at = now();
20
+ let retryAfter = 0;
21
+ const active = rules.map(rule => {
22
+ const bucket = `${key}:${rule.limit}:${rule.windowSeconds}`;
23
+ const threshold = at - rule.windowSeconds * 1000;
24
+ const values = (events.get(bucket) ?? []).filter(value => value > threshold);
25
+ events.set(bucket, values);
26
+ if (values.length >= rule.limit) {
27
+ retryAfter = Math.max(retryAfter, Math.ceil((values[0] + rule.windowSeconds * 1000 - at) / 1000));
28
+ }
29
+ return { bucket, values };
30
+ });
31
+ if (retryAfter > 0)
32
+ return { allowed: false, retryAfter };
33
+ active.forEach(({ bucket, values }) => events.set(bucket, [...values, at]));
34
+ return { allowed: true, retryAfter: 0 };
35
+ },
36
+ });
37
+ };
38
+ /** Redis implementation: every configured window is checked and consumed in one Lua operation. */
39
+ export const makeRedisThrottleService = (alias = OTP_THROTTLE_SERVICE, resourceAlias = OTP_RESOURCE) => {
40
+ const service = appendContextual(alias, {
41
+ consume: async (key, rules, token) => {
42
+ assertRules(rules);
43
+ const ctx = service.ctx;
44
+ const resource = ctx.resource(resourceAlias);
45
+ // The shared hash tag keeps all windows in one Redis Cluster slot, which EVAL requires.
46
+ const keys = rules.map(rule => resource.key(`throttle:{${key}}:${rule.limit}:${rule.windowSeconds}`));
47
+ const args = rules.flatMap(rule => [String(rule.limit), String(rule.windowSeconds * 1000)]);
48
+ args.push(token ?? randomBytes(16).toString('hex'));
49
+ try {
50
+ const result = await resource.db.client.eval(REDIS_THROTTLE_SCRIPT, keys.length, ...keys, ...args);
51
+ return { allowed: Number(result[0]) === 1, retryAfter: Number(result[1]) };
52
+ }
53
+ catch (error) {
54
+ const unavailable = new OtpUnavailable('throttle');
55
+ if (error instanceof Error)
56
+ unavailable.oiriginalStack = `${error}: ${error.stack}`;
57
+ throw unavailable;
58
+ }
59
+ },
60
+ });
61
+ return service;
62
+ };
63
+ /** @deprecated compat:factory-refactor — use `throttleKeyHelper.emailThrottleKey(…)` */
64
+ export const emailThrottleKey = (email) => throttleKeyHelper.emailThrottleKey(email);
65
+ /** @deprecated compat:factory-refactor — use `throttleKeyHelper.ipThrottleKey(…)` */
66
+ export const ipThrottleKey = (ip) => throttleKeyHelper.ipThrottleKey(ip);
67
+ //# sourceMappingURL=throttle.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"throttle.js","sourceRoot":"","sources":["../src/throttle.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AAEnE,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAE5C,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAChE,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AAEzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAA;AAEtD,MAAM,WAAW,GAAG,CAAC,KAA8B,EAAQ,EAAE;IAC3D,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC;WACvF,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC,EAAE,CAAC;QACtE,MAAM,IAAI,WAAW,CAAC,qEAAqE,CAAC,CAAA;IAC9F,CAAC;AACH,CAAC,CAAA;AAED,iGAAiG;AACjG,MAAM,CAAC,MAAM,yBAAyB,GAAG,CACvC,KAAK,GAAG,oBAAoB,EAAE,GAAG,GAAU,IAAI,CAAC,GAAG,EAC9B,EAAE;IACvB,MAAM,MAAM,GAAG,IAAI,GAAG,EAAoB,CAAA;IAE1C,OAAO,aAAa,CAAsB,KAAK,EAAE;QAC/C,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAA6B,EAAE;YACvD,WAAW,CAAC,KAAK,CAAC,CAAA;YAClB,MAAM,EAAE,GAAG,GAAG,EAAE,CAAA;YAChB,IAAI,UAAU,GAAG,CAAC,CAAA;YAClB,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;gBAC9B,MAAM,MAAM,GAAG,GAAG,GAAG,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,aAAa,EAAE,CAAA;gBAC3D,MAAM,SAAS,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,GAAG,IAAI,CAAA;gBAChD,MAAM,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,GAAG,SAAS,CAAC,CAAA;gBAC5E,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;gBAC1B,IAAI,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBAChC,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;gBACnG,CAAC;gBACD,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAA;YAC3B,CAAC,CAAC,CAAA;YAEF,IAAI,UAAU,GAAG,CAAC;gBAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAA;YACzD,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,GAAG,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;YAE3E,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,CAAA;QACzC,CAAC;KACF,CAAC,CAAA;AACJ,CAAC,CAAA;AAED,kGAAkG;AAClG,MAAM,CAAC,MAAM,wBAAwB,GAAG,CACtC,KAAK,GAAG,oBAAoB,EAAE,aAAa,GAAG,YAAY,EACrC,EAAE;IACvB,MAAM,OAAO,GAAG,gBAAgB,CAAsB,KAAK,EAAE;QAC3D,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAA6B,EAAE;YAC9D,WAAW,CAAC,KAAK,CAAC,CAAA;YAClB,MAAM,GAAG,GAAG,OAAO,CAAC,GAA4B,CAAA;YAChD,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAwC,aAAa,CAAC,CAAA;YACnF,wFAAwF;YACxF,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CACzC,aAAa,GAAG,KAAK,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,aAAa,EAAE,CACxD,CAAC,CAAA;YACF,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,CAAC,CAAC,CAAA;YAC3F,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAA;YAEnD,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAC1C,qBAAqB,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CACjC,CAAA;gBAErB,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;YAC5E,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,WAAW,GAAG,IAAI,cAAc,CAAC,UAAU,CAAC,CAAA;gBAClD,IAAI,KAAK,YAAY,KAAK;oBAAE,WAAW,CAAC,cAAc,GAAG,GAAG,KAAK,KAAK,KAAK,CAAC,KAAK,EAAE,CAAA;gBACnF,MAAM,WAAW,CAAA;YACnB,CAAC;QACH,CAAC;KACF,CAAC,CAAA;IAEF,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AAED,wFAAwF;AACxF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAA;AAEpG,qFAAqF;AACrF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,EAAU,EAAU,EAAE,CAAC,iBAAiB,CAAC,aAAa,CAAC,EAAE,CAAC,CAAA"}
package/build/types.d.ts CHANGED
@@ -1,10 +1,39 @@
1
1
  import type { ServerConfig, ServerContext } from '@owlmeans/server-context';
2
+ import type { InitializedService } from '@owlmeans/context';
3
+ import { OtpChallengeOutcome } from './consts.js';
4
+ export interface ThrottleRule {
5
+ limit: number;
6
+ windowSeconds: number;
7
+ }
8
+ export interface ThrottleDecision {
9
+ allowed: boolean;
10
+ retryAfter: number;
11
+ }
12
+ /** Generic fixed-subject, sliding-window throttle service for server auth plugins. */
13
+ export interface AuthThrottleService extends InitializedService {
14
+ consume: (key: string, rules: readonly ThrottleRule[], token?: string) => Promise<ThrottleDecision>;
15
+ }
16
+ export interface OtpChallenge {
17
+ id: string;
18
+ emailKey: string;
19
+ codeHash: string;
20
+ }
21
+ export interface OtpChallengeStore extends InitializedService {
22
+ issue: (challenge: OtpChallenge, ttlSeconds: number) => Promise<boolean>;
23
+ verify: (id: string, emailKey: string, codeHash: string, maxFailedAttempts: number) => Promise<OtpChallengeOutcome>;
24
+ }
2
25
  export interface OtpConfig extends ServerConfig {
3
26
  otp?: {
4
27
  /** Alias of the registered MailerService. Defaults to MAILER_SERVICE. */
5
28
  mailerAlias?: string;
6
29
  /** Alias of the Redis resource for code storage. Defaults to OTP_RESOURCE. */
7
30
  resourceAlias?: string;
31
+ /** Alias of an OtpChallengeStore. Defaults to OTP_CHALLENGE_STORE. */
32
+ challengeStoreAlias?: string;
33
+ /** Optional AuthThrottleService alias. Omitted means no issuance throttle. */
34
+ throttleAlias?: string;
35
+ /** Sliding-window limits applied together by the throttle service. */
36
+ throttleRules?: readonly ThrottleRule[];
8
37
  /** Alias of the IdentityLinkingService. Defaults to AUTH_IDENTITY_LINKING. */
9
38
  identityAlias?: string;
10
39
  };
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAE3E,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,GAAG,CAAC,EAAE;QACJ,yEAAyE;QACzE,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,8EAA8E;QAC9E,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,8EAA8E;QAC9E,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB,CAAA;CACF;AAED,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,CAAE,SAAQ,aAAa,CAAC,CAAC,CAAC;CAAG"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAC3E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAA;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAA;AAEjD,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,OAAO,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,sFAAsF;AACtF,MAAM,WAAW,mBAAoB,SAAQ,kBAAkB;IAC7D,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,YAAY,EAAE,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAA;CACpG;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,iBAAkB,SAAQ,kBAAkB;IAC3D,KAAK,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IACxE,MAAM,EAAE,CACN,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,KACtE,OAAO,CAAC,mBAAmB,CAAC,CAAA;CAClC;AAED,MAAM,WAAW,SAAU,SAAQ,YAAY;IAC7C,GAAG,CAAC,EAAE;QACJ,yEAAyE;QACzE,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,8EAA8E;QAC9E,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,sEAAsE;QACtE,mBAAmB,CAAC,EAAE,MAAM,CAAA;QAC5B,8EAA8E;QAC9E,aAAa,CAAC,EAAE,MAAM,CAAA;QACtB,sEAAsE;QACtE,aAAa,CAAC,EAAE,SAAS,YAAY,EAAE,CAAA;QACvC,8EAA8E;QAC9E,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB,CAAA;CACF;AAED,MAAM,WAAW,UAAU,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,CAAE,SAAQ,aAAa,CAAC,CAAC,CAAC;CAAG"}
@@ -0,0 +1,16 @@
1
+ import type { OtpChallenge } from './types.js';
2
+ import type { ResourceRecord } from '@owlmeans/resource';
3
+ export interface Clock {
4
+ (): number;
5
+ }
6
+ export interface StoredChallenge extends OtpChallenge {
7
+ failedAttempts: number;
8
+ expiresAt: number;
9
+ }
10
+ export interface ChallengeResourceRecord extends ResourceRecord {
11
+ id: string;
12
+ }
13
+ export interface ThrottleResourceRecord extends ResourceRecord {
14
+ id: string;
15
+ }
16
+ //# sourceMappingURL=types.local.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.local.d.ts","sourceRoot":"","sources":["../src/types.local.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD,MAAM,WAAW,KAAK;IAAG,IAAI,MAAM,CAAA;CAAE;AAErC,MAAM,WAAW,eAAgB,SAAQ,YAAY;IAAG,cAAc,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE;AAEnG,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAAG,EAAE,EAAE,MAAM,CAAA;CAAE;AAE9E,MAAM,WAAW,sBAAuB,SAAQ,cAAc;IAAG,EAAE,EAAE,MAAM,CAAA;CAAE"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.local.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.local.js","sourceRoot":"","sources":["../src/types.local.ts"],"names":[],"mappings":""}