Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

fix(admin): guard account actions and occupied role names

Tin806afd91d0f5
diff --git a/apps/api/src/admin/controllers/delete-user.ts b/apps/api/src/admin/controllers/delete-user.ts
index 18c4453c7..79c35bfa4 100644
--- a/apps/api/src/admin/controllers/delete-user.ts
+++ b/apps/api/src/admin/controllers/delete-user.ts
@@ -6,6 +6,8 @@ import { userTable } from "../../database/schema";
import { ApiError } from "../../errors/api-error";
import { deleteUserSessions } from "../../sessions/delete-user-sessions";
import deleteAccountData from "../../user/controllers/delete-account-data";
+import { hasOtherInstanceAdmin } from "../../utils/has-other-instance-admin";
+import { hasInstanceAdminRole } from "../../utils/instance-admin-role";
import { revokeUserConnections } from "../../ws";
import type { AdminAuditRequest } from "../audit/admin-audit-request";
import { recordAdminAction } from "../audit/record-admin-action";
@@ -37,11 +39,17 @@ async function deleteUser(
"YOU_CANNOT_REMOVE_YOURSELF",
"You cannot remove yourself.",
);
- await lockAdminTargetUser(userId, db);
- await removeAccountData(userId);
-
await db.transaction(async (tx) => {
+ // Match role demotion's lock order, before locking the target user.
+ const otherAdminRemains = await hasOtherInstanceAdmin(tx);
const target = await lockAdminTargetUser(userId, tx);
+ if (hasInstanceAdminRole(target.role) && !otherAdminRemains) {
+ throw new ApiError(400, {
+ code: "CANNOT_REMOVE_LAST_ADMIN",
+ message: "The instance must have at least one administrator.",
+ });
+ }
+ await removeAccountData(userId);
await deleteUserSessions(tx, userId, { exceptSessionId: null });
await tx.delete(userTable).where(eq(userTable.id, userId));
await recordAdminAction(
diff --git a/apps/api/src/admin/controllers/reactivate-user.ts b/apps/api/src/admin/controllers/reactivate-user.ts
index 3536ff03f..f5c69c9e9 100644
--- a/apps/api/src/admin/controllers/reactivate-user.ts
+++ b/apps/api/src/admin/controllers/reactivate-user.ts
@@ -5,9 +5,20 @@ import type { AdminAuditRequest } from "../audit/admin-audit-request";
import { recordAdminAction } from "../audit/record-admin-action";
import { lockAdminTargetUser } from "../users/lock-admin-target-user";
import { readAdminUser } from "../users/read-admin-user";
+import { rejectSelfAction } from "../users/reject-self-action";
/** Let a deactivated user sign in again. */
-async function reactivateUser(userId: string, audit: AdminAuditRequest) {
+async function reactivateUser(
+ userId: string,
+ actorId: string,
+ audit: AdminAuditRequest,
+) {
+ rejectSelfAction(
+ actorId,
+ userId,
+ "YOU_CANNOT_UNBAN_YOURSELF",
+ "You cannot reactivate yourself.",
+ );
return db.transaction(async (tx) => {
const target = await lockAdminTargetUser(userId, tx);
if (target.banned) {
diff --git a/apps/api/src/admin/role-routes.ts b/apps/api/src/admin/role-routes.ts
index 4d3311ff1..a8649d69e 100644
--- a/apps/api/src/admin/role-routes.ts
+++ b/apps/api/src/admin/role-routes.ts
@@ -62,7 +62,7 @@ const createRoleRoute = createRoute({
201: jsonResponse("The new role", instanceRoleSchema),
400: errorResponse("Invalid name or permission"),
403: forbidden,
- 409: errorResponse("The name is taken or reserved"),
+ 409: errorResponse("The name is taken, reserved, or already held by users"),
},
});
@@ -84,7 +84,7 @@ const updateRoleRoute = createRoute({
400: errorResponse("Invalid name or permission"),
403: forbidden,
404: errorResponse("Role not found"),
- 409: errorResponse("The name is taken or reserved"),
+ 409: errorResponse("The name is taken, reserved, or already held by users"),
},
});
diff --git a/apps/api/src/admin/roles/assert-role-name-available.ts b/apps/api/src/admin/roles/assert-role-name-available.ts
index 7c13a858c..8e47f70c9 100644
--- a/apps/api/src/admin/roles/assert-role-name-available.ts
+++ b/apps/api/src/admin/roles/assert-role-name-available.ts
@@ -1,6 +1,6 @@
import { isBuiltInInstanceRole } from "@kaneo/permissions";
import { and, eq, ne, sql } from "drizzle-orm";
-import { instanceRoleTable } from "../../database/schema";
+import { instanceRoleTable, userTable } from "../../database/schema";
import { ApiError } from "../../errors/api-error";
import type { DbOrTx } from "../../project-access/db-or-tx";
@@ -36,4 +36,15 @@ export async function assertRoleNameAvailable(
message: "A role with this name already exists.",
});
}
+ const [assigned] = await tx
+ .select({ id: userTable.id })
+ .from(userTable)
+ .where(sql`${name} = ANY(string_to_array(${userTable.role}, ','))`)
+ .limit(1);
+ if (assigned) {
+ throw new ApiError(409, {
+ code: "ROLE_NAME_IN_USE",
+ message: "Users already have this role name. Change their role first.",
+ });
+ }
}
diff --git a/apps/api/src/admin/user-account-routes.ts b/apps/api/src/admin/user-account-routes.ts
index 3cff3d2bc..4b0c47c04 100644
--- a/apps/api/src/admin/user-account-routes.ts
+++ b/apps/api/src/admin/user-account-routes.ts
@@ -89,6 +89,7 @@ const reactivateUserRoute = createRoute({
request: { params: adminUserParam },
responses: {
200: jsonResponse("The reactivated user", adminUserSchema),
+ 400: errorResponse("You can't reactivate yourself"),
403: forbidden,
404: notFound,
},
@@ -110,7 +111,7 @@ const deleteUserRoute = createRoute({
request: { params: adminUserParam },
responses: {
200: jsonResponse("The deleted user", adminDeletedUserSchema),
- 400: errorResponse("You can't delete yourself"),
+ 400: errorResponse("You can't delete yourself or the last administrator"),
403: forbidden,
404: notFound,
409: errorResponse(
@@ -145,7 +146,11 @@ const adminUserAccountRoutes = apiRouter()
)
.openapi(reactivateUserRoute, async (c) =>
c.json(
- await reactivateUser(c.req.valid("param").userId, adminAuditRequest(c)),
+ await reactivateUser(
+ c.req.valid("param").userId,
+ c.get("userId"),
+ adminAuditRequest(c),
+ ),
200,
),
)
diff --git a/apps/docs/core/operations/administration.mdx b/apps/docs/core/operations/administration.mdx
index 3606bae9e..9a644f75e 100644
--- a/apps/docs/core/operations/administration.mdx
+++ b/apps/docs/core/operations/administration.mdx
@@ -29,6 +29,8 @@ From a user's menu you can:
Guest accounts have generated addresses, so password reset, verification email, and mark-verified actions are unavailable for them.
+You can't deactivate, reactivate, or delete yourself through user management. Deleting the last built-in administrator is blocked.
+
Emails need [SMTP](/core/installation/environment-variables#smtp-configuration) to be configured. Without it, Kaneo tells you nothing was sent.
If [the identity provider manages profile pictures](/core/social-providers/custom-oauth#managed-profile-fields), you can't replace a user's picture, and you can only remove one they uploaded in Kaneo.
@@ -79,6 +81,8 @@ Kaneo has two built-in roles: **Admin** has every permission and **User** has no
Give someone a role from **Edit** in the user directory. Each person has one role. Each row on the Roles page shows how many people have that role; select the count to see them. Renaming a role keeps it on everyone who has it, and permission changes apply to their next request. A role can only be deleted once nobody has it.
+Creating or renaming a role to a name already stored on users is blocked. Change those users' roles first so they don't gain permissions without an assignment.
+
Custom roles only grant these administration permissions. Built-in admins can also open every workspace, and some powers stay with them alone: managing roles, editing project access from the workspace page, and creating workspaces when `DISABLE_WORKSPACE_CREATION` is set.
Kaneo keeps custom roles from being used to gain more power:
diff --git a/apps/docs/openapi.json b/apps/docs/openapi.json
index ed0cad937..3dbf67d0b 100644
--- a/apps/docs/openapi.json
+++ b/apps/docs/openapi.json
@@ -27279,7 +27279,7 @@
}
},
"400": {
- "description": "You can't delete yourself",
+ "description": "You can't delete yourself or the last administrator",
"content": {
"application/json": {
"schema": {
@@ -27440,6 +27440,16 @@
}
}
},
+ "400": {
+ "description": "You can't reactivate yourself",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ApiError"
+ }
+ }
+ }
+ },
"401": {
"description": "Missing or invalid credentials",
"content": {
@@ -27616,7 +27626,7 @@
}
},
"409": {
- "description": "The name is taken or reserved",
+ "description": "The name is taken, reserved, or already held by users",
"content": {
"application/json": {
"schema": {
@@ -27749,7 +27759,7 @@
}
},
"409": {
- "description": "The name is taken or reserved",
+ "description": "The name is taken, reserved, or already held by users",
"content": {
"application/json": {
"schema": {
diff --git a/tests/api-integration/admin-instance-roles.test.ts b/tests/api-integration/admin-instance-roles.test.ts
index e35379998..84d3783bb 100644
--- a/tests/api-integration/admin-instance-roles.test.ts
+++ b/tests/api-integration/admin-instance-roles.test.ts
@@ -152,6 +152,36 @@ describe("custom instance roles", () => {
expect(await ids("admin")).toEqual([admin.userId]);
});
+ it.each(["create", "rename"])(
+ "rejects %s of a role name already held by users",
+ async (operation) => {
+ const { app } = createApp();
+ const admin = await signInWithRole(app, "admin");
+ const stale = await insertUser("user,legacy-support");
+ const role = await insertInstanceRole("support", []);
+ const assigned = await insertUser("support");
+
+ const response = await admin.api(
+ operation === "create" ? "/roles" : `/roles/${role.id}`,
+ {
+ method: operation === "create" ? "POST" : "PUT",
+ body: { name: "legacy-support", permissions: ["users:read"] },
+ },
+ );
+
+ expect(response.status).toBe(409);
+ expect(await readErrorBody(response)).toMatchObject({
+ code: "ROLE_NAME_IN_USE",
+ message: "Users already have this role name. Change their role first.",
+ });
+ expect(await roleOf(stale.id)).toBe("user,legacy-support");
+ expect(await roleOf(assigned.id)).toBe("support");
+ const roles = await db.select().from(schema.instanceRoleTable);
+ expect(roles).toMatchObject([{ name: "support", permissions: [] }]);
+ expect(await readAuditLog()).toEqual([]);
+ },
+ );
+
it("grant only their permissions through the access endpoint", async () => {
const { app } = createApp();
await insertInstanceRole("auditor", ["audit:read", "system:read"]);
diff --git a/tests/api-integration/admin-user-account-guards.test.ts b/tests/api-integration/admin-user-account-guards.test.ts
new file mode 100644
index 000000000..df54d88d8
--- /dev/null
+++ b/tests/api-integration/admin-user-account-guards.test.ts
@@ -0,0 +1,79 @@
+import { eq, inArray } from "drizzle-orm";
+import { beforeEach, describe, expect, it } from "vite-plus/test";
+import deleteUser from "../../apps/api/src/admin/controllers/delete-user";
+import db, { schema } from "../../apps/api/src/database";
+import { createApp } from "../../apps/api/src/index";
+import { signInWithRole } from "./helpers/admin/instance-roles";
+import { readAuditLog } from "./helpers/admin/read-audit-log";
+import { resetTestDatabase } from "./helpers/database";
+import { readErrorBody } from "./helpers/error-body";
+import { createWorkspaceMember } from "./helpers/fixtures";
+
+beforeEach(resetTestDatabase);
+
+describe("admin account guards", () => {
+ it("keeps one administrator and their workspace during concurrent deletions", async () => {
+ const first = await createWorkspaceMember({ role: "owner" });
+ const second = await createWorkspaceMember({ role: "owner" });
+ const ids = [first.user.id, second.user.id];
+ await db
+ .update(schema.userTable)
+ .set({ role: "user,admin" })
+ .where(inArray(schema.userTable.id, ids));
+
+ // Both requests have already passed authorization before either deletion.
+ const results = await Promise.allSettled(
+ [first, second].map((target, index) => {
+ const actorId = ids[1 - index];
+ return deleteUser(target.user.id, actorId, {
+ actorUserId: actorId,
+ ipAddress: null,
+ userAgent: null,
+ });
+ }),
+ );
+
+ expect(
+ results.filter((result) => result.status === "fulfilled"),
+ ).toHaveLength(1);
+ expect(
+ results.find((result) => result.status === "rejected"),
+ ).toMatchObject({
+ reason: { status: 400, code: "CANNOT_REMOVE_LAST_ADMIN" },
+ });
+ const remaining = await db.select().from(schema.userTable);
+ expect(remaining).toHaveLength(1);
+ expect(remaining[0].role).toBe("user,admin");
+ const kept = [first, second].find(
+ (target) => target.user.id === remaining[0].id,
+ );
+ expect(kept).toBeDefined();
+ const workspaces = await db.select().from(schema.workspaceTable);
+ expect(workspaces.map((workspace) => workspace.id)).toEqual([
+ kept?.workspace.id,
+ ]);
+ expect((await readAuditLog()).map((entry) => entry.action)).toEqual([
+ "user.deleted",
+ ]);
+ });
+
+ it("rejects self-reactivation without changing the account or audit log", async () => {
+ const { app } = createApp();
+ const admin = await signInWithRole(app, "admin");
+
+ const response = await admin.api(`/users/${admin.userId}/reactivate`, {
+ method: "POST",
+ });
+
+ expect(response.status).toBe(400);
+ expect(await readErrorBody(response)).toMatchObject({
+ code: "YOU_CANNOT_UNBAN_YOURSELF",
+ });
+ const [user] = await db
+ .select({ banned: schema.userTable.banned })
+ .from(schema.userTable)
+ .where(eq(schema.userTable.id, admin.userId));
+ expect(user.banned).toBe(false);
+ expect(await readAuditLog()).toEqual([]);
+ });
+});