CBOR Feature Drop: COSE #2412
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| package kotlinx.serialization.cbor | ||
|
|
||
| import kotlinx.serialization.* | ||
| import kotlinx.serialization.builtins.* | ||
| import kotlinx.serialization.descriptors.* | ||
| import kotlinx.serialization.encoding.* | ||
|
|
||
| /** | ||
| * Use this class if you'll need to serialize a complex type as a byte string before encoding it, | ||
| * i.e. as it is the case with the protected header in COSE structures. | ||
| * | ||
| * An example for a COSE header data class would be: | ||
| * | ||
| * ``` | ||
| * @Serializable | ||
| * data class CoseHeader( | ||
| * @CborLabel(1) | ||
| * @SerialName("alg") | ||
| * val alg: Int? = null | ||
| * ) | ||
| * | ||
| * @Serializable | ||
| * data class CoseSigned( | ||
| * @ByteString | ||
| * @CborLabel(1) | ||
| * @SerialName("protectedHeader") | ||
| * val protectedHeader: ByteStringWrapper<CoseHeader>, | ||
sandwwraith marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * ) | ||
| * ``` | ||
| * | ||
| * Serializing this `CoseHeader` object would result in `a10143a10126`, in diagnostic notation: | ||
| * | ||
| * ``` | ||
| * A1 # map(1) | ||
| * 01 # unsigned(1) | ||
| * 43 # bytes(3) | ||
| * A10126 # "\xA1\u0001&" | ||
| * ``` | ||
| * | ||
| * so the `protectedHeader` got serialized first and then encoded as a `@ByteString`. | ||
| * | ||
| * Note that `equals()` and `hashCode()` only use `value`, not `serialized`. | ||
| */ | ||
| @Serializable(with = ByteStringWrapperSerializer::class) | ||
| public class ByteStringWrapper<T>( | ||
|
There was a problem hiding this comment. NB: it seems you need to update |
||
| public val value: T, | ||
| public val serialized: ByteArray = byteArrayOf() | ||
|
There was a problem hiding this comment. I've skimmed through the diff and can't find any usages of this value. Is there any reason to be a There was a problem hiding this comment. @nodh can you take care of this, please? There was a problem hiding this comment. We'll use the CBOR serialization for ISO 18013-5 compliaent mobile driving licences. There verifiers need to check that (the digest of) the serialized byte values appear in another structure (signed by the issuer). So in that case its quite useful to have the bytes as they were serialized (and parsed) in the deserialized |
||
| ) { | ||
| override fun equals(other: Any?): Boolean { | ||
sandwwraith marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if (this === other) return true | ||
| if (other == null || this::class != other::class) return false | ||
|
|
||
| other as ByteStringWrapper<*> | ||
|
|
||
| return value == other.value | ||
| } | ||
|
|
||
| override fun hashCode(): Int { | ||
| return value?.hashCode() ?: 0 | ||
| } | ||
|
|
||
| override fun toString(): String { | ||
| return "ByteStringWrapper(value=$value, serialized=${serialized.contentToString()})" | ||
| } | ||
|
|
||
| } | ||
|
|
||
|
|
||
| @OptIn(ExperimentalSerializationApi::class) | ||
| public class ByteStringWrapperSerializer<T>(private val dataSerializer: KSerializer<T>) : | ||
| KSerializer<ByteStringWrapper<T>> { | ||
|
|
||
| override val descriptor: SerialDescriptor = dataSerializer.descriptor | ||
|
|
||
| override fun serialize(encoder: Encoder, value: ByteStringWrapper<T>) { | ||
| val bytes = Cbor.encodeToByteArray(dataSerializer, value.value) | ||
| encoder.encodeSerializableValue(ByteArraySerializer(), bytes) | ||
| } | ||
|
|
||
| override fun deserialize(decoder: Decoder): ByteStringWrapper<T> { | ||
| val bytes = decoder.decodeSerializableValue(ByteArraySerializer()) | ||
| val value = Cbor.decodeFromByteArray(dataSerializer, bytes) | ||
| return ByteStringWrapper(value, bytes) | ||
| } | ||
|
|
||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe
ValueTags.Companionshould be mentioned here as a source for pre-defined tagsThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done