Files
OmniRoute/src/lib/db/apiKeyGroups.ts
Nguyen Thanh Dat 6945bbaaba fix(db): escape regex metacharacters in group model patterns (#11311)
Validated on a 17-PR combined board: group-model-pattern-regex-escape within the board's 287/287, typecheck:core clean. matchesModelPattern() only substituted * before compiling to RegExp — every other metacharacter kept its regex meaning, so a malformed group pattern (unbalanced parens/brackets) threw uncaught and broke EVERY request for keys in that group, not just the malformed rule (isModelAllowedForKey has no try/catch and runs on the chat completion path and the /v1/models catalog). Thank you @ntdat812!
2026-08-24 01:55:42 -03:00

371 lines
11 KiB
TypeScript

/**
* API Key Groups DB — CRUD operations for team/enterprise key grouping
*
* Tables: key_groups, group_model_permissions, key_group_members
* Migration: 065_api_key_groups.sql
*
* Enables team-level API key management with model-level access control.
*/
import { getDbInstance } from "@/lib/db/core";
import { randomUUID } from "crypto";
import { invalidateModelCatalogCache } from "./readCache";
// ── Types ────────────────────────────────────────────────────────────────
export interface KeyGroup {
id: string;
name: string;
description: string;
isActive: boolean;
createdAt: string;
updatedAt: string;
}
export interface GroupModelPermission {
id: string;
groupId: string;
modelPattern: string;
provider: string | null;
accessType: "allow" | "deny";
createdAt: string;
}
export interface KeyGroupMember {
keyId: string;
groupId: string;
createdAt: string;
}
export interface KeyGroupWithPermissions extends KeyGroup {
permissions: GroupModelPermission[];
memberCount: number;
}
// ── Key Groups CRUD ──────────────────────────────────────────────────────
export function getAllKeyGroups(): KeyGroup[] {
const db = getDbInstance() as any;
const rows = db.prepare("SELECT * FROM key_groups ORDER BY name ASC").all() as any[];
return rows.map(rowToGroup);
}
export function getKeyGroup(id: string): KeyGroup | undefined {
const db = getDbInstance() as any;
const row = db.prepare("SELECT * FROM key_groups WHERE id = ?").get(id) as any;
return row ? rowToGroup(row) : undefined;
}
export function getKeyGroupWithPermissions(id: string): KeyGroupWithPermissions | undefined {
const group = getKeyGroup(id);
if (!group) return undefined;
const permissions = getGroupPermissions(id);
const memberCount = getGroupMemberCount(id);
return { ...group, permissions, memberCount };
}
export function createKeyGroup(name: string, description = ""): KeyGroup {
const db = getDbInstance() as any;
const id = randomUUID();
const now = new Date().toISOString();
db.prepare(
"INSERT INTO key_groups (id, name, description, created_at, updated_at) VALUES (?, ?, ?, ?, ?)",
).run(id, name, description, now, now);
return getKeyGroup(id)!;
}
export function updateKeyGroup(
id: string,
updates: { name?: string; description?: string; isActive?: boolean },
): KeyGroup | undefined {
const existing = getKeyGroup(id);
if (!existing) return undefined;
const db = getDbInstance() as any;
const sets: string[] = [];
const params: Record<string, unknown> = { id };
if (updates.name !== undefined) {
sets.push("name = @name");
params.name = updates.name;
}
if (updates.description !== undefined) {
sets.push("description = @description");
params.description = updates.description;
}
if (updates.isActive !== undefined) {
sets.push("is_active = @isActive");
params.isActive = updates.isActive ? 1 : 0;
}
if (sets.length === 0) return existing;
const catalogInvalidationNeeded =
updates.isActive !== undefined && updates.isActive !== existing.isActive;
sets.push("updated_at = datetime('now')");
const result = db.prepare(`UPDATE key_groups SET ${sets.join(", ")} WHERE id = @id`).run(params);
if (catalogInvalidationNeeded && result.changes > 0) {
invalidateModelCatalogCache();
}
return result.changes > 0 ? getKeyGroup(id) : existing;
}
export function deleteKeyGroup(id: string): boolean {
const db = getDbInstance() as any;
// CASCADE deletes permissions and members
const result = db.prepare("DELETE FROM key_groups WHERE id = ?").run(id);
if (result.changes > 0) {
invalidateModelCatalogCache();
return true;
}
return false;
}
// ── Group Permissions ────────────────────────────────────────────────────
export function getGroupPermissions(groupId: string): GroupModelPermission[] {
const db = getDbInstance() as any;
const rows = db
.prepare(
"SELECT * FROM group_model_permissions WHERE group_id = ? ORDER BY access_type ASC, model_pattern ASC",
)
.all(groupId) as any[];
return rows.map(rowToPermission);
}
export function addGroupPermission(
groupId: string,
modelPattern: string,
accessType: "allow" | "deny",
provider?: string,
): GroupModelPermission {
const db = getDbInstance() as any;
const id = randomUUID();
const now = new Date().toISOString();
const result = db
.prepare(
"INSERT INTO group_model_permissions (id, group_id, model_pattern, provider, access_type, created_at) VALUES (?, ?, ?, ?, ?, ?)",
)
.run(id, groupId, modelPattern, provider || null, accessType, now);
if (result.changes > 0) {
invalidateModelCatalogCache();
}
return getGroupPermissions(groupId).find((p) => p.id === id)!;
}
export function removeGroupPermission(permissionId: string): boolean {
const db = getDbInstance() as any;
const result = db.prepare("DELETE FROM group_model_permissions WHERE id = ?").run(permissionId);
if (result.changes > 0) {
invalidateModelCatalogCache();
}
return result.changes > 0;
}
export function clearGroupPermissions(groupId: string): void {
const db = getDbInstance() as any;
const result = db.prepare("DELETE FROM group_model_permissions WHERE group_id = ?").run(groupId);
if (result.changes > 0) {
invalidateModelCatalogCache();
}
}
// ── Key Group Members ────────────────────────────────────────────────────
export function getGroupMembers(groupId: string): KeyGroupMember[] {
const db = getDbInstance() as any;
const rows = db
.prepare("SELECT * FROM key_group_members WHERE group_id = ? ORDER BY created_at ASC")
.all(groupId) as any[];
return rows.map(rowToMember);
}
export function getKeyGroupsForApiKey(keyId: string): KeyGroup[] {
const db = getDbInstance() as any;
const rows = db
.prepare(
`
SELECT g.* FROM key_groups g
INNER JOIN key_group_members m ON g.id = m.group_id
WHERE m.key_id = ? AND g.is_active = 1
ORDER BY g.name ASC
`,
)
.all(keyId) as any[];
return rows.map(rowToGroup);
}
export function addKeyToGroup(keyId: string, groupId: string): boolean {
const db = getDbInstance() as any;
try {
const result = db
.prepare("INSERT OR IGNORE INTO key_group_members (key_id, group_id) VALUES (?, ?)")
.run(keyId, groupId);
if (result.changes > 0) {
invalidateModelCatalogCache();
}
return true;
} catch {
return false;
}
}
export function removeKeyFromGroup(keyId: string, groupId: string): boolean {
const db = getDbInstance() as any;
const result = db
.prepare("DELETE FROM key_group_members WHERE key_id = ? AND group_id = ?")
.run(keyId, groupId);
if (result.changes > 0) {
invalidateModelCatalogCache();
}
return result.changes > 0;
}
function getGroupMemberCount(groupId: string): number {
const db = getDbInstance() as any;
const row = db
.prepare("SELECT COUNT(*) as count FROM key_group_members WHERE group_id = ?")
.get(groupId) as any;
return row?.count || 0;
}
// ── Authorization Helper ────────────────────────────────────────────────
export interface ModelAccessCheck {
allowed: boolean;
matchedRules: GroupModelPermission[];
deniedBy: GroupModelPermission | null;
}
/**
* Check if an API key has access to a specific model.
* Deny rules override allow rules. If no rules match, access is allowed by default.
*/
export function checkKeyModelAccess(
keyId: string,
model: string,
provider?: string,
): ModelAccessCheck {
const groups = getKeyGroupsForApiKey(keyId);
if (groups.length === 0) {
// No groups = no restrictions
return { allowed: true, matchedRules: [], deniedBy: null };
}
const db = getDbInstance() as any;
const groupIds = groups.map((g) => g.id);
const placeholders = groupIds.map(() => "?").join(",");
const rules = db
.prepare(
`
SELECT * FROM group_model_permissions
WHERE group_id IN (${placeholders})
ORDER BY access_type ASC
`,
)
.all(...groupIds) as any[];
const permissions = rules.map(rowToPermission);
// Check deny rules first (they take precedence)
const denyRules = permissions.filter(
(p) =>
p.accessType === "deny" &&
matchesModelPattern(p.modelPattern, model) &&
(!p.provider || p.provider === provider),
);
if (denyRules.length > 0) {
return { allowed: false, matchedRules: permissions, deniedBy: denyRules[0] };
}
// Check allow rules
const allowRules = permissions.filter(
(p) =>
p.accessType === "allow" &&
matchesModelPattern(p.modelPattern, model) &&
(!p.provider || p.provider === provider),
);
if (allowRules.length > 0) {
return { allowed: true, matchedRules: permissions, deniedBy: null };
}
// No matching rules = restricted by group membership but no explicit allow
return { allowed: false, matchedRules: permissions, deniedBy: null };
}
/**
* Compile a group model pattern.
*
* `*` is the only wildcard this syntax has, so every other regex
* metacharacter must be escaped before the pattern is compiled. Interpolating
* it raw made an operator's pattern behave as a regex in two ways:
*
* - `gpt-4.1*` matched `gpt-4o1-preview`, because `.` is "any character".
* On a deny rule that blocks unrelated models; on an allow rule it grants
* models the pattern was never meant to cover.
* - `gpt-4(*`, `claude-3[*` and `*+*` threw `SyntaxError` (unterminated
* group / unterminated character class / nothing to repeat) out of
* `checkKeyModelAccess()`, which runs on the completion and /v1/models
* paths — one malformed pattern broke every request for keys in that
* group.
*
* Escaping keeps the semantics this function already had (case-sensitive,
* `*`-only) and matches how the rest of the repo compiles operator patterns
* (`globToRegex`, `matchesWildcardPattern`).
*/
function modelPatternToRegex(pattern: string): RegExp {
const escaped = pattern.replace(/[.+^${}()|[\]\\?]/g, "\\$&").replace(/\*/g, ".*");
return new RegExp(`^${escaped}$`);
}
function matchesModelPattern(pattern: string, model: string): boolean {
if (pattern === "*") return true;
if (pattern.includes("*")) {
return modelPatternToRegex(pattern).test(model);
}
return pattern === model;
}
// ── Row Mappers ──────────────────────────────────────────────────────────
function rowToGroup(row: any): KeyGroup {
return {
id: row.id,
name: row.name,
description: row.description || "",
isActive: row.is_active === 1,
createdAt: row.created_at,
updatedAt: row.updated_at,
};
}
function rowToPermission(row: any): GroupModelPermission {
return {
id: row.id,
groupId: row.group_id,
modelPattern: row.model_pattern,
provider: row.provider || null,
accessType: row.access_type,
createdAt: row.created_at,
};
}
function rowToMember(row: any): KeyGroupMember {
return {
keyId: row.key_id,
groupId: row.group_id,
createdAt: row.created_at,
};
}