Skip to content

fix: tolerate malformed bundled entry names when listing tarball contents #10074

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

Open
ManoharPaturi wants to merge 1 commit into
base: latest
Choose a base branch
from
Open

fix: tolerate malformed bundled entry names when listing tarball contents #10074

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 7 additions & 2 deletions lib/utils/tar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,13 @@ const getContents = async (manifest, tarball) => {
totalEntrySize += entry.size
const p = entry.path
if (p.startsWith('package/node_modules/') && p !== 'package/node_modules/') {
const name = p.match(/^package\/node_modules\/((?:@[^/]+\/)?[^/]+)/)[1]
bundled.add(name)
// the entry path comes from the tarball, which for a registry or
// staged tarball is not something npm built, so a malformed name
// (for example a doubled separator) must not crash the listing
const bundledName = p.match(/^package\/node_modules\/((?:@[^/]+\/)?[^/]+)/)
if (bundledName) {
bundled.add(bundledName[1])
}
}
files.push({
path: entry.path.replace(/^package\//, ''),
Expand Down
47 changes: 47 additions & 0 deletions test/lib/utils/tar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,53 @@ t.test('should getContents of a tarball with a node_modules directory included',
t.end()
})

t.test('should getContents of a tarball with a malformed bundled entry name', async (t) => {
// tarballs on the registry or staging endpoint are not built by npm, so an
// entry under package/node_modules/ can carry a path the bundled name regex
// does not match. This helper writes raw tar entries because the filesystem
// collapses doubled separators and the tar package normalizes entry paths.
const craftEntry = (name, content) => {
const header = Buffer.alloc(512)
header.write(name.slice(0, 100), 0, 100, 'utf8')
header.write('0000644\0', 100, 8, 'ascii')
header.write('0000000\0', 108, 8, 'ascii')
header.write('0000000\0', 116, 8, 'ascii')
header.write(content.length.toString(8).padStart(7, '0') + '\0', 124, 8, 'ascii')
header.write('0000000\0', 136, 8, 'ascii')
header.write(' ', 148, 8, 'ascii')
header.write('0', 156, 1, 'ascii')
header.write('ustar\0', 257, 6, 'ascii')
header.write('00', 263, 2, 'ascii')
let sum = 0
for (const byte of header) {
sum += byte
}
header.write(sum.toString(8).padStart(6, '0') + '\0 ', 148, 8, 'ascii')
const data = Buffer.alloc(Math.ceil(content.length / 512) * 512)
data.write(content, 0, 'utf8')
return Buffer.concat([header, data])
}
const craftTarball = (entries) =>
Buffer.concat([...entries, Buffer.alloc(1024)])

const tarball = craftTarball([
craftEntry('package/package.json', '{"name":"evil","version":"1.0.0"}'),
craftEntry('package/node_modules//evil', 'abc'),
])

const tarballContents = await getContents({
name: 'evil',
version: '1.0.0',
}, tarball)

t.strictSame(tarballContents.bundled, [], 'malformed bundled entry is skipped')
t.equal(tarballContents.entryCount, 2, 'both entries are counted')
t.strictSame(tarballContents.files.map(f => f.path), [
'node_modules//evil',
'package.json',
])
})

t.test('should log byte sizes correctly', async (t) => {
const cases = [
[0, '0 B', '0B'],
Expand Down