-
-
Notifications
You must be signed in to change notification settings - Fork 110
Fix heap buffer overflow in NDCELL decompression path #785
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.
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
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -48,19 +48,54 @@ int ndcell_forward(const uint8_t *input, uint8_t *output, int32_t length, uint8_ | |
| } | ||
| int typesize = cparams->typesize; | ||
|
|
||
| int8_t cell_shape = (int8_t) meta; | ||
| // `meta` is the cell side length and comes from the chunk header (uint8_t, | ||
| // 0..255). Interpret it as unsigned and reject 0: an (int8_t) cast would turn | ||
| // 128..255 into negative values and 0 would later divide by zero in | ||
| // `(blockshape[i] + cell_shape - 1) / cell_shape`. | ||
| int cell_shape = (int) meta; | ||
| if (cell_shape <= 0) { | ||
| free(shape); | ||
| free(chunkshape); | ||
| free(blockshape); | ||
| BLOSC_TRACE_ERROR("Invalid cell_shape %d", cell_shape); | ||
| return BLOSC2_ERROR_FAILURE; | ||
| } | ||
| const int cell_size = (int) pow(cell_shape, ndim); | ||
|
|
||
| int32_t blocksize = (int32_t) typesize; | ||
| if (typesize <= 0) { | ||
| free(shape); | ||
| free(chunkshape); | ||
| free(blockshape); | ||
| BLOSC_TRACE_ERROR("Invalid typesize %d", typesize); | ||
| return BLOSC2_ERROR_FAILURE; | ||
| } | ||
| // See ndcell_backward(): validate the b2nd block geometry in 64-bit so a | ||
| // crafted blockshape cannot wrap a 32-bit product back onto `length` and make | ||
| // the index arithmetic below read past the `length`-sized input buffer. | ||
| int64_t blocksize = (int64_t) typesize; | ||
| for (int i = 0; i < ndim; i++) { | ||
| if (blockshape[i] <= 0) { | ||
| free(shape); | ||
| free(chunkshape); | ||
| free(blockshape); | ||
| BLOSC_TRACE_ERROR("Invalid blockshape[%d] = %d", i, blockshape[i]); | ||
| return BLOSC2_ERROR_FAILURE; | ||
| } | ||
| blocksize *= blockshape[i]; | ||
| if (blocksize > (int64_t) length) { | ||
| free(shape); | ||
| free(chunkshape); | ||
| free(blockshape); | ||
| BLOSC_TRACE_ERROR("blockshape too large for block of %d bytes", length); | ||
| return BLOSC2_ERROR_FAILURE; | ||
| } | ||
| } | ||
|
|
||
| if (length != blocksize) { | ||
| if ((int64_t) length != blocksize) { | ||
| free(shape); | ||
| free(chunkshape); | ||
| free(blockshape); | ||
| BLOSC_TRACE_ERROR("Length not equal to blocksize %d %d \n", length, blocksize); | ||
| BLOSC_TRACE_ERROR("Length not equal to blocksize %d %lld \n", length, (long long) blocksize); | ||
| return BLOSC2_ERROR_FAILURE; | ||
| } | ||
|
|
||
|
|
@@ -182,22 +217,62 @@ int ndcell_backward(const uint8_t *input, uint8_t *output, int32_t length, uint8 | |
| return BLOSC2_ERROR_FAILURE; | ||
| } | ||
|
|
||
| int8_t cell_shape = (int8_t) meta; | ||
| // `meta` is attacker-controlled in a crafted frame. Interpret it as unsigned | ||
| // and reject 0: an (int8_t) cast would turn 128..255 into negative values and | ||
| // 0 would later divide by zero in `(blockshape[i] + cell_shape - 1) / cell_shape`. | ||
| int cell_shape = (int) meta; | ||
| if (cell_shape <= 0) { | ||
| free(shape); | ||
| free(chunkshape); | ||
| free(blockshape); | ||
| BLOSC_TRACE_ERROR("Invalid cell_shape %d", cell_shape); | ||
| return BLOSC2_ERROR_FAILURE; | ||
| } | ||
| int cell_size = (int) pow(cell_shape, ndim); | ||
| int32_t typesize = schunk->typesize; | ||
|
Comment on lines
+237
to
262
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same fix applied here on the decompression path. Since meta is attacker-controlled, this matters more — checked 64-bit multiply rejects oversized cell_shape^ndim before it can bypass the buffer-size check, and the check itself is overflow-safe (length == blocksize guarantees the division is exact). |
||
| uint8_t *ip = (uint8_t *) input; | ||
| uint8_t *ip_limit = ip + length; | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same fix on the attacker-controlled decompression path, placed before cell_size/division use. |
||
| uint8_t *op = (uint8_t *) output; | ||
| int32_t blocksize = (int32_t) typesize; | ||
| if (typesize <= 0) { | ||
| free(shape); | ||
| free(chunkshape); | ||
| free(blockshape); | ||
| BLOSC_TRACE_ERROR("Invalid typesize %d", typesize); | ||
| return BLOSC2_ERROR_FAILURE; | ||
| } | ||
| // The block geometry (blockshape) comes from the attacker-controlled "b2nd" | ||
| // metalayer and is NOT validated by b2nd_deserialize_meta(). Compute the | ||
| // block size in 64-bit and reject non-positive dimensions. Otherwise a | ||
| // crafted blockshape whose 32-bit product wraps back onto `length` would pass | ||
| // the check below, while the scatter-write index arithmetic further down uses | ||
| // the true (huge) dimensions, writing past the `length`-sized output buffer | ||
| // (heap overflow). Bailing as soon as the running product exceeds `length` | ||
| // also keeps the 64-bit multiply from overflowing (it stays | ||
| // <= length * INT32_MAX < INT64_MAX). | ||
| int64_t blocksize = (int64_t) typesize; | ||
| for (int i = 0; i < ndim; i++) { | ||
| if (blockshape[i] <= 0) { | ||
| free(shape); | ||
| free(chunkshape); | ||
| free(blockshape); | ||
| BLOSC_TRACE_ERROR("Invalid blockshape[%d] = %d", i, blockshape[i]); | ||
| return BLOSC2_ERROR_FAILURE; | ||
| } | ||
| blocksize *= blockshape[i]; | ||
| if (blocksize > (int64_t) length) { | ||
| free(shape); | ||
| free(chunkshape); | ||
| free(blockshape); | ||
| BLOSC_TRACE_ERROR("blockshape too large for block of %d bytes", length); | ||
| return BLOSC2_ERROR_FAILURE; | ||
| } | ||
| } | ||
|
|
||
| if (length != blocksize) { | ||
| if ((int64_t) length != blocksize) { | ||
| free(shape); | ||
| free(chunkshape); | ||
| free(blockshape); | ||
|
Comment on lines
+301
to
304
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Added a 64-byte 0xAC canary immediately after the output buffer and a post-call check, so a partial scatter-write that precedes the error return is caught — not just the return code. Added <string.h> for memset. |
||
| BLOSC_TRACE_ERROR("Length not equal to blocksize"); | ||
| BLOSC_TRACE_ERROR("Length not equal to blocksize %d %lld", length, (long long) blocksize); | ||
| return BLOSC2_ERROR_FAILURE; | ||
| } | ||
|
|
||
|
|
@@ -272,8 +347,8 @@ int ndcell_backward(const uint8_t *input, uint8_t *output, int32_t length, uint8 | |
| free(shape); | ||
| free(chunkshape); | ||
| free(blockshape); | ||
| BLOSC_TRACE_ERROR("Output size is not compatible with embedded blockshape ind %d %d \n", | ||
| ind, (blocksize / typesize)); | ||
| BLOSC_TRACE_ERROR("Output size is not compatible with embedded blockshape ind %d %lld \n", | ||
| ind, (long long) (blocksize / typesize)); | ||
| return BLOSC2_ERROR_FAILURE; | ||
| } | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| /********************************************************************* | ||
| Blosc - Blocked Shuffling and Compression Library | ||
|
|
||
| Copyright (c) 2021 Blosc Development Team <blosc@blosc.org> | ||
| https://blosc.org | ||
| License: BSD 3-Clause (see LICENSE.txt) | ||
|
|
||
| See LICENSE.txt for details about copyright and rights to use. | ||
|
|
||
| Regression test for the NDCELL filter hardening in ndcell.c. | ||
|
|
||
| ndcell_backward() takes the block geometry (blockshape) from the "b2nd" | ||
| metalayer, which is attacker-controlled in a crafted frame, while the real | ||
| output block buffer is sized from the chunk-header block size (`length`). | ||
| The old code computed blocksize = typesize * prod(blockshape) in 32-bit | ||
| arithmetic: a crafted blockshape whose product wraps back onto `length` | ||
| passed the `length == blocksize` check, after which the scatter-write | ||
| index arithmetic used the *true* (huge) dimensions and wrote past the | ||
| output buffer (heap overflow). | ||
|
|
||
| These cases exercise the rejection paths so the fix cannot regress silently: | ||
| - blockshape whose 32-bit product wraps back onto `length` | ||
| - a zero block dimension (must be invalid, not a size-0 shortcut) | ||
| - a negative block dimension | ||
| **********************************************************************/ | ||
|
|
||
| #include "b2nd.h" | ||
| #include "blosc2.h" | ||
| #include "ndcell.h" | ||
|
|
||
| #include <stdio.h> | ||
| #include <stdlib.h> | ||
| #include <stdint.h> | ||
| #include <string.h> | ||
|
|
||
| int ndcell_backward(const uint8_t *input, uint8_t *output, int32_t length, uint8_t meta, | ||
| blosc2_dparams *dparams, uint8_t id); | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Removed. ndcell.h is already included and declares ndcell_backward, so I dropped the local prototype to avoid signature drift. |
||
|
|
||
| static blosc2_schunk *make_schunk(int8_t ndim, const int64_t *shape, const int32_t *chunkshape, | ||
| const int32_t *blockshape, int32_t typesize) { | ||
| blosc2_storage storage = BLOSC2_STORAGE_DEFAULTS; | ||
| blosc2_cparams cparams = BLOSC2_CPARAMS_DEFAULTS; | ||
| cparams.typesize = typesize; | ||
| storage.cparams = &cparams; | ||
| blosc2_schunk *schunk = blosc2_schunk_new(&storage); | ||
| if (schunk == NULL) { | ||
| return NULL; | ||
| } | ||
| uint8_t *smeta = NULL; | ||
| int smeta_len = b2nd_serialize_meta(ndim, shape, chunkshape, blockshape, "|u1", 0, &smeta); | ||
| if (smeta_len < 0) { | ||
| blosc2_schunk_free(schunk); | ||
| return NULL; | ||
| } | ||
| /* The metalayer MUST be attached, otherwise the decoder would fail for the | ||
| wrong reason ("b2nd layer not found") and the test would pass vacuously. */ | ||
| int rc = blosc2_meta_add(schunk, "b2nd", smeta, smeta_len); | ||
| free(smeta); | ||
| if (rc < 0) { | ||
| blosc2_schunk_free(schunk); | ||
| return NULL; | ||
| } | ||
| return schunk; | ||
| } | ||
|
|
||
| /* ndcell_backward must reject this geometry (return < 0) without writing past | ||
| `length`. Returns 0 on success (rejected), -1 on failure. */ | ||
| static int expect_rejected(const char *name, int32_t b0, int32_t b1, | ||
| int32_t length, int32_t typesize, uint8_t cell_shape) { | ||
| int64_t shape[2] = { b0, b1 }; | ||
| int32_t chunkshape[2] = { b0, b1 }; | ||
| int32_t blockshape[2] = { b0, b1 }; | ||
| blosc2_schunk *schunk = make_schunk(2, shape, chunkshape, blockshape, typesize); | ||
| if (schunk == NULL) { | ||
| printf(" %-30s: could not build schunk -- FAIL\n", name); | ||
| return -1; | ||
| } | ||
|
|
||
| blosc2_dparams dparams = BLOSC2_DPARAMS_DEFAULTS; | ||
| dparams.schunk = schunk; | ||
|
|
||
| size_t out_len = (size_t) (length > 0 ? length : 1); | ||
| /* Place a canary region immediately after the output buffer. A rejection | ||
| must happen *before* any scatter-write, so even a partial overflow that | ||
| precedes the error return is caught here -- not just by the return code. */ | ||
| const size_t canary_len = 64; | ||
| const uint8_t canary_byte = 0xAC; | ||
| uint8_t *input = calloc(1, out_len); | ||
| uint8_t *output_full = malloc(out_len + canary_len); | ||
| uint8_t *output = output_full; | ||
| memset(output_full + out_len, canary_byte, canary_len); | ||
|
|
||
| int rc = ndcell_backward(input, output, length, cell_shape, &dparams, 0); | ||
|
|
||
| int canary_ok = 1; | ||
| for (size_t i = 0; i < canary_len; i++) { | ||
| if (output_full[out_len + i] != canary_byte) { | ||
| canary_ok = 0; | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| free(input); | ||
| free(output_full); | ||
| blosc2_schunk_free(schunk); | ||
|
|
||
| if (!canary_ok) { | ||
| printf(" %-30s: wrote past output buffer (canary clobbered) -- FAIL\n", name); | ||
| return -1; | ||
| } | ||
| if (rc >= 0) { | ||
| printf(" %-30s: NOT rejected (rc=%d) -- FAIL\n", name, rc); | ||
| return -1; | ||
| } | ||
| printf(" %-30s: rejected (rc=%d) -- OK\n", name, rc); | ||
| return 0; | ||
| } | ||
|
|
||
| int main(void) { | ||
| int result = 0; | ||
| blosc2_init(); // mandatory for initializing the plugin mechanism | ||
| printf("NDCELL decompress hardening regression tests:\n"); | ||
|
|
||
| /* 1*65536*65537 = 0x100010000, low 32 bits = 0x10000 = 65536 == length */ | ||
| result |= expect_rejected("32-bit wrap onto length", 65536, 65537, 65536, 1, 2); | ||
| /* a zero block dimension must be invalid input */ | ||
| result |= expect_rejected("zero block dimension", 0, 64, 256, 1, 2); | ||
| /* a negative block dimension must be invalid input */ | ||
| result |= expect_rejected("negative block dimension", -1, 64, 256, 1, 2); | ||
|
|
||
| if (result == 0) { | ||
| printf("All NDCELL hardening checks passed.\n"); | ||
| } | ||
| blosc2_destroy(); | ||
| return result; | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed. cell_size is now int64_t, computed with checked multiplication that bails with BLOSC2_ERROR_FAILURE if the running product would exceed INT64_MAX — no more (int) pow() overflow/UB. The downstream guard is now cell_size > (int64_t) length / typesize, which can't overflow.