Skip to content

🪢 Open source agent evals & observability: Trace, evaluate, and improve LLM applications with one open platform.

feat(api-keys): stop computing bcrypt for new API keys (#18442)

Steffen Reuther42ba3c5f636b
diff --git a/packages/shared/prisma/schema.prisma b/packages/shared/prisma/schema.prisma
index 8796ba524e..822440ce32 100644
--- a/packages/shared/prisma/schema.prisma
+++ b/packages/shared/prisma/schema.prisma
@@ -222,6 +222,7 @@ model ApiKey {
createdAt DateTime @default(now()) @map("created_at")
note String?
publicKey String @unique @map("public_key")
+ // bcrypt hash for keys created before fastHashedSecretKey existed; newer keys store a non-secret placeholder
hashedSecretKey String @unique @map("hashed_secret_key")
fastHashedSecretKey String? @unique @map("fast_hashed_secret_key")
displaySecretKey String @map("display_secret_key")
diff --git a/packages/shared/scripts/seeder/load-seed-clickhouse.ts b/packages/shared/scripts/seeder/load-seed-clickhouse.ts
index 15e86a7b05..6c93d784d3 100644
--- a/packages/shared/scripts/seeder/load-seed-clickhouse.ts
+++ b/packages/shared/scripts/seeder/load-seed-clickhouse.ts
@@ -1,6 +1,10 @@
import { randomUUID } from "crypto";
import { prisma } from "../../src/db";
-import { getDisplaySecretKey, hashSecretKey, logger } from "../../src/server";
+import {
+ createLegacySecretKeyPlaceholder,
+ getDisplaySecretKey,
+ logger,
+} from "../../src/server";
import { assignRole } from "../../src/features/rbac/roleAssignmentRepository";
import {
ApiKeyId,
@@ -55,16 +59,14 @@ const prepareProjectsAndApiKeys = async (
where: { id: apiKeyId },
});
if (!apiKeyExists) {
- const sk = await hashSecretKey(
- `sk-${Math.random().toString(36).slice(2, 11)}`,
- );
+ const sk = `sk-lf-${randomUUID()}`;
await prisma.$transaction(async (tx) => {
await tx.apiKey.create({
data: {
id: apiKeyId,
note: `API Key for ${projectId}`,
publicKey: `pk-${Math.random().toString(36).slice(2, 11)}`,
- hashedSecretKey: sk,
+ hashedSecretKey: createLegacySecretKeyPlaceholder(),
displaySecretKey: getDisplaySecretKey(sk),
scope: "PROJECT",
project: {
diff --git a/packages/shared/src/server/auth/apiKeys.test.ts b/packages/shared/src/server/auth/apiKeys.test.ts
index c514182e52..fd7a5b20dc 100644
--- a/packages/shared/src/server/auth/apiKeys.test.ts
+++ b/packages/shared/src/server/auth/apiKeys.test.ts
@@ -7,8 +7,10 @@ vi.mock("../../env", () => ({ env: { SALT: "test-salt" } }));
import {
createApiKey,
+ createShaHash,
formatSubmittedPublicKeyForLog,
redactLangfuseSecretKeys,
+ verifySecretKey,
} from "./apiKeys";
import {
ApiKeyId,
@@ -190,6 +192,25 @@ describe("createApiKey assignment rows", () => {
expect(tx.project.findFirstOrThrow).not.toHaveBeenCalled();
});
+ it("stores the secret only as a fast hash, with a placeholder no bcrypt check accepts", async () => {
+ const { tx, getApiKeyData } = makeTx();
+
+ const result = await createApiKey(asTx(tx), {
+ owner: ProjectId("proj_1"),
+ role: SystemRoleId("VIEWER"),
+ createdBy: UserId("user_1"),
+ });
+
+ const data = getApiKeyData();
+ expect(data.fastHashedSecretKey).toBe(
+ createShaHash(result.secretKey, "test-salt"),
+ );
+ expect(data.hashedSecretKey).toMatch(/^unused:/);
+ expect(
+ await verifySecretKey(result.secretKey, data.hashedSecretKey as string),
+ ).toBe(false);
+ });
+
it.each(["legacy name", ""])(
"accepts the deprecated note alias %j",
async (note) => {
diff --git a/packages/shared/src/server/auth/apiKeys.ts b/packages/shared/src/server/auth/apiKeys.ts
index 8f027c4e77..ba30a99c27 100644
--- a/packages/shared/src/server/auth/apiKeys.ts
+++ b/packages/shared/src/server/auth/apiKeys.ts
@@ -60,12 +60,22 @@ export function formatSubmittedPublicKeyForLog(value: string): string {
);
}
+/** hashSecretKey produces the legacy bcrypt form of keys created before the fast hash; verification backfills their fast hash on first use. */
export async function hashSecretKey(key: string) {
- // legacy, uses bcrypt, transformed into hashed key upon first use
const hashedKey = await hash(key, 11);
return hashedKey;
}
+/**
+ * createLegacySecretKeyPlaceholder fills the legacy bcrypt column
+ * (hashedSecretKey) of a new key. New keys verify only through their fast
+ * hash, so the column holds a unique non-secret value that no bcrypt
+ * comparison matches.
+ */
+export function createLegacySecretKeyPlaceholder(): string {
+ return `unused:${randomUUID()}`;
+}
+
export async function generateKeySet() {
return {
pk: `pk-lf-${randomUUID()}`,
@@ -151,7 +161,7 @@ export async function createApiKey(
? { orgId: untag(opts.owner) }
: { projectId: untag(opts.owner) }),
publicKey: pk,
- hashedSecretKey: await hashSecretKey(sk),
+ hashedSecretKey: createLegacySecretKeyPlaceholder(),
displaySecretKey: getDisplaySecretKey(sk),
fastHashedSecretKey: createShaHash(sk, salt),
note: name ?? note,