@c9up/warden 0.2.6 → 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 +4 -2
- package/dist/AttemptStore.d.ts.map +1 -1
- package/dist/AttemptStore.js +12 -0
- package/dist/AttemptStore.js.map +1 -1
- package/dist/AuthManager.d.ts +11 -6
- package/dist/AuthManager.d.ts.map +1 -1
- package/dist/AuthManager.js +19 -9
- 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 +79 -9
- package/dist/Authenticator.d.ts.map +1 -1
- package/dist/Authenticator.js +186 -16
- package/dist/Authenticator.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.map +1 -1
- package/dist/ResilientBlacklistDriver.js +2 -1
- 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/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/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 +6 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4 -3
- package/dist/index.js.map +1 -1
- package/dist/mfa/MfaManager.d.ts +17 -4
- package/dist/mfa/MfaManager.d.ts.map +1 -1
- package/dist/mfa/MfaManager.js +37 -14
- 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 +1 -1
- package/dist/middleware.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.map +1 -1
- package/dist/standalone.js +2 -4
- package/dist/standalone.js.map +1 -1
- package/dist/strategies/ApiKeyStrategy.d.ts +5 -4
- package/dist/strategies/ApiKeyStrategy.d.ts.map +1 -1
- package/dist/strategies/ApiKeyStrategy.js +10 -5
- 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 +55 -8
- 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/vendor/quasarConnection.d.ts +18 -0
- package/dist/vendor/quasarConnection.d.ts.map +1 -1
- package/dist/vendor/quasarConnection.js +20 -0
- 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 +3 -4
- package/src/AttemptStore.ts +13 -0
- package/src/AuthManager.ts +35 -16
- package/src/AuthRateLimiter.ts +24 -8
- package/src/Authenticator.ts +243 -19
- package/src/RedisBlacklistDriver.ts +11 -0
- package/src/RefreshTokenStore.ts +79 -13
- package/src/ResilientBlacklistDriver.ts +2 -1
- package/src/TokenBlacklist.ts +28 -1
- 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/errors.ts +80 -2
- package/src/index.ts +11 -0
- package/src/mfa/MfaManager.ts +59 -16
- package/src/mfa/TotpProvider.ts +15 -2
- package/src/mfa/WebauthnProvider.ts +77 -13
- package/src/middleware.ts +16 -3
- package/src/rights/RightsResolver.ts +27 -0
- package/src/sanitize.ts +4 -2
- package/src/services/main.ts +14 -2
- package/src/standalone.ts +2 -5
- package/src/strategies/ApiKeyStrategy.ts +10 -5
- package/src/strategies/BasicAuthStrategy.ts +7 -2
- package/src/strategies/JwtStrategy.ts +58 -9
- package/src/strategies/SessionStrategy.ts +4 -1
- package/src/vendor/quasarConnection.ts +21 -0
- 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/README.md
CHANGED
|
@@ -13,7 +13,9 @@ const auth = new AuthManager({
|
|
|
13
13
|
})
|
|
14
14
|
|
|
15
15
|
const result = await auth.authenticate({ email: 'admin@c9up.com', password: 'secret' })
|
|
16
|
-
|
|
16
|
+
if (result.authenticated && result.user) {
|
|
17
|
+
await auth.hasRole(result.user, 'admin') // true
|
|
18
|
+
}
|
|
17
19
|
|
|
18
20
|
class OrderController {
|
|
19
21
|
@Guard('jwt')
|
|
@@ -33,7 +35,7 @@ authorization; an override inherits them too unless it declares its own.
|
|
|
33
35
|
- Multi-strategy AuthManager (JWT, session, access tokens, HTTP Basic)
|
|
34
36
|
- `@Guard()`, `@Permission()`, `@Role()` decorators
|
|
35
37
|
- RBAC: `hasRole`, `hasPermission`, `hasAllPermissions`
|
|
36
|
-
- Unified authorization:
|
|
38
|
+
- Unified authorization: abilities & policies (`Bouncer`) over one resolver — RBAC + ACL + ownership + multi-tenant scope, zero dependency
|
|
37
39
|
- Strategy exception safety (catch → AuthResult)
|
|
38
40
|
- Runtime strategy registration
|
|
39
41
|
- **Multi-factor authentication** — TOTP, backup codes, email/SMS OTP, WebAuthn/passkeys, all dependency-free
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AttemptStore.d.ts","sourceRoot":"","sources":["../src/AttemptStore.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;
|
|
1
|
+
{"version":3,"file":"AttemptStore.d.ts","sourceRoot":"","sources":["../src/AttemptStore.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAIH,kDAAkD;AAClD,MAAM,WAAW,YAAY;IAC5B;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,YAAY,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,YAAY;IAC5B;;;OAGG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IACrE,0EAA0E;IAC1E,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACpC,iDAAiD;IACjD,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClC;AAKD;;;;;;;;;;;GAWG;AACH,qBAAa,kBAAmB,YAAW,YAAY;;gBAI1C,OAAO,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO;IAIxC,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAmBpE,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAUnC,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAmBvC;AAED,oFAAoF;AACpF,MAAM,WAAW,kBAAkB;IAClC,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACnC,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACvD,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAClC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACzC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACnC;AAED,uEAAuE;AACvE,MAAM,MAAM,kBAAkB,GAC3B,kBAAkB,GAClB,CAAC,MAAM,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC;AAEvC;;;GAGG;AACH,qBAAa,iBAAkB,YAAW,YAAY;;gBAKzC,MAAM,EAAE,kBAAkB,EAAE,OAAO,GAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAO;IAuBnE,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAkBpE,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAOnC,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAIvC"}
|
package/dist/AttemptStore.js
CHANGED
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
* The memory store is one process's; a cluster shares {@link RedisAttemptStore}
|
|
11
11
|
* so a lockout holds whichever instance the next attempt lands on.
|
|
12
12
|
*/
|
|
13
|
+
import { hasEnded } from "./vendor/quasarConnection.js";
|
|
13
14
|
/** Most keys the memory store holds before it makes room. */
|
|
14
15
|
const DEFAULT_MAX_KEYS = 100_000;
|
|
15
16
|
/**
|
|
@@ -93,7 +94,18 @@ export class RedisAttemptStore {
|
|
|
93
94
|
this.#source = source;
|
|
94
95
|
this.#prefix = options.prefix ?? "warden:attempts";
|
|
95
96
|
}
|
|
97
|
+
/**
|
|
98
|
+
* The client, resolved on first use and again once it has ended for good:
|
|
99
|
+
* quasar retires a connection whose retry strategy gave up and hands out a
|
|
100
|
+
* fresh one, and keeping the dead client failed every call with "Connection
|
|
101
|
+
* is closed." until restart. NAMED DEVIATION, better than upstream, whose
|
|
102
|
+
* Redis stores capture `ioConnection` once. A client handed in directly is
|
|
103
|
+
* kept whatever its state.
|
|
104
|
+
*/
|
|
96
105
|
async #client() {
|
|
106
|
+
if (typeof this.#source === "function" && hasEnded(this.#resolved)) {
|
|
107
|
+
this.#resolved = undefined;
|
|
108
|
+
}
|
|
97
109
|
if (this.#resolved)
|
|
98
110
|
return this.#resolved;
|
|
99
111
|
this.#resolved =
|
package/dist/AttemptStore.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AttemptStore.js","sourceRoot":"","sources":["../src/AttemptStore.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;
|
|
1
|
+
{"version":3,"file":"AttemptStore.js","sourceRoot":"","sources":["../src/AttemptStore.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AAyBxD,6DAA6D;AAC7D,MAAM,gBAAgB,GAAG,OAAO,CAAC;AAEjC;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,kBAAkB;IACrB,QAAQ,GAAG,IAAI,GAAG,EAA8C,CAAC;IACjE,QAAQ,CAAS;IAE1B,YAAY,UAAgC,EAAE;QAC7C,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,OAAO,IAAI,gBAAgB,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,GAAW,EAAE,aAAqB;QACjD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,IAAI,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC;YACjD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;YACjC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,iBAAiB,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC;YAChE,CAAC;YACD,KAAK,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,GAAG,aAAa,GAAG,IAAI,EAAE,CAAC;YAC1D,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC/B,CAAC;QACD,KAAK,CAAC,KAAK,EAAE,CAAC;QACd,OAAO;YACN,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,YAAY,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC;SACrD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,GAAW;QACtB,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACrC,IAAI,KAAK,KAAK,SAAS;YAAE,OAAO,CAAC,CAAC;QAClC,IAAI,KAAK,CAAC,OAAO,IAAI,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;YACjC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAC1B,OAAO,CAAC,CAAC;QACV,CAAC;QACD,OAAO,KAAK,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,GAAW;QACtB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,GAAW;QACpB,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ;YAAE,OAAO,SAAS,CAAC;QACzD,IAAI,QAAQ,GAAG,MAAM,CAAC,iBAAiB,CAAC;QACxC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC1C,IAAI,KAAK,CAAC,OAAO,IAAI,GAAG;gBAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;;gBAC/C,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACnD,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ;YAAE,OAAO,SAAS,CAAC;QACzD,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACxD,CAAC;CACD;AAgBD;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IACpB,OAAO,CAAqB;IACrC,SAAS,CAAiC;IACjC,OAAO,CAAS;IAEzB,YAAY,MAA0B,EAAE,UAA+B,EAAE;QACxE,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,IAAI,iBAAiB,CAAC;IACpD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,OAAO;QACZ,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACpE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC5B,CAAC;QACD,IAAI,IAAI,CAAC,SAAS;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC;QAC1C,IAAI,CAAC,SAAS;YACb,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;QAC1E,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,GAAW,EAAE,aAAqB;QACjD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACpC,MAAM,UAAU,GAAG,GAAG,IAAI,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC;QAC5C,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5C,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC;YACjB,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;YAC/C,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC;QAC/C,CAAC;QACD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QACzC,mEAAmE;QACnE,uEAAuE;QACvE,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;YACb,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;YAC/C,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC;QAC/C,CAAC;QACD,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC;IACrC,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,GAAW;QACtB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACpC,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC,CAAC;QACzD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC;QACjC,OAAO,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,GAAW;QACtB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACpC,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC,CAAC;IAC5C,CAAC;CACD"}
|
package/dist/AuthManager.d.ts
CHANGED
|
@@ -47,11 +47,13 @@ export interface AuthResult {
|
|
|
47
47
|
user?: UserPayload;
|
|
48
48
|
error?: string;
|
|
49
49
|
/**
|
|
50
|
-
*
|
|
51
|
-
*
|
|
52
|
-
* rejection
|
|
53
|
-
*
|
|
54
|
-
*
|
|
50
|
+
* Set when the strategy's `verify()` / `authenticate()` THREW a generic
|
|
51
|
+
* error, as opposed to returning a deliberate `{ authenticated: false }`
|
|
52
|
+
* rejection: a server incident (the user store is down), not bad
|
|
53
|
+
* credentials. A caller answers it as unavailable (500), does not count it
|
|
54
|
+
* against the user's failed attempts, and does not tell the user their
|
|
55
|
+
* password is wrong. `authenticate()` carries no `error` text with it; the
|
|
56
|
+
* cause is in the server log.
|
|
55
57
|
*/
|
|
56
58
|
strategyCrash?: true;
|
|
57
59
|
}
|
|
@@ -177,6 +179,9 @@ export declare class AuthManager {
|
|
|
177
179
|
* Bouncer policy path (`this.permissions`, 56.3) consults the SAME resolver,
|
|
178
180
|
* so a coarse question and a policy question return the same answer for the
|
|
179
181
|
* same `(user, scope)` (the single unification point — AC-E3).
|
|
182
|
+
*
|
|
183
|
+
* Narrowed by the access token the user came in with, if any
|
|
184
|
+
* ({@link narrowToAccessToken}): the set is what THIS request may do.
|
|
180
185
|
*/
|
|
181
186
|
resolvePermissions(user: UserPayload, scope?: Scope): Promise<EffectivePermissions>;
|
|
182
187
|
/**
|
|
@@ -198,7 +203,7 @@ export declare class AuthManager {
|
|
|
198
203
|
* `"global"`). Empty list ⇒ vacuously true. Intersected with the token's
|
|
199
204
|
* abilities like {@link hasPermission}.
|
|
200
205
|
*/
|
|
201
|
-
hasAllPermissions(user: UserPayload, permissions: string[], scope?: Scope): Promise<boolean>;
|
|
206
|
+
hasAllPermissions(user: UserPayload, permissions: readonly string[], scope?: Scope): Promise<boolean>;
|
|
202
207
|
/** Get a registered strategy by name. */
|
|
203
208
|
/**
|
|
204
209
|
* An {@link Authenticator} bound to one request (AdonisJS
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AuthManager.d.ts","sourceRoot":"","sources":["../src/AuthManager.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,OAAO,
|
|
1
|
+
{"version":3,"file":"AuthManager.d.ts","sourceRoot":"","sources":["../src/AuthManager.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEnD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,OAAO,EAEN,cAAc,EACd,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,oBAAoB,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAErE,OAAO,KAAK,EACX,iBAAiB,EACjB,YAAY,EACZ,MAAM,iCAAiC,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IAClC,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;IACtC,qEAAqE;IACrE,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC,+CAA+C;IAC/C,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAG1E;AAED,MAAM,WAAW,WAAW;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,wEAAwE;IACxE,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,uEAAuE;IACvE,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,UAAU;IAC1B,aAAa,EAAE,OAAO,CAAC;IACvB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC;CACrB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IAClC,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,iDAAiD;IACjD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,uBAAuB;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAGtE;AAED,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACxE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC9E;;;;OAIG;IACH,oBAAoB,CAAC,CACpB,GAAG,IAAI,EAAE,KAAK,EAAE,GACd,OAAO,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;CACpD;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,UAAU;IAC1B,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IACtC,mDAAmD;IACnD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kDAAkD;IAClD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC1C;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;CACxB;AAkBD;;GAEG;AACH;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC7B,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,OAAO,CAAC;CAC5C;AAED,qBAAa,WAAW;;IAcvB;;;OAGG;IACH,UAAU,CAAC,OAAO,EAAE,aAAa,GAAG,IAAI;IAKxC;;;;OAIG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;gBAkBxD,MAAM,EAAE,UAAU;IAoC9B,0EAA0E;IACpE,YAAY,CACjB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,YAAY,CAAC,EAAE,MAAM,GACnB,OAAO,CAAC,UAAU,CAAC;IAwBtB,8CAA8C;IACxC,MAAM,CACX,KAAK,EAAE,MAAM,EACb,YAAY,CAAC,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,UAAU,CAAC;IAoBtB;;;;;;;;;;;OAWG;IACH,QAAQ,CACP,IAAI,EAAE,WAAW,EACjB,YAAY,CAAC,EAAE,MAAM;IACrB,8DAA8D;IAC9D,OAAO,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,OAAO,CAAA;KAAE,GACzB,MAAM;IAcT;;;;;;;;;;OAUG;IACG,kBAAkB,CACvB,IAAI,EAAE,WAAW,EACjB,KAAK,GAAE,KAAgB,GACrB,OAAO,CAAC,oBAAoB,CAAC;IAIhC;;;;OAIG;IACG,OAAO,CACZ,IAAI,EAAE,WAAW,EACjB,IAAI,EAAE,MAAM,EACZ,KAAK,GAAE,KAAgB,GACrB,OAAO,CAAC,OAAO,CAAC;IAInB;;;;;;OAMG;IACG,aAAa,CAClB,IAAI,EAAE,WAAW,EACjB,UAAU,EAAE,MAAM,EAClB,KAAK,GAAE,KAAgB,GACrB,OAAO,CAAC,OAAO,CAAC;IAKnB;;;;OAIG;IACG,iBAAiB,CACtB,IAAI,EAAE,WAAW,EACjB,WAAW,EAAE,SAAS,MAAM,EAAE,EAC9B,KAAK,GAAE,KAAgB,GACrB,OAAO,CAAC,OAAO,CAAC;IAKnB,yCAAyC;IACzC;;;;;;;OAOG;IACH,mBAAmB,CAAC,GAAG,EAAE,aAAa,GAAG,aAAa;IAItD;;;;;;OAMG;IACH,yBAAyB,IAAI;QAC5B,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG;YACpB,oBAAoB,CACnB,GAAG,IAAI,EAAE,KAAK,EAAE,GACd,OAAO,CAAC,kBAAkB,CAAC,GAAG,kBAAkB,CAAC;SACpD,CAAC;KACF;IAmBD;;;;OAIG;IACH,cAAc,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM;IAQ1C,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,YAAY;IAexC;;;;OAIG;IACH,IAAI,mBAAmB,IAAI,MAAM,CAEhC;IAED,0CAA0C;IAC1C,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,GAAG,IAAI;IAI5D,yCAAyC;IACzC,gBAAgB,IAAI,MAAM,EAAE;IAI5B;;;;;;;;;OASG;IACG,KAAK,CACV,IAAI,EAAE,WAAW,EACjB,OAAO,EAAE,YAAY,EACrB,YAAY,CAAC,EAAE,MAAM,EACrB,KAAK,CAAC,EAAE,iBAAiB,GACvB,OAAO,CAAC,IAAI,CAAC;IAwBhB;;;;;;OAMG;IACG,8BAA8B,CACnC,WAAW,EAAE,OAAO,EACpB,YAAY,CAAC,EAAE,MAAM,EACrB,KAAK,CAAC,EAAE,iBAAiB,GACvB,OAAO,CAAC;QAAE,IAAI,EAAE,WAAW,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAoB7D;;;;OAIG;IACG,MAAM,CACX,OAAO,EAAE,YAAY,EACrB,YAAY,CAAC,EAAE,MAAM,EACrB,KAAK,CAAC,EAAE,iBAAiB,GACvB,OAAO,CAAC,IAAI,CAAC;CAehB;AAqDD,kEAAkE;AAClE;;;;;;GAMG"}
|
package/dist/AuthManager.js
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
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
11
|
/**
|
|
12
12
|
* Whether the token the user authenticated with, if any, allows `permission`.
|
|
@@ -128,13 +128,16 @@ export class AuthManager {
|
|
|
128
128
|
catch (err) {
|
|
129
129
|
// Re-throw structured WardenError sentinels (e.g. SessionStrategy's
|
|
130
130
|
// USE_LOGIN throw) so callers see the design-boundary signal instead
|
|
131
|
-
// of a soft `{ authenticated: false }`.
|
|
131
|
+
// of a soft `{ authenticated: false }`.
|
|
132
132
|
if (err instanceof WardenError)
|
|
133
133
|
throw err;
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
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 };
|
|
138
141
|
}
|
|
139
142
|
}
|
|
140
143
|
/** Verify a token (JWT, session, API key). */
|
|
@@ -189,9 +192,12 @@ export class AuthManager {
|
|
|
189
192
|
* Bouncer policy path (`this.permissions`, 56.3) consults the SAME resolver,
|
|
190
193
|
* so a coarse question and a policy question return the same answer for the
|
|
191
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.
|
|
192
198
|
*/
|
|
193
|
-
resolvePermissions(user, scope = "global") {
|
|
194
|
-
return this.#rights.resolve(user, scope);
|
|
199
|
+
async resolvePermissions(user, scope = "global") {
|
|
200
|
+
return narrowToAccessToken(await this.#rights.resolve(user, scope), user);
|
|
195
201
|
}
|
|
196
202
|
/**
|
|
197
203
|
* Check if a user has a specific role within a scope (default `"global"`).
|
|
@@ -338,7 +344,11 @@ export class AuthManager {
|
|
|
338
344
|
hint: "Remember-me is a session-guard feature. Configure `rememberMeTokens` on the guard, or implement authenticateViaRememberMeToken() on your own.",
|
|
339
345
|
});
|
|
340
346
|
}
|
|
341
|
-
|
|
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;
|
|
342
352
|
}
|
|
343
353
|
/**
|
|
344
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
|
*
|
|
@@ -148,16 +185,46 @@ export declare class Authenticator {
|
|
|
148
185
|
get authenticationAttempted(): boolean;
|
|
149
186
|
/** Name of the guard that authenticated the request, if any. */
|
|
150
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;
|
|
151
192
|
/**
|
|
152
193
|
* Roles of the authenticated user (Ream reads `ctx.auth.roles ??
|
|
153
194
|
* ctx.auth.user.roles`). Warden nests them under `user`; this getter mirrors
|
|
154
195
|
* them at the top level for the host's guard readers.
|
|
155
196
|
*/
|
|
156
197
|
get roles(): string[] | undefined;
|
|
157
|
-
/**
|
|
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
|
+
*/
|
|
158
203
|
get permissions(): string[] | undefined;
|
|
159
|
-
/**
|
|
160
|
-
|
|
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>;
|
|
161
228
|
/**
|
|
162
229
|
* Like {@link Authenticator.authenticate} but returns a boolean instead of
|
|
163
230
|
* throwing on a credential rejection. A strategy CRASH / config error still
|
|
@@ -184,11 +251,14 @@ export declare class Authenticator {
|
|
|
184
251
|
*/
|
|
185
252
|
authenticateUsing(guards?: string[], options?: {
|
|
186
253
|
loginRoute?: string;
|
|
187
|
-
}): Promise<
|
|
254
|
+
}): Promise<UserPayload>;
|
|
188
255
|
/** Return the authenticated user or throw `E_UNAUTHORIZED_ACCESS`. */
|
|
189
256
|
getUserOrFail(): UserPayload;
|
|
190
|
-
/**
|
|
191
|
-
|
|
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;
|
|
192
262
|
/**
|
|
193
263
|
* @internal Seed the Authenticator from a result the enforcing middleware
|
|
194
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"}
|