Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@
"check:fix": "vp check --fix"
},
"dependencies": {
"form-data": "^4.0.5",
"formstream": "^1.5.2",
"form-data": "^4.0.6",
"formstream": "^1.5.3",
"mime-types": "^2.1.35",
"qs": "^6.15.0",
"type-fest": "^4.41.0",
Expand Down
12 changes: 6 additions & 6 deletions pnpm-lock.yaml

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

1 change: 1 addition & 0 deletions pnpm-workspace.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ minimumReleaseAgeExclude:
- '@oxlint/*'
- oxfmt@0.70.0
- oxlint@1.85.0
- formstream@1.5.3
overrides:
vite@*: 'catalog:'
vitest@*: 'catalog:'
Expand Down
8 changes: 5 additions & 3 deletions src/FormData.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,12 @@ export class FormData extends _FormData {
}

if (filename) {
// https://datatracker.ietf.org/doc/html/rfc6266#section-4.1
// support non-ascii filename
contentDisposition = 'filename="' + filename + '"';
// WHATWG multipart encoding escapes only CR, LF, and double quotes in filenames.
// https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#multipart-form-data
const escapedFilename = filename.replace(/\r/g, '%0D').replace(/\n/g, '%0A').replace(/"/g, '%22');
contentDisposition = 'filename="' + escapedFilename + '"';
if (NON_ASCII_RE.test(filename)) {
// Preserve legacy filename* support for compatibility, although RFC 7578 forbids it in multipart uploads.
contentDisposition += "; filename*=UTF-8''" + encodeURIComponent(filename);
}
}
Expand Down
33 changes: 33 additions & 0 deletions test/formData.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import { strict as assert } from 'node:assert';

import { describe, it } from 'vite-plus/test';

import { WebFormData } from '../src/index.js';

describe('formData.test.ts', () => {
it.each([
['plain.txt', 'filename="plain.txt"'],
['a"b".txt', 'filename="a%22b%22.txt"'],
['a\rb\r.txt', 'filename="a%0Db%0D.txt"'],
['a\nb\n.txt', 'filename="a%0Ab%0A.txt"'],
['a\r\nb.txt', 'filename="a%0D%0Ab.txt"'],
['a%22.txt', 'filename="a%22.txt"'],
["a b';=%.txt", 'filename="a b\';=%.txt"'],
['中文.txt', 'filename="中文.txt"; filename*=UTF-8\'\'%E4%B8%AD%E6%96%87.txt'],
['中"\r\n.txt', 'filename="中%22%0D%0A.txt"; filename*=UTF-8\'\'%E4%B8%AD%22%0D%0A.txt'],
])('should safely serialize filename %j', (filename, disposition) => {
const form = new WebFormData();
form.append('file', Buffer.from('data'), { filename, contentType: 'text/plain' });
assert.equal(
form.getBuffer().toString(),
`--${form.getBoundary()}\r\nContent-Disposition: form-data; name="file"; ${disposition}\r\n` +
`Content-Type: text/plain\r\n\r\ndata\r\n--${form.getBoundary()}--\r\n`,
);
});

it('should escape a custom filepath after normalization', () => {
const form = new WebFormData();
form.append('file', Buffer.from('data'), { filepath: 'folder/a"\r\n.txt' });
assert.ok(form.getBuffer().toString().includes('filename="folder/a%22%0D%0A.txt"\r\n'));
});
});
42 changes: 42 additions & 0 deletions test/options.files.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -322,4 +322,46 @@ describe('options.files.test.ts', () => {
assert.equal(response.data.form.hello, 'hello world,😄😓');
assert.equal(response.data.form.foo, 'bar');
});

it.each(['buffer', 'readable', 'stream path'])('should prevent filename header injection from %s', async (source) => {
const filename = 'evil.txt"\r\nX-Injected: smuggled\r\nContent-Disposition: form-data; name="ghost';
const escaped = 'evil.txt%22%0D%0AX-Injected: smuggled%0D%0AContent-Disposition: form-data; name=%22ghost';
const field = source === 'stream path' ? 'file' : escaped;
const makeFiles = () => {
if (source === 'stream path') {
return Object.assign(Readable.from([Buffer.from('data')]), { path: filename });
}
return {
[filename]: source === 'buffer' ? Buffer.from('data') : Readable.from([Buffer.from('data')]),
};
};

const raw = await urllib.request(`${_url}raw`, { files: makeFiles(), dataType: 'text' });
assert.equal(raw.status, 200);
assert.ok(raw.data.includes(`Content-Disposition: form-data; name="${field}"; filename="${escaped}"\r\n`));
assert.doesNotMatch(raw.data, /\r\nX-Injected:/);
assert.equal(raw.data.match(/\r\nContent-Disposition:/g)?.length, 1);

const parsed = await urllib.request(`${_url}multipart`, {
files: makeFiles(),
data: { role: 'user' },
dataType: 'json',
});
assert.equal(parsed.status, 200);
assert.deepEqual(Object.keys(parsed.data.files), [field]);
assert.equal(parsed.data.files[field].filename, escaped);
assert.equal(parsed.data.files[field].size, 4);
assert.deepEqual(parsed.data.form, { role: 'user' });
});

it('should escape normal multipart field names', async () => {
const response = await urllib.request(`${_url}raw`, {
files: Buffer.from('data'),
data: { 'field"\r\nX-Injected: value': 'unchanged\r\nvalue' },
dataType: 'text',
});
assert.ok(response.data.includes('name="field%22%0D%0AX-Injected: value"\r\n'));
assert.ok(response.data.includes('\r\n\r\nunchanged\r\nvalue\r\n'));
assert.doesNotMatch(response.data, /\r\nX-Injected:/);
});
});
Loading