Flagged six FileX APIs as deprecated#95
Open
fdesbiens wants to merge 1 commit into
Open
Conversation
Added #pragma message compile-time warnings and updated DESCRIPTION blocks in: - fx_directory_long_name_get -> use _extended (buffer size) - fx_directory_short_name_get -> use _extended (buffer size) - fx_media_volume_get -> use _extended (buffer size) - fx_unicode_length_get -> use _extended (buffer size) - fx_unicode_name_get -> use _extended (buffer size) - fx_unicode_short_name_get -> use _extended (buffer size) All six functions omit a destination buffer length parameter and use a fixed or hardcoded limit, which can cause buffer overruns in the caller. The corresponding _extended variants accept an explicit buffer size and must be used instead. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Six FileX functions omit a destination buffer-length parameter and use a fixed or hardcoded limit. They can cause buffer overruns in the caller. Each has an
_extendedreplacement that accepts an explicit buffer size.fx_directory_long_name_getfx_directory_long_name_get_extendedFX_MAX_LONG_NAME_LENfx_directory_short_name_getfx_directory_short_name_get_extendedFX_MAX_SHORT_NAME_LENfx_media_volume_getfx_media_volume_get_extendedfx_unicode_length_getfx_unicode_length_get_extendedfx_unicode_name_getfx_unicode_name_get_extendedFX_MAX_LONG_NAME_LEN*2fx_unicode_short_name_getfx_unicode_short_name_get_extendedChanges
Added
#pragma messagecompile-time warnings and updated DESCRIPTION blocks in all six source files.Companion
Docs: eclipse-threadx/rtos-docs-asciidoc#33 (pending)