Self-hosted platform: derive the R2 upload keys from the runtime API token
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 34/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- github, typescript
调研方向
Start with platform-lifecycle.ts, platform-management.ts, and platform-installer-secrets.ts; trace how runtime tokens and R2 credentials reach createPlatformInstallationSecrets and installPlatform. Check the token verification flow against platform/packages/api/src/email/cf-customer.ts and add coverage for both fallback directions, fresh installs, and token rotation. Done means derived credentials follow the specified precedence and recovery rules, with the docs updated and the Cloudflare token ID and presigned PUT behavior verified.
由索引模型根据 Issue 内容生成。
描述
Problem
A self-hosted platform install asks for two extra pasted values on a separate
Cloudflare page: the R2 Access Key ID and Secret Access Key
(packages/void/src/cli/platform-lifecycle.ts, the R2 block after the GitHub
OAuth prompts; page platformSetupPages(plan).r2 in platform-setup.ts).
The keys are only used by the API Worker to presign direct-to-R2 asset PUTs
(platform/packages/api/src/routes/deploy.ts presignAssetPut,
platform/packages/api/src/r2-presign.ts). They are not checked at install time,
so a wrong pair only fails at the first void deploy --platform void that
uploads assets (packages/void/src/cli/direct-r2-upload.ts, raw
R2 PUT failed for <path> (<hash>): 403).
Cloudflare documents that an API token can act as an S3 key pair:
Access Key ID = the token ID, Secret Access Key = SHA-256 hex of the token value
(https://developers.cloudflare.com/r2/api/tokens/). The runtime token already
has Account → Workers R2 Storage → Edit, and the API Worker already holds it as
CF_API_TOKEN, so deriving the pair adds no new permission to any Worker.
Proposed design
fresh interactive or CI install
runtime token verified ──▶ GET /user/tokens/verify (fallback /accounts/:id/tokens/verify)
──▶ r2AccessKeyId = result.id
r2SecretAccessKey = sha256hex(runtime token)
explicit VOID_PLATFORM_R2_ACCESS_KEY_ID + _SECRET_ACCESS_KEY pair still wins
upgrade / repair with a new VOID_PLATFORM_RUNTIME_CLOUDFLARE_API_TOKEN
recovery r2SecretAccessKey == sha256hex(recovery cloudflareApiToken)? (or no recovery)
yes ──▶ derive again, update R2_* Worker secrets together with CF_API_TOKEN
no ──▶ keep the separately supplied pair
PlatformCloudflareClient.apiTokenId(accountId): token-verify lookup, returns a
non-empty id without whitespace, otherwise throws.platform-installer-secrets.ts:platformR2SecretFromToken,
platformR2KeysFollowRuntimeToken(recovery),platformR2CredentialsFromRuntimeToken.- Lifecycle: remove the R2 page and both prompts; derive after the runtime token
is verified. platform-management.ts: derive on runtime-token rotation when the saved
pair was derived from the previous token.- Docs: credentials.md (R2 section), ci.md (R2 rows optional), maintenance.md
(rotation replaces derived keys; recreating the API needs R2 values only for
a separate R2 token), development/runtime.md (drop R2 from needed inputs).
Problems to fix in this design before implementing
- Order in
platform-management.ts: the keys cannot be derived both before
createPlatformInstallationSecretsand after the runtime-token preflight, because
the preflight (resolvePlatformRuntimeTokenToPreflight(plan, secrets)) reads the
result ofcreatePlatformInstallationSecrets. Derive before
createPlatformInstallationSecretsand leave the preflight where it is; the
token-verify call already rejects an invalid token. - Token-ID lookup order: trying account verify first and falling back only on
401/403/404 is not enough. What/accounts/:id/tokens/verifyreturns for a user token is
unverified (it may be 400). Match
platform/packages/api/src/email/cf-customer.tsverifyToken(user verify
first, then account verify), or fall back on any 4xx except 429. Rethrow 5xx.
Test both fallback directions. - Precedence on a non-draft resume:
configured()in the lifecycle returns
values[key] || envwhencredentialSetupis false. Reading the env pair first
in every mode flips that; withexistingInstallationand no
updateExistingWorkers, the live API Worker keeps its old R2 secret while
recovery saves the env pair, and later hash matching compares the wrong value.
Apply the env pair only whencredentialSetupis true; otherwise keep the
checkpoint values. - "Set both or neither": a new error for a half-set env pair can break a resume
that works today (one variable set, the other from the checkpoint). Apply the
check only on a fresh install (credentialSetup).
Tests this design needs: derived values reach createPlatformInstallationSecrets
and installPlatform on a fresh interactive install (token id from a spied
apiTokenId, secret = sha256 of the runtime token); the half-set env pair
error; upgrade with a rotated runtime token updates R2_ACCESS_KEY_ID /
R2_SECRET_ACCESS_KEY only when the saved pair was derived.
Unverified before merge
/user/tokens/verifyor/accounts/:id/tokens/verifyreturnsidfor an
account-owned runtime token (cfat_…), and a presigned PUT signed with the
derived pair succeeds on the e2e account.- Without recovery data, a rotation would also rewrite a separately supplied
pair. It keeps working (the runtime token has R2 Edit), but it changes
"only supplied values replace live credentials"; docs must say so.
Related, separate
An install-time R2 key check would also catch a wrong pasted pair before the
first deploy (today it surfaces as a raw 403 from direct-r2-upload.ts).
🤖 Generated with Claude Code
- 主要语言
- TypeScript
- 星标
- 402
- 派生
- 32
- 平均合并
- 12 小时 28 分钟
- 30 天内合并 PR
- 77
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
voidzero-dev/void 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 82/100
voidzero-dev/void#478 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
voidzero-dev/void#463 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
voidzero-dev/void#459 ·
维护者通常 1 天内回复
-
bug
难度 1/5 1-3 小时 新手友好度 78/100
voidzero-dev/void#428 ·
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 68/100
voidzero-dev/void#480 ·
维护者通常 1 天内回复
查看 voidzero-dev/void 的全部 Issue
相似的 Issue
-
documentation
难度 2/5 1-3 小时 新手友好度 74/100
components-web-app/docs#260 ·
-
难度 1/5 1 小时以内 新手友好度 65/100
521xueweihan/HelloGitHub#4025 ·
-
难度 2/5 1-3 小时 新手友好度 72/100
-
难度 2/5 1-3 小时 新手友好度 75/100
ctrf-io/playwright-ctrf-json-reporter#117 ·
维护者通常 1 天内回复
-
chore docs good first issue
难度 2/5 1-3 小时 新手友好度 87/100
Karthik-beta/Blinkql#105 ·
维护者通常 1 天内回复