googleapis / googleapis/google-cloud-node

google-auth-library: getErrorFromOAuthErrorResponse() copies stack as non-writable, breaking error decoration in consumers

未关闭 适合新手
#9,155 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
TypeScript
星标
3.2k
派生
712
平均合并
2 天 9 小时
30 天内合并 PR
104

描述

### Environment

- `google-auth-library`: **11.0.2** (also reproduced on 10.6.2)
- Node.js: 20.19.5
- Credential type: `external_account` (Workload Identity Federation, file-sourced OIDC subject token)

### Summary

`getErrorFromOAuthErrorResponse()` — [`core/packages/google-auth-library-nodejs/src/auth/oauth2common.ts:253`](https://github.com/googleapis/google-cloud-node/blob/main/core/packages/google-auth-library-nodejs/src/auth/oauth2common.ts#L253) — builds a new `Error` from an OAuth/STS error response and copies the original error's own properties onto it — including `stack` — as **non-writable**:

```js
const keys = Object.keys(err);
if (err.stack) {
// Copy error.stack if available.
keys.push('stack');
}
keys.forEach(key => {
if (key !== 'message') {
Object.defineProperty(newError, key, {
value: err[key],
writable: false, // <-- makes `stack` read-only
enumerable: true,
});
}
});
```

Every error surfaced from an STS/OAuth error response therefore has `stack` with `{ writable: false, enumerable: true, configurable: true }`, whereas a normal `Error` has a writable `stack`.

### Why it matters

Appending to `error.stack` to attach causal context is a common pattern, and it is normally safe. Against these errors it throws in strict mode (and silently discards the write in sloppy mode). Both outcomes are bad, and the strict-mode one is worse: the real authentication failure is replaced by a `TypeError` naming an unrelated library.

A concrete case in the same ecosystem — `@google-cloud/firestore`'s `wrapError()` (`build/src/util.js`) does:

```js
err.stack += '\nCaused by: ' + stack;
```

Its module is emitted with `"use strict"`, and it is invoked from stream `'error'` handlers. So when a Firestore operation fails because a federated credential was rejected, the `TypeError` is thrown inside an `EventEmitter` emit, escapes the promise chain, and becomes an **`uncaughtException`** rather than a rejected promise:

```
TypeError: Cannot assign to read only property 'stack' of object 'Error: Error code invalid_grant: ID Token issued at is stale to sign-in.'
at wrapError (/app/node_modules/@google-cloud/firestore/build/src/util.js:213:15)
at Transform.emit (node:events:524:28)
at emitErrorNT (node:internal/streams/destroy:169:8)
at process.processTicksAndRejections (node:internal/process/task_queues:82:21)
```

The underlying problem was an expired OIDC subject token. Nothing in what the process reported says so. I've filed the counterpart issue for the Firestore half (same monorepo) asking them to guard the assignment: #9154. But the read-only `stack` looks worth revisiting here too, since any consumer decorating errors this way will hit it, and `stack` is conventionally writable.

Also note `enumerable: true` on the copied properties: `stack` is normally non-enumerable, so this additionally makes it show up in `Object.keys(err)`, `for...in`, and `JSON.stringify` output of the error's own properties.

### Reproduction

```js
// npm i google-auth-library
const { getErrorFromOAuthErrorResponse } = require('google-auth-library/build/src/auth/oauth2common.js');

const authError = getErrorFromOAuthErrorResponse(
{ error: 'invalid_grant', error_description: 'ID Token is stale to sign-in.' },
new Error('underlying transport failure'),
);

console.log(Object.getOwnPropertyDescriptor(authError, 'stack'));
// => { value: '...', writable: false, enumerable: true, configurable: true }

// Sloppy mode: the write is silently discarded.
(function () { authError.stack += '\nCaused by: x'; })();

// Strict mode (what compiled TS/ESM consumers run in): throws.
(function () { 'use strict'; authError.stack += '\nCaused by: x'; })();
// => TypeError: Cannot assign to read only property 'stack' of object
// 'Error: Error code invalid_grant: ID Token is stale to sign-in.'
```

In situ this is reached via a normal `external_account` credential whose subject token has expired: the STS response is an `invalid_grant`, `getErrorFromOAuthErrorResponse()` converts it, and any downstream `err.stack +=` then crashes.

### Suggested fix

Leave `stack` writable (and non-enumerable) when copying, so these errors behave like ordinary ones:

```js
keys.forEach(key => {
if (key !== 'message') {
Object.defineProperty(newError, key, {
value: err[key],
writable: key === 'stack',
enumerable: key !== 'stack',
configurable: true,
});
}
});
```

Simply not copying `stack` at all would also work — `newError` already has its own accurate stack — though that loses the original call site. Alternatively `newError.cause = err` conveys the same information using the standard mechanism and keeps `stack` untouched.

贡献指南

打开贡献指南

调研方向

从 core/packages/google-auth-library-nodejs/src/auth/oauth2common.ts 中的 getErrorFromOAuthErrorResponse() 开始,然后针对 external_account 的 OAuth/STS 错误运行复现。完成此更改的标准是:生成的错误保留可写且不可枚举的 stack,同时保留预期的错误信息,并且 strict mode 下的 stack 装饰不再抛出异常。

由索引模型根据 Issue 内容生成。

评估

技术栈
nodejs, typescript
领域
authentication
Issue 类型
缺陷
难度
2/5
预计耗时
1-3 小时
活跃度
冷清
描述清晰度
描述清楚
新手友好度
74/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。