From 3a68d56b9efa3328a1aef020d538595ae3395ebe Mon Sep 17 00:00:00 2001 From: MK Date: Sat, 14 Nov 2026 10:50:36 +0800 Subject: [PATCH 1/3] fix: escape multipart filenames and field names --- lib/formstream.js | 22 +++++++ lib/urllib.js | 2 +- test/multipart-escaping.test.js | 113 ++++++++++++++++++++++++++++++++ 3 files changed, 136 insertions(+), 1 deletion(-) create mode 100644 lib/formstream.js create mode 100644 test/multipart-escaping.test.js diff --git a/lib/formstream.js b/lib/formstream.js new file mode 100644 index 00000000..411e4047 --- /dev/null +++ b/lib/formstream.js @@ -0,0 +1,22 @@ +'use strict'; + +var inherits = require('util').inherits; +var FormStream = require('formstream'); + +module.exports = SafeFormStream; + +function SafeFormStream() { + FormStream.call(this); +} + +inherits(SafeFormStream, FormStream); + +SafeFormStream.prototype._leading = function(disposition, type) { + var escaped = {}; + for (var name in disposition) { + // WHATWG multipart encoding escapes only CR, LF, and double quotes. + // https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#multipart-form-data + escaped[name] = String(disposition[name]).replace(/\r/g, '%0D').replace(/\n/g, '%0A').replace(/"/g, '%22'); + } + return FormStream.prototype._leading.call(this, escaped, type); +}; diff --git a/lib/urllib.js b/lib/urllib.js index 554d9d73..446b366f 100644 --- a/lib/urllib.js +++ b/lib/urllib.js @@ -20,7 +20,7 @@ var contentTypeParser = require('content-type'); var first = require('ee-first'); var pump = require('pump'); var utility = require('utility'); -var FormStream = require('formstream'); +var FormStream = require('./formstream'); var detectProxyAgent = require('./detect_proxy_agent'); var _Promise; diff --git a/test/multipart-escaping.test.js b/test/multipart-escaping.test.js new file mode 100644 index 00000000..820ce54f --- /dev/null +++ b/test/multipart-escaping.test.js @@ -0,0 +1,113 @@ +'use strict'; + +var assert = require('assert'); +var http = require('http'); +var fs = require('fs'); +var os = require('os'); +var path = require('path'); +var PassThrough = require('stream').PassThrough; +var urllib = require('..'); + +describe('test/multipart-escaping.test.js', function() { + var server; + var url; + var filename = 'evil.txt"\r\nX-Injected: smuggled\r\nContent-Disposition: form-data; name="ghost'; + var escaped = 'evil.txt%22%0D%0AX-Injected: smuggled%0D%0AContent-Disposition: form-data; name=%22ghost'; + + before(function(done) { + server = http.createServer(function(req, res) { + req.pipe(res); + }); + server.listen(0, '127.0.0.1', function() { + url = 'http://127.0.0.1:' + server.address().port; + done(); + }); + }); + + after(function(done) { + server.close(done); + }); + + function check(options, expected, done) { + options.dataType = 'text'; + options.headers = { connection: 'close' }; + urllib.request(url, options, function(err, body, res) { + if (err) { + return done(err); + } + try { + assert.strictEqual(res.status, 200); + assert(body.indexOf(expected) !== -1, JSON.stringify(body)); + assert.strictEqual(body.indexOf('\r\nX-Injected:'), -1); + assert.strictEqual((body.match(/\r\nContent-Disposition:/g) || []).length, options.data ? 2 : 1); + assert(body.indexOf('\r\n\r\ndata\r\n') !== -1); + done(); + } catch (error) { + done(error); + } + }); + } + + it('escapes filenames from stream paths', function(done) { + var stream = new PassThrough(); + stream.path = filename; + stream.end('data'); + check({ files: stream }, 'name="file"; filename="' + escaped + '"\r\n', done); + }); + + [ 'buffer', 'stream', 'file' ].forEach(function(source) { + it('escapes file field names for ' + source, function(done) { + var file = Buffer.from('data'); + if (source === 'stream') { + file = new PassThrough(); + file.end('data'); + } else if (source === 'file') { + file = path.join(os.tmpdir(), 'urllib-multipart-' + process.pid + '.txt'); + fs.writeFileSync(file, 'data'); + } + var files = {}; + files[filename] = file; + check({ files: files }, 'name="' + escaped + '"; filename="', function(err) { + if (source === 'file') { + fs.unlinkSync(file); + } + done(err); + }); + }); + }); + + it('escapes normal field names', function(done) { + var data = {}; + data[filename] = 'value'; + check({ files: Buffer.from('data'), data: data }, 'name="' + escaped + '"\r\n', done); + }); + + it('escapes a filesystem filename without changing the path used to read it', function(done) { + if (process.platform === 'win32') { + return this.skip(); + } + var directory = path.join(os.tmpdir(), 'urllib-multipart-path-' + process.pid); + var file = path.join(directory, filename); + fs.mkdirSync(directory); + fs.writeFileSync(file, 'data'); + check({ files: file }, 'name="file"; filename="' + escaped + '"\r\n', function(err) { + fs.unlinkSync(file); + fs.rmdirSync(directory); + done(err); + }); + }); + + [ + [ 'a"b".txt', 'a%22b%22.txt' ], + [ 'a\rb\r.txt', 'a%0Db%0D.txt' ], + [ 'a\nb\n.txt', 'a%0Ab%0A.txt' ], + [ "中文 a';=%.txt", "中文 a';=%.txt" ], + ].forEach(function(pair) { + it('uses standard filename escaping for ' + JSON.stringify(pair[0]), function(done) { + var stream = new PassThrough(); + stream.path = pair[0]; + stream.end('data'); + check({ files: stream }, 'filename="' + pair[1] + '"\r\n', done); + }); + }); +}); From a9a88836df74a3e8a677b8f2c9abf14c9bf55b5b Mon Sep 17 00:00:00 2001 From: MK Date: Sat, 14 Nov 2026 12:08:59 +0800 Subject: [PATCH 2/3] fix: require formstream 1.5.3 for safe multipart headers --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 94441cc7..2e28d783 100644 --- a/package.json +++ b/package.json @@ -40,7 +40,7 @@ "default-user-agent": "^1.0.0", "digest-header": "^1.0.0", "ee-first": "~1.1.1", - "formstream": "^1.1.0", + "formstream": "^1.5.3", "humanize-ms": "^1.2.0", "iconv-lite": "^0.6.3", "pump": "^3.0.0", From ce1ad1b545a432261a0562576fc02e6d35efd837 Mon Sep 17 00:00:00 2001 From: MK Date: Sat, 14 Nov 2026 12:11:25 +0800 Subject: [PATCH 3/3] refactor: rely on formstream header escaping --- lib/formstream.js | 22 ---------------------- lib/urllib.js | 2 +- 2 files changed, 1 insertion(+), 23 deletions(-) delete mode 100644 lib/formstream.js diff --git a/lib/formstream.js b/lib/formstream.js deleted file mode 100644 index 411e4047..00000000 --- a/lib/formstream.js +++ /dev/null @@ -1,22 +0,0 @@ -'use strict'; - -var inherits = require('util').inherits; -var FormStream = require('formstream'); - -module.exports = SafeFormStream; - -function SafeFormStream() { - FormStream.call(this); -} - -inherits(SafeFormStream, FormStream); - -SafeFormStream.prototype._leading = function(disposition, type) { - var escaped = {}; - for (var name in disposition) { - // WHATWG multipart encoding escapes only CR, LF, and double quotes. - // https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#multipart-form-data - escaped[name] = String(disposition[name]).replace(/\r/g, '%0D').replace(/\n/g, '%0A').replace(/"/g, '%22'); - } - return FormStream.prototype._leading.call(this, escaped, type); -}; diff --git a/lib/urllib.js b/lib/urllib.js index 446b366f..554d9d73 100644 --- a/lib/urllib.js +++ b/lib/urllib.js @@ -20,7 +20,7 @@ var contentTypeParser = require('content-type'); var first = require('ee-first'); var pump = require('pump'); var utility = require('utility'); -var FormStream = require('./formstream'); +var FormStream = require('formstream'); var detectProxyAgent = require('./detect_proxy_agent'); var _Promise;