* Secrets: add inline allowlist review set * Secrets: narrow detect-secrets file exclusions * Secrets: exclude Docker fingerprint false positive * Secrets: allowlist test and docs false positives * Secrets: refresh baseline after allowlist updates * Secrets: fix gateway chat fixture pragma * Secrets: format pre-commit config * Android: keep talk mode fixture JSON valid * Feishu: rely on client timeout injection * Secrets: allowlist provider auth test fixtures * Secrets: allowlist onboard search fixtures * Secrets: allowlist onboard mode fixture * Secrets: allowlist gateway auth mode fixture * Secrets: allowlist APNS wake test key * Secrets: allowlist gateway reload fixtures * Secrets: allowlist moonshot video fixture * Secrets: allowlist auto audio fixture * Secrets: allowlist tiny audio fixture * Secrets: allowlist embeddings fixtures * Secrets: allowlist resolve fixtures * Secrets: allowlist target registry pattern fixtures * Secrets: allowlist gateway chat env fixture * Secrets: refresh baseline after fixture allowlists * Secrets: reapply gateway chat env allowlist * Secrets: reapply gateway chat env allowlist * Secrets: stabilize gateway chat env allowlist * Secrets: allowlist runtime snapshot save fixture * Secrets: allowlist oauth profile fixtures * Secrets: allowlist compaction identifier fixture * Secrets: allowlist model auth fixture * Secrets: allowlist model status fixtures * Secrets: allowlist custom onboarding fixture * Secrets: allowlist mattermost token summary fixtures * Secrets: allowlist gateway auth suite fixtures * Secrets: allowlist channel summary fixture * Secrets: allowlist provider usage auth fixtures * Secrets: allowlist media proxy fixture * Secrets: allowlist secrets audit fixtures * Secrets: refresh baseline after final fixture allowlists * Feishu: prefer explicit client timeout * Feishu: test direct timeout precedence
778 lines
24 KiB
TypeScript
778 lines
24 KiB
TypeScript
import fs from "node:fs";
|
|
import os from "node:os";
|
|
import path from "node:path";
|
|
import { isDeepStrictEqual } from "node:util";
|
|
import { resolveAgentConfig } from "../agents/agent-scope.js";
|
|
import { loadAuthProfileStoreForSecretsRuntime } from "../agents/auth-profiles.js";
|
|
import { AUTH_STORE_VERSION } from "../agents/auth-profiles/constants.js";
|
|
import { resolveAuthStorePath } from "../agents/auth-profiles/paths.js";
|
|
import { normalizeProviderId } from "../agents/model-selection.js";
|
|
import { resolveStateDir, type OpenClawConfig } from "../config/config.js";
|
|
import type { ConfigWriteOptions } from "../config/io.js";
|
|
import type { SecretProviderConfig } from "../config/types.secrets.js";
|
|
import { normalizeAgentId } from "../routing/session-key.js";
|
|
import { resolveConfigDir, resolveUserPath } from "../utils.js";
|
|
import { iterateAuthProfileCredentials } from "./auth-profiles-scan.js";
|
|
import { createSecretsConfigIO } from "./config-io.js";
|
|
import { deletePathStrict, getPath, setPathCreateStrict } from "./path-utils.js";
|
|
import {
|
|
type SecretsApplyPlan,
|
|
type SecretsPlanTarget,
|
|
normalizeSecretsPlanOptions,
|
|
resolveValidatedPlanTarget,
|
|
} from "./plan.js";
|
|
import { listKnownSecretEnvVarNames } from "./provider-env-vars.js";
|
|
import { resolveSecretRefValue } from "./resolve.js";
|
|
import { prepareSecretsRuntimeSnapshot } from "./runtime.js";
|
|
import { assertExpectedResolvedSecretValue } from "./secret-value.js";
|
|
import { isNonEmptyString, isRecord, writeTextFileAtomic } from "./shared.js";
|
|
import {
|
|
listAuthProfileStorePaths,
|
|
listLegacyAuthJsonPaths,
|
|
parseEnvAssignmentValue,
|
|
readJsonObjectIfExists,
|
|
} from "./storage-scan.js";
|
|
|
|
type FileSnapshot = {
|
|
existed: boolean;
|
|
content: string;
|
|
mode: number;
|
|
};
|
|
|
|
type ApplyWrite = {
|
|
path: string;
|
|
content: string;
|
|
mode: number;
|
|
};
|
|
|
|
type ProjectedState = {
|
|
nextConfig: OpenClawConfig;
|
|
configPath: string;
|
|
configWriteOptions: ConfigWriteOptions;
|
|
authStoreByPath: Map<string, Record<string, unknown>>;
|
|
authJsonByPath: Map<string, Record<string, unknown>>;
|
|
envRawByPath: Map<string, string>;
|
|
changedFiles: Set<string>;
|
|
warnings: string[];
|
|
};
|
|
|
|
type ResolvedPlanTargetEntry = {
|
|
target: SecretsPlanTarget;
|
|
resolved: NonNullable<ReturnType<typeof resolveValidatedPlanTarget>>;
|
|
};
|
|
|
|
type ConfigTargetMutationResult = {
|
|
resolvedTargets: ResolvedPlanTargetEntry[];
|
|
scrubbedValues: Set<string>;
|
|
providerTargets: Set<string>;
|
|
configChanged: boolean;
|
|
authStoreByPath: Map<string, Record<string, unknown>>;
|
|
};
|
|
|
|
type MutableAuthProfileStore = Record<string, unknown> & {
|
|
profiles: Record<string, unknown>;
|
|
};
|
|
|
|
export type SecretsApplyResult = {
|
|
mode: "dry-run" | "write";
|
|
changed: boolean;
|
|
changedFiles: string[];
|
|
warningCount: number;
|
|
warnings: string[];
|
|
};
|
|
|
|
function resolveTarget(
|
|
target: SecretsPlanTarget,
|
|
): NonNullable<ReturnType<typeof resolveValidatedPlanTarget>> {
|
|
const resolved = resolveValidatedPlanTarget(target);
|
|
if (!resolved) {
|
|
throw new Error(`Invalid plan target path for ${target.type}: ${target.path}`);
|
|
}
|
|
return resolved;
|
|
}
|
|
|
|
function scrubEnvRaw(
|
|
raw: string,
|
|
migratedValues: Set<string>,
|
|
allowedEnvKeys: Set<string>,
|
|
): {
|
|
nextRaw: string;
|
|
removed: number;
|
|
} {
|
|
if (migratedValues.size === 0 || allowedEnvKeys.size === 0) {
|
|
return { nextRaw: raw, removed: 0 };
|
|
}
|
|
const lines = raw.split(/\r?\n/);
|
|
const nextLines: string[] = [];
|
|
let removed = 0;
|
|
for (const line of lines) {
|
|
const match = line.match(/^\s*(?:export\s+)?([A-Za-z_][A-Za-z0-9_]*)\s*=\s*(.*)$/);
|
|
if (!match) {
|
|
nextLines.push(line);
|
|
continue;
|
|
}
|
|
const envKey = match[1] ?? "";
|
|
if (!allowedEnvKeys.has(envKey)) {
|
|
nextLines.push(line);
|
|
continue;
|
|
}
|
|
const parsedValue = parseEnvAssignmentValue(match[2] ?? "");
|
|
if (migratedValues.has(parsedValue)) {
|
|
removed += 1;
|
|
continue;
|
|
}
|
|
nextLines.push(line);
|
|
}
|
|
const hadTrailingNewline = raw.endsWith("\n");
|
|
const joined = nextLines.join("\n");
|
|
return {
|
|
nextRaw:
|
|
hadTrailingNewline || joined.length === 0
|
|
? `${joined}${joined.endsWith("\n") ? "" : "\n"}`
|
|
: joined,
|
|
removed,
|
|
};
|
|
}
|
|
|
|
function applyProviderPlanMutations(params: {
|
|
config: OpenClawConfig;
|
|
upserts: Record<string, SecretProviderConfig> | undefined;
|
|
deletes: string[] | undefined;
|
|
}): boolean {
|
|
const currentProviders = isRecord(params.config.secrets?.providers)
|
|
? structuredClone(params.config.secrets?.providers)
|
|
: {};
|
|
let changed = false;
|
|
|
|
for (const providerAlias of params.deletes ?? []) {
|
|
if (!Object.prototype.hasOwnProperty.call(currentProviders, providerAlias)) {
|
|
continue;
|
|
}
|
|
delete currentProviders[providerAlias];
|
|
changed = true;
|
|
}
|
|
|
|
for (const [providerAlias, providerConfig] of Object.entries(params.upserts ?? {})) {
|
|
const previous = currentProviders[providerAlias];
|
|
if (isDeepStrictEqual(previous, providerConfig)) {
|
|
continue;
|
|
}
|
|
currentProviders[providerAlias] = structuredClone(providerConfig);
|
|
changed = true;
|
|
}
|
|
|
|
if (!changed) {
|
|
return false;
|
|
}
|
|
|
|
params.config.secrets ??= {};
|
|
if (Object.keys(currentProviders).length === 0) {
|
|
if ("providers" in params.config.secrets) {
|
|
delete params.config.secrets.providers;
|
|
}
|
|
return true;
|
|
}
|
|
params.config.secrets.providers = currentProviders;
|
|
return true;
|
|
}
|
|
|
|
async function projectPlanState(params: {
|
|
plan: SecretsApplyPlan;
|
|
env: NodeJS.ProcessEnv;
|
|
}): Promise<ProjectedState> {
|
|
const io = createSecretsConfigIO({ env: params.env });
|
|
const { snapshot, writeOptions } = await io.readConfigFileSnapshotForWrite();
|
|
if (!snapshot.valid) {
|
|
throw new Error("Cannot apply secrets plan: config is invalid.");
|
|
}
|
|
|
|
const options = normalizeSecretsPlanOptions(params.plan.options);
|
|
const nextConfig = structuredClone(snapshot.config);
|
|
const stateDir = resolveStateDir(params.env, os.homedir);
|
|
const changedFiles = new Set<string>();
|
|
const warnings: string[] = [];
|
|
const configPath = resolveUserPath(snapshot.path);
|
|
|
|
const providerConfigChanged = applyProviderPlanMutations({
|
|
config: nextConfig,
|
|
upserts: params.plan.providerUpserts,
|
|
deletes: params.plan.providerDeletes,
|
|
});
|
|
if (providerConfigChanged) {
|
|
changedFiles.add(configPath);
|
|
}
|
|
|
|
const targetMutations = applyConfigTargetMutations({
|
|
planTargets: params.plan.targets,
|
|
nextConfig,
|
|
stateDir,
|
|
authStoreByPath: new Map<string, Record<string, unknown>>(),
|
|
changedFiles,
|
|
});
|
|
if (targetMutations.configChanged) {
|
|
changedFiles.add(configPath);
|
|
}
|
|
|
|
const authStoreByPath = scrubAuthStoresForProviderTargets({
|
|
nextConfig,
|
|
stateDir,
|
|
providerTargets: targetMutations.providerTargets,
|
|
scrubbedValues: targetMutations.scrubbedValues,
|
|
authStoreByPath: targetMutations.authStoreByPath,
|
|
changedFiles,
|
|
warnings,
|
|
enabled: options.scrubAuthProfilesForProviderTargets,
|
|
});
|
|
|
|
const authJsonByPath = scrubLegacyAuthJsonStores({
|
|
stateDir,
|
|
changedFiles,
|
|
enabled: options.scrubLegacyAuthJson,
|
|
});
|
|
|
|
const envRawByPath = scrubEnvFiles({
|
|
env: params.env,
|
|
scrubbedValues: targetMutations.scrubbedValues,
|
|
changedFiles,
|
|
enabled: options.scrubEnv,
|
|
});
|
|
|
|
await validateProjectedSecretsState({
|
|
env: params.env,
|
|
nextConfig,
|
|
resolvedTargets: targetMutations.resolvedTargets,
|
|
authStoreByPath,
|
|
});
|
|
|
|
return {
|
|
nextConfig,
|
|
configPath,
|
|
configWriteOptions: writeOptions,
|
|
authStoreByPath,
|
|
authJsonByPath,
|
|
envRawByPath,
|
|
changedFiles,
|
|
warnings,
|
|
};
|
|
}
|
|
|
|
function applyConfigTargetMutations(params: {
|
|
planTargets: SecretsPlanTarget[];
|
|
nextConfig: OpenClawConfig;
|
|
stateDir: string;
|
|
authStoreByPath: Map<string, Record<string, unknown>>;
|
|
changedFiles: Set<string>;
|
|
}): ConfigTargetMutationResult {
|
|
const resolvedTargets = params.planTargets.map((target) => ({
|
|
target,
|
|
resolved: resolveTarget(target),
|
|
}));
|
|
const scrubbedValues = new Set<string>();
|
|
const providerTargets = new Set<string>();
|
|
let configChanged = false;
|
|
|
|
for (const { target, resolved } of resolvedTargets) {
|
|
if (resolved.entry.configFile === "auth-profiles.json") {
|
|
const authStoreChanged = applyAuthProfileTargetMutation({
|
|
target,
|
|
resolved,
|
|
nextConfig: params.nextConfig,
|
|
stateDir: params.stateDir,
|
|
authStoreByPath: params.authStoreByPath,
|
|
scrubbedValues,
|
|
});
|
|
if (authStoreChanged) {
|
|
const agentId = String(target.agentId ?? "").trim();
|
|
if (!agentId) {
|
|
throw new Error(`Missing required agentId for auth-profiles target ${target.path}.`);
|
|
}
|
|
params.changedFiles.add(
|
|
resolveAuthStorePathForAgent({
|
|
nextConfig: params.nextConfig,
|
|
stateDir: params.stateDir,
|
|
agentId,
|
|
}),
|
|
);
|
|
}
|
|
continue;
|
|
}
|
|
|
|
const targetPathSegments = resolved.pathSegments;
|
|
const usesSiblingRef = resolved.entry.secretShape === "sibling_ref"; // pragma: allowlist secret
|
|
if (usesSiblingRef) {
|
|
const previous = getPath(params.nextConfig, targetPathSegments);
|
|
if (isNonEmptyString(previous)) {
|
|
scrubbedValues.add(previous.trim());
|
|
}
|
|
const refPathSegments = resolved.refPathSegments;
|
|
if (!refPathSegments) {
|
|
throw new Error(`Missing sibling ref path for target ${target.type}.`);
|
|
}
|
|
const wroteRef = setPathCreateStrict(params.nextConfig, refPathSegments, target.ref);
|
|
const deletedLegacy = deletePathStrict(params.nextConfig, targetPathSegments);
|
|
if (wroteRef || deletedLegacy) {
|
|
configChanged = true;
|
|
}
|
|
continue;
|
|
}
|
|
|
|
const previous = getPath(params.nextConfig, targetPathSegments);
|
|
if (isNonEmptyString(previous)) {
|
|
scrubbedValues.add(previous.trim());
|
|
}
|
|
const wroteRef = setPathCreateStrict(params.nextConfig, targetPathSegments, target.ref);
|
|
if (wroteRef) {
|
|
configChanged = true;
|
|
}
|
|
if (resolved.entry.trackProviderShadowing && resolved.providerId) {
|
|
providerTargets.add(normalizeProviderId(resolved.providerId));
|
|
}
|
|
}
|
|
|
|
return {
|
|
resolvedTargets,
|
|
scrubbedValues,
|
|
providerTargets,
|
|
configChanged,
|
|
authStoreByPath: params.authStoreByPath,
|
|
};
|
|
}
|
|
|
|
function scrubAuthStoresForProviderTargets(params: {
|
|
nextConfig: OpenClawConfig;
|
|
stateDir: string;
|
|
providerTargets: Set<string>;
|
|
scrubbedValues: Set<string>;
|
|
authStoreByPath: Map<string, Record<string, unknown>>;
|
|
changedFiles: Set<string>;
|
|
warnings: string[];
|
|
enabled: boolean;
|
|
}): Map<string, Record<string, unknown>> {
|
|
if (!params.enabled || params.providerTargets.size === 0) {
|
|
return params.authStoreByPath;
|
|
}
|
|
|
|
for (const authStorePath of listAuthProfileStorePaths(params.nextConfig, params.stateDir)) {
|
|
const existing = params.authStoreByPath.get(authStorePath);
|
|
const parsed = existing ?? readJsonObjectIfExists(authStorePath).value;
|
|
if (!parsed || !isRecord(parsed.profiles)) {
|
|
continue;
|
|
}
|
|
const nextStore = structuredClone(parsed) as Record<string, unknown> & {
|
|
profiles: Record<string, unknown>;
|
|
};
|
|
let mutated = false;
|
|
for (const profile of iterateAuthProfileCredentials(nextStore.profiles)) {
|
|
const provider = normalizeProviderId(profile.provider);
|
|
if (!params.providerTargets.has(provider)) {
|
|
continue;
|
|
}
|
|
if (profile.kind === "api_key" || profile.kind === "token") {
|
|
if (isNonEmptyString(profile.value)) {
|
|
params.scrubbedValues.add(profile.value.trim());
|
|
}
|
|
if (profile.valueField in profile.profile) {
|
|
delete profile.profile[profile.valueField];
|
|
mutated = true;
|
|
}
|
|
if (profile.refField in profile.profile) {
|
|
delete profile.profile[profile.refField];
|
|
mutated = true;
|
|
}
|
|
continue;
|
|
}
|
|
if (profile.kind === "oauth" && (profile.hasAccess || profile.hasRefresh)) {
|
|
params.warnings.push(
|
|
`Provider "${provider}" has OAuth credentials in ${authStorePath}; those still take precedence and are out of scope for static SecretRef migration.`,
|
|
);
|
|
}
|
|
}
|
|
if (mutated) {
|
|
params.authStoreByPath.set(authStorePath, nextStore);
|
|
params.changedFiles.add(authStorePath);
|
|
}
|
|
}
|
|
|
|
return params.authStoreByPath;
|
|
}
|
|
|
|
function ensureMutableAuthStore(
|
|
store: Record<string, unknown> | undefined,
|
|
): MutableAuthProfileStore {
|
|
const next: Record<string, unknown> = store ? structuredClone(store) : {};
|
|
if (!isRecord(next.profiles)) {
|
|
next.profiles = {};
|
|
}
|
|
if (typeof next.version !== "number" || !Number.isFinite(next.version)) {
|
|
next.version = AUTH_STORE_VERSION;
|
|
}
|
|
return next as MutableAuthProfileStore;
|
|
}
|
|
|
|
function resolveAuthStoreForTarget(params: {
|
|
target: SecretsPlanTarget;
|
|
nextConfig: OpenClawConfig;
|
|
stateDir: string;
|
|
authStoreByPath: Map<string, Record<string, unknown>>;
|
|
}): { path: string; store: MutableAuthProfileStore } {
|
|
const agentId = String(params.target.agentId ?? "").trim();
|
|
if (!agentId) {
|
|
throw new Error(`Missing required agentId for auth-profiles target ${params.target.path}.`);
|
|
}
|
|
const authStorePath = resolveAuthStorePathForAgent({
|
|
nextConfig: params.nextConfig,
|
|
stateDir: params.stateDir,
|
|
agentId,
|
|
});
|
|
const existing = params.authStoreByPath.get(authStorePath);
|
|
const loaded = existing ?? readJsonObjectIfExists(authStorePath).value;
|
|
const store = ensureMutableAuthStore(isRecord(loaded) ? loaded : undefined);
|
|
params.authStoreByPath.set(authStorePath, store);
|
|
return { path: authStorePath, store };
|
|
}
|
|
|
|
function asConfigPathRoot(store: MutableAuthProfileStore): OpenClawConfig {
|
|
return store as unknown as OpenClawConfig;
|
|
}
|
|
|
|
function resolveAuthStorePathForAgent(params: {
|
|
nextConfig: OpenClawConfig;
|
|
stateDir: string;
|
|
agentId: string;
|
|
}): string {
|
|
const normalizedAgentId = normalizeAgentId(params.agentId);
|
|
const configuredAgentDir = resolveAgentConfig(
|
|
params.nextConfig,
|
|
normalizedAgentId,
|
|
)?.agentDir?.trim();
|
|
if (configuredAgentDir) {
|
|
return resolveUserPath(resolveAuthStorePath(configuredAgentDir));
|
|
}
|
|
return path.join(
|
|
resolveUserPath(params.stateDir),
|
|
"agents",
|
|
normalizedAgentId,
|
|
"agent",
|
|
"auth-profiles.json",
|
|
);
|
|
}
|
|
|
|
function ensureAuthProfileContainer(params: {
|
|
target: SecretsPlanTarget;
|
|
resolved: ResolvedPlanTargetEntry["resolved"];
|
|
store: MutableAuthProfileStore;
|
|
}): boolean {
|
|
let changed = false;
|
|
const profilePathSegments = params.resolved.pathSegments.slice(0, 2);
|
|
const profileId = profilePathSegments[1];
|
|
if (!profileId) {
|
|
throw new Error(`Invalid auth profile target path: ${params.target.path}`);
|
|
}
|
|
const current = getPath(params.store, profilePathSegments);
|
|
const expectedType = params.resolved.entry.authProfileType;
|
|
if (isRecord(current)) {
|
|
if (expectedType && typeof current.type === "string" && current.type !== expectedType) {
|
|
throw new Error(
|
|
`Auth profile "${profileId}" type mismatch for ${params.target.path}: expected "${expectedType}", got "${current.type}".`,
|
|
);
|
|
}
|
|
if (
|
|
!isNonEmptyString(current.provider) &&
|
|
isNonEmptyString(params.target.authProfileProvider)
|
|
) {
|
|
const wroteProvider = setPathCreateStrict(
|
|
asConfigPathRoot(params.store),
|
|
[...profilePathSegments, "provider"],
|
|
params.target.authProfileProvider,
|
|
);
|
|
changed = changed || wroteProvider;
|
|
}
|
|
return changed;
|
|
}
|
|
if (!expectedType) {
|
|
throw new Error(
|
|
`Auth profile target ${params.target.path} is missing auth profile type metadata.`,
|
|
);
|
|
}
|
|
const provider = String(params.target.authProfileProvider ?? "").trim();
|
|
if (!provider) {
|
|
throw new Error(
|
|
`Cannot create auth profile "${profileId}" for ${params.target.path} without authProfileProvider.`,
|
|
);
|
|
}
|
|
const wroteProfile = setPathCreateStrict(asConfigPathRoot(params.store), profilePathSegments, {
|
|
type: expectedType,
|
|
provider,
|
|
});
|
|
changed = changed || wroteProfile;
|
|
return changed;
|
|
}
|
|
|
|
function applyAuthProfileTargetMutation(params: {
|
|
target: SecretsPlanTarget;
|
|
resolved: ResolvedPlanTargetEntry["resolved"];
|
|
nextConfig: OpenClawConfig;
|
|
stateDir: string;
|
|
authStoreByPath: Map<string, Record<string, unknown>>;
|
|
scrubbedValues: Set<string>;
|
|
}): boolean {
|
|
if (params.resolved.entry.configFile !== "auth-profiles.json") {
|
|
return false;
|
|
}
|
|
const { store } = resolveAuthStoreForTarget({
|
|
target: params.target,
|
|
nextConfig: params.nextConfig,
|
|
stateDir: params.stateDir,
|
|
authStoreByPath: params.authStoreByPath,
|
|
});
|
|
let changed = ensureAuthProfileContainer({
|
|
target: params.target,
|
|
resolved: params.resolved,
|
|
store,
|
|
});
|
|
const targetPathSegments = params.resolved.pathSegments;
|
|
const usesSiblingRef = params.resolved.entry.secretShape === "sibling_ref"; // pragma: allowlist secret
|
|
if (usesSiblingRef) {
|
|
const previous = getPath(store, targetPathSegments);
|
|
if (isNonEmptyString(previous)) {
|
|
params.scrubbedValues.add(previous.trim());
|
|
}
|
|
const refPathSegments = params.resolved.refPathSegments;
|
|
if (!refPathSegments) {
|
|
throw new Error(`Missing sibling ref path for auth-profiles target ${params.target.path}.`);
|
|
}
|
|
const wroteRef = setPathCreateStrict(
|
|
asConfigPathRoot(store),
|
|
refPathSegments,
|
|
params.target.ref,
|
|
);
|
|
const deletedPlaintext = deletePathStrict(asConfigPathRoot(store), targetPathSegments);
|
|
changed = changed || wroteRef || deletedPlaintext;
|
|
return changed;
|
|
}
|
|
const previous = getPath(store, targetPathSegments);
|
|
if (isNonEmptyString(previous)) {
|
|
params.scrubbedValues.add(previous.trim());
|
|
}
|
|
const wroteRef = setPathCreateStrict(
|
|
asConfigPathRoot(store),
|
|
targetPathSegments,
|
|
params.target.ref,
|
|
);
|
|
changed = changed || wroteRef;
|
|
return changed;
|
|
}
|
|
|
|
function scrubLegacyAuthJsonStores(params: {
|
|
stateDir: string;
|
|
changedFiles: Set<string>;
|
|
enabled: boolean;
|
|
}): Map<string, Record<string, unknown>> {
|
|
const authJsonByPath = new Map<string, Record<string, unknown>>();
|
|
if (!params.enabled) {
|
|
return authJsonByPath;
|
|
}
|
|
for (const authJsonPath of listLegacyAuthJsonPaths(params.stateDir)) {
|
|
const parsedResult = readJsonObjectIfExists(authJsonPath);
|
|
const parsed = parsedResult.value;
|
|
if (!parsed) {
|
|
continue;
|
|
}
|
|
let mutated = false;
|
|
const nextParsed = structuredClone(parsed);
|
|
for (const [providerId, value] of Object.entries(nextParsed)) {
|
|
if (!isRecord(value)) {
|
|
continue;
|
|
}
|
|
if (value.type === "api_key" && isNonEmptyString(value.key)) {
|
|
delete nextParsed[providerId];
|
|
mutated = true;
|
|
}
|
|
}
|
|
if (mutated) {
|
|
authJsonByPath.set(authJsonPath, nextParsed);
|
|
params.changedFiles.add(authJsonPath);
|
|
}
|
|
}
|
|
return authJsonByPath;
|
|
}
|
|
|
|
function scrubEnvFiles(params: {
|
|
env: NodeJS.ProcessEnv;
|
|
scrubbedValues: Set<string>;
|
|
changedFiles: Set<string>;
|
|
enabled: boolean;
|
|
}): Map<string, string> {
|
|
const envRawByPath = new Map<string, string>();
|
|
if (!params.enabled || params.scrubbedValues.size === 0) {
|
|
return envRawByPath;
|
|
}
|
|
const envPath = path.join(resolveConfigDir(params.env, os.homedir), ".env");
|
|
if (!fs.existsSync(envPath)) {
|
|
return envRawByPath;
|
|
}
|
|
const current = fs.readFileSync(envPath, "utf8");
|
|
const scrubbed = scrubEnvRaw(
|
|
current,
|
|
params.scrubbedValues,
|
|
new Set(listKnownSecretEnvVarNames()),
|
|
);
|
|
if (scrubbed.removed > 0 && scrubbed.nextRaw !== current) {
|
|
envRawByPath.set(envPath, scrubbed.nextRaw);
|
|
params.changedFiles.add(envPath);
|
|
}
|
|
return envRawByPath;
|
|
}
|
|
|
|
async function validateProjectedSecretsState(params: {
|
|
env: NodeJS.ProcessEnv;
|
|
nextConfig: OpenClawConfig;
|
|
resolvedTargets: ResolvedPlanTargetEntry[];
|
|
authStoreByPath: Map<string, Record<string, unknown>>;
|
|
}): Promise<void> {
|
|
const cache = {};
|
|
for (const { target, resolved: resolvedTarget } of params.resolvedTargets) {
|
|
const resolved = await resolveSecretRefValue(target.ref, {
|
|
config: params.nextConfig,
|
|
env: params.env,
|
|
cache,
|
|
});
|
|
assertExpectedResolvedSecretValue({
|
|
value: resolved,
|
|
expected: resolvedTarget.entry.expectedResolvedValue,
|
|
errorMessage:
|
|
resolvedTarget.entry.expectedResolvedValue === "string"
|
|
? `Ref ${target.ref.source}:${target.ref.provider}:${target.ref.id} is not a non-empty string.`
|
|
: `Ref ${target.ref.source}:${target.ref.provider}:${target.ref.id} is not string/object.`,
|
|
});
|
|
}
|
|
|
|
const authStoreLookup = new Map<string, Record<string, unknown>>();
|
|
for (const [authStorePath, store] of params.authStoreByPath.entries()) {
|
|
authStoreLookup.set(resolveUserPath(authStorePath), store);
|
|
}
|
|
await prepareSecretsRuntimeSnapshot({
|
|
config: params.nextConfig,
|
|
env: params.env,
|
|
loadAuthStore: (agentDir?: string) => {
|
|
const storePath = resolveUserPath(resolveAuthStorePath(agentDir));
|
|
const override = authStoreLookup.get(storePath);
|
|
if (override) {
|
|
return structuredClone(override) as unknown as ReturnType<
|
|
typeof loadAuthProfileStoreForSecretsRuntime
|
|
>;
|
|
}
|
|
return loadAuthProfileStoreForSecretsRuntime(agentDir);
|
|
},
|
|
});
|
|
}
|
|
|
|
function captureFileSnapshot(pathname: string): FileSnapshot {
|
|
if (!fs.existsSync(pathname)) {
|
|
return { existed: false, content: "", mode: 0o600 };
|
|
}
|
|
const stat = fs.statSync(pathname);
|
|
return {
|
|
existed: true,
|
|
content: fs.readFileSync(pathname, "utf8"),
|
|
mode: stat.mode & 0o777,
|
|
};
|
|
}
|
|
|
|
function restoreFileSnapshot(pathname: string, snapshot: FileSnapshot): void {
|
|
if (!snapshot.existed) {
|
|
if (fs.existsSync(pathname)) {
|
|
fs.rmSync(pathname, { force: true });
|
|
}
|
|
return;
|
|
}
|
|
writeTextFileAtomic(pathname, snapshot.content, snapshot.mode || 0o600);
|
|
}
|
|
|
|
function toJsonWrite(pathname: string, value: Record<string, unknown>): ApplyWrite {
|
|
return {
|
|
path: pathname,
|
|
content: `${JSON.stringify(value, null, 2)}\n`,
|
|
mode: 0o600,
|
|
};
|
|
}
|
|
|
|
export async function runSecretsApply(params: {
|
|
plan: SecretsApplyPlan;
|
|
env?: NodeJS.ProcessEnv;
|
|
write?: boolean;
|
|
}): Promise<SecretsApplyResult> {
|
|
const env = params.env ?? process.env;
|
|
const projected = await projectPlanState({ plan: params.plan, env });
|
|
const changedFiles = [...projected.changedFiles].toSorted();
|
|
if (!params.write) {
|
|
return {
|
|
mode: "dry-run",
|
|
changed: changedFiles.length > 0,
|
|
changedFiles,
|
|
warningCount: projected.warnings.length,
|
|
warnings: projected.warnings,
|
|
};
|
|
}
|
|
if (changedFiles.length === 0) {
|
|
return {
|
|
mode: "write",
|
|
changed: false,
|
|
changedFiles: [],
|
|
warningCount: projected.warnings.length,
|
|
warnings: projected.warnings,
|
|
};
|
|
}
|
|
|
|
const io = createSecretsConfigIO({ env });
|
|
const snapshots = new Map<string, FileSnapshot>();
|
|
const capture = (pathname: string) => {
|
|
if (!snapshots.has(pathname)) {
|
|
snapshots.set(pathname, captureFileSnapshot(pathname));
|
|
}
|
|
};
|
|
|
|
capture(projected.configPath);
|
|
const writes: ApplyWrite[] = [];
|
|
for (const [pathname, value] of projected.authStoreByPath.entries()) {
|
|
capture(pathname);
|
|
writes.push(toJsonWrite(pathname, value));
|
|
}
|
|
for (const [pathname, value] of projected.authJsonByPath.entries()) {
|
|
capture(pathname);
|
|
writes.push(toJsonWrite(pathname, value));
|
|
}
|
|
for (const [pathname, raw] of projected.envRawByPath.entries()) {
|
|
capture(pathname);
|
|
writes.push({
|
|
path: pathname,
|
|
content: raw,
|
|
mode: 0o600,
|
|
});
|
|
}
|
|
|
|
try {
|
|
await io.writeConfigFile(projected.nextConfig, projected.configWriteOptions);
|
|
for (const write of writes) {
|
|
writeTextFileAtomic(write.path, write.content, write.mode);
|
|
}
|
|
} catch (err) {
|
|
for (const [pathname, snapshot] of snapshots.entries()) {
|
|
try {
|
|
restoreFileSnapshot(pathname, snapshot);
|
|
} catch {
|
|
// Best effort only; preserve original error.
|
|
}
|
|
}
|
|
throw new Error(`Secrets apply failed: ${String(err)}`, { cause: err });
|
|
}
|
|
|
|
return {
|
|
mode: "write",
|
|
changed: changedFiles.length > 0,
|
|
changedFiles,
|
|
warningCount: projected.warnings.length,
|
|
warnings: projected.warnings,
|
|
};
|
|
}
|