Spaces:
Runtime error
Runtime error
File size: 51,676 Bytes
cd8bd0a | 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 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 | /**
* db/apiKeys.js β API key management.
*/
import { createHash } from "crypto";
import { v4 as uuidv4 } from "uuid";
import { getDbInstance, rowToCamel } from "./core";
import { backupDbFile } from "./backup";
import { registerDbStateResetter } from "./stateReset";
import { getKeyGroupsForApiKey, checkKeyModelAccess } from "./apiKeyGroups";
import { API_KEY_COLUMN_FALLBACKS } from "./apiKeyColumnFallbacks";
import {
appendUsageLimitUpdates,
hasUsageLimitUpdate,
parseApiKeyUsageLimitFields,
} from "./apiKeyUsageLimitFields";
import { setNoLog } from "../compliance/noLog";
import { resolveModelAlias } from "@omniroute/open-sse/services/modelDeprecation.ts";
import { getSyncedAvailableModelsByConnection, getCustomModels, getModelIsHidden } from "./models";
import {
CLAUDE_CODE_PROVIDER_PREFIXES,
preferClaudeCodeForUnprefixedClaudeModels,
stripExtendedContextSuffix,
isPotentialUnprefixedClaudeCodeModel,
addModelCandidate,
modelPatternMatches,
hasClaudeCodeWildcardPermission,
matchesWildcardPattern,
} from "./apiKeys/modelPermissions";
import {
parseAllowedModels,
parseAllowedCombos,
parseNoLog,
parseAutoResolve,
parseDisableNonPublicModels,
parseAllowUsageCommand,
parseIsActive,
parseAccessSchedule,
parseRateLimits,
parseAllowedConnections,
parseAllowedQuotas,
parseStringList,
parseNullableTimestamp,
parseIsBanned,
parseStreamDefaultMode,
} from "./apiKeys/rowParsers";
import type { AccessSchedule, RateLimitRule } from "./apiKeys/types";
// ββββββββββββββββ Performance Optimizations ββββββββββββββββ
// Schema check memoization - only run once
let _schemaChecked = false;
type JsonRecord = Record<string, unknown>;
interface CacheEntry<TValue> {
timestamp: number;
value: TValue;
}
// Re-exported for the historical public surface (moved to ./apiKeys/types).
export type { AccessSchedule, RateLimitRule } from "./apiKeys/types";
interface ApiKeyMetadata {
id: string;
name: string;
machineId: string | null;
allowedModels: string[];
blockedModels: string[];
allowedCombos: string[];
allowedConnections: string[];
allowedQuotas: string[];
noLog: boolean;
autoResolve: boolean;
isActive: boolean;
accessSchedule: AccessSchedule | null;
maxRequestsPerDay: number | null;
maxRequestsPerMinute: number | null;
throttleDelayMs: number | null;
rateLimits: RateLimitRule[] | null;
// T08: Per-key max concurrent sticky sessions (0 = unlimited)
maxSessions: number;
// Phase 3 lifecycle/policy fields
revokedAt: string | null;
expiresAt: string | null;
ipAllowlist: string[];
scopes: string[];
isBanned: boolean;
keyHash: string | null;
proxyId: string | null;
allowedEndpoints: string[];
streamDefaultMode: "legacy" | "json";
disableNonPublicModels: boolean;
allowUsageCommand: boolean;
usageLimitEnabled: boolean;
dailyUsageLimitUsd: number | null;
weeklyUsageLimitUsd: number | null;
}
interface ApiKeyRow extends JsonRecord {
id?: unknown;
name?: unknown;
key?: unknown;
machine_id?: unknown;
machineId?: unknown;
allowed_models?: unknown;
allowedModels?: unknown;
blocked_models?: unknown;
blockedModels?: unknown;
allowed_combos?: unknown;
allowedCombos?: unknown;
allowed_connections?: unknown;
allowedConnections?: unknown;
allowed_quotas?: unknown;
allowedQuotas?: unknown;
no_log?: unknown;
noLog?: unknown;
auto_resolve?: unknown;
autoResolve?: unknown;
is_active?: unknown;
isActive?: unknown;
access_schedule?: unknown;
accessSchedule?: unknown;
rate_limits?: unknown;
rateLimits?: unknown;
proxy_id?: unknown;
stream_default_mode?: unknown;
streamDefaultMode?: unknown;
allow_usage_command?: unknown;
allowUsageCommand?: unknown;
usage_limit_enabled?: unknown;
usageLimitEnabled?: unknown;
daily_usage_limit_usd?: unknown;
dailyUsageLimitUsd?: unknown;
weekly_usage_limit_usd?: unknown;
weeklyUsageLimitUsd?: unknown;
}
interface StatementLike<TRow = unknown> {
all: (...params: unknown[]) => TRow[];
get: (...params: unknown[]) => TRow | undefined;
run: (...params: unknown[]) => { changes?: number };
}
interface ApiKeysDbLike {
prepare: <TRow = unknown>(sql: string) => StatementLike<TRow>;
exec: (sql: string) => void;
}
interface ApiKeysStatements {
getAllKeys: StatementLike<ApiKeyRow>;
getKeyById: StatementLike<ApiKeyRow>;
validateKey: StatementLike<JsonRecord>;
getKeyMetadata: StatementLike<ApiKeyRow>;
insertKey: StatementLike;
deleteKey: StatementLike;
}
interface ApiKeyView extends JsonRecord {
id?: string;
allowedModels: string[];
blockedModels: string[];
allowedCombos: string[];
allowedConnections: string[];
allowedQuotas: string[];
noLog: boolean;
autoResolve: boolean;
isActive: boolean;
accessSchedule: AccessSchedule | null;
throttleDelayMs?: number | null;
rateLimits: RateLimitRule[] | null;
scopes: string[];
proxyId?: string | null;
isBanned?: boolean;
expiresAt?: string | null;
allowedEndpoints: string[];
streamDefaultMode: "legacy" | "json";
disableNonPublicModels?: boolean;
allowUsageCommand?: boolean;
usageLimitEnabled?: boolean;
dailyUsageLimitUsd?: number | null;
weeklyUsageLimitUsd?: number | null;
}
// LRU cache for API key validation (valid keys only)
const _keyValidationCache = new Map<string, { valid: boolean; timestamp: number }>();
const _keyMetadataCache = new Map<string, CacheEntry<ApiKeyMetadata>>();
const _lastUsedUpdateCache = new Map<string, number>();
const CACHE_TTL = 60 * 1000; // 1 minute TTL
const LAST_USED_UPDATE_TTL = 5 * 60 * 1000;
const MAX_CACHE_SIZE = 1000;
// Wildcard scope matching is now handled by `matchesWildcardPattern`
// (deterministic, no RegExp from dynamic strings).
// Cache for model permission checks
const _modelPermissionCache = new Map<string, { allowed: boolean; timestamp: number }>();
// Prepared statements cache
let _stmtGetAllKeys: ApiKeysStatements["getAllKeys"] | null = null;
let _stmtGetKeyById: ApiKeysStatements["getKeyById"] | null = null;
let _stmtValidateKey: ApiKeysStatements["validateKey"] | null = null;
let _stmtGetKeyMetadata: ApiKeysStatements["getKeyMetadata"] | null = null;
let _stmtInsertKey: ApiKeysStatements["insertKey"] | null = null;
let _stmtDeleteKey: ApiKeysStatements["deleteKey"] | null = null;
/**
* Clear all caches (called on key create/update/delete)
*/
function invalidateCaches() {
_keyValidationCache.clear();
_keyMetadataCache.clear();
_modelPermissionCache.clear();
_lastUsedUpdateCache.clear();
}
function toRecord(value: unknown): JsonRecord {
return value && typeof value === "object" ? (value as JsonRecord) : {};
}
function isConfiguredEnvApiKey(key: string): boolean {
const envKey = process.env.OMNIROUTE_API_KEY || process.env.ROUTER_API_KEY;
return Boolean(envKey && key === envKey);
}
function isRedisAuthCacheEnabled(): boolean {
return (
process.env.OMNIROUTE_DISABLE_REDIS_AUTH_CACHE !== "1" &&
process.env.NODE_ENV !== "test" &&
process.env.DISABLE_SQLITE_AUTO_BACKUP !== "true"
);
}
async function deleteRedisAuthCacheEntry(keyHash: unknown): Promise<void> {
if (!isRedisAuthCacheEnabled() || typeof keyHash !== "string" || keyHash.trim() === "") return;
try {
const { getRedisClient, isRedisConfigured } = await import("@/shared/utils/rateLimiter");
if (!isRedisConfigured()) return;
const redis = getRedisClient();
await redis.del(`auth:api_key:${keyHash}`);
} catch {
// Redis is an optimization for auth caching; SQLite remains authoritative.
}
}
async function deleteRedisAuthCacheEntries(...keyHashes: unknown[]): Promise<void> {
await Promise.all(keyHashes.map((keyHash) => deleteRedisAuthCacheEntry(keyHash)));
}
async function deleteRedisAuthCacheForKeyId(db: ApiKeysDbLike, id: string): Promise<void> {
if (!isRedisAuthCacheEnabled()) return;
const row = db
.prepare<{ key_hash: string | null }>("SELECT key_hash FROM api_keys WHERE id = ?")
.get(id);
await deleteRedisAuthCacheEntry(row?.key_hash);
}
function markApiKeyUsed(db: ApiKeysDbLike, id: unknown, now: number): void {
if (typeof id !== "string" || id.trim() === "") return;
const lastUpdate = _lastUsedUpdateCache.get(id);
if (lastUpdate && now - lastUpdate < LAST_USED_UPDATE_TTL) return;
db.prepare("UPDATE api_keys SET last_used_at = @lastUsedAt WHERE id = @id").run({
id,
lastUsedAt: new Date(now).toISOString(),
});
_lastUsedUpdateCache.set(id, now);
}
/**
* LRU eviction for cache
*/
function evictIfNeeded<TKey, TValue>(cache: Map<TKey, TValue>) {
if (cache.size > MAX_CACHE_SIZE) {
// Remove oldest 20% of entries
const entriesToRemove = Math.floor(MAX_CACHE_SIZE * 0.2);
let i = 0;
for (const key of cache.keys()) {
if (i++ >= entriesToRemove) break;
cache.delete(key);
}
}
}
async function getModelPermissionCandidates(modelId: string): Promise<string[]> {
const candidates = new Set<string>();
addModelCandidate(candidates, modelId);
const cleanModelId = stripExtendedContextSuffix(modelId.trim());
if (!cleanModelId) return Array.from(candidates);
if (cleanModelId.includes("/")) {
const firstSlash = cleanModelId.indexOf("/");
const providerOrAlias = cleanModelId.slice(0, firstSlash);
const providerScopedModel = cleanModelId.slice(firstSlash + 1);
if (CLAUDE_CODE_PROVIDER_PREFIXES.has(providerOrAlias) && providerScopedModel) {
addModelCandidate(candidates, providerScopedModel);
addModelCandidate(candidates, `cc/${providerScopedModel}`);
addModelCandidate(candidates, `claude/${providerScopedModel}`);
}
return Array.from(candidates);
}
if (
isPotentialUnprefixedClaudeCodeModel(cleanModelId) &&
(await preferClaudeCodeForUnprefixedClaudeModels())
) {
addModelCandidate(candidates, `cc/${cleanModelId}`);
addModelCandidate(candidates, `claude/${cleanModelId}`);
}
return Array.from(candidates);
}
async function getPublishedModelLookupTarget(
modelId: string
): Promise<{ providerId: string; modelId: string } | null> {
const cleanModelId = stripExtendedContextSuffix(modelId.trim());
if (!cleanModelId) return null;
if (cleanModelId.includes("/")) {
const firstSlash = cleanModelId.indexOf("/");
const providerOrAlias = cleanModelId.slice(0, firstSlash);
const providerScopedModel = cleanModelId.slice(firstSlash + 1);
if (!providerScopedModel) return null;
const providerId = CLAUDE_CODE_PROVIDER_PREFIXES.has(providerOrAlias)
? "claude"
: providerOrAlias;
return { providerId, modelId: providerScopedModel };
}
if (
isPotentialUnprefixedClaudeCodeModel(cleanModelId) &&
(await preferClaudeCodeForUnprefixedClaudeModels())
) {
return { providerId: "claude", modelId: cleanModelId };
}
return null;
}
function ensureApiKeyColumn(
db: ApiKeysDbLike,
columnNames: Set<string>,
column: (typeof API_KEY_COLUMN_FALLBACKS)[number]
): void {
if (columnNames.has(column.name)) return;
db.exec(`ALTER TABLE api_keys ADD COLUMN ${column.definition}`);
console.log(`[DB] Added api_keys.${column.name} column`);
}
// Ensure api_keys extension columns exist (memoized)
function ensureApiKeysColumns(db: ApiKeysDbLike) {
if (_schemaChecked) return;
try {
const columns = db.prepare<ApiKeyRow>("PRAGMA table_info(api_keys)").all();
const columnNames = new Set(columns.map((column) => String(column.name ?? "")));
for (const column of API_KEY_COLUMN_FALLBACKS) {
ensureApiKeyColumn(db, columnNames, column);
}
_schemaChecked = true;
} catch (error) {
const message = error instanceof Error ? error.message : String(error);
console.warn("[DB] Failed to verify api_keys schema:", message);
}
}
/**
* Initialize prepared statements (lazy initialization)
* Re-creates statements if the underlying DB connection changed (HMR, backup restore).
*/
let _stmtDb: ApiKeysDbLike | null = null;
function getPreparedStatements(db: ApiKeysDbLike): ApiKeysStatements {
ensureApiKeysColumns(db);
if (
!_stmtGetAllKeys ||
!_stmtGetKeyById ||
!_stmtValidateKey ||
!_stmtGetKeyMetadata ||
!_stmtInsertKey ||
!_stmtDeleteKey ||
_stmtDb !== db
) {
_stmtDb = db;
_stmtGetAllKeys = db.prepare<ApiKeyRow>("SELECT * FROM api_keys ORDER BY created_at");
_stmtGetKeyById = db.prepare<ApiKeyRow>("SELECT * FROM api_keys WHERE id = ?");
_stmtValidateKey = db.prepare<JsonRecord>(
"SELECT id, expires_at, revoked_at, is_active, is_banned FROM api_keys WHERE key = ? OR key_hash = ?"
);
_stmtGetKeyMetadata = db.prepare<ApiKeyRow>(
"SELECT id, name, machine_id, allowed_models, blocked_models, allowed_combos, allowed_connections, allowed_quotas, no_log, auto_resolve, is_active, access_schedule, max_requests_per_day, max_requests_per_minute, throttle_delay_ms, max_sessions, revoked_at, expires_at, ip_allowlist, scopes, rate_limits, is_banned, key_hash, allowed_endpoints, stream_default_mode, disable_non_public_models, allow_usage_command, usage_limit_enabled, daily_usage_limit_usd, weekly_usage_limit_usd, proxy_id FROM api_keys WHERE key = ? OR key_hash = ?"
);
_stmtInsertKey = db.prepare(
"INSERT INTO api_keys (id, name, key, machine_id, allowed_models, no_log, created_at, key_prefix, key_hash, scopes) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)"
);
_stmtDeleteKey = db.prepare("DELETE FROM api_keys WHERE id = ?");
}
if (
!_stmtGetAllKeys ||
!_stmtGetKeyById ||
!_stmtValidateKey ||
!_stmtGetKeyMetadata ||
!_stmtInsertKey ||
!_stmtDeleteKey
) {
throw new Error("Failed to initialize API key prepared statements");
}
return {
getAllKeys: _stmtGetAllKeys,
getKeyById: _stmtGetKeyById,
validateKey: _stmtValidateKey,
getKeyMetadata: _stmtGetKeyMetadata,
insertKey: _stmtInsertKey,
deleteKey: _stmtDeleteKey,
};
}
export async function getApiKeys() {
const db = getDbInstance() as ApiKeysDbLike;
const stmt = getPreparedStatements(db);
const rows = stmt.getAllKeys.all();
return rows.map((row) => {
const camelRow = toRecord(rowToCamel(row)) as ApiKeyView;
camelRow.allowedModels = parseAllowedModels(camelRow.allowedModels);
camelRow.blockedModels = parseAllowedModels(camelRow.blockedModels);
camelRow.allowedCombos = parseAllowedCombos(camelRow.allowedCombos);
camelRow.allowedConnections = parseAllowedConnections(camelRow.allowedConnections);
camelRow.allowedQuotas = parseAllowedQuotas((camelRow as JsonRecord).allowedQuotas);
camelRow.noLog = parseNoLog(camelRow.noLog);
camelRow.autoResolve = parseAutoResolve(camelRow.autoResolve);
camelRow.isActive = parseIsActive(camelRow.isActive);
camelRow.accessSchedule = parseAccessSchedule(camelRow.accessSchedule);
camelRow.rateLimits = parseRateLimits(camelRow.rateLimits);
camelRow.isBanned = parseIsBanned(camelRow.isBanned);
camelRow.scopes = parseStringList((camelRow as JsonRecord).scopes);
camelRow.allowedEndpoints = parseStringList((camelRow as JsonRecord).allowedEndpoints);
camelRow.streamDefaultMode = parseStreamDefaultMode((camelRow as JsonRecord).streamDefaultMode);
camelRow.disableNonPublicModels = parseDisableNonPublicModels(
(camelRow as JsonRecord).disableNonPublicModels
);
camelRow.allowUsageCommand = parseAllowUsageCommand((camelRow as JsonRecord).allowUsageCommand);
Object.assign(camelRow, parseApiKeyUsageLimitFields(camelRow));
if (typeof camelRow.id === "string" && camelRow.id.length > 0) {
setNoLog(camelRow.id, camelRow.noLog === true);
}
return camelRow;
});
}
export async function getApiKeyById(id: string) {
const db = getDbInstance() as ApiKeysDbLike;
const stmt = getPreparedStatements(db);
const row = stmt.getKeyById.get(id);
if (!row) return null;
const camelRow = toRecord(rowToCamel(row)) as ApiKeyView;
camelRow.allowedModels = parseAllowedModels(camelRow.allowedModels);
camelRow.blockedModels = parseAllowedModels(camelRow.blockedModels);
camelRow.allowedCombos = parseAllowedCombos(camelRow.allowedCombos);
camelRow.allowedConnections = parseAllowedConnections(camelRow.allowedConnections);
camelRow.allowedQuotas = parseAllowedQuotas((camelRow as JsonRecord).allowedQuotas);
camelRow.noLog = parseNoLog(camelRow.noLog);
camelRow.autoResolve = parseAutoResolve(camelRow.autoResolve);
camelRow.isActive = parseIsActive(camelRow.isActive);
camelRow.accessSchedule = parseAccessSchedule(camelRow.accessSchedule);
camelRow.rateLimits = parseRateLimits(camelRow.rateLimits);
camelRow.isBanned = parseIsBanned(camelRow.isBanned);
camelRow.scopes = parseStringList((camelRow as JsonRecord).scopes);
camelRow.allowedEndpoints = parseStringList((camelRow as JsonRecord).allowedEndpoints);
camelRow.streamDefaultMode = parseStreamDefaultMode((camelRow as JsonRecord).streamDefaultMode);
camelRow.disableNonPublicModels = parseDisableNonPublicModels(
(camelRow as JsonRecord).disableNonPublicModels
);
camelRow.allowUsageCommand = parseAllowUsageCommand((camelRow as JsonRecord).allowUsageCommand);
Object.assign(camelRow, parseApiKeyUsageLimitFields(camelRow));
if (typeof camelRow.id === "string" && camelRow.id.length > 0) {
setNoLog(camelRow.id, camelRow.noLog === true);
}
return camelRow;
}
async function hashKey(key: string): Promise<string> {
if (!key || typeof key !== "string") return "";
// CodeQL: This is intentionally SHA-256, NOT password hashing. API keys are
// high-entropy random tokens (not user-chosen passwords) and need fast O(1)
// comparison for per-request validation. bcrypt/scrypt would add ~100ms per
// request, which is unacceptable for an API proxy.
// lgtm[js/insufficient-password-hash]
return createHash("sha256").update(key).digest("hex"); // nosemgrep: insufficient-password-hash
}
export async function createApiKey(name: string, machineId: string, scopes: string[] = []) {
if (!machineId) {
throw new Error("machineId is required");
}
const db = getDbInstance() as ApiKeysDbLike;
const now = new Date().toISOString();
const { generateApiKeyWithMachine } = await import("@/shared/utils/apiKey");
const result = generateApiKeyWithMachine(machineId);
const apiKey = {
id: uuidv4(),
name: name,
key: result.key,
machineId: machineId,
allowedModels: [], // Empty array means all models allowed
allowedCombos: [], // Empty array means no explicit combo restriction
allowedConnections: [], // Empty array means all connections allowed
noLog: false,
allowUsageCommand: false,
createdAt: now,
scopes,
};
const stmt = getPreparedStatements(db);
stmt.insertKey.run(
apiKey.id,
apiKey.name,
apiKey.key,
apiKey.machineId,
"[]",
0,
apiKey.createdAt,
apiKey.key.slice(0, 12),
await hashKey(apiKey.key),
JSON.stringify(scopes)
);
setNoLog(apiKey.id, false);
backupDbFile("pre-write");
return apiKey;
}
export async function regenerateApiKey(id: string) {
const db = getDbInstance() as ApiKeysDbLike;
const stmt = getPreparedStatements(db);
const row = stmt.getKeyById.get(id) as ApiKeyRow | undefined;
if (!row) return null;
const { generateApiKeyWithMachine } = await import("@/shared/utils/apiKey");
const machineId = (row.machine_id || row.machineId || "0000000000000000") as string;
const { key: newKey } = generateApiKeyWithMachine(machineId);
const newHash = await hashKey(newKey);
const newPrefix = newKey.slice(0, 12);
// Update in DB
const updateStmt = db.prepare(
"UPDATE api_keys SET key = ?, key_hash = ?, key_prefix = ? WHERE id = ?"
);
updateStmt.run(newKey, newHash, newPrefix, id);
// Invalidate all caches
clearApiKeyCaches();
await deleteRedisAuthCacheEntries(row.key_hash, newHash);
const { logAuditEvent } = await import("@/lib/compliance");
logAuditEvent({
action: "apiKey.regenerate",
target: id,
details: { name: String(row.name || "") },
});
return { id, key: newKey };
}
export async function updateApiKeyPermissions(
id: string,
update:
| string[]
| {
name?: string;
allowedModels?: string[];
blockedModels?: string[];
allowedCombos?: string[];
allowedConnections?: string[];
allowedQuotas?: string[];
noLog?: boolean;
autoResolve?: boolean;
isActive?: boolean;
accessSchedule?: AccessSchedule | null;
maxRequestsPerDay?: number | null;
maxRequestsPerMinute?: number | null;
throttleDelayMs?: number | null;
rateLimits?: RateLimitRule[] | null;
isBanned?: boolean;
expiresAt?: string | null;
// T08: max concurrent sessions for this key (0 = unlimited)
maxSessions?: number | null;
scopes?: string[] | null;
proxyId?: string | null;
allowedEndpoints?: string[] | null;
streamDefaultMode?: "legacy" | "json" | null;
disableNonPublicModels?: boolean;
allowUsageCommand?: boolean;
usageLimitEnabled?: boolean;
dailyUsageLimitUsd?: number | null;
weeklyUsageLimitUsd?: number | null;
}
) {
const db = getDbInstance() as ApiKeysDbLike;
getPreparedStatements(db);
const normalized =
Array.isArray(update) || update === undefined
? { allowedModels: update || [] }
: {
name: update.name,
allowedModels: update.allowedModels,
blockedModels: update.blockedModels,
allowedCombos: update.allowedCombos,
allowedConnections: update.allowedConnections,
allowedQuotas: (update as { allowedQuotas?: string[] }).allowedQuotas,
noLog: update.noLog,
autoResolve: update.autoResolve,
isActive: update.isActive,
accessSchedule: update.accessSchedule,
maxRequestsPerDay: update.maxRequestsPerDay,
maxRequestsPerMinute: update.maxRequestsPerMinute,
throttleDelayMs: update.throttleDelayMs,
rateLimits: update.rateLimits,
isBanned: update.isBanned,
expiresAt: update.expiresAt,
maxSessions: (update as { maxSessions?: number | null }).maxSessions,
scopes: (update as { scopes?: string[] | null }).scopes,
proxyId: (update as { proxyId?: string | null }).proxyId,
allowedEndpoints: (update as { allowedEndpoints?: string[] | null }).allowedEndpoints,
streamDefaultMode: (update as { streamDefaultMode?: "legacy" | "json" | null })
.streamDefaultMode,
disableNonPublicModels: (update as { disableNonPublicModels?: boolean })
.disableNonPublicModels,
allowUsageCommand: (update as { allowUsageCommand?: boolean }).allowUsageCommand,
usageLimitEnabled: (update as { usageLimitEnabled?: boolean }).usageLimitEnabled,
dailyUsageLimitUsd: (update as { dailyUsageLimitUsd?: number | null }).dailyUsageLimitUsd,
weeklyUsageLimitUsd: (update as { weeklyUsageLimitUsd?: number | null })
.weeklyUsageLimitUsd,
};
if (
normalized.name === undefined &&
normalized.allowedModels === undefined &&
normalized.blockedModels === undefined &&
normalized.allowedCombos === undefined &&
normalized.allowedConnections === undefined &&
(normalized as Record<string, unknown>).allowedQuotas === undefined &&
normalized.noLog === undefined &&
normalized.autoResolve === undefined &&
normalized.isActive === undefined &&
normalized.accessSchedule === undefined &&
normalized.maxRequestsPerDay === undefined &&
normalized.maxRequestsPerMinute === undefined &&
normalized.throttleDelayMs === undefined &&
normalized.rateLimits === undefined &&
normalized.isBanned === undefined &&
normalized.expiresAt === undefined &&
(normalized as Record<string, unknown>).maxSessions === undefined &&
(normalized as Record<string, unknown>).scopes === undefined &&
(normalized as Record<string, unknown>).proxyId === undefined &&
(normalized as Record<string, unknown>).allowedEndpoints === undefined &&
(normalized as Record<string, unknown>).streamDefaultMode === undefined &&
normalized.disableNonPublicModels === undefined &&
normalized.allowUsageCommand === undefined &&
!hasUsageLimitUpdate(normalized as Record<string, unknown>)
) {
return false;
}
const updates: string[] = [];
const params: {
id: string;
name?: string;
allowedModels?: string;
blockedModels?: string;
allowedCombos?: string;
allowedConnections?: string;
allowedQuotas?: string;
noLog?: number;
autoResolve?: number;
isActive?: number;
accessSchedule?: string | null;
maxRequestsPerDay?: number | null;
maxRequestsPerMinute?: number | null;
throttleDelayMs?: number | null;
rateLimits?: string | null;
isBanned?: number;
maxSessions?: number;
expiresAt?: string | null;
scopes?: string;
proxyId?: string | null;
streamDefaultMode?: "legacy" | "json";
disableNonPublicModels?: number;
allowUsageCommand?: number;
usageLimitEnabled?: number;
dailyUsageLimitUsd?: number | null;
weeklyUsageLimitUsd?: number | null;
} = { id };
if (normalized.name !== undefined) {
updates.push("name = @name");
params.name = normalized.name;
}
if (normalized.allowedModels !== undefined) {
// Empty array means all models are allowed
updates.push("allowed_models = @allowedModels");
params.allowedModels = JSON.stringify(normalized.allowedModels || []);
}
if (normalized.blockedModels !== undefined) {
// Deny-list patterns always take precedence over allowed_models.
updates.push("blocked_models = @blockedModels");
params.blockedModels = JSON.stringify(normalized.blockedModels || []);
}
if (normalized.allowedCombos !== undefined) {
// Empty array means no explicit combo restriction; legacy allowed_models rules still apply.
updates.push("allowed_combos = @allowedCombos");
params.allowedCombos = JSON.stringify(normalized.allowedCombos || []);
}
if (normalized.allowedConnections !== undefined) {
// Empty array means all connections are allowed
updates.push("allowed_connections = @allowedConnections");
params.allowedConnections = JSON.stringify(normalized.allowedConnections || []);
}
const allowedQuotasUpdate = (normalized as Record<string, unknown>).allowedQuotas;
if (allowedQuotasUpdate !== undefined) {
// Empty array means no quota-pool restriction; non-empty restricts to listed pools
updates.push("allowed_quotas = @allowedQuotas");
const nextQuotas: string[] = Array.isArray(allowedQuotasUpdate)
? (allowedQuotasUpdate as unknown[]).filter((s): s is string => typeof s === "string")
: [];
params.allowedQuotas = JSON.stringify(nextQuotas);
}
if (normalized.noLog !== undefined) {
updates.push("no_log = @noLog");
params.noLog = normalized.noLog ? 1 : 0;
}
if (normalized.autoResolve !== undefined) {
updates.push("auto_resolve = @autoResolve");
params.autoResolve = normalized.autoResolve ? 1 : 0;
}
if (normalized.isActive !== undefined) {
updates.push("is_active = @isActive");
params.isActive = normalized.isActive ? 1 : 0;
}
if (normalized.accessSchedule !== undefined) {
updates.push("access_schedule = @accessSchedule");
params.accessSchedule =
normalized.accessSchedule !== null ? JSON.stringify(normalized.accessSchedule) : null;
}
if (normalized.maxRequestsPerDay !== undefined) {
updates.push("max_requests_per_day = @maxRequestsPerDay");
params.maxRequestsPerDay = normalized.maxRequestsPerDay;
}
if (normalized.maxRequestsPerMinute !== undefined) {
updates.push("max_requests_per_minute = @maxRequestsPerMinute");
params.maxRequestsPerMinute = normalized.maxRequestsPerMinute;
}
if (normalized.throttleDelayMs !== undefined) {
updates.push("throttle_delay_ms = @throttleDelayMs");
params.throttleDelayMs = normalized.throttleDelayMs;
}
if (normalized.rateLimits !== undefined) {
updates.push("rate_limits = @rateLimits");
params.rateLimits =
normalized.rateLimits !== null ? JSON.stringify(normalized.rateLimits) : null;
}
if (normalized.isBanned !== undefined) {
updates.push("is_banned = @isBanned");
params.isBanned = normalized.isBanned ? 1 : 0;
}
if (normalized.expiresAt !== undefined) {
updates.push("expires_at = @expiresAt");
params.expiresAt = normalized.expiresAt;
}
if (normalized.disableNonPublicModels !== undefined) {
updates.push("disable_non_public_models = @disableNonPublicModels");
params.disableNonPublicModels = normalized.disableNonPublicModels ? 1 : 0;
}
if (normalized.allowUsageCommand !== undefined) {
updates.push("allow_usage_command = @allowUsageCommand");
params.allowUsageCommand = normalized.allowUsageCommand ? 1 : 0;
}
appendUsageLimitUpdates(normalized as Record<string, unknown>, updates, params);
const maxSessionsUpdate = (normalized as Record<string, unknown>).maxSessions;
if (maxSessionsUpdate !== undefined) {
updates.push("max_sessions = @maxSessions");
params.maxSessions = typeof maxSessionsUpdate === "number" ? Math.max(0, maxSessionsUpdate) : 0;
}
const proxyIdUpdate = (normalized as Record<string, unknown>).proxyId;
if (proxyIdUpdate !== undefined) {
updates.push("proxy_id = @proxyId");
params.proxyId =
typeof proxyIdUpdate === "string" && proxyIdUpdate.trim() !== "" ? proxyIdUpdate : null;
}
const allowedEndpointsUpdate = (normalized as Record<string, unknown>).allowedEndpoints;
if (allowedEndpointsUpdate !== undefined) {
updates.push("allowed_endpoints = @allowedEndpoints");
const nextEndpoints: string[] = Array.isArray(allowedEndpointsUpdate)
? (allowedEndpointsUpdate as unknown[]).filter((s): s is string => typeof s === "string")
: [];
(params as Record<string, unknown>).allowedEndpoints = JSON.stringify(nextEndpoints);
}
const streamDefaultModeUpdate = (normalized as Record<string, unknown>).streamDefaultMode;
if (streamDefaultModeUpdate !== undefined) {
updates.push("stream_default_mode = @streamDefaultMode");
params.streamDefaultMode = parseStreamDefaultMode(streamDefaultModeUpdate);
}
const scopesUpdate = (normalized as Record<string, unknown>).scopes;
const nextScopes: string[] = Array.isArray(scopesUpdate)
? (scopesUpdate as unknown[]).filter((s): s is string => typeof s === "string")
: [];
// Capture previous scopes BEFORE the UPDATE so we can compare for the audit
// event below. We only fetch when the caller is actually changing scopes β
// a privileged change ("manage" grants management API surface access) that
// must always leave an audit trail per OWASP A09 / SOC2 CC7.2.
//
// The previous-scopes SELECT and the row UPDATE are wrapped in a single
// transaction so a concurrent writer cannot slip in between and make the
// audit log lie about what changed. SQLite is single-writer in practice,
// but the transaction also gives us atomicity if the underlying driver
// ever swaps to a backend that allows multiple writers (sqljsAdapter /
// nodeSqliteAdapter fall-back per v3.8.1 db driver cascade).
let previousScopes: string[] = [];
let changedRows = 0;
if (scopesUpdate !== undefined) {
updates.push("scopes = @scopes");
params.scopes = JSON.stringify(nextScopes);
// SELECT-then-UPDATE wrapped in an explicit transaction so a concurrent
// writer can't slip between the read and the write and make the audit
// log lie about what changed. `exec("BEGIN"/"COMMIT")` works across all
// driver backends (better-sqlite3 / node:sqlite / sql.js) wired by the
// v3.8.1 db driver cascade β none of them expose `db.transaction()` via
// ApiKeysDbLike, which is intentionally minimal.
db.exec("BEGIN IMMEDIATE");
try {
const prevRow = db
.prepare<{ scopes: string | null }>("SELECT scopes FROM api_keys WHERE id = ?")
.get(id);
previousScopes = parseStringList(prevRow?.scopes ?? null);
const upd = db
.prepare(`UPDATE api_keys SET ${updates.join(", ")} WHERE id = @id`)
.run(params);
changedRows = upd.changes ?? 0;
db.exec("COMMIT");
} catch (err) {
// Guard the ROLLBACK: if it throws (e.g. transaction already ended
// due to an implicit commit, or backend in a bad state), the original
// error from the try block is the actionable one β don't shadow it.
try {
db.exec("ROLLBACK");
} catch {
// swallow: original error is more important
}
throw err;
}
} else {
const upd = db.prepare(`UPDATE api_keys SET ${updates.join(", ")} WHERE id = @id`).run(params);
changedRows = upd.changes ?? 0;
}
if (changedRows === 0) return false;
const { logAuditEvent } = await import("@/lib/compliance");
if (normalized.isBanned !== undefined) {
logAuditEvent({
action: normalized.isBanned ? "apiKey.ban" : "apiKey.unban",
target: id,
});
}
if (normalized.isActive !== undefined) {
logAuditEvent({
action: normalized.isActive ? "apiKey.activate" : "apiKey.deactivate",
target: id,
});
}
if (scopesUpdate !== undefined) {
// Compare prev vs next scope sets and emit a dedicated audit event when
// the privileged "manage" scope is granted or revoked. Other scope
// mutations also emit a generic "apiKey.scopes.update" so the audit log
// captures the full change history (action + details).
const hadManage = previousScopes.includes("manage");
const hasManage = nextScopes.includes("manage");
if (!hadManage && hasManage) {
logAuditEvent({
action: "apiKey.scopes.grant",
target: id,
details: { scopes: nextScopes, previous: previousScopes },
});
} else if (hadManage && !hasManage) {
logAuditEvent({
action: "apiKey.scopes.revoke",
target: id,
details: { scopes: nextScopes, previous: previousScopes },
});
} else if (
previousScopes.length !== nextScopes.length ||
previousScopes.some((s) => !nextScopes.includes(s)) ||
nextScopes.some((s) => !previousScopes.includes(s))
) {
logAuditEvent({
action: "apiKey.scopes.update",
target: id,
details: { scopes: nextScopes, previous: previousScopes },
});
}
}
if (normalized.noLog !== undefined) {
setNoLog(id, normalized.noLog);
}
// Invalidate caches since permissions changed
invalidateCaches();
await deleteRedisAuthCacheForKeyId(db, id);
backupDbFile("pre-write");
return true;
}
export async function deleteApiKey(id: string) {
const db = getDbInstance() as ApiKeysDbLike;
const stmt = getPreparedStatements(db);
const row = stmt.getKeyById.get(id) as ApiKeyRow | undefined;
const result = stmt.deleteKey.run(id);
if (result.changes === 0) return false;
db.prepare("DELETE FROM domain_budgets WHERE api_key_id = ?").run(id);
db.prepare("DELETE FROM domain_cost_history WHERE api_key_id = ?").run(id);
setNoLog(id, false);
// Invalidate caches since a key was removed
invalidateCaches();
await deleteRedisAuthCacheEntry(row?.key_hash);
backupDbFile("pre-write");
return true;
}
/**
* Revoke an API key by id. Logical, not destructive: the row stays so it can
* be audited, but validateApiKey() rejects it immediately after caches expire
* (or sooner because invalidateCaches() runs here).
*/
export async function revokeApiKey(id: string): Promise<boolean> {
const db = getDbInstance() as ApiKeysDbLike;
getPreparedStatements(db);
const result = db
.prepare(
"UPDATE api_keys SET revoked_at = COALESCE(revoked_at, @ts), is_active = 0 WHERE id = @id"
)
.run({ id, ts: new Date().toISOString() });
if ((result.changes ?? 0) === 0) return false;
invalidateCaches();
await deleteRedisAuthCacheForKeyId(db, id);
backupDbFile("pre-write");
return true;
}
/**
* Set or clear the expiry of an API key. Pass null to remove the expiry.
*/
export async function setApiKeyExpiry(id: string, expiresAt: string | null): Promise<boolean> {
const db = getDbInstance() as ApiKeysDbLike;
getPreparedStatements(db);
const result = db
.prepare("UPDATE api_keys SET expires_at = @expiresAt WHERE id = @id")
.run({ id, expiresAt });
if ((result.changes ?? 0) === 0) return false;
invalidateCaches();
await deleteRedisAuthCacheForKeyId(db, id);
backupDbFile("pre-write");
return true;
}
/**
* Validate API key with lifecycle gates and caching.
*
* A key is valid only when ALL of the following are true:
* - the row exists,
* - is_active = 1,
* - revoked_at IS NULL,
* - expires_at IS NULL OR expires_at > now.
*
* Cache TTL is short (CACHE_TTL) and the metadata cache is also invalidated
* by revokeApiKey/updateApiKeyPermissions/deleteApiKey, so a revoke takes
* effect within at most CACHE_TTL even without an explicit clear in the
* caller.
*/
export async function validateApiKey(key: string | null | undefined) {
if (!key || typeof key !== "string") return false;
if (isConfiguredEnvApiKey(key)) return true;
const now = Date.now();
const hashedKey = await hashKey(key);
const cacheKey = hashedKey;
const cached = _keyValidationCache.get(cacheKey);
if (cached && now - cached.timestamp < CACHE_TTL) {
return cached.valid;
}
if (isRedisAuthCacheEnabled()) {
// Try Redis cache for multi-instance consistency
try {
const { getRedisClient, isRedisConfigured } = await import("@/shared/utils/rateLimiter");
if (isRedisConfigured()) {
const redis = getRedisClient();
const redisKey = `auth:api_key:${hashedKey}`;
const redisData = await redis.get(redisKey);
if (redisData) {
const data = JSON.parse(redisData);
const isBanned = !!data.isBanned;
const isActive = !!data.isActive;
const revokedAt = data.revokedAt;
const expiresAt = data.expiresAt;
if (isBanned || !isActive) return false;
if (typeof revokedAt === "string" && revokedAt.trim() !== "") return false;
if (typeof expiresAt === "string" && expiresAt.trim() !== "") {
const expiresMs = Date.parse(expiresAt);
if (Number.isFinite(expiresMs) && expiresMs <= now) return false;
}
return true;
}
}
} catch {
// Redis lookup failures fall through to SQLite.
}
}
const db = getDbInstance() as ApiKeysDbLike;
const stmt = getPreparedStatements(db);
const row = stmt.validateKey.get(key, hashedKey) as JsonRecord | undefined;
if (!row) return false;
const isBanned = parseIsBanned(row.is_banned ?? row.isBanned);
if (isBanned) return false;
const isActive = parseIsActive(row.is_active ?? row.isActive);
if (!isActive) return false;
const revokedAt = row.revoked_at ?? row.revokedAt;
if (typeof revokedAt === "string" && revokedAt.trim() !== "") return false;
const expiresAt = row.expires_at ?? row.expiresAt;
if (typeof expiresAt === "string" && expiresAt.trim() !== "") {
const expiresMs = Date.parse(expiresAt);
if (Number.isFinite(expiresMs) && expiresMs <= now) return false;
}
evictIfNeeded(_keyValidationCache);
_keyValidationCache.set(cacheKey, { valid: true, timestamp: now });
if (isRedisAuthCacheEnabled()) {
// Update Redis cache for fast validation
try {
const { getRedisClient, isRedisConfigured } = await import("@/shared/utils/rateLimiter");
if (isRedisConfigured()) {
const redis = getRedisClient();
const redisKey = `auth:api_key:${hashedKey}`;
await redis.set(
redisKey,
JSON.stringify({
id: row.id,
isBanned: parseIsBanned(row.is_banned),
isActive: parseIsActive(row.is_active),
expiresAt: row.expires_at,
revokedAt: row.revoked_at,
}),
"EX",
3600 // 1 hour cache
);
}
} catch {
// Redis cache update failures do not block successful SQLite validation.
}
}
markApiKeyUsed(db, row.id, now);
return true;
}
/**
* Get API key metadata with caching for performance
*/
export async function getApiKeyMetadata(
key: string | null | undefined
): Promise<ApiKeyMetadata | null> {
if (!key || typeof key !== "string") return null;
const now = Date.now();
// persistent env-var key support (persistent passthrough keys) (#1350)
if (isConfiguredEnvApiKey(key)) {
// βββ Env-key management-scope bypass ββββββββββββββββββββββββββββββββββ
// The deployment-time env key (`OMNIROUTE_API_KEY` / `ROUTER_API_KEY`)
// is granted the "manage" scope unconditionally. This is intentional:
//
// 1. The env key never exists in the SQLite `api_keys` table, so the
// DB-backed scopes column does not apply. We synthesize the
// metadata record here.
// 2. The operator who set the env var is presumed to be the deployment
// owner; rotating (or unsetting) the env var is the only way to
// rotate this privilege. There is no UI to change it.
// 3. Management API access via the env key still passes through
// `requireManagementAuth` β `hasManageScope`, so policy decisions
// remain centralised in `src/server/authz/*`.
// 4. Requests authenticated by the env key are tagged with
// `id: "env-key"` for downstream audit-log emitters, making it
// possible to distinguish env-key activity from user-created keys
// that happen to also hold "manage".
//
// DO NOT remove "manage" from this list β that would break the
// deployment-time bootstrap path that operators rely on for headless
// / CI / first-boot scenarios. If you need to disable env-key access,
// unset the env var instead.
return {
id: "env-key",
name: "Environment Key",
machineId: "server-env",
allowedModels: [],
blockedModels: [],
allowedCombos: [],
allowedConnections: [],
allowedQuotas: [],
noLog: false,
autoResolve: true,
isActive: true,
accessSchedule: null,
rateLimits: null,
maxRequestsPerDay: null,
maxRequestsPerMinute: null,
throttleDelayMs: null,
maxSessions: 0,
revokedAt: null,
expiresAt: null,
ipAllowlist: [],
isBanned: false,
keyHash: null,
scopes: ["manage"],
proxyId: null,
allowedEndpoints: [],
streamDefaultMode: "legacy",
disableNonPublicModels: false,
allowUsageCommand: false,
usageLimitEnabled: false,
dailyUsageLimitUsd: null,
weeklyUsageLimitUsd: null,
};
}
// Check cache first
const hashedKey = await hashKey(key);
const cached = _keyMetadataCache.get(hashedKey);
if (cached && now - cached.timestamp < CACHE_TTL) {
return cached.value;
}
const db = getDbInstance() as ApiKeysDbLike;
const stmt = getPreparedStatements(db);
const row = stmt.getKeyMetadata.get(key, hashedKey);
if (!row) return null;
const record = toRecord(row) as ApiKeyRow;
const metadataId = typeof record.id === "string" ? record.id : "";
const metadataName = typeof record.name === "string" ? record.name : "";
const machineIdRaw = record.machine_id ?? record.machineId;
const metadataMachineId = typeof machineIdRaw === "string" ? machineIdRaw : null;
const rawMaxRPD = record.max_requests_per_day ?? record.maxRequestsPerDay;
const rawMaxRPM = record.max_requests_per_minute ?? record.maxRequestsPerMinute;
const rawThrottleDelayMs = record.throttle_delay_ms ?? (record as JsonRecord).throttleDelayMs;
const rawMaxSessions = record.max_sessions ?? record.maxSessions;
const metadata: ApiKeyMetadata = {
id: metadataId,
name: metadataName,
machineId: metadataMachineId,
allowedModels: parseAllowedModels(record.allowed_models ?? record.allowedModels),
blockedModels: parseAllowedModels(record.blocked_models ?? record.blockedModels),
allowedCombos: parseAllowedCombos(record.allowed_combos ?? record.allowedCombos),
allowedConnections: parseAllowedConnections(
record.allowed_connections ?? record.allowedConnections
),
allowedQuotas: parseAllowedQuotas(
(record as JsonRecord).allowed_quotas ?? (record as JsonRecord).allowedQuotas
),
noLog: parseNoLog(record.no_log ?? record.noLog),
autoResolve: parseAutoResolve(record.auto_resolve ?? record.autoResolve),
isActive: parseIsActive(record.is_active ?? record.isActive),
accessSchedule: parseAccessSchedule(record.access_schedule ?? record.accessSchedule),
rateLimits: parseRateLimits(record.rate_limits ?? (record as JsonRecord).rateLimits),
maxRequestsPerDay: typeof rawMaxRPD === "number" && rawMaxRPD > 0 ? rawMaxRPD : null,
maxRequestsPerMinute: typeof rawMaxRPM === "number" && rawMaxRPM > 0 ? rawMaxRPM : null,
throttleDelayMs:
typeof rawThrottleDelayMs === "number" && rawThrottleDelayMs > 0 ? rawThrottleDelayMs : null,
// T08: max concurrent sessions; 0 = unlimited (default & backward-compatible)
maxSessions: typeof rawMaxSessions === "number" && rawMaxSessions > 0 ? rawMaxSessions : 0,
revokedAt: parseNullableTimestamp(record.revoked_at ?? (record as JsonRecord).revokedAt),
expiresAt: parseNullableTimestamp(record.expires_at ?? (record as JsonRecord).expiresAt),
ipAllowlist: parseStringList(record.ip_allowlist ?? (record as JsonRecord).ipAllowlist),
scopes: parseStringList((record as JsonRecord).scopes),
isBanned: parseIsBanned(record.is_banned ?? (record as JsonRecord).isBanned),
keyHash: (record.key_hash ?? (record as JsonRecord).keyHash) as string | null,
proxyId:
typeof record.proxy_id === "string" && record.proxy_id.trim() !== "" ? record.proxy_id : null,
allowedEndpoints: parseStringList(
(record as JsonRecord).allowed_endpoints ?? (record as JsonRecord).allowedEndpoints
),
streamDefaultMode: parseStreamDefaultMode(
(record as JsonRecord).stream_default_mode ?? (record as JsonRecord).streamDefaultMode
),
disableNonPublicModels: parseDisableNonPublicModels(
(record as JsonRecord).disable_non_public_models ??
(record as JsonRecord).disableNonPublicModels
),
allowUsageCommand: parseAllowUsageCommand(
(record as JsonRecord).allow_usage_command ?? (record as JsonRecord).allowUsageCommand
),
...parseApiKeyUsageLimitFields(record as JsonRecord),
};
if (!metadata.id) {
return null;
}
setNoLog(metadata.id, metadata.noLog === true);
// Cache the result
evictIfNeeded(_keyMetadataCache);
_keyMetadataCache.set(hashedKey, { value: metadata, timestamp: now });
return metadata;
}
/**
* Check if a model is allowed for a given API key
* @param {string} key - The API key
* @param {string} modelId - The model ID to check
* @returns {boolean} - true if allowed, false if not
*/
export async function isModelAllowedForKey(
key: string | null | undefined,
modelId: string | null | undefined
) {
// If no key provided, allow (request may be using different auth method like JWT)
// If no modelId provided, deny (invalid request)
if (!key) return true;
if (!modelId) return false;
// Create cache key
const cacheKey = `${key}:${modelId}`;
const now = Date.now();
const usesSettingDependentClaudeRouting = isPotentialUnprefixedClaudeCodeModel(modelId);
// Check permission cache
const cached = _modelPermissionCache.get(cacheKey);
if (!usesSettingDependentClaudeRouting && cached && now - cached.timestamp < CACHE_TTL) {
return cached.allowed;
}
const metadata = await getApiKeyMetadata(key);
// SECURITY: Key not found in database = deny access (invalid/non-existent key)
if (!metadata) return false;
const { allowedModels, blockedModels, disableNonPublicModels } = metadata;
const modelPermissionCandidates = await getModelPermissionCandidates(modelId);
// Deny-list patterns win over any allow-list entry. This lets operators keep
// broad dynamic scopes like cc/* while excluding expensive families.
if (blockedModels?.some((pattern) => modelPatternMatches(pattern, modelPermissionCandidates))) {
return false;
}
// Check disableNonPublicModels flag
if (disableNonPublicModels) {
const resolvedModelId = resolveModelAlias(modelId);
const effectiveModelId = resolvedModelId || modelId;
if (!hasClaudeCodeWildcardPermission(allowedModels, modelPermissionCandidates)) {
const lookupTarget = await getPublishedModelLookupTarget(effectiveModelId);
const providerId = lookupTarget?.providerId || effectiveModelId.split("/")[0];
const shortModelId = lookupTarget?.modelId || effectiveModelId.split("/").slice(1).join("/");
if (!providerId || !shortModelId) return false;
const syncedModelsByConnection = await getSyncedAvailableModelsByConnection(providerId);
const customModels = await getCustomModels(providerId);
// Combine synced and custom models
const allDiscoveredModels = Object.values(syncedModelsByConnection)
.flat()
.concat(customModels);
const discovered = allDiscoveredModels.some((m) => m.id === shortModelId);
if (!discovered) return false;
const isPublic = !getModelIsHidden(providerId, shortModelId);
if (!isPublic) return false;
}
}
// Empty array means all models allowed
if (!allowedModels || allowedModels.length === 0) {
return true;
}
let allowed = false;
// Check if model matches each allowed pattern
// Support exact match and prefix match (e.g., "openai/*" allows all OpenAI models)
for (const pattern of allowedModels) {
if (modelPatternMatches(pattern, modelPermissionCandidates)) {
allowed = true;
break;
}
}
// If key belongs to groups, also check group-level permissions
if (metadata.id) {
const groupAccess = checkKeyModelAccess(metadata.id, modelId || "");
if (!groupAccess.allowed) {
allowed = false;
}
}
// Cache the result
if (!usesSettingDependentClaudeRouting) {
evictIfNeeded(_modelPermissionCache);
_modelPermissionCache.set(cacheKey, { allowed, timestamp: now });
}
return allowed;
}
/**
* Clear prepared statements cache (called on database reset/restore)
* Prepared statements are bound to a specific database connection,
* so they must be cleared when the connection is reset.
*/
function clearPreparedStatementCache() {
_stmtGetAllKeys = null;
_stmtGetKeyById = null;
_stmtValidateKey = null;
_stmtGetKeyMetadata = null;
_stmtInsertKey = null;
_stmtDeleteKey = null;
_schemaChecked = false; // Also reset schema check for new connection
}
/**
* Clear all caches (exported for testing/debugging)
*/
export function clearApiKeyCaches() {
invalidateCaches();
_lastUsedUpdateCache.clear();
_modelPermissionCache.clear();
}
/**
* Reset all cached state for database connection reset/restore.
* Called by backup.ts when the database is restored.
*/
export function resetApiKeyState() {
clearPreparedStatementCache();
clearApiKeyCaches();
}
registerDbStateResetter(resetApiKeyState);
|