@nauth-toolkit/oidc-provider 0.4.0

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 (64) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +158 -0
  3. package/dist/nestjs/index.d.ts +12 -0
  4. package/dist/nestjs/index.d.ts.map +1 -0
  5. package/dist/nestjs/index.js +23 -0
  6. package/dist/nestjs/index.js.map +1 -0
  7. package/dist/nestjs/mount.d.ts +38 -0
  8. package/dist/nestjs/mount.d.ts.map +1 -0
  9. package/dist/nestjs/mount.js +35 -0
  10. package/dist/nestjs/mount.js.map +1 -0
  11. package/dist/nestjs/oidc-interaction.controller.d.ts +40 -0
  12. package/dist/nestjs/oidc-interaction.controller.d.ts.map +1 -0
  13. package/dist/nestjs/oidc-interaction.controller.js +157 -0
  14. package/dist/nestjs/oidc-interaction.controller.js.map +1 -0
  15. package/dist/nestjs/oidc-provider.module.d.ts +70 -0
  16. package/dist/nestjs/oidc-provider.module.d.ts.map +1 -0
  17. package/dist/nestjs/oidc-provider.module.js +84 -0
  18. package/dist/nestjs/oidc-provider.module.js.map +1 -0
  19. package/dist/nestjs/tokens.d.ts +13 -0
  20. package/dist/nestjs/tokens.d.ts.map +1 -0
  21. package/dist/nestjs/tokens.js +16 -0
  22. package/dist/nestjs/tokens.js.map +1 -0
  23. package/dist/src/config.types.d.ts +102 -0
  24. package/dist/src/config.types.d.ts.map +1 -0
  25. package/dist/src/config.types.js +3 -0
  26. package/dist/src/config.types.js.map +1 -0
  27. package/dist/src/create-provider.d.ts +47 -0
  28. package/dist/src/create-provider.d.ts.map +1 -0
  29. package/dist/src/create-provider.js +159 -0
  30. package/dist/src/create-provider.js.map +1 -0
  31. package/dist/src/find-account.d.ts +33 -0
  32. package/dist/src/find-account.d.ts.map +1 -0
  33. package/dist/src/find-account.js +69 -0
  34. package/dist/src/find-account.js.map +1 -0
  35. package/dist/src/index.d.ts +41 -0
  36. package/dist/src/index.d.ts.map +1 -0
  37. package/dist/src/index.js +51 -0
  38. package/dist/src/index.js.map +1 -0
  39. package/dist/src/interaction-bridge.d.ts +147 -0
  40. package/dist/src/interaction-bridge.d.ts.map +1 -0
  41. package/dist/src/interaction-bridge.js +283 -0
  42. package/dist/src/interaction-bridge.js.map +1 -0
  43. package/dist/src/mount/express.d.ts +54 -0
  44. package/dist/src/mount/express.d.ts.map +1 -0
  45. package/dist/src/mount/express.js +56 -0
  46. package/dist/src/mount/express.js.map +1 -0
  47. package/dist/src/rate-limit.d.ts +61 -0
  48. package/dist/src/rate-limit.d.ts.map +1 -0
  49. package/dist/src/rate-limit.js +93 -0
  50. package/dist/src/rate-limit.js.map +1 -0
  51. package/dist/src/raw-http.d.ts +25 -0
  52. package/dist/src/raw-http.d.ts.map +1 -0
  53. package/dist/src/raw-http.js +33 -0
  54. package/dist/src/raw-http.js.map +1 -0
  55. package/dist/src/session-termination.d.ts +60 -0
  56. package/dist/src/session-termination.d.ts.map +1 -0
  57. package/dist/src/session-termination.js +70 -0
  58. package/dist/src/session-termination.js.map +1 -0
  59. package/dist/src/storage.adapter.d.ts +99 -0
  60. package/dist/src/storage.adapter.d.ts.map +1 -0
  61. package/dist/src/storage.adapter.js +197 -0
  62. package/dist/src/storage.adapter.js.map +1 -0
  63. package/dist/tsconfig.tsbuildinfo +1 -0
  64. package/package.json +95 -0
@@ -0,0 +1,197 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.NAuthOIDCAdapter = void 0;
4
+ exports.createOIDCStorageAdapter = createOIDCStorageAdapter;
5
+ /** Prefix for every key this adapter owns, so it never collides with other storage users. */
6
+ const NS = 'oidc';
7
+ /**
8
+ * Models whose payload carries a `grantId`. Only these need the grant marker that
9
+ * backs `revokeByGrantId`.
10
+ */
11
+ const GRANTABLE = new Set([
12
+ 'AccessToken',
13
+ 'AuthorizationCode',
14
+ 'RefreshToken',
15
+ 'DeviceCode',
16
+ 'BackchannelAuthenticationRequest',
17
+ ]);
18
+ /** Models looked up by `uid` rather than by id. */
19
+ const UID_INDEXED = new Set(['Session', 'Interaction']);
20
+ /**
21
+ * Build an `oidc-provider` storage adapter over nauth's {@link StorageAdapter}.
22
+ *
23
+ * **This needs no database tables.** Every model `oidc-provider` persists is
24
+ * TTL-bounded, which is exactly what `StorageAdapter` is for — the same reasoning
25
+ * that put authorization codes there rather than in a table.
26
+ *
27
+ * Secondary lookups (`findByUid`, `findByUserCode`) and grant revocation are built
28
+ * from **marker keys carrying their own TTL**, not from the adapter's `hset`/`lpush`
29
+ * operations. Those are deliberately avoided: `DatabaseStorageAdapter` writes them to
30
+ * internally re-prefixed keys (`hash:`/`list:`) with **no expiry**, and `del`/`expire`
31
+ * operate on the un-prefixed key — so an index built on them would leak forever and
32
+ * could not be reaped through the interface.
33
+ *
34
+ * Key scheme:
35
+ * ```
36
+ * oidc:{model}:{id} → JSON payload
37
+ * oidc:{model}:uid:{uid} → id (Session, Interaction)
38
+ * oidc:DeviceCode:uc:{userCode} → id
39
+ * oidc:g:{grantId}:{model}:{id} → '1' (swept by revokeByGrantId)
40
+ * oidc:acct:{accountId}:{model}:{id} → '1' (swept when a user logs out)
41
+ * ```
42
+ *
43
+ * @param storage - The nauth storage adapter (Redis in production, Database or Memory otherwise)
44
+ * @returns A factory `oidc-provider` calls once per model name
45
+ *
46
+ * @example
47
+ * ```typescript
48
+ * new Provider(issuer, { adapter: createOIDCStorageAdapter(nauth.storage) });
49
+ * ```
50
+ */
51
+ function createOIDCStorageAdapter(storage) {
52
+ return (name) => new NAuthOIDCAdapter(name, storage);
53
+ }
54
+ /**
55
+ * `oidc-provider` adapter for one model, backed by nauth's storage abstraction.
56
+ */
57
+ class NAuthOIDCAdapter {
58
+ name;
59
+ storage;
60
+ constructor(name, storage) {
61
+ this.name = name;
62
+ this.storage = storage;
63
+ }
64
+ /**
65
+ * Create or replace a model instance, plus whatever secondary markers it needs.
66
+ *
67
+ * Every marker is written with the *same* TTL as the payload, so the index can
68
+ * never outlive what it points at.
69
+ */
70
+ async upsert(id, payload, expiresIn) {
71
+ const ttl = expiresIn > 0 ? expiresIn : undefined;
72
+ await this.storage.set(this.key(id), JSON.stringify(payload), ttl);
73
+ if (UID_INDEXED.has(this.name) && payload.uid) {
74
+ await this.storage.set(`${NS}:${this.name}:uid:${payload.uid}`, id, ttl);
75
+ }
76
+ if (this.name === 'DeviceCode' && payload.userCode) {
77
+ await this.storage.set(`${NS}:DeviceCode:uc:${payload.userCode}`, id, ttl);
78
+ }
79
+ if (GRANTABLE.has(this.name) && payload.grantId) {
80
+ await this.storage.set(`${NS}:g:${payload.grantId}:${this.name}:${id}`, '1', ttl);
81
+ }
82
+ if (payload.accountId) {
83
+ await this.storage.set(`${NS}:acct:${payload.accountId}:${this.name}:${id}`, '1', ttl);
84
+ }
85
+ }
86
+ /**
87
+ * Load a model instance by id, or undefined once it has expired or been destroyed.
88
+ */
89
+ async find(id) {
90
+ return this.read(this.key(id));
91
+ }
92
+ /**
93
+ * Load a Session or Interaction by its `uid`.
94
+ */
95
+ async findByUid(uid) {
96
+ const id = await this.storage.get(`${NS}:${this.name}:uid:${uid}`);
97
+ return id ? this.read(this.key(id)) : undefined;
98
+ }
99
+ /**
100
+ * Load a DeviceCode by the code the end user typed in.
101
+ */
102
+ async findByUserCode(userCode) {
103
+ const id = await this.storage.get(`${NS}:DeviceCode:uc:${userCode}`);
104
+ return id ? this.read(this.key(id)) : undefined;
105
+ }
106
+ /**
107
+ * Mark a single-use artifact as spent, preserving its remaining lifetime.
108
+ *
109
+ * Read-modify-write is safe here: `consumed` is a monotonic marker, so a lost
110
+ * update cannot un-consume anything. `oidc-provider`'s actual replay defence is its
111
+ * separate `ReplayDetection` model, not this flag.
112
+ */
113
+ async consume(id) {
114
+ const key = this.key(id);
115
+ const payload = await this.read(key);
116
+ if (!payload) {
117
+ return;
118
+ }
119
+ const remaining = await this.storage.ttl(key);
120
+ payload.consumed = Math.floor(Date.now() / 1000);
121
+ await this.storage.set(key, JSON.stringify(payload), remaining > 0 ? remaining : undefined);
122
+ }
123
+ /**
124
+ * Delete a model instance.
125
+ */
126
+ async destroy(id) {
127
+ await this.storage.del(this.key(id));
128
+ }
129
+ /**
130
+ * Revoke every artifact issued under a grant.
131
+ *
132
+ * Sweeps the grant's marker keys and deletes both the marker and the payload it
133
+ * points at. This is how a consent withdrawal, or `oidc-provider`'s own refresh
134
+ * replay detection, cascades across access tokens, refresh tokens and codes.
135
+ */
136
+ async revokeByGrantId(grantId) {
137
+ // Grant markers span every model, and that is the point: revoking a grant must
138
+ // reach the access tokens, refresh tokens and codes derived from it.
139
+ const markers = await this.storage.keys(`${NS}:g:${grantId}:*`);
140
+ for (const marker of markers) {
141
+ const parts = marker.split(':');
142
+ const model = parts[3];
143
+ const id = parts.slice(4).join(':');
144
+ if (model && id) {
145
+ await this.storage.del(`${NS}:${model}:${id}`);
146
+ }
147
+ await this.storage.del(marker);
148
+ }
149
+ }
150
+ /**
151
+ * Delete every artifact of this model belonging to an account.
152
+ *
153
+ * Not part of `oidc-provider`'s Adapter contract — used by the single-logout helper
154
+ * so that ending a nauth session can also end the provider's own SSO session.
155
+ *
156
+ * @internal
157
+ */
158
+ async revokeByAccountId(accountId) {
159
+ // Scoped to THIS model. The account marker namespace is shared by every model, so
160
+ // sweeping it wholesale from one adapter would silently destroy the others'
161
+ // artifacts too — a session termination would take live access tokens with it.
162
+ const markers = await this.storage.keys(`${NS}:acct:${accountId}:${this.name}:*`);
163
+ let removed = 0;
164
+ for (const marker of markers) {
165
+ const id = marker.split(':').slice(4).join(':');
166
+ if (id) {
167
+ await this.storage.del(this.key(id));
168
+ removed += 1;
169
+ }
170
+ await this.storage.del(marker);
171
+ }
172
+ return removed;
173
+ }
174
+ /**
175
+ * Read and parse a payload, treating unparseable data as absent.
176
+ */
177
+ async read(key) {
178
+ const raw = await this.storage.get(key);
179
+ if (!raw) {
180
+ return undefined;
181
+ }
182
+ try {
183
+ return JSON.parse(raw);
184
+ }
185
+ catch {
186
+ return undefined;
187
+ }
188
+ }
189
+ /**
190
+ * Storage key for a model instance.
191
+ */
192
+ key(id) {
193
+ return `${NS}:${this.name}:${id}`;
194
+ }
195
+ }
196
+ exports.NAuthOIDCAdapter = NAuthOIDCAdapter;
197
+ //# sourceMappingURL=storage.adapter.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"storage.adapter.js","sourceRoot":"","sources":["../../src/storage.adapter.ts"],"names":[],"mappings":";;;AAoDA,4DAEC;AAnDD,6FAA6F;AAC7F,MAAM,EAAE,GAAG,MAAM,CAAC;AAElB;;;GAGG;AACH,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC;IACxB,aAAa;IACb,mBAAmB;IACnB,cAAc;IACd,YAAY;IACZ,kCAAkC;CACnC,CAAC,CAAC;AAEH,mDAAmD;AACnD,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC,CAAC;AAExD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,SAAgB,wBAAwB,CAAC,OAAuB;IAC9D,OAAO,CAAC,IAAY,EAAW,EAAE,CAAC,IAAI,gBAAgB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;AACxE,CAAC;AAED;;GAEG;AACH,MAAa,gBAAgB;IAER;IACA;IAFnB,YACmB,IAAY,EACZ,OAAuB;QADvB,SAAI,GAAJ,IAAI,CAAQ;QACZ,YAAO,GAAP,OAAO,CAAgB;IACvC,CAAC;IAEJ;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAuB,EAAE,SAAiB;QACjE,MAAM,GAAG,GAAG,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;QAClD,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC;QAEnE,IAAI,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;YAC9C,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,IAAI,QAAQ,OAAO,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC;QAC3E,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACnD,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,kBAAkB,OAAO,CAAC,QAAQ,EAAE,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC;QAC7E,CAAC;QACD,IAAI,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YAChD,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QACpF,CAAC;QACD,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACtB,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,EAAU;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,GAAW;QACzB,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,IAAI,QAAQ,GAAG,EAAE,CAAC,CAAC;QACnE,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc,CAAC,QAAgB;QACnC,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,kBAAkB,QAAQ,EAAE,CAAC,CAAC;QACrE,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CAAC,EAAU;QACtB,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACzB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO;QACT,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9C,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QACjD,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC9F,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,EAAU;QACtB,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;IACvC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,eAAe,CAAC,OAAe;QACnC,+EAA+E;QAC/E,qEAAqE;QACrE,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,OAAO,IAAI,CAAC,CAAC;QAChE,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAChC,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACvB,MAAM,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACpC,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;gBAChB,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC,CAAC;YACjD,CAAC;YACD,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CAAC,SAAiB;QACvC,kFAAkF;QAClF,4EAA4E;QAC5E,+EAA+E;QAC/E,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,SAAS,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC;QAElF,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,MAAM,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YAChD,IAAI,EAAE,EAAE,CAAC;gBACP,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;gBACrC,OAAO,IAAI,CAAC,CAAC;YACf,CAAC;YACD,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,IAAI,CAAC,GAAW;QAC5B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC;YACH,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAmB,CAAC;QAC3C,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;OAEG;IACK,GAAG,CAAC,EAAU;QACpB,OAAO,GAAG,EAAE,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;IACpC,CAAC;CACF;AAnJD,4CAmJC"}