mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-04-05 15:27:20 +02:00
* fix: Resolve custom role permissions not loading in frontend Users assigned to custom roles (non-USER/ADMIN) had all permission checks fail because AuthContext only fetched system role permissions. The roles map keyed by USER/ADMIN never contained the custom role name, so useHasAccess returned false for every feature gate. - Fetch the user's custom role in AuthContext and include it in the roles map so useHasAccess can resolve permissions correctly - Use encodeURIComponent instead of toLowerCase for role name URLs to preserve custom role casing through the API roundtrip - Only uppercase system role names on the backend GET route; pass custom role names through as-is for exact DB lookup - Allow users to fetch their own assigned role without READ_ROLES capability * refactor: Normalize all role names to uppercase Custom role names were stored in original casing, causing case-sensitivity bugs across the stack — URL lowercasing, route uppercasing, and case-sensitive DB lookups all conflicted for mixed-case custom roles. Enforce uppercase normalization at every boundary: - createRoleByName trims and uppercases the name before storage - createRoleHandler uppercases before passing to createRoleByName - All admin route handlers (get, update, delete, members, permissions) uppercase the :name URL param before DB lookups - addRoleMemberHandler uppercases before setting user.role - Startup migration (normalizeRoleNames) finds non-uppercase custom roles, renames them, and updates affected user.role values with collision detection Legacy GET /api/roles/:roleName retains always-uppercase behavior. Tests updated to expect uppercase role names throughout. * fix: Use case-preserved role names with strict equality Remove uppercase normalization — custom role names are stored and compared exactly as the user sets them, with only trimming applied. USER and ADMIN remain reserved case-insensitively via isSystemRoleName. - Remove toUpperCase from createRoleByName, createRoleHandler, and all admin route handlers (get, update, delete, members, permissions) - Remove toUpperCase from legacy GET and PUT routes in roles.js; the frontend now sends exact casing via encodeURIComponent - Remove normalizeRoleNames startup migration - Revert test expectations to original casing * fix: Format useMemo dependency array for Prettier * feat: Add custom role support to admin settings + review fixes - Add backend tests for isOwnRole authorization gate on GET /api/roles/:roleName - Add frontend tests for custom role detection and fetching in AuthContext - Fix transient null permission flash by only spreading custom role once loaded - Add isSystemRoleName helper to data-provider for case-insensitive system role detection - Use sentinel value in useGetRole to avoid ghost cache entry from empty string - Add useListRoles hook and listRoles data service for fetching all roles - Update AdminSettingsDialog and PeoplePickerAdminSettings to dynamically list custom roles in the role dropdown, with proper fallback defaults * fix: Address review findings for custom role permissions - Add assertions to AuthContext test verifying custom role in roles map - Fix empty array bypassing nullish coalescing fallback in role dropdowns - Add null/undefined guard to isSystemRoleName helper - Memoize role dropdown items to avoid unnecessary re-renders - Apply sentinel pattern to useGetRole in admin settings for consistency - Mark ListRolesResponse description as required to match schema * fix: Prevent prototype pollution in role authorization gate - Replace roleDefaults[roleName] with Object.hasOwn to prevent prototype chain bypass for names like constructor or __proto__ - Add dedicated rolesList query key to avoid cache collision when a custom role is named 'list' - Add regression test for prototype property name authorization * fix: Resolve Prettier formatting and unused variable lint errors * fix: Address review findings for custom role permissions - Add ADMIN self-read test documenting isOwnRole bypass behavior - Guard save button while custom role data loads to prevent data loss - Extract useRoleSelector hook eliminating ~55 lines of duplication - Unify defaultValues/useEffect permission resolution (fixes inconsistency) - Make ListRolesResponse.description and _id optional to match schema - Fix vacuous test assertions to verify sentinel calls exist - Only fetch userRole when user.role === USER (avoid unnecessary requests) - Remove redundant empty string guard in custom role detection * fix: Revert USER role fetch restriction to preserve admin settings Admins need the USER role loaded in AuthContext.roles so the admin settings dialog shows persisted USER permissions instead of defaults. * fix: Remove unused useEffect import from useRoleSelector * fix: Clean up useRoleSelector hook - Use existing isCustom variable instead of re-calling isSystemRoleName - Remove unused roles and availableRoleNames from return object * fix: Address review findings for custom role permissions - Use Set-based isSystemRoleName to auto-expand with future SystemRoles - Add isCustomRoleError handling: guard useEffect reset and disable Save - Remove resolvePermissions from hook return; use defaultValues in useEffect to eliminate redundant computation and stale-closure reset race - Rename customRoleName to userRoleName in AuthContext for clarity * fix: Request server-max roles for admin dropdown listRoles now passes limit=200 (the server's MAX_PAGE_LIMIT) so the admin role selector shows all roles instead of silently truncating at the default page size of 50. --------- Co-authored-by: Danny Avila <danny@librechat.ai>
180 lines
5.5 KiB
JavaScript
180 lines
5.5 KiB
JavaScript
const express = require('express');
|
|
const { logger, SystemCapabilities } = require('@librechat/data-schemas');
|
|
const {
|
|
SystemRoles,
|
|
roleDefaults,
|
|
PermissionTypes,
|
|
agentPermissionsSchema,
|
|
promptPermissionsSchema,
|
|
memoryPermissionsSchema,
|
|
mcpServersPermissionsSchema,
|
|
marketplacePermissionsSchema,
|
|
peoplePickerPermissionsSchema,
|
|
remoteAgentsPermissionsSchema,
|
|
} = require('librechat-data-provider');
|
|
const { hasCapability, requireCapability } = require('~/server/middleware/roles/capabilities');
|
|
const { updateRoleByName, getRoleByName } = require('~/models');
|
|
const { requireJwtAuth } = require('~/server/middleware');
|
|
|
|
const router = express.Router();
|
|
router.use(requireJwtAuth);
|
|
const manageRoles = requireCapability(SystemCapabilities.MANAGE_ROLES);
|
|
|
|
/**
|
|
* Permission configuration mapping
|
|
* Maps route paths to their corresponding schemas and permission types
|
|
*/
|
|
const permissionConfigs = {
|
|
prompts: {
|
|
schema: promptPermissionsSchema,
|
|
permissionType: PermissionTypes.PROMPTS,
|
|
errorMessage: 'Invalid prompt permissions.',
|
|
},
|
|
agents: {
|
|
schema: agentPermissionsSchema,
|
|
permissionType: PermissionTypes.AGENTS,
|
|
errorMessage: 'Invalid agent permissions.',
|
|
},
|
|
memories: {
|
|
schema: memoryPermissionsSchema,
|
|
permissionType: PermissionTypes.MEMORIES,
|
|
errorMessage: 'Invalid memory permissions.',
|
|
},
|
|
'people-picker': {
|
|
schema: peoplePickerPermissionsSchema,
|
|
permissionType: PermissionTypes.PEOPLE_PICKER,
|
|
errorMessage: 'Invalid people picker permissions.',
|
|
},
|
|
'mcp-servers': {
|
|
schema: mcpServersPermissionsSchema,
|
|
permissionType: PermissionTypes.MCP_SERVERS,
|
|
errorMessage: 'Invalid MCP servers permissions.',
|
|
},
|
|
marketplace: {
|
|
schema: marketplacePermissionsSchema,
|
|
permissionType: PermissionTypes.MARKETPLACE,
|
|
errorMessage: 'Invalid marketplace permissions.',
|
|
},
|
|
'remote-agents': {
|
|
schema: remoteAgentsPermissionsSchema,
|
|
permissionType: PermissionTypes.REMOTE_AGENTS,
|
|
errorMessage: 'Invalid remote agents permissions.',
|
|
},
|
|
};
|
|
|
|
/**
|
|
* Generic handler for updating permissions
|
|
* @param {string} permissionKey - The key from permissionConfigs
|
|
* @returns {Function} Express route handler
|
|
*/
|
|
const createPermissionUpdateHandler = (permissionKey) => {
|
|
const config = permissionConfigs[permissionKey];
|
|
|
|
return async (req, res) => {
|
|
const { roleName } = req.params;
|
|
const updates = req.body;
|
|
|
|
try {
|
|
const parsedUpdates = config.schema.partial().parse(updates);
|
|
|
|
const role = await getRoleByName(roleName);
|
|
if (!role) {
|
|
return res.status(404).send({ message: 'Role not found' });
|
|
}
|
|
|
|
const currentPermissions =
|
|
role.permissions?.[config.permissionType] || role[config.permissionType] || {};
|
|
|
|
const mergedUpdates = {
|
|
permissions: {
|
|
...role.permissions,
|
|
[config.permissionType]: {
|
|
...currentPermissions,
|
|
...parsedUpdates,
|
|
},
|
|
},
|
|
};
|
|
|
|
const updatedRole = await updateRoleByName(roleName, mergedUpdates);
|
|
res.status(200).send(updatedRole);
|
|
} catch (error) {
|
|
return res.status(400).send({ message: config.errorMessage, error: error.errors });
|
|
}
|
|
};
|
|
};
|
|
|
|
/**
|
|
* GET /api/roles/:roleName
|
|
* Get a specific role by name
|
|
*/
|
|
router.get('/:roleName', async (req, res) => {
|
|
const { roleName } = req.params;
|
|
|
|
try {
|
|
let hasReadRoles = false;
|
|
try {
|
|
hasReadRoles = await hasCapability(req.user, SystemCapabilities.READ_ROLES);
|
|
} catch (err) {
|
|
logger.warn(`[GET /roles/:roleName] capability check failed: ${err.message}`);
|
|
}
|
|
const isOwnRole = req.user?.role === roleName;
|
|
const isDefaultRole = Object.hasOwn(roleDefaults, roleName);
|
|
if (!hasReadRoles && !isOwnRole && (roleName === SystemRoles.ADMIN || !isDefaultRole)) {
|
|
return res.status(403).send({ message: 'Unauthorized' });
|
|
}
|
|
|
|
const role = await getRoleByName(roleName, '-_id -__v');
|
|
if (!role) {
|
|
return res.status(404).send({ message: 'Role not found' });
|
|
}
|
|
|
|
res.status(200).send(role);
|
|
} catch (error) {
|
|
logger.error('[GET /roles/:roleName] Error:', error);
|
|
return res.status(500).send({ message: 'Failed to retrieve role' });
|
|
}
|
|
});
|
|
|
|
/**
|
|
* PUT /api/roles/:roleName/prompts
|
|
* Update prompt permissions for a specific role
|
|
*/
|
|
router.put('/:roleName/prompts', manageRoles, createPermissionUpdateHandler('prompts'));
|
|
|
|
/**
|
|
* PUT /api/roles/:roleName/agents
|
|
* Update agent permissions for a specific role
|
|
*/
|
|
router.put('/:roleName/agents', manageRoles, createPermissionUpdateHandler('agents'));
|
|
|
|
/**
|
|
* PUT /api/roles/:roleName/memories
|
|
* Update memory permissions for a specific role
|
|
*/
|
|
router.put('/:roleName/memories', manageRoles, createPermissionUpdateHandler('memories'));
|
|
|
|
/**
|
|
* PUT /api/roles/:roleName/people-picker
|
|
* Update people picker permissions for a specific role
|
|
*/
|
|
router.put('/:roleName/people-picker', manageRoles, createPermissionUpdateHandler('people-picker'));
|
|
|
|
/**
|
|
* PUT /api/roles/:roleName/mcp-servers
|
|
* Update MCP servers permissions for a specific role
|
|
*/
|
|
router.put('/:roleName/mcp-servers', manageRoles, createPermissionUpdateHandler('mcp-servers'));
|
|
|
|
/**
|
|
* PUT /api/roles/:roleName/marketplace
|
|
* Update marketplace permissions for a specific role
|
|
*/
|
|
router.put('/:roleName/marketplace', manageRoles, createPermissionUpdateHandler('marketplace'));
|
|
|
|
/**
|
|
* PUT /api/roles/:roleName/remote-agents
|
|
* Update remote agents (API) permissions for a specific role
|
|
*/
|
|
router.put('/:roleName/remote-agents', manageRoles, createPermissionUpdateHandler('remote-agents'));
|
|
|
|
module.exports = router;
|