@vercel/oidc 3.8.10 → 4.0.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @vercel/oidc
 
+## 4.0.0
+
+### Major Changes
+
+- ec76b68: Read the Vercel OIDC token from the file specified by `VERCEL_OIDC_TOKEN_FILE` on each call.
+
 ## 3.8.10
 
 ### Patch Changes

package/dist/get-vercel-oidc-token-with-refresh.d.ts

@@ -48,18 +48,20 @@ export type GetVercelOidcTokenOptions = (GetVercelOidcTokenBaseOptions & {
     skipCache?: never;
 });
 /**
- * Gets the current OIDC token from the request context or the environment variable.
+ * Gets the current OIDC token from the request context, the Vercel OIDC token
+ * file, or the environment variable.
  *
  * Do not cache this value, as it is subject to change in production!
  *
- * This function is used to retrieve the OIDC token from the request context or the environment variable.
- * It checks for the `x-vercel-oidc-token` header in the request context and falls back to the `VERCEL_OIDC_TOKEN` environment variable if the header is not present.
+ * It checks for the `x-vercel-oidc-token` header in the request context, then
+ * reads the file named by `VERCEL_OIDC_TOKEN_FILE` when set, then falls back to
+ * the `VERCEL_OIDC_TOKEN` environment variable.
  *
  * Unlike the `getVercelOidcTokenSync` function, this function will refresh the token if it is expired in a development environment.
  *
  * @param {GetVercelOidcTokenOptions} [options] - Optional configuration for token retrieval.
  * @returns {Promise<string>} A promise that resolves to the OIDC token.
- * @throws {Error} If the `x-vercel-oidc-token` header is missing from the request context and the environment variable `VERCEL_OIDC_TOKEN` is not set. If the token
+ * @throws {Error} If no token source is available or the configured file cannot be read. If the token
  * is expired in a development environment, will also throw an error if the token cannot be refreshed: no CLI credentials are available, CLI credentials are expired, no project configuration is available
  * or the token refresh request fails.
  *

package/dist/get-vercel-oidc-token-with-refresh.js

@@ -31,14 +31,17 @@ __export(get_vercel_oidc_token_with_refresh_exports, {
   getVercelOidcToken: () => getVercelOidcToken
 });
 module.exports = __toCommonJS(get_vercel_oidc_token_with_refresh_exports);
+var import_promises = require("node:fs/promises");
 var import_exchange_vercel_oidc_token = require("./exchange-vercel-oidc-token");
+var import_get_context = require("./get-context");
 var import_get_vercel_oidc_token_sync = require("./get-vercel-oidc-token-sync");
 var import_token_error = require("./token-error");
 async function getVercelOidcToken(options) {
   let token = "";
   let err;
+  const tokenFromFile = (0, import_get_context.getContext)().headers?.["x-vercel-oidc-token"] ? null : await tryOidcTokenFromFile();
   try {
-    token = (0, import_get_vercel_oidc_token_sync.getVercelOidcTokenSync)();
+    token = tokenFromFile ?? (0, import_get_vercel_oidc_token_sync.getVercelOidcTokenSync)();
   } catch (error) {
     err = error;
   }
@@ -72,6 +75,19 @@ ${error.message}`;
   }
   return token;
 }
+async function tryOidcTokenFromFile() {
+  const tokenFile = process.env.VERCEL_OIDC_TOKEN_FILE;
+  if (!tokenFile) {
+    return null;
+  }
+  const token = (await (0, import_promises.readFile)(tokenFile, "utf8")).trim();
+  if (!token) {
+    throw new import_token_error.VercelOidcTokenError(
+      `The Vercel OIDC token file is empty: ${tokenFile}`
+    );
+  }
+  return token;
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   getVercelOidcToken

package/dist/get-vercel-oidc-token-with-refresh.test.js

@@ -30,6 +30,9 @@ var import_token_io = require("./token-io");
 var import_cli_config = require("@vercel/cli-config");
 var import_get_vercel_oidc_token_with_refresh = require("./get-vercel-oidc-token-with-refresh");
 var tokenUtil = __toESM(require("./token-util"));
+const requestHeaders = import_vitest.vi.hoisted(() => ({
+  current: {}
+}));
 import_vitest.vi.mock("@vercel/cli-config", async (importOriginal) => ({
   ...await importOriginal(),
   getGlobalPathConfig: import_vitest.vi.fn(),
@@ -42,7 +45,7 @@ import_vitest.vi.mock("@vercel/cli-exec", () => ({
 }));
 import_vitest.vi.mock("./token-io");
 import_vitest.vi.mock("./get-context", () => ({
-  getContext: () => ({ headers: {} })
+  getContext: () => ({ headers: requestHeaders.current })
 }));
 (0, import_vitest.describe)("getVercelOidcToken - Error Scenarios", () => {
   let rootDir;
@@ -54,7 +57,9 @@ import_vitest.vi.mock("./get-context", () => ({
   (0, import_vitest.beforeEach)(() => {
     import_vitest.vi.clearAllMocks();
     import_vitest.vi.restoreAllMocks();
+    requestHeaders.current = {};
     process.env.VERCEL_OIDC_TOKEN = void 0;
+    delete process.env.VERCEL_OIDC_TOKEN_FILE;
     const random = `test-${(0, import_crypto.randomUUID)()}`;
     rootDir = path.join(os.tmpdir(), random);
     userDataDir = path.join(rootDir, "data");
@@ -198,6 +203,124 @@ import_vitest.vi.mock("./get-context", () => ({
     const token = await (0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)();
     (0, import_vitest.expect)(token).toBe(validToken);
   });
+  (0, import_vitest.test)("reads the Vercel OIDC token file on each call after rotation", async () => {
+    delete process.env.VERCEL_OIDC_TOKEN;
+    const tokenFile = path.join(rootDir, "oidc-token");
+    process.env.VERCEL_OIDC_TOKEN_FILE = tokenFile;
+    const firstToken = createValidToken("first");
+    const secondToken = createValidToken("second");
+    fs.writeFileSync(tokenFile, `${firstToken}
+`);
+    (0, import_vitest.expect)(await (0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)()).toBe(firstToken);
+    fs.writeFileSync(tokenFile, `${secondToken}
+`);
+    (0, import_vitest.expect)(await (0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)()).toBe(secondToken);
+  });
+  (0, import_vitest.test)("prefers the advertised file over a static environment token", async () => {
+    process.env.VERCEL_OIDC_TOKEN = createValidToken("stale");
+    const tokenFile = path.join(rootDir, "oidc-token");
+    process.env.VERCEL_OIDC_TOKEN_FILE = tokenFile;
+    const currentToken = createValidToken("current");
+    fs.writeFileSync(tokenFile, currentToken);
+    const fetchSpy = import_vitest.vi.spyOn(globalThis, "fetch");
+    (0, import_vitest.expect)(
+      await (0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)({
+        team: teamId,
+        project: projectId,
+        expirationBufferMs: 6e4
+      })
+    ).toBe(currentToken);
+    (0, import_vitest.expect)(fetchSpy).not.toHaveBeenCalled();
+  });
+  (0, import_vitest.test)("keeps the request token ahead of the advertised file", async () => {
+    const requestToken = createValidToken("request");
+    requestHeaders.current = { "x-vercel-oidc-token": requestToken };
+    process.env.VERCEL_OIDC_TOKEN_FILE = path.join(rootDir, "missing-token");
+    const fetchSpy = import_vitest.vi.spyOn(globalThis, "fetch");
+    (0, import_vitest.expect)(
+      await (0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)({
+        team: teamId,
+        project: projectId,
+        expirationBufferMs: 6e4
+      })
+    ).toBe(requestToken);
+    (0, import_vitest.expect)(fetchSpy).not.toHaveBeenCalled();
+  });
+  (0, import_vitest.test)("includes the file path when the Vercel OIDC token file is empty", async () => {
+    delete process.env.VERCEL_OIDC_TOKEN;
+    const tokenFile = path.join(rootDir, "oidc-token");
+    process.env.VERCEL_OIDC_TOKEN_FILE = tokenFile;
+    fs.writeFileSync(tokenFile, " \n");
+    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)()).rejects.toThrow(
+      `The Vercel OIDC token file is empty: ${tokenFile}`
+    );
+  });
+  (0, import_vitest.test)("rejects a missing advertised token file instead of using the environment token", async () => {
+    process.env.VERCEL_OIDC_TOKEN = createValidToken("environment");
+    process.env.VERCEL_OIDC_TOKEN_FILE = path.join(rootDir, "missing-token");
+    await (0, import_vitest.expect)((0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)()).rejects.toThrow("ENOENT");
+  });
+  (0, import_vitest.test)("refreshes an expired file token using the provided team and project", async () => {
+    delete process.env.VERCEL_OIDC_TOKEN;
+    const tokenFile = path.join(rootDir, "oidc-token");
+    process.env.VERCEL_OIDC_TOKEN_FILE = tokenFile;
+    fs.writeFileSync(tokenFile, createExpiredToken());
+    fs.writeFileSync(
+      path.join(cliDataDir, "auth.json"),
+      JSON.stringify({ token: "test-auth-token" })
+    );
+    const refreshedToken = createValidToken("refreshed");
+    const fetchSpy = import_vitest.vi.spyOn(globalThis, "fetch").mockResolvedValue(
+      new Response(JSON.stringify({ token: refreshedToken }))
+    );
+    (0, import_vitest.expect)(await (0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)({ team: teamId, project: projectId })).toBe(
+      refreshedToken
+    );
+    (0, import_vitest.expect)(fetchSpy).toHaveBeenCalledWith(
+      `https://api.vercel.com/v1/projects/${projectId}/token?source=vercel-oidc-refresh&teamId=${teamId}`,
+      import_vitest.expect.objectContaining({ method: "POST" })
+    );
+  });
+  (0, import_vitest.test)("refreshes a file token within the expiration buffer before audience exchange", async () => {
+    delete process.env.VERCEL_OIDC_TOKEN;
+    const tokenFile = path.join(rootDir, "oidc-token");
+    process.env.VERCEL_OIDC_TOKEN_FILE = tokenFile;
+    fs.writeFileSync(
+      tokenFile,
+      createValidToken("near-expiry", Math.floor(Date.now() / 1e3) + 30)
+    );
+    fs.writeFileSync(
+      path.join(cliDataDir, "auth.json"),
+      JSON.stringify({ token: "test-auth-token" })
+    );
+    const refreshedToken = createValidToken("refreshed");
+    const fetchSpy = import_vitest.vi.spyOn(globalThis, "fetch").mockResolvedValueOnce(
+      new Response(JSON.stringify({ token: refreshedToken }))
+    ).mockResolvedValueOnce(
+      new Response(JSON.stringify({ token: "audience-specific-token" }))
+    );
+    (0, import_vitest.expect)(
+      await (0, import_get_vercel_oidc_token_with_refresh.getVercelOidcToken)({
+        team: teamId,
+        project: projectId,
+        expirationBufferMs: 6e4,
+        audience: "custom-audience",
+        jti: "custom-jti",
+        skipCache: true
+      })
+    ).toBe("audience-specific-token");
+    (0, import_vitest.expect)(fetchSpy).toHaveBeenCalledWith(
+      "https://oidc.vercel.com/~token",
+      import_vitest.expect.objectContaining({
+        method: "POST",
+        body: JSON.stringify({
+          token: refreshedToken,
+          aud: "custom-audience",
+          jti: "custom-jti"
+        })
+      })
+    );
+  });
   (0, import_vitest.test)("should refresh when token is expired but all configs are valid", async () => {
     fs.writeFileSync(
       path.join(cliDataDir, "auth.json"),
@@ -356,14 +479,14 @@ function createExpiredToken() {
   ).toString("base64url");
   return `${header}.${payload}.fake_signature`;
 }
-function createValidToken(value = "valid-token") {
+function createValidToken(value = "valid-token", expiresAt = Math.floor(Date.now() / 1e3) + 43200) {
   const header = Buffer.from(
     JSON.stringify({ alg: "RS256", typ: "JWT" })
   ).toString("base64url");
   const payload = Buffer.from(
     JSON.stringify({
       sub: "test-sub",
-      exp: Math.floor(Date.now() / 1e3) + 43200,
+      exp: expiresAt,
       iat: Math.floor(Date.now() / 1e3)
     })
   ).toString("base64url");

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const version = "3.8.10";
+export declare const version = "4.0.0";

package/dist/version.js

@@ -21,7 +21,7 @@ __export(version_exports, {
   version: () => version
 });
 module.exports = __toCommonJS(version_exports);
-const version = "3.8.10";
+const version = "4.0.0";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   version

package/docs/functions/getVercelOidcToken.md

@@ -6,14 +6,16 @@
 
 > **getVercelOidcToken**(`options?`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`string`\>
 
-Defined in: [packages/oidc/src/get-vercel-oidc-token-with-refresh.ts:96](https://github.com/vercel/vercel/blob/main/packages/oidc/src/get-vercel-oidc-token-with-refresh.ts#L96)
+Defined in: [packages/oidc/src/get-vercel-oidc-token-with-refresh.ts:100](https://github.com/vercel/vercel/blob/main/packages/oidc/src/get-vercel-oidc-token-with-refresh.ts#L100)
 
-Gets the current OIDC token from the request context or the environment variable.
+Gets the current OIDC token from the request context, the Vercel OIDC token
+file, or the environment variable.
 
 Do not cache this value, as it is subject to change in production!
 
-This function is used to retrieve the OIDC token from the request context or the environment variable.
-It checks for the `x-vercel-oidc-token` header in the request context and falls back to the `VERCEL_OIDC_TOKEN` environment variable if the header is not present.
+It checks for the `x-vercel-oidc-token` header in the request context, then
+reads the file named by `VERCEL_OIDC_TOKEN_FILE` when set, then falls back to
+the `VERCEL_OIDC_TOKEN` environment variable.
 
 Unlike the `getVercelOidcTokenSync` function, this function will refresh the token if it is expired in a development environment.
 
@@ -33,7 +35,7 @@ A promise that resolves to the OIDC token.
 
 ## Throws
 
-If the `x-vercel-oidc-token` header is missing from the request context and the environment variable `VERCEL_OIDC_TOKEN` is not set. If the token
+If no token source is available or the configured file cannot be read. If the token
 is expired in a development environment, will also throw an error if the token cannot be refreshed: no CLI credentials are available, CLI credentials are expired, no project configuration is available
 or the token refresh request fails.
 

package/package.json

@@ -18,7 +18,7 @@
       "require": "./dist/index.js"
     }
   },
-  "version": "3.8.10",
+  "version": "4.0.0",
   "repository": {
     "directory": "packages/oidc",
     "type": "git",