forked from farhoodlabs/paperclip
Add secrets provider vaults and remote import (#5429)
## 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>
This commit is contained in:
Dotta
@@ -5,6 +5,8 @@ import type {
|
||||
AuthSession,
|
||||
BudgetPolicySummary,
|
||||
Company,
|
||||
CompanySecret,
|
||||
CompanySecretBinding,
|
||||
DashboardSummary,
|
||||
ExecutionWorkspace,
|
||||
Goal,
|
||||
@@ -12,6 +14,8 @@ import type {
|
||||
IssueDocument,
|
||||
IssueLabel,
|
||||
Project,
|
||||
SecretAccessEvent,
|
||||
SecretProviderDescriptor,
|
||||
SidebarBadges,
|
||||
WorkspaceRuntimeService,
|
||||
} from "@paperclipai/shared";
|
||||
@@ -1303,3 +1307,229 @@ export const storybookLiveRuns: LiveRunForIssue[] = [
|
||||
nextAction: "Build fixture-backed navigation stories",
|
||||
},
|
||||
];
|
||||
|
||||
export const storybookSecretProviders: SecretProviderDescriptor[] = [
|
||||
{ id: "local_encrypted", label: "Local encrypted", requiresExternalRef: false },
|
||||
{ id: "aws_secrets_manager", label: "AWS Secrets Manager", requiresExternalRef: false },
|
||||
{ id: "gcp_secret_manager", label: "GCP Secret Manager", requiresExternalRef: false },
|
||||
{ id: "vault", label: "HashiCorp Vault", requiresExternalRef: false },
|
||||
];
|
||||
|
||||
export const storybookSecrets: CompanySecret[] = [
|
||||
{
|
||||
id: "secret-openai",
|
||||
companyId: "company-storybook",
|
||||
key: "openai_api_key",
|
||||
name: "OPENAI_API_KEY",
|
||||
provider: "local_encrypted",
|
||||
status: "active",
|
||||
managedMode: "paperclip_managed",
|
||||
externalRef: null,
|
||||
providerConfigId: null,
|
||||
providerMetadata: null,
|
||||
latestVersion: 3,
|
||||
description: "OpenAI API key shared by all model adapters.",
|
||||
lastResolvedAt: recent(12),
|
||||
lastRotatedAt: new Date("2026-04-15T09:30:00.000Z"),
|
||||
deletedAt: null,
|
||||
createdByAgentId: null,
|
||||
createdByUserId: "user-board",
|
||||
createdAt: new Date("2026-03-01T10:00:00.000Z"),
|
||||
updatedAt: recent(12),
|
||||
},
|
||||
{
|
||||
id: "secret-aws-prod",
|
||||
companyId: "company-storybook",
|
||||
key: "prod_aws_deploy",
|
||||
name: "PROD_AWS_DEPLOY_KEY",
|
||||
provider: "aws_secrets_manager",
|
||||
status: "active",
|
||||
managedMode: "external_reference",
|
||||
externalRef: "arn:aws:secretsmanager:us-east-1:123456789012:secret:paperclip/prod/aws-deploy-AbCdEf",
|
||||
providerConfigId: null,
|
||||
providerMetadata: null,
|
||||
latestVersion: 2,
|
||||
description: "Deploy key for the prod ECS rollout pipeline.",
|
||||
lastResolvedAt: recent(180),
|
||||
lastRotatedAt: new Date("2026-04-22T14:00:00.000Z"),
|
||||
deletedAt: null,
|
||||
createdByAgentId: null,
|
||||
createdByUserId: "user-board",
|
||||
createdAt: new Date("2026-02-01T10:00:00.000Z"),
|
||||
updatedAt: recent(180),
|
||||
},
|
||||
{
|
||||
id: "secret-github",
|
||||
companyId: "company-storybook",
|
||||
key: "github_app_pem",
|
||||
name: "GITHUB_APP_PEM",
|
||||
provider: "local_encrypted",
|
||||
status: "disabled",
|
||||
managedMode: "paperclip_managed",
|
||||
externalRef: null,
|
||||
providerConfigId: null,
|
||||
providerMetadata: null,
|
||||
latestVersion: 1,
|
||||
description: "Disabled until GitHub App reinstall is approved.",
|
||||
lastResolvedAt: new Date("2026-03-30T08:11:00.000Z"),
|
||||
lastRotatedAt: null,
|
||||
deletedAt: null,
|
||||
createdByAgentId: null,
|
||||
createdByUserId: "user-board",
|
||||
createdAt: new Date("2026-03-15T10:00:00.000Z"),
|
||||
updatedAt: new Date("2026-04-21T11:30:00.000Z"),
|
||||
},
|
||||
{
|
||||
id: "secret-stripe-archived",
|
||||
companyId: "company-storybook",
|
||||
key: "stripe_legacy",
|
||||
name: "STRIPE_LEGACY",
|
||||
provider: "vault",
|
||||
status: "archived",
|
||||
managedMode: "external_reference",
|
||||
externalRef: "secret/data/payments/stripe-legacy",
|
||||
providerConfigId: null,
|
||||
providerMetadata: null,
|
||||
latestVersion: 4,
|
||||
description: "Migrated to managed billing service. Kept for backfill jobs.",
|
||||
lastResolvedAt: new Date("2026-02-25T08:11:00.000Z"),
|
||||
lastRotatedAt: new Date("2026-02-20T08:11:00.000Z"),
|
||||
deletedAt: null,
|
||||
createdByAgentId: null,
|
||||
createdByUserId: "user-board",
|
||||
createdAt: new Date("2025-12-01T10:00:00.000Z"),
|
||||
updatedAt: new Date("2026-03-01T11:30:00.000Z"),
|
||||
},
|
||||
];
|
||||
|
||||
export const storybookSecretBindings: CompanySecretBinding[] = [
|
||||
{
|
||||
id: "binding-openai-agent",
|
||||
companyId: "company-storybook",
|
||||
secretId: "secret-openai",
|
||||
targetType: "agent",
|
||||
targetId: "agent-codex",
|
||||
configPath: "env.OPENAI_API_KEY",
|
||||
versionSelector: "latest",
|
||||
required: true,
|
||||
label: "Codex agent env",
|
||||
createdAt: new Date("2026-03-02T09:00:00.000Z"),
|
||||
updatedAt: new Date("2026-03-02T09:00:00.000Z"),
|
||||
},
|
||||
{
|
||||
id: "binding-openai-project",
|
||||
companyId: "company-storybook",
|
||||
secretId: "secret-openai",
|
||||
targetType: "project",
|
||||
targetId: "project-app",
|
||||
configPath: "env.OPENAI_API_KEY",
|
||||
versionSelector: "latest",
|
||||
required: true,
|
||||
label: "Paperclip App project env",
|
||||
createdAt: new Date("2026-03-02T09:00:00.000Z"),
|
||||
updatedAt: new Date("2026-03-02T09:00:00.000Z"),
|
||||
},
|
||||
{
|
||||
id: "binding-aws-environment",
|
||||
companyId: "company-storybook",
|
||||
secretId: "secret-aws-prod",
|
||||
targetType: "environment",
|
||||
targetId: "env-prod",
|
||||
configPath: "secrets.AWS_DEPLOY",
|
||||
versionSelector: 2,
|
||||
required: true,
|
||||
label: "Prod environment",
|
||||
createdAt: new Date("2026-04-22T14:01:00.000Z"),
|
||||
updatedAt: new Date("2026-04-22T14:01:00.000Z"),
|
||||
},
|
||||
];
|
||||
|
||||
export const storybookSecretAccessEvents: SecretAccessEvent[] = [
|
||||
{
|
||||
id: "evt-1",
|
||||
companyId: "company-storybook",
|
||||
secretId: "secret-openai",
|
||||
version: 3,
|
||||
provider: "local_encrypted",
|
||||
actorType: "agent",
|
||||
actorId: "agent-codex",
|
||||
consumerType: "agent",
|
||||
consumerId: "agent-codex",
|
||||
configPath: "env.OPENAI_API_KEY",
|
||||
issueId: "issue-storybook-1",
|
||||
heartbeatRunId: "run-storybook",
|
||||
pluginId: null,
|
||||
outcome: "success",
|
||||
errorCode: null,
|
||||
createdAt: recent(12),
|
||||
},
|
||||
{
|
||||
id: "evt-2",
|
||||
companyId: "company-storybook",
|
||||
secretId: "secret-openai",
|
||||
version: 3,
|
||||
provider: "local_encrypted",
|
||||
actorType: "system",
|
||||
actorId: null,
|
||||
consumerType: "project",
|
||||
consumerId: "project-app",
|
||||
configPath: "env.OPENAI_API_KEY",
|
||||
issueId: null,
|
||||
heartbeatRunId: null,
|
||||
pluginId: null,
|
||||
outcome: "success",
|
||||
errorCode: null,
|
||||
createdAt: recent(48),
|
||||
},
|
||||
{
|
||||
id: "evt-3",
|
||||
companyId: "company-storybook",
|
||||
secretId: "secret-openai",
|
||||
version: null,
|
||||
provider: "local_encrypted",
|
||||
actorType: "agent",
|
||||
actorId: "agent-codex",
|
||||
consumerType: "agent",
|
||||
consumerId: "agent-codex",
|
||||
configPath: "env.OPENAI_API_KEY",
|
||||
issueId: "issue-storybook-1",
|
||||
heartbeatRunId: "run-storybook",
|
||||
pluginId: null,
|
||||
outcome: "failure",
|
||||
errorCode: "secret_disabled",
|
||||
createdAt: recent(360),
|
||||
},
|
||||
];
|
||||
|
||||
export const storybookSecretProviderHealth = {
|
||||
providers: [
|
||||
{
|
||||
provider: "local_encrypted" as const,
|
||||
status: "ok" as const,
|
||||
message: "Encryption key loaded; permissions OK.",
|
||||
warnings: [] as string[],
|
||||
backupGuidance: ["Backup ~/.paperclip/instances/default/secrets/key separately from the database."],
|
||||
},
|
||||
{
|
||||
provider: "aws_secrets_manager" as const,
|
||||
status: "warn" as const,
|
||||
message: "Connected; KMS key rotation policy not yet enforced.",
|
||||
warnings: ["Set up automated KMS key rotation for production tenants."],
|
||||
backupGuidance: [],
|
||||
},
|
||||
{
|
||||
provider: "gcp_secret_manager" as const,
|
||||
status: "ok" as const,
|
||||
message: "Service account reachable.",
|
||||
warnings: [] as string[],
|
||||
backupGuidance: [],
|
||||
},
|
||||
{
|
||||
provider: "vault" as const,
|
||||
status: "ok" as const,
|
||||
message: "KV v2 mount reachable.",
|
||||
warnings: [] as string[],
|
||||
backupGuidance: [],
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user