#cose

ssi-cose

CBOR Object Signing and Encryption for the ssi library

1 unstable release

0.1.0 Sep 20, 2024

#6 in #cose

Download history 162/week @ 2024-09-16 560/week @ 2024-09-23 198/week @ 2024-09-30 352/week @ 2024-10-07 158/week @ 2024-10-14

1,287 downloads per month
Used in 15 crates (2 directly)

Apache-2.0 and Apache-2.0…

135KB
2.5K SLoC

CBOR Object Signing and Encryption (COSE) implementation based on coset.

Usage

use std::borrow::Cow;
use serde::{Serialize, Deserialize};
use ssi_claims_core::{VerifiableClaims, ValidateClaims, VerificationParameters};
use ssi_cose::{CosePayload, ValidateCoseHeader, CoseSignatureBytes, DecodedCoseSign1, CoseKey, key::CoseKeyGenerate};

// Our custom payload type.
#[derive(Serialize, Deserialize)]
struct CustomPayload {
  data: String
}

// Define how the payload is encoded in COSE.
impl CosePayload for CustomPayload {
  // Serialize the payload as JSON.
  fn payload_bytes(&self) -> Cow<[u8]> {
    Cow::Owned(serde_json::to_vec(self).unwrap())
  }
}

// Define how to validate the COSE header (always valid by default).
impl<P> ValidateCoseHeader<P> for CustomPayload {}

// Define how to validate the payload (always valid by default).
impl<P> ValidateClaims<P, CoseSignatureBytes> for CustomPayload {}

// Create a payload.
let payload = CustomPayload {
  data: "Some Data".to_owned()
};

// Create a signature key.
let key = CoseKey::generate_p256(); // requires the `secp256r1` feature.

// Sign the payload!
let bytes = payload.sign(
  &key,
  true // should the `COSE_Sign1` object be tagged or not.
).await.unwrap();

// Decode the signed COSE object.
let decoded: DecodedCoseSign1<CustomPayload> = bytes
    .decode(true)
    .unwrap()
    .try_map(|_, bytes| serde_json::from_slice(bytes))
    .unwrap();

assert_eq!(decoded.signing_bytes.payload.data, "Some Data");

// Verify the signature.
let params = VerificationParameters::from_resolver(&key);
decoded.verify(&params).await.unwrap();

Dependencies

~19–31MB
~497K SLoC