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>
479 lines
14 KiB
TypeScript
479 lines
14 KiB
TypeScript
import { Router } from "express";
|
|
import type { Db } from "@paperclipai/db";
|
|
import {
|
|
createSecretProviderConfigSchema,
|
|
createSecretSchema,
|
|
remoteSecretImportPreviewSchema,
|
|
remoteSecretImportSchema,
|
|
rotateSecretSchema,
|
|
updateSecretProviderConfigSchema,
|
|
updateSecretSchema,
|
|
} from "@paperclipai/shared";
|
|
import { validate } from "../middleware/validate.js";
|
|
import { assertBoard, assertCompanyAccess } from "./authz.js";
|
|
import { logActivity, secretService } from "../services/index.js";
|
|
import { getConfiguredSecretProvider } from "../secrets/configured-provider.js";
|
|
|
|
export function secretRoutes(db: Db) {
|
|
const router = Router();
|
|
const svc = secretService(db);
|
|
const defaultProvider = getConfiguredSecretProvider();
|
|
|
|
router.get("/companies/:companyId/secret-providers", (req, res) => {
|
|
assertBoard(req);
|
|
const companyId = req.params.companyId as string;
|
|
assertCompanyAccess(req, companyId);
|
|
res.json(svc.listProviders());
|
|
});
|
|
|
|
router.get("/companies/:companyId/secret-providers/health", async (req, res) => {
|
|
assertBoard(req);
|
|
const companyId = req.params.companyId as string;
|
|
assertCompanyAccess(req, companyId);
|
|
const checks = await svc.checkProviders();
|
|
res.json({ providers: checks });
|
|
});
|
|
|
|
router.get("/companies/:companyId/secret-provider-configs", async (req, res) => {
|
|
assertBoard(req);
|
|
const companyId = req.params.companyId as string;
|
|
assertCompanyAccess(req, companyId);
|
|
res.json(await svc.listProviderConfigs(companyId));
|
|
});
|
|
|
|
router.post("/companies/:companyId/secret-provider-configs", validate(createSecretProviderConfigSchema), async (req, res) => {
|
|
assertBoard(req);
|
|
const companyId = req.params.companyId as string;
|
|
assertCompanyAccess(req, companyId);
|
|
|
|
const created = await svc.createProviderConfig(
|
|
companyId,
|
|
{
|
|
provider: req.body.provider,
|
|
displayName: req.body.displayName,
|
|
status: req.body.status,
|
|
isDefault: req.body.isDefault,
|
|
config: req.body.config,
|
|
},
|
|
{ userId: req.actor.userId ?? "board", agentId: null },
|
|
);
|
|
|
|
await logActivity(db, {
|
|
companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "secret_provider_config.created",
|
|
entityType: "secret_provider_config",
|
|
entityId: created.id,
|
|
details: {
|
|
provider: created.provider,
|
|
displayName: created.displayName,
|
|
status: created.status,
|
|
isDefault: created.isDefault,
|
|
},
|
|
});
|
|
|
|
res.status(201).json(created);
|
|
});
|
|
|
|
router.get("/secret-provider-configs/:id", async (req, res) => {
|
|
assertBoard(req);
|
|
const existing = await svc.getProviderConfigById(req.params.id as string);
|
|
if (!existing) {
|
|
res.status(404).json({ error: "Provider vault not found" });
|
|
return;
|
|
}
|
|
assertCompanyAccess(req, existing.companyId);
|
|
res.json(existing);
|
|
});
|
|
|
|
router.patch("/secret-provider-configs/:id", validate(updateSecretProviderConfigSchema), async (req, res) => {
|
|
assertBoard(req);
|
|
const id = req.params.id as string;
|
|
const existing = await svc.getProviderConfigById(id);
|
|
if (!existing) {
|
|
res.status(404).json({ error: "Provider vault not found" });
|
|
return;
|
|
}
|
|
assertCompanyAccess(req, existing.companyId);
|
|
|
|
const updated = await svc.updateProviderConfig(id, {
|
|
displayName: req.body.displayName,
|
|
status: req.body.status,
|
|
isDefault: req.body.isDefault,
|
|
config: req.body.config,
|
|
});
|
|
if (!updated) {
|
|
res.status(404).json({ error: "Provider vault not found" });
|
|
return;
|
|
}
|
|
|
|
await logActivity(db, {
|
|
companyId: updated.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "secret_provider_config.updated",
|
|
entityType: "secret_provider_config",
|
|
entityId: updated.id,
|
|
details: {
|
|
provider: updated.provider,
|
|
displayName: updated.displayName,
|
|
status: updated.status,
|
|
isDefault: updated.isDefault,
|
|
},
|
|
});
|
|
|
|
res.json(updated);
|
|
});
|
|
|
|
router.delete("/secret-provider-configs/:id", async (req, res) => {
|
|
assertBoard(req);
|
|
const id = req.params.id as string;
|
|
const existing = await svc.getProviderConfigById(id);
|
|
if (!existing) {
|
|
res.status(404).json({ error: "Provider vault not found" });
|
|
return;
|
|
}
|
|
assertCompanyAccess(req, existing.companyId);
|
|
|
|
const disabled = await svc.disableProviderConfig(id);
|
|
if (!disabled) {
|
|
res.status(404).json({ error: "Provider vault not found" });
|
|
return;
|
|
}
|
|
|
|
await logActivity(db, {
|
|
companyId: disabled.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "secret_provider_config.disabled",
|
|
entityType: "secret_provider_config",
|
|
entityId: disabled.id,
|
|
details: {
|
|
provider: disabled.provider,
|
|
displayName: disabled.displayName,
|
|
status: disabled.status,
|
|
},
|
|
});
|
|
|
|
res.json(disabled);
|
|
});
|
|
|
|
router.post("/secret-provider-configs/:id/default", async (req, res) => {
|
|
assertBoard(req);
|
|
const id = req.params.id as string;
|
|
const existing = await svc.getProviderConfigById(id);
|
|
if (!existing) {
|
|
res.status(404).json({ error: "Provider vault not found" });
|
|
return;
|
|
}
|
|
assertCompanyAccess(req, existing.companyId);
|
|
|
|
const updated = await svc.setDefaultProviderConfig(id);
|
|
if (!updated) {
|
|
res.status(404).json({ error: "Provider vault not found" });
|
|
return;
|
|
}
|
|
|
|
await logActivity(db, {
|
|
companyId: updated.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "secret_provider_config.default_set",
|
|
entityType: "secret_provider_config",
|
|
entityId: updated.id,
|
|
details: {
|
|
provider: updated.provider,
|
|
displayName: updated.displayName,
|
|
isDefault: updated.isDefault,
|
|
},
|
|
});
|
|
|
|
res.json(updated);
|
|
});
|
|
|
|
router.post("/secret-provider-configs/:id/health", async (req, res) => {
|
|
assertBoard(req);
|
|
const id = req.params.id as string;
|
|
const existing = await svc.getProviderConfigById(id);
|
|
if (!existing) {
|
|
res.status(404).json({ error: "Provider vault not found" });
|
|
return;
|
|
}
|
|
assertCompanyAccess(req, existing.companyId);
|
|
|
|
const health = await svc.checkProviderConfigHealth(id);
|
|
if (!health) {
|
|
res.status(404).json({ error: "Provider vault not found" });
|
|
return;
|
|
}
|
|
|
|
await logActivity(db, {
|
|
companyId: existing.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "secret_provider_config.health_checked",
|
|
entityType: "secret_provider_config",
|
|
entityId: existing.id,
|
|
details: {
|
|
provider: existing.provider,
|
|
status: health.status,
|
|
code: health.details.code,
|
|
},
|
|
});
|
|
|
|
res.json(health);
|
|
});
|
|
|
|
router.get("/companies/:companyId/secrets", async (req, res) => {
|
|
assertBoard(req);
|
|
const companyId = req.params.companyId as string;
|
|
assertCompanyAccess(req, companyId);
|
|
const secrets = await svc.list(companyId);
|
|
res.json(secrets);
|
|
});
|
|
|
|
router.post("/companies/:companyId/secrets", validate(createSecretSchema), async (req, res) => {
|
|
assertBoard(req);
|
|
const companyId = req.params.companyId as string;
|
|
assertCompanyAccess(req, companyId);
|
|
|
|
const created = await svc.create(
|
|
companyId,
|
|
{
|
|
name: req.body.name,
|
|
key: req.body.key,
|
|
provider: req.body.provider ?? defaultProvider,
|
|
providerConfigId: req.body.providerConfigId,
|
|
managedMode: req.body.managedMode,
|
|
value: req.body.value,
|
|
description: req.body.description,
|
|
externalRef: req.body.externalRef,
|
|
providerVersionRef: req.body.providerVersionRef,
|
|
providerMetadata: req.body.providerMetadata,
|
|
},
|
|
{ userId: req.actor.userId ?? "board", agentId: null },
|
|
);
|
|
|
|
await logActivity(db, {
|
|
companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "secret.created",
|
|
entityType: "secret",
|
|
entityId: created.id,
|
|
details: { name: created.name, provider: created.provider },
|
|
});
|
|
|
|
res.status(201).json(created);
|
|
});
|
|
|
|
router.post(
|
|
"/companies/:companyId/secrets/remote-import/preview",
|
|
validate(remoteSecretImportPreviewSchema),
|
|
async (req, res) => {
|
|
assertBoard(req);
|
|
const companyId = req.params.companyId as string;
|
|
assertCompanyAccess(req, companyId);
|
|
|
|
const preview = await svc.previewRemoteImport(companyId, {
|
|
providerConfigId: req.body.providerConfigId,
|
|
query: req.body.query,
|
|
nextToken: req.body.nextToken,
|
|
pageSize: req.body.pageSize,
|
|
});
|
|
|
|
await logActivity(db, {
|
|
companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "secret.remote_import.previewed",
|
|
entityType: "secret_provider_config",
|
|
entityId: preview.providerConfigId,
|
|
details: {
|
|
provider: preview.provider,
|
|
candidateCount: preview.candidates.length,
|
|
readyCount: preview.candidates.filter((candidate) => candidate.status === "ready").length,
|
|
duplicateCount: preview.candidates.filter((candidate) => candidate.status === "duplicate").length,
|
|
conflictCount: preview.candidates.filter((candidate) => candidate.status === "conflict").length,
|
|
},
|
|
});
|
|
|
|
res.json(preview);
|
|
},
|
|
);
|
|
|
|
router.post(
|
|
"/companies/:companyId/secrets/remote-import",
|
|
validate(remoteSecretImportSchema),
|
|
async (req, res) => {
|
|
assertBoard(req);
|
|
const companyId = req.params.companyId as string;
|
|
assertCompanyAccess(req, companyId);
|
|
|
|
const result = await svc.importRemoteSecrets(
|
|
companyId,
|
|
{
|
|
providerConfigId: req.body.providerConfigId,
|
|
secrets: req.body.secrets,
|
|
},
|
|
{ userId: req.actor.userId ?? "board", agentId: null },
|
|
);
|
|
|
|
await logActivity(db, {
|
|
companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "secret.remote_import.completed",
|
|
entityType: "secret_provider_config",
|
|
entityId: result.providerConfigId,
|
|
details: {
|
|
provider: result.provider,
|
|
importedCount: result.importedCount,
|
|
skippedCount: result.skippedCount,
|
|
errorCount: result.errorCount,
|
|
},
|
|
});
|
|
|
|
res.json(result);
|
|
},
|
|
);
|
|
|
|
router.post("/secrets/:id/rotate", validate(rotateSecretSchema), async (req, res) => {
|
|
assertBoard(req);
|
|
const id = req.params.id as string;
|
|
const existing = await svc.getById(id);
|
|
if (!existing) {
|
|
res.status(404).json({ error: "Secret not found" });
|
|
return;
|
|
}
|
|
assertCompanyAccess(req, existing.companyId);
|
|
if (existing.status === "deleted") {
|
|
res.status(404).json({ error: "Secret not found" });
|
|
return;
|
|
}
|
|
|
|
const rotated = await svc.rotate(
|
|
id,
|
|
{
|
|
value: req.body.value,
|
|
externalRef: req.body.externalRef,
|
|
providerVersionRef: req.body.providerVersionRef,
|
|
providerConfigId: req.body.providerConfigId,
|
|
},
|
|
{ userId: req.actor.userId ?? "board", agentId: null },
|
|
);
|
|
|
|
await logActivity(db, {
|
|
companyId: rotated.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "secret.rotated",
|
|
entityType: "secret",
|
|
entityId: rotated.id,
|
|
details: { version: rotated.latestVersion },
|
|
});
|
|
|
|
res.json(rotated);
|
|
});
|
|
|
|
router.patch("/secrets/:id", validate(updateSecretSchema), async (req, res) => {
|
|
assertBoard(req);
|
|
const id = req.params.id as string;
|
|
const existing = await svc.getById(id);
|
|
if (!existing) {
|
|
res.status(404).json({ error: "Secret not found" });
|
|
return;
|
|
}
|
|
assertCompanyAccess(req, existing.companyId);
|
|
if (existing.status === "deleted") {
|
|
res.status(404).json({ error: "Secret not found" });
|
|
return;
|
|
}
|
|
|
|
const updated = await svc.update(id, {
|
|
name: req.body.name,
|
|
key: req.body.key,
|
|
status: req.body.status,
|
|
providerConfigId: req.body.providerConfigId,
|
|
description: req.body.description,
|
|
externalRef: req.body.externalRef,
|
|
providerMetadata: req.body.providerMetadata,
|
|
});
|
|
|
|
if (!updated) {
|
|
res.status(404).json({ error: "Secret not found" });
|
|
return;
|
|
}
|
|
|
|
await logActivity(db, {
|
|
companyId: updated.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "secret.updated",
|
|
entityType: "secret",
|
|
entityId: updated.id,
|
|
details: { name: updated.name },
|
|
});
|
|
|
|
res.json(updated);
|
|
});
|
|
|
|
router.get("/secrets/:id/usage", async (req, res) => {
|
|
assertBoard(req);
|
|
const id = req.params.id as string;
|
|
const existing = await svc.getById(id);
|
|
if (!existing) {
|
|
res.status(404).json({ error: "Secret not found" });
|
|
return;
|
|
}
|
|
assertCompanyAccess(req, existing.companyId);
|
|
const bindings = await svc.listBindingReferences(existing.companyId, existing.id);
|
|
res.json({ secretId: existing.id, bindings });
|
|
});
|
|
|
|
router.get("/secrets/:id/access-events", async (req, res) => {
|
|
assertBoard(req);
|
|
const id = req.params.id as string;
|
|
const existing = await svc.getById(id);
|
|
if (!existing) {
|
|
res.status(404).json({ error: "Secret not found" });
|
|
return;
|
|
}
|
|
assertCompanyAccess(req, existing.companyId);
|
|
const events = await svc.listAccessEvents(existing.companyId, existing.id);
|
|
res.json(events);
|
|
});
|
|
|
|
router.delete("/secrets/:id", async (req, res) => {
|
|
assertBoard(req);
|
|
const id = req.params.id as string;
|
|
const existing = await svc.getById(id);
|
|
if (!existing) {
|
|
res.status(404).json({ error: "Secret not found" });
|
|
return;
|
|
}
|
|
assertCompanyAccess(req, existing.companyId);
|
|
|
|
const removed = await svc.remove(id);
|
|
if (!removed) {
|
|
res.status(404).json({ error: "Secret not found" });
|
|
return;
|
|
}
|
|
|
|
await logActivity(db, {
|
|
companyId: removed.companyId,
|
|
actorType: "user",
|
|
actorId: req.actor.userId ?? "board",
|
|
action: "secret.deleted",
|
|
entityType: "secret",
|
|
entityId: removed.id,
|
|
details: { name: removed.name },
|
|
});
|
|
|
|
res.json({ ok: true });
|
|
});
|
|
|
|
return router;
|
|
}
|