commit | a2582f9bc9632f765a14344a5ada629e0f435e85 | [log] [tgz] |
---|---|---|
author | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Thu Apr 28 16:02:05 2022 +0000 |
committer | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | Thu Apr 28 16:02:05 2022 +0000 |
tree | c59a2e47aff325e9bba41815f4fff46748663b0e | |
parent | db4ee1a61d21624c945c67cddb834f386fdbfd8e [diff] | |
parent | 5e51be81e1dd965daebf1c13a5fd76a0ec09738e [diff] |
Snap for 8512216 from 5e51be81e1dd965daebf1c13a5fd76a0ec09738e to tm-frc-adbd-release Change-Id: I68767050df63ef89a919a97bbd66975a3b45edcb
This crate holds a set of Rust types for working with CBOR Object Signing and Encryption (COSE) objects, as defined in RFC 8152. It builds on the core CBOR parsing functionality from the ciborium
crate.
See crate docs, or the signature example for documentation on how to use the code.
This repo is under construction and so details of the API and the code may change without warning.
no_std
SupportThis crate supports no_std
, but uses the alloc
crate.
MSRV is 1.56 (the main ciborium
dependency is edition="2021"
)
CBOR supports integers in the range:
[-18_446_744_073_709_551_616, -1] ∪ [0, 18_446_744_073_709_551_615]
which is [-264, -1] ∪ [0, 264 - 1].
This does not map onto a single Rust integer type, so different CBOR crates take different approaches.
serde_cbor
crate uses a single i128
integer type for all integer values, which means that all CBOR integer values can be expressed, but there are also i128
values that cannot be encoded in CBOR. This also means that data size is larger.ciborium
also uses a single i128
integer type internally, but wraps it in its own Integer
type and only implements TryFrom
(not From
) for i128
/ u128
conversions so that unrepresentable numbers can be rejected.sk-cbor
crate uses distinct types:This crate uses a single type to encompass both positive and negative values, but uses i64
for that type to keep data sizes smaller. This means that:
i64
cover [0, 263 - 1]i64
cover [-263, -1]and so there are large values – both positive and negative – which are not supported by this crate.
Local coding conventions are enforced by the continuous integration jobs and include:
rustfmt
using the local rustfmt.toml settings.TODO
markers should be of form TODO(#99)
and refer to an open GitHub issue.panic!
, unwrap
, expect
) should have a comment on the same line in the form // safe: reason
(or /* safe: reason */
) to document the reason why panicking is acceptable.This is not an officially supported Google product.