CBOR: Basic Support for Tags #2359
Closed
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
|
Superseded by #2412. closing this one… |
sandwwraith
added a commit
that referenced
this pull request
Jul 22, 2024
This PR contains all features required to serialize and parse COSE-compliant CBOR (thanks to @nodh). While some canonicalization steps (such as sorting keys) still need to be performed manually. It does get the job done quite well. Namely, we have successfully used the features introduced here to create and validate ISO/IEC 18013-5:2021-compliant mobile driving license data. This PR introduces the following features to the CBOR format: - Serial Labels - Tagging of keys and values - Definite length encoding (this is the largest change, as it effectively makes the cbor encoder two-pass) - Option to globally prefer major type 2 for byte array encoding - Various QoL changes, such as public CborEncoder/CborDecoder interfaces and separate CborConfiguration class. This PR obsoletes #2371 and #2359 as it contains the features of both PRs and many more. Fixes #1955 Fixes #1560 Co-authored-by: Christian Kollmann <[email protected]> Co-authored-by: Leonid Startsev <[email protected]>
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.
Introduces basic support for CBOR tags.
Basic means that no semantic checks are performed yet, so you freely use reserved tags (e.g. serialize a cornucopia of fruit and other produce using tags reserved for dates, URIs, MIME messages, negative bignums and so forth) and no error will be thrown.
writeKeyTagswriteValueTagsverifyKeyTagsverifyValueTagsThis is the first PR in a series of planned enhancements, but we still consider it valuable on its own (as it also affects #1560).
In the long run, we plan to support semantically correct serialization for all reserved CBOR tags. This includes separate contributions to koltinx.datetime and the native support for self-describing CBOR. The latter of which is planned to enable the deserialization of CBOR structures, while also enabling access to the original underlying raw byte-string. This is a crucial features for conveniently working with (i.e. verifying) signed data. (Which, in turn, is a requirement for a 100% pure Kotlin multiplatform COSE implementation.)
Hence, we want to use this opportunity to also collect early feedback from those who are more familiar with kotlinx.serialization than we are.
(ofc, this should be squashed prior to merging/rebasing)