fix(secrets): enforce canonical secret refs · openclaw/openclaw@6bfe7a2

Recent Commits to openclaw:main

vincentkoc · 2026-06-20 · via Recent Commits to openclaw:main

Original file line number	Diff line number	Diff line change
`@@ -30,31 +30,37 @@ const secretInputSchema = z`
`30`	`30`	`.union([`
`31`	`31`	`z.string(),`
`32`	`32`	`z.discriminatedUnion("source", [`
`33`		`-z.object({`
`34`		`-source: z.literal("env"),`
`35`		`-provider: providerSchema,`
`36`		`-id: z`
`37`		`-.string()`
`38`		`-.regex(`
`39`		`-ENV_SECRET_REF_ID_RE,`
`40`		`-'Env secret reference id must match /^[A-Z][A-Z0-9_]{0,127}$/ (example: "OPENAI_API_KEY").',`
`41`		`-),`
`42`		`-}),`
`43`		`-z.object({`
`44`		`-source: z.literal("file"),`
`45`		`-provider: providerSchema,`
`46`		`-id: z`
`47`		`-.string()`
`48`		`-.refine(`
`49`		`-isValidFileSecretRefId,`
`50`		`-'File secret reference id must be an absolute JSON pointer (example: "/providers/openai/apiKey"), or "value" for singleValue mode.',`
`51`		`-),`
`52`		`-}),`
`53`		`-z.object({`
`54`		`-source: z.literal("exec"),`
`55`		`-provider: providerSchema,`
`56`		`-id: z.string().refine(isValidExecSecretRefId, formatExecSecretRefIdValidationMessage()),`
`57`		`-}),`
	`33`	`+z`
	`34`	`+.object({`
	`35`	`+source: z.literal("env"),`
	`36`	`+provider: providerSchema,`
	`37`	`+id: z`
	`38`	`+.string()`
	`39`	`+.regex(`
	`40`	`+ENV_SECRET_REF_ID_RE,`
	`41`	`+'Env secret reference id must match /^[A-Z][A-Z0-9_]{0,127}$/ (example: "OPENAI_API_KEY").',`
	`42`	`+),`
	`43`	`+})`
	`44`	`+.strict(),`
	`45`	`+z`
	`46`	`+.object({`
	`47`	`+source: z.literal("file"),`
	`48`	`+provider: providerSchema,`
	`49`	`+id: z`
	`50`	`+.string()`
	`51`	`+.refine(`
	`52`	`+isValidFileSecretRefId,`
	`53`	`+'File secret reference id must be an absolute JSON pointer (example: "/providers/openai/apiKey"), or "value" for singleValue mode.',`
	`54`	`+),`
	`55`	`+})`
	`56`	`+.strict(),`
	`57`	`+z`
	`58`	`+.object({`
	`59`	`+source: z.literal("exec"),`
	`60`	`+provider: providerSchema,`
	`61`	`+id: z.string().refine(isValidExecSecretRefId, formatExecSecretRefIdValidationMessage()),`
	`62`	`+})`
	`63`	`+.strict(),`
`58`	`64`	`]),`
`59`	`65`	`])`
`60`	`66`	`.register(sensitive);`

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,34 @@ describe("provider auth env trust", () => {`
`47`	`47`	`});`
`48`	`48`	`});`
`49`	`49`
	`50`	`+it("buildApiKeyCredential rejects malformed object SecretRefs", async () => {`
	`51`	`+const { buildApiKeyCredential } = await import("./provider-auth-helpers.js");`
	`52`	`+const malformedRefs = [`
	`53`	`+{ source: "env", provider: "default", id: "OPENAI_API_KEY", extra: "x" },`
	`54`	`+{ source: "env", provider: "Default", id: "OPENAI_API_KEY" },`
	`55`	`+{ source: "env", provider: "default", id: "openai_api_key" },`
	`56`	`+{ source: "file", provider: "default", id: "providers/openai/apiKey" },`
	`57`	`+{ source: "exec", provider: "vault", id: "vault/../api-key" },`
	`58`	`+];`
	`59`	`+`
	`60`	`+for (const ref of malformedRefs) {`
	`61`	`+expect(() => buildApiKeyCredential("openai", ref as never)).toThrow(`
	`62`	`+"API key SecretRef is invalid.",`
	`63`	`+);`
	`64`	`+}`
	`65`	`+});`
	`66`	`+`
	`67`	`+it("buildApiKeyCredential keeps invalid env-template strings as plaintext", async () => {`
	`68`	`+const { buildApiKeyCredential } = await import("./provider-auth-helpers.js");`
	`69`	+const overlongEnvRef = `\${A${"B".repeat(128)}}`;
	`70`	`+`
	`71`	`+expect(buildApiKeyCredential("openai", overlongEnvRef)).toEqual({`
	`72`	`+type: "api_key",`
	`73`	`+provider: "openai",`
	`74`	`+key: overlongEnvRef,`
	`75`	`+});`
	`76`	`+});`
	`77`	`+`
`50`	`78`	`it("resolveRefFallbackInput excludes untrusted workspace plugin env vars", async () => {`
`51`	`79`	`const { resolveRefFallbackInput } = await import("./provider-auth-ref.js");`
`52`	`80`	`const config = { plugins: {} };`

Original file line number	Diff line number	Diff line change
`@@ -11,15 +11,16 @@ import type { OpenClawConfig } from "../config/types.openclaw.js";`
`11`	`11`	`import {`
`12`	`12`	`coerceSecretRef,`
`13`	`13`	`DEFAULT_SECRET_PROVIDER_ALIAS,`
	`14`	`+parseEnvTemplateSecretRef,`
`14`	`15`	`type SecretInput,`
`15`	`16`	`type SecretRef,`
`16`	`17`	`} from "../config/types.secrets.js";`
`17`	`18`	`import type { OAuthCredentials } from "../llm/oauth.js";`
`18`	`19`	`import { getProviderEnvVars } from "../secrets/provider-env-vars.js";`
	`20`	`+import { isValidSecretRef } from "../secrets/ref-contract.js";`
`19`	`21`	`import { normalizeSecretInput } from "../utils/normalize-secret-input.js";`
`20`	`22`	`import type { SecretInputMode } from "./provider-auth-types.js";`
`21`	`23`
`22`		`-const ENV_REF_PATTERN = /^\$\{([A-Z][A-Z0-9_]*)\}$/;`
`23`	`24`	`type UpsertAuthProfileParams = Parameters<typeof upsertAuthProfileWithLock>[0];`
`24`	`25`
`25`	`26`	`const resolveAuthAgentDir = (agentDir?: string, config?: OpenClawConfig) =>`
`@@ -40,14 +41,6 @@ function buildEnvSecretRef(id: string): SecretRef {`
`40`	`41`	`return { source: "env", provider: DEFAULT_SECRET_PROVIDER_ALIAS, id };`
`41`	`42`	`}`
`42`	`43`
`43`		`-function parseEnvSecretRef(value: string): SecretRef \| null {`
`44`		`-const match = ENV_REF_PATTERN.exec(value);`
`45`		`-if (!match) {`
`46`		`-return null;`
`47`		`-}`
`48`		`-return buildEnvSecretRef(match[1]);`
`49`		`-}`
`50`		`-`
`51`	`44`	`function resolveProviderDefaultEnvSecretRef(provider: string, config?: OpenClawConfig): SecretRef {`
`52`	`45`	`const envVars = getProviderEnvVars(provider, {`
`53`	`46`	`...(config ? { config } : {}),`
`@@ -67,15 +60,25 @@ function resolveApiKeySecretInput(`
`67`	`60`	`input: SecretInput,`
`68`	`61`	`options?: ApiKeyStorageOptions,`
`69`	`62`	`): SecretInput {`
	`63`	`+if (input !== null && typeof input === "object") {`
	`64`	`+const coercedRef = coerceSecretRef(input);`
	`65`	`+if (!coercedRef \|\| !isValidSecretRef(coercedRef)) {`
	`66`	`+throw new Error("API key SecretRef is invalid.");`
	`67`	`+}`
	`68`	`+return coercedRef;`
	`69`	`+}`
`70`	`70`	`if (options?.secretInputMode === "plaintext") {`
`71`	`71`	`return normalizeSecretInput(input);`
`72`	`72`	`}`
`73`	`73`	`const coercedRef = coerceSecretRef(input);`
`74`	`74`	`if (coercedRef) {`
	`75`	`+if (!isValidSecretRef(coercedRef)) {`
	`76`	`+throw new Error("API key SecretRef is invalid.");`
	`77`	`+}`
`75`	`78`	`return coercedRef;`
`76`	`79`	`}`
`77`	`80`	`const normalized = normalizeSecretInput(input);`
`78`		`-const inlineEnvRef = parseEnvSecretRef(normalized);`
	`81`	`+const inlineEnvRef = parseEnvTemplateSecretRef(normalized, DEFAULT_SECRET_PROVIDER_ALIAS);`
`79`	`82`	`if (inlineEnvRef) {`
`80`	`83`	`return inlineEnvRef;`
`81`	`84`	`}`

Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,21 @@ describe("exec SecretRef id parity", () => {`
`57`	`57`	`return result.ok;`
`58`	`58`	`}`
`59`	`59`
	`60`	`+function configAcceptsRef(ref: unknown): boolean {`
	`61`	`+const result = validateConfigObjectRaw({`
	`62`	`+models: {`
	`63`	`+providers: {`
	`64`	`+openai: {`
	`65`	`+baseUrl: "https://api.openai.com/v1",`
	`66`	`+apiKey: ref,`
	`67`	`+models: [{ id: "gpt-5", name: "gpt-5" }],`
	`68`	`+},`
	`69`	`+},`
	`70`	`+},`
	`71`	`+});`
	`72`	`+return result.ok;`
	`73`	`+}`
	`74`	`+`
`60`	`75`	`function planAcceptsExecRef(id: string): boolean {`
`61`	`76`	`return isSecretsApplyPlan({`
`62`	`77`	`version: 1,`
`@@ -75,7 +90,7 @@ describe("exec SecretRef id parity", () => {`
`75`	`90`	`});`
`76`	`91`	`}`
`77`	`92`
`78`		`-function planAcceptsRef(ref: { source: "env" \| "file" \| "exec"; provider: string; id: string }) {`
	`93`	`+function planAcceptsRef(ref: unknown) {`
`79`	`94`	`return isSecretsApplyPlan({`
`80`	`95`	`version: 1,`
`81`	`96`	`protocolVersion: 1,`
`@@ -128,6 +143,19 @@ describe("exec SecretRef id parity", () => {`
`128`	`143`	`expect(pluginSdkSecretInput.safeParse(ref).success).toBe(false);`
`129`	`144`	`});`
`130`	`145`
	`146`	`+for (const ref of [`
	`147`	`+{ source: "env", provider: "default", id: "OPENAI_API_KEY", extra: "x" },`
	`148`	`+{ source: "file", provider: "default", id: "value", extra: "x" },`
	`149`	`+{ source: "exec", provider: "vault", id: "vault/openai/api-key", extra: "x" },`
	`150`	`+]) {`
	`151`	+it(`rejects non-canonical ${ref.source} refs with extra properties across config/plan/gateway/plugin`, () => {
	`152`	`+expect(configAcceptsRef(ref)).toBe(false);`
	`153`	`+expect(planAcceptsRef(ref)).toBe(false);`
	`154`	`+expect(validateGatewaySecretRef.Check(ref)).toBe(false);`
	`155`	`+expect(pluginSdkSecretInput.safeParse(ref).success).toBe(false);`
	`156`	`+});`
	`157`	`+}`
	`158`	`+`
`131`	`159`	`for (const id of [...VALID_EXEC_SECRET_REF_IDS, ...INVALID_EXEC_SECRET_REF_IDS]) {`
`132`	`160`	it(`keeps config/plan/gateway/plugin parity for exec id "${id}"`, () => {
`133`	`161`	`const expected = isValidExecSecretRefId(id);`

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ import {`
`9`	`9`	`import {`
`10`	`10`	`isValidExecSecretRefId,`
`11`	`11`	`isValidFileSecretRefId,`
	`12`	`+isValidSecretRef,`
`12`	`13`	`validateExecSecretRefId,`
`13`	`14`	`} from "./ref-contract.js";`
`14`	`15`
`@@ -52,3 +53,19 @@ describe("exec secret ref id validation", () => {`
`52`	`53`	`});`
`53`	`54`	`});`
`54`	`55`	`});`
	`56`	`+`
	`57`	`+describe("secret ref validation", () => {`
	`58`	`+it("rejects non-canonical refs with extra properties", () => {`
	`59`	`+expect(isValidSecretRef({ source: "env", provider: "default", id: "OPENAI_API_KEY" })).toBe(`
	`60`	`+true,`
	`61`	`+);`
	`62`	`+expect(`
	`63`	`+isValidSecretRef({`
	`64`	`+source: "env",`
	`65`	`+provider: "default",`
	`66`	`+id: "OPENAI_API_KEY",`
	`67`	`+extra: "x",`
	`68`	`+} as never),`
	`69`	`+).toBe(false);`
	`70`	`+});`
	`71`	`+});`

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`/** Shared SecretRef grammar and validation helpers for config, schema, SDK, and gateway parity. */`
`2`	`2`	`import {`
`3`	`3`	`DEFAULT_SECRET_PROVIDER_ALIAS,`
	`4`	`+isSecretRef,`
`4`	`5`	`isValidEnvSecretRefId,`
`5`	`6`	`type SecretRef,`
`6`	`7`	`type SecretRefSource,`
`@@ -135,6 +136,9 @@ export function isValidExecSecretRefId(value: string): boolean {`
`135`	`136`
`136`	`137`	`/** Validates a complete SecretRef against the shared provider/source/id grammar. */`
`137`	`138`	`export function isValidSecretRef(ref: SecretRef): boolean {`
	`139`	`+if (!isSecretRef(ref)) {`
	`140`	`+return false;`
	`141`	`+}`
`138`	`142`	`if (!isValidSecretProviderAlias(ref.provider)) {`
`139`	`143`	`return false;`
`140`	`144`	`}`

此内容由惯性聚合(RSS阅读器)自动聚合整理，仅供阅读参考。原文来自 — 版权归原作者所有。

推荐订阅源

Recent Commits to openclaw:main