ockam_identity 0.134.0

Ockam is a library for building devices that communicate securely, privately and trustfully with cloud services and other devices.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

use crate::alloc::string::ToString;
use core::fmt::{Debug, Formatter};
use minicbor::{CborLen, Decode, Encode};
use ockam_core::compat::vec::Vec;
use ockam_core::{cbor_encode_preallocate, Decodable, Encodable, Encoded, Message};

/// Identifier length
pub const IDENTIFIER_LEN: usize = 32;

/// ChangeHash length
pub const CHANGE_HASH_LEN: usize = 32;

/// Unique identifier for an [`super::super::identity::Identity`]
/// Equals to the [`ChangeHash`] of the first [`super::Change`] in the [`super::ChangeHistory`]
/// Computed as SHA256 of the first [`super::ChangeData`] CBOR binary
#[derive(Clone, Hash, Ord, PartialOrd, Eq, PartialEq, Encode, Decode, CborLen)]
#[cbor(transparent)]
pub struct Identifier(#[cbor(n(0), with = "minicbor::bytes")] pub [u8; IDENTIFIER_LEN]);

impl Debug for Identifier {
    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
        f.write_str(&self.to_string())
    }
}

/// List of identifiers
#[derive(Clone, Eq, PartialEq, Encode, Decode, CborLen, Message)]
#[cbor(transparent)]
pub struct IdentifierList(#[n(0)] pub Vec<Identifier>);

impl Encodable for IdentifierList {
    fn encode(self) -> ockam_core::Result<Encoded> {
        cbor_encode_preallocate(self)
    }
}

impl Decodable for IdentifierList {
    fn decode(e: &[u8]) -> ockam_core::Result<Self> {
        Ok(minicbor::decode(e)?)
    }
}

/// Unique identifier for a [`super::Change`]
/// Computed as SHA256 of the corresponding [`super::ChangeData`] CBOR binary
#[derive(Clone, Debug, Eq, PartialEq, Encode, Decode, CborLen)]
#[cbor(transparent)]
pub struct ChangeHash(#[cbor(n(0), with = "minicbor::bytes")] pub [u8; CHANGE_HASH_LEN]);