mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-07 07:23:08 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - The Skills Manager gives operators a reusable skill layer, but iteration still required manual edits, ad hoc prompts, and indirect run inspection. > - Skill authors need a focused workflow for editing skill files, saving representative test inputs, and running those inputs through an agent without exposing harness tasks as normal company work. > - The backend therefore needs durable test inputs, reusable run templates, hidden harness issues, scoped run execution, retention metadata, and read-containment rules around hidden work. > - The frontend needs a three-pane Studio that keeps skill files, saved inputs/templates, and run output/history visible together while preserving the existing design system and token rules. > - This pull request ships that Skill Studio surface end to end: database migrations, shared contracts, server APIs/services, hidden harness execution behavior, UI routes/components, and focused tests. > - The benefit is faster and safer skill iteration, with inspectable outputs and fewer ways for internal harness work to leak into normal task lists, costs, or adjacent read APIs. ## Linked Issues or Issue Description No public GitHub issue exists for this feature. Feature request summary: - Problem: Skill authors need to edit and test company skills in one place instead of switching between the skill detail page, task creation, run output, and manual prompt history. - Proposed solution: Add a Skill Studio workbench with saved inputs, reusable templates, hidden sandboxed test runs, live run status, output inspection, run history, rerun/delete controls, and frontmatter-aware editing. - Expected users: Paperclip operators and agent-company maintainers who create, fork, import, and tune skills. - Related public PRs: Supersedes #9205, which was replaced so the public PR branch name follows contributor policy. - Duplicate search: searched public GitHub issues and PRs for "Skill Studio"; no other active public issue or PR directly covers this feature. ## What Changed - Added database migrations for Skill Studio test inputs, test runs, test run retention, and reusable run templates. - Added shared Skill Studio types, validators, route helpers, frontmatter utilities, and status handling. - Added server services and routes for saved inputs, test runs, templates, reruns, terminal-run deletion, hidden harness issue execution, and run-detail hydration. - Strengthened hidden-issue read containment across issue-adjacent routes and cost rollups used by skill test harness work. - Added the Skill Studio UI with skill file editing, frontmatter editing, saved inputs, templates, run creation/cancel/rerun/delete flows, output rendering, history, route support, and responsive pane behavior. - Added focused backend, shared, and UI tests for the new APIs, routing logic, editor/run behavior, hidden-issue containment, and migration safety. - Rebased onto current `master`, removed the generated lockfile diff from the PR, and verified no workflow files are changed. ## Verification - [x] `pnpm --filter @paperclipai/db check:migrations` - [x] `pnpm check:token-gates` - [x] `pnpm exec vitest run server/src/__tests__/company-skills-service.test.ts server/src/__tests__/company-skills-routes.test.ts server/src/__tests__/company-skill-test-runs-service.test.ts ui/src/lib/skill-studio.test.ts ui/src/pages/SkillStudio.test.tsx` — 5 files, 132 tests passed - [x] Greptile review on the latest PR head - [x] GitHub PR checks on the latest PR head ## Risks - Medium risk because this is a broad feature touching database schema, server orchestration, issue visibility, and a large UI surface. - Hidden harness issue containment is security-sensitive; this PR includes regression coverage for adjacent read paths and cost rollups. - The new migrations are additive and use idempotent guards where applicable, but deployed databases that previously tested draft migration numbers should still be checked carefully. - The UI depends on a new resizable panels package in `ui/package.json`; the lockfile is intentionally left to repository automation. > 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 shell, git, and GitHub CLI tool use. Earlier feature commits include assistance from other Paperclip coding agents; this PR preparation, rebase, cleanup commit, and PR body were completed by OpenAI Codex in a Paperclip worktree. ## 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 - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [x] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing> Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
250 lines
10 KiB
TypeScript
250 lines
10 KiB
TypeScript
import { createHmac, timingSafeEqual } from "node:crypto";
|
|
import { normalizeAgentApiKeyScope, type AgentApiKeyScope } from "@paperclipai/shared";
|
|
import { resolvePaperclipInstanceId } from "./home-paths.js";
|
|
|
|
interface JwtHeader {
|
|
alg: string;
|
|
typ?: string;
|
|
}
|
|
|
|
export interface LocalAgentJwtClaims {
|
|
sub: string;
|
|
company_id: string;
|
|
adapter_type: string;
|
|
run_id: string;
|
|
responsible_user_id?: string | null;
|
|
key_scope?: AgentApiKeyScope | null;
|
|
iat: number;
|
|
exp: number;
|
|
iss?: string;
|
|
aud?: string;
|
|
instance_id?: string;
|
|
jti?: string;
|
|
}
|
|
|
|
const JWT_ALGORITHM = "HS256";
|
|
|
|
function parseNumber(value: string | undefined, fallback: number) {
|
|
const parsed = Number(value);
|
|
if (!Number.isFinite(parsed) || parsed <= 0) return fallback;
|
|
return Math.floor(parsed);
|
|
}
|
|
|
|
function parseBooleanEnv(value: string | undefined): boolean {
|
|
if (!value) return false;
|
|
const normalized = value.trim().toLowerCase();
|
|
return normalized === "1" || normalized === "true" || normalized === "yes" || normalized === "on";
|
|
}
|
|
|
|
function jwtConfig() {
|
|
const secret = process.env.PAPERCLIP_AGENT_JWT_SECRET?.trim() || process.env.BETTER_AUTH_SECRET?.trim();
|
|
if (!secret) return null;
|
|
|
|
return {
|
|
secret,
|
|
ttlSeconds: parseNumber(process.env.PAPERCLIP_AGENT_JWT_TTL_SECONDS, 60 * 60),
|
|
issuer: process.env.PAPERCLIP_AGENT_JWT_ISSUER ?? "paperclip",
|
|
audience: process.env.PAPERCLIP_AGENT_JWT_AUDIENCE ?? "paperclip-api",
|
|
// The control-plane instance this process belongs to. The live plane runs as
|
|
// "default"; every worktree/fork instance gets a distinct id (its worktree
|
|
// name) even though it deliberately shares PAPERCLIP_AGENT_JWT_SECRET with
|
|
// the source instance. Folding this into the signing-key derivation is what
|
|
// prevents a fork-minted token from authenticating against the live plane.
|
|
instanceId: resolvePaperclipInstanceId(),
|
|
disableLegacyFallback: parseBooleanEnv(process.env.PAPERCLIP_AGENT_JWT_DISABLE_LEGACY_FALLBACK),
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Derive a per-instance, per-company signing key from the master JWT secret,
|
|
* the control-plane instanceId, and a companyId.
|
|
*
|
|
* Two isolation properties fall out of this derivation:
|
|
* - Per-company: a JWT signed for company A cannot be reused to authenticate
|
|
* as an agent in company B, even if the raw token leaks.
|
|
* - Per-instance: a JWT minted by a worktree/fork control-plane instance
|
|
* cannot authenticate against the live plane, even though forks
|
|
* deliberately share the same master secret (it is copied into worktree
|
|
* envs by provisioning). The live plane derives its key from its own
|
|
* instanceId ("default"), so a fork token — signed under the fork's
|
|
* instanceId — never matches. See PAP-12896 for the incident this closes.
|
|
*
|
|
* The instance-wide master secret is never used to sign new tokens — it is
|
|
* retained only as a verification fallback so that tokens issued before this
|
|
* change continue to validate. NOTE: that legacy fallback is instance-agnostic
|
|
* (it signs with the raw shared secret), so complete cryptographic instance
|
|
* isolation additionally requires disabling it once outstanding legacy tokens
|
|
* have expired (set PAPERCLIP_AGENT_JWT_DISABLE_LEGACY_FALLBACK=true). Normal
|
|
* fork-minted run tokens are already rejected without that step because they
|
|
* are signed with the derived key, not the raw master secret.
|
|
*
|
|
* The derivation domain-separates with the `jwt:` prefix so the same master
|
|
* secret can safely be reused for other HMAC purposes without key reuse.
|
|
*/
|
|
function deriveCompanySigningKey(masterSecret: string, companyId: string, instanceId: string): string {
|
|
return createHmac("sha256", masterSecret).update(`jwt:${instanceId}:${companyId}`).digest("hex");
|
|
}
|
|
|
|
function base64UrlEncode(value: string) {
|
|
return Buffer.from(value, "utf8").toString("base64url");
|
|
}
|
|
|
|
function base64UrlDecode(value: string) {
|
|
return Buffer.from(value, "base64url").toString("utf8");
|
|
}
|
|
|
|
function signPayload(secret: string, signingInput: string) {
|
|
return createHmac("sha256", secret).update(signingInput).digest("base64url");
|
|
}
|
|
|
|
function parseJson(value: string): Record<string, unknown> | null {
|
|
try {
|
|
const parsed = JSON.parse(value);
|
|
return parsed && typeof parsed === "object" ? parsed as Record<string, unknown> : null;
|
|
} catch {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
function safeCompare(a: string, b: string) {
|
|
const left = Buffer.from(a);
|
|
const right = Buffer.from(b);
|
|
if (left.length !== right.length) return false;
|
|
return timingSafeEqual(left, right);
|
|
}
|
|
|
|
export function createLocalAgentJwt(
|
|
agentId: string,
|
|
companyId: string,
|
|
adapterType: string,
|
|
runId: string,
|
|
responsibleUserId?: string | null,
|
|
keyScope: AgentApiKeyScope = { kind: "standard" },
|
|
) {
|
|
const config = jwtConfig();
|
|
if (!config) return null;
|
|
|
|
const now = Math.floor(Date.now() / 1000);
|
|
const claims: LocalAgentJwtClaims = {
|
|
sub: agentId,
|
|
company_id: companyId,
|
|
adapter_type: adapterType,
|
|
run_id: runId,
|
|
responsible_user_id: responsibleUserId?.trim() || null,
|
|
...(keyScope.kind === "standard" ? {} : { key_scope: keyScope }),
|
|
iat: now,
|
|
exp: now + config.ttlSeconds,
|
|
iss: config.issuer,
|
|
aud: config.audience,
|
|
instance_id: config.instanceId,
|
|
};
|
|
|
|
const header = {
|
|
alg: JWT_ALGORITHM,
|
|
typ: "JWT",
|
|
};
|
|
|
|
const signingInput = `${base64UrlEncode(JSON.stringify(header))}.${base64UrlEncode(JSON.stringify(claims))}`;
|
|
// Sign with the per-instance, per-company derived key so a leaked token
|
|
// cannot be reused across tenants and a fork-minted token cannot authenticate
|
|
// against a different control-plane instance.
|
|
const signingKey = deriveCompanySigningKey(config.secret, companyId, config.instanceId);
|
|
const signature = signPayload(signingKey, signingInput);
|
|
|
|
return `${signingInput}.${signature}`;
|
|
}
|
|
|
|
export function verifyLocalAgentJwt(token: string): LocalAgentJwtClaims | null {
|
|
if (!token) return null;
|
|
const config = jwtConfig();
|
|
if (!config) return null;
|
|
|
|
const parts = token.split(".");
|
|
if (parts.length !== 3) return null;
|
|
const [headerB64, claimsB64, signature] = parts;
|
|
|
|
const header = parseJson(base64UrlDecode(headerB64));
|
|
if (!header || header.alg !== JWT_ALGORITHM) return null;
|
|
|
|
const claims = parseJson(base64UrlDecode(claimsB64));
|
|
if (!claims) return null;
|
|
|
|
const claimedCompanyId = typeof claims.company_id === "string" ? claims.company_id : null;
|
|
if (!claimedCompanyId) return null;
|
|
|
|
const signingInput = `${headerB64}.${claimsB64}`;
|
|
// Try the per-instance, per-company derived key first (current tokens),
|
|
// deriving under THIS control plane's own instanceId. A token minted by a
|
|
// worktree/fork instance was signed under a different instanceId, so it will
|
|
// not match here — that is the boundary that keeps fork tokens out of the
|
|
// live plane (PAP-12896/PAP-12899). Fall back to the raw master secret so
|
|
// tokens issued before per-company derivation existed continue to verify —
|
|
// this preserves backward compatibility for any outstanding tokens (TTL
|
|
// bounds the legacy window naturally).
|
|
//
|
|
// Operators should set `PAPERCLIP_AGENT_JWT_DISABLE_LEGACY_FALLBACK=true`
|
|
// approximately one JWT TTL (~1h by default, see PAPERCLIP_AGENT_JWT_TTL_SECONDS)
|
|
// after deploying per-company signing. Once set, the master-secret fallback
|
|
// is disabled and only tokens validating under the per-instance/per-company
|
|
// derived key are accepted — closing the window in which a leaked master
|
|
// secret could be used to forge tokens with arbitrary future `exp` values for
|
|
// any tenant, and completing cryptographic isolation between control-plane
|
|
// instances (the raw-secret fallback is instance-agnostic).
|
|
const perCompanyKey = deriveCompanySigningKey(config.secret, claimedCompanyId, config.instanceId);
|
|
const perCompanySig = signPayload(perCompanyKey, signingInput);
|
|
let signatureOk = safeCompare(signature, perCompanySig);
|
|
if (!signatureOk && !config.disableLegacyFallback) {
|
|
const legacySig = signPayload(config.secret, signingInput);
|
|
signatureOk = safeCompare(signature, legacySig);
|
|
}
|
|
if (!signatureOk) return null;
|
|
|
|
const sub = typeof claims.sub === "string" ? claims.sub : null;
|
|
const adapterType = typeof claims.adapter_type === "string" ? claims.adapter_type : null;
|
|
const runId = typeof claims.run_id === "string" ? claims.run_id : null;
|
|
const responsibleUserClaim = Object.hasOwn(claims, "responsible_user_id")
|
|
? typeof claims.responsible_user_id === "string" && claims.responsible_user_id.trim()
|
|
? claims.responsible_user_id.trim()
|
|
: null
|
|
: undefined;
|
|
const keyScopeClaim = Object.hasOwn(claims, "key_scope")
|
|
? normalizeAgentApiKeyScope(claims.key_scope)
|
|
: undefined;
|
|
const iat = typeof claims.iat === "number" ? claims.iat : null;
|
|
const exp = typeof claims.exp === "number" ? claims.exp : null;
|
|
if (!sub || !adapterType || !runId || !iat || !exp) return null;
|
|
const companyId = claimedCompanyId;
|
|
|
|
const now = Math.floor(Date.now() / 1000);
|
|
if (exp < now) return null;
|
|
|
|
const issuer = typeof claims.iss === "string" ? claims.iss : undefined;
|
|
const audience = typeof claims.aud === "string" ? claims.aud : undefined;
|
|
if (issuer && issuer !== config.issuer) return null;
|
|
if (audience && audience !== config.audience) return null;
|
|
|
|
// Enforce the minting instance when the claim is present. The instance-scoped
|
|
// signing key above is the real cryptographic boundary; this claim check is
|
|
// defense-in-depth that yields a clean, cheap rejection (and, once legacy
|
|
// tokens have aged out, guards the master-secret fallback path too). Legacy
|
|
// tokens minted before this claim existed omit it and are still accepted, so
|
|
// enforcement is conditional — matching how iss/aud are handled above.
|
|
const instanceClaim = typeof claims.instance_id === "string" ? claims.instance_id : undefined;
|
|
if (instanceClaim && instanceClaim !== config.instanceId) return null;
|
|
|
|
return {
|
|
sub,
|
|
company_id: companyId,
|
|
adapter_type: adapterType,
|
|
run_id: runId,
|
|
...(responsibleUserClaim !== undefined ? { responsible_user_id: responsibleUserClaim } : {}),
|
|
...(keyScopeClaim !== undefined ? { key_scope: keyScopeClaim } : {}),
|
|
iat,
|
|
exp,
|
|
...(issuer ? { iss: issuer } : {}),
|
|
...(audience ? { aud: audience } : {}),
|
|
...(instanceClaim ? { instance_id: instanceClaim } : {}),
|
|
jti: typeof claims.jti === "string" ? claims.jti : undefined,
|
|
};
|
|
}
|