mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-26 02:00:52 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Paperclip uses adapters to connect agents and model providers to its control plane > - The sandbox login panel supports displayed-code login for selected adapters > - Grok users need the same login path and a private credential home for later runs > - This pull request adds Grok support to the shared device-login path and preserves the existing Codex path > - The benefit is one secure login flow for both adapters with company-scoped credential storage ## Linked Issues or Issue Description **Agent or provider** Grok Local needs displayed-code login support in the sandbox login panel. **Why this adapter is useful** This change lets users sign in to Grok from the sandbox login panel. It also gives later Grok runs access to the stored credential. **How the agent is invoked** The Grok local adapter uses its login command through the shared displayed-code login flow. Later runs receive the managed home through `GROK_HOME`. **Additional context** The change uses adapter-scoped login lifecycle handling. It stores the credential in a company-scoped directory with mode `0700`, and it stores the credential file with mode `0600`. ## What Changed - Rename the shared device-login modules to adapter-neutral names. - Scope the shared login lifecycle to a closed adapter set. - Return the device-login URL that the provider prints. - Add the Grok prompt parser, login command, capability, and login panel entry. - Store the Grok credential in a private, company-scoped home directory. - Pass `GROK_HOME` to later Grok runs. - Add tests for the Grok adapter, the Daytona sandbox provider, the server login path, and the user interface. ## Verification - Run `pnpm vitest run packages/adapters/grok-local/src/server/adapter-auth-promotion.test.ts`. - Run the Grok adapter package suite. - Run the Daytona sandbox provider suite. - Run the server device-login suites. - Run the user interface suite. - Confirm the full CI suite passes. ## Risks The change extends shared login lifecycle code to another adapter. A regression could affect Codex login. The credential path uses explicit `chmod` calls to keep the directory at mode `0700` and the file at mode `0600`. ## Model Used OpenAI Codex, GPT-5. The runtime used tool calls and code review support. The runtime did not provide a context-window value. ## 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 - [ ] 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>
94 lines
3.4 KiB
JavaScript
94 lines
3.4 KiB
JavaScript
// The descriptor-bound credential read helper. The server runs it in the sandbox
|
|
// as `node -e <this file> <sessionHome> <maxBytes> [<expectedUid>]`. The sandbox
|
|
// already runs node for the Paperclip bridge, so the helper needs no extra
|
|
// runtime.
|
|
//
|
|
// The helper closes the time-of-check-to-time-of-use (TOCTOU) window. It opens
|
|
// the filesystem root, then opens each session-home path component in turn with a
|
|
// no-follow, directory-only open, relative to the previous directory descriptor. A
|
|
// symlink at any component fails the walk. Node has no `openat`, so the helper
|
|
// opens each next component through `/proc/self/fd/<dfd>/<component>`: the kernel
|
|
// resolves the magic descriptor link, then applies `O_NOFOLLOW` to the final
|
|
// component. This binds each open to the descriptor inode, not to a re-resolved
|
|
// pathname, so it matches an `openat` walk.
|
|
//
|
|
// The helper opens `auth.json` relative to the final directory descriptor with
|
|
// `O_NOFOLLOW`, runs `fstat` on that one descriptor, and reads only from it. The
|
|
// `fstat` check requires a regular file, the expected owner, exact mode `0600`,
|
|
// and a size at or below the bound. The helper never re-opens the pathname after
|
|
// the check.
|
|
//
|
|
// Security: the helper prints only the base64 of the credential bytes on the
|
|
// fully validated success path. It prints one fixed error token on stderr on every
|
|
// failed path. It never prints the pathname, the raw bytes, or any other detail.
|
|
|
|
"use strict";
|
|
|
|
const fs = require("node:fs");
|
|
|
|
const NAME = "auth.json";
|
|
const home = process.argv[1];
|
|
const max = Number.parseInt(process.argv[2], 10);
|
|
const expectedUid =
|
|
process.argv[3] !== undefined ? Number.parseInt(process.argv[3], 10) : process.getuid();
|
|
|
|
function fail() {
|
|
process.stderr.write("AUTH_READ_FAILED\n");
|
|
process.exit(1);
|
|
}
|
|
|
|
if (!Number.isInteger(max) || max <= 0) fail();
|
|
if (typeof home !== "string" || !home.startsWith("/")) fail();
|
|
const parts = home.split("/").filter((component) => component.length > 0);
|
|
if (parts.length === 0) fail();
|
|
|
|
// Open each component with a no-follow, directory-only open relative to the
|
|
// previous descriptor. A symlink or a non-directory at any component throws, so
|
|
// the read fails closed and never leaves the trusted tree.
|
|
let dfd;
|
|
try {
|
|
dfd = fs.openSync("/", fs.constants.O_RDONLY | fs.constants.O_DIRECTORY);
|
|
} catch {
|
|
fail();
|
|
}
|
|
for (const part of parts) {
|
|
try {
|
|
dfd = fs.openSync(
|
|
`/proc/self/fd/${dfd}/${part}`,
|
|
fs.constants.O_RDONLY | fs.constants.O_DIRECTORY | fs.constants.O_NOFOLLOW,
|
|
);
|
|
} catch {
|
|
fail();
|
|
}
|
|
}
|
|
|
|
// Open the credential relative to the final directory descriptor with a no-follow
|
|
// open, so a symlink credential fails and a missing credential fails.
|
|
let ffd;
|
|
try {
|
|
ffd = fs.openSync(`/proc/self/fd/${dfd}/${NAME}`, fs.constants.O_RDONLY | fs.constants.O_NOFOLLOW);
|
|
} catch {
|
|
fail();
|
|
}
|
|
|
|
// Validate the opened descriptor, then read only from it.
|
|
const st = fs.fstatSync(ffd);
|
|
if (!st.isFile()) fail();
|
|
if (st.uid !== expectedUid) fail();
|
|
if ((st.mode & 0o7777) !== 0o600) fail();
|
|
if (st.size > max) fail();
|
|
|
|
const buffer = Buffer.allocUnsafe(65536);
|
|
const chunks = [];
|
|
let total = 0;
|
|
for (;;) {
|
|
const read = fs.readSync(ffd, buffer, 0, buffer.length, null);
|
|
if (read === 0) break;
|
|
chunks.push(Buffer.from(buffer.subarray(0, read)));
|
|
total += read;
|
|
if (total > max) fail();
|
|
}
|
|
|
|
process.stdout.write(Buffer.concat(chunks).toString("base64"));
|
|
process.exit(0);
|