@c9up/warden 0.2.3 → 0.2.4
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 +5 -3
- package/dist/AttemptStore.d.ts +64 -0
- package/dist/AttemptStore.d.ts.map +1 -0
- package/dist/AttemptStore.js +117 -0
- package/dist/AttemptStore.js.map +1 -0
- package/dist/AuthManager.d.ts +5 -3
- package/dist/AuthManager.d.ts.map +1 -1
- package/dist/AuthManager.js +5 -4
- package/dist/AuthManager.js.map +1 -1
- package/dist/AuthRateLimiter.d.ts +44 -10
- package/dist/AuthRateLimiter.d.ts.map +1 -1
- package/dist/AuthRateLimiter.js +58 -73
- package/dist/AuthRateLimiter.js.map +1 -1
- package/dist/Authenticator.d.ts +8 -11
- package/dist/Authenticator.d.ts.map +1 -1
- package/dist/Authenticator.js +72 -9
- package/dist/Authenticator.js.map +1 -1
- package/dist/RememberMeToken.d.ts +15 -4
- package/dist/RememberMeToken.d.ts.map +1 -1
- package/dist/RememberMeToken.js +20 -7
- package/dist/RememberMeToken.js.map +1 -1
- package/dist/bouncer/evaluate.d.ts +0 -8
- package/dist/bouncer/evaluate.d.ts.map +1 -1
- package/dist/bouncer/evaluate.js +1 -1
- package/dist/bouncer/evaluate.js.map +1 -1
- package/dist/duration.d.ts.map +1 -1
- package/dist/duration.js +6 -0
- package/dist/duration.js.map +1 -1
- package/dist/errors.d.ts +6 -0
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +6 -0
- package/dist/errors.js.map +1 -1
- package/dist/index.d.ts +8 -6
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -1
- package/dist/index.js.map +1 -1
- package/dist/mfa/BackupCodesProvider.d.ts +8 -1
- package/dist/mfa/BackupCodesProvider.d.ts.map +1 -1
- package/dist/mfa/BackupCodesProvider.js +5 -7
- package/dist/mfa/BackupCodesProvider.js.map +1 -1
- package/dist/mfa/MfaManager.d.ts +18 -2
- package/dist/mfa/MfaManager.d.ts.map +1 -1
- package/dist/mfa/MfaManager.js +38 -35
- package/dist/mfa/MfaManager.js.map +1 -1
- package/dist/mfa/TotpProvider.d.ts +30 -6
- package/dist/mfa/TotpProvider.d.ts.map +1 -1
- package/dist/mfa/TotpProvider.js +48 -19
- package/dist/mfa/TotpProvider.js.map +1 -1
- package/dist/mfa/WebauthnProvider.d.ts.map +1 -1
- package/dist/mfa/WebauthnProvider.js +4 -1
- package/dist/mfa/WebauthnProvider.js.map +1 -1
- package/dist/middleware.d.ts +2 -0
- package/dist/middleware.d.ts.map +1 -1
- package/dist/middleware.js +3 -0
- package/dist/middleware.js.map +1 -1
- package/dist/native/generated.d.ts +0 -5
- package/dist/native/generated.d.ts.map +1 -1
- package/dist/native.d.ts +0 -2
- package/dist/native.d.ts.map +1 -1
- package/dist/native.js +0 -4
- package/dist/native.js.map +1 -1
- package/dist/strategies/JwtStrategy.d.ts +11 -1
- package/dist/strategies/JwtStrategy.d.ts.map +1 -1
- package/dist/strategies/JwtStrategy.js +9 -2
- package/dist/strategies/JwtStrategy.js.map +1 -1
- package/dist/strategies/SessionStrategy.d.ts +22 -0
- package/dist/strategies/SessionStrategy.d.ts.map +1 -1
- package/dist/strategies/SessionStrategy.js +31 -1
- package/dist/strategies/SessionStrategy.js.map +1 -1
- package/dist/vendor/nodeEnv.d.ts +5 -0
- package/dist/vendor/nodeEnv.d.ts.map +1 -0
- package/dist/vendor/nodeEnv.js +38 -0
- package/dist/vendor/nodeEnv.js.map +1 -0
- 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 +1 -1
- package/src/AttemptStore.ts +158 -0
- package/src/AuthManager.ts +9 -7
- package/src/AuthRateLimiter.ts +85 -80
- package/src/Authenticator.ts +92 -13
- package/src/RememberMeToken.ts +36 -8
- package/src/bouncer/evaluate.ts +1 -1
- package/src/duration.ts +8 -0
- package/src/errors.ts +11 -1
- package/src/index.ts +24 -3
- package/src/mfa/BackupCodesProvider.ts +13 -14
- package/src/mfa/MfaManager.ts +58 -43
- package/src/mfa/TotpProvider.ts +90 -22
- package/src/mfa/WebauthnProvider.ts +4 -1
- package/src/middleware.ts +9 -0
- package/src/native/generated.ts +0 -14
- package/src/native.ts +0 -5
- package/src/strategies/JwtStrategy.ts +20 -2
- package/src/strategies/SessionStrategy.ts +52 -1
- package/src/vendor/nodeEnv.ts +37 -0
|
@@ -60,6 +60,21 @@ export interface SessionStrategyConfig {
|
|
|
60
60
|
* default matches the `web` guard an app is most likely migrating.
|
|
61
61
|
*/
|
|
62
62
|
rememberMeCookieName?: string;
|
|
63
|
+
/**
|
|
64
|
+
* Attributes of the remember-me cookie, over the defaults: `path: "/"`,
|
|
65
|
+
* `sameSite: "lax"`, and `secure` in production. The cookie is a bearer
|
|
66
|
+
* credential that lives for years, so it never leaves over plain HTTP or
|
|
67
|
+
* rides a cross-site POST unless the app says so here.
|
|
68
|
+
*/
|
|
69
|
+
rememberMeCookie?: RememberMeCookieAttributes;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
/** What an app may set on the remember-me cookie. */
|
|
73
|
+
export interface RememberMeCookieAttributes {
|
|
74
|
+
path?: string;
|
|
75
|
+
domain?: string;
|
|
76
|
+
sameSite?: "lax" | "strict" | "none" | false;
|
|
77
|
+
secure?: boolean;
|
|
63
78
|
}
|
|
64
79
|
|
|
65
80
|
/** Two years, Adonis' `rememberMeTokensAge` default. */
|
|
@@ -102,6 +117,15 @@ export class SessionStrategy implements AuthStrategy {
|
|
|
102
117
|
#sessionKey: string;
|
|
103
118
|
|
|
104
119
|
constructor(config: SessionStrategyConfig) {
|
|
120
|
+
// A NaN age made every token's expiry NaN, which no "is it past?" test
|
|
121
|
+
// ever caught: the token never expired.
|
|
122
|
+
const age = config.rememberMeAge;
|
|
123
|
+
if (age !== undefined && (!Number.isSafeInteger(age) || age <= 0)) {
|
|
124
|
+
throw new WardenError(
|
|
125
|
+
"INVALID_CONFIG",
|
|
126
|
+
`rememberMeAge must be a positive whole number of seconds, got ${String(age)}`,
|
|
127
|
+
);
|
|
128
|
+
}
|
|
105
129
|
this.#config = config;
|
|
106
130
|
this.#sessionKey = config.sessionKey ?? "auth_user_id";
|
|
107
131
|
}
|
|
@@ -111,6 +135,11 @@ export class SessionStrategy implements AuthStrategy {
|
|
|
111
135
|
return this.#config.rememberMeCookieName ?? "remember_web";
|
|
112
136
|
}
|
|
113
137
|
|
|
138
|
+
/** The remember-me cookie's attributes the app configured, if any. */
|
|
139
|
+
get rememberMeCookie(): RememberMeCookieAttributes | undefined {
|
|
140
|
+
return this.#config.rememberMeCookie;
|
|
141
|
+
}
|
|
142
|
+
|
|
114
143
|
/** Whether "keep me signed in" is wired at all. */
|
|
115
144
|
get usesRememberMeTokens(): boolean {
|
|
116
145
|
return this.#config.rememberMeTokens !== undefined;
|
|
@@ -230,7 +259,12 @@ export class SessionStrategy implements AuthStrategy {
|
|
|
230
259
|
return { authenticated: false, error: "Invalid session data" };
|
|
231
260
|
const user = await this.#config.findUser(userId);
|
|
232
261
|
if (!user) return { authenticated: false, error: "User not found" };
|
|
233
|
-
|
|
262
|
+
// `mfa` is this SESSION's step-up, whatever `findUser` said (see
|
|
263
|
+
// markMfaVerified).
|
|
264
|
+
return {
|
|
265
|
+
authenticated: true,
|
|
266
|
+
user: { ...user, mfa: context.session.get(this.#mfaKey()) === true },
|
|
267
|
+
};
|
|
234
268
|
}
|
|
235
269
|
|
|
236
270
|
/**
|
|
@@ -254,6 +288,22 @@ export class SessionStrategy implements AuthStrategy {
|
|
|
254
288
|
seatSession(user: UserPayload, session: SessionStore): void {
|
|
255
289
|
session.regenerate();
|
|
256
290
|
session.put(this.#sessionKey, user.id);
|
|
291
|
+
// A new sign-in has not stepped up yet, whatever the session held before.
|
|
292
|
+
session.forget(this.#mfaKey());
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
/**
|
|
296
|
+
* Record that this session completed an MFA step-up (`MfaManager.verify()`
|
|
297
|
+
* succeeded), which `@RequireMfa()` requires. Cleared by the next sign-in
|
|
298
|
+
* and by logout.
|
|
299
|
+
*/
|
|
300
|
+
markMfaVerified(session: SessionStore): void {
|
|
301
|
+
session.put(this.#mfaKey(), true);
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
/** The session key of the step-up marker, beside the user id's. */
|
|
305
|
+
#mfaKey(): string {
|
|
306
|
+
return `${this.#sessionKey}_mfa`;
|
|
257
307
|
}
|
|
258
308
|
|
|
259
309
|
async login(
|
|
@@ -294,6 +344,7 @@ export class SessionStrategy implements AuthStrategy {
|
|
|
294
344
|
state?: SessionGuardState,
|
|
295
345
|
): Promise<void> {
|
|
296
346
|
session.forget(this.#sessionKey);
|
|
347
|
+
session.forget(this.#mfaKey());
|
|
297
348
|
if (state) {
|
|
298
349
|
state.viaRemember = false;
|
|
299
350
|
state.attemptedViaRemember = false;
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
// Generated from scripts/vendor/nodeEnv.ts — do not edit.
|
|
2
|
+
//
|
|
3
|
+
// This package is published and built from its own repository, so the file
|
|
4
|
+
// has to exist here rather than be imported. `pnpm vendor:sync` rewrites it,
|
|
5
|
+
// and `pnpm vendor:check` fails if this copy has drifted from the original.
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* `NODE_ENV`, read the way every runtime actually spells it.
|
|
9
|
+
*
|
|
10
|
+
* `NODE_ENV=prod` is ordinary in a Dockerfile or a platform dashboard, and a
|
|
11
|
+
* bare `=== "production"` answers "not production" for it. What that costs
|
|
12
|
+
* differs per package, so the consequence is stated where the decision is
|
|
13
|
+
* taken, not here.
|
|
14
|
+
*
|
|
15
|
+
* The tables mirror the framework's (`@c9up/ream`, src/env/nodeEnv.ts), which
|
|
16
|
+
* is the origin rather than a peer: it formats to different rules and exposes
|
|
17
|
+
* `currentNodeEnv()` instead of `inProduction()`.
|
|
18
|
+
*/
|
|
19
|
+
|
|
20
|
+
const DEV_ENVS = ["dev", "develop", "development"];
|
|
21
|
+
const PROD_ENVS = ["prod", "production"];
|
|
22
|
+
const TEST_ENVS = ["test", "testing"];
|
|
23
|
+
|
|
24
|
+
/** The canonical name for whatever `NODE_ENV` holds. */
|
|
25
|
+
export function normalizeNodeEnv(value: string | undefined): string {
|
|
26
|
+
if (!value || typeof value !== "string") return "unknown";
|
|
27
|
+
const env = value.toLowerCase();
|
|
28
|
+
if (DEV_ENVS.includes(env)) return "development";
|
|
29
|
+
if (PROD_ENVS.includes(env)) return "production";
|
|
30
|
+
if (TEST_ENVS.includes(env)) return "test";
|
|
31
|
+
return env;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/** Whether this process is running in production, under any spelling. */
|
|
35
|
+
export function inProduction(): boolean {
|
|
36
|
+
return normalizeNodeEnv(process.env.NODE_ENV) === "production";
|
|
37
|
+
}
|