mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-21 16:27:18 +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>
78 lines
2.4 KiB
TypeScript
78 lines
2.4 KiB
TypeScript
import {
|
|
guardedRemoteHttpFetch,
|
|
type GuardedRemoteHttpFetchOptions,
|
|
} from "../../services/remote-http-fetch.js";
|
|
import { parseRemoteHttpEndpoint } from "../../services/remote-http-endpoint-guard.js";
|
|
|
|
const PRIVATE_ENDPOINT_ALLOWLIST_ENV = "PAPERCLIP_HTTP_ADAPTER_PRIVATE_ENDPOINT_ALLOWLIST";
|
|
|
|
export class HttpAdapterEndpointError extends Error {
|
|
readonly code: string;
|
|
|
|
constructor(message: string, code: string) {
|
|
super(message);
|
|
this.name = "HttpAdapterEndpointError";
|
|
this.code = code;
|
|
}
|
|
}
|
|
|
|
function endpointError(message: string, code: string) {
|
|
return new HttpAdapterEndpointError(
|
|
message
|
|
.replaceAll("Remote MCP connection", "HTTP adapter endpoint")
|
|
.replaceAll("Remote MCP endpoint", "HTTP adapter endpoint"),
|
|
code,
|
|
);
|
|
}
|
|
|
|
function normalizeAllowlistedOrigin(value: string): string | null {
|
|
let endpoint: URL;
|
|
try {
|
|
endpoint = new URL(value);
|
|
} catch {
|
|
return null;
|
|
}
|
|
if (endpoint.protocol !== "http:" && endpoint.protocol !== "https:") return null;
|
|
if (endpoint.username || endpoint.password || endpoint.search || endpoint.hash) return null;
|
|
if (endpoint.pathname !== "/") return null;
|
|
return endpoint.origin.toLowerCase();
|
|
}
|
|
|
|
export function httpAdapterPrivateEndpointAllowlist(
|
|
raw = process.env[PRIVATE_ENDPOINT_ALLOWLIST_ENV] ?? "",
|
|
): ReadonlySet<string> {
|
|
return new Set(
|
|
raw
|
|
.split(",")
|
|
.map((entry) => normalizeAllowlistedOrigin(entry.trim()))
|
|
.filter((entry): entry is string => entry !== null),
|
|
);
|
|
}
|
|
|
|
type HttpAdapterFetchOptions = Omit<
|
|
GuardedRemoteHttpFetchOptions,
|
|
"allowPrivateNetwork" | "error"
|
|
> & {
|
|
privateEndpointAllowlist?: ReadonlySet<string>;
|
|
};
|
|
|
|
/**
|
|
* Guard every HTTP-adapter request at the actual socket boundary. Public
|
|
* endpoints are allowed by default. An exact operator-configured origin can
|
|
* opt into private networking, while the shared guard continues to reject
|
|
* link-local metadata targets and pins DNS results to prevent rebinding.
|
|
*/
|
|
export async function guardedHttpAdapterFetch(
|
|
url: string | URL,
|
|
init: RequestInit,
|
|
options: HttpAdapterFetchOptions = {},
|
|
): Promise<Response> {
|
|
const endpoint = parseRemoteHttpEndpoint(url.toString(), endpointError);
|
|
const allowlist = options.privateEndpointAllowlist ?? httpAdapterPrivateEndpointAllowlist();
|
|
return guardedRemoteHttpFetch(endpoint, init, {
|
|
...options,
|
|
allowPrivateNetwork: allowlist.has(endpoint.origin.toLowerCase()),
|
|
error: endpointError,
|
|
});
|
|
}
|