CBOR-to-JSON: do properly escape JSON strings#274
Merged
thiagomacieira merged 1 commit intointel:mainfrom Mar 11, 2025
Merged
Conversation
georgen117
approved these changes
Mar 11, 2025
georgen117
left a comment
georgen117
left a comment
There was a problem hiding this comment.
Looks good!
I did comment on line of code I think could benefit from code comments to clarify the magic number 0x1f used but have no problem if it is committed as is.
We hadn't bothered, as this was just example-like code to show how one could convert from CBOR to JSON. But as it was added to the library (no extra dependency), we should Do The Right Thing (DTRT) and escape. This patch could have used cbor_value_to_pretty() to print the string, which has better support for UTF-8 escaping and thus checks for UTF-8 correctness, but that would make map_to_json()'s metadata functionality much more complex, especially since we cannot rely on open_memstream() always being available. Therefore, we are partially duplicating cborpretty.c's utf8EscapedDump(). Signed-off-by: Thiago Macieira <thiago.macieira@intel.com>
thiagomacieira
force-pushed
the
CBOR_to_JSON_do_properly_escape_JSON_strings
branch
from
988aa33 to
4863012
Compare
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
2 participants
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.
We hadn't bothered, as this was just example-like code to show how one could convert from CBOR to JSON. But as it was added to the library (no extra dependency), we should Do The Right Thing (DTRT) and escape.
This patch could have used
cbor_value_to_pretty()to print the string, which has better support for UTF-8 escaping and thus checks for UTF-8 correctness, but that would makemap_to_json()'s metadata functionality much more complex, especially since we cannot rely onopen_memstream()always being available. Therefore, we are partially duplicating cborpretty.c'sutf8EscapedDump().