Skip to content

A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search

fix: sanitize user names before storing them (#2724)

Mohamed Bassem6109588fe12d
diff --git a/apps/web/server/auth.ts b/apps/web/server/auth.ts
index 52c5e9b3..6681cc0f 100644
--- a/apps/web/server/auth.ts
+++ b/apps/web/server/auth.ts
@@ -18,6 +18,10 @@ import {
verificationTokens,
} from "@karakeep/db/schema";
import serverConfig from "@karakeep/shared/config";
+import {
+ containsUnsafeUserNameMarkup,
+ normalizeUserNameInput,
+} from "@karakeep/shared/utils/userName";
import { validatePassword } from "@karakeep/trpc/auth";
import { User } from "@karakeep/trpc/models/users";
@@ -71,6 +75,15 @@ async function isAdmin(email: string): Promise<boolean> {
return res?.role == "admin";
}
+const DEFAULT_DISPLAY_NAME = "User";
+
+function normalizeSafeDisplayName(name: string | null | undefined): string {
+ const normalizedName = normalizeUserNameInput(name ?? "");
+ return !containsUnsafeUserNameMarkup(name ?? "") && normalizedName
+ ? normalizedName
+ : DEFAULT_DISPLAY_NAME;
+}
+
const CustomProvider = (): Adapter => {
const adapter = DrizzleAdapter(db, {
usersTable: users,
@@ -83,7 +96,7 @@ const CustomProvider = (): Adapter => {
...adapter,
createUser: async (user: Omit<AdapterUser, "id">) => {
return await User.createRaw(db, {
- name: user.name ?? "",
+ name: normalizeSafeDisplayName(user.name),
email: user.email,
emailVerified: user.emailVerified,
});
@@ -137,9 +150,10 @@ if (oauth.wellKnownUrl) {
isAdmin(profile.email),
isFirstUser(),
]);
+
return {
id: profile.sub,
- name: profile.name || profile.email,
+ name: normalizeSafeDisplayName(profile.name),
email: profile.email,
role: admin || firstUser ? "admin" : "user",
};
diff --git a/packages/shared/types/users.ts b/packages/shared/types/users.ts
index df4697f0..1ee5a281 100644
--- a/packages/shared/types/users.ts
+++ b/packages/shared/types/users.ts
@@ -1,5 +1,9 @@
import { z } from "zod";
+import {
+ containsUnsafeUserNameMarkup,
+ normalizeUserNameInput,
+} from "../utils/userName";
import { zBookmarkSourceSchema } from "./bookmarks";
export const PASSWORD_MIN_LENGTH = 8;
@@ -16,9 +20,17 @@ export const zTagStyleSchema = z.enum([
]);
export type ZTagStyle = z.infer<typeof zTagStyleSchema>;
+export const zUserNameSchema = z
+ .string()
+ .refine((value) => !containsUnsafeUserNameMarkup(value), {
+ message: "Name contains invalid characters",
+ })
+ .transform(normalizeUserNameInput)
+ .pipe(z.string().min(1, { message: "Name can't be empty" }));
+
export const zSignUpSchema = z
.object({
- name: z.string().min(1, { message: "Name can't be empty" }),
+ name: zUserNameSchema,
email: z.string().email(),
password: z.string().min(PASSWORD_MIN_LENGTH).max(PASSWORD_MAX_LENGTH),
confirmPassword: z.string(),
diff --git a/packages/shared/utils/userName.ts b/packages/shared/utils/userName.ts
new file mode 100644
index 00000000..38f29eda
--- /dev/null
+++ b/packages/shared/utils/userName.ts
@@ -0,0 +1,7 @@
+export function normalizeUserNameInput(input: string): string {
+ return input.trim();
+}
+
+export function containsUnsafeUserNameMarkup(input: string): boolean {
+ return /[<>]/.test(input);
+}
diff --git a/packages/trpc/models/users.ts b/packages/trpc/models/users.ts
index b77c3a19..e91c2ef9 100644
--- a/packages/trpc/models/users.ts
+++ b/packages/trpc/models/users.ts
@@ -78,7 +78,7 @@ export class User {
try {
await sendVerificationEmail(
input.email,
- input.name,
+ user.name,
token,
input.redirectUrl,
);
diff --git a/packages/trpc/routers/invites.test.ts b/packages/trpc/routers/invites.test.ts
index 5cadbc14..29d3891b 100644
--- a/packages/trpc/routers/invites.test.ts
+++ b/packages/trpc/routers/invites.test.ts
@@ -370,6 +370,36 @@ describe("Invites Router", () => {
expect(result.name).toBe("New User");
});
+ test<CustomTestContext>("invite accept rejects raw html in name", async ({
+ db,
+ unauthedAPICaller,
+ }) => {
+ const admin = await unauthedAPICaller.users.create({
+ name: "Admin User",
+ email: "[email protected]",
+ password: "pass1234",
+ confirmPassword: "pass1234",
+ });
+
+ const adminCaller = getApiCaller(db, admin.id, admin.email, "admin");
+
+ const invite = await adminCaller.invites.create({
+ email: "[email protected]",
+ });
+
+ const dbInvite = await db.query.invites.findFirst({
+ where: eq(invites.id, invite.id),
+ });
+
+ await expect(() =>
+ unauthedAPICaller.invites.accept({
+ token: dbInvite!.token,
+ name: "<b>Invited</b> <User>",
+ password: "newpass123",
+ }),
+ ).rejects.toThrow(/Name contains invalid characters/);
+ });
+
test<CustomTestContext>("cannot accept used invite (deleted)", async ({
db,
unauthedAPICaller,
diff --git a/packages/trpc/routers/invites.ts b/packages/trpc/routers/invites.ts
index 026ee4a2..94b8fc35 100644
--- a/packages/trpc/routers/invites.ts
+++ b/packages/trpc/routers/invites.ts
@@ -4,6 +4,7 @@ import { eq } from "drizzle-orm";
import { z } from "zod";
import { invites, users } from "@karakeep/db/schema";
+import { zUserNameSchema } from "@karakeep/shared/types/users";
import { generatePasswordSalt, hashPassword } from "../auth";
import { sendInviteEmail } from "../email";
@@ -158,7 +159,7 @@ export const invitesAppRouter = router({
.input(
z.object({
token: z.string(),
- name: z.string().min(1),
+ name: zUserNameSchema,
password: z.string().min(8),
}),
)
diff --git a/packages/trpc/routers/users.test.ts b/packages/trpc/routers/users.test.ts
index d8ec90f9..2aa82f83 100644
--- a/packages/trpc/routers/users.test.ts
+++ b/packages/trpc/routers/users.test.ts
@@ -60,6 +60,32 @@ describe("User Routes", () => {
expect(user.email).toEqual("[email protected]");
});
+ test<CustomTestContext>("create user trims surrounding whitespace in name", async ({
+ unauthedAPICaller,
+ }) => {
+ const user = await unauthedAPICaller.users.create({
+ name: " Test \n User ",
+ email: "[email protected]",
+ password: "pass1234",
+ confirmPassword: "pass1234",
+ });
+
+ expect(user.name).toEqual("Test \n User");
+ });
+
+ test<CustomTestContext>("create user rejects raw html in name", async ({
+ unauthedAPICaller,
+ }) => {
+ await expect(() =>
+ unauthedAPICaller.users.create({
+ name: "<script>alert('xss')</script>",
+ email: "[email protected]",
+ password: "pass1234",
+ confirmPassword: "pass1234",
+ }),
+ ).rejects.toThrow(/Name contains invalid characters/);
+ });
+
test<CustomTestContext>("first user is admin", async ({
unauthedAPICaller,
}) => {