Struct CoseKey 

pub struct CoseKey {
    pub kty: RegisteredLabel<KeyType>,
    pub key_id: Vec<u8>,
    pub alg: Option<RegisteredLabelWithPrivate<Algorithm>>,
    pub key_ops: BTreeSet<RegisteredLabel<KeyOperation>>,
    pub base_iv: Vec<u8>,
    pub params: Vec<(Label, Value)>,
}

Structure representing a cryptographic key.

 COSE_Key = {
     1 => tstr / int,          ; kty
     ? 2 => bstr,              ; kid
     ? 3 => tstr / int,        ; alg
     ? 4 => [+ (tstr / int) ], ; key_ops
     ? 5 => bstr,              ; Base IV
     * label => values
 }

Fields

kty: RegisteredLabel<KeyType>

Key type identification.

key_id: Vec<u8>

Key identification.

alg: Option<RegisteredLabelWithPrivate<Algorithm>>

Key use restriction to this algorithm.

key_ops: BTreeSet<RegisteredLabel<KeyOperation>>

Restrict set of possible operations.

base_iv: Vec<u8>

Base IV to be xor-ed with partial IVs.

params: Vec<(Label, Value)>

Any additional parameter (label,value) pairs. If duplicate labels are present, CBOR-encoding will fail.

Implementations

impl CoseKey

pub fn canonicalize(&mut self, ordering: CborOrdering)

Re-order the contents of the key so that the contents will be emitted in one of the standard CBOR sorted orders.

Trait Implementations

impl AsCborValue for CoseKey

fn from_cbor_value(value: Value) -> Result<CoseKey, CoseError>

Convert a Value into an instance of the type.

fn to_cbor_value(self) -> Result<Value, CoseError>

Convert the object into a Value, consuming it along the way.

impl CborSerializable for CoseKey

fn from_slice(slice: &[u8]) -> Result<Self, CoseError>

Create an object instance from serialized CBOR data in a slice. This method will fail (with CoseError::ExtraneousData) if there is additional CBOR data after the object.

fn to_vec(self) -> Result<Vec<u8>, CoseError>

Serialize this object to a vector, consuming it along the way.

impl Clone for CoseKey

fn clone(&self) -> CoseKey

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CoseKeyDecode for CoseKey

fn fetch_param(&self, label: &Label) -> Option<&Value>

Fetch a key parameter.

fn decode_public(&self) -> Result<PublicKey, KeyDecodingError>

Decodes the COSE key as a public key.

fn decode_secret(&self) -> Result<SecretKey, KeyDecodingError>

Decodes the COSE key as a secret key.

fn require_param(&self, label: &Label) -> Result<&Value, KeyDecodingError>

Requires the given key parameter.

fn parse_required_param<'a, T>( &'a self, label: &Label, f: impl FnOnce(&'a Value) -> Option<T>, ) -> Result<T, KeyDecodingError>

Requires and parses the given key parameter.

impl CoseKeyEncode for CoseKey

fn encode_public(key: &PublicKey) -> Result<Self, KeyEncodingError>

fn encode_secret(key: &SecretKey) -> Result<Self, KeyEncodingError>

fn encode_public_with_id( key: &PublicKey, id: Vec<u8>, ) -> Result<CoseKey, KeyEncodingError>

fn encode_secret_with_id( key: &SecretKey, id: Vec<u8>, ) -> Result<CoseKey, KeyEncodingError>

impl CoseKeyGenerate for CoseKey

fn generate_p256() -> Self

fn generate_p256_from(rng: &mut (impl RngCore + CryptoRng)) -> Self

impl CoseKeyResolver for CoseKey

async fn fetch_public_cose_key( &self, _id: Option<&[u8]>, ) -> Result<Cow<'_, CoseKey>, ProofValidationError>

Fetches the COSE key associated to the give identifier.

impl CoseSigner for CoseKey

async fn fetch_info(&self) -> Result<CoseSignerInfo, SignatureError>

Fetches the information about the signing key.

async fn sign_bytes( &self, signing_bytes: &[u8], ) -> Result<Vec<u8>, SignatureError>

Signs the given bytes.

async fn sign( &self, payload: &(impl ?Sized + CosePayload), additional_data: Option<&[u8]>, tagged: bool, ) -> Result<CoseSign1BytesBuf, SignatureError>

Signs the given payload.

impl Debug for CoseKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for CoseKey

fn default() -> CoseKey

Returns the “default value” for a type.

impl PartialEq for CoseKey

fn eq(&self, other: &CoseKey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CoseKey