@baseplate-dev/plugin-auth 0.6.17 → 0.6.18

package/dist/local-auth/core/generators/auth-module/templates/module/services/code-verification.service.ts

@@ -0,0 +1,184 @@
+// @ts-nocheck
+
+import type { AuthVerification, Prisma } from '%prismaGeneratedImports';
+
+import { safeCompare } from '$servicesAuthVerification';
+import { getConfig } from '%configServiceImports';
+import { prisma } from '%prismaImports';
+import * as crypto from 'node:crypto';
+
+/**
+ * Short code verifications, for flows that email a handful of digits rather
+ * than a link.
+ *
+ * These share the `AuthVerification` table with the split-token flows in
+ * {@link ./auth-verification.service.js} but not their security model: the
+ * secret is short enough to guess, so it is keyed rather than hashed, carries
+ * its own attempt budget, and is addressed by a caller-supplied identifier
+ * instead of a random selector.
+ */
+
+/**
+ * Derives the stored value for a short code.
+ *
+ * Short codes occupy a keyspace small enough to invert a plain digest by
+ * exhaustive search, so they are keyed with the server secret rather than
+ * hashed: an attacker holding only the database cannot recover them. The type
+ * and identifier are mixed in so a stored value is valid solely for the flow
+ * and address it was issued for.
+ */
+function hashCode({
+  type,
+  identifier,
+  code,
+}: {
+  type: string;
+  identifier: string;
+  code: string;
+}): string {
+  return crypto
+    .createHmac('sha256', getConfig().AUTH_SECRET)
+    .update(`${type}:${identifier}:${code}`)
+    .digest('hex');
+}
+
+/**
+ * Creates or replaces a short code verification (e.g. an emailed OTP).
+ *
+ * The identifier is caller-supplied (typically an email) rather than a random
+ * selector, so the code cannot be folded into a single token the way a
+ * split-token flow does. Only one code may be outstanding per
+ * `type`/`identifier` pair, so requesting a new one replaces any existing code
+ * and resets the attempt counter.
+ *
+ * The identifier rather than a user reference is the subject here, since a
+ * code may be issued for an address that has no account yet.
+ *
+ * The returned id identifies this particular issuance, so a caller that binds
+ * it to the requester (e.g. in a cookie) can tell one request apart from the
+ * next. It is regenerated on every call for that reason: reusing it would let
+ * whoever requested an earlier code redeem a later one requested by someone
+ * else.
+ *
+ * @param code - The plaintext code sent to the user; only its hash is stored
+ */
+export async function createCodeVerification({
+  type,
+  identifier,
+  code,
+  expiresInSec,
+}: {
+  type: string;
+  identifier: string;
+  code: string;
+  expiresInSec: number;
+}): Promise<{ id: string }> {
+  const value = hashCode({ type, identifier, code });
+  const expiresAt = new Date(Date.now() + expiresInSec * 1000);
+  const id = crypto.randomUUID();
+
+  await prisma.authVerification.upsert({
+    where: { type_identifier: { type, identifier } },
+    create: {
+      id,
+      type,
+      identifier,
+      value,
+      expiresAt,
+    },
+    // Resetting `attempts` is what gives the replacement code a fresh budget;
+    // without it a reissued code would inherit the old code's failed guesses.
+    update: {
+      id,
+      value,
+      attempts: 0,
+      expiresAt,
+    },
+    select: { id: true },
+  });
+
+  return { id };
+}
+
+/**
+ * Validates a short code verification without consuming it, so the caller can
+ * gather any further input it needs before committing.
+ *
+ * Security: a short numeric code has far less entropy than a random token, so
+ * each code carries its own attempt counter alongside the endpoint rate limits.
+ * The record is deleted when the code has expired or the attempt budget is
+ * exhausted. Pass the returned record to {@link consumeCodeVerification} to
+ * complete the flow.
+ *
+ * Both cleanup paths delete by filter rather than by primary key: simultaneous
+ * callers can each decide the record should go, and only one of them removes a
+ * row. A keyed delete would raise on the others instead of returning null.
+ */
+export async function validateCodeVerification({
+  type,
+  identifier,
+  code,
+  maxAttempts,
+}: {
+  type: string;
+  identifier: string;
+  code: string;
+  maxAttempts: number;
+}): Promise<AuthVerification | null> {
+  const record = await prisma.authVerification.findUnique({
+    where: { type_identifier: { type, identifier } },
+  });
+
+  if (!record) {
+    return null;
+  }
+
+  if (record.expiresAt < new Date()) {
+    await prisma.authVerification.deleteMany({ where: { id: record.id } });
+    return null;
+  }
+
+  if (safeCompare(record.value, hashCode({ type, identifier, code }))) {
+    return record;
+  }
+
+  // Incremented in the database rather than read-modify-written here, so
+  // simultaneous guesses each cost a point instead of sharing one.
+  const { attempts } = await prisma.authVerification.update({
+    where: { id: record.id },
+    data: { attempts: { increment: 1 } },
+    select: { attempts: true },
+  });
+
+  if (attempts >= maxAttempts) {
+    await prisma.authVerification.deleteMany({ where: { id: record.id } });
+  }
+
+  return null;
+}
+
+/**
+ * Consumes a previously validated verification, returning whether this call is
+ * the one that claimed it.
+ *
+ * The conditional delete is the authorization step: concurrent requests
+ * carrying the same code race here, and only the request that removes the row
+ * may proceed. Reading the row and deleting it in separate statements would
+ * let both win.
+ *
+ * @param client - Transaction client, so consuming the code can be committed
+ * together with whatever the code authorized rather than ahead of it
+ */
+export async function consumeCodeVerification({
+  id,
+  client = prisma,
+}: {
+  id: string;
+  client?: Prisma.TransactionClient;
+}): Promise<boolean> {
+  const { count } = await client.authVerification.deleteMany({
+    where: { id },
+  });
+
+  return count === 1;
+}

package/dist/local-auth/core/generators/auth-routes/auth-routes.generator.d.ts

@@ -3,6 +3,8 @@
  */
 export declare const authRoutesGenerator: import("@baseplate-dev/sync").GeneratorBundleCreator<{
     requireNameOnRegistration: boolean;
+    emailOtp?: boolean | undefined;
+    disableRegistration?: boolean | undefined;
 }, {
     paths: import("@baseplate-dev/sync").GeneratorTask<{
         authCoreAuthRoutesPaths: import("@baseplate-dev/sync").ProviderExport<import("./generated/template-paths.js").AuthCoreAuthRoutesPaths>;
@@ -144,6 +146,12 @@ export declare const authRoutesGenerator: import("@baseplate-dev/sync").Generato
             InputGroupInput: {};
             InputGroupText: {};
             InputGroupTextarea: {};
+            InputOtp: {};
+            InputOtpField: {};
+            InputOtpFieldController: {};
+            InputOtpGroup: {};
+            InputOtpSeparator: {};
+            InputOtpSlot: {};
             inputVariants: {};
             Item: {};
             ItemActions: {};

package/dist/local-auth/core/generators/auth-routes/auth-routes.generator.js

@@ -4,6 +4,8 @@ import { z } from 'zod';
 import { AUTH_CORE_AUTH_ROUTES_GENERATED as GENERATED_TEMPLATES } from './generated/index.js';
 const descriptorSchema = z.object({
     requireNameOnRegistration: z.boolean(),
+    emailOtp: z.boolean().default(false),
+    disableRegistration: z.boolean().default(false),
 });
 /**
  * Generator for auth routes for logging in and registering
@@ -12,7 +14,7 @@ export const authRoutesGenerator = createGenerator({
     name: 'auth/core/auth-routes',
     generatorFileUrl: import.meta.url,
     descriptorSchema,
-    buildTasks: ({ requireNameOnRegistration }) => ({
+    buildTasks: ({ requireNameOnRegistration, emailOtp, disableRegistration, }) => ({
         paths: GENERATED_TEMPLATES.paths.task,
         renderers: GENERATED_TEMPLATES.renderers.task,
         main: createGeneratorTask({
@@ -39,7 +41,39 @@ export const authRoutesGenerator = createGenerator({
                     build: async (builder) => {
                         await builder.apply(renderers.mainGroup.render({
                             variables: {
-                                register: {
+                                login: {
+                                    TPL_OTP_LOGIN_LINK: emailOtp
+                                        ? `<Link
+              to="/auth/login-otp"
+              search={{ return_to }}
+              className="text-muted-foreground underline-offset-4 hover:underline"
+            >
+              Sign in with a code instead
+            </Link>`
+                                        : '',
+                                    TPL_REGISTER_LINK: disableRegistration
+                                        ? ''
+                                        : `<div>
+              Don&apos;t have an account?{' '}
+              <Link
+                to="/auth/register"
+                className="underline underline-offset-4"
+              >
+                Sign up
+              </Link>
+            </div>`,
+                                },
+                            },
+                        }));
+                        await builder.apply(renderers.verifyEmail.render({}));
+                        await builder.apply(renderers.acceptInvite.render({}));
+                        if (emailOtp) {
+                            await builder.apply(renderers.otpConstants.render({}));
+                            await builder.apply(renderers.loginOtp.render({}));
+                        }
+                        if (!disableRegistration) {
+                            await builder.apply(renderers.register.render({
+                                variables: {
                                     TPL_REGISTER_SCHEMA: registerSchema,
                                     TPL_REGISTER_INPUT: registerInput,
                                     TPL_NAME_FORM_CONTROL: requireNameOnRegistration
@@ -53,9 +87,8 @@ export const authRoutesGenerator = createGenerator({
             />`
                                         : '',
                                 },
-                            },
-                        }));
-                        await builder.apply(renderers.verifyEmail.render({}));
+                            }));
+                        }
                     },
                 };
             },