Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Add an INVALID_ZIPFILE lint error on zip file with invalid chars in filenames #3940

Merged
merged 2 commits into from
Oct 5, 2021
Merged

fix: Add an INVALID_ZIPFILE lint error on zip file with invalid chars in filenames #3940

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a1928bf
fix(deps): update dependency addons-scanner-utils to v5
renovate-bot Oct 4, 2021
226d028
fix: Add an INVALID_ZIPFILE lint error on zip file with invalid chars…
rpl Sep 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,11 +225,6 @@ <h2 id="package-layout" tabindex="-1">Package layout <a class="header-anchor" hr
<td>Flagged file extensions found</td>
</tr>
<tr>
<td><code>DUPLICATE_XPI_ENTRY</code></td>
<td>warning</td>
<td>Package contains duplicate entries</td>
</tr>
<tr>
<td><code>ALREADY_SIGNED</code></td>
<td>warning</td>
<td>Already signed</td>
Expand All @@ -240,9 +235,19 @@ <h2 id="package-layout" tabindex="-1">Package layout <a class="header-anchor" hr
<td>Firefox add-ons are not allowed to run coin miners.</td>
</tr>
<tr>
<td><code>DUPLICATE_XPI_ENTRY</code></td>
<td>error</td>
<td>Package contains duplicate entries.</td>
</tr>
<tr>
<td><code>INVALID_XPI_ENTRY</code></td>
<td>error</td>
<td>Package contains invalid entries (e.g. invalid characters in entries path name).</td>
</tr>
<tr>
<td><code>BAD_ZIPFILE</code></td>
<td>error</td>
<td>Bad zip file</td>
<td>Bad zip file.</td>
</tr>
<tr>
<td><code>FILE_TOO_LARGE</code></td>
Expand Down
23 changes: 12 additions & 11 deletions docs/rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,18 @@ Rules are sorted by severity.

## Package layout

| Message code | Severity | Description |
| -------------------------- | -------- | --------------------------------------------------- |
| `MOZILLA_COND_OF_USE` | notice | Mozilla conditions of use violation. |
| `FLAGGED_FILE_TYPE` | notice | (Binary) Flagged file type found. |
| `FLAGGED_FILE_EXTENSION` | warning | Flagged file extensions found |
| `DUPLICATE_XPI_ENTRY` | warning | Package contains duplicate entries |
| `ALREADY_SIGNED` | warning | Already signed |
| `COINMINER_USAGE_DETECTED` | warning | Firefox add-ons are not allowed to run coin miners. |
| `BAD_ZIPFILE` | error | Bad zip file |
| `FILE_TOO_LARGE` | error | File is too large to parse |
| `RESERVED_FILENAME` | error | Reserved filename detected. |
| Message code | Severity | Description |
| -------------------------- | -------- | -------------------------------------------------------------------------------- |
| `MOZILLA_COND_OF_USE` | notice | Mozilla conditions of use violation. |
| `FLAGGED_FILE_TYPE` | notice | (Binary) Flagged file type found. |
| `FLAGGED_FILE_EXTENSION` | warning | Flagged file extensions found |
| `ALREADY_SIGNED` | warning | Already signed |
| `COINMINER_USAGE_DETECTED` | warning | Firefox add-ons are not allowed to run coin miners. |
| `DUPLICATE_XPI_ENTRY` | error | Package contains duplicate entries. |
| `INVALID_XPI_ENTRY` | error | Package contains invalid entries (e.g. invalid characters in entries path name). |
| `BAD_ZIPFILE` | error | Bad zip file. |
| `FILE_TOO_LARGE` | error | File is too large to parse |
| `RESERVED_FILENAME` | error | Reserved filename detected. |

## Type detection

Expand Down
14 changes: 7 additions & 7 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
"dependencies": {
"@mdn/browser-compat-data": "4.0.5",
"addons-moz-compare": "1.2.0",
"addons-scanner-utils": "4.11.0",
"addons-scanner-utils": "5.0.0",
"ajv": "6.12.6",
"ajv-merge-patch": "4.1.0",
"chalk": "4.1.2",
Expand Down
37 changes: 33 additions & 4 deletions src/linter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ import chalk from 'chalk';
import Dispensary from 'dispensary';
import { oneLine } from 'common-tags';
import { lstat } from 'addons-scanner-utils/dist/io/utils';
import {
DuplicateZipEntryError,
InvalidZipFileError,
} from 'addons-scanner-utils/dist/errors';
import { Directory, Xpi, Crx } from 'addons-scanner-utils/dist/io';

import { terminalWidth } from 'cli';
Expand Down Expand Up @@ -98,19 +102,42 @@ export default class Linter {
}

handleError(err, _console = console) {
if (err.message.includes('DuplicateZipEntry')) {
// The zip files contains invalid entries (likely path names using invalid
// characters like '\\'), the linter can inspect the package but Firefox
// would fail to load it.
if (err instanceof InvalidZipFileError) {
this.collector.addError({
...messages.INVALID_XPI_ENTRY,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do wonder if we should rename the exception in addons-scanner-utils now :D

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly I was also tempted to propose you that, but in the end from the linter perspective the fact that the rule name doesn't exactly match the addons-scanner-utils error name is annoying but probably not "annoying enough" to justify releasing a new addons-scanner-utils version just to rename the error class.

message: err.message,
});
this.print(_console);
return true;
}

// The zip file contains multiple entries with the exact same file name.
if (err instanceof DuplicateZipEntryError) {
this.collector.addError(messages.DUPLICATE_XPI_ENTRY);
this.print(_console);
} else if (err.message.includes(constants.ZIP_LIB_CORRUPT_FILE_ERROR)) {
return true;
}

// The zip file fails to open successfully, the linter can't inspect it
// at all.
if (err.message.includes(constants.ZIP_LIB_CORRUPT_FILE_ERROR)) {
this.collector.addError(messages.BAD_ZIPFILE);
this.print(_console);
} else if (this.config.stack === true) {
return true;
}

if (this.config.stack === true) {
_console.error(err.stack);
} else {
_console.error(this.chalk.red(err.message || err));
}

this.closeIO();

return false;
}

print(_console = console) {
Expand Down Expand Up @@ -552,7 +579,9 @@ export default class Linter {
process.exit(exitCode);
}
} catch (err) {
this.handleError(err, deps._console);
if (this.handleError(err, deps._console)) {
return;
}
throw err;
}
}
Expand Down
17 changes: 17 additions & 0 deletions src/messages/layout.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,23 @@ export const DUPLICATE_XPI_ENTRY = {
and re-zipping your add-on package and try again.`),
};

export const INVALID_XPI_ENTRY = {
code: 'INVALID_XPI_ENTRY',
// `message` will be replaced with the `InvalidZipFileError` message
// got from the addons-scanner-utils dependency when we were reading
// the zip file entries (in particular this would be triggered by
// a zipfile entry using invalid characters, like '\' as a path
// separator, and the underlying yauzl error message follows the
// format:
// `invalid characters in fileName: nameOfTheInvalidZipFileEntry`
message: 'Invalid ZIP file entry',
description: i18n._(oneLine`The package is invalid. It may contain
entries using invalid characters, as an example using '\\' as a
path separator is not allowed in Firefox. Try to recreate your
add-on package (ZIP) and make sure all entries are using '/' as the
path separator.`),
};

export const BAD_ZIPFILE = {
code: 'BAD_ZIPFILE',
message: 'Corrupt ZIP file',
Expand Down
39 changes: 32 additions & 7 deletions tests/unit/test.linter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ import fs from 'fs';

import { oneLine } from 'common-tags';
import { Xpi } from 'addons-scanner-utils/dist/io';
import {
DuplicateZipEntryError,
InvalidZipFileError,
} from 'addons-scanner-utils/dist/errors';
import { createFakeStderr } from 'addons-scanner-utils/dist/test-helpers';

import Linter from 'linter';
Expand Down Expand Up @@ -137,9 +141,7 @@ describe('Linter', () => {
// Stub print to prevent output.
addonLinter.print = sinon.stub();
expect(addonLinter.collector.errors.length).toEqual(0);
await expect(addonLinter.scan()).rejects.toThrow(
constants.ZIP_LIB_CORRUPT_FILE_ERROR
);
await addonLinter.scan();
expect(addonLinter.collector.errors.length).toEqual(1);
expect(addonLinter.collector.errors[0].code).toEqual(
messages.BAD_ZIPFILE.code
Expand Down Expand Up @@ -329,7 +331,7 @@ describe('Linter', () => {
addonLinter.checkFileExists = fakeCheckFileExists;
addonLinter.collector.addError = sinon.stub();
addonLinter.print = sinon.stub();
const expectedError = new Error('DuplicateZipEntry the zip has dupes!');
const expectedError = new DuplicateZipEntryError('the zip has dupes!');
class FakeXpi extends FakeIOBase {
async getFiles() {
throw expectedError;
Expand All @@ -339,16 +341,39 @@ describe('Linter', () => {
return this.getMetadata();
}
}
await expect(addonLinter.scan({ _Xpi: FakeXpi })).rejects.toThrow(
expectedError
);
await addonLinter.scan({ _Xpi: FakeXpi });
sinon.assert.calledWith(
addonLinter.collector.addError,
messages.DUPLICATE_XPI_ENTRY
);
sinon.assert.calledOnce(addonLinter.print);
});

it('should call addError when Xpi rejects with InvalidZipFileError', async () => {
const addonLinter = new Linter({ _: ['bar'] });
addonLinter.checkFileExists = fakeCheckFileExists;
addonLinter.collector.addError = sinon.stub();
addonLinter.print = sinon.stub();
const expectedError = new InvalidZipFileError(
'invalid characters in fileName: fake\\file.txt'
);
class FakeXpi extends FakeIOBase {
async getFiles() {
throw expectedError;
}

getFilesByExt() {
return this.getMetadata();
}
}
await addonLinter.scan({ _Xpi: FakeXpi });
sinon.assert.calledWith(addonLinter.collector.addError, {
...messages.INVALID_XPI_ENTRY,
message: expectedError.message,
});
sinon.assert.calledOnce(addonLinter.print);
});

it('should throw if invalid type is passed to colorize', () => {
const addonLinter = new Linter({ _: ['bar'] });
expect(() => {
Expand Down