mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-22 00:30:19 +02:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - The server controls secrets, host files, outbound requests, and workspace commands > - A red-team review found cases where restricted callers could cross these trust boundaries > - These cases could expose credentials or let untrusted input reach privileged resources > - This pull request applies least-privilege checks at each affected server boundary > - The benefit is safer agent execution without changing the private-instance bootstrap contract ## Linked Issues or Issue Description **What happened?** Several server paths used authorization, redaction, or content-delivery rules that were too broad. Restricted agent keys could obtain company-level operational data. Some adapter and instruction paths could reach server-owned network or file resources without the required owner approval. **Expected behavior** Paperclip must redact credential values, enforce restricted-key scopes, guard outbound network access, prevent same-origin script execution, and reserve host-level file and command controls for authorized operators. **Steps to reproduce** 1. Configure an authenticated development instance at the parent commit. 2. Exercise the affected APIs with a restricted agent key or a non-instance-admin company user. 3. Observe that the parent commit returns privileged data or accepts a privileged operation. 4. Repeat on this branch and observe a redacted response, a safe download, or an HTTP 403 response. **Paperclip version or commit** The findings reproduce from commit `39898ab22` and are fixed by this pull request. **Deployment mode** Authenticated self-hosted server and local development modes. **Installation method** Built from source with pnpm. ## What Changed - Redact generic secret `value` and `token` fields recursively in structured logs. - Classify exact and separator-suffixed `KEY` environment names as secrets in company exports. - Limit restricted self-identity responses and protect company run, log, and secret catalog APIs. - Route HTTP adapter requests through DNS-pinned SSRF protection with exact private-origin allowlisting. - Download HTML, SVG, and other script-capable assets with `nosniff` and a sandbox CSP. - Require instance-admin access for external instruction roots and exports that read them. - Block agent-authenticated host command persistence across supported workspace runtime shapes. - Apply the central runtime-management decision before workspace command controls. - Keep the documented first-user instance-admin claim contract unchanged. - Add regression tests and server-owner configuration documentation. ## Verification - `pnpm -r typecheck` passes. - The Node 24 remediation suite passes with 365 tests. It skips 25 environment-gated tests. - `pnpm build` passes under Node 24. - `git diff --check` passes. - The full local runner reaches known macOS-only general-server harness failures before the serialized route lane. The Linux PR matrix is the authoritative full-suite gate. ## Risks - Restricted agent keys now receive HTTP 403 responses from company-wide run, log, and secret catalog endpoints. - Script-capable assets now download instead of rendering inline. - External instruction roots now require instance-admin access. - Private HTTP adapter endpoints now require an exact origin in `PAPERCLIP_HTTP_ADAPTER_PRIVATE_ENDPOINT_ALLOWLIST`. - Public HTTP adapter endpoints remain enabled. Redirects and metadata or link-local targets remain blocked. - No database migration is required. > 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. The exact serving snapshot and context-window size are not exposed. The model used tool-enabled reasoning, repository access, code execution, and test execution. ## 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>
167 lines
5.1 KiB
TypeScript
167 lines
5.1 KiB
TypeScript
import type { Request } from "express";
|
|
import { forbidden } from "../errors.js";
|
|
|
|
function isRecord(value: unknown): value is Record<string, unknown> {
|
|
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
}
|
|
|
|
function hasOwn(value: Record<string, unknown>, key: string) {
|
|
return Object.prototype.hasOwnProperty.call(value, key);
|
|
}
|
|
|
|
function prefixPath(prefix: string, key: string) {
|
|
return prefix.length > 0 ? `${prefix}.${key}` : key;
|
|
}
|
|
|
|
function collectWorkspaceStrategyCommandPaths(raw: unknown, prefix: string): string[] {
|
|
if (!isRecord(raw)) return [];
|
|
const paths: string[] = [];
|
|
if (hasOwn(raw, "provisionCommand")) {
|
|
paths.push(prefixPath(prefix, "provisionCommand"));
|
|
}
|
|
if (hasOwn(raw, "runtimeProvisionCommand")) {
|
|
paths.push(prefixPath(prefix, "runtimeProvisionCommand"));
|
|
}
|
|
if (hasOwn(raw, "teardownCommand")) {
|
|
paths.push(prefixPath(prefix, "teardownCommand"));
|
|
}
|
|
return paths;
|
|
}
|
|
|
|
function collectWorkspaceRuntimeCommandPaths(raw: unknown, prefix: string): string[] {
|
|
if (!isRecord(raw)) return [];
|
|
const paths: string[] = [];
|
|
for (const collectionKey of ["commands", "services", "jobs"] as const) {
|
|
const entries = raw[collectionKey];
|
|
if (!Array.isArray(entries)) continue;
|
|
entries.forEach((entry, index) => {
|
|
if (isRecord(entry) && hasOwn(entry, "command")) {
|
|
paths.push(`${prefixPath(prefix, collectionKey)}[${index}].command`);
|
|
}
|
|
});
|
|
}
|
|
return paths;
|
|
}
|
|
|
|
function collectExecutionWorkspaceConfigCommandPaths(raw: unknown, prefix: string): string[] {
|
|
if (!isRecord(raw)) return [];
|
|
const paths: string[] = [];
|
|
if (hasOwn(raw, "provisionCommand")) {
|
|
paths.push(prefixPath(prefix, "provisionCommand"));
|
|
}
|
|
if (hasOwn(raw, "runtimeProvisionCommand")) {
|
|
paths.push(prefixPath(prefix, "runtimeProvisionCommand"));
|
|
}
|
|
if (hasOwn(raw, "teardownCommand")) {
|
|
paths.push(prefixPath(prefix, "teardownCommand"));
|
|
}
|
|
if (hasOwn(raw, "cleanupCommand")) {
|
|
paths.push(prefixPath(prefix, "cleanupCommand"));
|
|
}
|
|
paths.push(
|
|
...collectWorkspaceRuntimeCommandPaths(
|
|
raw.workspaceRuntime,
|
|
prefixPath(prefix, "workspaceRuntime"),
|
|
),
|
|
);
|
|
return paths;
|
|
}
|
|
|
|
export function assertNoAgentHostWorkspaceCommandMutation(req: Request, paths: string[]) {
|
|
if (req.actor.type !== "agent" || paths.length === 0) return;
|
|
throw forbidden(
|
|
`Agent keys cannot modify host-executed workspace commands (${paths.join(", ")}).`,
|
|
);
|
|
}
|
|
|
|
export function collectAgentAdapterWorkspaceCommandPaths(
|
|
adapterConfig: unknown,
|
|
prefix = "adapterConfig",
|
|
): string[] {
|
|
if (!isRecord(adapterConfig)) return [];
|
|
return collectWorkspaceStrategyCommandPaths(
|
|
adapterConfig.workspaceStrategy,
|
|
`${prefix}.workspaceStrategy`,
|
|
);
|
|
}
|
|
|
|
export function collectProjectExecutionWorkspaceCommandPaths(policy: unknown): string[] {
|
|
if (!isRecord(policy)) return [];
|
|
return [
|
|
...collectWorkspaceStrategyCommandPaths(
|
|
policy.workspaceStrategy,
|
|
"executionWorkspacePolicy.workspaceStrategy",
|
|
),
|
|
...collectWorkspaceRuntimeCommandPaths(
|
|
policy.workspaceRuntime,
|
|
"executionWorkspacePolicy.workspaceRuntime",
|
|
),
|
|
];
|
|
}
|
|
|
|
export function collectProjectWorkspaceCommandPaths(
|
|
workspacePatch: unknown,
|
|
prefix = "",
|
|
): string[] {
|
|
if (!isRecord(workspacePatch)) return [];
|
|
const paths = hasOwn(workspacePatch, "cleanupCommand")
|
|
? [prefixPath(prefix, "cleanupCommand")]
|
|
: [];
|
|
if (isRecord(workspacePatch.runtimeConfig)) {
|
|
paths.push(
|
|
...collectWorkspaceRuntimeCommandPaths(
|
|
workspacePatch.runtimeConfig.workspaceRuntime,
|
|
prefixPath(prefix, "runtimeConfig.workspaceRuntime"),
|
|
),
|
|
);
|
|
}
|
|
return paths;
|
|
}
|
|
|
|
export function collectIssueWorkspaceCommandPaths(input: {
|
|
executionWorkspaceSettings?: unknown;
|
|
assigneeAdapterOverrides?: unknown;
|
|
}): string[] {
|
|
const paths: string[] = [];
|
|
if (isRecord(input.executionWorkspaceSettings)) {
|
|
paths.push(
|
|
...collectWorkspaceStrategyCommandPaths(
|
|
input.executionWorkspaceSettings.workspaceStrategy,
|
|
"executionWorkspaceSettings.workspaceStrategy",
|
|
),
|
|
);
|
|
paths.push(
|
|
...collectWorkspaceRuntimeCommandPaths(
|
|
input.executionWorkspaceSettings.workspaceRuntime,
|
|
"executionWorkspaceSettings.workspaceRuntime",
|
|
),
|
|
);
|
|
}
|
|
if (isRecord(input.assigneeAdapterOverrides)) {
|
|
const adapterConfig = input.assigneeAdapterOverrides.adapterConfig;
|
|
if (isRecord(adapterConfig)) {
|
|
paths.push(
|
|
...collectWorkspaceStrategyCommandPaths(
|
|
adapterConfig.workspaceStrategy,
|
|
"assigneeAdapterOverrides.adapterConfig.workspaceStrategy",
|
|
),
|
|
);
|
|
}
|
|
}
|
|
return paths;
|
|
}
|
|
|
|
export function collectExecutionWorkspaceCommandPaths(input: {
|
|
config?: unknown;
|
|
metadata?: unknown;
|
|
}): string[] {
|
|
const paths: string[] = [];
|
|
if (input.config !== undefined) {
|
|
paths.push(...collectExecutionWorkspaceConfigCommandPaths(input.config, "config"));
|
|
}
|
|
if (isRecord(input.metadata) && hasOwn(input.metadata, "config")) {
|
|
paths.push(...collectExecutionWorkspaceConfigCommandPaths(input.metadata.config, "metadata.config"));
|
|
}
|
|
return paths;
|
|
}
|