addons-scanner-utils 2.5.0 → 4.0.0

package/dist/functions.js

@@ -20,13 +20,14 @@ const express_1 = __importDefault(require("express"));
 const body_parser_1 = __importDefault(require("body-parser"));
 const download_1 = __importDefault(require("download"));
 const safe_compare_1 = __importDefault(require("safe-compare"));
-exports.createApiError = ({ message, extraInfo, status = 500, }) => {
+const createApiError = ({ message, extraInfo, status = 500, }) => {
     const error = new Error(message);
     error.status = status;
     error.extraInfo = extraInfo;
     return error;
 };
-exports.createExpressApp = ({ _console = console, _download = download_1.default, _process = process, _unlinkFile = fs_1.default.promises.unlink, apiKeyEnvVarName = 'LAMBDA_API_KEY', requiredApiKeyParam = 'api_key', requiredDownloadUrlParam = 'download_url', tmpDir = os_1.default.tmpdir(), xpiFilename = 'input.xpi', } = {}) => (handler) => {
+exports.createApiError = createApiError;
+const createExpressApp = ({ _console = console, _download = download_1.default, _process = process, _unlinkFile = fs_1.default.promises.unlink, apiKeyEnvVarName = 'LAMBDA_API_KEY', requiredApiKeyParam = 'api_key', requiredDownloadUrlParam = 'download_url', tmpDir = os_1.default.tmpdir(), xpiFilename = 'input.xpi', } = {}) => (handler) => {
     const app = express_1.default();
     const allowedOrigin = _process.env.ALLOWED_ORIGIN || null;
     if (!allowedOrigin) {
@@ -126,3 +127,4 @@ exports.createExpressApp = ({ _console = console, _download = download_1.default
     });
     return app;
 };
+exports.createExpressApp = createExpressApp;

package/dist/io/base.d.ts

@@ -4,7 +4,7 @@ import { Stderr } from '../stdio';
 declare type ScanFileFunction = (_path: string, isDirectory: boolean) => boolean;
 declare type Files = Record<string, unknown>;
 export declare type IOBaseConstructorParams = {
-    filepath: string;
+    filePath: string;
     stderr: Stderr;
 };
 export declare class IOBase {
@@ -14,7 +14,7 @@ export declare class IOBase {
     entries: string[];
     maxSizeBytes: number;
     shouldScanFile: ScanFileFunction;
-    constructor({ filepath, stderr }: IOBaseConstructorParams);
+    constructor({ filePath, stderr }: IOBaseConstructorParams);
     setScanFileCallback(callback: ScanFileFunction): void;
     getFile(path: string, fileStreamType?: 'stream' | 'string' | 'chunk'): Promise<string> | Promise<Buffer> | Promise<Readable>;
     getFilesByExt(...extensions: string[]): Promise<string[]>;

package/dist/io/base.js

@@ -16,8 +16,8 @@ const const_1 = require("./const");
  * Base class for io operations for both an Xpi or a directory.
  */
 class IOBase {
-    constructor({ filepath, stderr }) {
-        this.path = filepath;
+    constructor({ filePath, stderr }) {
+        this.path = filePath;
         this.stderr = stderr;
         this.files = {};
         this.entries = [];

package/dist/io/crx.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="node" />
+import defaultFs from 'fs';
+import yauzl, { ZipFile } from 'yauzl';
+import { IOBaseConstructorParams } from './base';
+import { Xpi } from './xpi';
+export declare function defaultParseCRX(buf: Buffer): Buffer;
+declare type CrxConstructorParams = IOBaseConstructorParams & {
+    fs?: typeof defaultFs;
+    parseCRX?: typeof defaultParseCRX;
+    zipLib?: typeof yauzl;
+};
+export declare class Crx extends Xpi {
+    fs: typeof defaultFs;
+    parseCRX: typeof defaultParseCRX;
+    constructor({ filePath, stderr, fs, parseCRX, zipLib, }: CrxConstructorParams);
+    open(): Promise<ZipFile>;
+}
+export {};

package/dist/io/crx.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Crx = exports.defaultParseCRX = void 0;
+const fs_1 = __importDefault(require("fs"));
+const yauzl_1 = __importDefault(require("yauzl"));
+const xpi_1 = require("./xpi");
+function defaultParseCRX(buf) {
+    if (buf.readUInt32BE(0) !== 0x43723234) {
+        throw new Error('Invalid header: Does not start with Cr24.');
+    }
+    const version = buf.readUInt32LE(4);
+    if (version === 2) {
+        const publicKeyLength = buf.readUInt32LE(8);
+        const signatureLength = buf.readUInt32LE(12);
+        // 16 = Magic number (4), CRX format version (4), lengths (2x4)
+        return buf.slice(16 + publicKeyLength + signatureLength);
+    }
+    if (version === 3) {
+        const crx3HeaderLength = buf.readUInt32LE(8);
+        // 12 = Magic number (4), CRX format version (4), header length (4)
+        return buf.slice(12 + crx3HeaderLength);
+    }
+    throw new Error('Unexpected crx format version number.');
+}
+exports.defaultParseCRX = defaultParseCRX;
+/*
+ * A CRX file is just a ZIP file (eg an XPI) with some extra header
+ * information. We handle opening the file with a CRX parser, then treat it
+ * like an XPI after that.
+ */
+class Crx extends xpi_1.Xpi {
+    constructor({ filePath, stderr, fs = fs_1.default, parseCRX = defaultParseCRX, zipLib = yauzl_1.default, }) {
+        super({ filePath, stderr, zipLib, autoClose: true });
+        this.fs = fs;
+        this.parseCRX = parseCRX;
+    }
+    open() {
+        return new Promise((resolve, reject) => {
+            this.fs.readFile(this.path, (err, buf) => {
+                if (err) {
+                    reject(err);
+                    return;
+                }
+                // Parse out the CRX header data from the actual ZIP contents.
+                let zipBuffer;
+                try {
+                    zipBuffer = this.parseCRX(buf);
+                    this.stderr.debug('obtained zip data from CRX file');
+                }
+                catch (err2) {
+                    reject(err2);
+                    return;
+                }
+                this.zipLib.fromBuffer(zipBuffer, (err3, zipfile) => {
+                    if (err3) {
+                        reject(err3);
+                        return;
+                    }
+                    resolve(zipfile);
+                });
+            });
+        });
+    }
+}
+exports.Crx = Crx;

package/dist/io/directory.d.ts

@@ -10,7 +10,7 @@ declare type Files = {
 declare type DirectoryConstructorParams = IOBaseConstructorParams;
 export declare class Directory extends IOBase {
     files: Files;
-    constructor({ filepath, stderr }: DirectoryConstructorParams);
+    constructor({ filePath, stderr }: DirectoryConstructorParams);
     getFiles(_walkPromise?: typeof walkPromise): Promise<Files>;
     getPath(_path: string): Promise<string>;
     getFileAsStream(_path: string, { encoding }?: {

package/dist/io/directory.js

@@ -21,8 +21,8 @@ const common_tags_1 = require("common-tags");
 const base_1 = require("./base");
 const utils_1 = require("./utils");
 class Directory extends base_1.IOBase {
-    constructor({ filepath, stderr }) {
-        super({ filepath, stderr });
+    constructor({ filePath, stderr }) {
+        super({ filePath, stderr });
         this.files = {};
     }
     getFiles(_walkPromise = utils_1.walkPromise) {

package/dist/io/index.d.ts

@@ -1,4 +1,5 @@
 export * from './const';
+export * from './crx';
 export * from './directory';
 export * from './utils';
 export * from './xpi';

package/dist/io/index.js

@@ -11,6 +11,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./const"), exports);
+__exportStar(require("./crx"), exports);
 __exportStar(require("./directory"), exports);
 __exportStar(require("./utils"), exports);
 __exportStar(require("./xpi"), exports);

package/dist/io/utils.d.ts

@@ -13,6 +13,6 @@ export declare function walkPromise(curPath: string, { shouldIncludePath, stderr
         size: number;
     };
 }>;
-export declare function checkFileExists(filepath: string, { _lstat }?: {
+export declare function checkFileExists(filePath: string, { _lstat }?: {
     _lstat?: typeof fs.lstat.__promisify__ | undefined;
 }): Promise<fs.Stats>;

package/dist/io/utils.js

@@ -51,11 +51,11 @@ function walkPromise(curPath, { shouldIncludePath = () => true, stderr }) {
     return walk(curPath);
 }
 exports.walkPromise = walkPromise;
-function checkFileExists(filepath, { _lstat = exports.lstat } = {}) {
+function checkFileExists(filePath, { _lstat = exports.lstat } = {}) {
     return __awaiter(this, void 0, void 0, function* () {
-        const invalidMessage = new Error(`Path "${filepath}" is not a file or directory or does not exist.`);
+        const invalidMessage = new Error(`Path "${filePath}" is not a file or directory or does not exist.`);
         try {
-            const stats = yield _lstat(filepath);
+            const stats = yield _lstat(filePath);
             if (stats.isFile() === true || stats.isDirectory() === true) {
                 return stats;
             }

package/dist/io/xpi.d.ts

@@ -14,7 +14,7 @@ export declare class Xpi extends IOBase {
     files: Files;
     zipLib: typeof yauzl;
     zipfile: ZipFile | undefined;
-    constructor({ autoClose, filepath, stderr, zipLib, }: XpiConstructorParams);
+    constructor({ autoClose, filePath, stderr, zipLib, }: XpiConstructorParams);
     open(): Promise<ZipFile>;
     handleEntry(entry: Entry, reject: (error: Error) => void): void;
     getFiles(_onEventsSubscribed?: () => void): Promise<Files>;

package/dist/io/xpi.js

@@ -28,8 +28,8 @@ const base_1 = require("./base");
  * feature, so we can disable it if needed.
  */
 class Xpi extends base_1.IOBase {
-    constructor({ autoClose = true, filepath, stderr, zipLib = yauzl_1.default, }) {
-        super({ filepath, stderr });
+    constructor({ autoClose = true, filePath, stderr, zipLib = yauzl_1.default, }) {
+        super({ filePath, stderr });
         this.files = {};
         this.autoClose = autoClose;
         this.zipLib = zipLib;

package/dist/stdio.js

@@ -6,7 +6,7 @@ exports.createInMemoryStdout = exports.createConsoleStdout = exports.createInMem
 // `verboseLevel` argument (and the number of `-v` passed to the CLI).
 //
 // By default, only errors are shown.
-exports.createConsoleStderr = ({ _console = console, programName, verboseLevel = 0, }) => {
+const createConsoleStderr = ({ _console = console, programName, verboseLevel = 0, }) => {
     const logWithPrefix = (message) => {
         _console.error(`${programName}: ${message}`);
     };
@@ -29,7 +29,8 @@ exports.createConsoleStderr = ({ _console = console, programName, verboseLevel =
     };
     return stderr;
 };
-exports.createInMemoryStderr = () => {
+exports.createConsoleStderr = createConsoleStderr;
+const createInMemoryStderr = () => {
     return {
         messages: {
             debug: [],
@@ -47,16 +48,18 @@ exports.createInMemoryStderr = () => {
         },
     };
 };
+exports.createInMemoryStderr = createInMemoryStderr;
 // `stdout` should be used for final outputs, and usually once at the end of
 // the command.
-exports.createConsoleStdout = ({ _console = console } = {}) => {
+const createConsoleStdout = ({ _console = console } = {}) => {
     return {
         write(message) {
             _console.log(message);
         },
     };
 };
-exports.createInMemoryStdout = () => {
+exports.createConsoleStdout = createConsoleStdout;
+const createInMemoryStdout = () => {
     return {
         output: '',
         write(message) {
@@ -64,3 +67,4 @@ exports.createInMemoryStdout = () => {
         },
     };
 };
+exports.createInMemoryStdout = createInMemoryStdout;

package/dist/test-helpers.d.ts

@@ -1,4 +1,5 @@
 import { Readable } from 'stream';
+import { ZipFile, RandomAccessReader } from 'yauzl';
 import { Stderr, Stdout } from './stdio';
 export declare const createFakeStdout: () => Stdout;
 export declare const createFakeStderr: () => Stderr;
@@ -10,3 +11,17 @@ export declare const createFakeFsStats: ({ isFile, isDirectory, }?: {
     isDirectory: () => boolean;
     isFile: () => boolean;
 };
+declare class FakeRandomAccessReader extends RandomAccessReader {
+}
+export declare const createFakeZipFile: ({ autoClose, centralDirectoryOffset, comment, decodeStrings, entryCount, fileSize, lazyEntries, reader, validateEntrySizes, }?: {
+    autoClose?: boolean | undefined;
+    centralDirectoryOffset?: number | undefined;
+    comment?: string | undefined;
+    decodeStrings?: boolean | undefined;
+    entryCount?: number | undefined;
+    fileSize?: number | undefined;
+    lazyEntries?: boolean | undefined;
+    reader?: FakeRandomAccessReader | undefined;
+    validateEntrySizes?: boolean | undefined;
+}) => ZipFile;
+export {};

package/dist/test-helpers.js

@@ -1,19 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createFakeFsStats = exports.readStringFromStream = exports.createFakeStderr = exports.createFakeStdout = void 0;
-exports.createFakeStdout = () => {
+exports.createFakeZipFile = exports.createFakeFsStats = exports.readStringFromStream = exports.createFakeStderr = exports.createFakeStdout = void 0;
+const yauzl_1 = require("yauzl");
+const createFakeStdout = () => {
     return {
         write: jest.fn(),
     };
 };
-exports.createFakeStderr = () => {
+exports.createFakeStdout = createFakeStdout;
+const createFakeStderr = () => {
     return {
         debug: jest.fn(),
         error: jest.fn(),
         info: jest.fn(),
     };
 };
-exports.readStringFromStream = (readStream, encoding) => {
+exports.createFakeStderr = createFakeStderr;
+const readStringFromStream = (readStream, encoding) => {
     return new Promise((resolve, reject) => {
         let content = '';
         readStream.on('readable', () => {
@@ -29,9 +32,23 @@ exports.readStringFromStream = (readStream, encoding) => {
         readStream.on('error', reject);
     });
 };
-exports.createFakeFsStats = ({ isFile = false, isDirectory = false, } = {}) => {
+exports.readStringFromStream = readStringFromStream;
+const createFakeFsStats = ({ isFile = false, isDirectory = false, } = {}) => {
     return {
         isDirectory: () => isDirectory,
         isFile: () => isFile,
     };
 };
+exports.createFakeFsStats = createFakeFsStats;
+class FakeRandomAccessReader extends yauzl_1.RandomAccessReader {
+}
+const createFakeZipFile = ({ autoClose = true, centralDirectoryOffset = 0, comment = '', decodeStrings = true, 
+// This is set to `1` to avoid an error with `RandomAccessReader.unref()`
+// because we are using a `FakeRandomAccessReader`
+entryCount = 1, fileSize = 0, 
+// This is set to `true` to avoid an error due to the ZipFile trying to
+// automatically load the entries (because `entryCount = 1` above).
+lazyEntries = true, reader = new FakeRandomAccessReader(), validateEntrySizes = true, } = {}) => {
+    return new yauzl_1.ZipFile(reader, centralDirectoryOffset, fileSize, entryCount, comment, autoClose, lazyEntries, decodeStrings, validateEntrySizes);
+};
+exports.createFakeZipFile = createFakeZipFile;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "addons-scanner-utils",
-  "version": "2.5.0",
+  "version": "4.0.0",
   "description": "Various addons related helpers to build CLIs.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,21 +10,24 @@
   "author": "Mozilla Add-ons Team",
   "license": "MPL-2.0",
   "dependencies": {
-    "@types/download": "6.2.4",
     "@types/yauzl": "2.9.1",
-    "body-parser": "1.19.0",
     "common-tags": "1.8.0",
-    "download": "8.0.0",
-    "express": "4.17.1",
     "first-chunk-stream": "3.0.0",
-    "safe-compare": "1.1.4",
     "strip-bom-stream": "4.0.0",
-    "upath": "1.2.0",
+    "upath": "2.0.1",
     "yauzl": "2.10.0"
   },
+  "peerDependencies": {
+    "@types/download": "6.2.4",
+    "body-parser": "1.19.0",
+    "download": "8.0.0",
+    "express": "4.17.1",
+    "safe-compare": "1.1.4"
+  },
   "devDependencies": {
     "@types/common-tags": "^1.8.0",
-    "@types/express": "4.17.7",
+    "@types/download": "6.2.4",
+    "@types/express": "4.17.9",
     "@types/jest": "^26.0.0",
     "@types/node": "^12.7.5",
     "@types/safe-compare": "^1.1.0",
@@ -32,17 +35,21 @@
     "@types/supertest": "^2.0.8",
     "@typescript-eslint/eslint-plugin": "^4.0.0",
     "@typescript-eslint/parser": "^4.0.0",
+    "body-parser": "1.19.0",
     "codecov": "^3.5.0",
+    "download": "8.0.0",
     "eslint": "^7.0.0",
     "eslint-config-amo": "^3.0.0",
     "eslint-config-prettier": "^6.3.0",
     "eslint-plugin-amo": "^1.10.2",
+    "express": "4.17.1",
     "jest": "^26.0.0",
-    "prettier": "2.1.1",
+    "prettier": "2.1.2",
     "pretty-quick": "^3.0.0",
     "rimraf": "^3.0.0",
+    "safe-compare": "1.1.4",
     "sinon": "^9.0.0",
-    "supertest": "^4.0.2",
+    "supertest": "^6.0.0",
     "ts-jest": "^26.0.0",
     "type-coverage": "^2.3.0",
     "typescript": "^4.0.0"