Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 874x 2x 2x 874x 872x 871x 871x 874x 2x 2x 874x 874x 2x 2x 874x 874x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 16x 868x 868x 868x 868x 1x 1x 868x 1x 1x 868x 868x 16x 16x 1x 1x 1x 1x 1x 1x 1x 1x 1x 16x 1x 1x 16x 1x 1x 1x 1x 16x 3x 3x 3x 3x 3x 3x 3x 3x 3x 16x 1x 1x 1x 1x 1x 1x 16x 11x 11x 11x 11x 11x 11x 11x 857x 11x 11x 11x 11x 123x 954x 954x 1x 1x 1x 1x 1x 954x 954x 1x 1x 1x 1x 1x 954x 112x 112x 954x 123x 11x 11x 16x 1x 1x 1x 1x 1x 1x 1x 1x 1x 13x 13x 13x 13x 13x 13x 1x 1x 1x 1x 13x 13x 8x 8x 8x 8x 8x 8x 8x 8x 8x 13x 3x 3x 3x 13x 1x 1x 1x 1x 1x 1x 13x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 11x 11x 11x 11x 5x 19x 2x 2x 19x 3x 3x 19x 11x 11x | "use strict";
/**
* Resolve an existing SDK input (package directory or npm package archive).
*
* Directories are read in place and never written to: declarations and the
* execution bundle are produced in the oag-mcp workspace, and dependencies
* resolve from the SDK's own `node_modules` (or a parent's). Archives are
* extracted safely into the workspace. The supplied SDK is never modified.
*
* @module prepare/sdk-input
*/
import fs from "node:fs";
import path from "node:path";
import * as tar from "tar";
import { OagMcpError } from "../errors.js";
import { sha256File, sha256Tree } from "../util/hash.js";
/** Limits applied when extracting archives. */
export const ARCHIVE_LIMITS = {
maxEntries: 20000,
maxTotalBytes: 256 * 1024 * 1024,
};
/** Entry types allowed in SDK archives. */
const ALLOWED_ENTRY_TYPES = new Set([
"File",
"OldFile",
"ContiguousFile",
"Directory",
]);
/** Result of resolving an SDK input. */
export interface StagedSdk {
/**
* Package root (directory containing package.json/src): the supplied
* directory itself (read-only use) or the extracted archive.
*/
root: string;
kind: "directory" | "archive";
/** Hash of the original input (archive bytes or directory tree). */
sha256: string;
}
const IGNORED_TREE_ENTRIES = new Set([".git", "node_modules"]);
/**
* Validate an archive entry path, returning a reason when unsafe.
*
* @param {String} entryPath - path recorded in the archive
* @return {String|undefined} rejection reason
*/
export function unsafeArchivePath(entryPath: string): string | undefined {
if (!entryPath || entryPath.includes("\0")) {
return "empty or NUL-containing path";
}
if (
entryPath.startsWith("/") ||
entryPath.startsWith("\\") ||
/^[a-zA-Z]:/.test(entryPath)
) {
return "absolute path";
}
const segments = entryPath.split(/[\\/]+/);
if (segments.includes("..")) {
return "parent directory traversal";
}
return undefined;
}
/**
* Extract an npm package archive safely into `dest`.
*
* Entries are validated before extraction: absolute paths, `..` traversal,
* links, devices and FIFOs are rejected, and entry count and total size are
* bounded. After extraction every path is checked to resolve inside `dest`.
*
* @param {String} archive - path to the .tgz archive
* @param {String} dest - empty destination directory
* @return {Promise} absolute path of the package root inside `dest`
*/
export async function extractArchive(
archive: string,
dest: string,
): Promise<string> {
const problems: string[] = [];
let count = 0;
let total = 0;
const topLevel = new Set<string>();
try {
await tar.t({
file: archive,
strict: true,
onReadEntry: (entry) => {
count++;
total += entry.size ?? 0;
const reason = unsafeArchivePath(entry.path);
if (reason) {
problems.push(`${entry.path}: ${reason}`);
}
if (!ALLOWED_ENTRY_TYPES.has(String(entry.type))) {
problems.push(`${entry.path}: entry type ${entry.type} not allowed`);
}
topLevel.add(entry.path.split(/[\\/]+/)[0]);
},
});
} catch (err) {
throw new OagMcpError(
"SDK_ARCHIVE_INVALID",
`SDK archive ${archive} could not be read: ${(err as Error).message}`,
{
hint: "Provide a gzip-compressed npm package archive, e.g. created with `npm pack`.",
cause: err,
},
);
}
if (count > ARCHIVE_LIMITS.maxEntries) {
problems.push(`too many entries (${count} > ${ARCHIVE_LIMITS.maxEntries})`);
}
if (total > ARCHIVE_LIMITS.maxTotalBytes) {
problems.push(
`uncompressed size too large (${total} > ${ARCHIVE_LIMITS.maxTotalBytes} bytes)`,
);
}
if (problems.length > 0) {
throw new OagMcpError(
"SDK_ARCHIVE_UNSAFE",
`SDK archive ${archive} contains unsafe entries: ${problems.slice(0, 5).join("; ")}`,
{
hint: "Repack the SDK with `npm pack`; archives must not contain links, absolute paths or '..' segments.",
details: { problems: problems.slice(0, 20) },
},
);
}
if (topLevel.size !== 1) {
throw new OagMcpError(
"SDK_ARCHIVE_LAYOUT",
`SDK archive must contain a single top-level directory (found: ${[...topLevel].join(", ")})`,
{ hint: "npm pack archives contain a single `package/` directory." },
);
}
fs.mkdirSync(dest, { recursive: true });
await tar.x({
file: archive,
cwd: dest,
strict: true,
preservePaths: false,
noChmod: true,
filter: (_p, entry) =>
ALLOWED_ENTRY_TYPES.has(String((entry as tar.ReadEntry).type)),
});
const realDest = fs.realpathSync(dest);
const root = path.join(realDest, [...topLevel][0]);
const check = (dir: string) => {
for (const e of fs.readdirSync(dir, { withFileTypes: true })) {
const abs = path.join(dir, e.name);
if (e.isSymbolicLink()) {
throw new OagMcpError(
"SDK_ARCHIVE_UNSAFE",
`Extracted archive contains a link: ${path.relative(realDest, abs)}`,
);
}
const real = fs.realpathSync(abs);
if (!real.startsWith(realDest + path.sep)) {
throw new OagMcpError(
"SDK_ARCHIVE_UNSAFE",
`Extracted path escapes destination: ${path.relative(realDest, abs)}`,
);
}
if (e.isDirectory()) {
check(abs);
}
}
};
check(realDest);
return root;
}
/**
* Resolve an SDK input. Archives are extracted into `workDir`; directories
* are used in place, read-only.
*
* @param {String} input - SDK directory or .tgz archive path
* @param {String} workDir - private workspace directory for extraction
* @return {Promise} staged SDK
*/
export async function stageSdkInput(
input: string,
workDir: string,
): Promise<StagedSdk> {
const abs = path.resolve(input);
if (!fs.existsSync(abs)) {
throw new OagMcpError("SDK_NOT_FOUND", `SDK path ${input} does not exist`, {
hint: "Pass --sdk <directory|package.tgz> pointing at an existing OpenAPI Generator typescript-fetch SDK.",
});
}
const stat = fs.statSync(abs);
if (stat.isDirectory()) {
return {
root: fs.realpathSync(abs),
kind: "directory",
sha256: sha256Tree(
abs,
(rel) => !rel.split("/").some((s) => IGNORED_TREE_ENTRIES.has(s)),
),
};
}
if (/\.(tgz|tar\.gz)$/i.test(abs)) {
const root = await extractArchive(abs, workDir);
return { root, kind: "archive", sha256: sha256File(abs) };
}
throw new OagMcpError(
"SDK_INPUT_UNSUPPORTED",
`SDK input ${input} is neither a directory nor a .tgz package archive`,
{
hint: "Use a generated typescript-fetch SDK directory or an archive produced by `npm pack`.",
},
);
}
/**
* Find the runtime dependencies of an SDK that cannot be resolved from its
* root, using Node.js lookup rules (`node_modules` in the root or any
* parent directory). Nothing is installed.
*
* @param {String} root - SDK package root
* @param {Object} [deps] - package.json dependencies
* @return {Array} names of missing dependencies
*/
export function missingDependencies(
root: string,
deps: Record<string, string> | undefined,
): string[] {
return Object.keys(deps ?? {}).filter((name) => {
for (let dir = root; ; dir = path.dirname(dir)) {
if (fs.existsSync(path.join(dir, "node_modules", name, "package.json"))) {
return false;
}
if (path.dirname(dir) === dir) {
return true;
}
}
});
}
|