Skip to content

Infisical is the open-source platform for securing secrets, certificates, access, and AI Agents.

feat(cookie): integrate cookie signing key into Fastify server

Victor Hugo dos Santos688f2475b2e4
diff --git a/backend/src/@types/fastify.d.ts b/backend/src/@types/fastify.d.ts
index 9ef137dff4..7934fe2554 100644
--- a/backend/src/@types/fastify.d.ts
+++ b/backend/src/@types/fastify.d.ts
@@ -286,6 +286,7 @@ declare module "fastify" {
interface FastifyInstance {
redis: Redis | Cluster;
+ cookieSigningKey: string;
services: {
login: TAuthLoginFactory;
password: TAuthPasswordFactory;
diff --git a/backend/src/ee/routes/v1/ldap-router.ts b/backend/src/ee/routes/v1/ldap-router.ts
index 84437dd401..34edcad7f1 100644
--- a/backend/src/ee/routes/v1/ldap-router.ts
+++ b/backend/src/ee/routes/v1/ldap-router.ts
@@ -18,7 +18,6 @@ import { TLDAPConfig } from "@app/ee/services/ldap-config/ldap-config-types";
import { isValidLdapFilter, searchGroups } from "@app/ee/services/ldap-config/ldap-fns";
import { ApiDocsTags, LdapSso } from "@app/lib/api-docs";
import { getConfig } from "@app/lib/config/env";
-import { getCookieSigningKey } from "@app/lib/crypto/cookie-signing-key";
import { BadRequestError } from "@app/lib/errors";
import { logger } from "@app/lib/logger";
import { readLimit, writeLimit } from "@app/server/config/rateLimiter";
@@ -31,7 +30,7 @@ import { PostHogEventTypes } from "@app/services/telemetry/telemetry-types";
export const registerLdapRouter = async (server: FastifyZodProvider) => {
const appCfg = getConfig();
const passport = new Authenticator({ key: "ldap", userProperty: "passportUser" });
- await server.register(fastifySession, { secret: getCookieSigningKey() });
+ await server.register(fastifySession, { secret: server.cookieSigningKey });
await server.register(passport.initialize());
await server.register(passport.secureSession());
diff --git a/backend/src/ee/routes/v1/oidc-router.ts b/backend/src/ee/routes/v1/oidc-router.ts
index 0269643075..7a05919e85 100644
--- a/backend/src/ee/routes/v1/oidc-router.ts
+++ b/backend/src/ee/routes/v1/oidc-router.ts
@@ -15,7 +15,6 @@ import { OidcConfigsSchema } from "@app/db/schemas";
import { OIDCConfigurationType, OIDCJWTSignatureAlgorithm } from "@app/ee/services/oidc/oidc-config-types";
import { ApiDocsTags, OidcSSo } from "@app/lib/api-docs";
import { getConfig } from "@app/lib/config/env";
-import { getCookieSigningKey } from "@app/lib/crypto/cookie-signing-key";
import { BadRequestError } from "@app/lib/errors";
import { logger } from "@app/lib/logger";
import { authRateLimit, readLimit, writeLimit } from "@app/server/config/rateLimiter";
@@ -57,7 +56,7 @@ export const registerOidcRouter = async (server: FastifyZodProvider) => {
});
await server.register(fastifySession, {
- secret: getCookieSigningKey(),
+ secret: server.cookieSigningKey,
store: redisStore,
cookie: {
secure: appCfg.HTTPS_ENABLED,
diff --git a/backend/src/ee/routes/v1/saml-router.ts b/backend/src/ee/routes/v1/saml-router.ts
index e3454d3753..24c67b98de 100644
--- a/backend/src/ee/routes/v1/saml-router.ts
+++ b/backend/src/ee/routes/v1/saml-router.ts
@@ -17,7 +17,6 @@ import { z } from "zod";
import { SamlProviders, TGetSamlCfgDTO } from "@app/ee/services/saml-config/saml-config-types";
import { ApiDocsTags, SamlSso } from "@app/lib/api-docs";
import { getConfig } from "@app/lib/config/env";
-import { getCookieSigningKey } from "@app/lib/crypto/cookie-signing-key";
import { BadRequestError } from "@app/lib/errors";
import { logger } from "@app/lib/logger";
import { RequestContextKey } from "@app/lib/request-context/request-context-keys";
@@ -49,7 +48,7 @@ type TSAMLConfig = {
export const registerSamlRouter = async (server: FastifyZodProvider) => {
const appCfg = getConfig();
const passport = new Authenticator({ key: "saml", userProperty: "passportUser" });
- await server.register(fastifySession, { secret: getCookieSigningKey() });
+ await server.register(fastifySession, { secret: server.cookieSigningKey });
await server.register(passport.initialize());
await server.register(passport.secureSession());
server.decorateRequest("ssoConfig");
diff --git a/backend/src/lib/crypto/cookie-signing-key.test.ts b/backend/src/lib/crypto/cookie-signing-key.test.ts
index cedd6d8c2d..c5c46d82de 100644
--- a/backend/src/lib/crypto/cookie-signing-key.test.ts
+++ b/backend/src/lib/crypto/cookie-signing-key.test.ts
@@ -1,4 +1,4 @@
-import { beforeEach, describe, expect, it, vi } from "vitest";
+import { describe, expect, it } from "vitest";
import { deriveSecretValueBlindIndexKey } from "./blind-index";
import { deriveCookieSigningKey } from "./cookie-signing-key";
@@ -41,34 +41,3 @@ describe("deriveCookieSigningKey", () => {
expect(deriveCookieSigningKey(ROOT_KEY)).not.toBe(blindIndexKey.toString("base64"));
});
});
-
-describe("the resolved cookie signing key", () => {
- // The module holds the resolved key as process state, so each case takes a fresh copy rather than
- // inheriting whatever the previous one set.
- beforeEach(() => {
- vi.resetModules();
- });
-
- it("is refused before the root key has been loaded", async () => {
- const { getCookieSigningKey } = await import("./cookie-signing-key");
- expect(() => getCookieSigningKey()).toThrowError(/before the KMS root key was loaded/);
- });
-
- it("returns a configured key verbatim, without deriving or transforming it", async () => {
- const { getCookieSigningKey, setCookieSigningKey } = await import("./cookie-signing-key");
- const configured = "an-operator-supplied-key-of-at-least-32-chars";
-
- setCookieSigningKey(configured);
-
- expect(getCookieSigningKey()).toBe(configured);
- });
-
- it("takes the most recently set key", async () => {
- const { getCookieSigningKey, setCookieSigningKey } = await import("./cookie-signing-key");
-
- setCookieSigningKey("first-key-first-key-first-key-first");
- setCookieSigningKey("second-key-second-key-second-key-se");
-
- expect(getCookieSigningKey()).toBe("second-key-second-key-second-key-se");
- });
-});
diff --git a/backend/src/lib/crypto/cookie-signing-key.ts b/backend/src/lib/crypto/cookie-signing-key.ts
index 2b73ae8720..a9454d21e2 100644
--- a/backend/src/lib/crypto/cookie-signing-key.ts
+++ b/backend/src/lib/crypto/cookie-signing-key.ts
@@ -1,11 +1,7 @@
import crypto from "node:crypto";
-import { InternalServerError } from "@app/lib/errors";
-
const COOKIE_SIGNING_KEY_CONTEXT = "infisical-cookie-signing-key-v1";
-let cookieSigningKey: string | undefined;
-
/**
* Derives the cookie signing key from the KMS root key, which is already generated and persisted
* per instance at first boot. That keeps the key unique to the deployment without a second secret
@@ -13,17 +9,3 @@ let cookieSigningKey: string | undefined;
*/
export const deriveCookieSigningKey = (rootKey: Buffer) =>
Buffer.from(crypto.hkdfSync("sha256", rootKey, Buffer.alloc(0), COOKIE_SIGNING_KEY_CONTEXT, 32)).toString("base64");
-
-export const setCookieSigningKey = (key: string) => {
- cookieSigningKey = key;
-};
-
-export const getCookieSigningKey = () => {
- if (!cookieSigningKey) {
- throw new InternalServerError({
- message: "Cookie signing key was requested before the KMS root key was loaded"
- });
- }
-
- return cookieSigningKey;
-};
diff --git a/backend/src/server/routes/index.ts b/backend/src/server/routes/index.ts
index ac350358b1..cbc7620426 100644
--- a/backend/src/server/routes/index.ts
+++ b/backend/src/server/routes/index.ts
@@ -201,7 +201,6 @@ import { keyValueStoreDALFactory } from "@app/keystore/key-value-store-dal";
import { TKeyStoreFactory } from "@app/keystore/keystore";
import { getConfig, TEnvConfig } from "@app/lib/config/env";
import { cronJobFactory } from "@app/lib/cron/cron-job";
-import { getCookieSigningKey, setCookieSigningKey } from "@app/lib/crypto/cookie-signing-key";
import { crypto } from "@app/lib/crypto/cryptography";
import { BadRequestError } from "@app/lib/errors";
import { initGatewayLoadTracker } from "@app/lib/gateway-v2/gateway-load-tracker";
@@ -3997,9 +3996,9 @@ export const registerRoutes = async (
}
await kmsService.startService(hsmStatus);
- setCookieSigningKey(appCfg.COOKIE_SECRET_SIGN_KEY || kmsService.getCookieSigningKey());
- await server.register<FastifyCookieOptions>(cookie, { secret: getCookieSigningKey() });
+ server.decorate("cookieSigningKey", appCfg.COOKIE_SECRET_SIGN_KEY || kmsService.getCookieSigningKey());
+ await server.register<FastifyCookieOptions>(cookie, { secret: server.cookieSigningKey });
// Register all cron jobs (synchronous registrations) before starting the scheduler
encryptionKeyRotationService.init();
diff --git a/backend/src/server/routes/v1/identity-ldap-auth-router.ts b/backend/src/server/routes/v1/identity-ldap-auth-router.ts
index c998b9a39f..12f7a227c7 100644
--- a/backend/src/server/routes/v1/identity-ldap-auth-router.ts
+++ b/backend/src/server/routes/v1/identity-ldap-auth-router.ts
@@ -18,7 +18,6 @@ import { IdentityLdapAuthsSchema } from "@app/db/schemas/identity-ldap-auths";
import { EventType } from "@app/ee/services/audit-log/audit-log-types";
import { isValidLdapFilter } from "@app/ee/services/ldap-config/ldap-fns";
import { ApiDocsTags, LDAP_AUTH } from "@app/lib/api-docs";
-import { getCookieSigningKey } from "@app/lib/crypto/cookie-signing-key";
import { UnauthorizedError } from "@app/lib/errors";
import { logger } from "@app/lib/logger";
import { readLimit, writeLimit } from "@app/server/config/rateLimiter";
@@ -33,7 +32,7 @@ import { PostHogEventTypes } from "@app/services/telemetry/telemetry-types";
export const registerIdentityLdapAuthRouter = async (server: FastifyZodProvider) => {
const passport = new Authenticator({ key: "ldap-identity-auth", userProperty: "passportMachineIdentity" });
- await server.register(fastifySession, { secret: getCookieSigningKey() });
+ await server.register(fastifySession, { secret: server.cookieSigningKey });
await server.register(passport.initialize());
await server.register(passport.secureSession());
diff --git a/backend/src/server/routes/v1/sso-router.ts b/backend/src/server/routes/v1/sso-router.ts
index ea4ba8715f..48bcdaa2a4 100644
--- a/backend/src/server/routes/v1/sso-router.ts
+++ b/backend/src/server/routes/v1/sso-router.ts
@@ -18,7 +18,6 @@ import { z } from "zod";
import { INFISICAL_PROVIDER_GITHUB_ACCESS_TOKEN } from "@app/lib/config/const";
import { getConfig } from "@app/lib/config/env";
-import { getCookieSigningKey } from "@app/lib/crypto/cookie-signing-key";
import { BadRequestError, NotFoundError } from "@app/lib/errors";
import { logger } from "@app/lib/logger";
import { ms } from "@app/lib/ms";
@@ -426,7 +425,7 @@ export const registerSsoRouter = async (server: FastifyZodProvider) => {
});
await server.register(fastifySession, {
- secret: getCookieSigningKey(),
+ secret: server.cookieSigningKey,
store: redisStore,
cookie: {
secure: appCfg.HTTPS_ENABLED,
diff --git a/backend/src/services/kms/kms-service.test.ts b/backend/src/services/kms/kms-service.test.ts
new file mode 100644
index 0000000000..1a994287f1
--- /dev/null
+++ b/backend/src/services/kms/kms-service.test.ts
@@ -0,0 +1,11 @@
+import { describe, expect, it } from "vitest";
+
+import { kmsServiceFactory } from "./kms-service";
+
+describe("kmsService.getCookieSigningKey", () => {
+ const buildUnstartedService = () => kmsServiceFactory({} as unknown as Parameters<typeof kmsServiceFactory>[0]);
+
+ it("refuses to hand out a key before the root key is loaded", () => {
+ expect(() => buildUnstartedService().getCookieSigningKey()).toThrowError(/KMS root key is not loaded/);
+ });
+});