Skip to content

[Backport v3.7-branch] Add stream_flash_erase_page range check #80462

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

Merged
merged 2 commits into from
Nov 8, 2024
Merged

[Backport v3.7-branch] Add stream_flash_erase_page range check #80462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5983709
storage/stream_flash: Fix range check in stream_flash_erase_page
de-nordic Oct 15, 2024
ac3ab08
tests/storage/stream_flash: Add erase range check test
de-nordic Oct 15, 2024
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
3 changes: 2 additions & 1 deletion include/zephyr/storage/stream_flash.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,8 @@ int stream_flash_erase_page(struct stream_flash_ctx *ctx, off_t off);
* @param settings_key key to use with the settings module for loading
* the stream write progress
*
* @return non-negative on success, negative errno code on fail
* @return non-negative on success, -ERANGE in case when @p off is out
* of area designated for stream or negative errno code on fail
*/
int stream_flash_progress_load(struct stream_flash_ctx *ctx,
const char *settings_key);
Expand Down
6 changes: 6 additions & 0 deletions subsys/storage/stream/stream_flash.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,12 @@ int stream_flash_erase_page(struct stream_flash_ctx *ctx, off_t off)
#if defined(CONFIG_FLASH_HAS_EXPLICIT_ERASE)
int rc;
struct flash_pages_info page;

if (off < ctx->offset || (off - ctx->offset) >= ctx->available) {
LOG_ERR("Offset out of designated range");
return -ERANGE;
}

#if defined(CONFIG_FLASH_HAS_NO_EXPLICIT_ERASE)
/* There are both types of devices */
const struct flash_parameters *fparams = flash_get_parameters(ctx->fdev);
Expand Down
19 changes: 19 additions & 0 deletions tests/subsys/storage/stream/stream_flash/src/main.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,25 @@ ZTEST(lib_stream_flash, test_stream_flash_erase_page)
zassert_equal(memcmp(&bad_ctx, &cmp_ctx, sizeof(bad_ctx)), 0,
"Ctx should not get altered");
zassert_equal(rc, -EINVAL, "Expected failure");

/* False dev with erase set to NULL to avoid actual erase */
fake_api.erase = NULL;
struct stream_flash_ctx range_test_ctx = {
.offset = 1024,
.available = 2048,
.fdev = &fake_dev,
.last_erased_page_start_offset = -1,
};

rc = stream_flash_erase_page(&range_test_ctx, 1024);
zassert_equal(rc, -ENOSYS, "%d No device attached - expected failure", rc);

rc = stream_flash_erase_page(&range_test_ctx, 1023);
zassert_equal(rc, -ERANGE, "Expected failure - offset before designated area");

rc = stream_flash_erase_page(&range_test_ctx,
range_test_ctx.offset + range_test_ctx.available + 1);
zassert_equal(rc, -ERANGE, "Expected failure - offset after designated area");
}
#else
ZTEST(lib_stream_flash, test_stream_flash_erase_page)
Expand Down
Loading