MSC4224: CBOR Serialization #4224
Open
+72
−0
Conversation
This file contains 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
turt2live
added
proposal
turt2live
reviewed
Nov 6, 2024
There was a problem hiding this comment.
Implementation requirements:
- Client
- Server
turt2live
added
client-server
jvoisin
reviewed
Nov 8, 2024
Comment on lines
+35
to
+46
| of binary data, such as public keys or signatures. Given that unlike JSON, CBOR | ||
| can safely represent raw binary data, all binary data MUST be encoded and | ||
| represented as binary strings with tag 22, as described in RFC 8949 [Section | ||
| 3.4.5.2](https://www.rfc-editor.org/rfc/rfc8949.html#section-3.4.5.2). Tagging | ||
| is required for compatibility with generic CBOR-to-JSON converters. | ||
|
|
||
| Example object would be encoded like this: | ||
| ``` | ||
| D6 # tag(22) | ||
| 50 # bytes(16) | ||
| 03082C12C0053C1EC80BD712ACED1E0A # "AwgsEsAFPB7IC9cSrO0eCg" in base64 | ||
| ``` |
There was a problem hiding this comment.
As the goal is to minimize the space taken by the content, why use base64 instead of raw binary data? It can be trivially base64-encoded during the conversion to json.
There was a problem hiding this comment.
Using tag 22, generic converters can determine that raw bytes supposed to be encoded in base64 in JSON. We DON'T encode to base64, for a reason you mentioned.
There was a problem hiding this comment.
Err, it seems that I misread the snippet, my bad!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Rendered
Yes, this is basically #3079 but only CBOR part of it, "one bite at a time" and such.
This MSC is written as an individual FOSS contributor. (Disclosure as by matrix-org/matrix-spec#1700)
Signed-off-by: Alexander Ivanov saiv46.dev@gmail.com