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.

feat(permissions): add the instance permission vocabulary

Tina7097f75d5f8
diff --git a/apps/api/src/utils/require-instance-admin.ts b/apps/api/src/utils/require-instance-admin.ts
deleted file mode 100644
index bd5898965..000000000
--- a/apps/api/src/utils/require-instance-admin.ts
+++ /dev/null
@@ -1,12 +0,0 @@
-import type { Context, Next } from "hono";
-import { HTTPException } from "hono/http-exception";
-import { isInstanceAdmin } from "./is-instance-admin";
-
-export async function requireInstanceAdmin(c: Context, next: Next) {
- if (!(await isInstanceAdmin(c))) {
- throw new HTTPException(403, {
- message: "Instance administrator access is required",
- });
- }
- return next();
-}
diff --git a/packages/permissions/src/index.ts b/packages/permissions/src/index.ts
index c589a047b..2a69fbfa3 100644
--- a/packages/permissions/src/index.ts
+++ b/packages/permissions/src/index.ts
@@ -88,3 +88,17 @@ export {
type WorkspaceCapability,
workspaceCapabilities,
} from "./capabilities.js";
+
+export {
+ BUILT_IN_INSTANCE_ROLES,
+ type BuiltInInstanceRole,
+ CUSTOM_ROLE_PERMISSIONS,
+ type CustomRolePermission,
+ INSTANCE_PERMISSIONS,
+ INSTANCE_ROLE_NAME_PATTERN,
+ type InstancePermission,
+ isBuiltInInstanceRole,
+ isCustomRolePermission,
+ isInstancePermission,
+ parseInstanceRoles,
+} from "./instance.js";
diff --git a/packages/permissions/src/instance.test.ts b/packages/permissions/src/instance.test.ts
new file mode 100644
index 000000000..89f5308bd
--- /dev/null
+++ b/packages/permissions/src/instance.test.ts
@@ -0,0 +1,36 @@
+import { describe, expect, it } from "vite-plus/test";
+import {
+ CUSTOM_ROLE_PERMISSIONS,
+ INSTANCE_ROLE_NAME_PATTERN,
+ isCustomRolePermission,
+ parseInstanceRoles,
+} from "./instance";
+
+describe("instance permissions", () => {
+ it("keeps role management out of custom roles", () => {
+ expect(CUSTOM_ROLE_PERMISSIONS).not.toContain("roles:manage");
+ expect(isCustomRolePermission("roles:manage")).toBe(false);
+ expect(isCustomRolePermission("users:read")).toBe(true);
+ });
+
+ it("parses comma-separated role lists", () => {
+ expect(parseInstanceRoles("user,support,,admin")).toEqual([
+ "user",
+ "support",
+ "admin",
+ ]);
+ expect(parseInstanceRoles("user, admin")).toEqual(["user", " admin"]);
+ expect(parseInstanceRoles(null)).toEqual([]);
+ });
+
+ it.each(["support", "help-desk", "ops2"])("accepts the name %s", (name) => {
+ expect(INSTANCE_ROLE_NAME_PATTERN.test(name)).toBe(true);
+ });
+
+ it.each(["a", "Support", "2ops", "help desk", "a,b", "-x"])(
+ "rejects the name %s",
+ (name) => {
+ expect(INSTANCE_ROLE_NAME_PATTERN.test(name)).toBe(false);
+ },
+ );
+});
diff --git a/packages/permissions/src/instance.ts b/packages/permissions/src/instance.ts
new file mode 100644
index 000000000..967ae782c
--- /dev/null
+++ b/packages/permissions/src/instance.ts
@@ -0,0 +1,64 @@
+// Instance-wide administration permissions. A user's `role` column holds a
+// comma-separated list of instance roles: the built-in `admin` (everything)
+// and `user` (nothing), plus custom roles stored by the API.
+export const INSTANCE_PERMISSIONS = [
+ "users:read",
+ "users:create",
+ "users:update",
+ "users:disable",
+ "users:delete",
+ "users:credentials",
+ "users:sessions",
+ "users:api_keys",
+ "workspaces:read",
+ "workspaces:manage",
+ "workspaces:archive",
+ "workspaces:delete",
+ "audit:read",
+ "system:read",
+ "instance:settings",
+ "roles:manage",
+] as const;
+
+export type InstancePermission = (typeof INSTANCE_PERMISSIONS)[number];
+
+export type CustomRolePermission = Exclude<InstancePermission, "roles:manage">;
+
+/** Only the built-in admin role may manage roles; custom roles cannot. */
+export const CUSTOM_ROLE_PERMISSIONS = INSTANCE_PERMISSIONS.filter(
+ (permission): permission is CustomRolePermission =>
+ permission !== "roles:manage",
+);
+
+export const BUILT_IN_INSTANCE_ROLES = ["admin", "user"] as const;
+
+export type BuiltInInstanceRole = (typeof BUILT_IN_INSTANCE_ROLES)[number];
+
+/** Custom role names are lowercase slugs so they fit a comma-separated list. */
+export const INSTANCE_ROLE_NAME_PATTERN = /^[a-z][a-z0-9-]{1,31}$/;
+
+export function isInstancePermission(
+ value: unknown,
+): value is InstancePermission {
+ return (INSTANCE_PERMISSIONS as readonly unknown[]).includes(value);
+}
+
+export function isCustomRolePermission(
+ value: unknown,
+): value is CustomRolePermission {
+ return (CUSTOM_ROLE_PERMISSIONS as readonly unknown[]).includes(value);
+}
+
+export function isBuiltInInstanceRole(
+ value: unknown,
+): value is BuiltInInstanceRole {
+ return (BUILT_IN_INSTANCE_ROLES as readonly unknown[]).includes(value);
+}
+
+/**
+ * The role names in a user's `role` column. Like better-auth and the API's
+ * SQL checks, names are not trimmed: " admin" is not the admin role.
+ */
+export function parseInstanceRoles(role: string | null | undefined) {
+ return (role ?? "").split(",").filter(Boolean);
+}