mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-07 16:35:48 +01:00
<!-- Write all pull request text in Simplified Technical English (ASD-STE100): short sentences, one instruction per sentence, simple approved vocabulary, and the active voice. --> ## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - The server authenticates each agent request in `actorMiddleware` before it attributes chat comments > - When an agent bearer token failed verification, the middleware called `next()` with no error and the request continued without an agent actor > - The request then fell back to the local user actor, so the server stored agent replies as user comments > - The task chat UI renders user comments in blue bubbles, so agent messages appeared as blue user bubbles > - This pull request rejects invalid agent credentials with 401 instead of a silent downgrade > - The benefit is that agent messages keep agent attribution, and broken credentials fail loudly with a clear retry message ## Linked Issues or Issue Description **What happened?** A user cancelled an onboarding question card. The agent posted a follow-up reply. The reply appeared in a blue bubble, which the UI reserves for human messages. The agent run held an expired local agent JWT. The auth middleware could not verify the token, called `next()` without an actor, and the request fell back to the local user identity. The server stored the agent comment as a user comment. **Expected behavior** Agent messages always render as agent bubbles. A request with invalid agent credentials must fail with 401 so the adapter can refresh credentials and retry. It must not post content under a human identity. **Steps to reproduce** 1. Start a local Paperclip instance. 2. Give an agent run an expired or malformed agent JWT. 3. Let the agent post an issue comment through the API bridge. 4. Before this change: the comment is stored with the local user identity and renders as a blue bubble. After this change: the request fails with 401 and a message that tells the caller to obtain fresh credentials. ## What Changed - `server/src/middleware/auth.ts`: a bearer token that fails verification now produces a 401 `unauthorized` error instead of a silent fall-through to the anonymous/local-user actor. - The 401 message states the cause: expired token, unverifiable token, empty bearer token, missing agent record, agent record in another company, terminated agent, or agent pending approval. - The API-key path now also rejects an agent record whose company does not match the key. - `packages/adapter-utils/src/execution-target.ts`: the bridge proxy now writes a `comment id: <id>` marker to the run log for each posted issue comment, so misattributed comments can be traced to a run. - `ui/src/components/task-chat/task-chat-adapter.test.ts`: a regression test asserts that a recovered `local-board` comment with a derived agent author renders as an agent bubble, not a user bubble. - `server/src/__tests__/agent-auth-middleware.test.ts` and `packages/adapter-utils/src/execution-target-sandbox.test.ts`: new tests cover each rejection path and the log marker. ## Verification - Run `pnpm vitest run src/__tests__/agent-auth-middleware.test.ts` in `server/` — 14 tests pass. - Run `pnpm vitest run execution-target-sandbox` at the repo root — 44 tests pass. - Run `pnpm vitest run src/components/task-chat/task-chat-adapter.test.ts` in `ui/` — 4 tests pass. - Manual check: post an issue comment with an expired agent JWT; the API returns 401 with a retry message and no comment is stored. ## Risks - Behavioral shift: requests that previously continued as anonymous or local-user actors after a failed agent-token verification now receive 401. Any caller that relied on the silent downgrade must refresh its credentials. This is the intended fix, and the adapters already handle 401 with a credential refresh. - No schema or migration changes. Low risk otherwise. > 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 - Claude (Anthropic), model ID `claude-fable-5`, via Claude Code with extended thinking and tool use (agent harness with shell, file, and git tools). ## 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 - [ ] All Paperclip CI gates are green - [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [ ] I will address all Greptile and reviewer comments before requesting merge --------- Co-authored-by: Paperclip <noreply@paperclip.ing> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
469 lines
16 KiB
TypeScript
469 lines
16 KiB
TypeScript
import { createHash, createHmac, randomUUID } from "node:crypto";
|
|
import express from "express";
|
|
import request from "supertest";
|
|
import { afterEach, beforeEach, describe, expect, it } from "vitest";
|
|
import {
|
|
activityLog,
|
|
agentApiKeys,
|
|
agents,
|
|
boardApiKeys,
|
|
heartbeatRuns,
|
|
} from "@paperclipai/db";
|
|
import { actorMiddleware } from "../middleware/auth.js";
|
|
import { errorHandler } from "../middleware/error-handler.js";
|
|
import { createLocalAgentJwt } from "../agent-auth-jwt.js";
|
|
import { assertCompanyAccess } from "../routes/authz.js";
|
|
|
|
function hashToken(token: string) {
|
|
return createHash("sha256").update(token).digest("hex");
|
|
}
|
|
|
|
function createSelectChain(rowsForTable: (table: unknown) => unknown[]) {
|
|
return {
|
|
from(table: unknown) {
|
|
return {
|
|
where() {
|
|
return Promise.resolve(rowsForTable(table));
|
|
},
|
|
};
|
|
},
|
|
};
|
|
}
|
|
|
|
function createDbState(input: {
|
|
agent: { id: string; companyId: string; status?: string };
|
|
agentKey?: { id: string; agentId: string; companyId: string; keyHash: string; responsibleUserId?: string | null };
|
|
run?: { id: string; companyId: string; agentId: string; responsibleUserId?: string | null };
|
|
}) {
|
|
const activity: Array<Record<string, unknown>> = [];
|
|
const agentRow = {
|
|
id: input.agent.id,
|
|
companyId: input.agent.companyId,
|
|
status: input.agent.status ?? "active",
|
|
};
|
|
const keyRow = input.agentKey
|
|
? {
|
|
id: input.agentKey.id,
|
|
agentId: input.agentKey.agentId,
|
|
companyId: input.agentKey.companyId,
|
|
keyHash: input.agentKey.keyHash,
|
|
responsibleUserId: input.agentKey.responsibleUserId ?? null,
|
|
revokedAt: null,
|
|
scopeConfig: null,
|
|
}
|
|
: null;
|
|
const runRow = input.run
|
|
? {
|
|
id: input.run.id,
|
|
companyId: input.run.companyId,
|
|
agentId: input.run.agentId,
|
|
responsibleUserId: input.run.responsibleUserId ?? null,
|
|
}
|
|
: null;
|
|
|
|
const db = {
|
|
select: () =>
|
|
createSelectChain((table) => {
|
|
if (table === boardApiKeys) return [];
|
|
if (table === agentApiKeys) return keyRow ? [keyRow] : [];
|
|
if (table === agents) return [agentRow];
|
|
if (table === heartbeatRuns) return runRow ? [runRow] : [];
|
|
return [];
|
|
}),
|
|
update: () => ({
|
|
set() {
|
|
return {
|
|
where() {
|
|
return Promise.resolve([]);
|
|
},
|
|
};
|
|
},
|
|
}),
|
|
insert: (table: unknown) => ({
|
|
values(values: Record<string, unknown>) {
|
|
if (table === activityLog) activity.push(values);
|
|
return Promise.resolve([]);
|
|
},
|
|
}),
|
|
} as any;
|
|
|
|
return { db, activity };
|
|
}
|
|
|
|
function createApp(db: any, deploymentMode: "authenticated" | "local_trusted" = "authenticated") {
|
|
const app = express();
|
|
app.use(express.json());
|
|
app.use(
|
|
actorMiddleware(db, {
|
|
deploymentMode,
|
|
resolveSession: async () => null,
|
|
}),
|
|
);
|
|
app.get("/actor", (req, res) => {
|
|
res.json(req.actor);
|
|
});
|
|
app.get("/companies/:companyId/protected", (req, res) => {
|
|
assertCompanyAccess(req, req.params.companyId);
|
|
res.json({ ok: true });
|
|
});
|
|
app.get("/companies/:companyId/issues/:issueId", (req, res) => {
|
|
assertCompanyAccess(req, req.params.companyId);
|
|
res.json({ id: req.params.issueId, readable: true });
|
|
});
|
|
app.patch("/companies/:companyId/issues/:issueId", (req, res) => {
|
|
assertCompanyAccess(req, req.params.companyId);
|
|
res.json({ id: req.params.issueId, writable: true });
|
|
});
|
|
app.use(errorHandler);
|
|
return app;
|
|
}
|
|
|
|
function craftAgentJwtWithoutResponsibleClaim(input: {
|
|
secret: string;
|
|
agentId: string;
|
|
companyId: string;
|
|
adapterType: string;
|
|
runId: string;
|
|
expiresInSeconds?: number;
|
|
}) {
|
|
const now = Math.floor(Date.now() / 1000);
|
|
const header = { alg: "HS256", typ: "JWT" };
|
|
const claims = {
|
|
sub: input.agentId,
|
|
company_id: input.companyId,
|
|
adapter_type: input.adapterType,
|
|
run_id: input.runId,
|
|
iat: now,
|
|
exp: now + (input.expiresInSeconds ?? 3600),
|
|
iss: "paperclip",
|
|
aud: "paperclip-api",
|
|
};
|
|
const headerB64 = Buffer.from(JSON.stringify(header), "utf8").toString("base64url");
|
|
const claimsB64 = Buffer.from(JSON.stringify(claims), "utf8").toString("base64url");
|
|
const signingInput = `${headerB64}.${claimsB64}`;
|
|
// Sign with the same per-instance, per-company key the server derives. The
|
|
// instance defaults to "default" (beforeEach clears PAPERCLIP_INSTANCE_ID),
|
|
// matching the live control plane this middleware test exercises. This helper
|
|
// only omits the responsible_user_id claim — it is not a cross-instance token.
|
|
const signingKey = createHmac("sha256", input.secret).update(`jwt:default:${input.companyId}`).digest("hex");
|
|
const signature = createHmac("sha256", signingKey).update(signingInput).digest("base64url");
|
|
return `${signingInput}.${signature}`;
|
|
}
|
|
|
|
describe("agent auth middleware", () => {
|
|
const originalSecret = process.env.PAPERCLIP_AGENT_JWT_SECRET;
|
|
const originalTtl = process.env.PAPERCLIP_AGENT_JWT_TTL_SECONDS;
|
|
const originalInstanceId = process.env.PAPERCLIP_INSTANCE_ID;
|
|
|
|
beforeEach(() => {
|
|
process.env.PAPERCLIP_AGENT_JWT_SECRET = "auth-middleware-secret";
|
|
process.env.PAPERCLIP_AGENT_JWT_TTL_SECONDS = "3600";
|
|
// Pin the control-plane instance so mint/verify (and the hand-crafted
|
|
// legacy token helper) all derive keys under the "default" live instance.
|
|
delete process.env.PAPERCLIP_INSTANCE_ID;
|
|
});
|
|
|
|
afterEach(() => {
|
|
if (originalSecret === undefined) delete process.env.PAPERCLIP_AGENT_JWT_SECRET;
|
|
else process.env.PAPERCLIP_AGENT_JWT_SECRET = originalSecret;
|
|
if (originalTtl === undefined) delete process.env.PAPERCLIP_AGENT_JWT_TTL_SECONDS;
|
|
else process.env.PAPERCLIP_AGENT_JWT_TTL_SECONDS = originalTtl;
|
|
if (originalInstanceId === undefined) delete process.env.PAPERCLIP_INSTANCE_ID;
|
|
else process.env.PAPERCLIP_INSTANCE_ID = originalInstanceId;
|
|
});
|
|
|
|
it("keeps header-less local requests as the implicit board actor with their run id", async () => {
|
|
const runId = randomUUID();
|
|
const { db } = createDbState({ agent: { id: randomUUID(), companyId: randomUUID() } });
|
|
|
|
const res = await request(createApp(db, "local_trusted"))
|
|
.get("/actor")
|
|
.set("X-Paperclip-Run-Id", runId);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toMatchObject({ type: "board", userId: "local-board", runId });
|
|
});
|
|
|
|
it.each([
|
|
["empty bearer token", "Bearer ", "Empty bearer token"],
|
|
["unverified token", "Bearer not-a-token", "Agent token did not verify"],
|
|
])("rejects %s instead of retaining the implicit local-board actor", async (_label, authorization, error) => {
|
|
const { db } = createDbState({ agent: { id: randomUUID(), companyId: randomUUID() } });
|
|
let commentWrites = 0;
|
|
const app = createApp(db, "local_trusted");
|
|
app.post("/comments", (_req, res) => {
|
|
commentWrites += 1;
|
|
res.status(201).json({ ok: true });
|
|
});
|
|
|
|
const res = await request(app).post("/comments").set("Authorization", authorization).send({ body: "reply" });
|
|
|
|
expect(res.status).toBe(401);
|
|
expect(res.body.error).toContain(error);
|
|
expect(commentWrites).toBe(0);
|
|
});
|
|
|
|
it.each([
|
|
["terminated", "Agent is terminated"],
|
|
["pending_approval", "Agent is pending approval"],
|
|
])("rejects a %s agent JWT instead of retaining local-board", async (status, error) => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const runId = randomUUID();
|
|
const { db } = createDbState({ agent: { id: agentId, companyId, status } });
|
|
const token = createLocalAgentJwt(agentId, companyId, "codex_local", runId, "user-1");
|
|
|
|
const res = await request(createApp(db, "local_trusted"))
|
|
.get("/actor")
|
|
.set("Authorization", `Bearer ${token}`);
|
|
|
|
expect(res.status).toBe(401);
|
|
expect(res.body.error).toContain(error);
|
|
});
|
|
|
|
it("rejects an agent JWT when the agent record belongs to another company", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const runId = randomUUID();
|
|
const { db } = createDbState({ agent: { id: agentId, companyId: randomUUID() } });
|
|
const token = createLocalAgentJwt(agentId, companyId, "codex_local", runId, "user-1");
|
|
|
|
const res = await request(createApp(db, "local_trusted"))
|
|
.get("/actor")
|
|
.set("Authorization", `Bearer ${token}`);
|
|
|
|
expect(res.status).toBe(401);
|
|
expect(res.body.error).toContain("missing or belongs to another company");
|
|
});
|
|
|
|
it("reports an expired agent JWT specifically", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const runId = randomUUID();
|
|
const { db } = createDbState({ agent: { id: agentId, companyId } });
|
|
const token = craftAgentJwtWithoutResponsibleClaim({
|
|
secret: process.env.PAPERCLIP_AGENT_JWT_SECRET!,
|
|
agentId,
|
|
companyId,
|
|
adapterType: "codex_local",
|
|
runId,
|
|
expiresInSeconds: -1,
|
|
});
|
|
|
|
const res = await request(createApp(db, "local_trusted"))
|
|
.get("/actor")
|
|
.set("Authorization", `Bearer ${token}`);
|
|
|
|
expect(res.status).toBe(401);
|
|
expect(res.body.error).toContain("Expired agent token");
|
|
});
|
|
|
|
it("uses the signed responsible_user_id claim and keeps the signed run id authoritative", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const runId = randomUUID();
|
|
const { db } = createDbState({
|
|
agent: { id: agentId, companyId },
|
|
run: { id: runId, companyId, agentId, responsibleUserId: "user-row" },
|
|
});
|
|
const token = createLocalAgentJwt(agentId, companyId, "codex_local", runId, "user-claim");
|
|
|
|
const res = await request(createApp(db))
|
|
.get("/actor")
|
|
.set("Authorization", `Bearer ${token}`)
|
|
.set("X-Paperclip-Run-Id", runId);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toMatchObject({
|
|
type: "agent",
|
|
agentId,
|
|
companyId,
|
|
runId,
|
|
onBehalfOfUserId: "user-claim",
|
|
source: "agent_jwt",
|
|
});
|
|
});
|
|
|
|
it("preserves signed skill_test JWT scope on the request actor", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const runId = randomUUID();
|
|
const issueId = randomUUID();
|
|
const { db } = createDbState({
|
|
agent: { id: agentId, companyId },
|
|
run: { id: runId, companyId, agentId, responsibleUserId: "user-claim" },
|
|
});
|
|
const token = createLocalAgentJwt(agentId, companyId, "codex_local", runId, "user-claim", {
|
|
kind: "skill_test",
|
|
issueId,
|
|
});
|
|
|
|
const res = await request(createApp(db))
|
|
.get("/actor")
|
|
.set("Authorization", `Bearer ${token}`)
|
|
.set("X-Paperclip-Run-Id", runId);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toMatchObject({
|
|
type: "agent",
|
|
agentId,
|
|
companyId,
|
|
keyScope: { kind: "skill_test", issueId },
|
|
source: "agent_jwt",
|
|
});
|
|
});
|
|
|
|
it("rejects mismatched run headers for agent JWTs and audits the spoof attempt", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const runId = randomUUID();
|
|
const spoofedRunId = randomUUID();
|
|
const { db, activity } = createDbState({
|
|
agent: { id: agentId, companyId },
|
|
run: { id: runId, companyId, agentId, responsibleUserId: "user-claim" },
|
|
});
|
|
const token = createLocalAgentJwt(agentId, companyId, "codex_local", runId, "user-claim");
|
|
|
|
const res = await request(createApp(db))
|
|
.get("/actor")
|
|
.set("Authorization", `Bearer ${token}`)
|
|
.set("X-Paperclip-Run-Id", spoofedRunId);
|
|
|
|
expect(res.status).toBe(422);
|
|
expect(res.body.code).toBe("agent_jwt_run_id_mismatch");
|
|
expect(activity).toHaveLength(1);
|
|
expect(activity[0]).toMatchObject({
|
|
companyId,
|
|
actorType: "agent",
|
|
actorId: agentId,
|
|
action: "auth.agent_jwt_run_header_mismatch",
|
|
entityType: "heartbeat_run",
|
|
entityId: runId,
|
|
runId,
|
|
details: { claimRunId: runId, headerRunId: spoofedRunId },
|
|
});
|
|
});
|
|
|
|
it("falls back to the run row responsible user for legacy claim-less agent JWTs", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const runId = randomUUID();
|
|
const { db } = createDbState({
|
|
agent: { id: agentId, companyId },
|
|
run: { id: runId, companyId, agentId, responsibleUserId: "user-legacy" },
|
|
});
|
|
const token = craftAgentJwtWithoutResponsibleClaim({
|
|
secret: process.env.PAPERCLIP_AGENT_JWT_SECRET!,
|
|
agentId,
|
|
companyId,
|
|
adapterType: "codex_local",
|
|
runId,
|
|
});
|
|
|
|
const res = await request(createApp(db))
|
|
.get("/actor")
|
|
.set("Authorization", `Bearer ${token}`);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toMatchObject({
|
|
type: "agent",
|
|
runId,
|
|
onBehalfOfUserId: "user-legacy",
|
|
source: "agent_jwt",
|
|
});
|
|
});
|
|
|
|
it("rejects fork-minted run JWTs before issue reads or writes reach live issue data", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const runId = randomUUID();
|
|
const issueId = randomUUID();
|
|
const { db } = createDbState({
|
|
agent: { id: agentId, companyId },
|
|
run: { id: runId, companyId, agentId, responsibleUserId: "user-claim" },
|
|
});
|
|
|
|
process.env.PAPERCLIP_INSTANCE_ID = "pap-12899-worktree";
|
|
const forkToken = createLocalAgentJwt(agentId, companyId, "codex_local", runId, "user-claim");
|
|
expect(forkToken).not.toBeNull();
|
|
|
|
process.env.PAPERCLIP_INSTANCE_ID = "default";
|
|
const app = createApp(db);
|
|
const readRes = await request(app)
|
|
.get(`/companies/${companyId}/issues/${issueId}`)
|
|
.set("Authorization", `Bearer ${forkToken}`)
|
|
.set("X-Paperclip-Run-Id", runId);
|
|
const writeRes = await request(app)
|
|
.patch(`/companies/${companyId}/issues/${issueId}`)
|
|
.set("Authorization", `Bearer ${forkToken}`)
|
|
.set("X-Paperclip-Run-Id", runId)
|
|
.send({ title: "should not write" });
|
|
|
|
expect(readRes.status).toBe(401);
|
|
expect(writeRes.status).toBe(401);
|
|
});
|
|
|
|
it("populates agent-key actors from the key responsible user binding", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const token = "pcp_test_agent_key";
|
|
const { db } = createDbState({
|
|
agent: { id: agentId, companyId },
|
|
agentKey: {
|
|
id: randomUUID(),
|
|
agentId,
|
|
companyId,
|
|
keyHash: hashToken(token),
|
|
responsibleUserId: "user-key",
|
|
},
|
|
});
|
|
|
|
const res = await request(createApp(db))
|
|
.get("/actor")
|
|
.set("Authorization", `Bearer ${token}`);
|
|
|
|
expect(res.status).toBe(200);
|
|
expect(res.body).toMatchObject({
|
|
type: "agent",
|
|
agentId,
|
|
companyId,
|
|
onBehalfOfUserId: "user-key",
|
|
source: "agent_key",
|
|
});
|
|
});
|
|
|
|
it("rejects agent keys that lack a responsible user binding and audits the denial", async () => {
|
|
const companyId = randomUUID();
|
|
const agentId = randomUUID();
|
|
const keyId = randomUUID();
|
|
const token = "pcp_test_agent_key_without_user";
|
|
const { db, activity } = createDbState({
|
|
agent: { id: agentId, companyId },
|
|
agentKey: {
|
|
id: keyId,
|
|
agentId,
|
|
companyId,
|
|
keyHash: hashToken(token),
|
|
responsibleUserId: null,
|
|
},
|
|
});
|
|
|
|
const res = await request(createApp(db))
|
|
.get(`/companies/${companyId}/protected`)
|
|
.set("Authorization", `Bearer ${token}`);
|
|
|
|
expect(res.status).toBe(403);
|
|
expect(res.body.code).toBe("RESPONSIBLE_USER_UNAVAILABLE");
|
|
expect(activity).toHaveLength(1);
|
|
expect(activity[0]).toMatchObject({
|
|
companyId,
|
|
actorType: "agent",
|
|
actorId: agentId,
|
|
action: "auth.agent_key_missing_responsible_user",
|
|
entityType: "agent_api_key",
|
|
entityId: keyId,
|
|
details: { method: "GET", url: `/companies/${companyId}/protected` },
|
|
});
|
|
});
|
|
});
|