forked from farhoodlabs/paperclip
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>
258 lines
6.9 KiB
TypeScript
258 lines
6.9 KiB
TypeScript
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
|
import type { Agent, CompanySecret } from "@paperclipai/shared";
|
|
import type { PaperclipConfig } from "../config/schema.js";
|
|
import { secretsCheck } from "../checks/secrets-check.js";
|
|
import {
|
|
buildInlineMigrationSecretName,
|
|
buildMigratedAgentEnv,
|
|
collectInlineSecretMigrationCandidates,
|
|
parseSecretsInclude,
|
|
toPlainEnvValue,
|
|
} from "../commands/client/secrets.js";
|
|
|
|
function agent(partial: Partial<Agent>): Agent {
|
|
return {
|
|
id: "agent-12345678",
|
|
companyId: "company-1",
|
|
name: "Coder",
|
|
urlKey: "coder",
|
|
role: "engineer",
|
|
title: null,
|
|
icon: null,
|
|
status: "idle",
|
|
reportsTo: null,
|
|
capabilities: null,
|
|
adapterType: "codex_local",
|
|
adapterConfig: {},
|
|
runtimeConfig: {},
|
|
budgetMonthlyCents: 0,
|
|
spentMonthlyCents: 0,
|
|
pauseReason: null,
|
|
pausedAt: null,
|
|
permissions: {
|
|
canCreateAgents: false,
|
|
},
|
|
lastHeartbeatAt: null,
|
|
metadata: null,
|
|
createdAt: new Date("2026-04-26T00:00:00.000Z"),
|
|
updatedAt: new Date("2026-04-26T00:00:00.000Z"),
|
|
...partial,
|
|
};
|
|
}
|
|
|
|
function secret(partial: Partial<CompanySecret>): CompanySecret {
|
|
return {
|
|
id: "secret-1",
|
|
companyId: "company-1",
|
|
key: "agent_agent-12_anthropic_api_key",
|
|
name: "agent_agent-12_anthropic_api_key",
|
|
provider: "local_encrypted",
|
|
status: "active",
|
|
managedMode: "paperclip_managed",
|
|
externalRef: null,
|
|
providerConfigId: null,
|
|
providerMetadata: null,
|
|
latestVersion: 1,
|
|
description: null,
|
|
lastResolvedAt: null,
|
|
lastRotatedAt: null,
|
|
deletedAt: null,
|
|
createdByAgentId: null,
|
|
createdByUserId: null,
|
|
createdAt: new Date("2026-04-26T00:00:00.000Z"),
|
|
updatedAt: new Date("2026-04-26T00:00:00.000Z"),
|
|
...partial,
|
|
};
|
|
}
|
|
|
|
function configWithSecretsProvider(provider: PaperclipConfig["secrets"]["provider"]): PaperclipConfig {
|
|
return {
|
|
$meta: {
|
|
version: 1,
|
|
updatedAt: "2026-05-02T00:00:00.000Z",
|
|
source: "configure",
|
|
},
|
|
database: {
|
|
mode: "embedded-postgres",
|
|
embeddedPostgresDataDir: "/tmp/paperclip/db",
|
|
embeddedPostgresPort: 55432,
|
|
backup: {
|
|
enabled: true,
|
|
intervalMinutes: 60,
|
|
retentionDays: 30,
|
|
dir: "/tmp/paperclip/backups",
|
|
},
|
|
},
|
|
logging: {
|
|
mode: "file",
|
|
logDir: "/tmp/paperclip/logs",
|
|
},
|
|
server: {
|
|
deploymentMode: "local_trusted",
|
|
exposure: "private",
|
|
host: "127.0.0.1",
|
|
port: 3100,
|
|
allowedHostnames: [],
|
|
serveUi: true,
|
|
},
|
|
auth: {
|
|
baseUrlMode: "auto",
|
|
disableSignUp: false,
|
|
},
|
|
telemetry: {
|
|
enabled: true,
|
|
},
|
|
storage: {
|
|
provider: "local_disk",
|
|
localDisk: {
|
|
baseDir: "/tmp/paperclip/storage",
|
|
},
|
|
s3: {
|
|
bucket: "paperclip",
|
|
region: "us-east-1",
|
|
prefix: "",
|
|
forcePathStyle: false,
|
|
},
|
|
},
|
|
secrets: {
|
|
provider,
|
|
strictMode: true,
|
|
localEncrypted: {
|
|
keyFilePath: "/tmp/paperclip/secrets/master.key",
|
|
},
|
|
},
|
|
};
|
|
}
|
|
|
|
describe("secrets CLI helpers", () => {
|
|
const originalEnv = { ...process.env };
|
|
|
|
beforeEach(() => {
|
|
process.env = { ...originalEnv };
|
|
delete process.env.PAPERCLIP_SECRETS_AWS_REGION;
|
|
delete process.env.AWS_REGION;
|
|
delete process.env.AWS_DEFAULT_REGION;
|
|
delete process.env.PAPERCLIP_SECRETS_AWS_DEPLOYMENT_ID;
|
|
delete process.env.PAPERCLIP_SECRETS_AWS_KMS_KEY_ID;
|
|
});
|
|
|
|
afterEach(() => {
|
|
process.env = { ...originalEnv };
|
|
});
|
|
|
|
it("parses declaration include filters", () => {
|
|
expect(parseSecretsInclude("agents,projects,tasks")).toEqual({
|
|
company: false,
|
|
agents: true,
|
|
projects: true,
|
|
issues: true,
|
|
skills: false,
|
|
});
|
|
});
|
|
|
|
it("detects inline sensitive env values that need migration", () => {
|
|
const rows = collectInlineSecretMigrationCandidates(
|
|
[
|
|
agent({
|
|
id: "agent-12345678",
|
|
adapterConfig: {
|
|
env: {
|
|
ANTHROPIC_API_KEY: "sk-ant-test",
|
|
GH_TOKEN: {
|
|
type: "plain",
|
|
value: "ghp-test",
|
|
},
|
|
PATH: {
|
|
type: "plain",
|
|
value: "/usr/bin",
|
|
},
|
|
OPENAI_API_KEY: {
|
|
type: "secret_ref",
|
|
secretId: "secret-existing",
|
|
},
|
|
},
|
|
},
|
|
}),
|
|
],
|
|
[
|
|
secret({
|
|
id: "secret-gh-token",
|
|
name: buildInlineMigrationSecretName("agent-12345678", "GH_TOKEN"),
|
|
}),
|
|
],
|
|
);
|
|
|
|
expect(rows).toEqual([
|
|
{
|
|
agentId: "agent-12345678",
|
|
agentName: "Coder",
|
|
envKey: "ANTHROPIC_API_KEY",
|
|
secretName: "agent_agent-12_anthropic_api_key",
|
|
existingSecretId: null,
|
|
},
|
|
{
|
|
agentId: "agent-12345678",
|
|
agentName: "Coder",
|
|
envKey: "GH_TOKEN",
|
|
secretName: "agent_agent-12_gh_token",
|
|
existingSecretId: "secret-gh-token",
|
|
},
|
|
]);
|
|
});
|
|
|
|
it("builds migrated env bindings without preserving secret values", () => {
|
|
const next = buildMigratedAgentEnv(
|
|
{
|
|
ANTHROPIC_API_KEY: "sk-ant-test",
|
|
NODE_ENV: {
|
|
type: "plain",
|
|
value: "development",
|
|
},
|
|
},
|
|
new Map([["ANTHROPIC_API_KEY", "secret-1"]]),
|
|
);
|
|
|
|
expect(next).toEqual({
|
|
ANTHROPIC_API_KEY: {
|
|
type: "secret_ref",
|
|
secretId: "secret-1",
|
|
version: "latest",
|
|
},
|
|
NODE_ENV: {
|
|
type: "plain",
|
|
value: "development",
|
|
},
|
|
});
|
|
expect(JSON.stringify(next)).not.toContain("sk-ant-test");
|
|
});
|
|
|
|
it("reads only explicit plain env values", () => {
|
|
expect(toPlainEnvValue("plain-value")).toBe("plain-value");
|
|
expect(toPlainEnvValue({ type: "plain", value: "wrapped" })).toBe("wrapped");
|
|
expect(toPlainEnvValue({ type: "secret_ref", secretId: "secret-1" })).toBeNull();
|
|
});
|
|
|
|
it("reports the AWS bootstrap config required by doctor", () => {
|
|
const result = secretsCheck(configWithSecretsProvider("aws_secrets_manager"));
|
|
|
|
expect(result.status).toBe("fail");
|
|
expect(result.message).toContain("PAPERCLIP_SECRETS_AWS_DEPLOYMENT_ID");
|
|
expect(result.repairHint).toContain("AWS SDK default credential chain");
|
|
expect(result.repairHint).toContain("Do not store AWS root credentials");
|
|
});
|
|
|
|
it("passes AWS doctor checks when non-secret provider config is present", () => {
|
|
process.env.PAPERCLIP_SECRETS_AWS_REGION = "us-east-1";
|
|
process.env.PAPERCLIP_SECRETS_AWS_DEPLOYMENT_ID = "prod-us-1";
|
|
process.env.PAPERCLIP_SECRETS_AWS_KMS_KEY_ID =
|
|
"arn:aws:kms:us-east-1:123456789012:key/test";
|
|
process.env.AWS_PROFILE = "paperclip-prod";
|
|
|
|
const result = secretsCheck(configWithSecretsProvider("aws_secrets_manager"));
|
|
|
|
expect(result.status).toBe("pass");
|
|
expect(result.message).toContain("prod-us-1");
|
|
expect(result.message).toContain("AWS_PROFILE/shared config");
|
|
});
|
|
});
|