File size: 10,735 Bytes
f0743f4 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 | import { Types } from 'mongoose';
import { PrincipalType, PrincipalModel } from 'librechat-data-provider';
import type { Model, DeleteResult, ClientSession } from 'mongoose';
import type { IAclEntry } from '~/types';
export function createAclEntryMethods(mongoose: typeof import('mongoose')) {
/**
* Find ACL entries for a specific principal (user or group)
* @param principalType - The type of principal ('user', 'group')
* @param principalId - The ID of the principal
* @param resourceType - Optional filter by resource type
* @returns Array of ACL entries
*/
async function findEntriesByPrincipal(
principalType: string,
principalId: string | Types.ObjectId,
resourceType?: string,
): Promise<IAclEntry[]> {
const AclEntry = mongoose.models.AclEntry as Model<IAclEntry>;
const query: Record<string, unknown> = { principalType, principalId };
if (resourceType) {
query.resourceType = resourceType;
}
return await AclEntry.find(query).lean();
}
/**
* Find ACL entries for a specific resource
* @param resourceType - The type of resource ('agent', 'project', 'file')
* @param resourceId - The ID of the resource
* @returns Array of ACL entries
*/
async function findEntriesByResource(
resourceType: string,
resourceId: string | Types.ObjectId,
): Promise<IAclEntry[]> {
const AclEntry = mongoose.models.AclEntry as Model<IAclEntry>;
return await AclEntry.find({ resourceType, resourceId }).lean();
}
/**
* Find all ACL entries for a set of principals (including public)
* @param principalsList - List of principals, each containing { principalType, principalId }
* @param resourceType - The type of resource
* @param resourceId - The ID of the resource
* @returns Array of matching ACL entries
*/
async function findEntriesByPrincipalsAndResource(
principalsList: Array<{ principalType: string; principalId?: string | Types.ObjectId }>,
resourceType: string,
resourceId: string | Types.ObjectId,
): Promise<IAclEntry[]> {
const AclEntry = mongoose.models.AclEntry as Model<IAclEntry>;
const principalsQuery = principalsList.map((p) => ({
principalType: p.principalType,
...(p.principalType !== PrincipalType.PUBLIC && { principalId: p.principalId }),
}));
return await AclEntry.find({
$or: principalsQuery,
resourceType,
resourceId,
}).lean();
}
/**
* Check if a set of principals has a specific permission on a resource
* @param principalsList - List of principals, each containing { principalType, principalId }
* @param resourceType - The type of resource
* @param resourceId - The ID of the resource
* @param permissionBit - The permission bit to check (use PermissionBits enum)
* @returns Whether any of the principals has the permission
*/
async function hasPermission(
principalsList: Array<{ principalType: string; principalId?: string | Types.ObjectId }>,
resourceType: string,
resourceId: string | Types.ObjectId,
permissionBit: number,
): Promise<boolean> {
const AclEntry = mongoose.models.AclEntry as Model<IAclEntry>;
const principalsQuery = principalsList.map((p) => ({
principalType: p.principalType,
...(p.principalType !== PrincipalType.PUBLIC && { principalId: p.principalId }),
}));
const entry = await AclEntry.findOne({
$or: principalsQuery,
resourceType,
resourceId,
permBits: { $bitsAllSet: permissionBit },
}).lean();
return !!entry;
}
/**
* Get the combined effective permissions for a set of principals on a resource
* @param principalsList - List of principals, each containing { principalType, principalId }
* @param resourceType - The type of resource
* @param resourceId - The ID of the resource
* @returns {Promise<number>} Effective permission bitmask
*/
async function getEffectivePermissions(
principalsList: Array<{ principalType: string; principalId?: string | Types.ObjectId }>,
resourceType: string,
resourceId: string | Types.ObjectId,
): Promise<number> {
const aclEntries = await findEntriesByPrincipalsAndResource(
principalsList,
resourceType,
resourceId,
);
let effectiveBits = 0;
for (const entry of aclEntries) {
effectiveBits |= entry.permBits;
}
return effectiveBits;
}
/**
* Grant permission to a principal for a resource
* @param principalType - The type of principal ('user', 'group', 'public')
* @param principalId - The ID of the principal (null for 'public')
* @param resourceType - The type of resource
* @param resourceId - The ID of the resource
* @param permBits - The permission bits to grant
* @param grantedBy - The ID of the user granting the permission
* @param session - Optional MongoDB session for transactions
* @param roleId - Optional role ID to associate with this permission
* @returns The created or updated ACL entry
*/
async function grantPermission(
principalType: string,
principalId: string | Types.ObjectId | null,
resourceType: string,
resourceId: string | Types.ObjectId,
permBits: number,
grantedBy: string | Types.ObjectId,
session?: ClientSession,
roleId?: string | Types.ObjectId,
): Promise<IAclEntry | null> {
const AclEntry = mongoose.models.AclEntry as Model<IAclEntry>;
const query: Record<string, unknown> = {
principalType,
resourceType,
resourceId,
};
if (principalType !== PrincipalType.PUBLIC) {
query.principalId =
typeof principalId === 'string' && principalType !== PrincipalType.ROLE
? new Types.ObjectId(principalId)
: principalId;
if (principalType === PrincipalType.USER) {
query.principalModel = PrincipalModel.USER;
} else if (principalType === PrincipalType.GROUP) {
query.principalModel = PrincipalModel.GROUP;
} else if (principalType === PrincipalType.ROLE) {
query.principalModel = PrincipalModel.ROLE;
}
}
const update = {
$set: {
permBits,
grantedBy,
grantedAt: new Date(),
...(roleId && { roleId }),
},
};
const options = {
upsert: true,
new: true,
...(session ? { session } : {}),
};
return await AclEntry.findOneAndUpdate(query, update, options);
}
/**
* Revoke permissions from a principal for a resource
* @param principalType - The type of principal ('user', 'group', 'public')
* @param principalId - The ID of the principal (null for 'public')
* @param resourceType - The type of resource
* @param resourceId - The ID of the resource
* @param session - Optional MongoDB session for transactions
* @returns The result of the delete operation
*/
async function revokePermission(
principalType: string,
principalId: string | Types.ObjectId | null,
resourceType: string,
resourceId: string | Types.ObjectId,
session?: ClientSession,
): Promise<DeleteResult> {
const AclEntry = mongoose.models.AclEntry as Model<IAclEntry>;
const query: Record<string, unknown> = {
principalType,
resourceType,
resourceId,
};
if (principalType !== PrincipalType.PUBLIC) {
query.principalId =
typeof principalId === 'string' && principalType !== PrincipalType.ROLE
? new Types.ObjectId(principalId)
: principalId;
}
const options = session ? { session } : {};
return await AclEntry.deleteOne(query, options);
}
/**
* Modify existing permission bits for a principal on a resource
* @param principalType - The type of principal ('user', 'group', 'public')
* @param principalId - The ID of the principal (null for 'public')
* @param resourceType - The type of resource
* @param resourceId - The ID of the resource
* @param addBits - Permission bits to add
* @param removeBits - Permission bits to remove
* @param session - Optional MongoDB session for transactions
* @returns The updated ACL entry
*/
async function modifyPermissionBits(
principalType: string,
principalId: string | Types.ObjectId | null,
resourceType: string,
resourceId: string | Types.ObjectId,
addBits?: number | null,
removeBits?: number | null,
session?: ClientSession,
): Promise<IAclEntry | null> {
const AclEntry = mongoose.models.AclEntry as Model<IAclEntry>;
const query: Record<string, unknown> = {
principalType,
resourceType,
resourceId,
};
if (principalType !== PrincipalType.PUBLIC) {
query.principalId =
typeof principalId === 'string' && principalType !== PrincipalType.ROLE
? new Types.ObjectId(principalId)
: principalId;
}
const update: Record<string, unknown> = {};
if (addBits) {
update.$bit = { permBits: { or: addBits } };
}
if (removeBits) {
if (!update.$bit) update.$bit = {};
const bitUpdate = update.$bit as Record<string, unknown>;
bitUpdate.permBits = { ...(bitUpdate.permBits as Record<string, unknown>), and: ~removeBits };
}
const options = {
new: true,
...(session ? { session } : {}),
};
return await AclEntry.findOneAndUpdate(query, update, options);
}
/**
* Find all resources of a specific type that a set of principals has access to
* @param principalsList - List of principals, each containing { principalType, principalId }
* @param resourceType - The type of resource
* @param requiredPermBit - Required permission bit (use PermissionBits enum)
* @returns Array of resource IDs
*/
async function findAccessibleResources(
principalsList: Array<{ principalType: string; principalId?: string | Types.ObjectId }>,
resourceType: string,
requiredPermBit: number,
): Promise<Types.ObjectId[]> {
const AclEntry = mongoose.models.AclEntry as Model<IAclEntry>;
const principalsQuery = principalsList.map((p) => ({
principalType: p.principalType,
...(p.principalType !== PrincipalType.PUBLIC && { principalId: p.principalId }),
}));
const entries = await AclEntry.find({
$or: principalsQuery,
resourceType,
permBits: { $bitsAllSet: requiredPermBit },
}).distinct('resourceId');
return entries;
}
return {
findEntriesByPrincipal,
findEntriesByResource,
findEntriesByPrincipalsAndResource,
hasPermission,
getEffectivePermissions,
grantPermission,
revokePermission,
modifyPermissionBits,
findAccessibleResources,
};
}
export type AclEntryMethods = ReturnType<typeof createAclEntryMethods>;
|