ake/paperclip
1
0
Fork 0
mirror of https://github.com/alkimake/paperclip.git synced 2026-06-14 01:50:39 +09:00
Code Issues Projects Releases Packages Wiki Activity
paperclip/doc/plans
History
Dotta 778e775c35
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.

![Secrets
inventory](https://raw.githubusercontent.com/paperclipai/paperclip/PAP-2339-secrets-make-a-plan/doc/pr/5429/secrets-inventory.png)

![Secret binding
picker](https://raw.githubusercontent.com/paperclipai/paperclip/PAP-2339-secrets-make-a-plan/doc/pr/5429/secret-binding-picker.png)

![Environment editor with
secrets](https://raw.githubusercontent.com/paperclipai/paperclip/PAP-2339-secrets-make-a-plan/doc/pr/5429/env-editor-with-secrets.png)

## 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>
2026-05-09 18:22:17 -05:00
..
2026-02-16-module-system.md Add company import export v2 plan 2026-03-13 21:10:45 -05:00
2026-02-18-agent-authentication-implementation.md docs: organize plans into doc/plans with date prefixes 2026-03-13 09:11:56 -05:00
2026-02-18-agent-authentication.md docs: organize plans into doc/plans with date prefixes 2026-03-13 09:11:56 -05:00
2026-02-19-agent-mgmt-followup-plan.md docs: organize plans into doc/plans with date prefixes 2026-03-13 09:11:56 -05:00
2026-02-19-ceo-agent-creation-and-hiring.md docs: organize plans into doc/plans with date prefixes 2026-03-13 09:11:56 -05:00
2026-02-20-issue-run-orchestration-plan.md docs: organize plans into doc/plans with date prefixes 2026-03-13 09:11:56 -05:00
2026-02-20-storage-system-implementation.md docs: organize plans into doc/plans with date prefixes 2026-03-13 09:11:56 -05:00
2026-02-21-humans-and-permissions-implementation.md docs: organize plans into doc/plans with date prefixes 2026-03-13 09:11:56 -05:00
2026-02-21-humans-and-permissions.md docs: organize plans into doc/plans with date prefixes 2026-03-13 09:11:56 -05:00
2026-02-23-cursor-cloud-adapter.md docs: organize plans into doc/plans with date prefixes 2026-03-13 09:11:56 -05:00
2026-02-23-deployment-auth-mode-consolidation.md docs: organize plans into doc/plans with date prefixes 2026-03-13 09:11:56 -05:00
2026-03-10-workspace-strategy-and-git-worktrees.md docs: organize plans into doc/plans with date prefixes 2026-03-13 09:11:56 -05:00
2026-03-11-agent-chat-ui-and-issue-backed-conversations.md docs: organize plans into doc/plans with date prefixes 2026-03-13 09:11:56 -05:00
2026-03-13-agent-evals-framework.md docs: add agent evals framework plan 2026-03-13 15:07:56 -05:00
2026-03-13-company-import-export-v2.md Use positional source arg for company import 2026-03-23 08:14:51 -05:00
2026-03-13-features.md docs: update PRODUCT.md and add 2026-03-13 features plan 2026-03-13 07:25:23 -05:00
2026-03-13-paperclip-skill-tightening-plan.md docs: add paperclip skill tightening plan 2026-03-13 14:37:44 -05:00
2026-03-13-plugin-kitchen-sink-example.md Add kitchen sink plugin example 2026-03-13 23:03:51 -05:00
2026-03-13-TOKEN-OPTIMIZATION-PLAN.md fix: isolate codex home in worktrees 2026-03-13 11:53:56 -05:00
2026-03-13-workspace-product-model-and-work-product.md docs: add dated plan naming rule and align workspace plan 2026-03-13 09:16:28 -05:00
2026-03-14-adapter-skill-sync-rollout.md Refine portability export behavior and skill plans 2026-03-14 18:59:26 -05:00
2026-03-14-billing-ledger-and-reporting.md feat(costs): add billing, quota, and budget control plane 2026-03-16 15:11:01 -05:00
2026-03-14-budget-policies-and-enforcement.md feat(costs): add billing, quota, and budget control plane 2026-03-16 15:11:01 -05:00
2026-03-14-skills-ui-product-plan.md Refine portability export behavior and skill plans 2026-03-14 18:59:26 -05:00
2026-03-17-docker-release-browser-e2e.md feat: add release smoke workflow 2026-03-18 07:59:32 -05:00
2026-03-17-memory-service-surface-api.md chore: improve worktree tooling and security docs 2026-04-10 22:26:30 -05:00
2026-03-17-release-automation-and-versioning.md chore: switch release calver to mdd patch 2026-03-18 07:57:36 -05:00
2026-04-06-smart-model-routing.md docs: add smart model routing plan 2026-04-06 21:23:33 -05:00
2026-04-06-subissue-creation-on-issue-detail.md docs: add sub-issue issue detail plan 2026-04-06 21:24:22 -05:00
2026-04-07-issue-detail-speed-and-optimistic-inventory.md docs: add issue detail speed inventory plan 2026-04-09 06:14:12 -05:00
2026-04-07-pi-hooks-survey.md docs: survey pi and pi-mono hook surfaces 2026-04-09 06:14:12 -05:00
2026-04-08-agent-browser-process-cleanup-plan.md docs: add browser process cleanup plan 2026-04-09 06:14:12 -05:00
2026-04-08-agent-os-follow-up-plan.md docs: add agent-os follow-up plan 2026-04-09 06:14:12 -05:00
2026-04-08-agent-os-technical-report.md docs: add agent-os technical report 2026-04-09 06:14:12 -05:00
2026-04-12-vscode-task-interoperability-plan.md [codex] Harden execution reliability and heartbeat tooling (#3679) 2026-04-14 13:34:52 -05:00
2026-04-26-plugin-secret-ref-company-scope.md Add secrets provider vaults and remote import (#5429) 2026-05-09 18:22:17 -05:00
workspace-product-model-and-work-product.md Incorporate Worktrunk patterns into workspace plan 2026-03-13 09:41:12 -05:00
workspace-technical-implementation.md Add workspace technical implementation spec 2026-03-13 16:37:40 -05:00