Skip to content

Commit 801112a

Browse files
committed
zlib: validate pledgedSrcSize as a safe integer
pledgedSrcSize represents an exact byte count. Reject values that are not non-negative safe integers instead of silently ignoring or coercing them through IntegerValue(). Apply the same validation to zlib/iter and retain a native validation check for internal callers. Signed-off-by: Archkon <180910180+Archkon@users.noreply.github.com>
1 parent 2deb0a1 commit 801112a

6 files changed

Lines changed: 65 additions & 26 deletions

File tree

doc/api/zlib.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -784,8 +784,9 @@ const stream = zlib.createZstdCompress({
784784
#### Pledged Source Size
785785

786786
It's possible to specify the expected total size of the uncompressed input via
787-
`opts.pledgedSrcSize`. If the size doesn't match at the end of the input,
788-
compression will fail with the code `ZSTD_error_srcSize_wrong`.
787+
`opts.pledgedSrcSize`, which must be a non-negative safe integer. If the size
788+
doesn't match at the end of the input, compression will fail with the code
789+
`ZSTD_error_srcSize_wrong`.
789790

790791
#### Decompressor options
791792

@@ -1927,7 +1928,8 @@ added: v25.9.0
19271928
`ZSTD_btultra2`.
19281929
See the [Zstd compressor options][] in the zlib documentation for the
19291930
full list.
1930-
* `pledgedSrcSize` {number} Expected uncompressed size (optional hint).
1931+
* `pledgedSrcSize` {number} Expected uncompressed size as a non-negative safe
1932+
integer (optional hint).
19311933
* `dictionary` {Buffer|TypedArray|DataView}
19321934
* Returns: {Object} A stateful transform.
19331935

lib/internal/streams/iter/transform.js

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -257,16 +257,6 @@ function createZstdHandle(mode, options, processCallback, onError) {
257257
validateParams(options.params, maxParam, ERR_ZSTD_INVALID_PARAM);
258258

259259
const pledgedSrcSize = options.pledgedSrcSize;
260-
if (pledgedSrcSize !== undefined) {
261-
if (typeof pledgedSrcSize !== 'number' || NumberIsNaN(pledgedSrcSize)) {
262-
throw new ERR_INVALID_ARG_TYPE('options.pledgedSrcSize', 'number',
263-
pledgedSrcSize);
264-
}
265-
if (pledgedSrcSize < 0) {
266-
throw new ERR_OUT_OF_RANGE('options.pledgedSrcSize', '>= 0',
267-
pledgedSrcSize);
268-
}
269-
}
270260

271261
const handle = isCompress ?
272262
new binding.ZstdCompress() : new binding.ZstdDecompress();

lib/zlib.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -939,7 +939,7 @@ class Zstd extends ZlibBase {
939939
const handle = mode === ZSTD_COMPRESS ?
940940
new binding.ZstdCompress() : new binding.ZstdDecompress();
941941

942-
const pledgedSrcSize = opts?.pledgedSrcSize ?? undefined;
942+
const pledgedSrcSize = opts?.pledgedSrcSize;
943943

944944
const writeState = new Uint32Array(2);
945945

src/node_zlib.cc

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -941,9 +941,6 @@ class ZstdStream final : public CompressionStream<CompressionContext> {
941941
}
942942

943943
static void Init(const FunctionCallbackInfo<Value>& args) {
944-
Environment* env = Environment::GetCurrent(args);
945-
Local<Context> context = env->context();
946-
947944
CHECK((args.Length() == 4 || args.Length() == 5) &&
948945
"init(params, pledgedSrcSize, writeResult, writeCallback[, "
949946
"dictionary])");
@@ -960,19 +957,24 @@ class ZstdStream final : public CompressionStream<CompressionContext> {
960957
wrap->InitStream(write_result, write_js_callback);
961958

962959
uint64_t pledged_src_size = ZSTD_CONTENTSIZE_UNKNOWN;
963-
if (args[1]->IsNumber()) {
964-
int64_t signed_pledged_src_size;
965-
if (!args[1]->IntegerValue(context).To(&signed_pledged_src_size)) {
966-
THROW_ERR_INVALID_ARG_VALUE(wrap->env(),
967-
"pledgedSrcSize should be an integer");
960+
if (!args[1]->IsUndefined()) {
961+
if (!args[1]->IsNumber()) {
962+
THROW_ERR_INVALID_ARG_TYPE(wrap->env(),
963+
"pledgedSrcSize must be a number");
964+
return;
965+
}
966+
if (!IsSafeJsInt(args[1])) {
967+
THROW_ERR_OUT_OF_RANGE(wrap->env(),
968+
"pledgedSrcSize must be a safe integer");
968969
return;
969970
}
971+
const int64_t signed_pledged_src_size = args[1].As<Integer>()->Value();
970972
if (signed_pledged_src_size < 0) {
971-
THROW_ERR_INVALID_ARG_VALUE(wrap->env(),
972-
"pledgedSrcSize may not be negative");
973+
THROW_ERR_OUT_OF_RANGE(wrap->env(),
974+
"pledgedSrcSize must be non-negative");
973975
return;
974976
}
975-
pledged_src_size = signed_pledged_src_size;
977+
pledged_src_size = static_cast<uint64_t>(signed_pledged_src_size);
976978
}
977979

978980
AllocScope alloc_scope(wrap);

test/parallel/test-stream-iter-validation.js

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,16 @@ async function testAsyncValidation() {
352352

353353
// Zstd pledgedSrcSize
354354
await assert.rejects(consume(compressZstd({ pledgedSrcSize: 'bad' })), TYPE);
355-
await assert.rejects(consume(compressZstd({ pledgedSrcSize: -1 })), RANGE);
355+
for (const pledgedSrcSize of [
356+
NaN,
357+
Infinity,
358+
-Infinity,
359+
1.9,
360+
-1,
361+
Number.MAX_SAFE_INTEGER + 1,
362+
]) {
363+
await assert.rejects(consume(compressZstd({ pledgedSrcSize })), RANGE);
364+
}
356365
}
357366

358367
// =============================================================================

test/parallel/test-zlib-zstd-pledged-src-size.js

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,39 @@ compressWithPledgedSrcSize({ pledgedSrcSize: 42, actualSrcSize: 0 });
3535
compressWithPledgedSrcSize({ pledgedSrcSize: 42, actualSrcSize: 13 });
3636

3737
compressWithPledgedSrcSize({ pledgedSrcSize: 42, actualSrcSize: 42 });
38+
39+
function assertInvalidPledgedSrcSize(pledgedSrcSize, expected) {
40+
assert.throws(
41+
() => zlib.createZstdCompress({ pledgedSrcSize }),
42+
expected,
43+
);
44+
assert.throws(
45+
() => zlib.zstdCompressSync('', { pledgedSrcSize }),
46+
expected,
47+
);
48+
}
49+
50+
for (const pledgedSrcSize of ['1', null]) {
51+
assertInvalidPledgedSrcSize(pledgedSrcSize, {
52+
name: 'TypeError',
53+
code: 'ERR_INVALID_ARG_TYPE',
54+
});
55+
}
56+
57+
for (const pledgedSrcSize of [
58+
NaN,
59+
Infinity,
60+
-Infinity,
61+
1.9,
62+
-1,
63+
Number.MAX_SAFE_INTEGER + 1,
64+
]) {
65+
assertInvalidPledgedSrcSize(pledgedSrcSize, {
66+
name: 'RangeError',
67+
code: 'ERR_OUT_OF_RANGE',
68+
});
69+
}
70+
71+
zlib.createZstdCompress({
72+
pledgedSrcSize: Number.MAX_SAFE_INTEGER,
73+
}).destroy();

0 commit comments

Comments
 (0)