mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-26 10:23:31 +00:00
feat(secrets): expand SecretRef coverage across user-supplied credentials (#29580)
* feat(secrets): expand secret target coverage and gateway tooling * docs(secrets): align gateway and CLI secret docs * chore(protocol): regenerate swift gateway models for secrets methods * fix(config): restore talk apiKey fallback and stabilize runner test * ci(windows): reduce test worker count for shard stability * ci(windows): raise node heap for test shard stability * test(feishu): make proxy env precedence assertion windows-safe * fix(gateway): resolve auth password SecretInput refs for clients * fix(gateway): resolve remote SecretInput credentials for clients * fix(secrets): skip inactive refs in command snapshot assignments * fix(secrets): scope gateway.remote refs to effective auth surfaces * fix(secrets): ignore memory defaults when enabled agents disable search * fix(secrets): honor Google Chat serviceAccountRef inheritance * fix(secrets): address tsgo errors in command and gateway collectors * fix(secrets): avoid auth-store load in providers-only configure * fix(gateway): defer local password ref resolution by precedence * fix(secrets): gate telegram webhook secret refs by webhook mode * fix(secrets): gate slack signing secret refs to http mode * fix(secrets): skip telegram botToken refs when tokenFile is set * fix(secrets): gate discord pluralkit refs by enabled flag * fix(secrets): gate discord voice tts refs by voice enabled * test(secrets): make runtime fixture modes explicit * fix(cli): resolve local qr password secret refs * fix(cli): fail when gateway leaves command refs unresolved * fix(gateway): fail when local password SecretRef is unresolved * fix(gateway): fail when required remote SecretRefs are unresolved * fix(gateway): resolve local password refs only when password can win * fix(cli): skip local password SecretRef resolution on qr token override * test(gateway): cast SecretRef fixtures to OpenClawConfig * test(secrets): activate mode-gated targets in runtime coverage fixture * fix(cron): support SecretInput webhook tokens safely * fix(bluebubbles): support SecretInput passwords across config paths * fix(msteams): make appPassword SecretInput-safe in onboarding/token paths * fix(bluebubbles): align SecretInput schema helper typing * fix(cli): clarify secrets.resolve version-skew errors * refactor(secrets): return structured inactive paths from secrets.resolve * refactor(gateway): type onboarding secret writes as SecretInput * chore(protocol): regenerate swift models for secrets.resolve * feat(secrets): expand extension credential secretref support * fix(secrets): gate web-search refs by active provider * fix(onboarding): detect SecretRef credentials in extension status * fix(onboarding): allow keeping existing ref in secret prompt * fix(onboarding): resolve gateway password SecretRefs for probe and tui * fix(onboarding): honor secret-input-mode for local gateway auth * fix(acp): resolve gateway SecretInput credentials * fix(secrets): gate gateway.remote refs to remote surfaces * test(secrets): cover pattern matching and inactive array refs * docs(secrets): clarify secrets.resolve and remote active surfaces * fix(bluebubbles): keep existing SecretRef during onboarding * fix(tests): resolve CI type errors in new SecretRef coverage * fix(extensions): replace raw fetch with SSRF-guarded fetch * test(secrets): mark gateway remote targets active in runtime coverage * test(infra): normalize home-prefix expectation across platforms * fix(cli): only resolve local qr password refs in password mode * test(cli): cover local qr token mode with unresolved password ref * docs(cli): clarify local qr password ref resolution behavior * refactor(extensions): reuse sdk SecretInput helpers * fix(wizard): resolve onboarding env-template secrets before plaintext * fix(cli): surface secrets.resolve diagnostics in memory and qr * test(secrets): repair post-rebase runtime and fixtures * fix(gateway): skip remote password ref resolution when token wins * fix(secrets): treat tailscale remote gateway refs as active * fix(gateway): allow remote password fallback when token ref is unresolved * fix(gateway): ignore stale local password refs for none and trusted-proxy * fix(gateway): skip remote secret ref resolution on local call paths * test(cli): cover qr remote tailscale secret ref resolution * fix(secrets): align gateway password active-surface with auth inference * fix(cli): resolve inferred local gateway password refs in qr * fix(gateway): prefer resolvable remote password over token ref pre-resolution * test(gateway): cover none and trusted-proxy stale password refs * docs(secrets): sync qr and gateway active-surface behavior * fix: restore stability blockers from pre-release audit * Secrets: fix collector/runtime precedence contradictions * docs: align secrets and web credential docs * fix(rebase): resolve integration regressions after main rebase * fix(node-host): resolve gateway secret refs for auth * fix(secrets): harden secretinput runtime readers * gateway: skip inactive auth secretref resolution * cli: avoid gateway preflight for inactive secret refs * extensions: allow unresolved refs in onboarding status * tests: fix qr-cli module mock hoist ordering * Security: align audit checks with SecretInput resolution * Gateway: resolve local-mode remote fallback secret refs * Node host: avoid resolving inactive password secret refs * Secrets runtime: mark Slack appToken inactive for HTTP mode * secrets: keep inactive gateway remote refs non-blocking * cli: include agent memory secret targets in runtime resolution * docs(secrets): sync docs with active-surface and web search behavior * fix(secrets): keep telegram top-level token refs active for blank account tokens * fix(daemon): resolve gateway password secret refs for probe auth * fix(secrets): skip IRC NickServ ref resolution when NickServ is disabled * fix(secrets): align token inheritance and exec timeout defaults * docs(secrets): clarify active-surface notes in cli docs * cli: require secrets.resolve gateway capability * gateway: log auth secret surface diagnostics * secrets: remove dead provider resolver module * fix(secrets): restore gateway auth precedence and fallback resolution * fix(tests): align plugin runtime mock typings --------- Co-authored-by: Peter Steinberger <steipete@gmail.com>
This commit is contained in:
Josh Avant
@@ -18,8 +18,30 @@ async function invokeSecretsReload(params: {
|
||||
}
|
||||
|
||||
describe("secrets handlers", () => {
|
||||
function createHandlers(overrides?: {
|
||||
reloadSecrets?: () => Promise<{ warningCount: number }>;
|
||||
resolveSecrets?: (params: { commandName: string; targetIds: string[] }) => Promise<{
|
||||
assignments: Array<{ path: string; pathSegments: string[]; value: unknown }>;
|
||||
diagnostics: string[];
|
||||
inactiveRefPaths: string[];
|
||||
}>;
|
||||
}) {
|
||||
const reloadSecrets = overrides?.reloadSecrets ?? (async () => ({ warningCount: 0 }));
|
||||
const resolveSecrets =
|
||||
overrides?.resolveSecrets ??
|
||||
(async () => ({
|
||||
assignments: [],
|
||||
diagnostics: [],
|
||||
inactiveRefPaths: [],
|
||||
}));
|
||||
return createSecretsHandlers({
|
||||
reloadSecrets,
|
||||
resolveSecrets,
|
||||
});
|
||||
}
|
||||
|
||||
it("responds with warning count on successful reload", async () => {
|
||||
const handlers = createSecretsHandlers({
|
||||
const handlers = createHandlers({
|
||||
reloadSecrets: vi.fn().mockResolvedValue({ warningCount: 2 }),
|
||||
});
|
||||
const respond = vi.fn();
|
||||
@@ -28,7 +50,7 @@ describe("secrets handlers", () => {
|
||||
});
|
||||
|
||||
it("returns unavailable when reload fails", async () => {
|
||||
const handlers = createSecretsHandlers({
|
||||
const handlers = createHandlers({
|
||||
reloadSecrets: vi.fn().mockRejectedValue(new Error("reload failed")),
|
||||
});
|
||||
const respond = vi.fn();
|
||||
@@ -42,4 +64,123 @@ describe("secrets handlers", () => {
|
||||
}),
|
||||
);
|
||||
});
|
||||
|
||||
it("resolves requested command secret assignments from the active snapshot", async () => {
|
||||
const resolveSecrets = vi.fn().mockResolvedValue({
|
||||
assignments: [{ path: "talk.apiKey", pathSegments: ["talk", "apiKey"], value: "sk" }],
|
||||
diagnostics: ["note"],
|
||||
inactiveRefPaths: ["talk.apiKey"],
|
||||
});
|
||||
const handlers = createHandlers({ resolveSecrets });
|
||||
const respond = vi.fn();
|
||||
await handlers["secrets.resolve"]({
|
||||
req: { type: "req", id: "1", method: "secrets.resolve" },
|
||||
params: { commandName: "memory status", targetIds: ["talk.apiKey"] },
|
||||
client: null,
|
||||
isWebchatConnect: () => false,
|
||||
respond,
|
||||
context: {} as never,
|
||||
});
|
||||
expect(resolveSecrets).toHaveBeenCalledWith({
|
||||
commandName: "memory status",
|
||||
targetIds: ["talk.apiKey"],
|
||||
});
|
||||
expect(respond).toHaveBeenCalledWith(true, {
|
||||
ok: true,
|
||||
assignments: [{ path: "talk.apiKey", pathSegments: ["talk", "apiKey"], value: "sk" }],
|
||||
diagnostics: ["note"],
|
||||
inactiveRefPaths: ["talk.apiKey"],
|
||||
});
|
||||
});
|
||||
|
||||
it("rejects invalid secrets.resolve params", async () => {
|
||||
const handlers = createHandlers();
|
||||
const respond = vi.fn();
|
||||
await handlers["secrets.resolve"]({
|
||||
req: { type: "req", id: "1", method: "secrets.resolve" },
|
||||
params: { commandName: "", targetIds: "bad" },
|
||||
client: null,
|
||||
isWebchatConnect: () => false,
|
||||
respond,
|
||||
context: {} as never,
|
||||
});
|
||||
expect(respond).toHaveBeenCalledWith(
|
||||
false,
|
||||
undefined,
|
||||
expect.objectContaining({
|
||||
code: "INVALID_REQUEST",
|
||||
}),
|
||||
);
|
||||
});
|
||||
|
||||
it("rejects secrets.resolve params when targetIds entries are not strings", async () => {
|
||||
const resolveSecrets = vi.fn();
|
||||
const handlers = createHandlers({ resolveSecrets });
|
||||
const respond = vi.fn();
|
||||
await handlers["secrets.resolve"]({
|
||||
req: { type: "req", id: "1", method: "secrets.resolve" },
|
||||
params: { commandName: "memory status", targetIds: ["talk.apiKey", 12] },
|
||||
client: null,
|
||||
isWebchatConnect: () => false,
|
||||
respond,
|
||||
context: {} as never,
|
||||
});
|
||||
expect(resolveSecrets).not.toHaveBeenCalled();
|
||||
expect(respond).toHaveBeenCalledWith(
|
||||
false,
|
||||
undefined,
|
||||
expect.objectContaining({
|
||||
code: "INVALID_REQUEST",
|
||||
message: "invalid secrets.resolve params: targetIds",
|
||||
}),
|
||||
);
|
||||
});
|
||||
|
||||
it("rejects unknown secrets.resolve target ids", async () => {
|
||||
const resolveSecrets = vi.fn();
|
||||
const handlers = createHandlers({ resolveSecrets });
|
||||
const respond = vi.fn();
|
||||
await handlers["secrets.resolve"]({
|
||||
req: { type: "req", id: "1", method: "secrets.resolve" },
|
||||
params: { commandName: "memory status", targetIds: ["unknown.target"] },
|
||||
client: null,
|
||||
isWebchatConnect: () => false,
|
||||
respond,
|
||||
context: {} as never,
|
||||
});
|
||||
expect(resolveSecrets).not.toHaveBeenCalled();
|
||||
expect(respond).toHaveBeenCalledWith(
|
||||
false,
|
||||
undefined,
|
||||
expect.objectContaining({
|
||||
code: "INVALID_REQUEST",
|
||||
message: 'invalid secrets.resolve params: unknown target id "unknown.target"',
|
||||
}),
|
||||
);
|
||||
});
|
||||
|
||||
it("returns unavailable when secrets.resolve handler returns an invalid payload shape", async () => {
|
||||
const resolveSecrets = vi.fn().mockResolvedValue({
|
||||
assignments: [{ path: "talk.apiKey", pathSegments: [""], value: "sk" }],
|
||||
diagnostics: [],
|
||||
inactiveRefPaths: [],
|
||||
});
|
||||
const handlers = createHandlers({ resolveSecrets });
|
||||
const respond = vi.fn();
|
||||
await handlers["secrets.resolve"]({
|
||||
req: { type: "req", id: "1", method: "secrets.resolve" },
|
||||
params: { commandName: "memory status", targetIds: ["talk.apiKey"] },
|
||||
client: null,
|
||||
isWebchatConnect: () => false,
|
||||
respond,
|
||||
context: {} as never,
|
||||
});
|
||||
expect(respond).toHaveBeenCalledWith(
|
||||
false,
|
||||
undefined,
|
||||
expect.objectContaining({
|
||||
code: "UNAVAILABLE",
|
||||
}),
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -1,8 +1,39 @@
|
||||
import { ErrorCodes, errorShape } from "../protocol/index.js";
|
||||
import type { ErrorObject } from "ajv";
|
||||
import { isKnownSecretTargetId } from "../../secrets/target-registry.js";
|
||||
import {
|
||||
ErrorCodes,
|
||||
errorShape,
|
||||
validateSecretsResolveParams,
|
||||
validateSecretsResolveResult,
|
||||
} from "../protocol/index.js";
|
||||
import type { GatewayRequestHandlers } from "./types.js";
|
||||
|
||||
function invalidSecretsResolveField(
|
||||
errors: ErrorObject[] | null | undefined,
|
||||
): "commandName" | "targetIds" {
|
||||
for (const issue of errors ?? []) {
|
||||
if (
|
||||
issue.instancePath === "/commandName" ||
|
||||
(issue.instancePath === "" &&
|
||||
String((issue.params as { missingProperty?: unknown })?.missingProperty) === "commandName")
|
||||
) {
|
||||
return "commandName";
|
||||
}
|
||||
}
|
||||
return "targetIds";
|
||||
}
|
||||
|
||||
export function createSecretsHandlers(params: {
|
||||
reloadSecrets: () => Promise<{ warningCount: number }>;
|
||||
resolveSecrets: (params: { commandName: string; targetIds: string[] }) => Promise<{
|
||||
assignments: Array<{
|
||||
path: string;
|
||||
pathSegments: string[];
|
||||
value: unknown;
|
||||
}>;
|
||||
diagnostics: string[];
|
||||
inactiveRefPaths: string[];
|
||||
}>;
|
||||
}): GatewayRequestHandlers {
|
||||
return {
|
||||
"secrets.reload": async ({ respond }) => {
|
||||
@@ -13,5 +44,61 @@ export function createSecretsHandlers(params: {
|
||||
respond(false, undefined, errorShape(ErrorCodes.UNAVAILABLE, String(err)));
|
||||
}
|
||||
},
|
||||
"secrets.resolve": async ({ params: requestParams, respond }) => {
|
||||
if (!validateSecretsResolveParams(requestParams)) {
|
||||
const field = invalidSecretsResolveField(validateSecretsResolveParams.errors);
|
||||
respond(
|
||||
false,
|
||||
undefined,
|
||||
errorShape(ErrorCodes.INVALID_REQUEST, `invalid secrets.resolve params: ${field}`),
|
||||
);
|
||||
return;
|
||||
}
|
||||
const commandName = requestParams.commandName.trim();
|
||||
if (!commandName) {
|
||||
respond(
|
||||
false,
|
||||
undefined,
|
||||
errorShape(ErrorCodes.INVALID_REQUEST, "invalid secrets.resolve params: commandName"),
|
||||
);
|
||||
return;
|
||||
}
|
||||
const targetIds = requestParams.targetIds
|
||||
.map((entry) => entry.trim())
|
||||
.filter((entry) => entry.length > 0);
|
||||
|
||||
for (const targetId of targetIds) {
|
||||
if (!isKnownSecretTargetId(targetId)) {
|
||||
respond(
|
||||
false,
|
||||
undefined,
|
||||
errorShape(
|
||||
ErrorCodes.INVALID_REQUEST,
|
||||
`invalid secrets.resolve params: unknown target id "${String(targetId)}"`,
|
||||
),
|
||||
);
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
try {
|
||||
const result = await params.resolveSecrets({
|
||||
commandName,
|
||||
targetIds,
|
||||
});
|
||||
const payload = {
|
||||
ok: true,
|
||||
assignments: result.assignments,
|
||||
diagnostics: result.diagnostics,
|
||||
inactiveRefPaths: result.inactiveRefPaths,
|
||||
};
|
||||
if (!validateSecretsResolveResult(payload)) {
|
||||
throw new Error("secrets.resolve returned invalid payload.");
|
||||
}
|
||||
respond(true, payload);
|
||||
} catch (err) {
|
||||
respond(false, undefined, errorShape(ErrorCodes.UNAVAILABLE, String(err)));
|
||||
}
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user