mirror of
https://github.com/ajnart/homarr.git
synced 2026-02-27 17:00:54 +01:00
408cdeb5c3
* feat: add integration access settings * fix: typecheck and test issues * fix: test timeout * chore: address pull request feedback * chore: add throw if action forbidden for integration permissions * fix: unable to create new migrations because of duplicate prevId in sqlite snapshots * chore: add sqlite migration for integration permissions * test: add unit tests for integration access * test: add permission checks to integration router tests * test: add unit test for integration permissions * chore: add mysql migration * fix: format issues
103 lines
4.2 KiB
TypeScript
103 lines
4.2 KiB
TypeScript
import { objectEntries, objectKeys } from "@homarr/common";
|
|
|
|
/**
|
|
* Permissions for boards.
|
|
* view: Can view the board and its content. (e.g. see all items on the board, but not modify them)
|
|
* modify: Can modify the board, its content and visual settings. (e.g. move items, change the background)
|
|
* full: Can modify the board, its content, visual settings, access settings, delete, change the visibility and rename. (e.g. change the board name, delete the board, give access to other users)
|
|
*/
|
|
export const boardPermissions = ["view", "modify", "full"] as const;
|
|
export const boardPermissionsMap = {
|
|
view: "board-view-all",
|
|
modify: "board-modify-all",
|
|
full: "board-full-all",
|
|
} satisfies Record<BoardPermission, GroupPermissionKey>;
|
|
|
|
export type BoardPermission = (typeof boardPermissions)[number];
|
|
|
|
/**
|
|
* Permissions for integrations.
|
|
* use: Can select the integration for an item on the board. (e.g. select pi-hole for a widget)
|
|
* interact: Can interact with the integration. (e.g. enable / disable pi-hole)
|
|
* full: Can modify the integration. (e.g. change the pi-hole url, secrets and access settings)
|
|
*/
|
|
export const integrationPermissions = ["use", "interact", "full"] as const;
|
|
export const integrationPermissionsMap = {
|
|
use: "integration-use-all",
|
|
interact: "integration-interact-all",
|
|
full: "integration-full-all",
|
|
} satisfies Record<IntegrationPermission, GroupPermissionKey>;
|
|
|
|
export type IntegrationPermission = (typeof integrationPermissions)[number];
|
|
|
|
/**
|
|
* Global permissions that can be assigned to groups.
|
|
* The keys are generated through combining the key and all array items.
|
|
* For example "board-create" is a generated key
|
|
*/
|
|
export const groupPermissions = {
|
|
board: ["create", "view-all", "modify-all", "full-all"],
|
|
integration: ["create", "use-all", "interact-all", "full-all"],
|
|
admin: true,
|
|
} as const;
|
|
|
|
/**
|
|
* In the following object is described how the permissions are related to each other.
|
|
* For example everybody with the permission "board-modify-all" also has the permission "board-view-all".
|
|
* Or admin has all permissions (board-full-all and integration-full-all which will resolve in an array of every permission).
|
|
*/
|
|
const groupPermissionParents = {
|
|
"board-modify-all": ["board-view-all"],
|
|
"board-full-all": ["board-modify-all", "board-create"],
|
|
"integration-interact-all": ["integration-use-all"],
|
|
"integration-full-all": ["integration-interact-all", "integration-create"],
|
|
admin: ["board-full-all", "integration-full-all"],
|
|
} satisfies Partial<Record<GroupPermissionKey, GroupPermissionKey[]>>;
|
|
|
|
export const getPermissionsWithParents = (permissions: GroupPermissionKey[]): GroupPermissionKey[] => {
|
|
const res = permissions.map((permission) => {
|
|
return objectEntries(groupPermissionParents)
|
|
.filter(([_key, value]: [string, GroupPermissionKey[]]) => value.includes(permission))
|
|
.map(([key]) => getPermissionsWithParents([key]))
|
|
.flat();
|
|
});
|
|
|
|
return permissions.concat(res.flat());
|
|
};
|
|
|
|
const getPermissionsInner = (permissionSet: Set<GroupPermissionKey>, permissions: GroupPermissionKey[]) => {
|
|
permissions.forEach((permission) => {
|
|
const children = groupPermissionParents[permission as keyof typeof groupPermissionParents];
|
|
// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
|
|
if (children) {
|
|
getPermissionsInner(permissionSet, children);
|
|
}
|
|
|
|
permissionSet.add(permission);
|
|
});
|
|
};
|
|
|
|
export const getPermissionsWithChildren = (permissions: GroupPermissionKey[]) => {
|
|
const permissionSet = new Set<GroupPermissionKey>();
|
|
getPermissionsInner(permissionSet, permissions);
|
|
return Array.from(permissionSet);
|
|
};
|
|
|
|
type GroupPermissions = typeof groupPermissions;
|
|
|
|
export type GroupPermissionKey = {
|
|
[key in keyof GroupPermissions]: GroupPermissions[key] extends readonly string[]
|
|
? `${key}-${GroupPermissions[key][number]}`
|
|
: key;
|
|
}[keyof GroupPermissions];
|
|
|
|
export const groupPermissionKeys = objectKeys(groupPermissions).reduce((acc, key) => {
|
|
const item = groupPermissions[key];
|
|
if (typeof item !== "boolean") {
|
|
acc.push(...item.map((subKey) => `${key}-${subKey}` as GroupPermissionKey));
|
|
} else {
|
|
acc.push(key as GroupPermissionKey);
|
|
}
|
|
return acc;
|
|
}, [] as GroupPermissionKey[]);
|