778e775c35
## Thinking Path > - Paperclip orchestrates AI-agent companies and needs secrets handling to work across local development, hosted operators, and governed agent execution. > - The affected subsystem is the company-scoped secrets control plane: database schema, server services/routes, CLI workflows, and the Secrets settings UI. > - The gap was that secrets were local-only and operators could not manage provider vaults or import existing remote references without exposing plaintext. > - This branch adds provider vault configuration plus an AWS Secrets Manager remote-import path while preserving company boundaries, binding context, and audit trails. > - I kept the PR to a single branch PR, removed unrelated lockfile/package drift, rebased the full branch onto the current `public-gh/master`, and addressed fresh Greptile findings. > - The benefit is a reviewable implementation of provider-backed secrets with focused tests covering provider selection, import conflicts, deleted secret reuse, rotation guards, and AWS signing behavior. ## What Changed - Added provider vault support for company secrets, including provider config storage, default vault handling, health checks, binding usage, access events, and remote import preview/commit. - Added an AWS Secrets Manager provider using SigV4 request signing, bounded request timeouts, namespace guardrails, cached runtime credential resolution, and external-reference linking without plaintext reads. - Added Secrets UI surfaces for vault management and remote import, plus CLI/API documentation for setup and operations. - Stabilized routine webhook secret binding paths and SSH environment-driver fixture bindings discovered during verification. - Addressed Greptile and CI findings: no lockfile/package drift, monotonic migration metadata, disabled-vault default races, soft-deleted secret hiding/recreate behavior, remove behavior with disabled vaults, soft-deleted external-reference re-import, non-active rotation guards, managed-secret soft deletion through PATCH, and per-call AWS SDK credential client churn. - Rebased this branch onto `public-gh/master` at `0e1a5828` and force-pushed with lease to keep this as the single PR for the branch. ## Verification - `git fetch public-gh master` - `git rebase public-gh/master` - `git diff --name-only public-gh/master...HEAD | grep '^pnpm-lock\.yaml$' || true` confirmed `pnpm-lock.yaml` is not in the PR diff. - Confirmed migration ordering: master ends at `0081_optimal_dormammu`; this PR adds `0082_dry_vision` and `0083_company_secret_provider_configs`. - Inspected migrations for repeat safety: new tables/indexes use `IF NOT EXISTS`; foreign keys are guarded by `DO $$ ... IF NOT EXISTS`; column additions use `ADD COLUMN IF NOT EXISTS`. - `pnpm -r typecheck` passed before the Greptile follow-up commits. - `pnpm test:run` ran the full stable Vitest path before the Greptile follow-up commits; it completed with 3 timing-related failures under parallel load: `codex-local-execute.test.ts`, `cursor-local-execute.test.ts`, and `environment-service.test.ts`. - `pnpm --filter @paperclipai/server exec vitest run src/__tests__/codex-local-execute.test.ts src/__tests__/cursor-local-execute.test.ts src/__tests__/environment-service.test.ts` passed on targeted rerun (`24/24`). - `pnpm build` passed before the Greptile follow-up commits. Vite reported existing chunk-size/dynamic-import warnings. - After Greptile follow-up commits: `pnpm --filter @paperclipai/server exec vitest run src/__tests__/secrets-service.test.ts` passed (`26/26`). - After Greptile follow-up commits: `pnpm --filter @paperclipai/server exec vitest run src/__tests__/aws-secrets-manager-provider.test.ts src/__tests__/secrets-service.test.ts` passed (`39/39`). - After Greptile follow-up commits: `pnpm --filter @paperclipai/server typecheck` passed. - Captured Storybook screenshots from `ui/storybook-static` for visual review. - Latest PR checks on `5ca3a5cf`: `policy`, serialized server suites 1/4-4/4, `Canary Dry Run`, `e2e`, `security/snyk`, and `Greptile Review` pass; aggregate `verify` is still registering the completed child checks. - Greptile review loop continued through the latest requested pass; all Greptile review threads are resolved and the latest `Greptile Review` check on `5ca3a5cf` passed with 0 comments added. ## Screenshots Before: the provider-vault and remote-import surfaces did not exist on `master`; these are after-state screenshots from the Storybook fixtures.    ## Risks - Migration risk: this adds new secret provider tables and extends existing secret rows. The migrations were checked for monotonic ordering and idempotent guards, but reviewers should still inspect upgrade behavior carefully. - Provider risk: AWS support uses direct SigV4 requests. Automated tests cover signing, request timeouts, vault-config selection, namespace guardrails, pending-version archival, sanitized provider errors, and service-level cleanup paths. A real-vault AWS smoke test remains deployment validation for an operator with AWS credentials rather than an unverified merge blocker in this local branch. - UI risk: the Secrets page and import dialog are large new surfaces; screenshots are included above for reviewer inspection. - Verification risk: the full local stable test command hit parallel-load timing failures, although the exact failed files passed when rerun directly. - Operational risk: remote import intentionally avoids plaintext reads; operators must understand that imported external references resolve at runtime and may fail if AWS permissions change. > For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and discuss it in `#dev` before opening the PR. Feature PRs that overlap with planned core work may need to be redirected — check the roadmap first. See `CONTRIBUTING.md`. ## Model Used - OpenAI Codex, GPT-5 coding agent with local shell/tool use in the Paperclip worktree. Exact context-window size was not exposed by the runtime. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [ ] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] If this change affects the UI, I have included before/after screenshots - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing> Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
324 lines
12 KiB
TypeScript
324 lines
12 KiB
TypeScript
import { useEffect, useRef, useState } from "react";
|
|
import type { CompanySecret, EnvBinding, SecretVersionSelector } from "@paperclipai/shared";
|
|
import { AlertCircle, X } from "lucide-react";
|
|
import { cn } from "../lib/utils";
|
|
|
|
const inputClass =
|
|
"w-full rounded-md border border-border px-2.5 py-1.5 bg-transparent outline-none text-sm font-mono placeholder:text-muted-foreground/40";
|
|
|
|
type Row = {
|
|
key: string;
|
|
source: "plain" | "secret";
|
|
plainValue: string;
|
|
secretId: string;
|
|
version: SecretVersionSelector;
|
|
};
|
|
|
|
function emptyRow(): Row {
|
|
return { key: "", source: "plain", plainValue: "", secretId: "", version: "latest" };
|
|
}
|
|
|
|
function toRows(rec: Record<string, EnvBinding> | null | undefined): Row[] {
|
|
if (!rec || typeof rec !== "object") {
|
|
return [emptyRow()];
|
|
}
|
|
const entries = Object.entries(rec).map(([key, binding]) => {
|
|
if (typeof binding === "string") {
|
|
return { key, source: "plain" as const, plainValue: binding, secretId: "", version: "latest" as const };
|
|
}
|
|
if (
|
|
typeof binding === "object" &&
|
|
binding !== null &&
|
|
"type" in binding &&
|
|
(binding as { type?: unknown }).type === "secret_ref"
|
|
) {
|
|
const record = binding as { secretId?: unknown; version?: unknown };
|
|
const version: SecretVersionSelector = typeof record.version === "number"
|
|
? record.version
|
|
: "latest";
|
|
return {
|
|
key,
|
|
source: "secret" as const,
|
|
plainValue: "",
|
|
secretId: typeof record.secretId === "string" ? record.secretId : "",
|
|
version,
|
|
};
|
|
}
|
|
if (
|
|
typeof binding === "object" &&
|
|
binding !== null &&
|
|
"type" in binding &&
|
|
(binding as { type?: unknown }).type === "plain"
|
|
) {
|
|
const record = binding as { value?: unknown };
|
|
return {
|
|
key,
|
|
source: "plain" as const,
|
|
plainValue: typeof record.value === "string" ? record.value : "",
|
|
secretId: "",
|
|
version: "latest" as const,
|
|
};
|
|
}
|
|
return { key, source: "plain" as const, plainValue: "", secretId: "", version: "latest" as const };
|
|
});
|
|
return [...entries, emptyRow()];
|
|
}
|
|
|
|
export function EnvVarEditor({
|
|
value,
|
|
secrets,
|
|
onCreateSecret,
|
|
onChange,
|
|
}: {
|
|
value: Record<string, EnvBinding>;
|
|
secrets: CompanySecret[];
|
|
onCreateSecret: (name: string, value: string) => Promise<CompanySecret>;
|
|
onChange: (env: Record<string, EnvBinding> | undefined) => void;
|
|
}) {
|
|
const [rows, setRows] = useState<Row[]>(() => toRows(value));
|
|
const [sealError, setSealError] = useState<string | null>(null);
|
|
const valueRef = useRef(value);
|
|
const emittingRef = useRef(false);
|
|
|
|
useEffect(() => {
|
|
if (emittingRef.current) {
|
|
emittingRef.current = false;
|
|
valueRef.current = value;
|
|
return;
|
|
}
|
|
if (value !== valueRef.current) {
|
|
valueRef.current = value;
|
|
setRows(toRows(value));
|
|
}
|
|
}, [value]);
|
|
|
|
function emit(nextRows: Row[]) {
|
|
const rec: Record<string, EnvBinding> = {};
|
|
for (const row of nextRows) {
|
|
const key = row.key.trim();
|
|
if (!key) continue;
|
|
if (row.source === "secret") {
|
|
if (row.secretId) {
|
|
rec[key] = { type: "secret_ref", secretId: row.secretId, version: row.version };
|
|
} else {
|
|
rec[key] = { type: "plain", value: row.plainValue };
|
|
}
|
|
} else {
|
|
rec[key] = { type: "plain", value: row.plainValue };
|
|
}
|
|
}
|
|
emittingRef.current = true;
|
|
onChange(Object.keys(rec).length > 0 ? rec : undefined);
|
|
}
|
|
|
|
function updateRow(index: number, patch: Partial<Row>) {
|
|
const withPatch: Row[] = rows.map((row, rowIndex) =>
|
|
rowIndex === index ? { ...row, ...patch, version: patch.version ?? row.version } : row,
|
|
);
|
|
if (
|
|
withPatch[withPatch.length - 1].key ||
|
|
withPatch[withPatch.length - 1].plainValue ||
|
|
withPatch[withPatch.length - 1].secretId
|
|
) {
|
|
withPatch.push(emptyRow());
|
|
}
|
|
setRows(withPatch);
|
|
emit(withPatch);
|
|
}
|
|
|
|
function removeRow(index: number) {
|
|
const next = rows.filter((_, rowIndex) => rowIndex !== index);
|
|
if (
|
|
next.length === 0 ||
|
|
next[next.length - 1].key ||
|
|
next[next.length - 1].plainValue ||
|
|
next[next.length - 1].secretId
|
|
) {
|
|
next.push(emptyRow());
|
|
}
|
|
setRows(next);
|
|
emit(next);
|
|
}
|
|
|
|
function defaultSecretName(key: string) {
|
|
return key
|
|
.trim()
|
|
.toLowerCase()
|
|
.replace(/[^a-z0-9_]+/g, "_")
|
|
.replace(/^_+|_+$/g, "")
|
|
.slice(0, 64);
|
|
}
|
|
|
|
async function sealRow(index: number) {
|
|
const row = rows[index];
|
|
if (!row) return;
|
|
const key = row.key.trim();
|
|
const plain = row.plainValue;
|
|
if (!key || plain.length === 0) return;
|
|
|
|
const suggested = defaultSecretName(key) || "secret";
|
|
const name = window.prompt("Secret name", suggested)?.trim();
|
|
if (!name) return;
|
|
|
|
try {
|
|
setSealError(null);
|
|
const created = await onCreateSecret(name, plain);
|
|
updateRow(index, { source: "secret", secretId: created.id });
|
|
} catch (error) {
|
|
setSealError(error instanceof Error ? error.message : "Failed to create secret");
|
|
}
|
|
}
|
|
|
|
return (
|
|
<div className="space-y-1.5">
|
|
{rows.map((row, index) => {
|
|
const isTrailing =
|
|
index === rows.length - 1 &&
|
|
!row.key &&
|
|
!row.plainValue &&
|
|
!row.secretId;
|
|
return (
|
|
<div key={index} className="flex items-center gap-1.5">
|
|
<input
|
|
className={cn(inputClass, "flex-[2]")}
|
|
placeholder="KEY"
|
|
value={row.key}
|
|
onChange={(event) => updateRow(index, { key: event.target.value })}
|
|
/>
|
|
<select
|
|
className={cn(inputClass, "flex-[1] bg-background")}
|
|
value={row.source}
|
|
onChange={(event) =>
|
|
updateRow(index, {
|
|
source: event.target.value === "secret" ? "secret" : "plain",
|
|
...(event.target.value === "plain" ? { secretId: "" } : {}),
|
|
})
|
|
}
|
|
>
|
|
<option value="plain">Plain</option>
|
|
<option value="secret">Secret</option>
|
|
</select>
|
|
{row.source === "secret" ? (
|
|
<>
|
|
<select
|
|
className={cn(inputClass, "flex-[3] bg-background", row.secretId && !secrets.some((s) => s.id === row.secretId) && "border-destructive text-destructive")}
|
|
value={row.secretId}
|
|
onChange={(event) => updateRow(index, { secretId: event.target.value })}
|
|
>
|
|
<option value="">Select secret...</option>
|
|
{row.secretId && !secrets.some((s) => s.id === row.secretId) ? (
|
|
<option value={row.secretId}>Missing ({row.secretId.slice(0, 8)}…)</option>
|
|
) : null}
|
|
{secrets.map((secret) => (
|
|
<option key={secret.id} value={secret.id}>
|
|
{secret.name}
|
|
{secret.status !== "active" ? ` (${secret.status})` : ""}
|
|
</option>
|
|
))}
|
|
</select>
|
|
<select
|
|
className={cn(inputClass, "flex-[1] bg-background")}
|
|
value={row.version === "latest" ? "latest" : String(row.version)}
|
|
onChange={(event) => {
|
|
const raw = event.target.value;
|
|
updateRow(index, { version: raw === "latest" ? "latest" : Number.parseInt(raw, 10) });
|
|
}}
|
|
disabled={!row.secretId}
|
|
aria-label="Version"
|
|
>
|
|
<option value="latest">latest</option>
|
|
{(() => {
|
|
const selected = secrets.find((s) => s.id === row.secretId);
|
|
if (!selected) return null;
|
|
return Array.from({ length: Math.max(0, selected.latestVersion) }, (_, idx) => {
|
|
const version = selected.latestVersion - idx;
|
|
if (version <= 0) return null;
|
|
return (
|
|
<option key={version} value={version}>
|
|
v{version}
|
|
</option>
|
|
);
|
|
});
|
|
})()}
|
|
</select>
|
|
<button
|
|
type="button"
|
|
className="inline-flex items-center rounded-md border border-border px-2 py-0.5 text-xs text-muted-foreground hover:bg-accent/50 transition-colors shrink-0"
|
|
onClick={() => sealRow(index)}
|
|
disabled={!row.key.trim() || !row.plainValue}
|
|
title="Create secret from current plain value"
|
|
>
|
|
New
|
|
</button>
|
|
</>
|
|
) : (
|
|
<>
|
|
<input
|
|
className={cn(inputClass, "flex-[3]")}
|
|
placeholder="value"
|
|
value={row.plainValue}
|
|
onChange={(event) => updateRow(index, { plainValue: event.target.value })}
|
|
/>
|
|
<button
|
|
type="button"
|
|
className="inline-flex items-center rounded-md border border-border px-2 py-0.5 text-xs text-muted-foreground hover:bg-accent/50 transition-colors shrink-0"
|
|
onClick={() => sealRow(index)}
|
|
disabled={!row.key.trim() || !row.plainValue}
|
|
title="Store value as secret and replace with reference"
|
|
>
|
|
Seal
|
|
</button>
|
|
</>
|
|
)}
|
|
{!isTrailing ? (
|
|
<button
|
|
type="button"
|
|
className="shrink-0 p-1 rounded hover:bg-destructive/10 text-muted-foreground hover:text-destructive transition-colors"
|
|
onClick={() => removeRow(index)}
|
|
>
|
|
<X className="h-3.5 w-3.5" />
|
|
</button>
|
|
) : (
|
|
<div className="w-[26px] shrink-0" />
|
|
)}
|
|
</div>
|
|
);
|
|
})}
|
|
{sealError && <p className="text-[11px] text-destructive">{sealError}</p>}
|
|
{(() => {
|
|
const issues: { key: string; reason: string }[] = [];
|
|
for (const row of rows) {
|
|
if (row.source !== "secret" || !row.secretId) continue;
|
|
const secret = secrets.find((s) => s.id === row.secretId);
|
|
if (!secret) {
|
|
issues.push({ key: row.key.trim() || row.secretId, reason: "missing" });
|
|
} else if (secret.status !== "active") {
|
|
issues.push({ key: row.key.trim() || secret.name, reason: secret.status });
|
|
}
|
|
}
|
|
if (!issues.length) return null;
|
|
return (
|
|
<p className="text-[11px] text-amber-700 dark:text-amber-400 inline-flex items-start gap-1">
|
|
<AlertCircle className="h-3 w-3 mt-0.5 shrink-0" />
|
|
<span>
|
|
{issues.length} secret binding{issues.length === 1 ? "" : "s"} need attention:{" "}
|
|
{issues.map((issue, idx) => (
|
|
<span key={idx} className="font-mono">
|
|
{issue.key}
|
|
<span className="text-muted-foreground"> ({issue.reason})</span>
|
|
{idx < issues.length - 1 ? ", " : ""}
|
|
</span>
|
|
))}
|
|
. Runs will fail until you remap or re-enable.
|
|
</span>
|
|
</p>
|
|
);
|
|
})()}
|
|
<p className="text-[11px] text-muted-foreground/60">
|
|
Set KEY to the env var name the process expects, for example GH_TOKEN. Choose Secret to resolve a stored
|
|
value at run start. PAPERCLIP_* variables are injected automatically.
|
|
</p>
|
|
</div>
|
|
);
|
|
}
|