@c9up/warden 0.2.5 → 0.2.7
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.
- package/README.md +74 -5
- package/dist/AccessToken.d.ts +257 -0
- package/dist/AccessToken.d.ts.map +1 -0
- package/dist/AccessToken.js +370 -0
- package/dist/AccessToken.js.map +1 -0
- package/dist/AttemptStore.d.ts +16 -2
- package/dist/AttemptStore.d.ts.map +1 -1
- package/dist/AttemptStore.js +38 -12
- package/dist/AttemptStore.js.map +1 -1
- package/dist/AuthManager.d.ts +44 -8
- package/dist/AuthManager.d.ts.map +1 -1
- package/dist/AuthManager.js +42 -11
- package/dist/AuthManager.js.map +1 -1
- package/dist/AuthRateLimiter.d.ts +16 -3
- package/dist/AuthRateLimiter.d.ts.map +1 -1
- package/dist/AuthRateLimiter.js +25 -6
- package/dist/AuthRateLimiter.js.map +1 -1
- package/dist/Authenticator.d.ts +98 -10
- package/dist/Authenticator.d.ts.map +1 -1
- package/dist/Authenticator.js +223 -19
- package/dist/Authenticator.js.map +1 -1
- package/dist/Guard.d.ts.map +1 -1
- package/dist/Guard.js +17 -5
- package/dist/Guard.js.map +1 -1
- package/dist/RedisBlacklistDriver.d.ts.map +1 -1
- package/dist/RedisBlacklistDriver.js +11 -0
- package/dist/RedisBlacklistDriver.js.map +1 -1
- package/dist/RefreshTokenStore.d.ts +37 -6
- package/dist/RefreshTokenStore.d.ts.map +1 -1
- package/dist/RefreshTokenStore.js +51 -10
- package/dist/RefreshTokenStore.js.map +1 -1
- package/dist/ResilientBlacklistDriver.d.ts +23 -6
- package/dist/ResilientBlacklistDriver.d.ts.map +1 -1
- package/dist/ResilientBlacklistDriver.js +26 -9
- package/dist/ResilientBlacklistDriver.js.map +1 -1
- package/dist/TokenBlacklist.d.ts +3 -1
- package/dist/TokenBlacklist.d.ts.map +1 -1
- package/dist/TokenBlacklist.js +27 -1
- package/dist/TokenBlacklist.js.map +1 -1
- package/dist/WardenProvider.d.ts +2 -0
- package/dist/WardenProvider.d.ts.map +1 -1
- package/dist/WardenProvider.js +4 -58
- package/dist/WardenProvider.js.map +1 -1
- package/dist/authFinder.d.ts +58 -0
- package/dist/authFinder.d.ts.map +1 -0
- package/dist/authFinder.js +77 -0
- package/dist/authFinder.js.map +1 -0
- package/dist/bearer.d.ts +12 -0
- package/dist/bearer.d.ts.map +1 -0
- package/dist/bearer.js +19 -0
- package/dist/bearer.js.map +1 -0
- package/dist/bouncer/Bouncer.d.ts +2 -2
- package/dist/bouncer/Bouncer.d.ts.map +1 -1
- package/dist/bouncer/Bouncer.js +17 -4
- package/dist/bouncer/Bouncer.js.map +1 -1
- package/dist/bouncer/PolicyAuthorizer.d.ts +1 -1
- package/dist/bouncer/PolicyAuthorizer.d.ts.map +1 -1
- package/dist/bouncer/PolicyAuthorizer.js +1 -1
- package/dist/bouncer/PolicyAuthorizer.js.map +1 -1
- package/dist/bouncer/evaluate.d.ts +5 -1
- package/dist/bouncer/evaluate.d.ts.map +1 -1
- package/dist/bouncer/evaluate.js +7 -6
- package/dist/bouncer/evaluate.js.map +1 -1
- package/dist/config.d.ts +8 -4
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +4 -1
- package/dist/config.js.map +1 -1
- package/dist/errors.d.ts +28 -0
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +63 -2
- package/dist/errors.js.map +1 -1
- package/dist/index.d.ts +10 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +6 -4
- package/dist/index.js.map +1 -1
- package/dist/mfa/MfaManager.d.ts +33 -8
- package/dist/mfa/MfaManager.d.ts.map +1 -1
- package/dist/mfa/MfaManager.js +69 -20
- package/dist/mfa/MfaManager.js.map +1 -1
- package/dist/mfa/TotpProvider.d.ts.map +1 -1
- package/dist/mfa/TotpProvider.js +8 -0
- package/dist/mfa/TotpProvider.js.map +1 -1
- package/dist/mfa/WebauthnProvider.d.ts +22 -0
- package/dist/mfa/WebauthnProvider.d.ts.map +1 -1
- package/dist/mfa/WebauthnProvider.js +57 -12
- package/dist/mfa/WebauthnProvider.js.map +1 -1
- package/dist/middleware.d.ts +13 -3
- package/dist/middleware.d.ts.map +1 -1
- package/dist/middleware.js +28 -6
- package/dist/middleware.js.map +1 -1
- package/dist/native.d.ts +6 -2
- package/dist/native.d.ts.map +1 -1
- package/dist/native.js +19 -2
- package/dist/native.js.map +1 -1
- package/dist/quasar.d.ts.map +1 -1
- package/dist/quasar.js +8 -1
- package/dist/quasar.js.map +1 -1
- package/dist/rights/RightsResolver.d.ts +10 -0
- package/dist/rights/RightsResolver.d.ts.map +1 -1
- package/dist/rights/RightsResolver.js +23 -0
- package/dist/rights/RightsResolver.js.map +1 -1
- package/dist/sanitize.d.ts.map +1 -1
- package/dist/sanitize.js +3 -1
- package/dist/sanitize.js.map +1 -1
- package/dist/services/main.d.ts.map +1 -1
- package/dist/services/main.js +12 -2
- package/dist/services/main.js.map +1 -1
- package/dist/standalone.d.ts +24 -3
- package/dist/standalone.d.ts.map +1 -1
- package/dist/standalone.js +22 -32
- package/dist/standalone.js.map +1 -1
- package/dist/strategies/ApiKeyStrategy.d.ts +46 -12
- package/dist/strategies/ApiKeyStrategy.d.ts.map +1 -1
- package/dist/strategies/ApiKeyStrategy.js +76 -37
- package/dist/strategies/ApiKeyStrategy.js.map +1 -1
- package/dist/strategies/BasicAuthStrategy.d.ts.map +1 -1
- package/dist/strategies/BasicAuthStrategy.js +5 -2
- package/dist/strategies/BasicAuthStrategy.js.map +1 -1
- package/dist/strategies/JwtStrategy.d.ts +6 -2
- package/dist/strategies/JwtStrategy.d.ts.map +1 -1
- package/dist/strategies/JwtStrategy.js +58 -11
- package/dist/strategies/JwtStrategy.js.map +1 -1
- package/dist/strategies/SessionStrategy.d.ts.map +1 -1
- package/dist/strategies/SessionStrategy.js +4 -1
- package/dist/strategies/SessionStrategy.js.map +1 -1
- package/dist/templateTags.d.ts +42 -0
- package/dist/templateTags.d.ts.map +1 -0
- package/dist/templateTags.js +82 -0
- package/dist/templateTags.js.map +1 -0
- package/dist/vendor/nativeBinary.d.ts +26 -2
- package/dist/vendor/nativeBinary.d.ts.map +1 -1
- package/dist/vendor/nativeBinary.js +63 -6
- package/dist/vendor/nativeBinary.js.map +1 -1
- package/dist/vendor/quasarConnection.d.ts +44 -3
- package/dist/vendor/quasarConnection.d.ts.map +1 -1
- package/dist/vendor/quasarConnection.js +64 -23
- package/dist/vendor/quasarConnection.js.map +1 -1
- package/index.darwin-arm64.node +0 -0
- package/index.darwin-x64.node +0 -0
- package/index.linux-arm64-gnu.node +0 -0
- package/index.linux-x64-gnu.node +0 -0
- package/index.win32-x64-msvc.node +0 -0
- package/package.json +9 -5
- package/src/AccessToken.ts +550 -0
- package/src/AttemptStore.ts +42 -13
- package/src/AuthManager.ts +75 -18
- package/src/AuthRateLimiter.ts +24 -8
- package/src/Authenticator.ts +282 -22
- package/src/Guard.ts +18 -5
- package/src/RedisBlacklistDriver.ts +11 -0
- package/src/RefreshTokenStore.ts +79 -13
- package/src/ResilientBlacklistDriver.ts +30 -9
- package/src/TokenBlacklist.ts +28 -1
- package/src/WardenProvider.ts +6 -83
- package/src/authFinder.ts +118 -0
- package/src/bearer.ts +16 -0
- package/src/bouncer/Bouncer.ts +21 -6
- package/src/bouncer/PolicyAuthorizer.ts +1 -1
- package/src/bouncer/evaluate.ts +7 -10
- package/src/config.ts +8 -4
- package/src/errors.ts +80 -2
- package/src/index.ts +29 -0
- package/src/mfa/MfaManager.ts +98 -22
- package/src/mfa/TotpProvider.ts +15 -2
- package/src/mfa/WebauthnProvider.ts +77 -13
- package/src/middleware.ts +52 -8
- package/src/native.ts +20 -4
- package/src/quasar.ts +13 -2
- package/src/rights/RightsResolver.ts +27 -0
- package/src/sanitize.ts +4 -2
- package/src/services/main.ts +14 -2
- package/src/standalone.ts +75 -37
- package/src/strategies/ApiKeyStrategy.ts +117 -42
- package/src/strategies/BasicAuthStrategy.ts +7 -2
- package/src/strategies/JwtStrategy.ts +61 -10
- package/src/strategies/SessionStrategy.ts +4 -1
- package/src/templateTags.ts +117 -0
- package/src/vendor/nativeBinary.ts +82 -6
- package/src/vendor/quasarConnection.ts +105 -22
- package/stubs/config/auth.stub +3 -0
- package/scripts/build-napi-types.mjs +0 -69
- package/scripts/copy-napi.mjs +0 -75
- package/scripts/generate-napi-types.mjs +0 -156
package/dist/AuthManager.js
CHANGED
|
@@ -6,8 +6,22 @@
|
|
|
6
6
|
import { Authenticator } from "./Authenticator.js";
|
|
7
7
|
import { WardenError } from "./errors.js";
|
|
8
8
|
import { MemoryRightsStore } from "./rights/MemoryRightsStore.js";
|
|
9
|
-
import { RightsResolver } from "./rights/RightsResolver.js";
|
|
9
|
+
import { narrowToAccessToken, RightsResolver, } from "./rights/RightsResolver.js";
|
|
10
10
|
import { sanitizePayload } from "./sanitize.js";
|
|
11
|
+
/**
|
|
12
|
+
* Whether the token the user authenticated with, if any, allows `permission`.
|
|
13
|
+
*
|
|
14
|
+
* A permission check on a request made with a token is an INTERSECTION: the
|
|
15
|
+
* user must hold the permission AND the token must allow it. The token never
|
|
16
|
+
* widens what the user may do (a same-named ability grants nothing the user
|
|
17
|
+
* lacks), and it narrows it: a token limited to a few abilities does not carry
|
|
18
|
+
* every permission of its user. A user with no `currentAccessToken` (a session,
|
|
19
|
+
* a JWT) is not restricted here.
|
|
20
|
+
*/
|
|
21
|
+
export function tokenAllows(user, permission) {
|
|
22
|
+
const token = user.currentAccessToken;
|
|
23
|
+
return token === undefined || token.allows(permission);
|
|
24
|
+
}
|
|
11
25
|
/**
|
|
12
26
|
* The event namespace for a guard, taken from its DRIVER.
|
|
13
27
|
*
|
|
@@ -114,13 +128,16 @@ export class AuthManager {
|
|
|
114
128
|
catch (err) {
|
|
115
129
|
// Re-throw structured WardenError sentinels (e.g. SessionStrategy's
|
|
116
130
|
// USE_LOGIN throw) so callers see the design-boundary signal instead
|
|
117
|
-
// of a soft `{ authenticated: false }`.
|
|
131
|
+
// of a soft `{ authenticated: false }`.
|
|
118
132
|
if (err instanceof WardenError)
|
|
119
133
|
throw err;
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
134
|
+
// Anything else is an outage (a database down, a driver bug), not a
|
|
135
|
+
// wrong password: flag it so the caller does not answer "invalid
|
|
136
|
+
// credentials" or count it as a failed attempt. The thrown text names
|
|
137
|
+
// hosts, ports and queries, so it goes to the server log and never
|
|
138
|
+
// into the result a caller may render.
|
|
139
|
+
console.error(`[warden] strategy '${strategyName ?? this.#default}' threw during authenticate():`, err);
|
|
140
|
+
return { authenticated: false, strategyCrash: true };
|
|
124
141
|
}
|
|
125
142
|
}
|
|
126
143
|
/** Verify a token (JWT, session, API key). */
|
|
@@ -175,9 +192,12 @@ export class AuthManager {
|
|
|
175
192
|
* Bouncer policy path (`this.permissions`, 56.3) consults the SAME resolver,
|
|
176
193
|
* so a coarse question and a policy question return the same answer for the
|
|
177
194
|
* same `(user, scope)` (the single unification point — AC-E3).
|
|
195
|
+
*
|
|
196
|
+
* Narrowed by the access token the user came in with, if any
|
|
197
|
+
* ({@link narrowToAccessToken}): the set is what THIS request may do.
|
|
178
198
|
*/
|
|
179
|
-
resolvePermissions(user, scope = "global") {
|
|
180
|
-
return this.#rights.resolve(user, scope);
|
|
199
|
+
async resolvePermissions(user, scope = "global") {
|
|
200
|
+
return narrowToAccessToken(await this.#rights.resolve(user, scope), user);
|
|
181
201
|
}
|
|
182
202
|
/**
|
|
183
203
|
* Check if a user has a specific role within a scope (default `"global"`).
|
|
@@ -190,16 +210,23 @@ export class AuthManager {
|
|
|
190
210
|
/**
|
|
191
211
|
* Check if a user has a specific permission within a scope (default
|
|
192
212
|
* `"global"`). Derived from roles + store grants ONLY — token
|
|
193
|
-
* `user.permissions` is NOT read (D1, cerebrum 459).
|
|
213
|
+
* `user.permissions` is NOT read (D1, cerebrum 459). When the user came in
|
|
214
|
+
* with a token (`currentAccessToken`), the token must allow it too: see
|
|
215
|
+
* {@link tokenAllows}.
|
|
194
216
|
*/
|
|
195
217
|
async hasPermission(user, permission, scope = "global") {
|
|
218
|
+
if (!tokenAllows(user, permission))
|
|
219
|
+
return false;
|
|
196
220
|
return (await this.resolvePermissions(user, scope)).has(permission);
|
|
197
221
|
}
|
|
198
222
|
/**
|
|
199
223
|
* Check if a user has ALL required permissions within a scope (default
|
|
200
|
-
* `"global"`). Empty list ⇒ vacuously true.
|
|
224
|
+
* `"global"`). Empty list ⇒ vacuously true. Intersected with the token's
|
|
225
|
+
* abilities like {@link hasPermission}.
|
|
201
226
|
*/
|
|
202
227
|
async hasAllPermissions(user, permissions, scope = "global") {
|
|
228
|
+
if (!permissions.every((p) => tokenAllows(user, p)))
|
|
229
|
+
return false;
|
|
203
230
|
return (await this.resolvePermissions(user, scope)).hasAll(permissions);
|
|
204
231
|
}
|
|
205
232
|
/** Get a registered strategy by name. */
|
|
@@ -317,7 +344,11 @@ export class AuthManager {
|
|
|
317
344
|
hint: "Remember-me is a session-guard feature. Configure `rememberMeTokens` on the guard, or implement authenticateViaRememberMeToken() on your own.",
|
|
318
345
|
});
|
|
319
346
|
}
|
|
320
|
-
|
|
347
|
+
const revived = await strategy.authenticateViaRememberMeToken(cookieValue, state);
|
|
348
|
+
// The same prototype-pollution guard `verify` and `authenticate` apply.
|
|
349
|
+
if (revived)
|
|
350
|
+
sanitizePayload(revived.user);
|
|
351
|
+
return revived;
|
|
321
352
|
}
|
|
322
353
|
/**
|
|
323
354
|
* Log a user out of a session-capable guard (AdonisJS `auth.use('web').logout()`
|
package/dist/AuthManager.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AuthManager.js","sourceRoot":"","sources":["../src/AuthManager.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,
|
|
1
|
+
{"version":3,"file":"AuthManager.js","sourceRoot":"","sources":["../src/AuthManager.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AAClE,OAAO,EACN,mBAAmB,EACnB,cAAc,GACd,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAqBhD;;;;;;;;;GASG;AACH,MAAM,UAAU,WAAW,CAAC,IAAiB,EAAE,UAAkB;IAChE,MAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC;IACtC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;AACxD,CAAC;AA4CD;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,eAAe,CAAC,UAA8B;IAC7D,IAAI,CAAC,UAAU;QAAE,OAAO,cAAc,CAAC;IACvC,OAAO,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,OAAO,CAAC;AACzE,CAAC;AAmDD;;;;GAIG;AACH,SAAS,aAAa,CACrB,QAAsB;IAEtB,OAAO,WAAW,IAAI,QAAQ,IAAI,OAAO,QAAQ,CAAC,SAAS,KAAK,UAAU,CAAC;AAC5E,CAAC;AAaD,MAAM,OAAO,WAAW;IACvB,2EAA2E;IAC3E,iFAAiF;IACjF,OAAO,GAA8B,IAAI,GAAG,EAAE,CAAC;IAC/C,QAAQ,CAAS;IACR,OAAO,CAAiB;IAEjC;;;;OAIG;IACH,QAAQ,CAA4B;IAEpC;;;OAGG;IACH,UAAU,CAAC,OAAsB;QAChC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,KAAa,EAAE,OAAgC;QAC5D,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,KAAa,EAAE,OAAgC;QACpD,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE;YACnE,iEAAiE;QAClE,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,YAAY,MAAkB;QAC7B,wEAAwE;QACxE,wEAAwE;QACxE,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,UAAU,CAAC;QAClD,MAAM,YAAY,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,eAAe,CAAC;QAC9D,IAAI,CAAC,MAAM,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC3C,MAAM,IAAI,WAAW,CACpB,gBAAgB,EAChB,wGAAwG,CACxG,CAAC;QACH,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,YAAY,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,IAAI,IAAI,cAAc,CAAC,IAAI,iBAAiB,EAAE,CAAC,CAAC;QAC5E,KAAK,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACvD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAClC,CAAC;QACD,kEAAkE;QAClE,kEAAkE;QAClE,iEAAiE;QACjE,sEAAsE;QACtE,wEAAwE;QACxE,sCAAsC;QACtC,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,WAAW,CACpB,gBAAgB,EAChB,6IAA6I,CAC7I,CAAC;QACH,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,WAAW,CACpB,gBAAgB,EAChB,kBAAkB,YAAY,4BAA4B,CAC1D,CAAC;QACH,CAAC;IACF,CAAC;IAED,0EAA0E;IAC1E,KAAK,CAAC,YAAY,CACjB,WAAoC,EACpC,YAAqB;QAErB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAChD,IAAI,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;YACxD,IAAI,MAAM,CAAC,IAAI;gBAAE,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC9C,OAAO,MAAM,CAAC;QACf,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,oEAAoE;YACpE,qEAAqE;YACrE,wCAAwC;YACxC,IAAI,GAAG,YAAY,WAAW;gBAAE,MAAM,GAAG,CAAC;YAC1C,oEAAoE;YACpE,iEAAiE;YACjE,sEAAsE;YACtE,mEAAmE;YACnE,uCAAuC;YACvC,OAAO,CAAC,KAAK,CACZ,sBAAsB,YAAY,IAAI,IAAI,CAAC,QAAQ,gCAAgC,EACnF,GAAG,CACH,CAAC;YACF,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;QACtD,CAAC;IACF,CAAC;IAED,8CAA8C;IAC9C,KAAK,CAAC,MAAM,CACX,KAAa,EACb,YAAqB,EACrB,OAAiC;QAEjC,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAChD,IAAI,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACrD,IAAI,MAAM,CAAC,IAAI;gBAAE,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC9C,OAAO,MAAM,CAAC;QACf,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,mEAAmE;YACnE,mEAAmE;YACnE,sEAAsE;YACtE,IAAI,GAAG,YAAY,WAAW;gBAAE,MAAM,GAAG,CAAC;YAC1C,OAAO;gBACN,aAAa,EAAE,KAAK;gBACpB,KAAK,EACJ,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,4BAA4B;gBAClE,aAAa,EAAE,IAAI;aACnB,CAAC;QACH,CAAC;IACF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,QAAQ,CACP,IAAiB,EACjB,YAAqB;IACrB,8DAA8D;IAC9D,OAA2B;QAE3B,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAChD,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,WAAW,CACpB,uBAAuB,EACvB,kBAAkB,YAAY,IAAI,IAAI,CAAC,QAAQ,wBAAwB,EACvE;gBACC,IAAI,EAAE,8HAA8H;aACpI,CACD,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,kBAAkB,CACvB,IAAiB,EACjB,QAAe,QAAQ;QAEvB,OAAO,mBAAmB,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC;IAC3E,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CACZ,IAAiB,EACjB,IAAY,EACZ,QAAe,QAAQ;QAEvB,OAAO,CAAC,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CAClB,IAAiB,EACjB,UAAkB,EAClB,QAAe,QAAQ;QAEvB,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,UAAU,CAAC;YAAE,OAAO,KAAK,CAAC;QACjD,OAAO,CAAC,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACrE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,iBAAiB,CACtB,IAAiB,EACjB,WAA8B,EAC9B,QAAe,QAAQ;QAEvB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;QAClE,OAAO,CAAC,MAAM,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACzE,CAAC;IAED,yCAAyC;IACzC;;;;;;;OAOG;IACH,mBAAmB,CAAC,GAAkB;QACrC,OAAO,IAAI,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;OAMG;IACH,yBAAyB;QAOxB,OAAO;YACN,GAAG,EAAE,CAAC,KAAc,EAAE,EAAE;gBACvB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;gBACzC,MAAM,IAAI,GAAG,QAAQ,CAAC,oBAAoB,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;gBAC3D,IAAI,CAAC,IAAI,EAAE,CAAC;oBACX,MAAM,IAAI,WAAW,CACpB,wBAAwB,EACxB,kBAAkB,KAAK,IAAI,IAAI,CAAC,QAAQ,qEAAqE,EAC7G;wBACC,IAAI,EAAE,qGAAqG;qBAC3G,CACD,CAAC;gBACH,CAAC;gBACD,OAAO,EAAE,oBAAoB,EAAE,IAAI,EAAE,CAAC;YACvC,CAAC;SACD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,SAAkB;QAChC,IAAI,CAAC;YACJ,OAAO,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC;QAC1D,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,eAAe,CAAC,SAAS,CAAC,CAAC;QACnC,CAAC;IACF,CAAC;IAED,WAAW,CAAC,IAAa;QACxB,MAAM,YAAY,GAAG,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAChD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACf,MAAM,IAAI,WAAW,CACpB,oBAAoB,EACpB,kBAAkB,YAAY,kBAAkB,EAChD;gBACC,IAAI,EAAE,0DAA0D;aAChE,CACD,CAAC;QACH,CAAC;QACD,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,IAAI,mBAAmB;QACtB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACtB,CAAC;IAED,0CAA0C;IAC1C,gBAAgB,CAAC,IAAY,EAAE,QAAsB;QACpD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED,yCAAyC;IACzC,gBAAgB;QACf,OAAO,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,KAAK,CACV,IAAiB,EACjB,OAAqB,EACrB,YAAqB,EACrB,KAAyB;QAEzB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAChD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,WAAW,CACpB,uBAAuB,EACvB,kBAAkB,YAAY,IAAI,IAAI,CAAC,QAAQ,mCAAmC,EAClF;gBACC,IAAI,EAAE,2IAA2I;aACjJ,CACD,CAAC;QACH,CAAC;QACD,MAAM,MAAM,GAAG,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,KAAK,CAAC,GAAG,MAAM,kBAAkB,EAAE;YACvC,SAAS,EAAE,YAAY,IAAI,IAAI,CAAC,QAAQ;YACxC,IAAI;SACJ,CAAC,CAAC;QACH,MAAM,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK,CAAC,GAAG,MAAM,kBAAkB,EAAE;YACvC,SAAS,EAAE,YAAY,IAAI,IAAI,CAAC,QAAQ;YACxC,IAAI;YACJ,SAAS,EAAE,SAAS;SACpB,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,8BAA8B,CACnC,WAAoB,EACpB,YAAqB,EACrB,KAAyB;QAEzB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAChD,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,EAAE,CAAC;YACpC,MAAM,IAAI,WAAW,CACpB,uBAAuB,EACvB,kBAAkB,YAAY,IAAI,IAAI,CAAC,QAAQ,8BAA8B,EAC7E;gBACC,IAAI,EAAE,+IAA+I;aACrJ,CACD,CAAC;QACH,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,8BAA8B,CAC5D,WAAW,EACX,KAAK,CACL,CAAC;QACF,wEAAwE;QACxE,IAAI,OAAO;YAAE,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC3C,OAAO,OAAO,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,MAAM,CACX,OAAqB,EACrB,YAAqB,EACrB,KAAyB;QAEzB,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAChD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,WAAW,CACpB,uBAAuB,EACvB,kBAAkB,YAAY,IAAI,IAAI,CAAC,QAAQ,oCAAoC,CACnF,CAAC;QACH,CAAC;QACD,MAAM,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC,KAAK,CAAC,GAAG,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE;YAC1D,SAAS,EAAE,YAAY,IAAI,IAAI,CAAC,QAAQ;YACxC,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,IAAI;SACX,CAAC,CAAC;IACJ,CAAC;CACD;AAWD;;;;;;;GAOG;AACH,SAAS,mBAAmB,CAC3B,QAAsB;IAEtB,OAAO,CACN,gCAAgC,IAAI,QAAQ;QAC5C,OAAO,QAAQ,CAAC,8BAA8B,KAAK,UAAU,CAC7D,CAAC;AACH,CAAC;AAWD;;;;GAIG;AACH,SAAS,cAAc,CACtB,QAAsB;IAEtB,OAAO,CACN,OAAO,IAAI,QAAQ;QACnB,OAAO,QAAQ,CAAC,KAAK,KAAK,UAAU;QACpC,QAAQ,IAAI,QAAQ;QACpB,OAAO,QAAQ,CAAC,MAAM,KAAK,UAAU,CACrC,CAAC;AACH,CAAC;AAED,kEAAkE;AAClE;;;;;;GAMG"}
|
|
@@ -43,11 +43,24 @@ export interface AttemptDecision {
|
|
|
43
43
|
export declare class AuthRateLimiter {
|
|
44
44
|
#private;
|
|
45
45
|
constructor(config?: AuthRateLimiterConfig);
|
|
46
|
-
/**
|
|
46
|
+
/**
|
|
47
|
+
* The keys a login attempt is counted under: its IP first, then its
|
|
48
|
+
* identifier. The identifier is keyed by the SHA-256 of its normalized form
|
|
49
|
+
* (trimmed, lowercased): it is whatever the client posted, and kept
|
|
50
|
+
* verbatim a 1 MB body pinned 1 MB in the store for the whole window.
|
|
51
|
+
*/
|
|
47
52
|
static loginKeys(ip: string, identifier: string): string[];
|
|
48
53
|
/**
|
|
49
|
-
* Count an attempt under
|
|
50
|
-
* BEFORE checking the credential; a refused attempt must not reach
|
|
54
|
+
* Count an attempt under its keys, in order, and say whether it may go on.
|
|
55
|
+
* Call it BEFORE checking the credential; a refused attempt must not reach
|
|
56
|
+
* it.
|
|
57
|
+
*
|
|
58
|
+
* The first key over the limit refuses the attempt and the keys after it
|
|
59
|
+
* are not counted. Counting them all let an IP already throttled create
|
|
60
|
+
* one `id:` window per request: a client cycling identifiers filled the
|
|
61
|
+
* memory store, whose bound then refused every other client's new keys.
|
|
62
|
+
* Stopped at the spent `ip:` key, one address touches at most
|
|
63
|
+
* `maxAttempts` identifiers per window.
|
|
51
64
|
*/
|
|
52
65
|
attempt(...keys: string[]): Promise<AttemptDecision>;
|
|
53
66
|
/** Whether any key has used up its attempts, without counting one. */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AuthRateLimiter.d.ts","sourceRoot":"","sources":["../src/AuthRateLimiter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;
|
|
1
|
+
{"version":3,"file":"AuthRateLimiter.d.ts","sourceRoot":"","sources":["../src/AuthRateLimiter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAGH,OAAO,EAAE,KAAK,YAAY,EAAsB,MAAM,mBAAmB,CAAC;AAG1E,MAAM,WAAW,qBAAqB;IACrC,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iEAAiE;IACjE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,KAAK,CAAC,EAAE,YAAY,CAAC;CACrB;AAED,oDAAoD;AACpD,MAAM,WAAW,eAAe;IAC/B,8DAA8D;IAC9D,OAAO,EAAE,OAAO,CAAC;IACjB,0CAA0C;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,qDAAqD;IACrD,iBAAiB,EAAE,MAAM,CAAC;CAC1B;AAED,qBAAa,eAAe;;gBAKf,MAAM,GAAE,qBAA0B;IAS9C;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM,EAAE;IAO1D;;;;;;;;;;;OAWG;IACG,OAAO,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC;IAc1D,sEAAsE;IAChE,SAAS,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAKpD,mDAAmD;IAC7C,KAAK,CAAC,GAAG,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CAG7C"}
|
package/dist/AuthRateLimiter.js
CHANGED
|
@@ -18,6 +18,7 @@
|
|
|
18
18
|
*
|
|
19
19
|
* @implements MISS-26
|
|
20
20
|
*/
|
|
21
|
+
import { createHash } from "node:crypto";
|
|
21
22
|
import { MemoryAttemptStore } from "./AttemptStore.js";
|
|
22
23
|
import { WardenError } from "./errors.js";
|
|
23
24
|
export class AuthRateLimiter {
|
|
@@ -29,20 +30,38 @@ export class AuthRateLimiter {
|
|
|
29
30
|
this.#windowSeconds = positiveInteger("windowSeconds", config.windowSeconds ?? 900);
|
|
30
31
|
this.#store = config.store ?? new MemoryAttemptStore();
|
|
31
32
|
}
|
|
32
|
-
/**
|
|
33
|
+
/**
|
|
34
|
+
* The keys a login attempt is counted under: its IP first, then its
|
|
35
|
+
* identifier. The identifier is keyed by the SHA-256 of its normalized form
|
|
36
|
+
* (trimmed, lowercased): it is whatever the client posted, and kept
|
|
37
|
+
* verbatim a 1 MB body pinned 1 MB in the store for the whole window.
|
|
38
|
+
*/
|
|
33
39
|
static loginKeys(ip, identifier) {
|
|
34
|
-
|
|
40
|
+
const digest = createHash("sha256")
|
|
41
|
+
.update(identifier.trim().toLowerCase())
|
|
42
|
+
.digest("base64url");
|
|
43
|
+
return [`ip:${ip.trim()}`, `id:${digest}`];
|
|
35
44
|
}
|
|
36
45
|
/**
|
|
37
|
-
* Count an attempt under
|
|
38
|
-
* BEFORE checking the credential; a refused attempt must not reach
|
|
46
|
+
* Count an attempt under its keys, in order, and say whether it may go on.
|
|
47
|
+
* Call it BEFORE checking the credential; a refused attempt must not reach
|
|
48
|
+
* it.
|
|
49
|
+
*
|
|
50
|
+
* The first key over the limit refuses the attempt and the keys after it
|
|
51
|
+
* are not counted. Counting them all let an IP already throttled create
|
|
52
|
+
* one `id:` window per request: a client cycling identifiers filled the
|
|
53
|
+
* memory store, whose bound then refused every other client's new keys.
|
|
54
|
+
* Stopped at the spent `ip:` key, one address touches at most
|
|
55
|
+
* `maxAttempts` identifiers per window.
|
|
39
56
|
*/
|
|
40
57
|
async attempt(...keys) {
|
|
41
|
-
const counts = await Promise.all(keys.map((key) => this.#store.increment(key, this.#windowSeconds)));
|
|
42
58
|
let highest = { count: 0, resetSeconds: 0 };
|
|
43
|
-
for (const
|
|
59
|
+
for (const key of keys) {
|
|
60
|
+
const counted = await this.#store.increment(key, this.#windowSeconds);
|
|
44
61
|
if (counted.count > highest.count)
|
|
45
62
|
highest = counted;
|
|
63
|
+
if (counted.count > this.#maxAttempts)
|
|
64
|
+
break;
|
|
46
65
|
}
|
|
47
66
|
return {
|
|
48
67
|
allowed: highest.count <= this.#maxAttempts,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AuthRateLimiter.js","sourceRoot":"","sources":["../src/AuthRateLimiter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAqB,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAyB1C,MAAM,OAAO,eAAe;IAClB,YAAY,CAAS;IACrB,cAAc,CAAS;IACvB,MAAM,CAAe;IAE9B,YAAY,SAAgC,EAAE;QAC7C,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC,aAAa,EAAE,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC;QAC5E,IAAI,CAAC,cAAc,GAAG,eAAe,CACpC,eAAe,EACf,MAAM,CAAC,aAAa,IAAI,GAAG,CAC3B,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,IAAI,IAAI,kBAAkB,EAAE,CAAC;IACxD,CAAC;IAED
|
|
1
|
+
{"version":3,"file":"AuthRateLimiter.js","sourceRoot":"","sources":["../src/AuthRateLimiter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAqB,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAC1E,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAyB1C,MAAM,OAAO,eAAe;IAClB,YAAY,CAAS;IACrB,cAAc,CAAS;IACvB,MAAM,CAAe;IAE9B,YAAY,SAAgC,EAAE;QAC7C,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC,aAAa,EAAE,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC;QAC5E,IAAI,CAAC,cAAc,GAAG,eAAe,CACpC,eAAe,EACf,MAAM,CAAC,aAAa,IAAI,GAAG,CAC3B,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,KAAK,IAAI,IAAI,kBAAkB,EAAE,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,EAAU,EAAE,UAAkB;QAC9C,MAAM,MAAM,GAAG,UAAU,CAAC,QAAQ,CAAC;aACjC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;aACvC,MAAM,CAAC,WAAW,CAAC,CAAC;QACtB,OAAO,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,EAAE,MAAM,MAAM,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,OAAO,CAAC,GAAG,IAAc;QAC9B,IAAI,OAAO,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,EAAE,CAAC;QAC5C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;YACtE,IAAI,OAAO,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK;gBAAE,OAAO,GAAG,OAAO,CAAC;YACrD,IAAI,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,YAAY;gBAAE,MAAM;QAC9C,CAAC;QACD,OAAO;YACN,OAAO,EAAE,OAAO,CAAC,KAAK,IAAI,IAAI,CAAC,YAAY;YAC3C,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC;YACzD,iBAAiB,EAAE,OAAO,CAAC,YAAY;SACvC,CAAC;IACH,CAAC;IAED,sEAAsE;IACtE,KAAK,CAAC,SAAS,CAAC,GAAG,IAAc;QAChC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAC5E,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC;IAC3D,CAAC;IAED,mDAAmD;IACnD,KAAK,CAAC,KAAK,CAAC,GAAG,IAAc;QAC5B,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC9D,CAAC;CACD;AAED;;;GAGG;AACH,SAAS,eAAe,CAAC,KAAa,EAAE,KAAa;IACpD,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;QAChD,MAAM,IAAI,WAAW,CACpB,gBAAgB,EAChB,mBAAmB,KAAK,yCAAyC,MAAM,CAAC,KAAK,CAAC,EAAE,CAChF,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC"}
|
package/dist/Authenticator.d.ts
CHANGED
|
@@ -13,8 +13,10 @@
|
|
|
13
13
|
* (resolved via `ctx.containerResolver`) + the request `ctx`; it never imports
|
|
14
14
|
* `@c9up/ream`.
|
|
15
15
|
*/
|
|
16
|
-
import type {
|
|
16
|
+
import type { AccessToken, CreateAccessTokenOptions, TokenOwner } from "./AccessToken.js";
|
|
17
|
+
import type { AuthClientResponse, AuthManager, AuthResult, UserPayload } from "./AuthManager.js";
|
|
17
18
|
import type { WardenContext } from "./middleware.js";
|
|
19
|
+
import type { Scope } from "./rights/types.js";
|
|
18
20
|
import { type SessionStore } from "./strategies/SessionStrategy.js";
|
|
19
21
|
/**
|
|
20
22
|
* Guard names Warden accepts for the API-key / access-tokens driver. AdonisJS
|
|
@@ -55,6 +57,38 @@ export declare class GuardAccessor {
|
|
|
55
57
|
/** The user, only if the request authenticated via THIS guard. */
|
|
56
58
|
get user(): UserPayload | undefined;
|
|
57
59
|
get isAuthenticated(): boolean;
|
|
60
|
+
/** Whether this guard was tried during the request (AdonisJS guard parity). */
|
|
61
|
+
get authenticationAttempted(): boolean;
|
|
62
|
+
/**
|
|
63
|
+
* The user, or `E_UNAUTHORIZED_ACCESS` when this guard did not authenticate
|
|
64
|
+
* the request (AdonisJS `guard.getUserOrFail()`).
|
|
65
|
+
*/
|
|
66
|
+
getUserOrFail(): UserPayload;
|
|
67
|
+
/**
|
|
68
|
+
* Authenticate through this guard and say whether it worked, without
|
|
69
|
+
* throwing on a credential rejection (AdonisJS `guard.check()`). A crashed
|
|
70
|
+
* strategy still throws: an outage is not a guest.
|
|
71
|
+
*/
|
|
72
|
+
check(): Promise<boolean>;
|
|
73
|
+
/**
|
|
74
|
+
* What a test client sends to be a user through this guard (AdonisJS
|
|
75
|
+
* `guard.authenticateAsClient`). The arguments are the strategy's own: a
|
|
76
|
+
* user for a session guard, a user plus abilities for a token guard.
|
|
77
|
+
*/
|
|
78
|
+
authenticateAsClient(...args: unknown[]): Promise<AuthClientResponse>;
|
|
79
|
+
/**
|
|
80
|
+
* Mint an access token for `user` through this guard (AdonisJS
|
|
81
|
+
* `auth.use('api').createToken(user, abilities, options)`). The returned
|
|
82
|
+
* token carries its `value` this once: hand it to the client now.
|
|
83
|
+
*/
|
|
84
|
+
createToken(user: TokenOwner, abilities?: string[], options?: CreateAccessTokenOptions): Promise<AccessToken>;
|
|
85
|
+
/**
|
|
86
|
+
* Revoke the access token this request came in with (AdonisJS
|
|
87
|
+
* `auth.use('api').invalidateToken()`) — the sign-out of a token client.
|
|
88
|
+
* Answers whether it existed; `E_UNAUTHORIZED_ACCESS` when the request
|
|
89
|
+
* carries no token, as upstream.
|
|
90
|
+
*/
|
|
91
|
+
invalidateToken(): Promise<boolean>;
|
|
58
92
|
/**
|
|
59
93
|
* Whether the user was revived from a remember-me cookie rather than
|
|
60
94
|
* signing in.
|
|
@@ -84,8 +118,11 @@ export declare class GuardAccessor {
|
|
|
84
118
|
user: UserPayload;
|
|
85
119
|
cookieValue: string;
|
|
86
120
|
} | null>;
|
|
87
|
-
/**
|
|
88
|
-
|
|
121
|
+
/**
|
|
122
|
+
* Authenticate the request using only this guard, resolving to the user
|
|
123
|
+
* (throws `E_UNAUTHORIZED_ACCESS` on failure).
|
|
124
|
+
*/
|
|
125
|
+
authenticate(): Promise<UserPayload>;
|
|
89
126
|
/**
|
|
90
127
|
* Revive this request from the remember-me cookie, if the browser holds one.
|
|
91
128
|
*
|
|
@@ -110,7 +147,25 @@ export declare class GuardAccessor {
|
|
|
110
147
|
* guards; a JWT carries it as `issueFor(user, guard, { mfa: true })`).
|
|
111
148
|
*/
|
|
112
149
|
markMfaVerified(): void;
|
|
113
|
-
/**
|
|
150
|
+
/**
|
|
151
|
+
* Log the current user out of this guard (session guards).
|
|
152
|
+
*
|
|
153
|
+
* Ends the remember-me credential too, as upstream's session guard does: the
|
|
154
|
+
* cookie is cleared and the stored token behind it deleted. Leaving either
|
|
155
|
+
* meant the next request, with an empty session, was signed straight back
|
|
156
|
+
* in from the cookie.
|
|
157
|
+
*
|
|
158
|
+
* The cookie is cleared first and whatever happens next: a store that fails
|
|
159
|
+
* to delete the row must not leave the browser holding the credential. The
|
|
160
|
+
* store's error is still thrown, after the session is ended, because a token
|
|
161
|
+
* row that survived a logout is something the application has to know about.
|
|
162
|
+
*
|
|
163
|
+
* NAMED DEVIATION — upstream deletes the row only once the presented secret
|
|
164
|
+
* matches it and only for the signed-in user. Here the row is deleted from
|
|
165
|
+
* the identifier the (encrypted) cookie names whatever the secret: a cookie
|
|
166
|
+
* whose secret no longer matches is one a stolen copy already recycled, and
|
|
167
|
+
* a logout from the real browser is exactly when that copy must die.
|
|
168
|
+
*/
|
|
114
169
|
logout(): Promise<void>;
|
|
115
170
|
}
|
|
116
171
|
/**
|
|
@@ -130,16 +185,46 @@ export declare class Authenticator {
|
|
|
130
185
|
get authenticationAttempted(): boolean;
|
|
131
186
|
/** Name of the guard that authenticated the request, if any. */
|
|
132
187
|
get authenticatedViaGuard(): string | undefined;
|
|
188
|
+
/** The guard used when none is named (AdonisJS `auth.defaultGuard`). */
|
|
189
|
+
get defaultGuard(): string;
|
|
190
|
+
/** @internal Whether `name` was tried during this request. */
|
|
191
|
+
attemptedVia(name: string): boolean;
|
|
133
192
|
/**
|
|
134
193
|
* Roles of the authenticated user (Ream reads `ctx.auth.roles ??
|
|
135
194
|
* ctx.auth.user.roles`). Warden nests them under `user`; this getter mirrors
|
|
136
195
|
* them at the top level for the host's guard readers.
|
|
137
196
|
*/
|
|
138
197
|
get roles(): string[] | undefined;
|
|
139
|
-
/**
|
|
198
|
+
/**
|
|
199
|
+
* Permissions the authenticated user's PAYLOAD carries (see
|
|
200
|
+
* {@link Authenticator.roles}). Informational only: a decision goes through
|
|
201
|
+
* {@link Authenticator.hasPermission}, which consults the rights resolver.
|
|
202
|
+
*/
|
|
140
203
|
get permissions(): string[] | undefined;
|
|
141
|
-
/**
|
|
142
|
-
|
|
204
|
+
/**
|
|
205
|
+
* Whether the authenticated user may do `permission` within `scope`.
|
|
206
|
+
*
|
|
207
|
+
* Delegates to {@link AuthManager.hasPermission}: the rights resolver decides
|
|
208
|
+
* (roles and grants from the store, never the payload's `permissions`), and
|
|
209
|
+
* the access token the request came with narrows it. A guest holds nothing.
|
|
210
|
+
*
|
|
211
|
+
* No upstream shape to mirror: the upstream authenticator has no notion of
|
|
212
|
+
* permissions. This is how a host's gates reach warden's rights layer
|
|
213
|
+
* through `ctx.auth` without importing warden.
|
|
214
|
+
*/
|
|
215
|
+
hasPermission(permission: string, scope?: Scope): Promise<boolean>;
|
|
216
|
+
/**
|
|
217
|
+
* Whether the authenticated user may do every one of `permissions` within
|
|
218
|
+
* `scope` — {@link Authenticator.hasPermission} for a list. A guest holds
|
|
219
|
+
* nothing, not even the empty list.
|
|
220
|
+
*/
|
|
221
|
+
hasAllPermissions(permissions: readonly string[], scope?: Scope): Promise<boolean>;
|
|
222
|
+
/**
|
|
223
|
+
* Authenticate via the default guard and resolve to the user (AdonisJS
|
|
224
|
+
* `const user = await auth.authenticate()`). Throws `E_UNAUTHORIZED_ACCESS`
|
|
225
|
+
* on failure.
|
|
226
|
+
*/
|
|
227
|
+
authenticate(): Promise<UserPayload>;
|
|
143
228
|
/**
|
|
144
229
|
* Like {@link Authenticator.authenticate} but returns a boolean instead of
|
|
145
230
|
* throwing on a credential rejection. A strategy CRASH / config error still
|
|
@@ -166,11 +251,14 @@ export declare class Authenticator {
|
|
|
166
251
|
*/
|
|
167
252
|
authenticateUsing(guards?: string[], options?: {
|
|
168
253
|
loginRoute?: string;
|
|
169
|
-
}): Promise<
|
|
254
|
+
}): Promise<UserPayload>;
|
|
170
255
|
/** Return the authenticated user or throw `E_UNAUTHORIZED_ACCESS`. */
|
|
171
256
|
getUserOrFail(): UserPayload;
|
|
172
|
-
/**
|
|
173
|
-
|
|
257
|
+
/**
|
|
258
|
+
* Access a named guard (AdonisJS `auth.use('web')`); the default guard when
|
|
259
|
+
* no name is given. Instances are cached per request.
|
|
260
|
+
*/
|
|
261
|
+
use(name?: string): GuardAccessor;
|
|
174
262
|
/**
|
|
175
263
|
* @internal Seed the Authenticator from a result the enforcing middleware
|
|
176
264
|
* already computed, so `ctx.auth` reflects the authenticated user without a
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Authenticator.d.ts","sourceRoot":"","sources":["../src/Authenticator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EACX,WAAW,EACX,UAAU,EAEV,WAAW,EACX,MAAM,kBAAkB,CAAC;
|
|
1
|
+
{"version":3,"file":"Authenticator.d.ts","sourceRoot":"","sources":["../src/Authenticator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EACX,WAAW,EACX,wBAAwB,EACxB,UAAU,EACV,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EACX,kBAAkB,EAClB,WAAW,EACX,UAAU,EAEV,WAAW,EACX,MAAM,kBAAkB,CAAC;AAG1B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,EAIN,KAAK,YAAY,EACjB,MAAM,iCAAiC,CAAC;AAGzC;;;;GAIG;AACH,eAAO,MAAM,mBAAmB,EAAE,SAAS,MAAM,EAGhD,CAAC;AA0IF,iFAAiF;AACjF,MAAM,WAAW,oBAAoB;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,YAAY,GAAG,SAAS,CAAC;CAClC;AAiCD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CACjC,GAAG,EAAE,aAAa,EAClB,IAAI,EAAE,WAAW,GACf,oBAAoB,CAUtB;AAED,0CAA0C;AAC1C,MAAM,WAAW,WAAW;IAC3B,MAAM,EAAE,UAAU,GAAG,IAAI,CAAC;IAC1B,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;CACnB;AA4ED;;;GAGG;AACH,qBAAa,aAAa;;gBAaxB,GAAG,EAAE,aAAa,EAClB,IAAI,EAAE,WAAW,EACjB,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,aAAa;IAQtB,kEAAkE;IAClE,IAAI,IAAI,IAAI,WAAW,GAAG,SAAS,CAIlC;IAED,IAAI,eAAe,IAAI,OAAO,CAE7B;IAED,+EAA+E;IAC/E,IAAI,uBAAuB,IAAI,OAAO,CAErC;IAED;;;OAGG;IACH,aAAa,IAAI,WAAW;IAU5B;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;IAU/B;;;;OAIG;IACG,oBAAoB,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAsB3E;;;;OAIG;IACG,WAAW,CAChB,IAAI,EAAE,UAAU,EAChB,SAAS,CAAC,EAAE,MAAM,EAAE,EACpB,OAAO,CAAC,EAAE,wBAAwB,GAChC,OAAO,CAAC,WAAW,CAAC;IAIvB;;;;;OAKG;IACG,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC;IA4BzC;;;;;;;OAOG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED,qEAAqE;IACrE,IAAI,oBAAoB,IAAI,OAAO,CAElC;IAED;;;;;OAKG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED;;;;;;OAMG;IACH,8BAA8B,CAC7B,WAAW,EAAE,OAAO,GAClB,OAAO,CAAC;QAAE,IAAI,EAAE,WAAW,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAQ7D;;;OAGG;IACH,YAAY,IAAI,OAAO,CAAC,WAAW,CAAC;IAIpC;;;;;;OAMG;IACG,mBAAmB,IAAI,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAwC7D;;;;;;;;OAQG;IACG,KAAK,CAAC,IAAI,EAAE,WAAW,EAAE,QAAQ,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAuG/D;;;;OAIG;IACH,eAAe,IAAI,IAAI;IAmBvB;;;;;;;;;;;;;;;;;;OAkBG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;CA+B7B;AAED;;;;;GAKG;AACH,qBAAa,aAAa;;gBAUb,GAAG,EAAE,aAAa,EAAE,IAAI,EAAE,WAAW;IAKjD,0DAA0D;IAC1D,IAAI,IAAI,IAAI,WAAW,GAAG,SAAS,CAElC;IAED,qEAAqE;IACrE,IAAI,eAAe,IAAI,OAAO,CAE7B;IAED,2EAA2E;IAC3E,IAAI,uBAAuB,IAAI,OAAO,CAErC;IAED,gEAAgE;IAChE,IAAI,qBAAqB,IAAI,MAAM,GAAG,SAAS,CAE9C;IAED,wEAAwE;IACxE,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED,8DAA8D;IAC9D,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAInC;;;;OAIG;IACH,IAAI,KAAK,IAAI,MAAM,EAAE,GAAG,SAAS,CAEhC;IAED;;;;OAIG;IACH,IAAI,WAAW,IAAI,MAAM,EAAE,GAAG,SAAS,CAEtC;IAED;;;;;;;;;;OAUG;IACG,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC;IAKxE;;;;OAIG;IACG,iBAAiB,CACtB,WAAW,EAAE,SAAS,MAAM,EAAE,EAC9B,KAAK,CAAC,EAAE,KAAK,GACX,OAAO,CAAC,OAAO,CAAC;IAKnB;;;;OAIG;IACH,YAAY,IAAI,OAAO,CAAC,WAAW,CAAC;IAIpC;;;;OAIG;IACG,KAAK,IAAI,OAAO,CAAC,OAAO,CAAC;IAU/B;;;;;;;;OAQG;IACG,UAAU,CACf,MAAM,CAAC,EAAE,MAAM,EAAE,EACjB,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAC/B,OAAO,CAAC,OAAO,CAAC;IAanB;;;;;OAKG;IACG,iBAAiB,CACtB,MAAM,CAAC,EAAE,MAAM,EAAE,EACjB,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,GAC/B,OAAO,CAAC,WAAW,CAAC;IAoFvB,sEAAsE;IACtE,aAAa,IAAI,WAAW;IAU5B;;;OAGG;IACH,GAAG,CAAC,IAAI,GAAE,MAAuC,GAAG,aAAa;IASjE;;;;OAIG;IACH,KAAK,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI,EAAE,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;CAQpE"}
|