Skip to content

The open alternative to Salesforce, designed for AI.

fix(server): reject oversized app tarballs without crashing the process (#27471)

JotaDuo7546021edac3
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-package/application-package-fetcher.service.ts b/packages/twenty-server/src/engine/core-modules/application/application-package/application-package-fetcher.service.ts
index 14b2549994d..1d02e3f0bf7 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-package/application-package-fetcher.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-package/application-package-fetcher.service.ts
@@ -202,7 +202,7 @@ export class ApplicationPackageFetcherService implements OnModuleInit {
const tarballPath = join(workDir, 'package.tgz');
await fs.writeFile(tarballPath, tarballBuffer);
- await extractTarballSecurely(tarballPath, workDir);
+ await extractTarballSecurely({ tarballPath, targetDir: workDir });
await fs.rm(tarballPath);
const contentDir = await resolvePackageContentDir(workDir);
@@ -288,7 +288,7 @@ export class ApplicationPackageFetcherService implements OnModuleInit {
const tarballPath = join(workDir, 'app.tar.gz');
await fs.writeFile(tarballPath, tarballBuffer);
- await extractTarballSecurely(tarballPath, workDir);
+ await extractTarballSecurely({ tarballPath, targetDir: workDir });
await fs.rm(tarballPath);
const contentDir = await resolvePackageContentDir(workDir);
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-package/utils/extract-tarball-securely.util.ts b/packages/twenty-server/src/engine/core-modules/application/application-package/utils/extract-tarball-securely.util.ts
index 94c00efe988..7a0b49aeff1 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-package/utils/extract-tarball-securely.util.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-package/utils/extract-tarball-securely.util.ts
@@ -1,3 +1,4 @@
+import { createReadStream } from 'fs';
import { resolve, sep } from 'path';
import * as tar from 'tar';
@@ -9,41 +10,59 @@ import {
export const MAX_EXTRACTED_SIZE_BYTES = 500 * 1024 * 1024;
-export const extractTarballSecurely = async (
- tarballPath: string,
- targetDir: string,
-): Promise<void> => {
- let totalExtractedSize = 0;
- const resolvedTarget = resolve(targetDir) + sep;
+export const extractTarballSecurely = ({
+ tarballPath,
+ targetDir,
+}: {
+ tarballPath: string;
+ targetDir: string;
+}): Promise<void> =>
+ new Promise((resolvePromise, rejectPromise) => {
+ let totalExtractedSize = 0;
+ const resolvedTarget = resolve(targetDir) + sep;
+ const tarballStream = createReadStream(tarballPath);
- await tar.extract({
- file: tarballPath,
- cwd: targetDir,
- filter: (entryPath, entry) => {
- const resolvedEntry = resolve(targetDir, entryPath);
+ const unpackStream = tar.extract({
+ cwd: targetDir,
+ filter: (entryPath, entry) => {
+ if (totalExtractedSize > MAX_EXTRACTED_SIZE_BYTES) {
+ return false;
+ }
- if (!resolvedEntry.startsWith(resolvedTarget)) {
- return false;
- }
+ const resolvedEntry = resolve(targetDir, entryPath);
- if ('type' in entry) {
- const entryType = entry.type;
+ if (!resolvedEntry.startsWith(resolvedTarget)) {
+ return false;
+ }
- if (entryType === 'SymbolicLink' || entryType === 'Link') {
+ if (
+ 'type' in entry &&
+ (entry.type === 'SymbolicLink' || entry.type === 'Link')
+ ) {
return false;
}
- }
- totalExtractedSize += entry.size ?? 0;
+ totalExtractedSize += entry.size ?? 0;
+
+ if (totalExtractedSize > MAX_EXTRACTED_SIZE_BYTES) {
+ // Throwing here escapes tar's stream callback and kills the process
+ tarballStream.destroy();
+ rejectPromise(
+ new ApplicationException(
+ `Extracted size exceeds ${MAX_EXTRACTED_SIZE_BYTES} bytes`,
+ ApplicationExceptionCode.TARBALL_EXTRACTION_FAILED,
+ ),
+ );
+
+ return false;
+ }
- if (totalExtractedSize > MAX_EXTRACTED_SIZE_BYTES) {
- throw new ApplicationException(
- `Extracted size exceeds ${MAX_EXTRACTED_SIZE_BYTES} bytes`,
- ApplicationExceptionCode.TARBALL_EXTRACTION_FAILED,
- );
- }
+ return true;
+ },
+ });
- return true;
- },
+ tarballStream.on('error', rejectPromise);
+ unpackStream.on('error', rejectPromise);
+ unpackStream.on('close', () => resolvePromise());
+ tarballStream.pipe(unpackStream);
});
-};
diff --git a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-tarball.service.ts b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-tarball.service.ts
index 659f0c6e6bb..27c40fcc57f 100644
--- a/packages/twenty-server/src/engine/core-modules/application/application-registration/application-tarball.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/application/application-registration/application-tarball.service.ts
@@ -446,7 +446,7 @@ export class ApplicationTarballService {
const extractDir = join(tempDir, 'extracted');
await fs.mkdir(extractDir, { recursive: true });
- await extractTarballSecurely(tarballPath, extractDir);
+ await extractTarballSecurely({ tarballPath, targetDir: extractDir });
const contentDir = await resolvePackageContentDir(extractDir);