mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-26 18:31:34 +01:00
## 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>
88 lines
2.7 KiB
TypeScript
88 lines
2.7 KiB
TypeScript
import { unprocessable } from "../errors.js";
|
|
import type { PreparedSecretVersion, SecretProviderModule } from "./types.js";
|
|
import { createHash } from "node:crypto";
|
|
|
|
function unavailableProvider(
|
|
id: "aws_secrets_manager" | "gcp_secret_manager" | "vault",
|
|
label: string,
|
|
): SecretProviderModule {
|
|
function externalFingerprint(externalRef: string, providerVersionRef: string | null): string {
|
|
return createHash("sha256")
|
|
.update(`${id}:${externalRef}:${providerVersionRef ?? ""}`)
|
|
.digest("hex");
|
|
}
|
|
|
|
function prepareExternalReference(input: {
|
|
externalRef: string;
|
|
providerVersionRef?: string | null;
|
|
}): PreparedSecretVersion {
|
|
const externalRef = input.externalRef.trim();
|
|
const providerVersionRef = input.providerVersionRef?.trim() || null;
|
|
const fingerprint = externalFingerprint(externalRef, providerVersionRef);
|
|
return {
|
|
material: {
|
|
scheme: "external_reference_v1",
|
|
provider: id,
|
|
externalRef,
|
|
providerVersionRef,
|
|
},
|
|
valueSha256: fingerprint,
|
|
fingerprintSha256: fingerprint,
|
|
externalRef,
|
|
providerVersionRef,
|
|
};
|
|
}
|
|
|
|
return {
|
|
id,
|
|
descriptor() {
|
|
return {
|
|
id,
|
|
label,
|
|
requiresExternalRef: true,
|
|
supportsManagedValues: false,
|
|
supportsExternalReferences: true,
|
|
configured: false,
|
|
};
|
|
},
|
|
async validateConfig() {
|
|
return { ok: false, warnings: [`${id} provider is not configured in this deployment`] };
|
|
},
|
|
async createSecret() {
|
|
throw unprocessable(`${id} provider is not configured for Paperclip-managed values`);
|
|
},
|
|
async createVersion() {
|
|
throw unprocessable(`${id} provider is not configured for Paperclip-managed values`);
|
|
},
|
|
async linkExternalSecret(input) {
|
|
return prepareExternalReference(input);
|
|
},
|
|
async resolveVersion() {
|
|
throw unprocessable(`${id} provider is not configured in this deployment`);
|
|
},
|
|
async deleteOrArchive() {
|
|
// External references are metadata-only in Paperclip for unconfigured providers.
|
|
},
|
|
async healthCheck() {
|
|
return {
|
|
provider: id,
|
|
status: "warn",
|
|
message: `${id} provider is available for external references but not configured for runtime resolution`,
|
|
warnings: [
|
|
"Linked external references can be stored as metadata, but runtime resolution will fail until this provider is configured.",
|
|
],
|
|
};
|
|
},
|
|
};
|
|
}
|
|
|
|
export const awsSecretsManagerProvider = unavailableProvider(
|
|
"aws_secrets_manager",
|
|
"AWS Secrets Manager",
|
|
);
|
|
export const gcpSecretManagerProvider = unavailableProvider(
|
|
"gcp_secret_manager",
|
|
"GCP Secret Manager",
|
|
);
|
|
export const vaultProvider = unavailableProvider("vault", "HashiCorp Vault");
|