@revealui/auth 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. package/README.md +58 -34
  2. package/dist/index.d.ts.map +1 -1
  3. package/dist/react/index.d.ts +4 -0
  4. package/dist/react/index.d.ts.map +1 -1
  5. package/dist/react/index.js +2 -0
  6. package/dist/react/useMFA.d.ts +83 -0
  7. package/dist/react/useMFA.d.ts.map +1 -0
  8. package/dist/react/useMFA.js +182 -0
  9. package/dist/react/usePasskey.d.ts +88 -0
  10. package/dist/react/usePasskey.d.ts.map +1 -0
  11. package/dist/react/usePasskey.js +203 -0
  12. package/dist/react/useSession.d.ts.map +1 -1
  13. package/dist/react/useSession.js +16 -5
  14. package/dist/react/useSignIn.d.ts +9 -3
  15. package/dist/react/useSignIn.d.ts.map +1 -1
  16. package/dist/react/useSignIn.js +32 -10
  17. package/dist/react/useSignOut.d.ts.map +1 -1
  18. package/dist/react/useSignUp.d.ts +1 -0
  19. package/dist/react/useSignUp.d.ts.map +1 -1
  20. package/dist/react/useSignUp.js +25 -9
  21. package/dist/server/auth.d.ts +2 -0
  22. package/dist/server/auth.d.ts.map +1 -1
  23. package/dist/server/auth.js +93 -5
  24. package/dist/server/brute-force.d.ts +10 -1
  25. package/dist/server/brute-force.d.ts.map +1 -1
  26. package/dist/server/brute-force.js +46 -23
  27. package/dist/server/errors.d.ts +4 -0
  28. package/dist/server/errors.d.ts.map +1 -1
  29. package/dist/server/errors.js +8 -0
  30. package/dist/server/index.d.ts +17 -6
  31. package/dist/server/index.d.ts.map +1 -1
  32. package/dist/server/index.js +12 -5
  33. package/dist/server/magic-link.d.ts +52 -0
  34. package/dist/server/magic-link.d.ts.map +1 -0
  35. package/dist/server/magic-link.js +111 -0
  36. package/dist/server/mfa.d.ts +87 -0
  37. package/dist/server/mfa.d.ts.map +1 -0
  38. package/dist/server/mfa.js +263 -0
  39. package/dist/server/oauth.d.ts +86 -0
  40. package/dist/server/oauth.d.ts.map +1 -0
  41. package/dist/server/oauth.js +355 -0
  42. package/dist/server/passkey.d.ts +132 -0
  43. package/dist/server/passkey.d.ts.map +1 -0
  44. package/dist/server/passkey.js +257 -0
  45. package/dist/server/password-reset.d.ts +32 -6
  46. package/dist/server/password-reset.d.ts.map +1 -1
  47. package/dist/server/password-reset.js +116 -47
  48. package/dist/server/password-validation.d.ts.map +1 -1
  49. package/dist/server/providers/github.d.ts +14 -0
  50. package/dist/server/providers/github.d.ts.map +1 -0
  51. package/dist/server/providers/github.js +89 -0
  52. package/dist/server/providers/google.d.ts +11 -0
  53. package/dist/server/providers/google.d.ts.map +1 -0
  54. package/dist/server/providers/google.js +69 -0
  55. package/dist/server/providers/vercel.d.ts +11 -0
  56. package/dist/server/providers/vercel.d.ts.map +1 -0
  57. package/dist/server/providers/vercel.js +63 -0
  58. package/dist/server/rate-limit.d.ts +10 -1
  59. package/dist/server/rate-limit.d.ts.map +1 -1
  60. package/dist/server/rate-limit.js +61 -43
  61. package/dist/server/session.d.ts +48 -1
  62. package/dist/server/session.d.ts.map +1 -1
  63. package/dist/server/session.js +126 -7
  64. package/dist/server/signed-cookie.d.ts +32 -0
  65. package/dist/server/signed-cookie.d.ts.map +1 -0
  66. package/dist/server/signed-cookie.js +67 -0
  67. package/dist/server/storage/database.d.ts +10 -1
  68. package/dist/server/storage/database.d.ts.map +1 -1
  69. package/dist/server/storage/database.js +43 -5
  70. package/dist/server/storage/in-memory.d.ts +4 -0
  71. package/dist/server/storage/in-memory.d.ts.map +1 -1
  72. package/dist/server/storage/in-memory.js +16 -6
  73. package/dist/server/storage/index.d.ts +11 -3
  74. package/dist/server/storage/index.d.ts.map +1 -1
  75. package/dist/server/storage/index.js +18 -4
  76. package/dist/server/storage/interface.d.ts +11 -1
  77. package/dist/server/storage/interface.d.ts.map +1 -1
  78. package/dist/server/storage/interface.js +1 -1
  79. package/dist/types.d.ts +23 -8
  80. package/dist/types.d.ts.map +1 -1
  81. package/dist/types.js +2 -2
  82. package/dist/utils/database.d.ts.map +1 -1
  83. package/dist/utils/database.js +12 -2
  84. package/dist/utils/token.d.ts +9 -1
  85. package/dist/utils/token.d.ts.map +1 -1
  86. package/dist/utils/token.js +9 -1
  87. package/package.json +26 -8
@@ -0,0 +1,263 @@
1
+ /**
2
+ * MFA/2FA — TOTP-based Multi-Factor Authentication
3
+ *
4
+ * Uses the timing-safe TOTP implementation from @revealui/core/security/auth.
5
+ * Backup codes are bcrypt-hashed for storage (one-time use, consumed on verify).
6
+ */
7
+ import { randomBytes } from 'node:crypto';
8
+ import { TwoFactorAuth } from '@revealui/core/security';
9
+ import { getClient } from '@revealui/db/client';
10
+ import { users } from '@revealui/db/schema';
11
+ import bcrypt from 'bcryptjs';
12
+ import { eq } from 'drizzle-orm';
13
+ const DEFAULT_MFA_CONFIG = {
14
+ backupCodeCount: 8,
15
+ backupCodeLength: 5,
16
+ issuer: 'RevealUI',
17
+ };
18
+ let config = { ...DEFAULT_MFA_CONFIG };
19
+ export function configureMFA(overrides) {
20
+ config = { ...DEFAULT_MFA_CONFIG, ...overrides };
21
+ }
22
+ export function resetMFAConfig() {
23
+ config = { ...DEFAULT_MFA_CONFIG };
24
+ }
25
+ // =============================================================================
26
+ // Backup Code Generation
27
+ // =============================================================================
28
+ /**
29
+ * Generate a set of plaintext backup codes.
30
+ * Returns both the plaintext codes (to show the user once) and bcrypt hashes (to store).
31
+ */
32
+ async function generateBackupCodes() {
33
+ const plaintext = [];
34
+ const hashed = [];
35
+ for (let i = 0; i < config.backupCodeCount; i++) {
36
+ const code = randomBytes(config.backupCodeLength).toString('hex');
37
+ plaintext.push(code);
38
+ hashed.push(await bcrypt.hash(code, 10));
39
+ }
40
+ return { plaintext, hashed };
41
+ }
42
+ // =============================================================================
43
+ // TOTP Provisioning URI
44
+ // =============================================================================
45
+ /**
46
+ * Build an otpauth:// URI for QR code generation in authenticator apps.
47
+ */
48
+ function buildProvisioningUri(secret, email) {
49
+ const issuer = encodeURIComponent(config.issuer);
50
+ const account = encodeURIComponent(email);
51
+ return `otpauth://totp/${issuer}:${account}?secret=${secret}&issuer=${issuer}&algorithm=SHA1&digits=6&period=30`;
52
+ }
53
+ /**
54
+ * Initiate MFA setup for a user.
55
+ * Generates a TOTP secret and backup codes. The user must verify with a TOTP
56
+ * code before MFA is activated (see `verifyMFASetup`).
57
+ */
58
+ export async function initiateMFASetup(userId, email) {
59
+ const db = getClient();
60
+ // Check if MFA is already enabled
61
+ const [user] = await db
62
+ .select({ mfaEnabled: users.mfaEnabled })
63
+ .from(users)
64
+ .where(eq(users.id, userId))
65
+ .limit(1);
66
+ if (!user) {
67
+ return { success: false, error: 'User not found' };
68
+ }
69
+ if (user.mfaEnabled) {
70
+ return { success: false, error: 'MFA is already enabled' };
71
+ }
72
+ // Generate TOTP secret and backup codes
73
+ const secret = TwoFactorAuth.generateSecret();
74
+ const { plaintext, hashed } = await generateBackupCodes();
75
+ const uri = buildProvisioningUri(secret, email);
76
+ // Store secret and backup codes (MFA stays disabled until verified)
77
+ await db
78
+ .update(users)
79
+ .set({
80
+ mfaSecret: secret,
81
+ mfaBackupCodes: hashed,
82
+ updatedAt: new Date(),
83
+ })
84
+ .where(eq(users.id, userId));
85
+ return {
86
+ success: true,
87
+ secret,
88
+ uri,
89
+ backupCodes: plaintext,
90
+ };
91
+ }
92
+ /**
93
+ * Verify MFA setup by confirming the user's authenticator app works.
94
+ * This activates MFA on the account.
95
+ */
96
+ export async function verifyMFASetup(userId, code) {
97
+ const db = getClient();
98
+ const [user] = await db
99
+ .select({ mfaSecret: users.mfaSecret, mfaEnabled: users.mfaEnabled })
100
+ .from(users)
101
+ .where(eq(users.id, userId))
102
+ .limit(1);
103
+ if (!user) {
104
+ return { success: false, error: 'User not found' };
105
+ }
106
+ if (user.mfaEnabled) {
107
+ return { success: false, error: 'MFA is already enabled' };
108
+ }
109
+ if (!user.mfaSecret) {
110
+ return { success: false, error: 'MFA setup not initiated' };
111
+ }
112
+ // Verify the TOTP code against the stored secret
113
+ const valid = TwoFactorAuth.verifyCode(user.mfaSecret, code);
114
+ if (!valid) {
115
+ return { success: false, error: 'Invalid verification code' };
116
+ }
117
+ // Activate MFA
118
+ await db
119
+ .update(users)
120
+ .set({
121
+ mfaEnabled: true,
122
+ mfaVerifiedAt: new Date(),
123
+ updatedAt: new Date(),
124
+ })
125
+ .where(eq(users.id, userId));
126
+ return { success: true };
127
+ }
128
+ /**
129
+ * Verify a TOTP code during login (step 2 of MFA login flow).
130
+ */
131
+ export async function verifyMFACode(userId, code) {
132
+ const db = getClient();
133
+ const [user] = await db
134
+ .select({ mfaSecret: users.mfaSecret, mfaEnabled: users.mfaEnabled })
135
+ .from(users)
136
+ .where(eq(users.id, userId))
137
+ .limit(1);
138
+ if (!(user?.mfaEnabled && user.mfaSecret)) {
139
+ return { success: false, error: 'MFA not enabled' };
140
+ }
141
+ const valid = TwoFactorAuth.verifyCode(user.mfaSecret, code);
142
+ if (!valid) {
143
+ return { success: false, error: 'Invalid code' };
144
+ }
145
+ return { success: true };
146
+ }
147
+ /**
148
+ * Verify a backup code (one-time use). Consumes the code on success.
149
+ */
150
+ export async function verifyBackupCode(userId, code) {
151
+ const db = getClient();
152
+ const [user] = await db
153
+ .select({ mfaBackupCodes: users.mfaBackupCodes, mfaEnabled: users.mfaEnabled })
154
+ .from(users)
155
+ .where(eq(users.id, userId))
156
+ .limit(1);
157
+ if (!user?.mfaEnabled) {
158
+ return { success: false, error: 'MFA not enabled' };
159
+ }
160
+ const storedCodes = (user.mfaBackupCodes ?? []);
161
+ if (storedCodes.length === 0) {
162
+ return { success: false, error: 'No backup codes available' };
163
+ }
164
+ // Find and consume the matching backup code
165
+ for (let i = 0; i < storedCodes.length; i++) {
166
+ const storedCode = storedCodes[i];
167
+ if (!storedCode)
168
+ continue;
169
+ const matches = await bcrypt.compare(code, storedCode);
170
+ if (matches) {
171
+ // Remove the consumed code
172
+ const remaining = [...storedCodes.slice(0, i), ...storedCodes.slice(i + 1)];
173
+ await db
174
+ .update(users)
175
+ .set({
176
+ mfaBackupCodes: remaining,
177
+ updatedAt: new Date(),
178
+ })
179
+ .where(eq(users.id, userId));
180
+ return { success: true, remainingCodes: remaining.length };
181
+ }
182
+ }
183
+ return { success: false, error: 'Invalid backup code' };
184
+ }
185
+ /**
186
+ * Regenerate backup codes (requires active MFA).
187
+ */
188
+ export async function regenerateBackupCodes(userId) {
189
+ const db = getClient();
190
+ const [user] = await db
191
+ .select({ mfaEnabled: users.mfaEnabled })
192
+ .from(users)
193
+ .where(eq(users.id, userId))
194
+ .limit(1);
195
+ if (!user?.mfaEnabled) {
196
+ return { success: false, error: 'MFA not enabled' };
197
+ }
198
+ const { plaintext, hashed } = await generateBackupCodes();
199
+ await db
200
+ .update(users)
201
+ .set({
202
+ mfaBackupCodes: hashed,
203
+ updatedAt: new Date(),
204
+ })
205
+ .where(eq(users.id, userId));
206
+ return { success: true, backupCodes: plaintext };
207
+ }
208
+ /**
209
+ * Disable MFA on a user account. Requires re-authentication proof.
210
+ */
211
+ export async function disableMFA(userId, proof) {
212
+ const db = getClient();
213
+ const [user] = await db
214
+ .select({
215
+ mfaEnabled: users.mfaEnabled,
216
+ password: users.password,
217
+ })
218
+ .from(users)
219
+ .where(eq(users.id, userId))
220
+ .limit(1);
221
+ if (!user) {
222
+ return { success: false, error: 'User not found' };
223
+ }
224
+ if (!user.mfaEnabled) {
225
+ return { success: false, error: 'MFA is not enabled' };
226
+ }
227
+ // Verify re-authentication proof
228
+ if (proof.method === 'password') {
229
+ if (!user.password) {
230
+ return { success: false, error: 'Password verification required' };
231
+ }
232
+ const passwordValid = await bcrypt.compare(proof.password, user.password);
233
+ if (!passwordValid) {
234
+ return { success: false, error: 'Invalid password' };
235
+ }
236
+ }
237
+ // For passkey proof, the API route has already performed the WebAuthn assertion —
238
+ // the `verified: true` flag is trusted as a server-side signal.
239
+ // Clear all MFA data
240
+ await db
241
+ .update(users)
242
+ .set({
243
+ mfaEnabled: false,
244
+ mfaSecret: null,
245
+ mfaBackupCodes: null,
246
+ mfaVerifiedAt: null,
247
+ updatedAt: new Date(),
248
+ })
249
+ .where(eq(users.id, userId));
250
+ return { success: true };
251
+ }
252
+ /**
253
+ * Check if a user has MFA enabled.
254
+ */
255
+ export async function isMFAEnabled(userId) {
256
+ const db = getClient();
257
+ const [user] = await db
258
+ .select({ mfaEnabled: users.mfaEnabled })
259
+ .from(users)
260
+ .where(eq(users.id, userId))
261
+ .limit(1);
262
+ return user?.mfaEnabled ?? false;
263
+ }
@@ -0,0 +1,86 @@
1
+ /**
2
+ * OAuth Core — State Management + User Upsert
3
+ *
4
+ * CSRF state: signed cookie using HMAC-SHA256 over a base64url payload.
5
+ * Provider dispatch: routes to Google / GitHub / Vercel provider modules.
6
+ * User upsert: links OAuth identities to local users via oauth_accounts table.
7
+ */
8
+ import type { User } from '../types.js';
9
+ export interface ProviderUser {
10
+ id: string;
11
+ email: string | null;
12
+ name: string;
13
+ avatarUrl: string | null;
14
+ }
15
+ /**
16
+ * Generate a signed OAuth state token.
17
+ *
18
+ * State encodes provider + redirectTo + nonce as base64url JSON.
19
+ * Cookie value is `<state>.<hmac>` — the HMAC is over the state string
20
+ * using REVEALUI_SECRET, providing CSRF protection without a DB table.
21
+ */
22
+ export declare function generateOAuthState(provider: string, redirectTo: string): {
23
+ state: string;
24
+ cookieValue: string;
25
+ };
26
+ /**
27
+ * Verify a signed OAuth state token from the callback.
28
+ *
29
+ * Returns the decoded provider + redirectTo if valid, null otherwise.
30
+ */
31
+ export declare function verifyOAuthState(state: string | null | undefined, cookieValue: string | null | undefined): {
32
+ provider: string;
33
+ redirectTo: string;
34
+ } | null;
35
+ export declare function buildAuthUrl(provider: string, redirectUri: string, state: string): string;
36
+ export declare function exchangeCode(provider: string, code: string, redirectUri: string): Promise<string>;
37
+ export declare function fetchProviderUser(provider: string, accessToken: string): Promise<ProviderUser>;
38
+ /**
39
+ * Find or create a local user for the given OAuth identity.
40
+ *
41
+ * Flow:
42
+ * 1. Look up oauth_accounts by (provider, providerUserId) → get userId
43
+ * 2. If found: refresh metadata + return user
44
+ * 3. If not found: check users by email → link if match
45
+ * 4. If no match: create new user (role: 'admin', no password)
46
+ * 5. Insert oauth_accounts row
47
+ */
48
+ export declare function upsertOAuthUser(provider: string, providerUser: ProviderUser): Promise<User>;
49
+ /**
50
+ * Link an OAuth provider to an existing authenticated user.
51
+ *
52
+ * Unlike upsertOAuthUser(), this function requires the caller to be
53
+ * authenticated and explicitly requests the link. This is safe because
54
+ * the user has already proven ownership of the local account via their
55
+ * session.
56
+ *
57
+ * @param userId - The authenticated user's ID (from session)
58
+ * @param provider - OAuth provider name
59
+ * @param providerUser - Profile returned by the OAuth provider
60
+ * @returns The linked user
61
+ * @throws Error if the provider account is already linked to a different user
62
+ */
63
+ export declare function linkOAuthAccount(userId: string, provider: string, providerUser: ProviderUser): Promise<User>;
64
+ /**
65
+ * Unlink an OAuth provider from a user's account.
66
+ *
67
+ * Safety: refuses to unlink the last auth method (if user has no password
68
+ * and this is their only OAuth link, unlinking would lock them out).
69
+ *
70
+ * @param userId - The authenticated user's ID
71
+ * @param provider - The provider to unlink
72
+ * @throws Error if unlinking would leave the user with no authentication method
73
+ */
74
+ export declare function unlinkOAuthAccount(userId: string, provider: string): Promise<void>;
75
+ /**
76
+ * Get all linked OAuth providers for a user.
77
+ *
78
+ * @param userId - The user's ID
79
+ * @returns Array of linked provider info (provider name, email, avatar)
80
+ */
81
+ export declare function getLinkedProviders(userId: string): Promise<Array<{
82
+ provider: string;
83
+ providerEmail: string | null;
84
+ providerName: string | null;
85
+ }>>;
86
+ //# sourceMappingURL=oauth.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"oauth.d.ts","sourceRoot":"","sources":["../../src/server/oauth.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAOH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAMxC,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAMD;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,GACjB;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAaxC;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAChC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GACrC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAgDjD;AAwBD,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CASzF;AAED,wBAAsB,YAAY,CAChC,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC,CAQjB;AAED,wBAAsB,iBAAiB,CACrC,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC,YAAY,CAAC,CAQvB;AAMD;;;;;;;;;GASG;AACH,wBAAsB,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CA6FjG;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,IAAI,CAAC,CAiEf;AAED;;;;;;;;;GASG;AACH,wBAAsB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAsCxF;AAED;;;;;GAKG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,KAAK,CAAC;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC,CAAC,CAajG"}